persistent_params 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7de7241a8c44ae180ef25cd9e27932de5f8ef90c
+  data.tar.gz: 245612b25916d768e8f4b2a03b14c3d83b3dfa5b
+SHA512:
+  metadata.gz: 8b8e7c7a50995bae22779d1faacbc3d1f60b03efa1c39ada92c337d81fd72a92687bc25755581342116c4d40ccabd5dd043fdcf7b54d4eeb8ae2d2acaabd09e9
+  data.tar.gz: ae37d4bb7719c602350d54973d774346f78b2fb8bcff01e9d1db371fd38ca44ecf5e32bbd8f933dd1ce897968ed16beac90ebc1606075a871ffd61dee16a5cae

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'rdoc', '~> 3.12'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 2.0.1'
+end
+
+gem 'actionpack', '~> 4.2.0'

data/Gemfile.lock

@@ -0,0 +1,95 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (4.2.5)
+      actionview (= 4.2.5)
+      activesupport (= 4.2.5)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5)
+      activesupport (= 4.2.5)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activesupport (4.2.5)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    erubis (2.7.0)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.9.1)
+    github_api (0.13.1)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      multi_json (>= 1.7.5, < 2.0)
+      oauth2
+    hashie (3.4.3)
+    highline (1.7.8)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.2)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.0.0)
+    minitest (5.8.3)
+    multi_json (1.11.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.7.1)
+      mini_portile2 (~> 2.0.0.rc2)
+    oauth2 (1.0.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.2)
+      loofah (~> 2.0)
+    rake (10.4.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 4.2.0)
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  rdoc (~> 3.12)
+
+BUNDLED WITH
+   1.10.6

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Diego Aguir Selzlein
+
+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,74 @@
+# persistent_params
+
+Save params in session to use them again when the user goes to another page and
+comes back. This gem adds a method to Rails controllers called `persists_params`
+that adds this feature to that controller.
+
+## What?
+
+I have to deal with not-so-simple search forms in my `index` templates. It's
+awful when I combine several filters, search for records, choose one of them
+to see details and then go back to the `index` page just to see all my filters
+gone and I have to set them all over.
+
+With this gem, the controller will save the params in session and, when the
+same action is invoked again with no params, the request is redirected to the
+same path, but with the previous used params set.
+
+It also offers a handy method to integrate with the `HasScope` gem, so `scopes`
+are persisted between requests.
+
+## Installation
+
+In your Gemfile:
+
+```ruby
+gem 'persistent_params'
+```
+
+In your controller:
+
+```ruby
+class UsersController < ApplicationController
+  persists_params
+end
+```
+
+That's it. All the parameters except `controller` and `action` will be stored
+and used between requests to the `index` action. If you want to apply to other
+actions, use the `only` key when calling `persists_params`.
+
+## HasScope Integration
+
+In my case, I use the gem to save scopes defined by
+[HasScope](https://github.com/plataformatec/has_scope). Not all parameters
+are scopes, so I created a handy method that configures PersistentParams to
+save only scopes:
+
+```ruby
+class UsersController < ApplicationController
+  persists_scopes
+end
+```
+
+## Clearing Params
+
+To actually clear the previous params and prevent the redirecting, you need to
+parameterize a `?clear=true`. I usually do this with a `link_to` in my `index`:
+
+```erb
+<%= link_to 'Clear Filters', users_path(clear: true) %>
+```
+
+## Contributing
+
+* Fork
+* Clone
+* Create your branch
+* Make your changes
+* Push
+* Create a Pull Request
+
+## Copyright
+
+Copyright (c) 2015 Diego Aguir Selzlein. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "persistent_params"
+  gem.homepage = "http://github.com/nerde/persistent_params"
+  gem.license = "MIT"
+  gem.summary = %Q{Persist params by controller/action}
+  gem.description = %Q{Persist your params in session so they are used the next time you call the same controller/action. Works with HasScope.}
+  gem.email = "diego.selzlein@unila.edu.br"
+  gem.authors = ["Diego Aguir Selzlein"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ''
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "persistent_params #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/persistent_params.rb

@@ -0,0 +1,84 @@
+require 'ostruct'
+
+module PersistentParams
+  module ClassMethods
+    def persistent_params_config(hash = {})
+      @persistent_params_config ||= OpenStruct.new(hash)
+    end
+  end
+
+  def self.included(controller)
+    controller.before_filter :check_last_params
+    controller.extend ClassMethods
+  end
+
+  private
+
+  def check_last_params
+    return if skip_this_action?
+    return clear_last_params if clear_last_params?
+    return redirect_to_last_params if current_params.empty?
+    self.last_params = current_params
+  end
+
+  def skip_this_action?
+    !actions_to_persist_params.include?(params[:action])
+  end
+
+  def actions_to_persist_params
+    Array(persistent_params_config.only || 'index').map(&:to_s)
+  end
+
+  def clear_last_params?
+    params[:clear].present?
+  end
+
+  def clear_last_params
+    self.last_params = nil
+  end
+
+  def redirect_to_last_params
+    return if last_params.empty?
+    redirect_to **last_params.symbolize_keys
+  end
+
+  def current_params
+    send(params_method).except(*ignored_keys)
+  end
+
+  def params_method
+    persistent_params_config.params_method || :params
+  end
+
+  def ignored_keys
+    %w(controller action)
+  end
+
+  def persistent_params_config
+    self.class.persistent_params_config
+  end
+
+  def last_params
+    session[last_params_key] || {}
+  end
+
+  def last_params=(scopes)
+    session[last_params_key] = scopes
+  end
+
+  def last_params_key
+    "#{params[:controller]}__#{params[:action]}"
+  end
+end
+
+class ActionController::Base
+  def self.persists_params(**options)
+    include PersistentParams
+    persistent_params_config(options)
+    yield persistent_params_config if block_given?
+  end
+
+  def self.persists_scopes(**options, &block)
+    persists_params(params_method: :current_scopes, **options, &block)
+  end
+end

data/persistent_params.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: persistent_params 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "persistent_params"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Diego Aguir Selzlein"]
+  s.date = "2015-12-29"
+  s.description = "Persist your params in session so they are used the next time you call the same controller/action. Works with HasScope."
+  s.email = "diego.selzlein@unila.edu.br"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".ruby-version",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/persistent_params.rb",
+    "persistent_params.gemspec",
+    "test/persistent_params_test.rb",
+    "test/persistent_scopes_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = "http://github.com/nerde/persistent_params"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.5.1"
+  s.summary = "Persist params by controller/action"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<actionpack>, ["~> 4.2.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+    else
+      s.add_dependency(%q<actionpack>, ["~> 4.2.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    end
+  else
+    s.add_dependency(%q<actionpack>, ["~> 4.2.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+  end
+end
+

data/test/persistent_params_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+
+class MyController < ApplicationController
+  persists_params only: %i(index show)
+
+  def index
+    render nothing: true
+  end
+
+  def show
+    render nothing: true
+  end
+
+  def create
+    render nothing: true
+  end
+end
+
+class PersistentParamsTest < ActionController::TestCase
+  tests MyController
+
+  def test_redirects_to_last_used_params
+    get :index, something: 123
+
+    assert_response :ok
+
+    get :index
+
+    assert_response :found
+    assert_redirected_to(controller: :my, action: :index, something: 123)
+  end
+
+  def test_does_not_redirect_empty_params
+    get :index
+
+    assert_response :ok
+
+    get :index
+
+    assert_response :ok
+  end
+
+  def test_clears_params
+    get :index, something: 123
+
+    assert_response :ok
+
+    get :index, clear: true
+
+    assert_response :ok
+
+    get :index
+
+    assert_response :ok
+  end
+
+  def test_isolate_actions
+    get :index, something: 123
+
+    assert_response :ok
+
+    get :show
+
+    assert_response :ok
+  end
+
+  def test_only_actions
+    get :create, something: 123
+
+    assert_response :ok
+
+    get :create
+
+    assert_response :ok
+  end
+end

data/test/persistent_scopes_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class HasScopesController < ApplicationController
+  persists_scopes
+
+  def index
+    render nothing: true
+  end
+
+  private
+
+  def current_scopes
+    fake_scopes
+  end
+
+  def fake_scopes
+    params.select{ |key, _| key == 'a_scope' } || {}
+  end
+end
+
+class PersistentScopesTest < ActionController::TestCase
+  tests HasScopesController
+
+  def test_saves_scopes
+    get :index, a_scope: 123
+
+    assert_response :ok
+
+    get :index
+
+    assert_response :found
+    assert_redirected_to(controller: :has_scopes, action: :index, a_scope: 123)
+  end
+
+  def test_ignores_another_arguments
+    get :index, not_a_scope: 123
+
+    assert_response :ok
+
+    get :index
+
+    assert_response :ok
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+require 'minitest/autorun'
+
+# Configure Rails
+ENV['RAILS_ENV'] = 'test'
+
+require 'action_controller'
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'persistent_params'
+
+PersistentParams::Routes = ActionDispatch::Routing::RouteSet.new
+PersistentParams::Routes.draw do
+  get '/:controller(/:action(/:id))'
+end
+
+class ApplicationController < ActionController::Base
+  include PersistentParams::Routes.url_helpers
+end
+
+class ActiveSupport::TestCase
+  self.test_order = :random if respond_to?(:test_order=)
+
+  setup do
+    @routes = PersistentParams::Routes
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: persistent_params
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Diego Aguir Selzlein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Persist your params in session so they are used the next time you call
+  the same controller/action. Works with HasScope.
+email: diego.selzlein@unila.edu.br
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/persistent_params.rb
+- persistent_params.gemspec
+- test/persistent_params_test.rb
+- test/persistent_scopes_test.rb
+- test/test_helper.rb
+homepage: http://github.com/nerde/persistent_params
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Persist params by controller/action
+test_files: []