asset_pipeline_routes 0.0.3 → 0.0.4

data/README.md

@@ -3,7 +3,7 @@
 Getting your Rails routes into the Rails 3.2 asset pipeline is really easy. Just
 `include Rails.application.routes.url_helpers` and you have all your routes available.
 
-But except for hard-coded links this won't help you, because all resource links dynamic params at compile-time to work, like `{:id => 42}`. Without supplying them you won't get anywhere.
+But except for hard-coded links this won't help you, because in production you have to pass in resource parameters at compile-time, where they are not available.
 
 Heh, you might think! Just call a route helper and pass in a dynamic parameter mapping, like
 `user_path('{{id}}')`. Sadly this won't yield the desired result! Instead of `/users/{{id}}`, you'll be presented with `/users/%7B%7Bid%7D%7D` because you're mapping just got html_escaped!
@@ -21,25 +21,30 @@ Here's an example, assuming you got a routes.rb with
     resources :users # => yields multiple routes, e.g. /users/:id(.:format)
 
 in it. Then, in you're javascript file you'd call `r.users_path`.  All path fragments are replaced with Mustache-style attribute bindings by default:
-    
+
     # application.js.coffee.erb
     userPath = '<%= r.user_path %>' # => yields /users/{{id}}
     usersPath = '<%= r.users_path %>' # => yields /users
 
 You can even hook up member- or collection routes, whatever you like really. Just prefix your routes with `r.` and you can directly use them in your asset-pipeline!
 
-All `_path`-methods take an arbitrary argument which is used to evaluate the final route. 
+All `_path`-methods take an arbitrary argument which is used to evaluate the final route.
 So if you want a regexp matching all users-show actions, you can do it just like this:
 
     # application.js.coffee.erb
     usersPath = '<%= r.user_path '\d+' %>' # => yields /users/\d+
-    
+
 Sometimes you want to generate the URL for a given resource on the client-side entirely. That's possible as well:
 
+    # application.js.erb
+    var editUserRoute = <%= r.edit_user_path_method %>; // => yields anonymous function in js
+    var editUserPath = editUserRoute(42); // => yields '/users/42/edit'
+
+    # or, if you prefer CoffeeScript:
     # application.js.coffee.erb
-    editUserRoute = `<%= r.edit_user_method %>` # => yields anonymous function
-    editUserPath = editUserRoute(42) # => yields /users/42/edit
-    
+    editUserPath = <%= r.edit_user_path_method(:coffee) %>
+    editUserPath = editUserRoute(42) # => yields '/users/42/edit'
+
 Now you have total control over your Rails routes.
 
 # Addendum

data/lib/asset_pipeline_routes.rb

@@ -1,16 +1,17 @@
+# encoding: UTF-8
 require_relative "asset_pipeline_routes/version"
-require_relative "asset_pipeline_routes/routes_helper"
+require_relative "asset_pipeline_routes/routes"
 
 module AssetPipelineRoutes
   class Railtie < ::Rails::Railtie
     initializer "asset_pipeline_routes.environment" do |app|
-     	ActiveSupport.on_load(:action_view) do
-     	  include ::AssetPipelineRoutes::RoutesContext
-        
-     	  app.assets.context_class.instance_eval do
-     	    include ::AssetPipelineRoutes::RoutesContext
+      ActiveSupport.on_load(:action_view) do
+        include ::AssetPipelineRoutes::RoutesContext
+
+        app.assets.context_class.instance_eval do
+          include ::AssetPipelineRoutes::RoutesContext
         end
-     	end
+      end
     end
   end
 end

data/lib/asset_pipeline_routes/js_function_helper.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 require 'active_support/core_ext/string/inflections'
 
 module AssetPipelineRoutes

data/lib/asset_pipeline_routes/path.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+module AssetPipelineRoutes
+  class Path
+    DEFAULT_REPLACEMENT = '{{\1}}'
+
+    attr_accessor :route
+
+    def self.proc_for_route route
+      proc { |id_replacement = DEFAULT_REPLACEMENT, *args|
+        proc { |route, replacement, *mapping|
+          Path.new(route.path.ast.to_s).build replacement, *mapping
+        }.curry[route].call(id_replacement, *args)
+      }
+    end
+
+    def initialize route_str
+      @route = route_str
+    end
+
+    def apply_format options = {}
+      @route = @route.sub(/\(\.:\w+\)/,format(options))
+    end
+
+    def build *args
+      apply_format args.extract_options!
+      replacements(*args).inject(@route) { |route, param|
+        route.sub(/:(\w+)/, param.to_s)
+      }
+    end
+
+    def format options
+      str = options.fetch(:format) { '' }
+      str = ".#{str}" unless str.empty? && str[0] != '.'
+      str
+    end
+
+    def default_replacements
+      Array.new(number_of_replacements, DEFAULT_REPLACEMENT)
+    end
+
+    def replacements *args
+      defaults = default_replacements
+      defaults[0...args.length] = args
+      defaults
+    end
+
+    def number_of_replacements
+      @route.scan(/:(\w+)/).inject(0) { |sum, n| sum + 1 }
+    end
+  end
+end

