params_keeper_rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3849671b65b09469406cf424369f6738686eb9a
+  data.tar.gz: 0cd0bf4977454d69558c1c3f4556ccbd99d9bf62
+SHA512:
+  metadata.gz: a0450d4f2c493ec326d95fe97e641a9d8e9838252c44c3585badb4b4eaee3091523b7d5e240f258930626a9e920e50704bf904585406b00d772ae30759f9142c
+  data.tar.gz: 7d8833985dc7d95fc448ea23a1caec19489dd80cf4426fb452bd95644b523e4c535a53489631415309572c106ac432cc11f0b17ef903bbbf352dbab8cf1bb78b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require spec_helper
+--require rails_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+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/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at kaneta@sitebridge.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yoshikazu Kaneta
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,81 @@
+# ParamsKeeperRails
+
+A rails gem for keeping specific parameters through links.
+
+## Dependencies
+
+* ruby 2.3+
+* rails 5.0+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'params_keeper_rails'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Include modules in your controller and specify parameter keys you want to keep:
+
+```ruby
+class ExamplesController < ApplicationController
+  include ParamsKeeper::Controller
+  keep_params :key1, :key2
+```
+
+Parameters are kept 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=**'
+
+# string and active model arguments don't keep parameters by defalut
+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
+url_for(action: :show, keep_params: false)  #=> '/examples/:id'
+```
+
+Specify class of url_for argument:
+
+```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
+```
+
+Keep parameters throught multiple controllers:
+
+```ruby
+class ExamplesController < ApplicationController
+  include ParamsKeeper::Controller
+  keep_params :key1, :key2, to: %w(examples nested_examples)
+end
+
+class NestedExamplesController < ApplicationController
+  include ParamsKeeper::Controller
+  keep_params :key1, :key2, to: %w(examples nested_examples)
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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

data/gemfiles/rails50.gemfile

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

data/gemfiles/rails51.gemfile

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

data/lib/params_keeper/controller.rb

@@ -0,0 +1,64 @@
+require 'params_keeper/helper'
+
+module ParamsKeeper::Controller
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :keep_params_keys, :keep_params_configs
+    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
+  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)
+    end
+  end
+end

data/lib/params_keeper/helper.rb

@@ -0,0 +1,12 @@
+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
+  end
+end

data/lib/params_keeper/version.rb

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

data/lib/params_keeper_rails.rb

@@ -0,0 +1,3 @@
+require 'active_support'
+require 'params_keeper/version'
+require 'params_keeper/controller'

data/params_keeper_rails.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'params_keeper/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "params_keeper_rails"
+  spec.version       = ParamsKeeper::VERSION
+  spec.authors       = ["Yoshikazu Kaneta"]
+  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.homepage      = "https://github.com/kanety/params_keeper_rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_runtime_dependency "rails", ">= 5.0"
+
+  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

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: params_keeper_rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Yoshikazu Kaneta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rspec-rails
+  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: 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
+    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 gem for keeping specific parameters through links.
+email:
+- kaneta@sitebridge.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails50.gemfile
+- gemfiles/rails51.gemfile
+- lib/params_keeper/controller.rb
+- lib/params_keeper/helper.rb
+- lib/params_keeper/version.rb
+- lib/params_keeper_rails.rb
+- params_keeper_rails.gemspec
+homepage: https://github.com/kanety/params_keeper_rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: keep specific parameters through links.
+test_files: []