params_keeper_rails 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e3849671b65b09469406cf424369f6738686eb9a
-  data.tar.gz: 0cd0bf4977454d69558c1c3f4556ccbd99d9bf62
+SHA256:
+  metadata.gz: dbfc02008104f20c4213f259cf2ba429cf259f407e580ffe717ec8f8031c1cad
+  data.tar.gz: 50ec13a553a8a94a534f21622c728de197fcc492bfc34cbab98a7209534540ef
 SHA512:
-  metadata.gz: a0450d4f2c493ec326d95fe97e641a9d8e9838252c44c3585badb4b4eaee3091523b7d5e240f258930626a9e920e50704bf904585406b00d772ae30759f9142c
-  data.tar.gz: 7d8833985dc7d95fc448ea23a1caec19489dd80cf4426fb452bd95644b523e4c535a53489631415309572c106ac432cc11f0b17ef903bbbf352dbab8cf1bb78b
+  metadata.gz: 81446f14b629abffbb74e55949cd2dbe0e11c2e5941604a68e3ff1a05d668bcffe396497ccb58d13b0da0287de28f6b416481285d013b75df92af67fe5e62451
+  data.tar.gz: abb1b559084ffba8fd1a9bab5ba238416fe10e8148603bce8178be53d86054e683fe0af7fb9813e767e6baf13eb88a6708de9eea59b88bea65a075ee63ea1cba

data/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-16.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, 3.0]
+        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61']
+        exclude:
+          - ruby: 2.3
+            gemfile: rails60
+          - ruby: 2.3
+            gemfile: rails61
+          - ruby: 2.4
+            gemfile: rails60
+          - ruby: 2.4
+            gemfile: rails61
+          - ruby: 3.0
+            gemfile: rails50
+          - ruby: 3.0
+            gemfile: rails51
+          - ruby: 3.0
+            gemfile: rails52
+
+    name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run test
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -1,15 +1,8 @@
 /.bundle/
-/.yardoc
 /.project
 /Gemfile.lock
