hippodrome 0.0.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc3cea9a26a649e2e04b3c21554ba063aca8bdd3
+  data.tar.gz: 7767ff96fcc07330ba8da26c4c5b4c347248e1f7
+SHA512:
+  metadata.gz: be5730f42f7060510ed95b7db3065776fc2407fabf8df85801ff602ad677d755aa17b8004f8a94260139fe7015115351e3c4202eb5e9297a36672168bedd2e73
+  data.tar.gz: 4e76f557732c663a619ad9b51404d9cfc46fbf604cf145b94343e4690cfe891def01be959d3efada45eb894621c3d838f2782048b1b86596162c9a46f2e9608c

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sean Kermes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,49 @@
+# Hippodrome
+
+> At last the herald with loud blare of trumpet calls forth the impatient teams
+> and launches the fleet chariots into the field. The swoop of forked lightning,
+> the arrow sped by Scythian string, the trail of the swiftly-falling star, the
+> leaden hurricane of bullets whirled from Balearic slings has never so rapidly
+> split the airy paths of the sky.… Thus they go once round, then a
+> second time; thus goes the third lap, thus the fourth…
+>
+> — [Sidonius](http://skookumpete.com/chariots.htm)
+
+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
+instead of exposing data to views, do additional asynchronous work like
+making a network request and possibly dispatching more actions based on the
+response.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hippodrome'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hippodrome
+
+## Usage
+
+In your javascript manifest file:
+
+    //= require hippodrome
+
+TODO: Explain how all the bits work.
+
+## Contributing
+
+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

data/app/assets/javascripts/action.js.coffee

@@ -0,0 +1,22 @@
+Action = (name, ctor) ->
+  buildPayload = ->
+    payload = ctor.apply(null, arguments)
+    payload.action = name
+    payload
+
+  send = (payload) ->
+    Hippodrome.Dispatcher.dispatch(payload)
+
+  actionFn = ->
+    payload = buildPayload.apply(null, arguments)
+    send(payload)
+
+  actionFn.buildPayload = buildPayload
+  actionFn.send = send
+
+  actionFn.hippoName = name
+  actionFn.toString = -> name
+
+  actionFn
+
+Hippodrome.Action = Action

data/app/assets/javascripts/assert.js.coffee

@@ -0,0 +1,12 @@
+Hippodrome.assert = (condition, message, args...) ->
+  if not condition
+    # TODO: Don't report in non-dev mode
+    argIndex = 0;
+    error = new Error('Assertion Failed: ' +
+                      message.replace(/%s/g, -> args[argIndex++]))
+
+    # Ignore assert's frame
+    error.framesToPop = 1
+    throw error
+
+  condition

data/app/assets/javascripts/dispatcher.js.coffee

@@ -0,0 +1,83 @@
+Dispatcher = ->
+  @callbacksByAction = {}
+  @isStarted = {}
+  @isFinished = {}
+  @isDispatching = false
+  @payload = null
+
+prefix = 'Dispatcher_ID_'
+lastId = 1
+nextId = -> prefix + lastId++
+
+Dispatcher.prototype.register = ->
+  args = _.compact(arguments)
+
+  if args.length == 3
+    @register(args[0], args[1], [], args[2])
+  else
+    [store, action, prereqStores, callback] = args
+    @callbacksByAction[action] ?= {}
+
+    id = nextId()
+    @callbacksByAction[action][id] = {
+      callback: callback,
+      prerequisites: _.map(prereqStores,
+                           (ps) -> ps.dispatcherIdsByAction[action])
+    }
+    id
+
+Dispatcher.prototype.unregister = (action, id) ->
+  Hippodrome.assert(@callbacksByAction[action][id],
+         'Dispatcher.unregister(%s, %s) does not map to a registered callback.',
+         action, id)
+  @callbacks[action][id] = null
+
+Dispatcher.prototype.waitFor = (action, ids) ->
+  Hippodrome.assert(@isDispatching,
+         'Dispatcher.waitFor must be invoked while dispatching.')
+  _.forEach(ids, (id) =>
+    if @isStarted[id]
+      Hippodrome.assert(@isFinished[id],
+             'Dispatcher.waitFor encountered circular dependency while ' +
+             'waiting for `%s` during %s.', id, action)
+      return
+
+    Hippodrome.assert(@callbacksByAction[action][id],
+           'Dispatcher.waitFor `%s` is not a registered callback for %s.',
+           id, action)
+    @invokeCallback(action, id)
+  )
+
+Dispatcher.prototype.dispatch = (payload) ->
+  Hippodrome.assert(not @isDispatching,
+         'Dispatch.dispatch cannot be called during dispatch.')
+  @startDispatching(payload)
+  try
+    action = payload.action
+    _.forEach(@callbacksByAction[action], (callback, id) =>
+      if @isStarted[id]
+        return
+
+      @invokeCallback(action, id)
+    )
+  finally
+    @stopDispatching()
+
+Dispatcher.prototype.invokeCallback = (action, id) ->
+  @isStarted[id] = true
+  {callback, prerequisites} = @callbacksByAction[action][id]
+  @waitFor(action, prerequisites)
+  callback(@payload)
+  @isFinished[id] = true
+
+Dispatcher.prototype.startDispatching = (payload) ->
+  @isStarted = {}
+  @isFinished = {}
+  @payload = payload
+  @isDispatching = true
+
+Dispatcher.prototype.stopDispatching = ->
+  @payload = null
+  @isDispatching = false
+
+Hippodrome.Dispatcher = new Dispatcher()

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

@@ -0,0 +1,5 @@
+#= require lodash
+#= require_self
+#= require_tree .
+
+window.Hippodrome = {}

data/app/assets/javascripts/side_effect.js.coffee

@@ -0,0 +1,19 @@
+SideEffect = (options) ->
+  Hippodrome.assert(options.action,
+         'SideEffect must register for exactly one action.')
+  Hippodrome.assert(options.effect,
+         'SideEffect must supply exactly one effect to run')
+
+  {action, effect} = options
+
+  if typeof effect == 'string'
+    effect = this[effect]
+  effect = _.defer.bind(this, effect)
+
+  id = Hippodrome.Dispatcher.register(this, action.hippoName, [], effect)
+  @dispatcherIdsByAction = {}
+  @dispatcherIdsByAction[action.hippoName] = id
+
+  this
+
+Hippodrome.SideEffect = SideEffect

data/app/assets/javascripts/store.js.coffee

@@ -0,0 +1,52 @@
+bindToContextIfFunction = (context) ->
+  (objValue, srcValue) ->
+    if srcValue instanceof Function
+      srcValue.bind(context)
+    else
+      srcValue
+
+Store = (options) ->
+  @dispatcherIdsByAction = {}
+  @callbacks = []
+  _.assign(this, _.omit(options, 'initialize', 'dispatches'), bindToContextIfFunction(this))
+
+  if options.initialize
+    options.initialize.call(@)
+
+  if options.dispatches
+    _.forEach(options.dispatches, (callbackDescription) =>
+      {action, after, callback} = callbackDescription
+
+      Hippodrome.assert(not @dispatcherIdsByAction[action.hippoName]
+             'Each store can only register one callback for each action.')
+
+      if typeof callback == 'string'
+        callback = @[callback]
+      callback = callback.bind(@)
+
+      id = Hippodrome.Dispatcher.register(this, action.hippoName, after, callback)
+      @dispatcherIdsByAction[action.hippoName] = id
+    )
+
+  this
+
+Store.prototype.register = (callback) ->
+  @callbacks.push(callback)
+
+Store.prototype.unregister = (callback) ->
+  @callbacks = _.reject(@callbacks, (cb) -> cb == callback)
+
+# register/unregister are completely general, this is tailored for React mixins.
+Store.prototype.listen = (callbackName) ->
+  store = this
+  return {
+    componentDidMount: ->
+      store.register(this[callbackName])
+    componentWillUnmount: ->
+      store.unregister(this[callbackName])
+  }
+
+Store.prototype.trigger = ->
+  _.forEach(@callbacks, (callback) -> callback())
+
+Hippodrome.Store = Store

data/lib/hippodrome/version.rb

@@ -0,0 +1,3 @@
+module Hippodrome
+  VERSION = "0.0.8"
+end

data/lib/hippodrome.rb

@@ -0,0 +1,8 @@
+require 'lodash-rails'
+
+require "hippodrome/version"
+
+module Hippodrome
+  class Engine < ::Rails::Engine
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: hippodrome
+version: !ruby/object:Gem::Version
+  version: 0.0.8
+platform: ruby
+authors:
+- Sean Kermes
+- William Lubelksi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: coffee-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+- !ruby/object:Gem::Dependency
+  name: lodash-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.4.1
+description: Longer descripttion to make rake happy.
+email:
+- skermes@gmail.com
+- will.lubelski@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- app/assets/javascripts/action.js.coffee
+- app/assets/javascripts/assert.js.coffee
+- app/assets/javascripts/dispatcher.js.coffee
+- app/assets/javascripts/hippodrome.js.coffee
+- app/assets/javascripts/side_effect.js.coffee
+- app/assets/javascripts/store.js.coffee
+- lib/hippodrome.rb
+- lib/hippodrome/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Your data, like your chariots, go around and around in one direction in this,
+  a Flux implementation that only Ben Hur could love.
+test_files: []
+has_rdoc: