backbone_sync-rails 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Jason Morrison
+
+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,124 @@
+# BackboneSyncRails
+
+Use this in a Rails 3.1 app.  Right now the only supported pubsub messaging
+system is Faye http://faye.jcoglan.com/.
+
+## Installation
+
+This assumes you already have a Backbone.js + Rails app.
+
+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.
+    For now, let's say we add `config/initializers/backbone_sync_rails_faye.rb` with:
+
+    ```ruby
+    BackboneSync::Rails::Faye.root_address = 'http://localhost:9292'
+    ```
+
+3.  Pull in the javascripts:
+
+    ```javascript
+    //= require extensions/backbone.collection.idempotent
+    //= require backbone_sync-rails/rails_faye_subscriber
+    ```
+
+    (Until I rewrite it, one of 'em uses coffeescript, so you'll need that.)
+
+4.  Open a connection to Faye from your clients, somewhere on your page (in the layout?):
+
+    ```eruby
+    <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
+    an observer for you, so add a file like `app/models/user_observer.rb`:
+
+    ```ruby
+    class UserObserver < ActiveRecord::Observer
+      include BackboneSync::Rails::Faye::Observer
+    end
+    ```
+
+    and enable it in `config/application.rb` like any good observer:
+
+    ```ruby
+    module MyApp
+      class Application < Rails::Application
+        # snip...
+
+        # Activate observers that should always be running.
+        config.active_record.observers = :user_observer
+
+        # snip...
+      end
+    end
+    ```
+
+6.  Instantiate a new `BackboneSync.RailsFayeSynchronizer` for *each instance*
+    of a Backbone collection you instantiate.  You could do this in the
+    collection's constructor, or do it by hand:
+
+    ```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
+    ```
+
+7.  Check it out!  Open two browsers, do some stuff in one, and see your changes
+    cascade to the other.  Your Backbone views will need to observe events on
+    the collection like `change`, `add`, and `remove`.
+
+### Installing on Rails < 3.1
+
+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.
+
+## Caveats
+
+In short, I augment the `Backbone.Collection.prototype._add` function so
+that adding multiple models to the same collection with the same `id` attribute
+(or your `idAttribute`-specified attribute of choice) will pass silently.
+
+In long:
+
+In a distributed messaging system, messages should be idempotent: this means
+that, for any message, an actor should be able to execute that message several
+times with no ill effect.
+
+Why?  Consider the following situation.
+
+1. There are two clients, Alice and Bob.
+2. Alice creates a new model in Backbone.
+3. The server receives her request and persists it.  It also distributes a
+"create" message to all subscribed clients.  4. Alice's new model is added to
+her local collection in the normal due course of
+`Backbone.Model.prototype.save`.
+5. Bob receives the create message and creates a model in his local collection.
+6. All is well until this point.  Now, Alice receives the create message (she
+is subscribed just as Bob is) and creates a duplicate model into her
+collection.
+
+There is actually a race condition in that Alice's HTTP request to create (and
+therefore her normal `save()`-based addition to the collection)_ may complete
+before or after the pubsub notification informs her collection to add a new
+member.
+
+One approach to solving this would be for each update message to be tagged with
+its originating client, and for each client to filter out those messages.  This
+would prove difficult, particularly since, in this implementation, the
+`ActiveModel::Observer` subclass is decoupled from the originating client.
+
+The change made in
+`vendor/assets/javascripts/extensions/backbone.collection.idempotent.js` is to
+make `Backbone.Collection.prototype.add` idempotent with respect to the
+server-side `id` attribute, and neatly addresses the issue.
+
+I'm more than happy to hear about better approaches from people with more
+experience in distributed messaging systems.
+
+## Copyright
+
+Copyright (c) 2011 Jason Morrison. See MIT-LICENSE for details.

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BackboneSyncRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/backbone_sync-rails/faye/event.rb

@@ -0,0 +1,28 @@
+require 'backbone_sync-rails/faye/message'
+
+module BackboneSync
+  module Rails
+    module Faye
+      class Event
+        def initialize(model, event)
+          @model = model
+          @event = event
+        end
+
+        def broadcast
+          Message.new(channel, data).send
+        end
+
+        private
+
+        def channel
+          "/sync/#{@model.class.table_name}"
+        end
+
+        def data
+          { @event => { @model.id => @model.as_json } }
+        end
+      end
+    end
+  end
+end

data/lib/backbone_sync-rails/faye/message.rb

@@ -0,0 +1,31 @@
+require 'net/http'
+require 'json'
+
+module BackboneSync
+  module Rails
+    module Faye
+      # To publish from outside of an `EM.run {}` loop:
+      # http://groups.google.com/group/faye-users/browse_thread/thread/ae6e2a1cc37b3b07
+      class Message
+        def initialize(channel, data)
+          @channel = channel
+          @data = data
+        end
+
+        def send
+          Net::HTTP.post_form(uri, :message => payload) 
+        end
+
+        private
+
+        def uri
+          URI.parse("#{BackboneSync::Rails::Faye.root_address}/faye")
+        end
+
+        def payload
+          {:channel => @channel, :data => @data}.to_json
+        end
+      end
+    end
+  end
+end

data/lib/backbone_sync-rails/faye/observer.rb

@@ -0,0 +1,21 @@
+require 'backbone_sync-rails/faye/event'
+
+module BackboneSync
+  module Rails
+    module Faye
+      module Observer
+        def after_update(model)
+          Event.new(model, :update).broadcast
+        end
+
+        def after_create(model)
+          Event.new(model, :create).broadcast
+        end
+
+        def after_destroy(model)
+          Event.new(model, :destroy).broadcast
+        end
+      end
+    end
+  end
+end

data/lib/backbone_sync-rails/faye.rb

@@ -0,0 +1,9 @@
+require 'backbone_sync-rails/faye/observer'
+
+module BackboneSync
+  module Rails
+    module Faye
+      mattr_accessor :root_address
+    end
+  end
+end

data/lib/backbone_sync-rails/version.rb

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

data/lib/backbone_sync-rails.rb

@@ -0,0 +1,6 @@
+require 'backbone_sync-rails/faye'
+
+module BackboneSyncRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/tasks/backbone_sync-rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :backbone_sync-rails do
+#   # Task goes here
+# end

data/test/backbone_sync-rails_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class BackboneSyncRailsTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, BackboneSyncRails
+  end
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config/application.rb

@@ -0,0 +1,42 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require
+require "backbone_sync-rails"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,27 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Do not compress assets
+  config.assets.compress = false
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,51 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this)
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS
+  config.assets.compress = true
+
+  # Specifies the header that your server uses for sending files
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # config.assets.precompile += %w( search.js )
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,39 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Configure static asset server for tests with Cache-Control for performance
+  config.serve_static_assets = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Log error messages when you accidentally call methods on nil
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/dummy/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '4d99852faa59dcaf16388b6fc77bf59f970d460661fa25ac9baab9988bfea8555f108f8c575271be62d110eb578f6752b04d961f60abbedd9d8e8ea92706042c'

data/test/dummy/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rails generate session_migration")
+# Dummy::Application.config.session_store :active_record_store

data/test/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+#
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/test/dummy/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/test/dummy/config/routes.rb

@@ -0,0 +1,58 @@
+Dummy::Application.routes.draw do
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => 'welcome#index'
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id(.:format)))'
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/test/dummy/public/500.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+    <p>We've been notified about this issue and we'll take a look at it shortly.</p>
+  </div>
+</body>
+</html>

data/test/dummy/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"
+
+Rails.backtrace_cleaner.remove_silencers!
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

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

@@ -0,0 +1,31 @@
+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)

data/vendor/assets/javascripts/extensions/backbone.collection.idempotent.js

@@ -0,0 +1,11 @@
+Backbone.Collection.prototype._addWithIdCheck = function(model, options) {
+  var idAttribute = model.idAttribute || this.model.prototype.idAttribute;
+  var modelId = model[idAttribute];
+
+  if (this.get(modelId) === undefined) {
+    this._addWithoutIdCheck(model, options);
+  }
+};
+
+Backbone.Collection.prototype._addWithoutIdCheck = Backbone.Collection.prototype._add;
+Backbone.Collection.prototype._add = Backbone.Collection.prototype._addWithIdCheck;

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification 
+name: backbone_sync-rails
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jason Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 3.1.0.rc6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Broadcast changes from Rails models to client-side Backbone.js collections with WebSockets.
+email: 
+- jason.p.morrison@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/backbone_sync-rails/faye/event.rb
+- lib/backbone_sync-rails/faye/message.rb
+- lib/backbone_sync-rails/faye/observer.rb
+- lib/backbone_sync-rails/faye.rb
+- 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/extensions/backbone.collection.idempotent.js
+- MIT-LICENSE
+- Rakefile
+- README.md
+- test/backbone_sync-rails_test.rb
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/config.ru
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/dummy/Rakefile
+- test/dummy/script/rails
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/jasonm/backbone_sync-rails
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Effortlessly keep Backbone.js clients in sync.
+test_files: 
+- test/backbone_sync-rails_test.rb
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
+- test/dummy/app/controllers/application_controller.rb
+- test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/views/layouts/application.html.erb
+- test/dummy/config/application.rb
+- test/dummy/config/boot.rb
+- test/dummy/config/database.yml
+- test/dummy/config/environment.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/inflections.rb
+- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/initializers/secret_token.rb
+- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/wrap_parameters.rb
+- test/dummy/config/locales/en.yml
+- test/dummy/config/routes.rb
+- test/dummy/config.ru
+- test/dummy/public/404.html
+- test/dummy/public/422.html
+- test/dummy/public/500.html
+- test/dummy/public/favicon.ico
+- test/dummy/Rakefile
+- test/dummy/script/rails
+- test/test_helper.rb