status-im
/
sourcecred
mirror of https://github.com/status-im/sourcecred.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Export a clean `Entity` type from relationalView (#437) 

Callers will want to write functions that are generic over `Entity`.
This makes those call signatures cleaner.

Test plan: travis
This commit is contained in:
Dandelion Mané 2018-06-28 14:52:24 -07:00 committed by GitHub
parent a8f54530bc
commit e239fdfeeb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/v3/plugins/github/relationalView.js
View File

@ -148,7 +148,7 @@ export class RelationalView {
yield* this.comments(); yield* this.comments();
} }
*entities(): Iterator<Entity<Entry>> { *entities(): Iterator<Entity> {
yield* this.repos(); yield* this.repos();
yield* this.issues(); yield* this.issues();
yield* this.pulls(); yield* this.pulls();
@ -419,7 +419,7 @@ type Entry =
| CommentEntry | CommentEntry
| UserlikeEntry; | UserlikeEntry;
export class Entity<+T: Entry> { export class _Entity<+T: Entry> {
+_view: RelationalView; +_view: RelationalView;
+_entry: T; +_entry: T;
constructor(view: RelationalView, entry: T) { constructor(view: RelationalView, entry: T) {
@ -441,7 +441,7 @@ type RepoEntry = {|
+pulls: PullAddress[], +pulls: PullAddress[],
|}; |};
export class Repo extends Entity<RepoEntry> { export class Repo extends _Entity<RepoEntry> {
constructor(view: RelationalView, entry: RepoEntry) { constructor(view: RelationalView, entry: RepoEntry) {
super(view, entry); super(view, entry);
} }
@ -477,7 +477,7 @@ type IssueEntry = {|
+nominalAuthor: ?UserlikeAddress, +nominalAuthor: ?UserlikeAddress,
|}; |};
export class Issue extends Entity<IssueEntry> { export class Issue extends _Entity<IssueEntry> {
constructor(view: RelationalView, entry: IssueEntry) { constructor(view: RelationalView, entry: IssueEntry) {
super(view, entry); super(view, entry);
} }
@ -523,7 +523,7 @@ type PullEntry = {|
+nominalAuthor: ?UserlikeAddress, +nominalAuthor: ?UserlikeAddress,
|}; |};
export class Pull extends Entity<PullEntry> { export class Pull extends _Entity<PullEntry> {
constructor(view: RelationalView, entry: PullEntry) { constructor(view: RelationalView, entry: PullEntry) {
super(view, entry); super(view, entry);
} }
@ -576,7 +576,7 @@ type ReviewEntry = {|
+nominalAuthor: ?UserlikeAddress, +nominalAuthor: ?UserlikeAddress,
|}; |};
export class Review extends Entity<ReviewEntry> { export class Review extends _Entity<ReviewEntry> {
constructor(view: RelationalView, entry: ReviewEntry) { constructor(view: RelationalView, entry: ReviewEntry) {
super(view, entry); super(view, entry);
} }
@ -615,7 +615,7 @@ type CommentEntry = {|
+nominalAuthor: ?UserlikeAddress, +nominalAuthor: ?UserlikeAddress,
|}; |};
export class Comment extends Entity<CommentEntry> { export class Comment extends _Entity<CommentEntry> {
constructor(view: RelationalView, entry: CommentEntry) { constructor(view: RelationalView, entry: CommentEntry) {
super(view, entry); super(view, entry);
} }
@ -658,7 +658,7 @@ type UserlikeEntry = {|
+url: string, +url: string,
|}; |};
export class Userlike extends Entity<UserlikeEntry> { export class Userlike extends _Entity<UserlikeEntry> {
constructor(view: RelationalView, entry: UserlikeEntry) { constructor(view: RelationalView, entry: UserlikeEntry) {
super(view, entry); super(view, entry);
} }
@ -690,6 +690,7 @@ function* getAuthors(
} }
} }
export type Entity = Repo | Issue | Pull | Review | Comment | Userlike;
export type AuthoredEntity = Issue | Pull | Review | Comment; export type AuthoredEntity = Issue | Pull | Review | Comment;
export type TextContentEntity = Issue | Pull | Review | Comment; export type TextContentEntity = Issue | Pull | Review | Comment;
export type ParentEntity = Repo | Issue | Pull | Review; export type ParentEntity = Repo | Issue | Pull | Review;

4
src/v3/plugins/github/relationalView.test.js
View File

@ -24,7 +24,7 @@ describe("plugins/github/relationalView", () => {
it(`has ${name}`, () => { it(`has ${name}`, () => {
const element = method(); const element = method();
let snapshot; let snapshot;
if (element instanceof R.Entity) { if (element instanceof R._Entity) {
// element is an Entity. Entities have pointers to the RelationalView, // element is an Entity. Entities have pointers to the RelationalView,
// and it would pollute our snapshot horribly. Just show the url. // and it would pollute our snapshot horribly. Just show the url.
snapshot = {url: element.url()}; snapshot = {url: element.url()};
@ -36,7 +36,7 @@ describe("plugins/github/relationalView", () => {
} }
describe("RelationalView", () => { describe("RelationalView", () => {
function hasEntityMethods<T: R.Entity<any>>( function hasEntityMethods<T: R._Entity<any>>(
name, name,
getAll: () => Iterator<T>, getAll: () => Iterator<T>,
get: (x: $Call<$PropertyType<T, "address">>) => ?T get: (x: $Call<$PropertyType<T, "address">>) => ?T