routing-filter 0.3.1 → 0.6.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d325ee34a8fc83f65430e6341ce97f86767f4b03d52252820ccf2eec4ce0f20
+  data.tar.gz: 0eeff41dc5c2556854828223f8219b92941249fe332c6c73f42a27ebb38068ab
+SHA512:
+  metadata.gz: be99776a974207014dc3ea4ef43811a37be9277ee6ee12f84552fd8cc992ea6e7419a2219d0fbb3bb81fcb77c3eef8b4074e4f3e92f5b814b80a5b09470e097f
+  data.tar.gz: 85eabfac1078e4c520ca316b0321027e54e1fa8e2eb900df76af40f726c3974dac695cbf5ad6d889c5aec0f48fa8320f273940a97f01612dfa5af15238f1ec7d

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## 0.6.3
+
+* Rails 6.0 support
+
+## 0.6.2
+
+* Rails 5.2 support
+
+## 0.6.1
+
+* Rails 5.1 support
+
+## 0.6.0
+
+* Rails 5.0 support
+
+## 0.5.1
+
+* Handle env as Hash and object at the same time in journey overrides.
+
+## 0.5.0
+
+* Rails 4.2 only support
+
+## 0.4.0
+
+* Rails 4 support
+
 ## 0.3.1
 * Filters support exclude option.
 

data/README.markdown

@@ -1,5 +1,7 @@
 # Routing Filter
 
