routing-filter 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d325ee34a8fc83f65430e6341ce97f86767f4b03d52252820ccf2eec4ce0f20
-  data.tar.gz: 0eeff41dc5c2556854828223f8219b92941249fe332c6c73f42a27ebb38068ab
+  metadata.gz: 545f70e3cf86cd8a929b1cdad7d7b69709d4b39a8bd492d92c7de3bdb1b7e33d
+  data.tar.gz: 1f558537658aad99dd8399e4ed366c169df2f4b26339bb420e9615e39ff28639
 SHA512:
-  metadata.gz: be99776a974207014dc3ea4ef43811a37be9277ee6ee12f84552fd8cc992ea6e7419a2219d0fbb3bb81fcb77c3eef8b4074e4f3e92f5b814b80a5b09470e097f
-  data.tar.gz: 85eabfac1078e4c520ca316b0321027e54e1fa8e2eb900df76af40f726c3974dac695cbf5ad6d889c5aec0f48fa8320f273940a97f01612dfa5af15238f1ec7d
+  metadata.gz: 1d33b7c6b011e74c14372a05553b608d1beccbb0637fea654e011d0969a77b30a7c119438108545caa7185990347a4c8b49057a784c968386b47b95d4de2812b
+  data.tar.gz: 535eb1baa68413efa08e41c30256ebfca6e76b8eaa6807e533851a08028ca6269d79d9e3b31d7f17c53a17d60e2ba3db13057caf4a80c5bf10d877b9d4b81465

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.7.0
+
+* Rails 6.1 exclusive support
+
 ## 0.6.3
 
 * Rails 6.0 support

data/README.markdown

@@ -92,7 +92,7 @@ RoutingFilter.active = false
 
 ## 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.
+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 passed 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.
 
@@ -108,7 +108,7 @@ This way common base filters (such as the locale filter) can run first and do no
 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:
+The following would be a skeleton of an empty filter:
 
 ```ruby
 module RoutingFilter
@@ -128,16 +128,15 @@ module RoutingFilter
       # 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).
+        # You can change the generated url_or_path here by calling `result.update(url)`.
+        # The current url is available via `result.url`
       end
     end
   end
 end
 ```
 
