Merge pull request #4 from wtandy/collection_proxy

CollectionProxy, Scope#stats

Author: Lee Richmond

gulpfile.js

@@ -3,6 +3,7 @@ const mocha   = require('gulp-mocha');
 const webpack = require('webpack-stream');
 const ts      = require('gulp-typescript');
 const del     = require('del');
+const watch   = require('gulp-watch');
 
 var tsProject = ts.createProject('tsconfig.json');
 
@@ -18,6 +19,12 @@ gulp.task('test', ['clean:test'], () =>
     .pipe(mocha())
 );
 
+gulp.task('watch', function () {
+  return watch(['src/**/*', 'test/**/*'], function () {
+    gulp.start('test')
+  })
+});
+
 gulp.task('test-browser', function () {
   gulp
     .src(['./index.d.ts.', './src/main.ts', './src/**/*.ts', './test/fixtures.ts', './test/test-helper.ts', './test/**/*-test.ts'], { base: '.' })

index.d.ts

@@ -13,7 +13,8 @@ declare module NodeJS  {
 
 interface japiDoc {
   data: any; // can't do Array | japiResource
-  included: Array<japiResource>;
+  included?: Array<japiResource>;
+  meta?: any;
 }
 
 interface japiResourceIdentifier {
@@ -27,3 +28,9 @@ interface japiResource extends japiResourceIdentifier {
   meta?: Object;
   links?: Object;
 }
+
+interface IResultProxy<T> {
+  data: any
+  meta: Object
+  raw: japiDoc
+}

package.json

@@ -30,6 +30,7 @@
     "gulp-clean": "^0.3.2",
     "gulp-mocha": "^3.0.1",
     "gulp-typescript": "^3.1.3",
+    "gulp-watch": "4.3.11",
     "json-loader": "^0.5.4",
     "mocha": "^3.2.0",
     "sinon": "^1.17.6",

src/model.ts

@@ -4,6 +4,7 @@ import Scope from './scope';
 import Config from './configuration';
 import Attribute from './attribute';
 import deserialize from './util/deserialize';
+import { CollectionProxy, RecordProxy } from './proxies';
 import _extend from './util/extend';
 import { camelize } from './util/string';
 
@@ -41,11 +42,11 @@ export default class Model {
     this.attributes = attributes;
   }
 
-  static all() : Promise<Array<Model>> {
+  static all() : Promise<CollectionProxy<Model>> {
     return this.scope().all();
   }
 
-  static find(id : string | number) : Promise<Model> {
+  static find(id : string | number) : Promise<RecordProxy<Model>> {
     return this.scope().find(id);
   }
 

src/proxies.ts

@@ -0,0 +1,7 @@
+import CollectionProxy from './proxies/collection-proxy'
+import RecordProxy from './proxies/record-proxy'
+
+export {
+  CollectionProxy,
+  RecordProxy
+}

src/proxies/collection-proxy.ts

@@ -0,0 +1,34 @@
+import Model from '../model';
+
+class CollectionProxy<T> implements IResultProxy<T> {
+  private _raw_json : japiDoc;
+  private _array : Array<T>;
+
+  constructor (raw_json : japiDoc = { data: [] }) {
+    this.setRaw(raw_json);
+  }
+
+  get raw () : japiDoc {
+    return this._raw_json;
+  }
+
+  get data () : Array<T> {
+    return this._array;
+  }
+
+  get meta () : Object {
+    return this.raw.meta || {};
+  }
+
+  private setRaw = (json_payload : japiDoc) => {
+    this._raw_json = json_payload;
+
+    this._array = [];
+
+    this.raw.data.map((datum : japiResource) => {
+      this._array.push(Model.fromJsonapi(datum, this.raw));
+    });
+  }
+}
+
+export default CollectionProxy;

src/proxies/record-proxy.ts

@@ -0,0 +1,34 @@
+import Model from '../model';
+
+class RecordProxy<T> implements IResultProxy<T> {
+  private _raw_json : japiDoc;
+  private _model : T;
+
+  constructor (raw_json : japiDoc = { data: [] }) {
+    this.setRaw(raw_json);
+  }
+
+  get raw () : japiDoc {
+    return this._raw_json;
+  }
+
+  get data () : T {
+    return this._model;
+  }
+
+  get meta () : Object {
+    return this.raw.meta || {};
+  }
+
+  private setRaw = (json_payload : japiDoc) => {
+    this._raw_json = json_payload;
+
+    if (this.raw.data) {
+      this._model = Model.fromJsonapi(this.raw.data, this.raw);
+    } else {
+      this._model = null
+    }
+  }
+}
+
+export default RecordProxy;

src/scope.ts

@@ -2,6 +2,7 @@ import Model from './model';
 import Config from './configuration';
 import parameterize from './util/parameterize';
 import IncludeDirective from './util/include-directive';
+import { CollectionProxy, RecordProxy } from './proxies';
 import Request from './request';
 import colorize from './util/colorize';
 
@@ -13,29 +14,30 @@ export default class Scope {
   _fields: Object = {};
   _extra_fields: Object = {};
   _include: Object = {};
+  _stats: Object = {};
 
   constructor(model : typeof Model) {
     this.model = model;
   }
 
-  all() : Promise<Array<Model>> {
+  all() : Promise<CollectionProxy<Model>> {
     return this._fetch(this.model.url()).then((json : japiDoc) => {
-      return json.data.map((datum : japiResource) => {
-        return Model.fromJsonapi(datum, json);
-      });
+      let collection = new CollectionProxy(json);
+
+      return  collection;
     });
   }
 
-  find(id : string | number) : Promise<Model> {
+  find(id : string | number) : Promise<RecordProxy<Model>> {
     return this._fetch(this.model.url(id)).then((json : japiDoc) => {
-      return Model.fromJsonapi(json.data, json);
+      return new RecordProxy(json)
     });
   }
 
   // TODO: paginate 1
   first() : Promise<Model> {
-    return this.per(1).all().then((models : Array<Model>) => {
-      return models[0];
+    return this.per(1).all().then((models : CollectionProxy<Model>) => {
+      return models.data[0];
     });
   }
 
@@ -56,6 +58,13 @@ export default class Scope {
     return this;
   }
 
+  stats(clause: Object) : Scope {
+    for (let key in clause) {
+      this._stats[key] = clause[key];
+    }
+    return this;
+  }
+
   order(clause: Object | string) : Scope {
     if (typeof clause == "object") {
       for (let key in clause) {
@@ -95,6 +104,13 @@ 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;
+  }
+
   asQueryParams() : Object {
     let qp = {};
 
@@ -103,6 +119,7 @@ export default class Scope {
     qp['sort']          = this._sortParam(this._sort);
     qp['fields']        = this._fields;
     qp['extra_fields']  = this._extra_fields;
+    qp['stats']         = this._stats;
     qp['include']       = new IncludeDirective(this._include).toString();
 
     return qp;

test/integration/finders-test.ts

@@ -7,6 +7,12 @@ after(function () {
   fetchMock.restore();
 });
 
+let resultData = function(promise) {
+  return promise.then(function(proxyObject) {
+    return proxyObject.data
+  })
+}
+
 describe('Model finders', function() {
   describe('#find()', function() {
     before(function () {
@@ -22,13 +28,13 @@ describe('Model finders', function() {
     });
 
     it('returns a promise that resolves the correct instance', function() {
-      return expect(Person.find(1)).to.eventually
+      return expect(resultData(Person.find(1))).to.eventually
         .be.instanceof(Person).and
         .have.property('id', '1');
     });
 
     it('assigns attributes correctly', function() {
-      return expect(Person.find(1)).to.eventually
+      return expect(resultData(Person.find(1))).to.eventually
         .have.property('name', 'John')
     });
 
@@ -44,7 +50,7 @@ describe('Model finders', function() {
       });
 
       it('resolves to the correct class', function() {
-        return expect(Person.find(1)).to.eventually
+        return expect(resultData(Person.find(1))).to.eventually
           .be.instanceof(Author);
       });
     });
@@ -71,7 +77,8 @@ describe('Model finders', function() {
   });
 
   describe('#all()', function() {
-    before(function () {
+    beforeEach(function () {
+      fetchMock.restore();
       fetchMock.get('http://example.com/api/v1/people', {
         data: [
           { id: '1', type: 'people' }
@@ -80,10 +87,33 @@ describe('Model finders', function() {
     });
 
     it('returns a promise that resolves the correct instances', function() {
-      return expect(Person.all()).to.eventually
+      return expect(resultData(Person.all())).to.eventually
         .all.be.instanceof(Person)
         .all.have.property('id', '1')
     });
+
+    describe('response includes a meta payload', function() {
+      beforeEach(function () {
+        fetchMock.restore();
+        fetchMock.get('http://example.com/api/v1/people', {
+          data: [
+            { id: '1', type: 'people' }
+          ],
+          meta: {
+            stats: {
+              total: {
+                count: 45
+              },
+            }
+          }
+        });
+      });
+
+      it('includes meta payload in the resulting collection', function() {
+        return expect(Person.all()).to.eventually
+          .have.deep.property('meta.stats.total.count', 45)
+      });
+    });
   });
 
   describe('#page', function() {
@@ -96,25 +126,24 @@ describe('Model finders', function() {
     });
 
     it('queries correctly', function() {
-      return expect(Person.page(2).all()).to.eventually
+      return expect(resultData(Person.page(2).all())).to.eventually
         .all.be.instanceof(Person)
         .all.have.property('id', '2')
     });
   });
 
   describe('#per', function() {
     before(function () {
-      fetchMock.get('http://example.com/api/v1/people?page[size]=10', {
+      fetchMock.get('http://example.com/api/v1/people?page[size]=2', {
         data: [
-          { id: '2', type: 'people' }
+          { id: '1', type: 'people' }
         ]
       });
     });
 
     it('queries correctly', function() {
-      return expect(Person.page(2).all()).to.eventually
+      return expect(resultData(Person.per(2).all())).to.eventually
         .all.be.instanceof(Person)
-        .all.have.property('id', '2')
     });
   });
 
@@ -128,7 +157,7 @@ describe('Model finders', function() {
     });
 
     it('queries correctly', function() {
-      return expect(Person.order('foo').order({ bar: 'desc' }).all()).to.eventually
+      return expect(resultData(Person.order('foo').order({ bar: 'desc' }).all())).to.eventually
         .all.be.instanceof(Person)
         .all.have.property('id', '2')
     });
@@ -144,7 +173,7 @@ describe('Model finders', function() {
     });
 
     it('queries correctly', function() {
-      return expect(Person.where({ id: 2 }).where({ a: 'b' }).all()).to.eventually
+      return expect(resultData(Person.where({ id: 2 }).where({ a: 'b' }).all())).to.eventually
         .all.be.instanceof(Person)
         .all.have.property('id', '2')
     });
@@ -160,7 +189,7 @@ describe('Model finders', function() {
     });
 
     it('queries correctly', function() {
-      return expect(Person.select({ people: ['name', 'age'] }).all()).to.eventually
+      return expect(resultData(Person.select({ people: ['name', 'age'] }).all())).to.eventually
         .all.be.instanceof(Person)
         .all.have.property('id', '2')
     });
@@ -176,7 +205,7 @@ describe('Model finders', function() {
     });
 
     it('queries correctly', function() {
-      return expect(Person.selectExtra({ people: ['net_worth', 'best_friend'] }).all()).to.eventually
+      return expect(resultData(Person.selectExtra({ people: ['net_worth', 'best_friend'] }).all())).to.eventually
         .all.be.instanceof(Person)
         .all.have.property('id', '2')
     });
@@ -195,7 +224,7 @@ describe('Model finders', function() {
     });
 
     it('queries correctly', function() {
-      return expect(Person.includes({ a: ['b', { c: 'd' }] }).all()).to.eventually
+      return expect(resultData(Person.includes({ a: ['b', { c: 'd' }] }).all())).to.eventually
         .all.be.instanceof(Person)
         .all.have.property('id', '2')
     });