svenfuchs-routing-filter 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+vendor

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Sven Fuchs
+
+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.markdown

@@ -0,0 +1,123 @@
+## Routing Filter
+
+This plugin is a wild hack that wraps around the complex beast that the Rails
+routing system is to allow for unseen flexibility and power in Rails URL
+recognition and generation.
+
+As powerful and awesome the Rails' routes are, when you need to design your
+URLs in a manner that only slightly leaves the paved cowpaths of Rails
+conventions, you're usually unable to use all the goodness of helpers and
+convenience that Rails ships with.
+
+## Usage
+
+This plugin comes with a locale routing filter that demonstrates the
+implementation of a custom filter. 
+
+The following would be a sceleton of an empty filter:
+
+    module RoutingFilter
+      class Awesomeness < Base
+        def around_recognize(route, path, env)
+          # Alter the path here before it gets recognized. 
+          # Make sure to yield (calls the next around filter if present and 
+          # eventually `recognize_path` on the routeset):
+          returning yield do |params|
+            # You can additionally modify the params here before they get passed
+            # to the controller.
+          end
+        end
+    
+        def around_generate(controller, *args, &block)
+          # Alter arguments here before they are passed to `url_for`. 
+          # Make sure to yield (calls the next around filter if present and 
+          # eventually `url_for` on the controller):
+          returning yield do |result|
+            # You can change the generated url_or_path here. Make sure to use
+            # one of the "in-place" modifying String methods though (like sub! 
+            # and friends).
+          end
+        end
+      end
+    end
+
+You then have to specify the filter explicitely in your routes.rb:
+
+    ActionController::Routing::Routes.draw do |map|
+      map.filter 'awesomeness'
+    end
+
+(I am not sure if it makes sense to provide more technical information than
+this because the usage of this plugin definitely requires some advanced
+knowledge about Rails internals and especially its routing system. So, I
+figure, anyone who could use this should also be able to read the code and
+figure out what it's doing much better then from any lengthy documentation.
+
+If I'm mistaken on this please drop me an email with your suggestions.)
+
+
+## Rationale: Two example usecases
+
+An early usecase from which this originated was the need to define a locale
+at the beginning of an URL in a way so that 
+
+* the locale can be omitted when it is the default locale
+* all the url\_helpers that are generated by named routes continue to work in 
+a concise manner (i.e. without specifying all parameters again and again)
+* ideally also plays nicely with default route helpers in tests/specs
+
+You can read about this struggle and two possible, yet unsatisfying solutions
+[here](http://www.artweb-design.de/2007/5/13/concise-localized-rails-url-helpers-solved-twice).
+The conclusion so far is that Rails itself does not provide the tools to solve
+this problem in a clean and dry way.
+
+Another usecase that eventually spawned the manifestation of this plugin was 
+the need to map an arbitrary count of path segments to a certain model 
+instance. In an application that I've been working on recently I needed to 
+map URL paths to a nested tree of models like so:
+
+    root
+    + docs
+      + api
+      + wiki
+  
+E.g. the docs section should map to the path `/docs`, the api section to 
+the path `/docs/api` and so on. Furthermore, after these paths there need to be 
+more things to be specified. E.g. the wiki needs to define a whole Rails 
+resource with URLs like `/docs/wiki/pages/1/edit`.
+
+The only way to solve this problem with Rails' routing toolkit is to map
+a big, bold `/*everything` catch-all ("globbing") route and process the whole 
+path in a custom dispatcher.
+
+This, of course, is a really unsatisfying solution because one has to
+reimplement everything that Rails routes are here to help with: regarding both 
+URL recognition (like parameter mappings, resources, ...) and generation 
+(url\_helpers).
+
+## Solution
+
+This plugin offers a solution that takes exactly the opposite route. 
+
+Instead of trying to change things *between* the URL recognition and
+generation stages to achieve the desired result it *wraps around* the whole
+routing system and allows to pre- and post-filter both what goes into it 
+(URL recognition) and what comes out of it (URL generation).
+
+This way we can leave *everything* else completely untouched. 
+
+* We can tinker with the URLs that we receive from the server and feed URLs to 
+Rails that perfectly match the best breed of Rails' conventions. 
+* Inside of the application we can use all the nice helper goodness and 
+conveniences that rely on these conventions being followed. 
+* Finally we can accept URLs that have been generated by the url\_helpers and,
+again, mutate them in the way that matches our requirements.
+
+So, even though the plugin itself is a blatant monkey-patch to one of the
+most complex area of Rails internals, this solution seems to be effectively
+less intrusive and pricey than others are.
+
+## Etc
+
+Authors: [Sven Fuchs](http://www.artweb-design.de) <svenfuchs at artweb-design dot de>  
+License: MIT 

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/init.rb

@@ -0,0 +1 @@
+require 'routing_filter'

data/lib/routing_filter.rb

@@ -0,0 +1,94 @@
+module RoutingFilter
+  mattr_accessor :active
+  @@active = true
+
+  class Chain < Array
+    def << (filter)
+      filter.chain = self
+      super
+    end
+
+    def run(method, *args, &final)
+      RoutingFilter.active && !first.nil? ? first.run(method, *args, &final) : final.call
+    end
+
+    def run_reverse(method, *args, &final)
+      RoutingFilter.active && !last.nil? ? last.run_reverse(method, *args, &final) : final.call
+    end
+
+    def predecessor(filter)
+      ix = index(filter)
+      ix > 0 ? self[ix - 1] : nil
+    end
+
+    def successor(filter)
+      ix = index(filter)
+      ix < length - 1 ? self[ix + 1] : nil
+    end
+  end
+end
+
+# allows to install a filter to the route set by calling: map.filter 'locale'
+ActionController::Routing::RouteSet::Mapper.class_eval do
+  def filter(name, options = {})
+    require options.delete(:file) || "routing_filter/#{name}"
+    klass = RoutingFilter.const_get(name.to_s.camelize)
+    @set.filters << klass.new(options)
+  end
+end
+
+# same here for the optimized url generation in named routes
+ActionController::Routing::RouteSet::NamedRouteCollection.class_eval do
+  # gosh. monkey engineering optimization code
+  def generate_optimisation_block_with_filtering(*args)
+    code = generate_optimisation_block_without_filtering(*args)
+    if match = code.match(%r(^return (.*) if (.*)))
+      # returned string must not contain newlines, or we'll spill out of inline code comments in
+      # ActionController::Routing::RouteSet::NamedRouteCollection#define_url_helper
+      "returning(#{match[1]}) { |result|" +
+      "  ActionController::Routing::Routes.filters.run_reverse(:around_generate, *args, &lambda{ result }) " +
+      "} if #{match[2]}"
+    end
+  end
+  alias_method_chain :generate_optimisation_block, :filtering
+end
+
+ActionController::Routing::RouteSet.class_eval do
+  def clear_with_filtering!
+    @filters.clear if @filters
+    clear_without_filtering!
+  end
+  alias_method_chain :clear!, :filtering
+
+  attr_writer :filters
+
+  def filters
+    @filters ||= RoutingFilter::Chain.new
+  end
+
+  def recognize_path_with_filtering(path, env = {})
+    path = ::URI.unescape(path.dup) # string is frozen due to memoize
+    filters.run(:around_recognize, path, env, &lambda{ recognize_path_without_filtering(path, env) })
+  end
+  alias_method_chain :recognize_path, :filtering
+
+  def generate_with_filtering(*args)
+    filters.run_reverse(:around_generate, args.first, &lambda{ generate_without_filtering(*args) })
+  end
+  alias_method_chain :generate, :filtering
+
+  # add some useful information to the request environment
+  # right, this is from jamis buck's excellent article about routes internals
+  # http://weblog.jamisbuck.org/2006/10/26/monkey-patching-rails-extending-routes-2
+  # TODO move this ... where?
+  alias_method :extract_request_environment_without_host, :extract_request_environment unless method_defined? :extract_request_environment_without_host
+  def extract_request_environment(request)
+    returning extract_request_environment_without_host(request) do |env|
+      env.merge! :host => request.host,
+                 :port => request.port,
+                 :host_with_port => request.host_with_port,
+                 :domain => request.domain,
+                 :subdomain => request.subdomains.first
+    end
+  end
+end

data/lib/routing_filter/base.rb

@@ -0,0 +1,31 @@
+module RoutingFilter
+  class Base
+    class_inheritable_accessor :active
+    self.active = true
+
+    attr_accessor :chain, :options
+
+    def initialize(options = {})
+      @options = options
+      options.each { |name, value| instance_variable_set :"@#{name}", value }
+    end
+
+    def run(method, *args, &block)
+      _next = successor ? lambda { successor.run(method, *args, &block) } : block
+      active ? send(method, *args, &_next) : _next.call(*args)
+    end
+
+    def run_reverse(method, *args, &block)
+      _prev = predecessor ? lambda { predecessor.run(method, *args, &block) } : block
+      active ? send(method, *args, &_prev) : _prev.call(*args)
+    end
+
+    def predecessor
+      @chain.predecessor(self)
+    end
+
+    def successor
+      @chain.successor(self)
+    end
+  end
+end

data/lib/routing_filter/force_extension.rb

@@ -0,0 +1,57 @@
+require 'routing_filter/base'
+
+module RoutingFilter
+  class ForceExtension < Base
+    attr_reader :extension, :exclude
+
+    def initialize(*args)
+      super
+      @extension ||= 'html'
+      @exclude = %r(^(http.?://[^/]+)?\/?$) if @exclude.nil?
+    end
+
+    def around_recognize(path, env, &block)
+      extract_extension!(path) unless excluded?(path)
+      yield(path, env)
+    end
+
+    def around_generate(*args, &block)
+      returning yield do |result|
+        url = result.is_a?(Array) ? result.first : result
+        append_extension!(url) if append_extension?(url)
+      end
+    end
+
+    protected
+
+      def extract_extension!(path)
+        path.sub! /\.#{extension}$/, ''
+        $1
+      end
+      
+      def append_extension?(url)
+        !(url.blank? || excluded?(url) || mime_extension?(url))
+      end
+      
+      def excluded?(url)
+        case exclude
+        when Regexp
+          url =~ exclude
+        when Proc
+          exclude.call(url)
+        end
+      end
+      
+      def mime_extension?(url)
+        url =~ /\.#{Mime::EXTENSION_LOOKUP.keys.join('|')}(\?|$)/
+      end
+      
+      def append_extension!(url)
+        url.replace url.sub(/(\?|$)/, ".#{extension}\\1")
+      end
+
+      def append_page!(url, page)
+        url.replace "#{url}/pages/#{page}"
+      end
+  end
+end

data/lib/routing_filter/locale.rb

@@ -0,0 +1,70 @@
+require 'i18n'
+require 'routing_filter/base'
+
+module RoutingFilter
+  class Locale < Base
+    @@include_default_locale = true
+    cattr_writer :include_default_locale
+
+    class << self
+      def include_default_locale?
+        @@include_default_locale
+      end
+
+      def locales
+        @@locales ||= I18n.available_locales.map(&:to_sym)
+      end
+
+      def locales=(locales)
+        @@locales = locales.map(&:to_sym)
+      end
+
+      def locales_pattern
+        @@locales_pattern ||= %r(^/(#{self.locales.map { |l| Regexp.escape(l.to_s) }.join('|')})(?=/|$))
+      end
+    end
+
+    def around_recognize(path, env, &block)
+      locale = extract_locale!(path)                 # remove the locale from the beginning of the path
+      returning yield do |params|                    # invoke the given block (calls more filters and finally routing)
+        params[:locale] = locale if locale           # set recognized locale to the resulting params hash
+      end
+    end
+
+    def around_generate(*args, &block)
+      locale = args.extract_options!.delete(:locale) # extract the passed :locale option
+      locale = I18n.locale if locale.nil?            # default to I18n.locale when locale is nil (could also be false)
+      locale = nil unless valid_locale?(locale)      # reset to no locale when locale is not valid
+
+      returning yield do |result|
+        if locale && prepend_locale?(locale)
+          url = result.is_a?(Array) ? result.first : result
+          prepend_locale!(url, locale)
+        end
+      end
+    end
+
+    protected
+
+      def extract_locale!(path)
+        path.sub! self.class.locales_pattern, ''
+        $1
+      end
+
+      def prepend_locale?(locale)
+        self.class.include_default_locale? || !default_locale?(locale)
+      end
+
+      def valid_locale?(locale)
+        locale && self.class.locales.include?(locale.to_sym)
+      end
+
+      def default_locale?(locale)
+        locale && locale.to_sym == I18n.default_locale.to_sym
+      end
+
+      def prepend_locale!(url, locale)
+        url.sub!(%r(^(http.?://[^/]*)?(.*))) { "#{$1}/#{locale}#{$2}" }
+      end
+  end
+end

data/lib/routing_filter/pagination.rb

@@ -0,0 +1,33 @@
+require 'routing_filter/base'
+
+module RoutingFilter
+  class Pagination < Base
+    def around_recognize(path, env, &block)
+      page = extract_page!(path)
+      returning yield(path, env) do |params|
+        params[:page] = page.to_i if page
+      end
+    end
+
+    def around_generate(*args, &block)
+      page = args.extract_options!.delete(:page)
+      returning yield do |result|
+        if page && page != 1
+          url = result.is_a?(Array) ? result.first : result
+          append_page!(url, page)
+        end
+      end
+    end
+
+    protected
+
+      def extract_page!(path)
+        path.sub! %r(/pages/([\d]+)/?$), ''
+        $1
+      end
+
+      def append_page!(url, page)
+        url.sub!(/($|\?)/) { "/pages/#{page}#{$1}" }
+      end
+  end
+end

data/spec/force_extension_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'RoutingFilter::ForceExtension' do
+  include RoutingFilterHelpers
+
+  before :each do
+    setup_environment(:force_extension)
+  end
+
+  describe 'url recognition' do
+    it 'recognizes the path /sections/1.html' do
+      should_recognize_path '/sections/1.html', @section_params
+    end
+
+    it 'recognizes the path /sections/1/articles/1.html' do
+      should_recognize_path '/sections/1/articles/1.html', @article_params
+    end
+
+    it 'does not recognize the path /sections/1/articles/1.foobar' do
+      lambda { @set.recognize_path('/sections/1/articles/1.foobar', {}) }.should raise_error(ActionController::RoutingError)
+    end
+  end
+
+  describe 'url generation' do
+    it 'appends the .html extension to generated paths (section_path)' do
+      section_path(:id => 1).should == '/sections/1.html'
+    end
+
+    it 'appends the .html extension to generated paths (section_article_path)' do
+      section_article_path(:section_id => 1, :id => 1).should == '/sections/1/articles/1.html'
+    end
+
+    it 'appends the .html extension to generated paths (admin_articles_path)' do
+      admin_articles_path.should == '/admin/articles.html'
+    end
+
+    it 'does not replace or add on an existing extension' do
+      section_path(:id => 1, :format => 'xml').should == '/sections/1.xml'
+    end
+
+    it 'works with url query params' do
+      section_path(:id => 1, :foo => 'bar').should == '/sections/1.html?foo=bar'
+    end
+    
+    it 'excludes / by default' do
+      home_path.should == '/'
+    end
+    
+    it 'excludes http://test.host/ by default' do
+      home_url.should == 'http://test.host/'
+    end
+    
+    it 'excludes with custom regexp' do
+      setup_environment { |map| map.filter :force_extension, :exclude => %r(^/(admin|$)) }
+      home_path.should == '/'
+      admin_articles_path.should == '/admin/articles'
+      section_path(:id => 1).should == '/sections/1.html'
+    end
+
+    it 'does not exclude / when :exclude => false was passed' do
+      setup_environment { |map| map.filter :force_extension, :exclude => false }
+      home_path.should == '/.html'
+    end
+  end
+end

data/spec/generation_spec.rb

@@ -0,0 +1,367 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'RoutingFilter', 'url generation' do
+  include RoutingFilterHelpers
+
+  before :each do
+    setup_environment :locale, :pagination
+
+    @site = Site.new
+    @section = Section.new
+    @article = Article.new
+  end
+
+  describe "named route url_helpers" do
+    describe "a not nested resource" do
+      it 'does not change the section_path when given page option equals 1' do
+        section_path(:id => 1, :page => 1).should == '/en/sections/1'
+      end
+
+      it 'appends the pages segments to section_path when given page option does not equal 1' do
+        section_path(:id => 1, :page => 2).should == '/en/sections/1/pages/2'
+      end
+
+      it 'prepends the current locale to section_path' do
+        I18n.locale = :de
+        section_path(:id => 1).should == '/de/sections/1'
+      end
+
+      it 'prepends a given locale param to section_path' do
+        I18n.locale = :de
+        section_path(:id => 1, :locale => :fi).should == '/fi/sections/1'
+      end
+
+      it 'does not prepend a locale to section_path if given locale is false' do
+        section_path(:id => 1, :locale => false).should == '/sections/1'
+      end
+
+      it 'works on section_path with both a locale and page option' do
+        section_path(:id => 1, :locale => :fi, :page => 2).should == '/fi/sections/1/pages/2'
+      end
+
+      it 'should not prepend an invalid locale to section_path' do
+        section_path(:id => 1, :locale => :aa).should == '/sections/1'
+      end
+
+      it 'should prepend a longer locale to section_path' do
+        section_path(:id => 1, :locale => 'en-US').should == '/en-US/sections/1'
+      end
+
+      it 'should not prepend the default locale when configured not to' do
+        RoutingFilter::Locale.include_default_locale = false
+        section_path(:id => 1, :locale => :en).should == '/sections/1'
+      end
+    end
+
+    describe "a nested resource" do
+      it 'does not change the section_article_path when given page option equals 1' do
+        section_article_path(:section_id => 1, :id => 1, :page => 1).should == '/en/sections/1/articles/1'
+      end
+
+      it 'appends the pages segments to section_article_path when given page option does not equal 1' do
+        section_article_path(:section_id => 1, :id => 1, :page => 2).should == '/en/sections/1/articles/1/pages/2'
+      end
+
+      it 'prepends the current locale to section_article_path' do
+        I18n.locale = :de
+        section_article_path(:section_id => 1, :id => 1).should == '/de/sections/1/articles/1'
+      end
+
+      it 'prepends a given locale param to section_article_path' do
+        I18n.locale = :de
+        section_article_path(:section_id => 1, :id => 1, :locale => :fi).should == '/fi/sections/1/articles/1'
+      end
+
+      it 'does not prepend a locale to section_article_path if given locale is false' do
+        section_article_path(:section_id => 1, :id => 1, :locale => false).should == '/sections/1/articles/1'
+      end
+
+      it 'works on section_article_path with both a locale and page option' do
+        section_article_path(:section_id => 1, :id => 1, :locale => :fi, :page => 2).should == '/fi/sections/1/articles/1/pages/2'
+      end
+
+      it 'should not prepend an invalid locale to section_article_path' do
+        section_article_path(:section_id => 1, :id => 1, :locale => :aa).should == '/sections/1/articles/1'
+      end
+
+      it 'should prepend a longer locale to section_article_path' do
+        section_article_path(:section_id => 1, :id => 1, :locale => 'en-US').should == '/en-US/sections/1/articles/1'
+      end
+
+      it 'should not prepend the default locale when configured not to' do
+        RoutingFilter::Locale.include_default_locale = false
+        section_article_path(:section_id => 1, :id => 1, :locale => :en).should == '/sections/1/articles/1'
+      end
+    end
+  end
+
+  describe 'when used with named route url_helper with "optimized" generation blocks' do
+    describe "a not nested resource" do
+      it 'does not change the section_path when given page option equals 1' do
+        section_path(1, :page => 1).should == '/en/sections/1'
+      end
+
+      it 'appends the pages segments to section_path when given page option does not equal 1' do
+        section_path(1, :page => 2).should == '/en/sections/1/pages/2'
+      end
+
+      it 'prepends the current locale to section_path' do
+        I18n.locale = :de
+        section_path(1).should == '/de/sections/1'
+      end
+
+      it 'prepends a given locale param to section_path' do
+        I18n.locale = :de
+        section_path(1, :locale => :fi).should == '/fi/sections/1'
+      end
+
+      it 'does not prepend a locale to section_path if given locale is false' do
+        section_path(1, :locale => false).should == '/sections/1'
+      end
+
+      it 'works for section_path with both a locale and page option' do
+        section_path(1, :locale => :fi, :page => 2).should == '/fi/sections/1/pages/2'
+      end
+
+      it 'should not prepend an invalid locale to section_path' do
+        section_path(1, :locale => :aa).should == '/sections/1'
+      end
+
+      it 'should prepend a longer locale to section_path' do
+        section_path(1, :locale => 'en-US').should == '/en-US/sections/1'
+      end
+
+      it 'should not prepend the default locale when configured not to' do
+        RoutingFilter::Locale.include_default_locale = false
+        section_path(1, :locale => :en).should == '/sections/1'
+      end
+    end
+
+    describe "a nested resource" do
+      it 'does not change the section_article_path when given page option equals 1' do
+        section_article_path(1, 1, :page => 1).should == '/en/sections/1/articles/1'
+      end
+
+      it 'appends the pages segments to section_article_path when given page option does not equal 1' do
+        section_article_path(1, 1, :page => 2).should == '/en/sections/1/articles/1/pages/2'
+      end
+
+      it 'prepends the current locale to section_article_path' do
+        I18n.locale = :de
+        section_article_path(1, 1).should == '/de/sections/1/articles/1'
+      end
+
+      it 'prepends a given locale param to section_article_path' do
+        I18n.locale = :de
+        section_article_path(1, 1, :locale => :fi).should == '/fi/sections/1/articles/1'
+      end
+
+      it 'does not prepend a locale to section_article_path if given locale is false' do
+        section_article_path(1, 1, :locale => false).should == '/sections/1/articles/1'
+      end
+
+      it 'works for section_article_path with both a locale and page option' do
+        section_article_path(1, 1, :locale => :fi, :page => 2).should == '/fi/sections/1/articles/1/pages/2'
+      end
+
+      it 'should not prepend an invalid locale to section_article_path' do
+        section_article_path(1, 1, :locale => :aa).should == '/sections/1/articles/1'
+      end
+
+      it 'should prepend a longer locale to section_article_path' do
+        section_article_path(1, 1, :locale => 'en-US').should == '/en-US/sections/1/articles/1'
+      end
+
+      it 'should not prepend the default locale when configured not to' do
+        RoutingFilter::Locale.include_default_locale = false
+        section_article_path(1, 1, :locale => :en).should == '/sections/1/articles/1'
+      end
+    end
+  end
+
+  describe 'when used with a polymorphic_path' do
+    describe "a not nested resource" do
+      it 'does not change the section_path when given page option equals 1' do
+        section_path(@section, :page => 1).should == '/en/sections/1'
+      end
+
+      it 'appends the pages segments to section_path when given page option does not equal 1' do
+        section_path(@section, :page => 2).should == '/en/sections/1/pages/2'
+      end
+
+      it 'prepends the current locale to section_path' do
+        I18n.locale = :de
+        section_path(@section).should == '/de/sections/1'
+      end
+
+      it 'prepends a given locale param to section_path' do
+        I18n.locale = :de
+        section_path(@section, :locale => :fi).should == '/fi/sections/1'
+      end
+
+      it 'does not prepend a locale to section_path if given locale is false' do
+        section_path(@section, :locale => false).should == '/sections/1'
+      end
+
+      it 'works for section_path with both a locale and page option' do
+        section_path(@section, :locale => :fi, :page => 2).should == '/fi/sections/1/pages/2'
+      end
+
+      it 'should not prepend an invalid locale to section_path' do
+        section_path(@section, :locale => :aa).should == '/sections/1'
+      end
+
+      it 'should prepend a longer locale to section_path' do
+        section_path(@section, :locale => 'en-US').should == '/en-US/sections/1'
+      end
+
+      it 'should not prepend the default locale when configured not to' do
+        RoutingFilter::Locale.include_default_locale = false
+        section_path(@section, :locale => :en).should == '/sections/1'
+      end
+    end
+
+    describe "a nested resource" do
+      it 'does not change the section_article_path when given page option equals 1' do
+        section_article_path(@section, @article, :page => 1).should == '/en/sections/1/articles/1'
+      end
+
+      it 'appends the pages segments to section_article_path when given page option does not equal 1' do
+        section_article_path(@section, @article, :page => 2).should == '/en/sections/1/articles/1/pages/2'
+      end
+
+      it 'prepends the current locale to section_article_path' do
+        I18n.locale = :de
+        section_article_path(@section, @article).should == '/de/sections/1/articles/1'
+      end
+
+      it 'prepends a given locale param to section_article_path' do
+        I18n.locale = :de
+        section_article_path(@section, @article, :locale => :fi).should == '/fi/sections/1/articles/1'
+      end
+
+      it 'does not prepend a locale to section_article_path if given locale is false' do
+        section_article_path(@section, @article, :locale => false).should == '/sections/1/articles/1'
+      end
+
+      it 'works for section_article_path with both a locale and page option' do
+        section_article_path(@section, @article, :locale => :fi, :page => 2).should == '/fi/sections/1/articles/1/pages/2'
+      end
+
+      it 'should not prepend an invalid locale to section_article_path' do
+        section_article_path(@section, @article, :locale => :aa).should == '/sections/1/articles/1'
+      end
+
+      it 'should prepend a longer locale to section_article_path' do
+        section_article_path(@section, @article, :locale => 'en-US').should == '/en-US/sections/1/articles/1'
+      end
+
+      it 'should not prepend the default locale when configured not to' do
+        RoutingFilter::Locale.include_default_locale = false
+        section_article_path(@section, @article, :locale => :en).should == '/sections/1/articles/1'
+      end
+    end
+  end
+
+  describe 'when used with url_for and an ActivRecord instance' do
+    describe "a not nested resource" do
+      it 'does not change the url_for result when given page option equals 1' do
+        params = @section_params.update :id => @section, :page => 1
+        url_for(params).should == 'http://test.host/en/sections/1'
+      end
+
+      it 'appends the pages segments to url_for result when given page option does not equal 1' do
+        params = @section_params.update :id => @section, :page => 2
+        url_for(params).should == 'http://test.host/en/sections/1/pages/2'
+      end
+
+      it 'prepends the current locale to url_for result' do
+        I18n.locale = :de
+        params = @section_params.update :id => @section
+        url_for(params).should == 'http://test.host/de/sections/1'
+      end
+
+      it 'prepends a given locale param url_for result' do
+        I18n.locale = :de
+        params = @section_params.update :id => @section, :locale => :fi
+        url_for(params).should == 'http://test.host/fi/sections/1'
+      end
+
+      it 'does not prepend a locale to url_for result if given locale is false' do
+        params = @section_params.update :id => @section, :locale => false
+        url_for(params).should == 'http://test.host/sections/1'
+      end
+
+      it 'works for url_for result with both a locale and page option' do
+        params = @section_params.update :id => @section, :locale => :fi, :page => 2
+        url_for(params).should == 'http://test.host/fi/sections/1/pages/2'
+      end
+
+      it 'should not prepend an invalid locale to section_path' do
+        params = @section_params.update :id => @section, :locale => :aa
+        url_for(params).should == 'http://test.host/sections/1'
+      end
+
+      it 'should prepend a longer locale to section_path' do
+        params = @section_params.update :id => @section, :locale => 'en-US'
+        url_for(params).should == 'http://test.host/en-US/sections/1'
+      end
+
+      it 'should not prepend the default locale when configured not to' do
+        RoutingFilter::Locale.include_default_locale = false
+        params = @section_params.update :id => @section, :locale => :en
+        url_for(params).should == 'http://test.host/sections/1'
+      end
+    end
+
+    describe "a nested resource" do
+      it 'does not change the url_for result when given page option equals 1' do
+        params = @article_params.update :section_id => @section, :id => @article, :page => 1
+        url_for(params).should == 'http://test.host/en/sections/1/articles/1'
+      end
+
+      it 'appends the pages segments to url_for result when given page option does not equal 1' do
+        params = @article_params.update :section_id => @section, :id => @article, :page => 2
+        url_for(params).should == 'http://test.host/en/sections/1/articles/1/pages/2'
+      end
+
+      it 'prepends the current locale to url_for result' do
+        I18n.locale = :de
+        params = @article_params.update :section_id => @section, :id => @article
+        url_for(params).should == 'http://test.host/de/sections/1/articles/1'
+      end
+
+      it 'prepends a given locale param to url_for result' do
+        I18n.locale = :de
+        params = @article_params.update :section_id => @section, :id => @article, :locale => :fi
+        url_for(params).should == 'http://test.host/fi/sections/1/articles/1'
+      end
+
+      it 'does not prepend a locale to url_for result if given locale is false' do
+        params = @article_params.update :section_id => @section, :id => @article, :locale => false
+        url_for(params).should == 'http://test.host/sections/1/articles/1'
+      end
+
+      it 'works for url_for result with both a locale and page option' do
+        params = @article_params.update :section_id => @section, :id => @article, :locale => :fi, :page => 2
+        url_for(params).should == 'http://test.host/fi/sections/1/articles/1/pages/2'
+      end
+
+      it 'should not prepend an invalid locale to url_for result' do
+        params = @article_params.update :section_id => @section, :id => @article, :locale => :aa
+        url_for(params).should == 'http://test.host/sections/1/articles/1'
+      end
+
+      it 'should prepend a longer locale to section_article_path' do
+        params = @article_params.update :section_id => @section, :id => @article, :locale => 'en-US'
+        url_for(params).should == 'http://test.host/en-US/sections/1/articles/1'
+      end
+
+      it 'should not prepend the default locale when configured not to' do
+        RoutingFilter::Locale.include_default_locale = false
+        params = @article_params.update :section_id => @section, :id => @article, :locale => :en
+        url_for(params).should == 'http://test.host/sections/1/articles/1'
+      end
+    end
+  end
+end

data/spec/pagination_extension_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'RoutingFilter::Pagination' do
+  include RoutingFilterHelpers
+
+  before :each do
+    setup_environment(:pagination)
+  end
+
+  describe 'url generation' do
+    it 'appends the segments /pages/:page to the generated path' do
+      section_path(1, :page => 2).should == '/sections/1/pages/2'
+    end
+
+    it 'appends the segments /pages/:page to the generated path excluding http get params' do
+      section_path(1, :page => 2, :foo => 'bar').should == '/sections/1/pages/2?foo=bar'
+    end
+  end
+end

data/spec/recognition_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'RoutingFilter', 'url recognition' do
+  include RoutingFilterHelpers
+
+  before :each do
+    setup_environment :locale, :pagination
+  end
+
+  it 'recognizes the path /de/sections/1 and sets the :locale param' do
+    should_recognize_path '/de/sections/1', @section_params.update(:locale => 'de')
+  end
+
+  it 'recognizes the path /sections/1/pages/1 and sets the :page param' do
+    should_recognize_path '/sections/1/pages/1', @section_params.update(:page => 1)
+  end
+
+  it 'recognizes the path /de/sections/1/pages/1 and sets the :locale param' do
+    should_recognize_path '/de/sections/1/pages/1', @section_params.update(:locale => 'de', :page => 1)
+  end
+
+  it 'recognizes the path /sections/1/articles/1 and sets the :locale param' do
+    should_recognize_path '/sections/1/articles/1', @article_params
+  end
+
+  it 'recognizes the path /de/sections/1/articles/1 and sets the :locale param' do
+    should_recognize_path '/de/sections/1/articles/1', @article_params.update(:locale => 'de')
+  end
+
+  it 'recognizes the path /de/sections/1/articles/1/pages/1 and sets the :locale param' do
+    should_recognize_path '/de/sections/1/articles/1/pages/1', @article_params.update(:locale => 'de', :page => 1)
+  end
+
+  it 'recognizes the path /sections/1 and does not set a :locale param' do
+    should_recognize_path '/sections/1', @section_params
+  end
+
+  it 'recognizes the path /sections/1 and does not set a :page param' do
+    should_recognize_path '/sections/1', @section_params
+  end
+
+  # Test that routing errors are thrown for invalid locales
+  it 'does not recognizes the path /aa/sections/1 and does not set a :locale param' do
+    begin
+      should_recognize_path '/aa/sections/1', @section_params.update(:locale => 'aa')
+      false
+    rescue ActionController::RoutingError
+      true
+    end
+  end
+
+  it 'recognizes the path /en-US/sections/1 and sets a :locale param' do
+    should_recognize_path '/en-US/sections/1', @section_params.update(:locale => 'en-US')
+  end
+
+  it 'recognizes the path /sections/1/articles/1 and does not set a :locale param' do
+    should_recognize_path '/sections/1/articles/1', @article_params
+  end
+
+  it 'recognizes the path /sections/1/articles/1 and does not set a :page param' do
+    should_recognize_path '/sections/1/articles/1', @article_params
+  end
+
+  it 'invalid locale: does not recognize the path /aa/sections/1/articles/1 and does not set a :locale param' do
+    lambda { @set.recognize_path('/aa/sections/1/articles/1', {}) }.should raise_error(ActionController::RoutingError)
+  end
+
+  it 'recognizes the path /en-US/sections/1/articles/1 and sets a :locale param' do
+    should_recognize_path '/en-US/sections/1/articles/1', @article_params.update(:locale => 'en-US')
+  end
+
+  it 'unescapes the path for the filters' do
+    @set.should_receive(:recognize_path_without_filtering).with('/sections/motörhead', 'test')
+    @set.recognize_path('/sections/mot%C3%B6rhead', 'test')
+  end
+end

data/spec/routing_filter_spec.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'RoutingFilter' do
+  include RoutingFilterHelpers
+
+  before :each do
+    setup_environment :locale, :pagination
+  end
+
+  def recognize_path(path = '/de/sections/1', options = {})
+    @set.recognize_path(path, options)
+  end
+
+  it 'installs filters to the route set' do
+    @locale_filter.should be_instance_of(RoutingFilter::Locale)
+    @pagination_filter.should be_instance_of(RoutingFilter::Pagination)
+  end
+
+  it 'calls the first filter for route recognition' do
+    @locale_filter.should_receive(:around_recognize).and_return :foo => :bar
+    recognize_path.should == { :foo => :bar }
+  end
+
+  it 'calls the second filter for route recognition' do
+    @pagination_filter.should_receive(:around_recognize).and_return :foo => :bar
+    recognize_path.should == { :foo => :bar, :locale => 'de' }
+  end
+
+  it 'calls the first filter for url generation' do
+    @locale_filter.should_receive(:around_generate).and_return '/en/sections/1?page=2'
+    url_for(:controller => 'sections', :action => 'show', :section_id => 1)
+  end
+
+  it 'calls the second filter for url generation' do
+    @pagination_filter.should_receive(:around_generate).and_return '/sections/1?page=2'
+    url_for(:controller => 'sections', :action => 'show', :section_id => 1)
+  end
+
+  it 'calls the first filter for named route url_helper' do
+    @locale_filter.should_receive(:around_generate).and_return '/en/sections/1'
+    section_path(:section_id => 1)
+  end
+
+  it 'calls the filter for named route url_helper with "optimized" generation blocks' do
+    # at_least(1) since the inline code comments in ActionController::Routing::RouteSet::NamedRouteCollection#define_url_helper also call us (as of http://github.com/rails/rails/commit/a2270ef2594b97891994848138614657363f2806)
+    @locale_filter.should_receive(:around_generate).at_least(1).and_return '/en/sections/1'
+    section_path(1)
+  end
+
+  it 'calls the filter for named route polymorphic_path' do
+    # at_least(1) since the inline code comments in ActionController::Routing::RouteSet::NamedRouteCollection#define_url_helper also call us (as of http://github.com/rails/rails/commit/a2270ef2594b97891994848138614657363f2806)
+    @locale_filter.should_receive(:around_generate).at_least(1).and_return '/en/sections/1'
+    section_path(Section.new)
+  end
+
+  # When filters are set up in the order:
+  #
+  #   map.filter :locale
+  #   map.filter :pagination
+  #
+  # Then #around_recognize should be first called on the locale filter and then
+  # on the pagination filter. Whereas #around_generate should be first called
+  # on the pagination filter and then on the locale filter. Right?
+
+  it 'calls #around_recognize in the expected order' do
+    params = { :id => "1", :page => 2, :controller => "sections", :action => "show" }
+    @pagination_filter.stub!(:around_recognize).and_return({ :page => 2, :controller => "sections", :action => "show" })
+
+    recognize_path('/de/sections/1/pages/2')[:locale].should == "de"
+    recognize_path('/de/sections/1/pages/2')[:page].should == 2
+  end
+
+  it 'calls #around_generate in the expected order' do
+    @locale_filter.stub!(:around_generate).and_return('de/sections/1')
+    section_path(1, :page => 2).should == "de/sections/1/pages/2"
+  end
+
+  it 'does not call deactivated filters' do
+    with_deactivated_filters(RoutingFilter::Locale) do
+      @locale_filter.should_not_receive(:around_generate)
+      section_path(Section.new)
+    end
+  end
+
+  it 'still calls successors of deactivated filters' do
+    with_deactivated_filters(RoutingFilter::Locale) do
+      @pagination_filter.should_receive(:around_recognize).and_return :foo => :bar
+      recognize_path('/sections/1').should == { :foo => :bar }
+    end
+  end
+
+  # chain
+
+  it 'adds filters in the order they are registered' do
+    @set.filters[0].should == @locale_filter
+    @set.filters[1].should == @pagination_filter
+  end
+
+  it 'returns the previous filter as a predecessor of a filter' do
+    @set.filters.predecessor(@pagination_filter).should == @locale_filter
+  end
+
+  it 'returns the nil as a predecessor of the first filter' do
+    @set.filters.successor(@pagination_filter).should be_nil
+  end
+
+  it 'returns the next filter as a successor of a filter' do
+    @set.filters.successor(@locale_filter).should == @pagination_filter
+  end
+
+  it 'returns the nil as a successor of the last filter' do
+    @set.filters.successor(@pagination_filter).should be_nil
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,108 @@
+$: << File.dirname(__FILE__)
+$: << File.dirname(__FILE__) + '/../lib/'
+
+require 'rubygems'
+require 'actionpack'
+require 'activesupport'
+require 'action_controller'
+require 'action_controller/test_process'
+require 'active_support/vendor'
+require 'spec'
+
+require 'routing_filter'
+require 'routing_filter/locale'
+require 'routing_filter/pagination'
+
+class Site
+end
+
+class Section
+  def id; 1 end
+  alias :to_param :id
+  def type; 'Section' end
+  def path; 'section' end
+end
+
+class Article
+  def to_param; 1 end
+end
+
+module RoutingFilterHelpers
+  def draw_routes(&block)
+    set = returning ActionController::Routing::RouteSet.new do |set|
+      class << set; def clear!; end; end
+      set.draw &block
+      silence_warnings{ ActionController::Routing.const_set 'Routes', set }
+    end
+    set
+  end
+
+  def instantiate_controller(params)
+    returning ActionController::Base.new do |controller|
+      request = ActionController::TestRequest.new
+      url = ActionController::UrlRewriter.new(request, params)
+      controller.stub!(:request).and_return request
+      controller.instance_variable_set :@url, url
+      controller
+    end
+  end
+
+  def should_recognize_path(path, params)
+    @set.recognize_path(path, {}).should == params
+  end
+
+  def home_path(*args)
+    @controller.send :home_path, *args
+  end
+
+  def home_url(*args)
+    @controller.send :home_url, *args
+  end
+
+  def section_path(*args)
+    @controller.send :section_path, *args
+  end
+
+  def section_article_path(*args)
+    @controller.send :section_article_path, *args
+  end
+
+  def admin_articles_path(*args)
+    @controller.send :admin_articles_path, *args
+  end
+
+  def url_for(*args)
+    @controller.send :url_for, *args
+  end
+
+  def setup_environment(*filters)
+    RoutingFilter::Locale.locales = [:en, 'en-US', :de, :fi, 'en-UK']
+    RoutingFilter::Locale.include_default_locale = true
+    I18n.default_locale = :en
+    I18n.locale = :en
+
+    @controller = instantiate_controller :locale => 'de', :id => 1
+    @set = draw_routes do |map|
+      yield map if block_given?
+      filters.each { |filter| map.filter filter }
+      map.section 'sections/:id.:format', :controller => 'sections', :action => "show"
+      map.section_article 'sections/:section_id/articles/:id', :controller => 'articles', :action => "show"
+      map.admin_articles 'admin/articles/:id', :controller => 'admin/articles', :action => "index"
+      map.home '/', :controller => 'home', :action => 'index'
+    end
+
+    @section_params = {:controller => 'sections', :action => "show", :id => "1"}
+    @article_params = {:controller => 'articles', :action => "show", :section_id => "1", :id => "1"}
+    @locale_filter = @set.filters.first
+    @pagination_filter = @set.filters.last
+  end
+  
+  def with_deactivated_filters(*filters, &block)
+    states = filters.inject({}) do |states, filter| 
+      states[filter], filter.active = filter.active, false
+      states
+    end
+    yield
+    states.each { |filter, state| filter.active = state }
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: svenfuchs-routing-filter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sven Fuchs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: routing-filter wraps around the complex beast that the Rails routing system is, allowing for unseen flexibility and power in Rails URL recognition and generation.
+email: svenfuchs@artweb-design.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- VERSION
+- init.rb
+- lib/routing_filter.rb
+- lib/routing_filter/base.rb
+- lib/routing_filter/force_extension.rb
+- lib/routing_filter/locale.rb
+- lib/routing_filter/pagination.rb
+- spec/force_extension_spec.rb
+- spec/generation_spec.rb
+- spec/pagination_extension_spec.rb
+- spec/recognition_spec.rb
+- spec/routing_filter_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/svenfuchs/routing-filter
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: routing-filter wraps around the complex beast that the Rails routing system is, allowing for unseen flexibility and power in Rails URL recognition and generation.
+test_files: 
+- spec/force_extension_spec.rb
+- spec/generation_spec.rb
+- spec/pagination_extension_spec.rb
+- spec/recognition_spec.rb
+- spec/routing_filter_spec.rb
+- spec/spec_helper.rb