-/gemfiles/.bundle
-/gemfiles/vendor
 /gemfiles/*gemfile.lock
-/_yardoc/
 /coverage/
-/doc/
 /log/
 /pkg/
-/spec/reports/
-/tmp/
-/vendor/
+/spec/dummy/log/

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# CHANGELOG
+
+## 1.2.1
+
+* Fix order of options to be resolved for hidden fields.
+
+## 1.2.0
+
+* Support multiple configs.
+* Support hidden fields for `form_with` with GET method. (Rails => 5.1)
+
+## 1.1.2
+
+* Fix url_for helper outside of controller.
+
+## 1.1.1
+
+* Support symbolized :to config.
+
+## 1.1.0
+
+Features:
+
+* Add :url_options config.
+
+Changes:
+
+* Change :args to :for.
+
+Fixes:
+
+* Refactoring.
+
+## 1.0.0
+
+* First release.

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in params_keeper_rails.gemspec
 gemspec

data/README.md

@@ -1,6 +1,6 @@
 # ParamsKeeperRails
 
-A rails gem for keeping specific parameters through links.
+A rails controller extension for keeping specific parameters through links.
 
 ## Dependencies
 
@@ -29,51 +29,90 @@ class ExamplesController < ApplicationController
   keep_params :key1, :key2
 ```
 
-Parameters are kept if destination controller is same as current controller.
+Parameters are kept via `url_for` if destination controller is same as current controller.
 For example:
 
 ```ruby
 GET "/examples?key1=**&key2=**"
 
-# hash argument
-url_for(action: :show)  #=> '/examples/:id?key1=**&key2=**'
+# hash arg
+url_for(action: :index)  #=> '/examples?key1=**&key2=**'
 
-# string and active model arguments don't keep parameters by defalut
+# parameters are not kept if string or model arg is specified
 url_for('/examples')  #=> '/examples'
 url_for(@example)  #=> '/examples/:id'
 
 # parameters are not kept if destination controller is different from current controller
 url_for(controller: 'examples2', action: :index)  #=> '/examples2'
 
-# parameters are not kept if you set keep_params: false
+# parameters are not kept if you put "keep_params: false" into args
 url_for(action: :show, keep_params: false)  #=> '/examples/:id'
 ```
 
-Specify class of url_for argument:
+Parameters are kept for form with GET method via hidden fields.
+This feature is supported by `form_with` for rails >= 5.1.
 
 ```ruby
-keep_params :key1, :key2, args: [:hash]    # only hash argument like url_for(action: :show) keeps parameters
-keep_params :key1, :key2, args: [:string]  # only string argument like url_for('/examples') keeps parameters
-keep_params :key1, :key2, args: [:model]   # only model argument like url_for(@example) keeps parameters
+<%= form_with url: { action: :index}, method: :get do %>
+  <%= submit_tag 'submit' %>
+<% end %>
+#=> ...<input type="hidden" name="key1" value="**" />
+#      <input type="hidden" name="key2" value="**" /></form>
 ```
 
+## Options
+
+### Argument type
+
+Enable only specific argument type of url_for:
+
+```ruby
+# hash arg (same as default behaviour)
+keep_params :key1, :key2, for: :hash
+url_for(action: :index)  #=> '/examples?key1=**&key2=**'
+
+# string arg
+keep_params :key1, :key2, for: :string
+url_for('/examples')  #=> '/examples?key1=**&key2=**'
+
+# model arg
+keep_params :key1, :key2, for: :model
+url_for(@example)  #=> '/examples/:id?key1=**&key2=**'
+```
+
+`:for` allows to set multiple argument type as follows:
+
+```ruby
+keep_params :key1, :key2, for: [:hash, :model]
+```
+
+### Multiple controllers
+
 Keep parameters throught multiple controllers:
 
 ```ruby
 class ExamplesController < ApplicationController
   include ParamsKeeper::Controller
-  keep_params :key1, :key2, to: %w(examples nested_examples)
+  keep_params :key1, :key2, to: %w(examples examples2)
 end
 
-class NestedExamplesController < ApplicationController
+class Examples2Controller < ApplicationController
   include ParamsKeeper::Controller
-  keep_params :key1, :key2, to: %w(examples nested_examples)
+  keep_params :key1, :key2, to: %w(examples examples2)
 end
 ```
 
+### Default parameters
+
+Specify default parameters:
+
+```ruby
+keep_params :key1, :key2, url_options: { fixed_param: :something }
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/kanety/params_keeper_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/kanety/params_keeper_rails.
 
 ## License
 

data/gemfiles/rails50.gemfile

@@ -1,6 +1,5 @@
 source 'https://rubygems.org'
 
-gem "rails", "~> 5.0.5"
+gem "rails", "~> 5.0.0"
 
-# Specify your gem's dependencies in params_keeper_rails.gemspec
 gemspec path: "../"

data/gemfiles/rails51.gemfile

@@ -1,6 +1,5 @@
 source 'https://rubygems.org'
 
-gem "rails", "~> 5.1.3"
+gem "rails", "~> 5.1.0"
 
-# Specify your gem's dependencies in params_keeper_rails.gemspec
 gemspec path: "../"

data/gemfiles/rails52.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/rails60.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.0.0"
+
+gemspec path: "../"

data/gemfiles/rails61.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 6.1.0"
+
+gemspec path: "../"

data/lib/params_keeper/config.rb

@@ -0,0 +1,12 @@
+module ParamsKeeper
+  class Config
+    attr_accessor :keys, :to, :for, :url_options
+
+    def initialize(keys, options = {})
+      @keys = Array(keys)
+      @to = Array(options[:to])
+      @for = Array(options[:for] || :hash)
+      @url_options = options[:url_options] || {}
+    end
+  end
+end

data/lib/params_keeper/controller.rb

@@ -1,64 +1,33 @@
-require 'params_keeper/helper'
+module ParamsKeeper
+  module Controller
+    extend ActiveSupport::Concern
 
-module ParamsKeeper::Controller
-  extend ActiveSupport::Concern
-
-  included do
-    class_attribute :keep_params_keys, :keep_params_configs
-    helper ParamsKeeper::Helper
-  end
+    included do
+      class_attribute :keep_params_configs
+      helper ParamsKeeper::Helper
+    end
 
-  def url_for(options = nil)
-    return super if options.is_a?(Hash) && options.delete(:keep_params) == false
+    def url_for(options = nil)
+      ParamsKeeper::UrlFor.new(self, self, options).call || super
+    end
 
-    configs = self.class.keep_params_configs
-    keys = self.class.keep_params_keys
-    return super if keys.blank?
+    def redirect_to(options = {}, response_options = {})
+      return super unless options.is_a?(String)
 
-    if configs.key?(:args)
-      args = Array(configs[:args])
-      return super if (options.is_a?(Hash) && !args.include?(:hash)) ||
-                      (options.is_a?(String) && !args.include?(:string)) ||
-                      (options.class.respond_to?(:model_name) && !args.include?(:model))
-    elsif !options.is_a?(Hash)
-      return super
+      url = ParamsKeeper::UrlFor.new(self, self, options).call
+      url ? super(url, response_options) : super
     end
 
-    if options.is_a?(Hash)
-      if keep_params?(options, configs)
-        super(ParamsKeeper::Helper.merge_params(options, params, keys))
-      else
-        super
-      end
-    else
-      url = super(options)
-      url_opts = begin
-                   Rails.application.routes.recognize_path(url)
-                 rescue ActionController::RoutingError
-                   nil
-                 end
-      if url_opts && keep_params?(url_opts, configs)
-        super(ParamsKeeper::Helper.merge_params(url_opts, params, keys))
-      else
-        url
+    class_methods do
+      def keep_params(*args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        config = ParamsKeeper::Config.new(args, options)
+        self.keep_params_configs = keep_params_configs.to_a + [config]
       end
-    end
-  end
-
-  def keep_params?(options, configs)
-    controller = options[:controller].to_s
-    if configs[:to]
-      target = [controller, controller_name, controller_path]
-      Array(configs[:to]).any? { |c| c.to_s.in?(target) }
-    else
-      controller.blank? || controller.in?([controller_name, controller_path])
-    end
-  end
 
-  class_methods do
-    def keep_params(*args)
-      self.keep_params_configs = args.last.is_a?(Hash) ? args.pop : {}
-      self.keep_params_keys = Array(args)
+      def clear_keep_params!
+        self.keep_params_configs = nil
+     end
     end
   end
 end

data/lib/params_keeper/helper.rb

@@ -1,12 +1,23 @@
-module ParamsKeeper::Helper
-  def url_for(options = nil)
-    controller.url_for(options)
-  end
+module ParamsKeeper
+  module Helper
+    def url_for(url_options = nil)
+      return super unless controller
+
+      ParamsKeeper::UrlFor.new(self, controller, url_options).call || super
+    end
+
+    def form_with(**options, &block)
+      return super unless controller
+      return super if options[:method].to_s.downcase != 'get'
 
-  class << self
-    def merge_params(options, params, keep_params_keys)
-      keeps = params.to_unsafe_h.deep_symbolize_keys.slice(*keep_params_keys.to_a)
-      options.reverse_merge(keeps)
+      html = super
+      url_options = options[:url] || options[:model]
+      hidden_fields = ParamsKeeper::HiddenFields.new(controller, url_options).call
+      if hidden_fields.present?
+        html.sub('</form>') { "#{hidden_fields}</form>" }.html_safe
+      else
+        html
+      end
     end
   end
 end

data/lib/params_keeper/hidden_fields.rb

@@ -0,0 +1,19 @@
+module ParamsKeeper
+  class HiddenFields
+    def initialize(controller, url_options)
+      @controller = controller
+      @url_options = url_options
+    end
+
+    def call
+      return if @controller.class.keep_params_configs.blank?
+
+      params = ParamsKeeper::Resolver.new(@controller, @url_options).call
+      return if params.blank?
+
+      CGI.parse(params.to_query).flat_map do |key, values|
+        values.map { |value| @controller.view_context.hidden_field_tag(key, value, id: nil) }
+      end.join.html_safe
+    end
+  end
+end

data/lib/params_keeper/resolver.rb

@@ -0,0 +1,87 @@
+module ParamsKeeper
+  class Resolver
+    def initialize(controller, url_options)
+      @controller = controller
+      @url_options = url_options
+      @cache = {}
+    end
+
+    def call
+      return {} if configs.blank? || skip_url_options?
+
+      configs.each_with_object({}) do |config, params|
+        if target_config?(config)
+          params.merge!(extract_params(config))
+        end
+      end
+    end
+
+    def url_options_hash
+      if @url_options.is_a?(Hash)
+        @url_options
+      else
+        recognize_path(base_url_for(@url_options))
+      end
+    end
+
+    private
+
+    def configs
+      @controller.class.keep_params_configs
+    end
+
+    def skip_url_options?
+      if @url_options.is_a?(Hash)
+        @url_options.delete(:keep_params) == false
+      else
+        false
+      end
+    end
+
+    def target_config?(config)
+      target_url_options?(config) && target_controller?(config)
+    end
+
+    def target_url_options?(config)
+      (config.for.include?(:hash) && @url_options.is_a?(Hash)) ||
+        (config.for.include?(:string) && @url_options.is_a?(String)) ||
+        (config.for.include?(:model) && @url_options.class.respond_to?(:model_name))
+    end
+
+    def target_controller?(config)
+      dests = destination_controllers(url_options_hash)
+      if config.to.present?
+        (dests & config.to.map(&:to_s)).present?
+      else
+        (dests & current_controllers).present?
+      end
+    end
+
+    def destination_controllers(url_options_hash)
+      if url_options_hash[:controller].present?
+        [url_options_hash[:controller].to_s]
+      else
+        current_controllers
+      end
+    end
+
+    def current_controllers
+      [@controller.controller_name, @controller.controller_path]
+    end
+
+    def recognize_path(url)
+      @cache[url] ||= Rails.application.routes.recognize_path(url)
+    rescue ActionController::RoutingError
+      {}
+    end
+
+    def extract_params(config)
+      params = @controller.request.params.deep_symbolize_keys
+      params.slice(*config.keys).merge(config.url_options)
+    end
+
+    def base_url_for(url_options)
+      @controller.method(:url_for).super_method.call(url_options)
+    end
+  end
+end

data/lib/params_keeper/url_for.rb

@@ -0,0 +1,25 @@
+module ParamsKeeper
+  class UrlFor
+    def initialize(caller, controller, url_options)
+      @caller = caller
+      @controller = controller
+      @url_options = url_options
+    end
+
+    def call
+      return if @controller.class.keep_params_configs.blank?
+
+      resolver = ParamsKeeper::Resolver.new(@controller, @url_options)
+      params = resolver.call
+      return if params.blank?
+
+      base_url_for(resolver.url_options_hash.reverse_merge(params))
+    end
+
+    private
+
+    def base_url_for(url_options)
+      @caller.method(:url_for).super_method.call(url_options)
+    end
+  end
+end

data/lib/params_keeper/version.rb

@@ -1,3 +1,3 @@
 module ParamsKeeper
-  VERSION = "1.0.0"
+  VERSION = "1.2.1"
 end

data/lib/params_keeper_rails.rb

@@ -1,3 +1,8 @@
 require 'active_support'
 require 'params_keeper/version'
+require 'params_keeper/config'
+require 'params_keeper/resolver'
+require 'params_keeper/url_for'
+require 'params_keeper/hidden_fields'
+require 'params_keeper/helper'
 require 'params_keeper/controller'

data/params_keeper_rails.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["kaneta@sitebridge.co.jp"]
 
   spec.summary       = %q{keep specific parameters through links.}
-  spec.description   = %q{A rails gem for keeping specific parameters through links.}
+  spec.description   = %q{A rails controller extension for keeping specific parameters through links.}
   spec.homepage      = "https://github.com/kanety/params_keeper_rails"
   spec.license       = "MIT"
 
@@ -26,6 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-rails"
-  spec.add_development_dependency "rails-controller-testing"
   spec.add_development_dependency "simplecov"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: params_keeper_rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -66,20 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails-controller-testing
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,27 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A rails gem for keeping specific parameters through links.
+description: A rails controller extension for keeping specific parameters through
+  links.
 email:
 - kaneta@sitebridge.co.jp
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
+- gemfiles/rails60.gemfile
+- gemfiles/rails61.gemfile
+- lib/params_keeper/config.rb
 - lib/params_keeper/controller.rb
 - lib/params_keeper/helper.rb
+- lib/params_keeper/hidden_fields.rb
+- lib/params_keeper/resolver.rb
+- lib/params_keeper/url_for.rb
 - lib/params_keeper/version.rb
 - lib/params_keeper_rails.rb
 - params_keeper_rails.gemspec
@@ -137,8 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: keep specific parameters through links.

data/.travis.yml

@@ -1,8 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.4
-  - 2.4.1
-gemfile:
-  - gemfiles/rails50.gemfile
-  - gemfiles/rails51.gemfile
-before_install: gem install bundler -v 1.15.3

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "params_keeper/controller"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here