handlebars_routes 0.0.2 → 0.0.3

data/README.md

@@ -1,15 +1,24 @@
 Handlebars Routes
 =================
+
 Installing
 ----------
+
 Bundle it
 
     gem 'handlebars_routes', '~> 0.0.1'
 
 Sprockets require it (in app/assets/javascripts/application.(js|coffee) for example):
-    
+
     //= handlebars_routes
 
+The `link_to` helper uses [underscore.js](https://github.com/rweng/underscore-rails) templating and assumes you have put it into "mustache mode"
+
+    # Setup underscore's templating to use Mustache style templates
+    _.templateSettings =
+      interpolate: /\{\{(.+?)\}\}/g
+
+
 What it does
 ------------
 Its really annoying not to have all your Rails routes on the client side especially when you're doing Javascript templating.  This gem aims to fix that by dumping your rails routes into a `rails_routes` object in javascript.
@@ -22,11 +31,11 @@ Examples are probably better eh?
 --------------------------------
 
 Given the Rails routes:
-    
+
     resources :items do
       resources :products
     end
-      
+
 Given the data (a Backbone like object):
 
     item = { attributes: {
@@ -36,9 +45,12 @@ Given the data (a Backbone like object):
                created_at:'11/11/2011'      
               }
            }
-           
-And the template item/show.jst.hbs (notice the **triple-stache** around link_to):
-    
+
+And the template item/show.jst.hbs (notice the **triple-stache** around link_to).
+`"item_product"` is the route that Rails provided. The list of routes
+are stored in the `rails_routes` global javascript object. Take a look at
+it in Inspector to find specific routes. 
+
     <tr>
       {{#attributes}}
         <td>{{{link_to product.title "item_product"}}}</td>
@@ -51,10 +63,10 @@ And this coffeescript Backbone View:
 
     class ItemView extends Backbone.View
       # ...
-      
+
       render: =>
         $(@el).prepend JST['item/show'] @model
-      
+
       # ...
     end
 
@@ -65,4 +77,4 @@ This awesome looking html will be produced!!!
       <td>PUGS</td>
       <td>11/11/2011</td>
     </tr>
-    
+

data/handlebars_routes.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "execjs", "~> 1.2.9"
+  s.add_runtime_dependency "execjs", "~> 1.3"
   s.add_runtime_dependency "handlebars_assets", "~> 0.1.3"
+  s.add_runtime_dependency "underscore-rails", "~> 1.3"
 
 end

data/lib/handlebars_routes/version.rb

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

data/vendor/assets/javascripts/handlebars_routes_helpers.coffee

@@ -7,7 +7,6 @@ Handlebars.registerHelper 'link_to', (text, route_name) ->
   template = _.template("<a href='{{href}}'>{{text}}</a>")
   template(text: text, href: href)
 
-# Returns what it returns.
 # Grab a named route from the global rails_routes object
 # rails_routes are mustached, so we'll try to match the object's attributes
 # to the attribute names in the route. We'll even recurse into the object
@@ -20,13 +19,16 @@ Handlebars.registerHelper 'link_to', (text, route_name) ->
 # Example:
 # object = {id: 1, title: 'boom', company_id: 5 }
 # route = /companies/:company_id/resources/:id 
+# router("company_resource", object)
 # # => /companies/5/resources/1
 # 
 # Example:
 # object = {id: 1, title: 'boom', company: { id: 2 }}
 # route = /companies/:company_id/resources/:id 
+# router("company_resource", object)
 # # => /companies/2/resources/1
 #
+# Returns a String.
 Handlebars.registerHelper 'router', (route_name, object) ->
   object or= @
   route = rails_routes[route_name]
@@ -40,6 +42,11 @@ Handlebars.registerHelper 'router', (route_name, object) ->
     # build an array to traverse if the attr has an underscore in it
     # we'll look for nested objects if we don't find a value in the object
     # for the underscored attr.
+    # For example if one of the attrs is "company_id" we'll look for
+    # the top level key "company_id" in object or look for the key
+    # "company" and then look for the key "id" inside the object at
+    # "company". The example in the comments above shows you both
+    # scenarios. 
     _.each attrs, (attr)->
       attr_hash[attr] or= [attr]
       if attr.match(/_/)
@@ -55,12 +62,13 @@ Handlebars.registerHelper 'router', (route_name, object) ->
           return traverse(obj[node], path)
         else
           return obj[node]
+    
     _.each _.keys(attr_hash), (key) ->
       if object[key]?
         attr_hash[key] = object[key]
       else
         attr_hash[key] = traverse(object, _.clone(attr_hash[key][1]))
-    
+
     _.template(route)(attr_hash)
 
-   
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: handlebars_routes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-09 00:00:00.000000000Z
+date: 2012-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
-  requirement: &2157787020 !ruby/object:Gem::Requirement
+  requirement: &70167036036660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.9
+        version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *2157787020
+  version_requirements: *70167036036660
 - !ruby/object:Gem::Dependency
   name: handlebars_assets
-  requirement: &2157786440 !ruby/object:Gem::Requirement
+  requirement: &70167036035480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,18 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *2157786440
+  version_requirements: *70167036035480
+- !ruby/object:Gem::Dependency
+  name: underscore-rails
+  requirement: &70167036034860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70167036034860
 description: Rails routes in your javascripts, link_to and route helper for Handlebars
 email:
 - tyler.a.montgomery@gmail.com
@@ -69,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: handlebars_routes
-rubygems_version: 1.8.10
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Rails routes in your javascripts, link_to and route helper for Handlebars