remember_params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce94a13aeb7b7d71f7e6dddd562749a05319447c
+  data.tar.gz: 01df42f09a70c39bb44467bd2478dcef55dd7632
+SHA512:
+  metadata.gz: ffdef6b59164004d10f2be067f6780ffbb934afc94147bc358cf783681afa16263461604d805c6e739cbb3721b085f0353bbc040cd663e40ba51416e52e18610
+  data.tar.gz: 2f78cb364d9ab9130c371f79ff187b9a20c1bf92c60dcc21c085ba577466d3cca71eeb6b627731e49825ee32728f14c55ba0211daa5b7c833559faee58b6965f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Johannes Treitz
+
+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,54 @@
+# RememberParams
+Rails gem that makes actions remembers GET params like keywords and page.
+
+## Scenario
+
+Say you have that index action where you can search, filter and
+paginate through records. Once you click on one of the records
+you lose track of the exact location (that is search keywords,
+filter settings and page).
+
+RememberParams will bring users back to that location when they
+return to the index page by remembering the search keywords,
+filter settings and page.
+
+## Usage
+
+To make a controller action remember its params simply add the
+`remember_params` line on top like this:
+
+```ruby
+class BooksController < ApplicationController
+  remember_params :keywords, :page # defaults are index and 1 hour
+  remember_params :client_id, on: :client_list, for: 1.minute
+end
+```
+
+Browsing the action without any params will automatically try to restore
+params and redirect to the same location but with previously set params.
+
+To reset params set them to empty string:
+
+```ruby
+link_to 'Books', books_path(keywords: '', page: '')
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'remember_params'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install remember_params
+```
+
+## 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,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RememberParams'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/remember_params.rb

@@ -0,0 +1,55 @@
+module RememberParams
+  extend ActiveSupport::Concern
+
+  included do
+    before_action :restore_or_save_params
+
+    def self.remember_params(*params, on: :index, duration: 1.hour)
+      on = on.to_s
+
+      raise '[remember_params] must specify one or more params to remember' if
+        params.empty?
+      raise '[remember_params] param name remembered_at is reserved' if
+        params.include? :remembered_at
+      raise '[remember_params] \'for\' must be ActiveSupport::Duration' unless
+        duration.is_a?(ActiveSupport::Duration)
+      raise '[remember_params] \'for\' must be gte 1 second' unless
+        duration >= 1.second
+
+      cattr_accessor :remember_params_config
+      self.remember_params_config ||= {}
+      self.remember_params_config[on] = {}
+      self.remember_params_config[on][:params] = params
+      self.remember_params_config[on][:duration] = duration
+
+      self.before_action :restore_or_save_params
+    end
+  end
+
+  def restore_or_save_params
+    return unless request.get?
+    return unless respond_to? :remember_params_config
+    return unless config = self.remember_params_config[action_name]
+
+    session[:remembered_params] ||= {}
+    key = params.slice(:controller, :action).values.join('/').parameterize
+    params_to_remember = params.permit(*config[:params]).to_h
+
+    # Restore params
+    if params_to_remember.empty? &&
+      session[:remembered_params][key]&.except('remembered_at')&.select{|_,v| v.present?}&.any? &&
+      DateTime.parse(session[:remembered_params][key]['remembered_at']) >
+        (DateTime.now - config[:duration])
+    then
+      redirect_to params: session[:remembered_params][key].except('remembered_at')
+    end
+
+    # Save params (also refreshes remembered_at after restore)
+    if params_to_remember.any?
+      params_to_remember['remembered_at'] = DateTime.now
+      session[:remembered_params][key] = params_to_remember
+    end
+  end
+end
+
+ActionController::Base.send :include, RememberParams

data/lib/remember_params/version.rb

@@ -0,0 +1,3 @@
+module RememberParams
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: remember_params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johannes Treitz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-07 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: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Makes it easy to return to exact position on index pages after clicking
+  on records.
+email:
+- jotreitz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/remember_params.rb
+- lib/remember_params/version.rb
+homepage: https://github.com/crispymtn/remember_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.5.1
+signing_key: 
+specification_version: 4
+summary: Rails gem that makes actions remembers GET params like keywords and page.
+test_files: []