data/lib/asset_pipeline_routes/routes.rb

@@ -0,0 +1,34 @@
+# encoding: UTF-8
+require "active_support/core_ext/array/extract_options"
+
+require_relative "routes_context"
+require_relative "js_function_helper"
+require_relative "path"
+
+module AssetPipelineRoutes
+  class Routes
+    def initialize routes
+      define_application_routes routes
+    end
+
+    def define_application_routes routes
+      routes.select{ |route| named_route?(route) }.each do |route|
+        define_route route
+      end
+    end
+
+    def define_route route
+      self.class.instance_eval do
+        define_method :"#{route.name}_path", Path.proc_for_route(route)
+
+        define_method :"#{route.name}_path_method" do |style = :js|
+          AssetPipelineRoutes::JsFunctionHelper::route_to_anonymous_function Path.new(route.path.ast.to_s).build(':\1'), style
+        end
+      end
+    end
+
+    def named_route? route
+      !route.name.nil?
+    end
+  end
+end

data/lib/asset_pipeline_routes/routes_context.rb

@@ -1,9 +1,8 @@
+# encoding: UTF-8
 module AssetPipelineRoutes
   module RoutesContext
-
     def r
-      @r ||= ::AssetPipelineRoutes::RoutesHelper.new(Rails.application.routes.routes)
+      @r ||= ::AssetPipelineRoutes::Routes.new(Rails.application.routes.routes)
     end
-
   end
 end

data/lib/asset_pipeline_routes/version.rb

@@ -1,3 +1,4 @@
+# encoding: UTF-8
 module AssetPipelineRoutes
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/asset_pipeline_routes_spec.rb

@@ -4,60 +4,78 @@ def build_route name, path
   OpenStruct.new({:name => name, :path => OpenStruct.new(:ast => path)})
 end
 
-describe AssetPipelineRoutes do
+describe AssetPipelineRoutes::Routes do
   # the @route property basically describes a RouteSet#routes object
   # as Rails.application.routes.routes[:index] returns it
   describe 'resources#index' do
     before { @route = build_route 'users', '/users(.:format)' }
-    subject { AssetPipelineRoutes::RoutesHelper.new [@route] }
+    subject { AssetPipelineRoutes::Routes.new [@route] }
 
     it { should respond_to(:users_path) }
     its(:users_path) { should eql '/users'}
     it { subject.users_path('\d+').should eql('/users') }
+
+    describe "with format" do
+      it { subject.users_path(format: 'json').should eql('/users.json') }
+    end
   end
 
   describe 'resources#show' do
     before { @route = build_route 'user', '/users/:id(.:format)' }
-    subject { AssetPipelineRoutes::RoutesHelper.new [@route] }
+    subject { AssetPipelineRoutes::Routes.new [@route] }
 
     it { should respond_to(:user_path) }
     its(:user_path) { should eql('/users/{{id}}') }
     it { subject.user_path('\d+').should eql('/users/\d+') }
+
+    describe "with format" do
+      it { subject.user_path('\d+', format: 'json').should eql('/users/\d+.json') }
+      it { subject.user_path(42, format: 'xml').should eql('/users/42.xml') }
+    end
   end
 
   describe 'resources#edit' do
     before { @route = build_route 'edit_user', '/users/:id/edit(.:format)' }
-    subject { AssetPipelineRoutes::RoutesHelper.new [@route] }
+    subject { AssetPipelineRoutes::Routes.new [@route] }
 
     it { should respond_to(:edit_user_path) }
     its(:edit_user_path) { should eql('/users/{{id}}/edit') }
     it { subject.edit_user_path('\d+').should eql('/users/\d+/edit') }
-  end
-
-  describe 'resources without name' do
-    before { @route = build_route nil, '/foo' }
-    subject { AssetPipelineRoutes::RoutesHelper.new [@route] }
 
-    it { subject.should_not_receive(:build_url) }
+    describe "with format" do
+      it { subject.edit_user_path('\d+', format: 'json').should eql('/users/\d+/edit.json') }
+      it { subject.edit_user_path(42, format: 'xml').should eql('/users/42/edit.xml') }
+    end
   end
 
   describe 'nested routes' do
     before { @route = build_route 'project_ticket', '/projects/:project_id/tickets/:id(.:format)' }
-    subject { AssetPipelineRoutes::RoutesHelper.new [@route] }
+    subject { AssetPipelineRoutes::Routes.new [@route] }
 
     it { should respond_to(:project_ticket_path) }
