backbone_sync-rails 0.0.1 → 0.0.2

data/README.md

@@ -7,6 +7,12 @@ system is Faye http://faye.jcoglan.com/.
 
 This assumes you already have a Backbone.js + Rails app.
 
+0.  Install the gem, say in your `Gemfile`:
+
+    ```ruby
+    gem 'backbone_sync-rails', '~> 0.0.1'
+    ```
+
 1.  Run a Faye server.  It's pretty straightforward, check out `example_faye/run.sh` in this repo.
 
 2.  Tell your app where the faye server is.  This may differ per Rails.env.
@@ -31,7 +37,7 @@ This assumes you already have a Backbone.js + Rails app.
     <script type="text/javascript" src="<%= BackboneSync::Rails::Faye.root_address %>/faye.js"></script>
     ```
 
-5.  Observe model changes in Rails, and broadcast them.  We provide the guts of
+5.  Observe model changes in Rails, and broadcast them.  The gem provides the guts of
     an observer for you, so add a file like `app/models/user_observer.rb`:
 
     ```ruby
@@ -61,9 +67,9 @@ This assumes you already have a Backbone.js + Rails app.
 
     ```javascript
     // For simplicitly, here it is in a router, or app bootstrap
-    this.users = new MyApp.Collections.UsersCollection()
-    new BackboneSync.RailsFayeSubscriber(this.users, channel: 'users')
-    this.wizards.reset options.users
+    this.users = new MyApp.Collections.UsersCollection();
+    new BackboneSync.RailsFayeSubscriber(this.users, channel: 'users');
+    this.wizards.reset(options.users);
     ```
 
 7.  Check it out!  Open two browsers, do some stuff in one, and see your changes
@@ -76,6 +82,13 @@ If you're on a version of Rails < 3.1, you'll probably have to copy some files
 into your app by hand, like the `vendor/assets` files.  You'll probably have to
 require the `lib/backbone_sync-rails/faye.rb` file yourself, too.
 
+## Example app
+
+I wrote an untested example application that uses CoffeeScript and the
+backbone-rails generators:
+
+https://github.com/jasonm/wizards
+
 ## Caveats
 
 In short, I augment the `Backbone.Collection.prototype._add` function so

data/lib/backbone_sync-rails/version.rb

@@ -1,3 +1,3 @@
 module BackboneSyncRails
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/vendor/assets/javascripts/backbone_sync-rails/rails_faye_subscriber.js.erb

@@ -0,0 +1,80 @@
+// Original CoffeeScript:
+//
+// window.BackboneSync = {}
+// 
+// class BackboneSync.RailsFayeSubscriber
+//   constructor: (collection, options) ->
+//     @collection = collection
+//     @client  = new Faye.Client('<%= BackboneSync::Rails::Faye.root_address %>/faye')
+//     @channel = options.channel
+// 
+//     @subscribe()
+// 
+//   subscribe: =>
+//     @client.subscribe "/sync/#{@channel}", @receive
+// 
+//   receive: (message) =>
+//     $.each message, (event, eventArguments) =>
+//       @[event](eventArguments)
+// 
+//   update: (params) =>
+//     $.each params, (id, attributes) =>
+//       model = @collection.get(id)
+//       model.set(attributes)
+// 
+//   create: (params) =>
+//     $.each params, (id, attributes) =>
+//       model = new @collection.model(attributes)
+//       @collection.add(model)
+// 
+//   destroy: (params) =>
+//     $.each params, (id, attributes) =>
+//       model = @collection.get(id)
+//       @collection.remove(model)
+
+(function() {
+  var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
+  window.BackboneSync = {};
+  BackboneSync.RailsFayeSubscriber = (function() {
+    function RailsFayeSubscriber(collection, options) {
+      this.destroy = __bind(this.destroy, this);
+      this.create = __bind(this.create, this);
+      this.update = __bind(this.update, this);
+      this.receive = __bind(this.receive, this);
+      this.subscribe = __bind(this.subscribe, this);      this.collection = collection;
+      this.client = new Faye.Client('<%= BackboneSync::Rails::Faye.root_address %>/faye');
+      this.channel = options.channel;
+      this.subscribe();
+    }
+    RailsFayeSubscriber.prototype.subscribe = function() {
+      return this.client.subscribe("/sync/" + this.channel, this.receive);
+    };
+    RailsFayeSubscriber.prototype.receive = function(message) {
+      return $.each(message, __bind(function(event, eventArguments) {
+        return this[event](eventArguments);
+      }, this));
+    };
+    RailsFayeSubscriber.prototype.update = function(params) {
+      return $.each(params, __bind(function(id, attributes) {
+        var model;
+        model = this.collection.get(id);
+        return model.set(attributes);
+      }, this));
+    };
+    RailsFayeSubscriber.prototype.create = function(params) {
+      return $.each(params, __bind(function(id, attributes) {
+        var model;
+        model = new this.collection.model(attributes);
+        return this.collection.add(model);
+      }, this));
+    };
+    RailsFayeSubscriber.prototype.destroy = function(params) {
+      return $.each(params, __bind(function(id, attributes) {
+        var model;
+        model = this.collection.get(id);
+        return this.collection.remove(model);
+      }, this));
+    };
+    return RailsFayeSubscriber;
+  })();
+}).call(this);

metadata

@@ -2,7 +2,7 @@
 name: backbone_sync-rails
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jason Morrison
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-28 00:00:00 -04:00
+date: 2011-09-06 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,7 @@ files:
 - lib/backbone_sync-rails/version.rb
 - lib/backbone_sync-rails.rb
 - lib/tasks/backbone_sync-rails_tasks.rake
-- vendor/assets/javascripts/backbone_sync-rails/rails_faye_subscriber.js.coffee.erb
+- vendor/assets/javascripts/backbone_sync-rails/rails_faye_subscriber.js.erb
 - vendor/assets/javascripts/extensions/backbone.collection.idempotent.js
 - MIT-LICENSE
 - Rakefile

data/vendor/assets/javascripts/backbone_sync-rails/rails_faye_subscriber.js.coffee.erb

@@ -1,31 +0,0 @@
-window.BackboneSync = {}
-
-class BackboneSync.RailsFayeSubscriber
-  constructor: (collection, options) ->
-    @collection = collection
-    @client  = new Faye.Client('<%= BackboneSync::Rails::Faye.root_address %>/faye')
-    @channel = options.channel
-
-    @subscribe()
-
-  subscribe: =>
-    @client.subscribe "/sync/#{@channel}", @receive
-
-  receive: (message) =>
-    $.each message, (event, eventArguments) =>
-      @[event](eventArguments)
-
-  update: (params) =>
-    $.each params, (id, attributes) =>
-      model = @collection.get(id)
-      model.set(attributes)
-
-  create: (params) =>
-    $.each params, (id, attributes) =>
-      model = new @collection.model(attributes)
-      @collection.add(model)
-
-  destroy: (params) =>
-    $.each params, (id, attributes) =>
-      model = @collection.get(id)
-      @collection.remove(model)