Flesh out low-level relationship API

Author: Lee Richmond

src/associations.ts

@@ -2,12 +2,26 @@ import Attribute from './attribute';
 import Model from './model';
 
 class Base extends Attribute {
+  klass: typeof Model;
+  isRelationship = true;
+  jsonapiType: string;
+
+  constructor(...args) {
+    super();
+    this.jsonapiType = args[0];
+  }
+
   getter(context: Model) {
     return context.relationships[this.name];
   }
 
   setter(context: Model, val: any) : void {
-    context.relationships[this.name] = val;
+    if (!val.hasOwnProperty('isRelationship')) {
+      if (!(val instanceof Model) && !(Array.isArray(val))) {
+        val = new this.klass(val);
+      }
+      context.relationships[this.name] = val;
+    }
   }
 }
 
@@ -29,16 +43,16 @@ class HasOne extends Base {
 class BelongsTo extends Base {
 }
 
-const hasMany = function() : HasMany {
-  return new HasMany();
+const hasMany = function(...args) : HasMany {
+  return new HasMany(...args);
 }
 
-const hasOne = function() : HasOne {
-  return new HasOne();
+const hasOne = function(...args) : HasOne {
+  return new HasOne(...args);
 }
 
-const belongsTo = function() : BelongsTo {
-  return new BelongsTo();
+const belongsTo = function(...args) : BelongsTo {
+  return new BelongsTo(...args);
 }
 
 export { hasMany, hasOne, belongsTo };

src/attribute.ts

@@ -2,6 +2,7 @@
 // transforms, default values, etc.
 
 import Model from './model';
+import Config from './configuration';
 
 export default class Attribute {
   name: string;
@@ -23,6 +24,11 @@ export default class Attribute {
 
         let attrInstance = instance[propName];
         attrInstance.name = propName;
+
+        if (attrInstance.isRelationship) {
+          attrInstance.klass = Config.modelForType(attrInstance.jsonapiType || attrInstance.name);
+        }
+
         callback(attrInstance);
       }
     }

src/configuration.ts

@@ -10,6 +10,9 @@ export default class Config {
   static bootstrap() : void {
     for (let model of this.models) {
       this.typeMapping[model.jsonapiType] = model;
+    }
+
+    for (let model of this.models) {
       Attribute.applyAll(model);
     }
   }

test/fixtures.ts

@@ -1,4 +1,4 @@
-import { Model, Config, attr, hasMany, belongsTo } from '../src/main';
+import { Model, Config, attr, hasMany, belongsTo, hasOne } from '../src/main';
 
 // typescript class
 class Person extends Model {
@@ -18,7 +18,8 @@ let Author = Person.extend({
   },
 
   books: hasMany(),
-  genre: belongsTo()
+  genre: belongsTo('genres'),
+  bio:   hasOne('bios')
 });
 
 class Book extends Model {
@@ -30,11 +31,17 @@ class Book extends Model {
 class Genre extends Model {
   static jsonapiType = 'genres';
 
-  authors: any = hasMany()
+  authors: any = hasMany('authors')
 
   name: string = attr();
 }
 
+class Bio extends Model {
+  static jsonapiType = 'bios';
+
+  description: string = attr()
+}
+
 Config.bootstrap();
 
-export { Author, Person, Book, Genre };
+export { Author, Person, Book, Genre, Bio };

test/integration/finders-test.ts

@@ -1,6 +1,4 @@
 import '../../test/test-helper';
-//import { Model, Config } from '../../src/main';
-
 import { Person, Author } from '../fixtures';
 
 let fetchMock = require('fetch-mock');
@@ -15,7 +13,10 @@ describe('Model finders', function() {
       fetchMock.get('http://example.com/api/v1/people/1', {
         data: {
           id: '1',
-          type: 'people'
+          type: 'people',
+          attributes: {
+            name: 'John'
+          }
         }
       });
     });
@@ -26,6 +27,11 @@ describe('Model finders', function() {
         .have.property('id', '1');
     });
 
+    it('assigns attributes correctly', function() {
+      return expect(Person.find(1)).to.eventually
+        .have.property('name', 'John')
+    });
+
     describe('when API response returns a different type than the caller', function() {
       before(function() {
         fetchMock.restore();

test/unit/model-test.ts

@@ -2,7 +2,7 @@
 
 import { sinon } from '../../test/test-helper';
 import { Model } from '../../src/main';
-import { Person, Author, Book, Genre } from '../fixtures';
+import { Person, Author, Book, Genre, Bio } from '../fixtures';
 
 let instance;
 
@@ -27,6 +27,12 @@ describe('Model', function() {
               id: '1',
               type: 'books'
             }]
+          },
+          bio: {
+            data: {
+              id: '1',
+              type: 'bios'
+            }
           }
         },
         meta: {
@@ -62,6 +68,13 @@ describe('Model', function() {
           attributes: {
             name: 'Maurice Sendak'
           }
+        },
+        {
+          type: 'bios',
+          id: '1',
+          attributes: {
+            description: 'Some Dude.'
+          }
         }
       ]
     };
@@ -106,6 +119,13 @@ describe('Model', function() {
       expect(genre.name).to.eq("Children's");
     });
 
+    it('assigns hasOne relationships correctly', function() {
+      let instance = Model.fromJsonapi(doc.data, doc);
+      let bio = instance.bio;
+      expect(bio).to.be.instanceof(Bio);
+      //expect(bio.description).to.eq("Some Dude.");
+    });
+
     it('assigns nested relationships correctly', function() {
       let instance = Model.fromJsonapi(doc.data, doc);
       let authors = instance.genre.authors;

test/unit/relationships-test.ts

@@ -0,0 +1,38 @@
+/// <reference path="../../index.d.ts" />
+
+import { sinon } from '../../test/test-helper';
+import { Author, Genre } from '../fixtures';
+
+describe('Model relationships', function() {
+  it('supports direct assignment of models', function() {
+    let author = new Author();
+    author.genre = new Genre({ name: 'Horror' });
+    expect(author.genre).to.be.instanceof(Genre);
+    expect(author.genre.name).to.eq('Horror');
+  });
+
+  it('supports direct assignment of objects', function() {
+    let author = new Author();
+    author.genre = { name: 'Horror' };
+    expect(author.genre).to.be.instanceof(Genre);
+    expect(author.genre.name).to.eq('Horror');
+  });
+
+  it('supports constructor assignment of models', function() {
+    let genre = new Genre({ name: 'Horror' });
+    let author = new Author({ genre: genre });
+    expect(author.genre).to.be.instanceof(Genre);
+    expect(author.genre.name).to.eq('Horror');
+  });
+
+  it('supports constructor assignment of objects', function() {
+    let author = new Author({ genre: { name: 'Horror' }});
+    expect(author.genre).to.be.instanceof(Genre);
+    expect(author.genre.name).to.eq('Horror');
+  });
+
+  it('defaults hasMany to empty array', function() {
+    let genre = new Genre();
+    expect(genre.authors).to.eql([]);
+  });
+});