Pull Request cleanup items

Mostly making CollectionProxy more consistent.  Was half acting like an
array and half acting like a thing that passes on an array when asked.
Made it be the latter.

Author: wadetandy

index.d.ts

@@ -13,7 +13,7 @@ declare module NodeJS  {
 
 interface japiDoc {
   data: any; // can't do Array | japiResource
-  included: Array<japiResource>;
+  included?: Array<japiResource>;
   meta?: any;
 }
 

src/collection-proxy.ts

@@ -4,38 +4,26 @@ class CollectionProxy<T> {
   private _raw_json : japiDoc;
   private _array : Array<T>;
 
-  constructor (raw_json : japiDoc = { data: [], included: [] }) {
-    this.setRaw(raw_json)
+  constructor (raw_json : japiDoc = { data: [] }) {
+    this.setRaw(raw_json);
   }
 
   get raw () : japiDoc {
-    return this._raw_json
+    return this._raw_json;
   }
 
   get data () : Array<T> {
-    return this._array
-  }
-
-  get collection () : Array<T> {
-    return this._array
+    return this._array;
   }
 
   get meta () : Object {
-    if (this.raw) {
-      return this.raw.meta || {}
-    }
-
-    return {}
-  }
-
-  map (fn) {
-    return this.data.map(fn)
+    return this.raw.meta || {};
   }
 
   private setRaw = (json_payload : japiDoc) => {
-    this._raw_json = json_payload
+    this._raw_json = json_payload;
 
-    this._array = []
+    this._array = [];
 
     if (this.raw.data) {
       this.raw.data.map((datum : japiResource) => {
@@ -45,4 +33,4 @@ class CollectionProxy<T> {
   }
 }
 
-export default CollectionProxy
+export default CollectionProxy;

src/scope.ts

@@ -22,9 +22,9 @@ export default class Scope {
 
   all() : Promise<CollectionProxy<Model>> {
     return this._fetch(this.model.url()).then((json : japiDoc) => {
-      let collection = new CollectionProxy(json)
+      let collection = new CollectionProxy(json);
 
-      return  collection
+      return  collection;
     });
   }
 
@@ -104,6 +104,9 @@ export default class Scope {
     return this;
   }
 
+  // The `Model` class has a `scope()` method to return the scope for it.
+  // This method makes it possible for methods to expect either a model or
+  // a scope and reliably cast them to a scope for use via `scope()`
   scope() : Scope {
     return this;
   }

test/integration/finders-test.ts

@@ -109,7 +109,7 @@ describe('Model finders', function() {
         });
       });
 
-      it('promise collection includes meta payload', function() {
+      it('includes meta payload in the resulting collection', function() {
         return expect(Person.all()).to.eventually
           .have.deep.property('meta.stats.total.count', 45)
       });

test/unit/collection-proxy-test.ts

@@ -3,9 +3,6 @@ import { Person } from '../fixtures';
 
 import CollectionProxy from '../../src/collection-proxy'
 
-beforeEach(function() {
-});
-
 describe('CollectionProxy', function() {
   let personData = {
     data: [
@@ -48,12 +45,16 @@ describe('CollectionProxy', function() {
       let collection = new CollectionProxy(personData)
       expect(collection.meta).to.eq(personData.meta)
     })
-  })
 
-  describe('#collection', function() {
-    it('should alias the data field', function() {
-      let collection = new CollectionProxy(personData)
-      expect(collection.collection).to.eq(collection.data)
+    describe('meta is null', function() {
+      let personData = {
+        data: [],
+      }
+
+      it('should return an empty object', function() {
+        let collection = new CollectionProxy(personData)
+        expect(collection.meta).to.deep.eq({})
+      })
     })
   })
 })

test/unit/model-test.ts

@@ -174,7 +174,7 @@ describe('Model', function() {
 
     it('skips relationships without data', function() {
       let instance = Model.fromJsonapi(doc.data, doc);
-      expect(instance.tags.length).to.eql(0);
+      expect(instance.tags).to.eql([]);
     });
   });
 });