railsy_backbone 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a846e920a5dad426c7c7e892cf4af5c5e7a85e45
-  data.tar.gz: 37d9f658a1c1b61f45aa144a5393429134ac6474
+  metadata.gz: a60b10150fbc85539a6081d94fa22531453cecd1
+  data.tar.gz: 8c72b9aec92541d08d742e5c7ff5235d61c65d5a
 SHA512:
-  metadata.gz: 5fae32e260f47e893775010bbe983361126644085e70391d5013b533d6c586f53a883fc6eef3e6a349aad38339e76369b0308535a4d57b8be55e662a01bdd54d
-  data.tar.gz: fd9f382bbbe0a082ceafdc937ba33dd80d2f7de9f3a033d129c07a763ae176086d7fb93995296b66f237d0d9c727341c1f720dd853d4772faf7e286531e44dbb
+  metadata.gz: 8d5af02700098e358931772710eb49b6b07b211b1bb9ded35bd5ec43913fe2a2ea6746134ef9ea5b750f62f983b749cc8cdd8022d808e195f7ebcbed2a5b55a9
+  data.tar.gz: f563f3ac772cc65bb7105f71c6636fe415e39dd4b3504d3c7142f100c68e152d1b4b3b1cedb55afa4d88d897a906bc852aac6efa44dfb321ca50a2270e3f9f5f

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## next
+
+## 0.0.4
+
+- Remove Rails unofficially reserved `created_at` and `updated_at` so they're 
+  included in HTTP PUT/PATCH request.
+  (westonplatter)
+  
+- Finished docs for `railsy_backbone.sync`.
+  (westonplatter)
+
+- Account for application.js and application.js.coffee Javascript require differences.
+  (Nicholas Zaillian - https://github.com/nzaillian/backbone-rails/commit/24fb49d4c941821307ccdec7160ec218e7475706)
+  
+- Added install instructions to README.
+  (westonplatter)
+
+
 ## 0.0.3
 
 - copied Backbone model generator from backbone-rails

data/README.md

@@ -4,6 +4,85 @@ Underscore 1.5.1
 
 [![Build Status](https://travis-ci.org/westonplatter/railsy_backbone.png?branch=master)](https://travis-ci.org/westonplatter/railsy_backbone)
 
+Questions/Suggestions   =>   [open a GitHub issue - 24 hr response time](https://github.com/westonplatter/railsy_backbone/issues/new)
+
+## Rails Setup
+
+### Install
+
+Add this line to Gemfile,
+
+    gem 'railsy_backbone'
+
+And then,
+
+    $ bundle install
+    $ rails g backbone:install
+    
+This requires `underscore`, `backbone`, and JS customizations to make Backbone play nice with Rails (see Javscript files with `rails_backbone.` prefix regarding what changed).
+
+    //= require jquery
+    //= require jquery_ujs
+    //= require underscore
+    //= require backbone
+    //= require railsy_backbone.sync
+    //= require railsy_backbone.datalink
+    //= require backbone/<your_application_name_here>
+    //= require_tree .
+
+### Generators
+Rails Install  
+Backbone Model  
+Backbone Router  
+Backbone Scaffold  
+
+### Example Usage      
+
+Create new rails app, 
+
+    rails new library
+    cd library
+
+Install `railsy_backbone`,
+    
+    # add railsy_backbone to Gemfile
+    bundle install
+    rails g backbone:install
+
+Generate a standard Rails scaffold,
+    
+    rails g scaffold Book title:string author:string
+    rake db:migrate
+
+Generate a `Backbone` scaffold, 
+    
+    rails g backbone:scaffold Book title:string author:string
+    
+Edit `books/index.html` to execute actions through the Backbone scaffold UI rather than routing to different pages. 
+    
+    ### ERB
+    
+    <div id="books"></div>
+
+    <script type="text/javascript">
+      $(function() {
+        window.router = new Library.Routers.BooksRouter({books: <%= @books.to_json.html_safe -%>});
+        Backbone.history.start();
+      });
+    </script>
+    
+    
+    ### HAML
+    
+    #books
+    
+    :javascript
+      $(function() {
+        window.router = new Library.Routers.BooksRouter({books: #{@books.to_json.html_safe}});
+        Backbone.history.start();
+      });
+
+
 ## Features
 
 1. [Nested Model Attributes](#nested-model-attributes)
@@ -26,32 +105,29 @@ Allows you to specify a namespace for model attributes by defining a  ```paramRo
 
 This will cause the HTTP POST to look like this, 
 
-    Started POST "/books" for 127.0.0.1 at 2013-08-03 18:08:56 -0600
+    Started POST "/books" for 127.0.0.1
       Processing by BooksController#create as JSON
-      Parameters: { "book" => { "title" => "the illiad", "author" => "homer" }}
+      Parameters: { "book" => { 
+        "title" => "the illiad", 
+        "author" => "homer", 
+        "id" => 1}
+      }
 
 
 ### Automatic Rails CSRF Integration
 Automatically handles the Rails `authenticity_token`. Or, more technically, sets the  `xhr.setRequestHeader`  to the Rails CSRF token supplied in the HTML `header` meta tag.
 
-<br>
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'railsy_backbone', '~> 0.0.3'
-
-And then execute:
-
-    $ bundle
 
 ## Docs
 
 [Here's the link to our docs](http://westonplatter.github.io/railsy_backbone/).
 
-__We really value clear communication__ (we're serious!). If you think something is missing in the docs, __please__ let us know via a GitHub issue ([create issues here](https://github.com/westonplatter/railsy_backbone/issues)), and we'll look at adding it. 
+__I really value clear communication__ (I'm serious!). If you think something is missing in the docs, __please__ let me know via a GitHub issue ([create issues here](https://github.com/westonplatter/railsy_backbone/issues)), and I'll look at adding it. 
+
+
 
+## Contributions
+[Nicholas Zaillian](https://github.com/nzaillian)  
 
 ## Credits
 See LICENSE

data/lib/generators/backbone/install/install_generator.rb

@@ -4,21 +4,36 @@ module Backbone
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include Backbone::Generators::Helpers
- 
+      
       source_root File.expand_path("../templates", __FILE__)
 
       desc "This generator installs backbone.js with a default folder layout in app/assets/javascripts/backbone"
 
-      class_option :skip_git, :type => :boolean, :aliases => "-G", :default => false,
-                              :desc => "Skip Git ignores and keeps"
+      class_option :skip_git, type: :boolean, 
+                              aliases: '-G', 
+                              default: false,
+                              desc: 'Skip Git ignores and keeps'
 
       def inject_backbone
-        inject_into_file "app/assets/javascripts/application.js", :before => "//= require_tree" do
-"//= require underscore
-//= require backbone
-//= require railsy_backbone.sync
-//= require railsy_backbone.datalink
-//= require backbone/#{application_name.underscore}\n"
+        # when Rails app has application.js        
+        if File.exists? "#{Rails.root}/app/assets/javascripts/application.js"
+          inject_into_file "app/assets/javascripts/application.js", before: "//= require_tree" do
+            result =  "//= require underscore\n"
+            result += "//= require backbone\n"
+            result += "//= require railsy_backbone.sync\n"
+            result += "//= require railsy_backbone.datalink\n"
+            result += "//= require backbone/#{application_name.underscore}\n"
+          end
+        # when Rails app has application.js.coffee
+        elsif File.exists? "#{Rails.root}/app/assets/javascripts/application.js.coffee"
+          inject_into_file "app/assets/javascripts/application.js.coffee", before: '#= require_tree' do
+            result =  "#= require underscore\n"
+            result += "#= require backbone\n"
+            result += "#= require railsy_backbone.sync\n"
+            result += "#= require railsy_backbone.datalink\n"
+            result += "#= require backbone/#{application_name.underscore}\n"
+            result
+          end
         end
       end
 

data/lib/railsy_backbone/version.rb

@@ -1,3 +1,3 @@
 module RailsyBackbone
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/vendor/assets/javascripts/railsy_backbone.datalink.js

@@ -24,12 +24,12 @@
         // select the HTML input `name` attribute
         name = el.attr("name");
         
-        // TODO describe what this does
+        // jQuery select the HTML input element for next code chunk 
         model.bind("change:" + name, function() {
           return el.val(model.get(name));
         });
         
-        // re-set model specifical attribute when changed
+        // re-set model's specific attribute when changed
         return $(this).bind("change", function() {
           var attrs;
           el = $(this);

data/vendor/assets/javascripts/railsy_backbone.sync.js

@@ -85,15 +85,26 @@
       // 
       //      Started POST "/books" for 127.0.0.1
       //        Processing by BooksController#create as JSON
-      //        { "book" => { "title" => "the illiad", "author" => "home" } }
+      //        { "book" => { "title" => "the illiad", "author" => "home", "id" => 1} }
       // 
-      if(model.paramRoot) {
+      if(model.paramRoot) {        
         var model_attributes = {}
-        model_attributes[model.paramRoot] = model.toJSON(options);
-        params.data = JSON.stringify(options.attrs || model_attributes );
+        
+        // Store model instance in JSON format.
+        var attrs = model.toJSON(options);
+        
+        // Remove Rails unofficially reserved `created_at` and `updated_at` so 
+        // they're included in HTTP PUT/PATCH request.
+        delete attrs["created_at"];
+        delete attrs["updated_at"];
+        
+        // Nest model attributes within model's `paramRoot` key-value pair.
+        model_attributes[model.paramRoot] = attrs;
+        
+        params.data = JSON.stringify(options.attrs || model_attributes);
       } else {
         // If model does not define a `paramRoot`, use the original Backbone 
-        // implementation
+        // implementation.
         params.data = JSON.stringify(options.attrs || model.toJSON(options) );
       }
       // railsy_backbone (end)  

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railsy_backbone
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Weston Platter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-19 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties