params_keeper_rails 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e3849671b65b09469406cf424369f6738686eb9a
-  data.tar.gz: 0cd0bf4977454d69558c1c3f4556ccbd99d9bf62
+SHA256:
+  metadata.gz: 42544c02623dbab162cb32dfbf47788df7ccec735e0b606591577033712c9687
+  data.tar.gz: 3a1e1ba2b64830eb1615c3de5200df092166739c6676b94dd17dd495ab420b2b
 SHA512:
-  metadata.gz: a0450d4f2c493ec326d95fe97e641a9d8e9838252c44c3585badb4b4eaee3091523b7d5e240f258930626a9e920e50704bf904585406b00d772ae30759f9142c
-  data.tar.gz: 7d8833985dc7d95fc448ea23a1caec19489dd80cf4426fb452bd95644b523e4c535a53489631415309572c106ac432cc11f0b17ef903bbbf352dbab8cf1bb78b
+  metadata.gz: a1c5604ee7acfc4db4b552a6e9408df49a4cb0085cb1e04556582241b303abde1e04216c9404e80315bc65b8f7e8d7925f60edbf1df68d001ca112d040e342c1
+  data.tar.gz: 3548469944a9851c9ca439d9423a9ad9393b5e546fe25c842b7a575da027521f7e724976043fe6c6aa4fa6e9c753daf1cb08f8b175c42e8ab440b1fc553d05c5

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
 rvm:
-  - 2.3.4
-  - 2.4.1
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
 gemfile:
   - gemfiles/rails50.gemfile
   - gemfiles/rails51.gemfile
-before_install: gem install bundler -v 1.15.3
+  - gemfiles/rails52.gemfile

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# CHANGELOG
+
+## 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
 
@@ -35,10 +35,10 @@ For example:
 ```ruby
 GET "/examples?key1=**&key2=**"
 
-# hash argument
+# hash
 url_for(action: :show)  #=> '/examples/:id?key1=**&key2=**'
 
-# string and active model arguments don't keep parameters by defalut
+# string and active model don't keep parameters by defalut
 url_for('/examples')  #=> '/examples'
 url_for(@example)  #=> '/examples/:id'
 
@@ -49,12 +49,23 @@ url_for(controller: 'examples2', action: :index)  #=> '/examples2'
 url_for(action: :show, keep_params: false)  #=> '/examples/:id'
 ```
 
-Specify class of url_for argument:
+Enable only specific class of url_for:
 
 ```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
+# enable only hash like url_for(action: :show)
+keep_params :key1, :key2, for: :hash
+
+# enable only string like url_for('/examples')
+keep_params :key1, :key2, for: :string
+
+# enable only model like url_for(@example)
+keep_params :key1, :key2, for: :model
+```
+
+Specify default options of url_for:
+
+```ruby
+keep_params :key1, :key2, url_options: { fixed_param: :something }
 ```
 
 Keep parameters throught multiple controllers:
@@ -73,7 +84,7 @@ end
 
 ## 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/lib/params_keeper/controller.rb

@@ -1,64 +1,25 @@
-require 'params_keeper/helper'
-
 module ParamsKeeper::Controller
   extend ActiveSupport::Concern
 
   included do
-    class_attribute :keep_params_keys, :keep_params_configs
+    class_attribute :keep_params_config
     helper ParamsKeeper::Helper
   end
 
   def url_for(options = nil)
-    return super if options.is_a?(Hash) && options.delete(:keep_params) == false
-
-    configs = self.class.keep_params_configs
-    keys = self.class.keep_params_keys
-    return super if keys.blank?
-
-    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
-    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
-      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
+    ParamsKeeper::Resolver.new(self, self, options).resolve || super
   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)
+      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)
     end
   end
 end

data/lib/params_keeper/helper.rb

@@ -1,12 +1,5 @@
 module ParamsKeeper::Helper
   def url_for(options = nil)
-    controller.url_for(options)
-  end
-
-  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)
-    end
+    ParamsKeeper::Resolver.new(self, controller, options).resolve || super
   end
 end

data/lib/params_keeper/resolver.rb

@@ -0,0 +1,84 @@
+class ParamsKeeper::Resolver
+  def initialize(klass, controller, options)
+    @klass = klass
+    @controller = controller
+    @options = options
+  end
+
+  def resolve
+    return if !configured? || !enable_options? || !target_options?
+
+    if @options.is_a?(Hash)
+      resolve_from_hash
+    else
+      resolve_from_routing
+    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)
+    end
+  end
+
+  def resolve_from_routing
+    url = base_url_for(@options)
+    url_opts = recognize_path(url)
+
+    if url_opts && link_to_target_controller?(url_opts)
+      base_url_for(self.class.merge_params(url_opts, @controller.params, config[:keys]))
+    else
+      url
+    end
+  end
+
+  def link_to_target_controller?(options)
+    controller = options[:controller].to_s
+    if config[:to].present?
+      ([controller] - Array(config[:to])).blank?
+    else
+      controller.blank? || controller.in?([@controller.controller_name, @controller.controller_path])
+    end
+  end
+
+  def config
+    @controller.class.keep_params_config
+  end
+
+  def configured?
+    config && config[:keys].present?
+  end
+
+  def enable_options?
+    !@options.is_a?(Hash) || @options.delete(:keep_params) != false
+  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 recognize_path(url)
+    Rails.application.routes.recognize_path(url)
+  rescue ActionController::RoutingError
+    nil
+  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
+
+  class << self
+    def merge_params(options, params, keys)
+      keeps = params.to_unsafe_h.deep_symbolize_keys.slice(*keys.to_a)
+      options.reverse_merge(keeps)
+    end
+  end
+end

data/lib/params_keeper/version.rb

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

data/lib/params_keeper_rails.rb

@@ -1,3 +1,5 @@
 require 'active_support'
 require 'params_keeper/version'
+require 'params_keeper/resolver'
+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.1.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-09-04 00:00:00.000000000 Z
+date: 2019-01-31 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,7 +80,8 @@ 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: []
@@ -104,6 +91,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -113,8 +101,10 @@ files:
 - bin/setup
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
+- gemfiles/rails52.gemfile
 - lib/params_keeper/controller.rb
 - lib/params_keeper/helper.rb
+- lib/params_keeper/resolver.rb
 - lib/params_keeper/version.rb
 - lib/params_keeper_rails.rb
 - params_keeper_rails.gemspec
@@ -137,8 +127,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.0.1
 signing_key: 
 specification_version: 4
 summary: keep specific parameters through links.