robin-rails 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e13a9eacc13a76cc09d33d925daabaa111012ac5
-  data.tar.gz: b95f6b46420a8842fab70c0246e2c8076d04976e
+  metadata.gz: 7a53b2130e296798e0f9904424d22a7455c4718b
+  data.tar.gz: fbe629e0b2d28a38161ad5c789deef54724dbeac
 SHA512:
-  metadata.gz: f4e3cc7401e5fe5797a13ef78d1517193cf3f7e976369e5bf1bad2fbf4e07b91d0d7e022262a3e561590e7befd2c08744a1e84345b971a2a58c61260bda40cbf
-  data.tar.gz: 999148332f40ddf9a74ddb43cf8793b66ac484ae272fefe98d9238eff3c6225f4a85fb465c5093c1b131d05028b1d86d93f2dd0984aa32776c31de1c41ec782c
+  metadata.gz: 9dc6fced33d2e1560d57c824d19a4fd971457c7cfb2a609118fa1cdc9f78a8cc8a0560c759f620c099bc65297f520966fe29d24f38aa058a3734cd501481b2d1
+  data.tar.gz: c528834bc565005a810f823ceb8e902e4aa89e1d2da7cbb59933608cd1407ea9078adfa7742f4c3010a6d4bdbd7392347cf877d7393687fdcd737d6589716e18

data/README.md

@@ -8,3 +8,61 @@ Robin.js on Rails
 =================
 
 Every Batman.js app on Rails needs a sidekick. Bring realtime to the fight with Robin.js.
