railsy_backbone 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb1af4f0c455456434c50c08a1d5223423504b6b
-  data.tar.gz: c1ae2f4fdff40e8cb05baac296e99e196bec3240
+  metadata.gz: a846e920a5dad426c7c7e892cf4af5c5e7a85e45
+  data.tar.gz: 37d9f658a1c1b61f45aa144a5393429134ac6474
 SHA512:
-  metadata.gz: 40ce46134b4a21e1a576a86625793b1431ae6bce5db3b5cea8b789fb203f85012590ef1f08b4f66f3807e2b0d9eaa7cd130f65b88ffef08abb32aaf75c83f4dd
-  data.tar.gz: b4678c7c8ca149d574d62ac03d2c42a2edc88da9fe96f302b48a94365a528a3ef89373714ad0dcd207fc1484010b6821c527946ab1d5e8dfb739cc5c428f5c79
+  metadata.gz: 5fae32e260f47e893775010bbe983361126644085e70391d5013b533d6c586f53a883fc6eef3e6a349aad38339e76369b0308535a4d57b8be55e662a01bdd54d
+  data.tar.gz: fd9f382bbbe0a082ceafdc937ba33dd80d2f7de9f3a033d129c07a763ae176086d7fb93995296b66f237d0d9c727341c1f720dd853d4772faf7e286531e44dbb

data/CHANGELOG.md

@@ -1,26 +1,54 @@
+## 0.0.3
+
+- copied Backbone model generator from backbone-rails
+  (westonplatter)
+
+- copied Backbone router generator from backbone-rails
+  (westonplatter)
+  
+- copied Backbone scaffold generator from backbone-rails
+  (westonplatter)
+  
+- copied the localized Gemset setup from backbone-rails
+  (westonplatter)
+  
+- copied `dataLink` from backbone-rails + added docs with TODOS
+
+- updated install instructions
+
 
 ## 0.0.2
 
 - changed license to BSD-3
