lazy_named_routes_helpers 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+rdoc
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in gc_hacks.gemspec
+gemspec

data/LICENCSE

@@ -0,0 +1,23 @@
+The MIT License
+
+Copyright (c) 2009 {XING AG}[http://www.xing.com/]
+Copyright (c) 2009 {Stefan Kaes}[http://railsexpress.de]
+
+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.rdoc

@@ -0,0 +1,27 @@
+= Lazy Routing Helper Generation for Named Routes
+
+A plugin for Rails 3.x which defers generation of routing helpers for named routes, such
+as ..._path and ..._url, to when they're first accessed.
+
+This can reduce the initial footprint of your Rails application, especially for ruby
+1.8.7, and and will speed up starting a rails console.
+
+== Author
+
+Stefan Kaes <skaes@railexpress.de>
+
+
+== Usage
+
+Require the railtie somewhere in application.rb
+
+  require "lazy_named_routes_helpers/railtie"
+
+
+== Installation
+
+  gem install lazy_named_routes_helpers
+
+or let bundler manage it.
+
+

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'lazy_named_routes_helpers'
+  rdoc.options << '--line-numbers' << '--inline-source' << '--quiet'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :rdoc

data/lazy_named_routes_helpers.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lazy_named_routes_helpers/version"
+
+Gem::Specification.new do |s|
+  s.name        = "lazy_named_routes_helpers"
+  s.version     = LazyNamedRoutesHelpers::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Stefan Kaes"]
+  s.email       = ["skaes@railsexpress.de"]
+  s.homepage    = "https://github.com/skaes/lazy_named_routes_helpers"
+  s.summary     = "Generate rails helper methods for accessing named routes on demand"
+  s.description = "Generate rails helper methods for accessing named routes on demand"
+
+  s.rubyforge_project = "lazy_named_routes_helpers"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/lazy_named_routes_helpers/railtie.rb

@@ -0,0 +1,12 @@
+# load monkey patches to rails routing code according to Rails version
+# log a warning if the rails version is not supported
+
+ActiveSupport.on_load(:action_controller) do
+  case Rails.version
+  when /^3\.0/
+    require 'lazy_named_routes_helpers/routing_monkey_patches_rails_3_0'
+  else
+    Rails.logger.warn "Rails version not compatible with lazy routing helper generation"
+  end
+end
+

data/lib/lazy_named_routes_helpers/routing_monkey_patches_rails_3_0.rb

@@ -0,0 +1,133 @@
+# patches for Rails 3.0 to generate named route helpers lazily
+# modified:   actionpack/lib/action_dispatch/routing/route_set.rb
+# modified:   actionpack/lib/action_dispatch/assertions/routing.rb
+# modified:   actionpack/lib/action_view/test_case.rb
+
+require 'action_dispatch/routing/route_set'
+module ActionDispatch
+  module Routing
+    class RouteSet
+      class NamedRouteCollection
+
+        # new method needed for test processing
+        def helper_method?(method_name)
+          return false unless method_name.to_s =~ /^(.+)\_(url|path)$/
+          get($1) != nil
+        end
+
+        def clear!
+          # puts "patched clear! (#{object_id})"
+          @routes = {}
+          @helpers = []
+
+          @module ||= Module.new do
+            instance_methods.each { |selector| remove_method(selector) }
+          end
+
+          # puts "installing method_missing handler for named routes"
+          @module.module_eval <<-'end_code', __FILE__, __LINE__ + 1
+            private
+            def __named_routes__; Rails.application.routes.named_routes; end
+            def method_missing(method_name, *args, &block)
+              begin
+                # puts "missing url helper method #{method_name}"
+                super
+              rescue NameError
+                raise unless method_name.to_s =~ /^(.+)\_(url|path)$/
+                # puts "redefining #{method_name}"
+                name, kind = $1.to_sym, $2.to_sym
+                raise "route not found: #{name}" unless route = __named_routes__[name]
+                opts = {:only_path => (kind == :path)}
+                hash = route.defaults.merge(:use_route => name).merge(opts)
+                __named_routes__.__send__(:define_hash_access, route, name, kind, hash)
+                __named_routes__.__send__(:define_url_helper, route, name, kind, hash)
+                __send__(method_name, *args, &block)
+              end
+            end
+          end_code
+        end #clear!
+        alias clear clear!
+
+        def add(name, route)
+          routes[name.to_sym] = route
+          # define_named_route_methods(name, route)
+        end
+        alias []=   add
+
+        $generated_code = File.open("/tmp/generated_routing_code.rb", "w") if ENV['RAILS_DEBUG_ROUTING_CODE'].to_i==1
+
+        def add_generated_code(code, tag, file, line)
+          if $generated_code
+            # $generated_code.puts "# route: #{@requirements.inspect}"
+            $generated_code.puts code
+            $generated_code.puts
+            $generated_code.flush
+          end
+          # We use module_eval to avoid leaks
+          @module.module_eval code, "generated code/#{tag}/(#{file}:#{line})"
+        end
+
+        def define_hash_access(route, name, kind, options)
+          selector = hash_access_name(name, kind)
+          code = <<-END_EVAL
+          def #{selector}(options = nil)
+            options ? #{options.inspect}.merge(options) : #{options.inspect}
+          end
+          protected :#{selector}
+          END_EVAL
+          add_generated_code code, "hash_access", __FILE__, __LINE__
+          helpers << selector
+        end
+
+        def define_url_helper(route, name, kind, options)
+          selector = url_helper_name(name, kind)
+          hash_access_method = hash_access_name(name, kind)
+          code = <<-END_EVAL
+          def #{selector}(*args)
+            options = #{hash_access_method}(args.extract_options!)
+            if args.any?
+              options[:_positional_args] = args
+              options[:_positional_keys] = #{route.segment_keys.inspect}
+            end
+            url_for(options)
+          end
+          END_EVAL
+          add_generated_code code, "url_helper", __FILE__, __LINE__
+          helpers << selector
+        end
+      end
+    end
+  end
+end
+
+if Rails.env.test?
+
+  require 'action_dispatch/testing/assertions/routing'
+  module ActionDispatch
+    module Assertions
+      module RoutingAssertions
+        # ROUTES TODO: These assertions should really work in an integration context
+        def method_missing(selector, *args, &block)
+          if @controller && @routes && @routes.named_routes.helper_method?(selector)
+            @controller.__send__(selector, *args, &block)
+          else
+            super
+          end
+        end
+      end
+    end
+  end
+
+  require 'action_view/test_case'
+  module ActionView
+    class TestCase
+      def method_missing(selector, *args, &block)
+        if @controller.respond_to?(:_routes) && @controller._routes.named_routes.helper_method?(selector)
+          @controller.__send__(selector, *args, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/lazy_named_routes_helpers/version.rb

@@ -0,0 +1,3 @@
+module LazyNamedRoutesHelpers
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: lazy_named_routes_helpers
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Stefan Kaes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-19 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Generate rails helper methods for accessing named routes on demand
+email: 
+- skaes@railsexpress.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENCSE
+- README.rdoc
+- Rakefile
+- lazy_named_routes_helpers.gemspec
+- lib/lazy_named_routes_helpers/railtie.rb
+- lib/lazy_named_routes_helpers/routing_monkey_patches_rails_3_0.rb
+- lib/lazy_named_routes_helpers/version.rb
+has_rdoc: true
+homepage: https://github.com/skaes/lazy_named_routes_helpers
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: lazy_named_routes_helpers
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Generate rails helper methods for accessing named routes on demand
+test_files: []
+