+
+Usage
+=====
+
+For client-side info on Robin.js, [checkout the CoffeeScript source.](https://github.com/nybblr/robin)
+
+Vendoring
+---------
+
+The latest version of the client-side Robin.js source is available through the asset pipeline under the `robin` namespace.
+
+~~~coffeescript
+# app/assets/javascripts/application.js.coffee
+#
+#= require batman/es5-shim
+#= require batman/batman
+#= require batman/batman.rails
+#= require batman/batman.jquery
+#
+#= require robin/robin
+~~~
+
+Make sure you load Robin after the Batman source files. To get things working on the frontend, [checkout the setup details for Robin.js.](https://github.com/nybblr/robin)
+
+Realtime
+--------
+
+The easiest way to get started is to add Robin to your Gemfile:
+
+~~~ruby
+gem 'robin-rails' # Robin.js vendor and Rails events
+gem 'faye' # websocket backend
+~~~
+
+For every model you want to update in realtime, include the `Robin::Rails` module.
+
+~~~ruby
+class Post < ActiveRecord::Base
+  include Robin::Rails
+end
+~~~
+
+You can configure the Faye endpoint in an initializer.
+
+~~~ruby
+# config/initializers/robin.rb
+Robin.configure do |config|
+  config.faye_url = 'http://localhost:9292/faye' # the default
+end
+~~~
+
+That's it! Anytime a record is created, updated, or destroyed, the event will immediately be pushed to Robin.js subscribers via Faye. If you've got Faye running correctly (e.g. make sure you use Thin or another EventMachine friendly server), you should now be able to open several browser clients, edit models in the JS console, then watch the events propagate to other subscribed clients!
+
+Contributing
+============
+This project is (obviously) in its infancy with just the basics. TODO lists a bunch of features I hope to get implemented, but this is GitHub: if you add a feature on your own, give me a hand and contribute!
+
+No guidelines yet other than your basics: fork it, submit a pull request with relevant tests, and try to follow the conventions already in the code. Any and all quality contributions welcome!

data/lib/robin/rails/version.rb

@@ -1,5 +1,5 @@
 module Robin
   module Rails
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/vendor/assets/javascripts/robin/lib/queue.js

@@ -0,0 +1 @@
+(function(){function n(n){function t(){for(;f=a<c.length&&n>p;){var u=a++,t=c[u],r=l.call(t,1);r.push(e(u)),++p,t[0].apply(null,r)}}function e(n){return function(u,l){--p,null==d&&(null!=u?(d=u,a=s=0/0,r()):(c[n]=l,--s?f||t():r()))}}function r(){null!=d?v(d):i?v(d,c):v.apply(null,[d].concat(c))}var o,f,i,c=[],a=0,p=0,s=0,d=null,v=u;return n||(n=1/0),o={defer:function(){return d||(c.push(arguments),++s,t()),o},await:function(n){return v=n,i=!1,s||r(),o},awaitAll:function(n){return v=n,i=!0,s||r(),o}}}function u(){}"undefined"==typeof module?self.queue=n:module.exports=n,n.version="1.0.4";var l=[].slice})();

data/vendor/assets/javascripts/robin/robin.js.coffee

@@ -1,44 +1,11 @@
-# Push-persistence backed by Faye.
-class Batman.Robin extends Batman.Object
-  @_nest: []
-  @_verbs: ["updated", "created", "destroyed", "flushed", "batched"]
-
-  @on 'socket:ready', ->
-    @socket = Batman.currentApp.socket
-    bird() for bird in @_nest
-
-  constructor: (@model) ->
-    if @socket
-      # Go ahead and subscribe.
-      @subscribe()
-    else
-      # Add it to the nest.
-      Batman.Robin._nest.push =>
-        @socket = Batman.Robin.socket
-        @subscribe()
+#= require_self
+#= require ./robin/reactor
+#= require ./robin/adapter
 
-  subscribe: ->
-    channel = @model.storageKey
-    Batman.developer.log "Subscribing to /#{channel}..."
-    for verb in @constructor._verbs
-      do (verb) =>
-        @socket.subscribe "/#{channel}/#{verb}", (data) => @delayIfXhrRequests(verb, data)
-
-  delayIfXhrRequestsWithoutDecompress: (method, data) ->
-    if Batman.Robin.activeXhrCount == 0
-      setTimeout =>
-        Batman.developer.log("Processing #{method} with data #{JSON.stringify(data)}")
-        Batman.Reactor.process(method, @model, data)
-      , 0
-    else
-      Batman.developer.log("Delaying #{method}")
-      setTimeout =>
-        @delayIfXhrRequestsWithoutDecompress(method, data)
-      , 500
-
-  delayIfXhrRequests: (method, data) ->
-    @delayIfXhrRequestsWithoutDecompress(method, data)
+# Push-persistence backed by Faye.
+class @Robin extends Batman.Object
+  @connect: (socket) ->
+    @set 'socket', socket
+    @fire('socket:ready')
 
-@Robin = Batman.Robin
-@Robin.activeXhrCount = 0
-$(document).ajaxSend(=> @Robin.activeXhrCount++).ajaxComplete(=> @Robin.activeXhrCount--)
+window.Robin = Robin

data/vendor/assets/javascripts/robin/robin/adapter.js.coffee

@@ -0,0 +1,23 @@
+Robin.AdapterMethods =
+  subscribe: ->
+    Robin.observeAndFire 'socket', (newVal, oldVal) =>
+      if newVal?
+        @socket = newVal
+        @_subscribeNow()
+
+  _subscribeNow: ->
+    channel = @model.storageKey
+    Batman.developer.log "Subscribing to /#{channel}..."
+    for verb in Robin.Reactor._verbs
+      do (verb) =>
+        @socket.subscribe "/#{channel}/#{verb}", (data) => @_react(verb, data)
+
+  _react: (verb, data) ->
+    Robin.Reactor.process(verb, @model, data)
+
+class Robin.Adapter extends Batman.RailsStorage
+  Batman.mixin @::, Robin.AdapterMethods
+
+  constructor: (model) ->
+    super(model)
+    @subscribe()

data/vendor/assets/javascripts/robin/robin/reactor.js.coffee

@@ -0,0 +1,74 @@
+#= require ../lib/queue
+#= require_self
+
+# Utility class for updating models in memory.
+Robin.Reactor =
+  # Private queue for batching
+  _q: queue(1)
+
+  # Valid batch operations
+  _verbs: ["updated", "created", "destroyed", "flushed", "batched"]
+
+  # Public interface for updating objects in Batman in a bulk/one off fashion
+  process: (verb, model, data) ->
+    if @_verbs.indexOf(verb) > -1
+      if verb is 'batched'
+        @_batched(model, data)
+      else
+        @_enqueue(verb, model, data)
+    else
+      Batman.developer.warn("unrecognized verb: " + verb)
+
+  _execute: (verb, model, data) ->
+    Batman.developer.log("#{verb} #{model.name} => #{JSON.stringify(data)}")
+    @['_'+verb](model, data)
+
+  _enqueue: (verb, model, data) ->
+    @_q.defer (next) =>
+      @_execute(verb, model, data)
+      next()
+
+  _removeRecord: (model, record) ->
+    model.get('loaded').remove(record)
+    record.get('lifecycle').destroyed()
+
+  _initOrUpdateRecord: (model, data) ->
+    model._makeOrFindRecordFromData(data)
+
+  _findRecord: (model, data) ->
+    model._loadIdentity(data['id'])
+
+  # Flush every record of a model matching the criterion.
+  # Makes Batman request updates.
+  _flushed: (model, data) ->
+    key   = data.key
+    value = data.value
+
+    recordsToRemove = model.get('loaded').indexedBy(key).get(value).toArray()
+    for record in recordsToRemove
+      @_removeRecord(model, record)
+    if key is model.get('primaryKey')
+      model.find value, ->
+    else
+      options = {}
+      options["#{key}"] = value
+      model.load options
+
+  _batched: (model, batch) ->
+    return unless batch?
+    Batman.developer.log("batched (#{batch.length})")
+
+    for item in batch
+      @_enqueue(item[0], model, item[1])
+
+  _created: (model, data) ->
+    @_initOrUpdateRecord(model, data)
+
+  _updated: (model, data) ->
+    record = @_findRecord(model, data)
+    @_initOrUpdateRecord(model, data) if record?
+
+  _destroyed: (model, data) ->
+    record = @_findRecord(model, data)
+    @_removeRecord(model, record) if record?
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: robin-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jonathan Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-16 00:00:00.000000000 Z
+date: 2013-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -132,8 +132,10 @@ files:
 - spec/robin/rails_spec.rb
 - spec/robin_spec.rb
 - spec/spec_helper.rb
-- vendor/assets/javascripts/robin/reactor.js.coffee
+- vendor/assets/javascripts/robin/lib/queue.js
 - vendor/assets/javascripts/robin/robin.js.coffee
+- vendor/assets/javascripts/robin/robin/adapter.js.coffee
+- vendor/assets/javascripts/robin/robin/reactor.js.coffee
 homepage: https://github.com/nybblr/robin-rails
 licenses:
 - MIT

data/vendor/assets/javascripts/robin/reactor.js.coffee

@@ -1,70 +0,0 @@
-# Utility class for updating models in memory.
-Batman.Reactor =
-  # Private queue for jQuery
-  _q: $({})
-
-  # Valid batch operations
-  _verbs: ["updated", "created", "destroyed", "flushed", "batched"]
-
-  # Public interface for updating objects in Batman in a bulk/one off fashion
-  process: (verb, model, data) ->
-    if _.contains @_verbs, verb
-      @['_'+verb](model, data)
-    else
-      Batman.developer.warn("unrecognized batch operation: " + verb)
-
-  _enqueue: (model, batch_item) ->
-    @_q.queue (next) =>
-      @process(batch_item[0], model, batch_item[1])
-      next()
-
-  _getObject: (model, data) ->
-    # model = Batman.currentApp[pushed_data.model_name]
-    # data = pushed_data.model_data
-    obj = new model()
-    obj._withoutDirtyTracking -> obj.fromJSON(data)
-    return obj
-
-  # Flush every object of a certain model that matches the criterion (all comments for a post)
-  # used when you have too much data to pass through Pusher but want Batman to request updates
-  _flushed: (model, data) ->
-    # model = Batman.currentApp[reload_data.model_name]
-    match_key = data.match_key
-    match_value = data.match_value
-    Batman.developer.log("FLUSH #{model.name} - #{match_key} => #{match_value}")
-    recordsToRemove = model.get('loaded').indexedBy(match_key).get(match_value).toArray()
-    recordsToRemove.forEach (existing) =>
-      model.get('loaded').remove(existing)
-    if match_key == 'id'
-      model.find match_value, ->
-    else
-      options = {}
-      options["#{match_key}"] = match_value
-      model.load options
-
-  _batched: (model, batch) ->
-    return if batch == undefined
-    Batman.developer.log("BATCH: " + batch.length)
-    for batched_item in batch
-      @_enqueue(model, batched_item)
-
-  _created: (model, data) ->
-    Batman.developer.log("created: #{JSON.stringify(data)}")
-    obj = model.get('loaded.indexedByUnique.id').get(data["id"])
-    if obj # If object already in memory, update it
-      obj._withoutDirtyTracking -> obj.fromJSON(data)
-    else # create object in memory
-      obj = @_getObject(model, data)
-      model._mapIdentity(obj)
-
-  _updated: (model, data) ->
-    Batman.developer.log("updated #{JSON.stringify(data)}")
-    obj = model.get('loaded.indexedByUnique.id').get(data["id"])
-    if obj
-      obj._withoutDirtyTracking -> obj.fromJSON(data)
-
-  _destroyed: (model, data) ->
-    Batman.developer.log("destroyed #{JSON.stringify(data)}")
-    existing = model.get('loaded.indexedByUnique.id').get(data["id"])
-    if existing
-      model.get('loaded').remove(existing)