rails-backbone-sp 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Ryan Fitzgerald
+
+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,89 @@
+# Backbone-Rails [![Build Status](https://secure.travis-ci.org/codebrew/backbone-rails.png)](http://travis-ci.org/codebrew/backbone-rails)
+
+Easily setup and use backbone.js (0.5.0) with rails 3.1
+
+## Rails 3.1 setup
+This gem requires the use of rails 3.1, coffeescript and the new rails asset pipeline provided by sprockets.
+
+This gem vendors the latest version of underscore.js and backbone.js for Rails 3.1 and greater. The files will be added to the asset pipeline and available for you to use. 
+    
+### Installation
+
+In your Gemfile, add this line:
+
+    gem "rails-backbone"
+  
+Then run the following commands:
+
+    bundle install
+    rails g backbone:install
+
+### Layout and namespacing
+
+Running `rails g backbone:install` will create the following directory structure under `app/assets/javascripts/backbone`:
+  
+    routers/
+    models/
+    templates/
+    views/
+    
+It will also create a toplevel app_name.coffee file to setup namespacing and setup initial requires.
+    
+## Generators
+backbone-rails provides 3 simple generators to help get you started using backbone.js with rails 3.1. 
+The generators will only create client side code (javascript).
+
+### Model Generator
+
+    rails g backbone:model
+    
+This generator creates a backbone model and collection inside `app/assets/javascript/backbone/models` to be used to talk to the rails backend.
+
+### Routers
+    
+    rails g backbone:router
+    
+This generator creates a backbone router with corresponding views and templates for the given actions provided.
+
+### Scaffolding
+
+    rails g backbone:scaffold
+    
+This generator creates a router, views, templates, model and collection to create a simple crud single page app
+
+## Example Usage
+
+Created a new rails 3.1 application called `blog`.
+
+    rails new blog
+
+Edit your Gemfile and add
+
+    gem 'rails-backbone'
+
+Install the gem and generate scaffolding.
+
+    bundle install
+    rails g backbone:install
+    rails g scaffold Post title:string content:string
+    rake db:migrate
+    rails g backbone:scaffold Post title:string content:string
+    
+You now have installed the backbone-rails gem, setup a default directory structure for your frontend backbone code. 
+Then you generated the usual rails server side crud scaffolding and finally generated backbone.js code to provide a simple single page crud app.
+You have one last step:
+
+Edit your posts index view `app/views/posts/index.html.erb` with the following contents:
+
+    <div id="posts"></div>
+
+    <script type="text/javascript">
+      $(function() {
+        // Blog is the app name
+        window.router = new Blog.Routers.PostsRouter({posts: <%= @posts.to_json.html_safe -%>});
+        Backbone.history.start();
+      });
+    </script>
+    
+Now start your server `rails s` and browse to [localhost:3000/posts](http://localhost:3000/posts)
+You should now have a fully functioning single page crud app for Post models.

data/Rakefile

@@ -0,0 +1,48 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'BackboneRails'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+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
+
+namespace :backbone do
+  desc "Download the latest versions of underscore and backbone.js from git"
+  task :download_latest do
+    files = {
+      'underscore.js'=>'https://github.com/documentcloud/underscore/raw/master/underscore.js',
+      'backbone.js' => 'https://github.com/documentcloud/backbone/raw/master/backbone.js'
+    }
+    
+    vendor_dir = "vendor/assets/javascripts"
+
+    require 'open-uri'
+    files.each do |local,remote|
+      puts "Downloading #{local}"
+      File.open "#{vendor_dir}/#{local}", 'w' do |f|
+        f.write open(remote).read
+      end
+    end
+  end
+end

data/lib/backbone-rails.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module BackboneRails
+  class Engine < Rails::Engine
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'generators/backbone/resource_helpers'
+
+module Backbone
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Backbone::Generators::ResourceHelpers
+      
+      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"
+                                      
+      def inject_backbone
+        inject_into_file "app/assets/javascripts/application.js", :before => "//= require_tree" do
+          "//= require underscore\n//= require backbone\n//= require backbone_rails_sync\n//= require backbone_datalink\n//= require backbone/#{application_name.underscore}\n"
+        end
+      end
+    
+      def create_dir_layout
+        %W{routers models views templates}.each do |dir|
+          empty_directory "app/assets/javascripts/backbone/#{dir}" 
+          create_file "app/assets/javascripts/backbone/#{dir}/.gitkeep" unless options[:skip_git]
+        end
+      end
+    
+      def create_app_file
+        template "app.coffee", "app/assets/javascripts/backbone/#{application_name.underscore}.js.coffee"
+      end
+     
+    end
+  end
+end

data/lib/generators/backbone/install/templates/app.coffee

@@ -0,0 +1,11 @@
+#= require_self
+#= require_tree ./templates
+#= require_tree ./models
+#= require_tree ./views
+#= require_tree ./routers
+
+window.<%= js_app_name %> =
+  Models: {}
+  Collections: {}
+  Routers: {}
+  Views: {}

data/lib/generators/backbone/model/model_generator.rb

@@ -0,0 +1,19 @@
+require 'generators/backbone/resource_helpers'
+
+module Backbone
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      include Backbone::Generators::ResourceHelpers
+        
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates a backbone model"
+      
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+    
+      def create_backbone_model
+        template "model.coffee", "#{backbone_path}/models/#{file_name}.js.coffee"
+      end
+    
+    end
+  end
+end

data/lib/generators/backbone/model/templates/model.coffee

@@ -0,0 +1,11 @@
+class <%= model_namespace %> extends Backbone.Model
+  paramRoot: '<%= singular_table_name %>'
+
+  defaults:
+<% attributes.each do |attribute| -%>
+    <%= attribute.name %>: null
+<% end -%>
+
+class <%= collection_namespace %>Collection extends Backbone.Collection
+  model: <%= model_namespace %>
+  url: '<%= route_url %>'

data/lib/generators/backbone/resource_helpers.rb

@@ -0,0 +1,55 @@
+module Backbone
+  module Generators
+    module ResourceHelpers
+      
+      def backbone_path
+        "app/assets/javascripts/backbone"
+      end
+      
+      def model_namespace
+        [js_app_name, "Models", class_name].join(".")
+      end
+      
+      def singular_model_name
+        uncapitalize singular_name.camelize
+      end
+      
+      def plural_model_name
+        uncapitalize(plural_name.camelize)
+      end
+      
+      def collection_namespace
+        [js_app_name, "Collections", plural_name.camelize].join(".")
+      end
+      
+      def view_namespace
+        [js_app_name, "Views", plural_name.camelize].join(".")
+      end
+      
+      def router_namespace
+        [js_app_name, "Routers", plural_name.camelize].join(".")
+      end
+      
+      def jst(action)
+        "backbone/templates/#{plural_name}/#{action}"
+      end
+      
+      def js_app_name
+        application_name.camelize
+      end
+      
+      def application_name
+        if defined?(Rails) && Rails.application
+          Rails.application.class.name.split('::').first
+        else
+          "application"
+        end
+      end
+      
+      def uncapitalize(str)
+          str[0, 1].downcase + str[1..-1]
+      end
+      
+    end
+  end
+end

data/lib/generators/backbone/router/router_generator.rb

@@ -0,0 +1,51 @@
+require 'generators/backbone/resource_helpers'
+
+module Backbone
+  module Generators
+    class RouterGenerator < Rails::Generators::NamedBase
+      include Backbone::Generators::ResourceHelpers
+      
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates a backbone router with views and templates for the provided actions"
+      
+      class_option :single, :type => :boolean, :aliases => "-S", :default => false,
+                              :desc => "Single Page Mode"
+      
+      argument :actions, :type => :array, :default => [], :banner => "action action"
+      
+      RESERVED_JS_WORDS = %W{
+        break case catch continue debugger default delete do else finally for 
+        function if in instanceof new return switch this throw try typeof var void while with 
+      }
+      
+      def validate_no_reserved_words
+        actions.each do |action|
+          if RESERVED_JS_WORDS.include? action
+             raise Thor::Error, "The name '#{action}' is reserved by javascript " <<
+                                "Please choose an alternative action name and run this generator again."
+          end
+        end
+      end
+      
+      def create_router_files
+        if options[:single]
+          template 'router-sp.coffee', File.join(backbone_path, "routers", class_path, "#{file_name}_router.js.coffee")
+        else
+          template 'router.coffee', File.join(backbone_path, "routers", class_path, "#{file_name}_router.js.coffee")
+        end
+      end
+      
+      def create_view_files
+         actions.each do |action|
+           @action = action
+           @view_path = File.join(backbone_path, "views", plural_name, "#{action}_view.js.coffee")
+           @jst_path = File.join(backbone_path,"templates", plural_name, "#{action}.jst.ejs")
+           
+           template "view.coffee", @view_path
+           template "template.jst", @jst_path
+         end
+      end
+
+    end
+  end
+end

data/lib/generators/backbone/router/templates/router-sp.coffee

@@ -0,0 +1,14 @@
+class <%= router_namespace %>Router extends Backbone.Router
+  initialize: (options) ->
+
+  routes:
+  <% actions.each do |action| -%>
+  "/<%= plural_name %>/<%= action %>": "<%= action %>"
+  <% end -%>
+
+<% actions.each do |action| -%>
+  <%= action %>: ->
+    @view = new <%= "#{view_namespace}.#{action.camelize}View()" %>
+    $("#<%= plural_name %>").html(@view.render().el)
+
+<% end -%>

data/lib/generators/backbone/router/templates/router.coffee

@@ -0,0 +1,14 @@
+class <%= router_namespace %>Router extends Backbone.Router
+  initialize: (options) ->
+
+  routes:
+  <% actions.each do |action| -%>
+  "/<%= action %>": "<%= action %>"
+  <% end -%>
+
+<% actions.each do |action| -%>
+  <%= action %>: ->
+    @view = new <%= "#{view_namespace}.#{action.camelize}View()" %>
+    $("#<%= plural_name %>").html(@view.render().el)
+
+<% end -%>

data/lib/generators/backbone/router/templates/template.jst

@@ -0,0 +1,2 @@
+<h1><%= class_name %>#<%= @action %></h1>
+<p>Find me in <%= @jst_path %></p>

data/lib/generators/backbone/router/templates/view.coffee

@@ -0,0 +1,8 @@
+<%= view_namespace %> ||= {}
+
+class <%= view_namespace %>.<%= @action.camelize %>View extends Backbone.View
+  template: JST["<%= jst @action %>"]
+
+  render: ->
+    $(@el).html(@template())
+    return this

data/lib/generators/backbone/scaffold/scaffold_generator.rb

@@ -0,0 +1,52 @@
+require 'generators/backbone/model/model_generator'
+
+module Backbone
+  module Generators
+    class ScaffoldGenerator < ModelGenerator
+      
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates the client side crud scaffolding"
+      
+      class_option :single, :type => :boolean, :aliases => "-S", :default => false,
+                              :desc => "Single Page Mode"
+      
+      def create_router_files 
+        if options[:single]
+          template 'router-sp.coffee', File.join(backbone_path, "routers", class_path, "#{plural_name}_router.js.coffee")
+        else
+          template 'router.coffee', File.join(backbone_path, "routers", class_path, "#{plural_name}_router.js.coffee")
+        end
+      end
+      
+      def create_view_files
+        available_views.each do |view|
+          template "views/#{view}_view.coffee", File.join(backbone_path, "views", plural_name, "#{view}_view.js.coffee")
+          template "templates/#{view}.jst", File.join(backbone_path, "templates", plural_name, "#{view}.jst.ejs")       
+        end
+        if options[:single]
+          available_views.each do |view|
+            template "views-sp/#{view}_view.coffee", File.join(backbone_path, "views", plural_name, "#{view}_view.js.coffee")
+            template "templates-sp/#{view}.jst", File.join(backbone_path, "templates", plural_name, "#{view}.jst.ejs")       
+          end
+          
+          template "views-sp/model_view.coffee", File.join(backbone_path, "views", plural_name, "#{singular_name}_view.js.coffee")
+          template "templates-sp/model.jst", File.join(backbone_path, "templates", plural_name, "#{singular_name}.jst.ejs")
+        else
+          available_views.each do |view|
+            template "views/#{view}_view.coffee", File.join(backbone_path, "views", plural_name, "#{view}_view.js.coffee")
+            template "templates/#{view}.jst", File.join(backbone_path, "templates", plural_name, "#{view}.jst.ejs")       
+          end
+          
+          template "views/model_view.coffee", File.join(backbone_path, "views", plural_name, "#{singular_name}_view.js.coffee")
+          template "templates/model.jst", File.join(backbone_path, "templates", plural_name, "#{singular_name}.jst.ejs")
+        end
+      end
+      
+      protected
+        def available_views
+          %w(index show new edit)
+        end
+        
+    end
+  end
+end

data/lib/generators/backbone/scaffold/templates/model.coffee

@@ -0,0 +1,11 @@
+class <%= model_namespace %> extends Backbone.Model
+  paramRoot: '<%= singular_table_name %>'
+
+  defaults:
+<% attributes.each do |attribute| -%>
+    <%= attribute.name %>: null
+<% end -%>
+
+class <%= collection_namespace %>Collection extends Backbone.Collection
+  model: <%= model_namespace %>
+  url: '<%= route_url %>'

data/lib/generators/backbone/scaffold/templates/router-sp.coffee

@@ -0,0 +1,31 @@
+class <%= router_namespace %>Router extends Backbone.Router
+  initialize: (options) ->
+    @<%= plural_model_name %> = new <%= collection_namespace %>Collection()
+    @<%= plural_model_name %>.reset options.<%= plural_model_name %>
+
+  routes:
+    "/<%= plural_name %>/new"      : "new<%= class_name %>"
+    "/<%= plural_name %>/index"    : "index"
+    "/<%= plural_name %>/:id/edit" : "edit"
+    "/<%= plural_name %>/:id"      : "show"
+    "/<%= plural_name %>/.*"       : "index"
+  
+  new<%= class_name %>: ->
+    @view = new <%= "#{view_namespace}.NewView(collection: @#{plural_name})" %>
+    $("#<%= plural_name %>").html(@view.render().el)
+
+  index: ->
+    @view = new <%= "#{view_namespace}.IndexView(#{plural_name}: @#{plural_name})" %>
+    $("#<%= plural_name %>").html(@view.render().el)
+
+  show: (id) ->
+    <%= singular_name %> = @<%= plural_name %>.get(id)
+
+    @view = new <%= "#{view_namespace}.ShowView(model: #{singular_name})" %>
+    $("#<%= plural_name %>").html(@view.render().el)
+
+  edit: (id) ->
+    <%= singular_name %> = @<%= plural_name %>.get(id)
+
+    @view = new <%= "#{view_namespace}.EditView(model: #{singular_name})" %>
+    $("#<%= plural_name %>").html(@view.render().el)

data/lib/generators/backbone/scaffold/templates/router.coffee

@@ -0,0 +1,31 @@
+class <%= router_namespace %>Router extends Backbone.Router
+  initialize: (options) ->
+    @<%= plural_model_name %> = new <%= collection_namespace %>Collection()
+    @<%= plural_model_name %>.reset options.<%= plural_model_name %>
+
+  routes:
+    "/new"      : "new<%= class_name %>"
+    "/index"    : "index"
+    "/:id/edit" : "edit"
+    "/:id"      : "show"
+    ".*"        : "index"
+
+  new<%= class_name %>: ->
+    @view = new <%= "#{view_namespace}.NewView(collection: @#{plural_name})" %>
+    $("#<%= plural_name %>").html(@view.render().el)
+
+  index: ->
+    @view = new <%= "#{view_namespace}.IndexView(#{plural_name}: @#{plural_name})" %>
+    $("#<%= plural_name %>").html(@view.render().el)
+
+  show: (id) ->
+    <%= singular_name %> = @<%= plural_name %>.get(id)
+
+    @view = new <%= "#{view_namespace}.ShowView(model: #{singular_name})" %>
+    $("#<%= plural_name %>").html(@view.render().el)
+
+  edit: (id) ->
+    <%= singular_name %> = @<%= plural_name %>.get(id)
+
+    @view = new <%= "#{view_namespace}.EditView(model: #{singular_name})" %>
+    $("#<%= plural_name %>").html(@view.render().el)

data/lib/generators/backbone/scaffold/templates/templates/edit.jst

@@ -0,0 +1,17 @@
+<h1>Edit <%= singular_table_name %></h1>
+
+<form id="edit-<%= singular_table_name %>" name="<%= singular_table_name %>">
+<% attributes.each do |attribute| -%>
+  <div class="field">
+    <label for="<%= attribute.name %>"> <%= attribute.name %>:</label>
+    <input type="text" name="<%= attribute.name %>" id="<%= attribute.name %>" value=<%%= <%= attribute.name %> %> >
+  </div>
+
+<% end -%>
+  <div class="actions">
+    <input type="submit" value="Update <%= human_name %>" />
+  </div>
+
+</form>
+
+<a href="#/index">Back</a>

data/lib/generators/backbone/scaffold/templates/templates/index.jst

@@ -0,0 +1,16 @@
+<h1>Listing <%= plural_table_name %></h1>
+
+<table id="<%= plural_name %>-table">
+  <tr>
+<% attributes.each do |attribute| -%>
+    <th><%= attribute.human_name %></th>
+<% end -%>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+</table>
+
+<br/>
+
+<a href="#/new">New <%= human_name %></a>

data/lib/generators/backbone/scaffold/templates/templates/model.jst

@@ -0,0 +1,7 @@
+<% attributes.each do |attribute| -%>
+<td><%%= <%= attribute.name %> %></td>
+<% end -%>
+
+<td><a href="#/<%%= id %>">Show</td>
+<td><a href="#/<%%= id %>/edit">Edit</td>
+<td><a href="#/<%%= id %>/destroy" class="destroy">Destroy</a></td>

data/lib/generators/backbone/scaffold/templates/templates/new.jst

@@ -0,0 +1,17 @@
+<h1>New <%= singular_table_name %></h1>
+
+<form id="new-<%= singular_table_name %>" name="<%= singular_table_name %>">
+<% attributes.each do |attribute| -%>
+  <div class="field">
+    <label for="<%= attribute.name %>"> <%= attribute.name %>:</label>
+    <input type="text" name="<%= attribute.name %>" id="<%= attribute.name %>" value=<%%= <%= attribute.name %> %> >
+  </div>
+
+<% end -%>
+  <div class="actions">
+    <input type="submit" value="Create <%= human_name %>" />
+  </div>
+
+</form>
+
+<a href="#/index">Back</a>

data/lib/generators/backbone/scaffold/templates/templates/show.jst

@@ -0,0 +1,9 @@
+<% attributes.each do |attribute| -%>
+<p>
+  <b><%= attribute.human_name %>:</b>
+  <%%= <%= attribute.name %> %>
+</p>
+
+<% end -%>
+
+<a href="#/index">Back</a>

data/lib/generators/backbone/scaffold/templates/templates-sp/edit.jst

@@ -0,0 +1,17 @@
+<h1>Edit <%= singular_table_name %></h1>
+
+<form id="edit-<%= singular_table_name %>" name="<%= singular_table_name %>">
+<% attributes.each do |attribute| -%>
+  <div class="field">
+    <label for="<%= attribute.name %>"> <%= attribute.name %>:</label>
+    <input type="text" name="<%= attribute.name %>" id="<%= attribute.name %>" value=<%%= <%= attribute.name %> %> >
+  </div>
+
+<% end -%>
+  <div class="actions">
+    <input type="submit" value="Update <%= human_name %>" />
+  </div>
+
+</form>
+
+<a href="#/<%= plural_name %>/index">Back</a>

data/lib/generators/backbone/scaffold/templates/templates-sp/index.jst

@@ -0,0 +1,16 @@
+<h1>Listing <%= plural_table_name %></h1>
+
+<table id="<%= plural_name %>-table">
+  <tr>
+<% attributes.each do |attribute| -%>
+    <th><%= attribute.human_name %></th>
+<% end -%>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+</table>
+
+<br/>
+
+<a href="#/<%= plural_name %>/new">New <%= human_name %></a>

data/lib/generators/backbone/scaffold/templates/templates-sp/model.jst

@@ -0,0 +1,7 @@
+<% attributes.each do |attribute| -%>
+<td><%%= <%= attribute.name %> %></td>
+<% end -%>
+
+<td><a href="#/<%= plural_name %>/<%%= id %>">Show</td>
+<td><a href="#/<%= plural_name %>/<%%= id %>/edit">Edit</td>
+<td><a href="#/<%= plural_name %>/<%%= id %>/destroy" class="destroy">Destroy</a></td>