Add support for extra_fields

Author: Lee Richmond

src/model.ts

@@ -73,6 +73,10 @@ export default class Model {
     return this.scope().select(clause);
   }
 
+  static selectExtra(clause: Object) : Scope {
+    return this.scope().selectExtra(clause);
+  }
+
   static includes(clause: string | Object | Array<any>) : Scope {
     return this.scope().includes(clause);
   }

src/scope.ts

@@ -11,6 +11,7 @@ export default class Scope {
   _filter: Object = {};
   _sort: Object = {};
   _fields: Object = {};
+  _extra_fields: Object = {};
   _include: Object = {};
 
   constructor(model : typeof Model) {
@@ -75,6 +76,14 @@ export default class Scope {
     return this;
   }
 
+  selectExtra(clause: Object) {
+    for (let key in clause) {
+      this._extra_fields[key] = clause[key];
+    }
+
+    return this;
+  }
+
   includes(clause: Object | string | Array<any>) : Scope {
     let directive = new IncludeDirective(clause);
     let directiveObject = directive.toObject();
@@ -89,11 +98,12 @@ export default class Scope {
   asQueryParams() : Object {
     let qp = {};
 
-    qp['page']    = this._pagination;
-    qp['filter']  = this._filter;
-    qp['sort']    = this._sortParam(this._sort);
-    qp['fields']  = this._fields;
-    qp['include'] = new IncludeDirective(this._include).toString();
+    qp['page']          = this._pagination;
+    qp['filter']        = this._filter;
+    qp['sort']          = this._sortParam(this._sort);
+    qp['fields']        = this._fields;
+    qp['extra_fields']  = this._extra_fields;
+    qp['include']       = new IncludeDirective(this._include).toString();
 
     return qp;
   }

test/integration/finders-test.ts

@@ -166,6 +166,22 @@ describe('Model finders', function() {
     });
   });
 
+  describe('#select_extra', function() {
+    before(function () {
+      fetchMock.get('http://example.com/api/v1/people?extra_fields[people]=net_worth,best_friend', {
+        data: [
+          { id: '2', type: 'people' }
+        ]
+      });
+    });
+
+    it('queries correctly', function() {
+      return expect(Person.selectExtra({ people: ['net_worth', 'best_friend'] }).all()).to.eventually
+        .all.be.instanceof(Person)
+        .all.have.property('id', '2')
+    });
+  });
+
   describe('#includes', function() {
     before(function () {
       fetchMock.get('http://example.com/api/v1/people?include=a.b,a.c.d', {

test/unit/scope-test.ts

@@ -129,6 +129,7 @@ describe('Scope', function() {
         .order({ bar: 'desc' })
         .select({ people: ['name', 'age'] })
         .select({ pets: ['type'] })
+        .selectExtra({ people: ['net_worth'] })
         .includes({ a: ['b', { c: 'd' }] })
       let qp = scope.asQueryParams();
 
@@ -146,6 +147,9 @@ describe('Scope', function() {
           people: ['name', 'age'],
           pets: ['type']
         },
+        extra_fields: {
+          people: ['net_worth']
+        },
         include: 'a.b,a.c.d'
       });
     });
@@ -164,6 +168,11 @@ describe('Scope', function() {
       expect(scope.toQueryParams()).to.eq('page[number]=2&page[size]=10&filter[foo]=bar&sort=foo,-bar&fields[people]=name,age&include=a.b,a.c.d');
     });
 
+    it('does not include empty objects', function() {
+      scope.page(2);
+      expect(scope.toQueryParams().match(/field/) === null).to.eq(true);
+    });
+
     describe('when no scoping criteria present', function() {
       it('returns undefined', function() {
         expect(scope.toQueryParams()).to.eq(undefined);