params_keeper_rails 1.1.2 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcba9e0da62cef22f6a10be854b3f87576ca42959a07e73ba6f5db15b4cc3832
-  data.tar.gz: 9f34f3aff5de4d3aaa00b8c1091ac4d577e5eaba0bbe68d35f59af9a8aa720bc
+  metadata.gz: 0e45dfc5db4050646b12ac16f67cd674add86504f033ea0e53994b70899fe965
+  data.tar.gz: ed817a1bea1033e7f72a6e606b886af52bdd4c0f7d408caf83dcec2837cfb93d
 SHA512:
-  metadata.gz: c0cd32d51cbd4ff13e175ce8f9ada37458325c9d51e464569fc7969661ef29f1966f155bba0850de004ad11a773fd2b646a2cfcf3aff3cc488c0dd10a0364fb9
-  data.tar.gz: bf5d57f3cb6c783a6af545c0d22b183556ad0280b4708b9521b286f00cc065ed1f36bd07c296757e4817c8fc8d948ecbbff542643e7dcc7f50762b33a0d5d102
+  metadata.gz: dd080fe7ffe4708d8d79c2cbb0918b485d6f1fe5d437662a0b39935267264a23ce2edbad4f5128ab67526bb6054301ab27d7fcec67b4a15c7c37af8621d5ed80
+  data.tar.gz: 825ef3b8765a00fc087e6e0c989e86c0fb92953a04542bb3d6f489ec0effd4505bde9de6091eba58420cf99815632e3b5fb3dd29a1c9cc74869d8050917800aa

data/.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0', 3.1]
+        gemfile: ['rails50', 'rails51', 'rails52', 'rails60', 'rails61', 'rails70']
+        exclude:
+          - ruby: 2.3
+            gemfile: rails60
+          - ruby: 2.3
+            gemfile: rails61
+          - ruby: 2.3
+            gemfile: rails70
+          - ruby: 2.4
+            gemfile: rails60
+          - ruby: 2.4
+            gemfile: rails61
+          - ruby: 2.4
+            gemfile: rails70
+          - ruby: 2.5
+            gemfile: rails70
+          - ruby: 2.6
+            gemfile: rails70
+          - ruby: 3.0
+            gemfile: rails50
+          - ruby: 3.0
+            gemfile: rails51
+          - ruby: 3.0
+            gemfile: rails52
+          - ruby: 3.1
+            gemfile: rails50
+          - ruby: 3.1
+            gemfile: rails51
+          - ruby: 3.1
+            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,8 +1,13 @@
 /.bundle/
