refactor(builder): Change builders to models

Author: Gery Hirschfeld

src/builders/abstact.builder.ts

@@ -1,10 +1,10 @@
 import { name } from 'faker';
 
-import { AuthorBuilder } from '../../builders/author.builder';
+import { AuthorModel } from '../../models/author.model';
 
 
-export const makeAuthor = (): AuthorBuilder => {
-    return (new AuthorBuilder())
+export const makeAuthor = (): AuthorModel => {
+    return (new AuthorModel())
         .setFirstName(name.firstName())
         .setLastName(name.lastName());
 };

src/database/factories/author.factory.ts

@@ -1,10 +1,10 @@
 import { lorem, random, date } from 'faker';
 
-import { BookBuilder } from '../../builders/book.builder';
+import { BookModel } from '../../models/book.model';
 
 
-export const makeBook = (authorId: number): BookBuilder => {
-    return (new BookBuilder())
+export const makeBook = (authorId: number): BookModel => {
+    return (new BookModel())
         .setTitle(lorem.word())
         .setDescription(lorem.sentences(5))
         .setPrice(random.number(120) + (random.number(99) / 100))

src/database/factories/book.factory.ts

@@ -0,0 +1,4 @@
+export interface AbstactModel<Attributes, RawAttributes> {
+    toJson(): Attributes;
+    toDatabaseObject(): RawAttributes;
+}

src/models/abstact.model.ts

@@ -1,9 +1,9 @@
 import { models } from 'models';
 
-import { AbstactBuilder } from './abstact.builder';
+import { AbstactModel } from './abstact.model';
 
 
-export class AuthorBuilder implements AbstactBuilder<models.author.Attributes, models.author.RawAttributes> {
+export class AuthorModel implements AbstactModel<models.author.Attributes, models.author.RawAttributes> {
 
     private id?: number;
     private firstName: string;
@@ -14,9 +14,9 @@ export class AuthorBuilder implements AbstactBuilder<models.author.Attributes, m
     constructor(attributes?: models.author.Attributes | models.author.RawAttributes, isRaw = true) {
         if (attributes) {
             if (isRaw) {
-                this.mapRaw(attributes);
+                this.mapDatabaseObject(attributes);
             } else {
-                this.map(attributes);
+                this.mapJson(attributes);
             }
         }
     }
@@ -41,31 +41,31 @@ export class AuthorBuilder implements AbstactBuilder<models.author.Attributes, m
         return this.createdAt;
     };
 
-    public setId(id: number): AuthorBuilder {
+    public setId(id: number): AuthorModel {
         this.id = id;
         return this;
     };
 
-    public setFirstName(firstName: string): AuthorBuilder {
+    public setFirstName(firstName: string): AuthorModel {
         this.firstName = firstName;
         return this;
     };
-    public setLastName(lastName: string): AuthorBuilder {
+    public setLastName(lastName: string): AuthorModel {
         this.lastName = lastName;
         return this;
     };
 
-    public setUpdatedAt(updatedAt: Date): AuthorBuilder {
+    public setUpdatedAt(updatedAt: Date): AuthorModel {
         this.updatedAt = updatedAt;
         return this;
     };
 
-    public setCreatedAt(createdAt: Date): AuthorBuilder {
+    public setCreatedAt(createdAt: Date): AuthorModel {
         this.createdAt = createdAt;
         return this;
     };
 
-    public map(attributes: models.author.Attributes): AuthorBuilder {
+    public mapJson(attributes: models.author.Attributes): AuthorModel {
         if (attributes !== undefined) {
             this.setId(attributes.id);
             this.setFirstName(attributes.firstName);
@@ -76,7 +76,7 @@ export class AuthorBuilder implements AbstactBuilder<models.author.Attributes, m
         return this;
     }
 
-    public mapRaw(attributes: models.author.RawAttributes): AuthorBuilder {
+    public mapDatabaseObject(attributes: models.author.RawAttributes): AuthorModel {
         if (attributes !== undefined) {
             this.setId(attributes.id);
             this.setFirstName(attributes.first_name);
@@ -91,11 +91,11 @@ export class AuthorBuilder implements AbstactBuilder<models.author.Attributes, m
         return !!this.firstName && !!this.lastName;
     }
 
-    public build(): Author {
+    public toJson(): Author {
         return new Author(this);
     }
 
-    public buildRaw(): RawAuthor {
+    public toDatabaseObject(): RawAuthor {
         return new RawAuthor(this);
     }
 
@@ -108,7 +108,7 @@ export class Author implements models.author.Attributes {
     public updatedAt?: Date;
     public createdAt?: Date;
 
-    constructor(builder: AuthorBuilder) {
+    constructor(builder: AuthorModel) {
         this.id = builder.Id;
         this.firstName = builder.FirstName;
         this.lastName = builder.LastName;
@@ -124,7 +124,7 @@ export class RawAuthor implements models.author.RawAttributes {
     public updated_at?: Date;
     public created_at?: Date;
 
-    constructor(builder: AuthorBuilder) {
+    constructor(builder: AuthorModel) {
         this.id = builder.Id;
         this.first_name = builder.FirstName;
         this.last_name = builder.LastName;

src/builders/author.builder.ts src/models/author.model.ts

@@ -1,9 +1,9 @@
 import { models } from 'models';
 
-import { AbstactBuilder } from './abstact.builder';
+import { AbstactModel } from './abstact.model';
 
 
-export class BookBuilder implements AbstactBuilder<models.book.Attributes, models.book.RawAttributes> {
+export class BookModel implements AbstactModel<models.book.Attributes, models.book.RawAttributes> {
 
     private id?: number;
     private title?: string;
@@ -17,9 +17,9 @@ export class BookBuilder implements AbstactBuilder<models.book.Attributes, model
     constructor(attributes?: models.book.Attributes | models.book.RawAttributes, isRaw = true) {
         if (attributes) {
             if (isRaw) {
-                this.mapRaw(attributes);
+                this.mapDatabaseObject(attributes);
             } else {
-                this.map(attributes);
+                this.mapJson(attributes);
             }
         }
     }
@@ -56,47 +56,47 @@ export class BookBuilder implements AbstactBuilder<models.book.Attributes, model
         return this.createdAt;
     };
 
-    public setId(id: number): BookBuilder {
+    public setId(id: number): BookModel {
         this.id = id;
         return this;
     };
 
-    public setTitle(title: string): BookBuilder {
+    public setTitle(title: string): BookModel {
         this.title = title;
         return this;
     };
 
-    public setDescription(description: string): BookBuilder {
+    public setDescription(description: string): BookModel {
         this.description = description;
         return this;
     };
 
-    public setPrice(price: number): BookBuilder {
+    public setPrice(price: number): BookModel {
         this.price = price;
         return this;
     };
 
-    public setAuthorId(authorId: number): BookBuilder {
+    public setAuthorId(authorId: number): BookModel {
         this.authorId = authorId;
         return this;
     };
 
-    public setPublishedAt(publishedAt: Date): BookBuilder {
+    public setPublishedAt(publishedAt: Date): BookModel {
         this.publishedAt = publishedAt;
         return this;
     };
 
-    public setUpdatedAt(updatedAt: Date): BookBuilder {
+    public setUpdatedAt(updatedAt: Date): BookModel {
         this.updatedAt = updatedAt;
         return this;
     };
 
-    public setCreatedAt(createdAt: Date): BookBuilder {
+    public setCreatedAt(createdAt: Date): BookModel {
         this.createdAt = createdAt;
         return this;
     };
 
-    public map(attributes: models.book.Attributes): BookBuilder {
+    public mapJson(attributes: models.book.Attributes): BookModel {
         if (attributes !== undefined) {
             this.setId(attributes.id);
             this.setTitle(attributes.title);
@@ -110,7 +110,7 @@ export class BookBuilder implements AbstactBuilder<models.book.Attributes, model
         return this;
     }
 
-    public mapRaw(attributes: models.book.RawAttributes): BookBuilder {
+    public mapDatabaseObject(attributes: models.book.RawAttributes): BookModel {
         if (attributes !== undefined) {
             this.setId(attributes.id);
             this.setTitle(attributes.title);
@@ -128,11 +128,11 @@ export class BookBuilder implements AbstactBuilder<models.book.Attributes, model
         // TODO Check id all required attributes ar given
     }
 
-    public build() {
+    public toJson() {
         return new Book(this);
     }
 
-    public buildRaw() {
+    public toDatabaseObject() {
         return new RawBook(this);
     }
 
@@ -148,7 +148,7 @@ export class Book implements models.book.Attributes {
     public updatedAt?: Date;
     public createdAt?: Date;
 
-    constructor(builder: BookBuilder) {
+    constructor(builder: BookModel) {
         this.id = builder.Id;
         this.title = builder.Title;
         this.description = builder.Description;
@@ -170,7 +170,7 @@ export class RawBook implements models.book.RawAttributes {
     public updated_at?: Date;
     public created_at?: Date;
 
-    constructor(builder: BookBuilder) {
+    constructor(builder: BookModel) {
         this.id = builder.Id;
         this.title = builder.Title;
         this.description = builder.Description;

src/builders/book.builder.ts src/models/book.model.ts

@@ -2,7 +2,7 @@ import * as Knex from 'knex';
 
 import { models } from 'models';
 import { AUTHOR } from '../common/tables';
-import { AuthorBuilder } from '../builders/author.builder';
+import { AuthorModel } from '../models/author.model';
 import { AbstractRepository } from './abstract.repository';
 import { Utils } from '../common/utils';
 
@@ -26,7 +26,7 @@ export class AuthorRepository extends AbstractRepository<Knex> {
             .from(AUTHOR)
             .limit(options.limit)
             .offset(options.offset);
-        return results.map((result) => new AuthorBuilder(result).build());
+        return results.map((result) => new AuthorModel(result).toJson());
     }
 
     /**
@@ -41,7 +41,7 @@ export class AuthorRepository extends AbstractRepository<Knex> {
         log.debug('findAuthorById called with id=', id);
         const results = await this.db.select().from(AUTHOR).where('id', id);
         Utils.assertResults(results, id);
-        return (new AuthorBuilder(Utils.single(results))).build();
+        return (new AuthorModel(Utils.single(results))).toJson();
     }
 
     /**
@@ -56,7 +56,7 @@ export class AuthorRepository extends AbstractRepository<Knex> {
         log.debug('findAuthorByIds called with ids=', ids);
         const results = await this.db.select().from(AUTHOR).whereIn('id', ids);
         Utils.assertResults(results, ids);
-        return results.map((result) => new AuthorBuilder(result).build());
+        return results.map((result) => new AuthorModel(result).toJson());
     }
 
 }

src/repositories/author.repository.ts

@@ -2,7 +2,7 @@ import * as Knex from 'knex';
 
 import { models } from 'models';
 import { BOOK } from '../common/tables';
-import { BookBuilder } from '../builders/book.builder';
+import { BookModel } from '../models/book.model';
 import { AbstractRepository } from './abstract.repository';
 import { Utils } from '../common/utils';
 
@@ -26,7 +26,7 @@ export class BookRepository extends AbstractRepository<Knex> {
             .from(BOOK)
             .limit(options.limit)
             .offset(options.offset);
-        return results.map((result) => new BookBuilder(result).build());
+        return results.map((result) => new BookModel(result).toJson());
     }
 
     /**
@@ -41,7 +41,7 @@ export class BookRepository extends AbstractRepository<Knex> {
         log.debug('findBookById called with id=', id);
         const results = await this.db.select().from(BOOK).where('id', id);
         Utils.assertResults(results, id);
-        return (new BookBuilder(Utils.single(results))).build();
+        return (new BookModel(Utils.single(results))).toJson();
     }
 
     /**
@@ -55,7 +55,7 @@ export class BookRepository extends AbstractRepository<Knex> {
     public async findBookByAuthorId(id: number): Promise<models.book.Attributes> {
         log.debug('findBookByAuthorId called with id=', id);
         const results = await this.db.select().from(BOOK).where('author_id', id);
-        return results.map((result) => new BookBuilder(result).build());
+        return results.map((result) => new BookModel(result).toJson());
     }
 
     /**
@@ -70,7 +70,7 @@ export class BookRepository extends AbstractRepository<Knex> {
         log.debug('findBooksByIds called with ids=', ids);
         const results = await this.db.select().from(BOOK).whereIn('id', ids);
         Utils.assertResults(results, ids);
-        return results.map((result) => new BookBuilder(result).build());
+        return results.map((result) => new BookModel(result).toJson());
     }
 
 }

src/repositories/book.repository.ts

@@ -3,7 +3,7 @@ import { GraphQLFieldDefinition } from 'graphql';
 import { Context } from '../../context';
 import { AbstractField, IGraphQLField } from '../abstract.field';
 import { AuthorType } from '../author/author.type';
-import { Book } from '../../builders/book.builder';
+import { Book } from '../../models/book.model';
 
 import { Logger } from '../../core/logger';
 const log = Logger('app:schemas:author:AuthorField');

src/schemas/author/author.field.ts

@@ -3,7 +3,7 @@ import { GraphQLFieldDefinition, GraphQLList } from 'graphql';
 import { Context } from '../../context';
 import { AbstractField, IGraphQLField } from '../abstract.field';
 import { BookType } from '../book/book.type';
-import { Author } from '../../builders/author.builder';
+import { Author } from '../../models/author.model';
 
 import { Logger } from '../../core/logger';
 const log = Logger('app:schemas:book:BooksField');