hippodrome 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 978fbc039b45352d86b23dfe98e7625418cf316a
-  data.tar.gz: 0939c65848ef70ef1d84cdb0c9bf5374d3459e6f
+  metadata.gz: 4bede62bfabff37412be8a2a77b34c462cf39129
+  data.tar.gz: 0851339e619a727f6dc56bbd7fb117445f52dd40
 SHA512:
-  metadata.gz: 462d65c404dc55118ce3eb795fae3089327919177766edd9783142fbb7d1ce1a1dcf373022101f0d8db0ea75f829afc9e53036d713ba5f91e27fda12aac692b6
-  data.tar.gz: 8297b6ce39ca69904bfc76e07c678a4c8f7a33f36b2780085d5fd347127c09b3cd713cf1d1b65d7aca8c455eb9b23e776f7ac453872bd139cc56c569bbea44b4
+  metadata.gz: 385c75fe65a11dce8e13075d9d15d5feebc894baab26c51869af3934ce8bc7fed2a5d7e888ca35d3bdbc008106779f1b75ad870948df52f440e0a44cbc17e77e
+  data.tar.gz: 888d384c1a98f3daad65e477fa2d89b833c8c0b6949d297b2ab46fda0283fc05f17ec36b15bb3b9e2554ebf22b54f3b66ea12c8401fc984ca623672e28b9cf2a

data/README.md

