routing-filter 0.0.1 → 0.1.0

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: routing-filter
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Sven Fuchs
@@ -9,68 +15,89 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-26 09:00:00 +02:00
+date: 2010-07-24 00:00:00 +02: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.
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test_declarative
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Routing filters 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
+extra_rdoc_files: []
+
 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
+- lib/routing_filter/adapters/rails_2.rb
+- lib/routing_filter/adapters/rails_3.rb
+- lib/routing_filter/chain.rb
+- lib/routing_filter/filter.rb
+- lib/routing_filter/filters/extension.rb
+- lib/routing_filter/filters/locale.rb
+- lib/routing_filter/filters/pagination.rb
+- lib/routing_filter/filters/uuid.rb
+- lib/routing_filter/version.rb
+has_rdoc: true
 homepage: http://github.com/svenfuchs/routing-filter
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: 
-rubygems_version: 1.3.5
+rubyforge_project: "[none]"
+rubygems_version: 1.3.7
 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
+summary: Routing filters 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: []
+

data/.gitignore

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

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-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

@@ -1,123 +0,0 @@
-## 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

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

data/init.rb

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

data/lib/routing_filter/base.rb

@@ -1,31 +0,0 @@
-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/pagination.rb

@@ -1,33 +0,0 @@
-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

@@ -1,65 +0,0 @@
-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