+[![Build Status](https://secure.travis-ci.org/svenfuchs/routing-filter.png)](http://travis-ci.org/svenfuchs/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.
@@ -17,15 +19,14 @@ implement custom ones. Maybe the most popular one is the Locale routing filter:
 * `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.
+Latest routing-filter (~> 0.6.0) currently only works with Rails >= 4.2. It should
+not be all too hard to get it working with plain Rack::Mount but I haven't had that
+usecase, yet.
+
+For older Rails use `0-4-stable` branch.
 
 ## Installation
 
@@ -33,48 +34,61 @@ Just install the Gem:
 
     $ gem install routing-filter
 
-The Gem should work out of the box for Rails 3 after specifying it in your
+The Gem should work out of the box with Rails 4.2 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'
+```ruby
+# Gemfile
+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
+```ruby
+# 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/)
-      filter :locale,    :exclude => /^\/admin/
-    end
+```ruby
+Rails.application.routes.draw do
+  filter :extension, :exclude => %r(^admin/)
+  filter :locale,    :exclude => /^\/admin/
+end
+```
 
-## Running the tests
+The locale filter may be configured to not include the default locale:
 
-To run the tests against different dependencies [appraisal](https://github.com/thoughtbot/appraisal) is used.
+    # in config/initializers/routing_filter.rb
+    # Do not include default locale in generated URLs
+    RoutingFilter::Locale.include_default_locale = false
+    
+    # Then if the default locale is :de
+    # products_path(:locale => 'de') => /products
+    # products_path(:locale => 'en') => /en/products
 
-Running the tests for all supported Rails versions:
+### Testing
 
-    $ bundle install
-    $ bundle exec rake all
+RoutingFilter should not be enabled in functional tests by default since the Rails router gets
+bypassed for most testcases. Having RoutingFilter enabled in this setup can cause missing parameters
+in the test environment. Routing tests can/should re-enable RoutingFilter since the whole routing stack
+gets executed for these testcases.
 
-Running the tests for a single version, for example Rails 3.1:
+To disable RoutingFilter in your test suite add the following to your test_helper.rb / spec_helper.rb:
 
-    $ bundle install
-    $ bundle exec rake appraisal:rails-3.1 test
+```ruby
+RoutingFilter.active = false
+```
+
+## Running the tests
 
-Valid appraisal targets include rails-2.3, rails-3.0, rails-3.1 and rails-3.2
+    $ bundle install
+    $ bundle exec rake test
 
 ## Filter order
 
@@ -96,36 +110,40 @@ For example implementations have a look at the existing filters in
 
 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
+```ruby
+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
+```ruby
+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

data/lib/routing_filter/adapters/rails.rb

@@ -0,0 +1,49 @@
+require 'action_dispatch'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/core_ext/hash/reverse_merge'
+
+mappers = [ActionDispatch::Routing::Mapper]
+mappers << ActionDispatch::Routing::DeprecatedMapper if defined?(ActionDispatch::Routing::DeprecatedMapper)
+mappers.each do |mapper|
+  mapper.class_eval do
+    def filter(*args)
+      @set.add_filters(*args)
+    end
+  end
+end
+
+module ActionDispatchRoutingRouteSetWithFiltering
+  def filters
+    @set.filters if @set
+  end
+
+  def add_filters(*names)
+    options = names.extract_options!
+    names.each { |name| filters.unshift(RoutingFilter.build(name, options)) }
+  end
+
+  def generate(route_key, options, recall = {})
+    options = options.symbolize_keys
+
+    # `around_generate` is destructive method and it breaks url. To avoid this, `dup` is required.
+    filters.run(:around_generate, options, &lambda{
+      super(route_key, options, recall).map(&:dup)
+    })
+  end
+
+  def clear!
+    filters.clear if filters
+    super
+  end
+end
+
+ActionDispatch::Routing::RouteSet.send(:prepend, ActionDispatchRoutingRouteSetWithFiltering)
+
+
+ActionDispatch::Journey::Routes.class_eval do
+  def filters
+    @filters ||= RoutingFilter::Chain.new.tap { |f| @filters = f unless frozen? }
+  end
+end
+
+require 'routing_filter/adapters/routers/journey'

data/lib/routing_filter/adapters/routers/journey.rb

@@ -1,23 +1,24 @@
-require 'journey/routes'
-require 'journey/router'
-
-Journey::Routes.class_eval do
-  def filters
-    @filters || RoutingFilter::Chain.new.tap { |f| @filters = f unless frozen? }
-  end
-end
-
-Journey::Router.class_eval do
-  def find_routes_with_filtering env
-    path, filter_parameters = env['PATH_INFO'], {}
+module ActionDispatchJourneyRouterWithFiltering
+  def find_routes(env)
+    path = env.is_a?(Hash) ? env['PATH_INFO'] : env.path_info
+    filter_parameters = {}
+    original_path = path.dup
 
     @routes.filters.run(:around_recognize, path, env) do
       filter_parameters
     end
 
-    find_routes_without_filtering(env).map do |match, parameters, route|
+    super(env).map do |match, parameters, route|
       [ match, parameters.merge(filter_parameters), route ]
+    end.tap do |match, parameters, route|
+      # restore the original path
+      if env.is_a?(Hash)
+        env['PATH_INFO'] = original_path
+      else
+        env.path_info = original_path
+      end
     end
   end
-  alias_method_chain :find_routes, :filtering
 end
+
+ActionDispatch::Journey::Router.send(:prepend, ActionDispatchJourneyRouterWithFiltering)

data/lib/routing_filter/filters/pagination.rb

@@ -27,7 +27,7 @@ module RoutingFilter
     def around_recognize(path, env, &block)
       page = extract_segment!(PAGINATION_SEGMENT, path)
       yield.tap do |params|
-        params[:page] = page.to_i if page
+        params[:page] = page if page
       end
     end
 

data/lib/routing_filter/version.rb

@@ -1,3 +1,3 @@
 module RoutingFilter
-  VERSION = '0.3.1'
+  VERSION = '0.6.3'
 end

data/lib/routing_filter.rb

@@ -24,4 +24,4 @@ module RoutingFilter
   end
 end
 
-require "routing_filter/adapters/rails_#{ActionPack::VERSION::MAJOR}"
+require "routing_filter/adapters/rails"

metadata

@@ -1,60 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: routing-filter
 version: !ruby/object:Gem::Version
-  version: 0.3.1
-  prerelease: 
+  version: 0.6.3
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2019-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &2156259340 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :runtime
   prerelease: false
-  version_requirements: *2156259340
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: &2156258620 !ruby/object:Gem::Requirement
-    none: false
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '4.2'
+  type: :runtime
   prerelease: false
-  version_requirements: *2156258620
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2156257900 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156257900
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test_declarative
-  requirement: &2156273620 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2156273620
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.10.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.10.2
 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.
@@ -64,12 +117,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- README.markdown
 - MIT-LICENSE
-- lib/routing/filter.rb
+- README.markdown
 - lib/routing-filter.rb
-- lib/routing_filter/adapters/rails_2.rb
-- lib/routing_filter/adapters/rails_3.rb
+- lib/routing/filter.rb
+- lib/routing_filter.rb
+- lib/routing_filter/adapters/rails.rb
 - lib/routing_filter/adapters/routers/journey.rb
 - lib/routing_filter/adapters/routers/rack_mount.rb
 - lib/routing_filter/chain.rb
@@ -79,30 +132,28 @@ files:
 - lib/routing_filter/filters/pagination.rb
 - lib/routing_filter/filters/uuid.rb
 - lib/routing_filter/version.rb
-- lib/routing_filter.rb
 homepage: http://github.com/svenfuchs/routing-filter
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: ! '[none]'
-rubygems_version: 1.8.17
+rubyforge_project: "[none]"
+rubygems_version: 2.7.6.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 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/lib/routing_filter/adapters/rails_2.rb

@@ -1,69 +0,0 @@
-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
-      "#{match[1]}.tap { |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)
-    extract_request_environment_without_host(request).tap 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

@@ -1,47 +0,0 @@
-require 'action_dispatch'
-require 'active_support/core_ext/module/aliasing'
-require 'active_support/core_ext/hash/reverse_merge'
-
-mappers = [ActionDispatch::Routing::Mapper]
-mappers << ActionDispatch::Routing::DeprecatedMapper if defined?(ActionDispatch::Routing::DeprecatedMapper)
-mappers.each do |mapper|
-  mapper.class_eval do
-    def filter(*args)
-      @set.add_filters(*args)
-    end
-  end
-end
-
-ActionDispatch::Routing::RouteSet.class_eval do
-  def filters
-    @set.filters if @set
-  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 = {})
-  #   @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)
-    filters.run(:around_generate, options, &lambda{ generate_without_filtering(options, recall, extras) })
-  end
-  alias_method_chain :generate, :filtering
-
-  def clear_with_filtering!
-    filters.clear if filters
-    clear_without_filtering!
-  end
-  alias_method_chain :clear!, :filtering
-end
-
-case ActionPack::VERSION::MINOR
-when 2
-  require 'routing_filter/adapters/routers/journey'
-when 0,1
-  require 'routing_filter/adapters/routers/rack_mount'
-end