@@ -13,11 +13,13 @@ Hippodrome is an implementation of Facebook's
 [Flux](http://facebook.github.io/flux/docs/overview.html)
 architecture.  It adds some more structure (especially to Stores) to the ideas
 beyond what [Facebook's Flux](https://github.com/facebook/flux) has and
-includes Side Effects, objects that can respond to Actions (like Stores) but
+includes Deferred Tasks, objects that can respond to Actions (like Stores) but
 instead of exposing data to views, do additional asynchronous work like
 making a network request and possibly dispatching more actions based on the
 response.
 
+For a more in-depth explanation, [read this](./docs/hippodrome.md).
+
 ## Installation
 
 ### Rails
@@ -50,13 +52,27 @@ In your javascript manifest file:
 
     Hippodrome = require('hippodrome')
 
+## Contributing
 
-TODO: Explain how all the bits work.
+The actual project code is in `src/`.  `js/` and `app/` are where the compiled
+assets go to get picked up by npm and bundler, respectively.
 
-## Contributing
+In order to build the code, install [node](http://nodejs.org/) and
+[gulp](http://gulpjs.com/), install the dev dependencies with `npm install` and
+then build with `gulp build`.  This will deposit the compiled javascript to
+`js/` and `app/assets/javascripts/` and build a .gem file in `pkg/`.
+
+`test/hippodrome-test` is both a rails app and a node project that can run the
+tests in
+`test/hippodrome-test/specs/javascripts/hippodrome/hippodrome_spec.coffee`.
+
+To run the tests under rails, first `gulp build` in the project root, then
+`bundle` in the test project to install the gem, the either
+`rake spec:javascript` to run the tests in the console or `rails s` to start a
+WEBrick server and see the tests at
+[http://localhost:3000/specs](http://localhost:300/specs).
 
-1. Fork it ( http://github.com/structural/hippodrome/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+To run the tests under node, first `gulp build` in the project root, then
+`npm install` in the test directory (you may need to `rm -r node_modules/*` if
+you want to install the package again without bumping the version number), then
+`npm run test`.

data/app/assets/javascripts/hippodrome.js

@@ -1,7 +1,7 @@
 //= require lodash
 
 (function() {
-  var Action, DeferredTask, Dispatcher, Hippodrome, IdFactory, Store, actionIds, assert, bindToContextIfFunction, dispatcherIds, isNode, _,
+  var Action, DeferredTask, Dispatcher, Hippodrome, IdFactory, Store, actionIds, assert, bindToContextIfFunction, dispatcherIds, isNode, makeDeferredFunction, _,
     __slice = [].slice;
 
   isNode = typeof window === 'undefined';
@@ -160,18 +160,39 @@
 
   Hippodrome.Dispatcher = new Dispatcher();
 
+  makeDeferredFunction = function(context, fn) {
+    if (typeof fn === 'string') {
+      fn = context[fn];
+    }
+    fn = _.defer.bind(context, fn);
+    return fn;
+  };
+
   DeferredTask = function(options) {
     var action, id, task;
-    assert(options.action, 'DeferredTask must register for exactly one action.');
-    assert(options.task, 'DeferredTask must supply exactly one task to run');
-    action = options.action, task = options.task;
-    if (typeof task === 'string') {
-      task = this[task];
-    }
-    task = _.defer.bind(this, task);
-    id = Hippodrome.Dispatcher.register(this, action.id, [], task);
+    this.displayName = options.displayName;
+    assert(options.action || options.dispatches, "Deferred Task " + this.displayName + " must include either an action key or dispatches list.");
+    assert(!options.action || options.task, "Deferred Task " + this.displayName + " declared an action, it must declare a task.");
+    _.assign(this, _.omit(options, 'dispatches', 'action', 'task'), bindToContextIfFunction(this));
     this._dispatcherIdsByAction = {};
-    this._dispatcherIdsByAction[action.id] = id;
+    if (options.action && options.task) {
+      action = options.action, task = options.task;
+      task = makeDeferredFunction(this, task);
+      id = Hippodrome.Dispatcher.register(this, action.id, [], task);
+      this._dispatcherIdsByAction[action.id] = id;
+    }
+    if (options.dispatches) {
+      _.forEach(options.dispatches, (function(_this) {
+        return function(dispatch) {
+          var callback;
+          action = dispatch.action, callback = dispatch.callback;
+          assert(!_this._dispatcherIdsByAction[action.id], "Deferred Task " + _this.displayName + " registered two callbacks for the action " + action.displayName + ".");
+          callback = makeDeferredFunction(_this, callback);
+          id = Hippodrome.Dispatcher.register(_this, action.id, [], callback);
+          return _this._dispatcherIdsByAction[action.id] = id;
+        };
+      })(this));
+    }
     return this;
   };
 

data/app/assets/javascripts/hippodrome.min.js

@@ -1,3 +1,3 @@
 //= require lodash
 
-(function(){var t,i,s,r,n,e,a,o,c,l,p,u,h=[].slice;p="undefined"==typeof window,u=p?require("lodash"):this._,r={},o=function(){var t,i,s,r,n;if(s=arguments[0],n=arguments[1],i=3<=arguments.length?h.call(arguments,2):[],!s)throw t=0,r=new Error("Assertion Failed: "+n.replace(/%s/g,function(){return i[t++]})),r.framesToPop=1,r;return s},n=function(t){return this._lastId=1,this._prefix=t},n.prototype.next=function(){return""+this._prefix+"_"+this._lastId++},a=new n("Action_ID"),t=function(t,i){var s,n,e,o;return e=""+a.next()+"_"+t,n=function(){var t;return t=i.apply(null,arguments),t.action=e,t},o=function(t){return r.Dispatcher.dispatch(t)},s=function(){var t;return t=n.apply(null,arguments),o(t)},s.buildPayload=n,s.send=o,s.displayName=t,s.id=e,s.toString=function(){return e},s},r.Action=t,s=function(){return this._callbacksByAction={},this._isStarted={},this._isFinished={},this._isDispatching=!1,this._payload=null},l=new n("Dispatcher_ID"),s.prototype.register=function(){var t,i,s,r,n,e,a;return i=u.compact(arguments),3===i.length?this.register(i[0],i[1],[],i[2]):(e=i[0],t=i[1],n=i[2],s=i[3],null==(a=this._callbacksByAction)[t]&&(a[t]={}),r=l.next(),this._callbacksByAction[t][r]={callback:s,prerequisites:u.map(n,function(i){return i._storeImpl.dispatcherIdsByAction[t]})},r)},s.prototype.unregister=function(t,i){return o(this._callbacksByAction[t][i],"Dispatcher.unregister(%s, %s) does not map to a registered callback.",t.displayName,i),this._callbacksByAction[t][i]=null},s.prototype.waitFor=function(t,i){return o(this._isDispatching,"Dispatcher.waitFor must be invoked while dispatching."),u.forEach(i,function(i){return function(s){return i._isStarted[s]?void o(i._isFinished[s],"Dispatcher.waitFor encountered circular dependency while waiting for `%s` during %s.",s,t.displayName):(o(i._callbacksByAction[t][s],"Dispatcher.waitFor `%s` is not a registered callback for %s.",s,t.displayName),i.invokeCallback(t,s))}}(this))},s.prototype.dispatch=function(t){var i;o(!this._isDispatching,"Dispatch.dispatch cannot be called during dispatch."),this.startDispatching(t);try{return i=t.action,u.forEach(this._callbacksByAction[i],function(t){return function(s,r){return t._isStarted[r]?void 0:t.invokeCallback(i,r)}}(this))}finally{this.stopDispatching()}},s.prototype.invokeCallback=function(t,i){var s,r,n;return this._isStarted[i]=!0,n=this._callbacksByAction[t][i],s=n.callback,r=n.prerequisites,this.waitFor(t,r),s(this._payload),this._isFinished[i]=!0},s.prototype.startDispatching=function(t){return this._isStarted={},this._isFinished={},this._payload=t,this._isDispatching=!0},s.prototype.stopDispatching=function(){return this._payload=null,this._isDispatching=!1},r.Dispatcher=new s,i=function(t){var i,s,n;return o(t.action,"DeferredTask must register for exactly one action."),o(t.task,"DeferredTask must supply exactly one task to run"),i=t.action,n=t.task,"string"==typeof n&&(n=this[n]),n=u.defer.bind(this,n),s=r.Dispatcher.register(this,i.id,[],n),this._dispatcherIdsByAction={},this._dispatcherIdsByAction[i.id]=s,this},r.DeferredTask=i,c=function(t){return function(i,s){return s instanceof Function?s.bind(t):s}},e=function(t){return this._storeImpl={trigger:function(){return u.each(this.callbacks,function(t){return t()})}},this._storeImpl.dispatcherIdsByAction={},this._storeImpl.callbacks=[],u.assign(this._storeImpl,u.omit(t,"initialize","dispatches","public"),c(this._storeImpl)),t["public"]&&(u.assign(this,t["public"],c(this._storeImpl)),u.assign(this._storeImpl,t["public"],c(this._storeImpl))),this.displayName=t.displayName,t.initialize&&t.initialize.call(this._storeImpl),t.dispatches&&u.forEach(t.dispatches,function(t){return function(i){var s,n,e,a;return s=i.action,n=i.after,e=i.callback,o(!t._storeImpl.dispatcherIdsByAction[s.id],"Store "+t.displayName+" registered two callbacks for action "+s.displayName),"string"==typeof e&&(e=t._storeImpl[e]),e=e.bind(t._storeImpl),a=r.Dispatcher.register(t,s.id,n,e),t._storeImpl.dispatcherIdsByAction[s.id]=a}}(this)),this},e.prototype.register=function(t){return this._storeImpl.callbacks.push(t)},e.prototype.unregister=function(t){return this._storeImpl.callbacks=u.reject(this._storeImpl.callbacks,function(i){return i===t})},e.prototype.listen=function(t){var i;return i=this,{componentDidMount:function(){return i.register(this[t])},componentWillUnmount:function(){return i.unregister(this[t])}}},e.prototype.trigger=function(){return this._storeImpl.trigger()},r.Store=e,p?module.exports=r:this.Hippodrome=r}).call(this);
+(function(){var t,i,s,e,r,n,a,c,o,l,p,h,u,d=[].slice;p="undefined"==typeof window,u=p?require("lodash"):this._,e={},c=function(){var t,i,s,e,r;if(s=arguments[0],r=arguments[1],i=3<=arguments.length?d.call(arguments,2):[],!s)throw t=0,e=new Error("Assertion Failed: "+r.replace(/%s/g,function(){return i[t++]})),e.framesToPop=1,e;return s},r=function(t){return this._lastId=1,this._prefix=t},r.prototype.next=function(){return""+this._prefix+"_"+this._lastId++},a=new r("Action_ID"),t=function(t,i){var s,r,n,c;return n=""+a.next()+"_"+t,r=function(){var t;return t=i.apply(null,arguments),t.action=n,t},c=function(t){return e.Dispatcher.dispatch(t)},s=function(){var t;return t=r.apply(null,arguments),c(t)},s.buildPayload=r,s.send=c,s.displayName=t,s.id=n,s.toString=function(){return n},s},e.Action=t,s=function(){return this._callbacksByAction={},this._isStarted={},this._isFinished={},this._isDispatching=!1,this._payload=null},l=new r("Dispatcher_ID"),s.prototype.register=function(){var t,i,s,e,r,n,a;return i=u.compact(arguments),3===i.length?this.register(i[0],i[1],[],i[2]):(n=i[0],t=i[1],r=i[2],s=i[3],null==(a=this._callbacksByAction)[t]&&(a[t]={}),e=l.next(),this._callbacksByAction[t][e]={callback:s,prerequisites:u.map(r,function(i){return i._storeImpl.dispatcherIdsByAction[t]})},e)},s.prototype.unregister=function(t,i){return c(this._callbacksByAction[t][i],"Dispatcher.unregister(%s, %s) does not map to a registered callback.",t.displayName,i),this._callbacksByAction[t][i]=null},s.prototype.waitFor=function(t,i){return c(this._isDispatching,"Dispatcher.waitFor must be invoked while dispatching."),u.forEach(i,function(i){return function(s){return i._isStarted[s]?void c(i._isFinished[s],"Dispatcher.waitFor encountered circular dependency while waiting for `%s` during %s.",s,t.displayName):(c(i._callbacksByAction[t][s],"Dispatcher.waitFor `%s` is not a registered callback for %s.",s,t.displayName),i.invokeCallback(t,s))}}(this))},s.prototype.dispatch=function(t){var i;c(!this._isDispatching,"Dispatch.dispatch cannot be called during dispatch."),this.startDispatching(t);try{return i=t.action,u.forEach(this._callbacksByAction[i],function(t){return function(s,e){return t._isStarted[e]?void 0:t.invokeCallback(i,e)}}(this))}finally{this.stopDispatching()}},s.prototype.invokeCallback=function(t,i){var s,e,r;return this._isStarted[i]=!0,r=this._callbacksByAction[t][i],s=r.callback,e=r.prerequisites,this.waitFor(t,e),s(this._payload),this._isFinished[i]=!0},s.prototype.startDispatching=function(t){return this._isStarted={},this._isFinished={},this._payload=t,this._isDispatching=!0},s.prototype.stopDispatching=function(){return this._payload=null,this._isDispatching=!1},e.Dispatcher=new s,h=function(t,i){return"string"==typeof i&&(i=t[i]),i=u.defer.bind(t,i)},i=function(t){var i,s,r;return this.displayName=t.displayName,c(t.action||t.dispatches,"Deferred Task "+this.displayName+" must include either an action key or dispatches list."),c(!t.action||t.task,"Deferred Task "+this.displayName+" declared an action, it must declare a task."),u.assign(this,u.omit(t,"dispatches","action","task"),o(this)),this._dispatcherIdsByAction={},t.action&&t.task&&(i=t.action,r=t.task,r=h(this,r),s=e.Dispatcher.register(this,i.id,[],r),this._dispatcherIdsByAction[i.id]=s),t.dispatches&&u.forEach(t.dispatches,function(t){return function(r){var n;return i=r.action,n=r.callback,c(!t._dispatcherIdsByAction[i.id],"Deferred Task "+t.displayName+" registered two callbacks for the action "+i.displayName+"."),n=h(t,n),s=e.Dispatcher.register(t,i.id,[],n),t._dispatcherIdsByAction[i.id]=s}}(this)),this},e.DeferredTask=i,o=function(t){return function(i,s){return s instanceof Function?s.bind(t):s}},n=function(t){return this._storeImpl={trigger:function(){return u.each(this.callbacks,function(t){return t()})}},this._storeImpl.dispatcherIdsByAction={},this._storeImpl.callbacks=[],u.assign(this._storeImpl,u.omit(t,"initialize","dispatches","public"),o(this._storeImpl)),t["public"]&&(u.assign(this,t["public"],o(this._storeImpl)),u.assign(this._storeImpl,t["public"],o(this._storeImpl))),this.displayName=t.displayName,t.initialize&&t.initialize.call(this._storeImpl),t.dispatches&&u.forEach(t.dispatches,function(t){return function(i){var s,r,n,a;return s=i.action,r=i.after,n=i.callback,c(!t._storeImpl.dispatcherIdsByAction[s.id],"Store "+t.displayName+" registered two callbacks for action "+s.displayName),"string"==typeof n&&(n=t._storeImpl[n]),n=n.bind(t._storeImpl),a=e.Dispatcher.register(t,s.id,r,n),t._storeImpl.dispatcherIdsByAction[s.id]=a}}(this)),this},n.prototype.register=function(t){return this._storeImpl.callbacks.push(t)},n.prototype.unregister=function(t){return this._storeImpl.callbacks=u.reject(this._storeImpl.callbacks,function(i){return i===t})},n.prototype.listen=function(t){var i;return i=this,{componentDidMount:function(){return i.register(this[t])},componentWillUnmount:function(){return i.unregister(this[t])}}},n.prototype.trigger=function(){return this._storeImpl.trigger()},e.Store=n,p?module.exports=e:this.Hippodrome=e}).call(this);

data/lib/hippodrome/version.rb

@@ -1,3 +1,3 @@
 module Hippodrome
-  VERSION = '0.0.24'
+  VERSION = '0.0.25'
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hippodrome",
-  "version": "0.0.24",
+  "version": "0.0.25",
   "description": "Your data, like your chariots, go around and around in one direction in this, a Flux implementation that only Ben Hur could love.",
   "main": "js/hippodrome.js",
   "scripts": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hippodrome
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.25
 platform: ruby
 authors:
 - Sean Kermes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-26 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler