routing-filter 0.2.1 → 0.2.2

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,82 @@
+PATH
+  remote: .
+  specs:
+    routing-filter (0.2.0)
+      actionpack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.3)
+      actionpack (= 3.0.3)
+      mail (~> 2.2.9)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+    activesupport (3.0.3)
+    arel (2.0.6)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    i18n (0.5.0)
+    mail (2.2.12)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.3)
+      actionmailer (= 3.0.3)
+      actionpack (= 3.0.3)
+      activerecord (= 3.0.3)
+      activeresource (= 3.0.3)
+      activesupport (= 3.0.3)
+      bundler (~> 1.0)
+      railties (= 3.0.3)
+    railties (3.0.3)
+      actionpack (= 3.0.3)
+      activesupport (= 3.0.3)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    test_declarative (0.0.4)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  i18n
+  rails
+  routing-filter!
+  test_declarative

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,190 @@
+# Routing Filter
+
+Routing filters wrap 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.
+
+This library comes with four more or less reusable filters and it is easy to
+implement custom ones. Maybe the most popular one is the Locale routing filter:
+
+* `Locale` - prepends the page's :locale (e.g. /de/products)
+* `Pagination` - appends page/:num (e.g. /products/page/2)
+* `Uuid` - prepends a uuid for authentication or other purposes (e.g. /d00fbbd1-82b6-4c1a-a57d-098d529d6854/products/1)
+* `Extension` - appends an extension (e.g. /products.html)
+
+Please note that Rails 3's routing system is much more powerful and flexible
+than Rails 2 was. There are many usecases that now can be covered with just
+Rails 3 default routing features that weren't doable in Rails 2. For an example
+of a quite complex and flexible route see this [gist by Andrew White](http://gist.github.com/653543)
+
+## Requirements
+
+routing-filter currently only works with Rails. It should not be all too hard
+to get it working with plain Rack::Mount but I haven't had that usecase, yet.
+
+## Installation
+
+Just install the Gem:
+
+    $ gem install routing-filter
+
+The Gem should work out of the box for Rails 3 after specifying it in your
+application's Gemfile.
+
+    # Gemfile
+    gem 'routing-filter'
+
+In order to use it with Rails 2.x you could specify it in your environment.rb
+
+    # config/environment.rb
+    gem 'routing-filter'
+
+## Usage
+
+Once the Gem has loaded you can setup the filters in your routes file like this:
+
+    # in config/routes.rb
+    Rails.application.routes.draw do
+      filter :pagination, :uuid
+    end
+
+Filters can also accept options:
+
+    Rails.application.routes.draw do
+      filter :extension, :exclude => %r(^admin/)
+    end
+
+## Filter order
+
+You can picture the way routing-filter wraps filters around your application as a russian puppet pattern. Your application sits in the center and is wrapped by a number of filters. An incoming request's path will be past through these layers of filters from the outside in until it is passed to the regular application routes set. When you generate URLs on the other hand then the filters will be run from the inside out.
+
+Filter order might be confusing at first. The reason for that is that the way rack/mount (which is used by Rails as a core routing engine) is confusing in this respect and Rails tries to make the best of it.
+
+Suppose you have a filter :custom in your application routes.rb file and an engine that adds a :common filter. Then Rails makes it so that your application's routes file will be loaded first (basically route.rb files are loaded in reverse engine load order).
+
+Thus routing-filter will make your :custom filter the *inner-most* filter, wrapping the application *first*. The :common filter from your engine will be wrapped *around* that onion and will be made the *outer-most* filter.
+
+This way common base filters (such as the locale filter) can run first and do not need to know about the specifics of other (more specialized, custom) filters. Custom filters on the other hand can easily take into account that common filters might already have run and adjust accordingly.
+
+
+## Implementing your own filters
+
+For example implementations have a look at the existing filters in
+[lib/routing_filter/filters](http://github.com/svenfuchs/routing-filter/tree/master/lib/routing_filter/filters)
+
+The following would be a sceleton of an empty filter:
+
+    module RoutingFilter
+      class Awesomeness < Filter
+        def around_recognize(path, env, &block)
+          # 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):
+          yield.tap do |params|
+            # You can additionally modify the params here before they get passed
+            # to the controller.
+          end
+        end
+
+        def around_generate(params, &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):
+          yield.tap 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 can specify the filter explicitely in your routes.rb:
+
+    Rails.application.routes.draw do
+      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
+
+### Conditionally prepending the locale
+
+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 as well as url_for 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.
+
+### Expanding /sections/:id to nested tree segments
+
+Another usecase that eventually spawned the implementation 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/lib/routing-filter.rb

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

data/lib/routing_filter.rb

@@ -0,0 +1,27 @@
+require 'action_pack'
+require 'active_support/core_ext/string/inflections'
+
+module RoutingFilter
+  autoload :Filter,     'routing_filter/filter'
+  autoload :Chain,      'routing_filter/chain'
+  autoload :Extension,  'routing_filter/filters/extension'
+  autoload :Locale,     'routing_filter/filters/locale'
+  autoload :Pagination, 'routing_filter/filters/pagination'
+  autoload :Uuid,       'routing_filter/filters/uuid'
+
+  class << self
+    def build(name, options)
+      const_get(name.to_s.camelize).new(options)
+    end
+
+    def active=(active)
+      @@active = active
+    end
+
+    def active?
+      defined?(@@active) ? @@active : @@active = true
+    end
+  end
+end
+
+require "routing_filter/adapters/rails_#{ActionPack::VERSION::MAJOR}"

data/lib/routing_filter/adapters/rails_2.rb

@@ -0,0 +1,69 @@
+require 'action_controller'
+
+# allows to install a filter to the route set by calling: map.filter 'locale'
+ActionController::Routing::RouteSet::Mapper.class_eval do
+  def filter(*args)
+    @set.add_filters(*args)
+  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(:around_generate, *args, &lambda{ result }) " +
+      "} if #{match[2]}"
+    end
+  end
+  alias_method_chain :generate_optimisation_block, :filtering
+end
+
+ActionController::Routing::RouteSet.class_eval do
+  attr_writer :filters
+
+  def filters
+    @filters ||= RoutingFilter::Chain.new
+  end
+
+  def add_filters(*names)
+    options = names.extract_options!
+    names.each { |name| filters.unshift(RoutingFilter.build(name, options)) }
+  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(:around_generate, args.first, &lambda{ generate_without_filtering(*args) })
+  end
+  alias_method_chain :generate, :filtering
+
+  def clear_with_filtering!
+    @filters.clear if @filters
+    clear_without_filtering!
+  end
+  alias_method_chain :clear!, :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/adapters/rails_3.rb

@@ -0,0 +1,71 @@
+require 'action_dispatch'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/hash/reverse_merge'
+
+[ActionDispatch::Routing::Mapper, ActionDispatch::Routing::DeprecatedMapper].each do |mapper|
+  mapper.class_eval do
+    def filter(*args)
+      @set.add_filters(*args)
+    end
+  end
+end
+
+ActionDispatch::Routing::RouteSet.class_eval do
+  def add_filters(*names)
+    options = names.extract_options!
+    names.each { |name| @set.filters.unshift(RoutingFilter.build(name, options)) }
+  end
+
+  # def recognize_path_with_filtering(path, env = {})
+  #   @set.filters.run(:around_recognize, path.dup, env, &lambda{ recognize_path_without_filtering(path.dup, env) })
+  # end
+  # alias_method_chain :recognize_path, :filtering
+
+  def generate_with_filtering(options, recall = {}, extras = false)
+    @set.filters.run(:around_generate, options, &lambda{ generate_without_filtering(options, recall, extras) })
+  end
+  alias_method_chain :generate, :filtering
+
+  def clear_with_filtering!
+    @set.filters.clear if @set
+    clear_without_filtering!
+  end
+  alias_method_chain :clear!, :filtering
+end
+
+require 'rack/mount/route_set'
+require 'rack/mount/code_generation'
+
+Rack::Mount::RouteSet.class_eval do
+  def filters
+    @filters || RoutingFilter::Chain.new.tap { |f| @filters = f unless frozen? }
+  end
+end
+
+# gah. so who's hoped monkeypatching optimized code wouldn't be necessary with rails 3 anymore?
+Rack::Mount::CodeGeneration.class_eval do
+  def optimize_recognize_with_filtering!
+    optimize_recognize_without_filtering!
+    (class << self; self; end).class_eval do
+      alias_method_chain :recognize, :filtering
+    end
+  end
+  alias :optimize_recognize_without_filtering! :optimize_recognize!
+  alias :optimize_recognize! :optimize_recognize_with_filtering!
+
+  # note: if you overly and unnecessarily use blocks in your lowlevel libraries you make it fricking
+  # hard for your users to hook in anywhere
+  def recognize_with_filtering(request, &block)
+    path, route, matches, params = request.env['PATH_INFO'], nil, nil, nil
+    original_path = path.dup
+
+    filters.run(:around_recognize, path, request.env) do
+      route, matches, params = recognize_without_filtering(request)
+      params || {}
+    end
+
+    request.env['PATH_INFO'] = original_path # hmm ...
+    block.call(route, matches, params) if route
+  end
+end
+