-/.project
 /Gemfile.lock
 /gemfiles/*gemfile.lock
 /coverage/
 /log/
 /pkg/
+/tmp/
 /spec/dummy/log/
+/spec/dummy/config/database.yml
+/spec/dummy/db/schema*.rb
+/spec/dummy/db/*.sqlite3
+/spec/dummy/log/*.log
+/spec/dummy/tmp/*

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # CHANGELOG
 
+## 1.2.2
+
+* Put hidden fields after beginning tag of form.
+
+## 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.

data/README.md

@@ -29,59 +29,87 @@ 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
-url_for(action: :show)  #=> '/examples/:id?key1=**&key2=**'
+# hash arg
+url_for(action: :index)  #=> '/examples?key1=**&key2=**'
 
-# string and active model 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'
 ```
 
-Enable only specific class of url_for:
+Parameters are kept for form with GET method via hidden fields.
+This feature is supported by `form_with` for rails >= 5.1.
 
 ```ruby
-# enable only hash like url_for(action: :show)
+<%= 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=**'
 
-# enable only string like url_for('/examples')
+# string arg
 keep_params :key1, :key2, for: :string
+url_for('/examples')  #=> '/examples?key1=**&key2=**'
 
-# enable only model like url_for(@example)
+# model arg
 keep_params :key1, :key2, for: :model
+url_for(@example)  #=> '/examples/:id?key1=**&key2=**'
 ```
 
-Specify default options of url_for:
+`:for` allows to set multiple argument type as follows:
 
 ```ruby
-keep_params :key1, :key2, url_options: { fixed_param: :something }
+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.

data/gemfiles/rails60.gemfile

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

data/gemfiles/rails61.gemfile

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

data/gemfiles/rails70.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem "rails", "~> 7.0.1"
+
+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,25 +1,33 @@
-module ParamsKeeper::Controller
-  extend ActiveSupport::Concern
+module ParamsKeeper
+  module Controller
+    extend ActiveSupport::Concern
 
-  included do
-    class_attribute :keep_params_config
-    helper ParamsKeeper::Helper
-  end
+    included do
+      class_attribute :keep_params_configs
+      helper ParamsKeeper::Helper
+    end
 
-  def url_for(options = nil)
-    ParamsKeeper::Resolver.new(self, self, options).resolve || super
-  end
+    def url_for(options = nil)
+      ParamsKeeper::UrlFor.new(self, self, options).call || super
+    end
+
+    def redirect_to(options = {}, response_options = {})
+      return super unless options.is_a?(String)
+
+      url = ParamsKeeper::UrlFor.new(self, self, options).call
+      url ? super(url, response_options) : super
+    end
+
+    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
 
-  class_methods do
-    def keep_params(*args)
-      self.keep_params_config = {
-        keys: nil,
-        to: nil,
-        for: :hash,
-        url_options: nil
-      }
-      self.keep_params_config.merge!(args.last.is_a?(Hash) ? args.pop : {})
-      self.keep_params_config[:keys] = Array(args)
+      def clear_keep_params!
+        self.keep_params_configs = nil
+     end
     end
   end
 end

data/lib/params_keeper/helper.rb

@@ -1,9 +1,23 @@
-module ParamsKeeper::Helper
-  def url_for(options = nil)
-    if controller
-      ParamsKeeper::Resolver.new(self, controller, options).resolve || super
-    else
-      super
+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'
+
+      html = super
+      url_options = options[:url] || options[:model]
+      hidden_fields = ParamsKeeper::HiddenFields.new(controller, url_options).call
+      if hidden_fields.present?
+        html.sub(/^(<form[^>]*>)/) { "#{$1}#{hidden_fields}" }.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

@@ -1,85 +1,87 @@
-class ParamsKeeper::Resolver
-  def initialize(klass, controller, options)
-    @klass = klass
-    @controller = controller
-    @options = options
-  end
+module ParamsKeeper
+  class Resolver
+    def initialize(controller, url_options)
+      @controller = controller
+      @url_options = url_options
+      @cache = {}
+    end
 
-  def resolve
-    return if !configured? || !enable_options? || !target_options?
+    def call
+      return {} if configs.blank? || skip_url_options?
 
-    if @options.is_a?(Hash)
-      resolve_from_hash
-    else
-      resolve_from_routing
+      configs.each_with_object({}) do |config, params|
+        if target_config?(config)
+          params.merge!(extract_params(config))
+        end
+      end
     end
-  end
 
-  private
-
-  def resolve_from_hash
-    if link_to_target_controller?(@options)
-      base_url_for(self.class.merge_params(@options, @controller.params, config[:keys]))
-    else
-      base_url_for(@options)
+    def url_options_hash
+      if @url_options.is_a?(Hash)
+        @url_options
+      else
+        recognize_path(base_url_for(@url_options))
+      end
     end
-  end
 
-  def resolve_from_routing
-    url = base_url_for(@options)
-    url_opts = recognize_path(url)
+    private
 
-    if url_opts && link_to_target_controller?(url_opts)
-      base_url_for(self.class.merge_params(url_opts, @controller.params, config[:keys]))
-    else
-      url
+    def configs
+      @controller.class.keep_params_configs
     end
-  end
 
-  def link_to_target_controller?(options)
-    controller = options[:controller].to_s
-    if config[:to].present?
-      target = controller.present? ? [controller] : [@controller.controller_name, @controller.controller_path]
-      (Array(config[:to]).map(&:to_s) & target).present?
-    else
-      controller.blank? || controller.in?([@controller.controller_name, @controller.controller_path])
+    def skip_url_options?
+      if @url_options.is_a?(Hash)
+        @url_options.delete(:keep_params) == false
+      else
+        false
+      end
     end
-  end
 
-  def config
-    @controller.class.keep_params_config
-  end
+    def target_config?(config)
+      target_url_options?(config) && target_controller?(config)
+    end
 
-  def configured?
-    config && config[:keys].present?
-  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 enable_options?
-    !@options.is_a?(Hash) || @options.delete(:keep_params) != false
-  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 target_options?
-    fors = Array(config[:for] || :hash)
-    (fors.include?(:hash) && @options.is_a?(Hash)) ||
-      (fors.include?(:string) && @options.is_a?(String)) ||
-      (fors.include?(:model) && @options.class.respond_to?(:model_name))
-  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 recognize_path(url)
-    Rails.application.routes.recognize_path(url)
-  rescue ActionController::RoutingError
-    nil
-  end
+    def current_controllers
+      [@controller.controller_name, @controller.controller_path]
+    end
 
-  def base_url_for(options)
-    options = options.merge(config[:url_options]) if options.is_a?(Hash) && config[:url_options]
-    @klass.method(:url_for).super_method.call(options)
-  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
 
-  class << self
-    def merge_params(options, params, keys)
-      keeps = params.to_unsafe_h.deep_symbolize_keys.slice(*keys.to_a)
-      options.reverse_merge(keeps)
+    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.1.2"
+  VERSION = "1.2.2"
 end

data/lib/params_keeper_rails.rb

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

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "webrick"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: params_keeper_rails
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.2
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-15 00:00:00.000000000 Z
+date: 2022-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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'
 description: A rails controller extension for keeping specific parameters through
   links.
 email:
@@ -88,24 +102,27 @@ 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
+- gemfiles/rails70.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
@@ -128,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: keep specific parameters through links.

data/.travis.yml

@@ -1,19 +0,0 @@
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-gemfile:
-  - gemfiles/rails50.gemfile
-  - gemfiles/rails51.gemfile
-  - gemfiles/rails52.gemfile
-  - gemfiles/rails60.gemfile
-matrix:
-  exclude:
-  - rvm: 2.3
-    gemfile: gemfiles/rails60.gemfile
-  - rvm: 2.4
-    gemfile: gemfiles/rails60.gemfile
-script:
-  - bundle exec rspec

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