-You can specify the filter explicitely in your routes.rb:
+You can specify the filter explicitly in your routes.rb:
 
 ```ruby
 Rails.application.routes.draw do
@@ -154,12 +153,12 @@ 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
+## Rationale: Two example use cases
 
 ### 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
+An early use-case from which this originated was the need to define a locale
+at the beginning of a 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

data/lib/routing_filter/adapters/rails.rb

@@ -1,14 +1,11 @@
 require 'action_dispatch'
 require 'active_support/core_ext/module/aliasing'
 require 'active_support/core_ext/hash/reverse_merge'
+require 'routing_filter/result_wrapper'
 
-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
+ActionDispatch::Routing::Mapper.class_eval do
+  def filter(*args)
+    @set.add_filters(*args)
   end
 end
 
@@ -25,10 +22,9 @@ module ActionDispatchRoutingRouteSetWithFiltering
   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)
-    })
+    filters.run(:around_generate, options, &lambda {
+      RoutingFilter::ResultWrapper.new(super(route_key, options, recall))
+    }).generate
   end
 
   def clear!
@@ -37,8 +33,7 @@ module ActionDispatchRoutingRouteSetWithFiltering
   end
 end
 
-ActionDispatch::Routing::RouteSet.send(:prepend, ActionDispatchRoutingRouteSetWithFiltering)
-
+ActionDispatch::Routing::RouteSet.prepend ActionDispatchRoutingRouteSetWithFiltering
 
 ActionDispatch::Journey::Routes.class_eval do
   def filters

data/lib/routing_filter/filter.rb

@@ -24,14 +24,12 @@ module RoutingFilter
         $1
       end
 
-      def prepend_segment!(result, segment)
-        url = result.is_a?(Array) ? result.first : result
-        url.sub!(%r(^(http.?://[^/]*)?(.*))) { "#{$1}/#{segment}#{$2 == '/' ? '' : $2}" }
+      def prepend_segment(url, segment)
+        url.sub(%r(^(http.?://[^/]*)?(.*))) { "#{$1}/#{segment}#{$2 == '/' ? '' : $2}" }
       end
 
-      def append_segment!(result, segment)
-        url = result.is_a?(Array) ? result.first : result
-        url.sub!(%r(/?($|\?))) { "/#{segment}#{$1}" }
+      def append_segment(url, segment)
+        url.sub(%r(/?($|\?))) { "/#{segment}#{$1}" }
       end
   end
-end
+end

data/lib/routing_filter/filters/extension.rb

@@ -1,11 +1,11 @@
 # The Extension filter chops a file extension off from the end of the
-# recognized path. When a path is generated the filter re-adds the extension 
+# recognized path. When a path is generated the filter re-adds the extension
 # to the path accordingly.
-# 
+#
 #   incoming url: /products.xml
 #   filtered url: /products
 #   generated url: /products.xml
-# 
+#
 # You can install the filter like this:
 #
 #   # in config/routes.rb
@@ -30,30 +30,29 @@ module RoutingFilter
 
     def around_generate(params, &block)
       yield.tap do |result|
-        url = result.is_a?(Array) ? result.first : result
-        append_extension!(url) if append_extension?(url)
+        result.update append_extension!(result.url) if append_extension?(result.url)
       end
     end
 
     protected
-    
+
       def extract_extension!(path)
         path.sub!(/\.#{extension}$/, '')
         $1
       end
-      
+
       def append_extension?(url)
         !(blank?(url) || excluded?(url) || mime_extension?(url))
       end
-      
+
       def append_extension!(url)
         url.replace url.sub(/(\?|$)/, ".#{extension}\\1")
       end
-      
+
       def blank?(url)
         url.blank? || !!url.match(%r(^/(\?|$)))
       end
-      
+
       def excluded?(url)
         case exclude
         when Regexp
@@ -62,7 +61,7 @@ module RoutingFilter
           exclude.call(url)
         end
       end
-      
+
       def mime_extension?(url)
         url =~ /\.#{Mime::EXTENSION_LOOKUP.keys.join('|')}(\?|$)/
       end

data/lib/routing_filter/filters/locale.rb

@@ -67,9 +67,8 @@ module RoutingFilter
 
       args << params
 
-      yield.tap do |result|        
-        url = result.is_a?(Array) ? result.first : result
-        prepend_segment!(result, locale) if prepend_locale?(locale) && !excluded?(url)
+      yield.tap do |result|
+        result.update prepend_segment(result.url, locale) if prepend_locale?(locale) && !excluded?(result.url)
       end
     end
 
@@ -85,7 +84,7 @@ module RoutingFilter
     def prepend_locale?(locale)
       locale && (self.class.include_default_locale? || !default_locale?(locale))
     end
-    
+
     def excluded?(url)
       case exclude
       when Regexp

data/lib/routing_filter/filters/pagination.rb

@@ -34,7 +34,7 @@ module RoutingFilter
     def around_generate(params, &block)
       page = params.delete(:page)
       yield.tap do |result|
-        append_segment!(result, "page/#{page}") if append_page?(page)
+        result.update append_segment(result.url, "page/#{page}") if append_page?(page)
       end
     end
 

data/lib/routing_filter/filters/uuid.rb

@@ -22,7 +22,7 @@
 module RoutingFilter
   class Uuid < Filter
     UUID_SEGMENT = %r(^/?([a-z\d]{8}\-[a-z\d]{4}\-[a-z\d]{4}\-[a-z\d]{4}\-[a-z\d]{12})(/)?)
-    
+
     def around_recognize(path, env, &block)
       uuid = extract_segment!(UUID_SEGMENT, path)
       yield.tap do |params|
@@ -33,7 +33,7 @@ module RoutingFilter
     def around_generate(params, &block)
       uuid = params.delete(:uuid)
       yield.tap do |result|
-        prepend_segment!(result, uuid) if uuid
+        result.update prepend_segment(result.url, uuid) if uuid
       end
     end
   end

data/lib/routing_filter/result_wrapper.rb

@@ -0,0 +1,24 @@
+module RoutingFilter
+  class ResultWrapper
+    RouteWithParams = Struct.new(:url, :params) do
+      def path(_)
+        url
+      end
+    end
+
+    attr_reader :url, :params
+
+    def initialize(result)
+      @url = result.path(nil)
+      @params = result.params
+    end
+
+    def update(url)
+      @url = url
+    end
+
+    def generate
+      RouteWithParams.new(url, params)
+    end
+  end
+end

data/lib/routing_filter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routing-filter
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Sven Fuchs
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-09 00:00:00.000000000 Z
+date: 2021-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -131,11 +131,13 @@ files:
 - lib/routing_filter/filters/locale.rb
 - lib/routing_filter/filters/pagination.rb
 - lib/routing_filter/filters/uuid.rb
+- lib/routing_filter/result_wrapper.rb
 - lib/routing_filter/version.rb
 homepage: http://github.com/svenfuchs/routing-filter
-licenses: []
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,9 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: "[none]"
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 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