Merge pull request #5 from Exelord/feature-promise-types

Add posibility to bind results

Author: Exelord

README.md

@@ -81,7 +81,8 @@ module.exports = function(environment) {
       type: 'PUT',
       ajaxOptions: {},
       pushToStore: false,
-      normalizeOperation: ''
+      normalizeOperation: '',
+      promiseType: null
     },
   };
 
@@ -133,6 +134,27 @@ It's great for API with request data format restrictions
   - decamelize
   - underscore
 
+
+#### `promiseType`
+You can easily observe a returned model by changing promiseType to `array` or `object` according to what type of data
+your server will return.
+
+When `array`:
+```js
+model.customAction({}, { promiseType: 'array' }) // returns DS.PromiseArray
+```
+
+When `object`:
+```js
+model.customAction({}, { promiseType: 'object' }) // returns DS.PromiseObject
+```
+
+When `null` (default):
+```js
+model.customAction({}, { promiseType: null }) // returns Promise
+```
+`null` is useful if you don't care about the response or just want to use `then` on the promise without using `binding` or display it in the template.
+
 # Development
 
 ## Installation

addon/actions/action.js

@@ -1,9 +1,18 @@
+/* eslint ember-suave/no-direct-property-access:1 */
+
 import Ember from 'ember';
+import DS from 'ember-data';
+
 import UrlBuilder from '../utils/url-builder';
 import normalizePayload from '../utils/normalize-payload';
 import defaultConfig from '../config';
 
-const { assign, getOwner, computed, isArray, ArrayProxy, ObjectProxy, Object } = Ember;
+const { assign, getOwner, computed, Object } = Ember;
+
+const promiseTypes = {
+  array: DS.PromiseArray,
+  object: DS.PromiseObject
+};
 
 export default Object.extend({
   model: null,
@@ -61,18 +70,22 @@ export default Object.extend({
     return assign(this.get('config.ajaxOptions'), { data });
   }),
 
+  promiseType: computed('config.promiseType', function() {
+    return promiseTypes[this.get('config.promiseType')];
+  }),
+
   callAction() {
+    let promise = this._promise();
+    return this.get('promiseType') ? this.get('promiseType').create({ promise }) : promise;
+  },
+
+  _promise() {
     return this.get('adapter').ajax(this.get('url'), this.get('requestType'), this.get('data')).then((response) => {
       if (this.get('config.pushToStore') && response.data) {
-        return this._pushToStore(this.get('serializer').pushPayload(this.get('store'), response));
+        return this.get('serializer').pushPayload(this.get('store'), response);
       } else {
         return response;
       }
     });
-  },
-
-  _pushToStore(content) {
-    let proxy = isArray(content) ? ArrayProxy : ObjectProxy;
-    return proxy.create({ content });
   }
 });

addon/config.js

@@ -2,5 +2,6 @@ export default {
   type: 'PUT',
   ajaxOptions: {},
   pushToStore: false,
-  normalizeOperation: ''
+  normalizeOperation: '',
+  promiseType: null
 };

tests/dummy/app/components/model-action/component.js

@@ -0,0 +1,15 @@
+import Ember from 'ember';
+
+const { Component, inject, computed } = Ember;
+
+export default Component.extend({
+  store: inject.service(),
+
+  post: computed('property', function() {
+    return this.get('store').createRecord('post', { id: 1 });
+  }),
+
+  status: computed('post', function() {
+    return this.get('post').publish();
+  })
+});

tests/dummy/app/components/model-action/template.hbs

@@ -0,0 +1 @@
+{{status.published}}

tests/dummy/app/models/post.js

@@ -1,8 +1,12 @@
 import Model from 'ember-data/model';
+import attr from 'ember-data/attr';
 import { modelAction, resourceAction } from 'ember-custom-actions';
 
 export default Model.extend({
-  publish: modelAction('publish'),
+  name: attr(),
+  published: attr(),
+
+  publish: modelAction('publish', { promiseType: 'object' }),
   list: resourceAction('list'),
   search: resourceAction('search', { type: 'GET', normalizeOperation: 'dasherize' })
 });

tests/dummy/app/routes/application.js

@@ -0,0 +1,18 @@
+import Ember from 'ember';
+import Pretender from 'pretender';
+
+const { Route } = Ember;
+
+export default Route.extend({
+  init() {
+    this._super(...arguments);
+    this.server = new Pretender();
+    this.mockServer();
+  },
+
+  mockServer() {
+    this.server.put('/posts/:id/publish', (request) => {
+      return [200, {}, `{"data": {"id": ${request.params.id}, "type": "Post", "attributes": {"published": true}}}`];
+    });
+  }
+});

tests/dummy/app/templates/application.hbs

@@ -1,5 +1 @@
-{{!-- The following component displays Ember's default welcome message. --}}
-{{welcome-page}}
-{{!-- Feel free to remove this! --}}
-
-{{outlet}}
+{{model-action}}

tests/dummy/app/templates/components/.gitkeep

@@ -1,3 +1,7 @@
+/* eslint ember-suave/no-direct-property-access:1 */
+
+import Ember from 'ember';
+import DS from 'ember-data';
 import { moduleForModel, test } from 'ember-qunit';
 import Pretender from 'pretender';
 
@@ -125,8 +129,28 @@ test('resource action pushes to store', function(assert) {
   assert.equal(store.peekAll('post').get('length'), 1);
 
   model.list(payload).then((response) => {
-    assert.equal(response.get('length'), 2);
+    assert.equal(response.length, 2);
     assert.equal(store.peekAll('post').get('length'), 3);
     done();
   });
 });
+
+test('promiseTypes', function(assert) {
+  assert.expect(6);
+
+  this.server.put('/posts/list', (request) => {
+    assert.equal(request.url, '/posts/list');
+
+    return [200, {}, '{"data": [{"id": "2", "type": "post"},{"id": "3", "type": "post"}]}'];
+  });
+
+  let model = this.subject();
+
+  let promise = model.list();
+  let promiseArray = model.list(null, { promiseType: 'array' });
+  let promiseObject = model.list(null, { promiseType: 'object' });
+
+  assert.equal(promise.constructor, Ember.RSVP.Promise);
+  assert.equal(promiseArray.constructor, DS.PromiseArray);
+  assert.equal(promiseObject.constructor, DS.PromiseObject);
+});