redirect_with_params 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f2923ffdb029f993ac7d6f8f5a3d942ce116e6b
-  data.tar.gz: 12fb2f56170563f0ab6bf475f36ba8b70ae34c12
+  metadata.gz: e91cf9f9f9da14b4c1b964ab4a9873aa9b2d6c8d
+  data.tar.gz: 127bb1e015b4ab7fc2f6dfa1d8d2232e947cef46
 SHA512:
-  metadata.gz: fa35cc65896456283e797efc572bbf4d5abbe5a3b4e5412429ce9c5aa82e02e71606ee30e6795d722744de9d150362c077110b8f52f947dc218723eae66b5196
-  data.tar.gz: fcb6f20bbb678a2b10066fe9205f367d5791811589cee218d340f83933408aa7f253fe081e1ef330d7ce830f0bc7c47066cd932ebb845cc4c30c0be4d07362af
+  metadata.gz: a6dd0152c00a71a4e32635f6c95b75f21bff57d99af5673a8ea64afbb626979cae456100632fc7e367e0ba03953580c6ca369a7b529ac000ea3675747583cc48
+  data.tar.gz: 33b8426e6746d8a9441597345ebff777a17293525149039bbb729d7b30b991705941cd4f598f786fbe51d0295f4d05851885377e2807e5813c637a10d7988937

data/README.md

@@ -7,7 +7,7 @@ Preserve query parameters through Rails routing redirects
 Add this line to your application's `Gemfile`:
 
 ```ruby
-gem 'redirect_with_params', require: false
+gem 'redirect_with_params'
 ```
 
 And then execute:
@@ -20,21 +20,27 @@ Or install it yourself as:
 
 Add this line to your `config/routes.rb`:
 
+## Usage
+
+Use `redirect_with_params` in place of `redirect` in your Routes file. This will preserve the query parameters in the redirect.
+
 ```ruby
-require 'redirect_with_params'
+My::Application.routes.draw do
+  get "some/route/:id" => redirect_with_params { |path_params, request| "/some/new/route/#{path_params[:id]}" }
+end
 ```
 
-## Usage
+Navigating your browser to `/some/route/123?my_param=zebra&source=web` will redirect you to `/some/new/route/123?my_param=zebra&source=web`
 
-Use `redirect_with_params` in place of `redirect` in your Routes file. This will perserve the query parameters in the redirect.
+Optionally, you can specify a param whitelist:
 
 ```ruby
 My::Application.routes.draw do
-  get "some/route/:id" => redirect_with_params { |path_params, request| "/some/new/route/#{path_params[:id]}" }
+  get "some/route/:id" => redirect_with_params(:source) { |path_params, request| "/some/new/route/#{path_params[:id]}" }
 end
 ```
 
-Navigating your browser to `/some/route/123?my_param=zebra` will redirect you to `/some/new/route/123?my_param=zebra`
+Navigating your browser to `/some/route/123?my_param=zebra&source=web` will redirect you to `/some/new/route/123?source=web`
 
 ## Contributing
 

data/lib/redirect_with_params/extensions.rb

@@ -0,0 +1,40 @@
+require 'action_dispatch/routing'
+require 'action_dispatch/routing/redirection'
+
+module RedirectWithParams
+  module Extensions
+
+    module Routing
+      class ParamPreservingRedirect < ActionDispatch::Routing::Redirect
+        attr_reader :permitted_params
+        def initialize(status, query_params = [], block)
+          @permitted_params = query_params
+          @permitted_params.map! { |k| k.to_sym }
+          super(status, block)
+        end
+
+        def path(params, request)
+          path_builder = block.call(params, request)
+
+          allowed_keys = permitted_params
+          allowed_keys = request.params.keys.map(&:to_sym) if permitted_params.empty?
+          allowed_keys -= params.keys(&:to_sym)
+
+          allowed_params = request.params.select { |k,v| allowed_keys.include?(k.to_sym) }
+          path_builder << "?" << allowed_params.to_query unless allowed_params.empty?
+
+          path_builder
+        end
+      end
+    end
+
+    module Redirection
+      def redirect_with_params(*args, &block)
+        options = args.extract_options!
+        status  = options.delete(:status) || 301
+        RedirectWithParams::Extensions::Routing::ParamPreservingRedirect.new(status, args.to_a, block)
+      end
+    end
+
+  end
+end

data/lib/redirect_with_params/railtie.rb

@@ -0,0 +1,10 @@
+module RedirectWithParams
+  class Railtie < Rails::Railtie
+    initializer 'redirect_with_params.initialize' do
+      require 'redirect_with_params/extensions'
+
+      ActionDispatch::Routing.send(:include, RedirectWithParams::Extensions::Routing)
+      ActionDispatch::Routing::Redirection.send(:include, RedirectWithParams::Extensions::Redirection)
+    end
+  end
+end

data/lib/redirect_with_params/version.rb

@@ -1,3 +1,3 @@
 module RedirectWithParams
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/redirect_with_params.rb

@@ -1,41 +1,7 @@
-require "redirect_with_params/version"
+require 'redirect_with_params/version'
 
 if defined?(Rails)
-  module ActionDispatch::Routing
-    class RedirectWithParams < ActionDispatch::Routing::Redirect
-      attr_reader :permitted_params
-      def initialize(status, query_params = [], block)
-        @permitted_params = query_params
-        @permitted_params.map! { |k| k.to_sym }
-        super(status, block)
-      end
-
-      def path(params, request)
-        path_builder = block.call(params, request)
-
-        allowed_keys = permitted_params
-        allowed_keys = request.params.keys.map(&:to_sym) if permitted_params.empty?
-        allowed_keys -= params.keys(&:to_sym)
-
-        allowed_params = request.params.select { |k,v| allowed_keys.include?(k.to_sym) }
-        path_builder << "?" << allowed_params.to_query unless allowed_params.empty?
-
-        path_builder
-      end
-
-    end
-
-    module Redirection
-      def redirect_with_params(*args, &block)
-        options = args.extract_options!
-        status  = options.delete(:status) || 301
-        ActionDispatch::Routing::RedirectWithParams.new(status, args.to_a, block)
-      end
-    end
-  end
-
+  require 'redirect_with_params/railtie'
 else
-  STDERR.puts "redirect_with_params is a rails gem, but rails was not found."
+  STDERR.puts "redirect_with_params requires Rails, but Rails was not found"
 end
-
-module RedirectWithParams; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redirect_with_params
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kyle Dayton
@@ -65,6 +65,8 @@ files:
 - README.md
 - Rakefile
 - lib/redirect_with_params.rb
+- lib/redirect_with_params/extensions.rb
+- lib/redirect_with_params/railtie.rb
 - lib/redirect_with_params/version.rb
 - redirect_with_params.gemspec
 homepage: https://github.com/kyledayton/redirect_with_params