+  (westonplatter)
 
 - setup [travis ci](https://travis-ci.org/westonplatter/railsy_backbone)
+  (westonplatter)
 
 - application.js install generator is fully setup
-
+  (westonplatter)
+  
 - application.js install generator is full tested
-
+  (westonplatter)
+  
 - moved location of helpers.rb so it can be required
-
-- setup test unit (much thanks to [Ryan Fitzgerald](https://twitter.com/TheRyanFitz))
+  (westonplatter)
   
+- setup test unit (much thanks to [Ryan Fitzgerald](https://twitter.com/TheRyanFitz))
+  (westonplatter)
+    
 - updated gemspec for jquery-rails 3
-
+  (westonplatter)
+  
 - setup groc to document the project. docs available at 
 [http://westonplatter.github.io/railsy_backbone](http://westonplatter.github.io/railsy_backbone)
+  (westonplatter)
 
 
 ## 0.0.1
 
 - Updated jquery-rails to be 2.2.x compatible.
-
+  (westonplatter)
+  
 - Copied repo from https://github.com/codebrew/backbone-rails 
+  (westonplatter)

data/README.md

@@ -40,7 +40,7 @@ Automatically handles the Rails `authenticity_token`. Or, more technically, sets
 
 Add this line to your application's Gemfile:
 
-    gem 'railsy_backbone', github: 'westonplatter/railsy_backbone'
+    gem 'railsy_backbone', '~> 0.0.3'
 
 And then execute:
 

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

@@ -0,0 +1,19 @@
+require 'generators/backbone/helpers'
+
+module Backbone
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      include Backbone::Generators::Helpers
+        
+      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/router/router_generator.rb

@@ -0,0 +1,44 @@
+require 'generators/backbone/helpers'
+
+module Backbone
+  module Generators
+    class RouterGenerator < Rails::Generators::NamedBase
+      include Backbone::Generators::Helpers
+      
+      source_root File.expand_path("../templates", __FILE__)
+      desc "This generator creates a backbone router with views and templates for the provided actions"
+      
+      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 
+        template 'router.coffee', File.join(backbone_path, "routers", class_path, "#{file_name}_router.js.coffee")
+      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.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,31 @@
+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"
+      
+      def create_router_files 
+        template 'router.coffee', File.join(backbone_path, "routers", class_path, "#{plural_name}_router.js.coffee")
+      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
+        
+        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
+      
+      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.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/views/edit_view.coffee

@@ -0,0 +1,24 @@
+<%= view_namespace %> ||= {}
+
+class <%= view_namespace %>.EditView extends Backbone.View
+  template: JST["<%= jst 'edit' %>"]
+
+  events:
+    "submit #edit-<%= singular_name %>": "update"
+
+  update: (e) ->
+    e.preventDefault()
+    e.stopPropagation()
+
+    @model.save(null,
+      success: (<%= singular_name %>) =>
+        @model = <%= singular_name %>
+        window.location.hash = "/#{@model.id}"
+    )
+
+  render: ->
+    @$el.html(@template(@model.toJSON() ))
+
+    this.$("form").backboneLink(@model)
+
+    return this

data/lib/generators/backbone/scaffold/templates/views/index_view.coffee

@@ -0,0 +1,20 @@
+<%= view_namespace %> ||= {}
+
+class <%= view_namespace %>.IndexView extends Backbone.View
+  template: JST["<%= jst 'index' %>"]
+
+  initialize: () ->
+    @options.<%= plural_model_name %>.bind('reset', @addAll)
+
+  addAll: () =>
+    @options.<%= plural_model_name %>.each(@addOne)
+
+  addOne: (<%= singular_model_name %>) =>
+    view = new <%= view_namespace %>.<%= singular_name.camelize %>View({model : <%= singular_model_name %>})
+    @$("tbody").append(view.render().el)
+
+  render: =>
+    @$el.html(@template(<%= plural_model_name %>: @options.<%= plural_model_name %>.toJSON() ))
+    @addAll()
+
+    return this

data/lib/generators/backbone/scaffold/templates/views/model_view.coffee

@@ -0,0 +1,19 @@
+<%= view_namespace %> ||= {}
+
+class <%= view_namespace %>.<%= singular_name.camelize %>View extends Backbone.View
+  template: JST["<%= jst singular_name %>"]
+
+  events:
+    "click .destroy" : "destroy"
+
+  tagName: "tr"
+
+  destroy: () ->
+    @model.destroy()
+    this.remove()
+
+    return false
+
+  render: ->
+    @$el.html(@template(@model.toJSON() ))
+    return this

data/lib/generators/backbone/scaffold/templates/views/new_view.coffee

@@ -0,0 +1,37 @@
+<%= view_namespace %> ||= {}
+
+class <%= view_namespace %>.NewView extends Backbone.View
+  template: JST["<%= jst 'new' %>"]
+
+  events:
+    "submit #new-<%= singular_name %>": "save"
+
+  constructor: (options) ->
+    super(options)
+    @model = new @collection.model()
+
+    @model.bind("change:errors", () =>
+      this.render()
+    )
+
+  save: (e) ->
+    e.preventDefault()
+    e.stopPropagation()
+
+    @model.unset("errors")
+
+    @collection.create(@model.toJSON(),
+      success: (<%= singular_name %>) =>
+        @model = <%= singular_name %>
+        window.location.hash = "/#{@model.id}"
+
+      error: (<%= singular_name %>, jqXHR) =>
+        @model.set({errors: $.parseJSON(jqXHR.responseText)})
+    )
+
+  render: ->
+    @$el.html(@template(@model.toJSON() ))
+
+    this.$("form").backboneLink(@model)
+
+    return this

data/lib/generators/backbone/scaffold/templates/views/show_view.coffee

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

data/lib/railsy_backbone/version.rb

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

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

@@ -1,28 +1,43 @@
 // __NOTE:__ only overriding Backbone when `railsy_backbone (start) ... (end)` 
 // is explicitly called out.
 // 
-// Before addign this to the repo, I'd like to enable a configuration value to 
-// turn this feature on and off
-// 
-// 
-// (function($) {
-//   return $.extend($.fn, {
-//     backboneLink: function(model) {
-//       return $(this).find(":input").each(function() {
-//         var el, name;
-//         el = $(this);
-//         name = el.attr("name");
-//         model.bind("change:" + name, function() {
-//           return el.val(model.get(name));
-//         });
-//         return $(this).bind("change", function() {
-//           var attrs;
-//           el = $(this);
-//           attrs = {};
-//           attrs[el.attr("name")] = el.val();
-//           return model.set(attrs);
-//         });
-//       });
-//     }
-//   });
-// })(jQuery);
+// TODO
+// Enable a configuration value to turn this feature on/off
+
+(function($) {
+  
+  // `$.extend` enables us to chain functions onto jQuery selected DOM elements.
+  // For example, 
+  // 
+  //     this.$("form").backboneLink(@model)
+  // 
+  return $.extend($.fn, {
+    
+    // name function `backboneLine`
+    backboneLink: function(model) {
+      
+      // only target HTML input elements
+      return $(this).find(":input").each(function() {
+        var el, name;
+        el = $(this);
+        
+        // select the HTML input `name` attribute
+        name = el.attr("name");
+        
+        // TODO describe what this does
+        model.bind("change:" + name, function() {
+          return el.val(model.get(name));
+        });
+        
+        // re-set model specifical attribute when changed
+        return $(this).bind("change", function() {
+          var attrs;
+          el = $(this);
+          attrs = {};
+          attrs[el.attr("name")] = el.val();
+          return model.set(attrs);
+        });
+      });
+    }
+  });
+})(jQuery);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: railsy_backbone
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Weston Platter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-03 00:00:00.000000000 Z
+date: 2013-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -202,6 +202,25 @@ files:
 - lib/generators/backbone/helpers.rb
 - lib/generators/backbone/install/install_generator.rb
 - lib/generators/backbone/install/templates/app.coffee
+- lib/generators/backbone/model/model_generator.rb
+- lib/generators/backbone/model/templates/model.coffee
+- lib/generators/backbone/router/router_generator.rb
+- lib/generators/backbone/router/templates/router.coffee
+- lib/generators/backbone/router/templates/template.jst
+- lib/generators/backbone/router/templates/view.coffee
+- lib/generators/backbone/scaffold/scaffold_generator.rb
+- lib/generators/backbone/scaffold/templates/model.coffee
+- lib/generators/backbone/scaffold/templates/router.coffee
+- lib/generators/backbone/scaffold/templates/templates/edit.jst
+- lib/generators/backbone/scaffold/templates/templates/index.jst
+- lib/generators/backbone/scaffold/templates/templates/model.jst
+- lib/generators/backbone/scaffold/templates/templates/new.jst
+- lib/generators/backbone/scaffold/templates/templates/show.jst
+- lib/generators/backbone/scaffold/templates/views/edit_view.coffee
+- lib/generators/backbone/scaffold/templates/views/index_view.coffee
+- lib/generators/backbone/scaffold/templates/views/model_view.coffee
+- lib/generators/backbone/scaffold/templates/views/new_view.coffee
+- lib/generators/backbone/scaffold/templates/views/show_view.coffee
 - lib/railsy_backbone/version.rb
 - lib/railsy_backbone.rb
 - vendor/assets/javascripts/backbone.js