-    its(:project_ticket_path) { should eql('/projects/{{project_id}}/tickets/{{id}}') }
+    its(:project_ticket_path) {should eql('/projects/{{project_id}}/tickets/{{id}}') }
+    it { subject.project_ticket_path(1,'\d+').should eql('/projects/1/tickets/\d+') }
+    it { subject.project_ticket_path('\d+',2).should eql('/projects/\d+/tickets/2') }
+    it { subject.project_ticket_path(1,2).should eql('/projects/1/tickets/2') }
+    it { subject.project_ticket_path(1,2,3).should eql('/projects/1/tickets/2') }
+
+    describe "with format" do
+      it { subject.project_ticket_path("a","b",format: 'json').should eql('/projects/a/tickets/b.json') }
+      it { subject.project_ticket_path("a", format: 'json').should eql('/projects/a/tickets/{{id}}.json') }
+    end
   end
 
   describe 'javascript method generation' do
     before { @route = build_route 'user', '/users/:id/edit(.:format)' }
-    subject { AssetPipelineRoutes::RoutesHelper.new [@route] }
+    subject { AssetPipelineRoutes::Routes.new [@route] }
 
     it { should respond_to(:user_path_method) }
+
     it "should generate JavaScript mapping method" do
       js_method = "(function() { return function (id) { return '/users/' + id + '/edit' }; }).call(this);"
       subject.edit_user_path_method.should eql(js_method)
     end
+
     it "should generate CoffeScript mapping method" do
       coffee_method = "(-> (id) -> '/users/' + id + '/edit')(this)"
       subject.edit_user_path_method(:coffee).should eql(coffee_method)

data/spec/path_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe AssetPipelineRoutes::Path do
+  subject { AssetPipelineRoutes::Path.new '/users/:id/edit(.:format)' }
+
+  describe 'apply_format' do
+    it { subject.apply_format({ format: 'json' }).should eql '/users/:id/edit.json' }
+    it { subject.apply_format({}).should eql '/users/:id/edit' }
+  end
+
+  describe 'format' do
+    it { subject.format({ format: 'json' }).should == '.json' }
+    it { subject.format({}).should == '' }
+  end
+
+  describe 'after applying formats' do
+    before { subject.apply_format }
+
+    describe 'number_of_replacements' do
+      it { subject.number_of_replacements.should == 1 }
+    end
+
+    describe 'default_replacements' do
+      it { subject.default_replacements.should eql [AssetPipelineRoutes::Path::DEFAULT_REPLACEMENT]}
+    end
+
+    describe 'replacements' do
+      it { subject.replacements().should eql subject.default_replacements }
+      it { subject.replacements(1).should eql [1] }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ ENV["RAILS_ENV"] = "test"
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require 'asset_pipeline_routes/routes_helper'
+require 'asset_pipeline_routes/routes'
+require 'asset_pipeline_routes/path'
 require 'rspec'
 require 'ostruct'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asset_pipeline_routes
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-04 00:00:00.000000000 Z
+date: 2012-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70170979291500 !ruby/object:Gem::Requirement
+  requirement: &70101206508480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 3.2.0
   type: :development
   prerelease: false
-  version_requirements: *70170979291500
+  version_requirements: *70101206508480
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70170979291080 !ruby/object:Gem::Requirement
+  requirement: &70101206507700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170979291080
+  version_requirements: *70101206507700
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70170979290620 !ruby/object:Gem::Requirement
+  requirement: &70101206506900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70170979290620
+  version_requirements: *70101206506900
 description: Add a routes helper for all asset pipeline needs
 email:
 - nicolai86@me.com
@@ -52,11 +52,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/asset_pipeline_routes/js_function_helper.rb
+- lib/asset_pipeline_routes/path.rb
+- lib/asset_pipeline_routes/routes.rb
 - lib/asset_pipeline_routes/routes_context.rb
-- lib/asset_pipeline_routes/routes_helper.rb
 - lib/asset_pipeline_routes/version.rb
 - lib/asset_pipeline_routes.rb
 - spec/asset_pipeline_routes_spec.rb
+- spec/path_spec.rb
 - spec/spec_helper.rb
 - README.md
 - Rakefile
@@ -80,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: asset_pipeline_routes
-rubygems_version: 1.8.15
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Add a routes helper for all asset pipeline needs

data/lib/asset_pipeline_routes/routes_helper.rb

@@ -1,26 +0,0 @@
-require_relative "routes_context"
-require_relative "js_function_helper"
-
-module AssetPipelineRoutes
-  class RoutesHelper
-    def initialize(routes, default_block = '{{\1}}')
-      routes.each do |route|
-        next if route.name.nil? # only handle named_routes
-
-        self.class.instance_eval do
-          define_method :"#{route.name}_path" do |id_replacement = default_block|
-            proc { |route, mapping| build_url route, mapping }.curry[route].call id_replacement
-          end
-
-          define_method :"#{route.name}_path_method" do |style = :js|
-            AssetPipelineRoutes::JsFunctionHelper::route_to_anonymous_function build_url(route, ':\1'), style
-          end
-        end
-      end
-    end
-
-    def build_url route, mapping
-      route.path.ast.to_s.gsub(/\(\.:\w+\)/,'').gsub(/:(\w+)/, mapping).to_s
-    end
-  end
-end