sticky_params 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 13294e2e60564fda27ffa1ead2f59cccbbf6af95
-  data.tar.gz: 8775f676a8991a9a294a0edb441cd6f3bd9258e6
+SHA256:
+  metadata.gz: 44455740df636d34ee63027b34b7733b24fe241a70313533d0c698ddfa38ba87
+  data.tar.gz: cab9e1b6c9bf1a728f147abd475fba7f4aeef9c8988c990ab906e213b8fc822b
 SHA512:
-  metadata.gz: 74ade0f427847a50dc1b67fab75e9fa5caa52e77be70e0c06ecce28a9d3f9f6c5387cc29d4872df33b9c2015fa2e767a3f7e1ade07180f61e6b45c2d8d904752
-  data.tar.gz: c971993f6172b86b0c202334ee4d364eb356f9d37ff82d701aba84c7aae0bf65ec9bf7b9f00003e25a292976a25caa169d822a19455a105d240ed6acc5ada273
+  metadata.gz: d2cee252c15971b0acb0891c5169f595896f8e047f5792fa3bef29dbd7fcf58b2b06fa0afd470a9cb4fd06facc67ac61e2b8044d18e7aff2c387a6236b67d0ec
+  data.tar.gz: '05283ece5a2a758f24b150b5f6bc0a38394a65902d04434a3b866bf188eeb1d72b357af2614eeaf0c2a14f6cb9bc891b05554bb39375b0ce3b870c8d64a358c7'

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Rick Blommers
+Copyright (c) 2015-2020 Rick Blommers
 
 MIT License
 

data/README.md

@@ -1,20 +1,17 @@
 # StickyParams
 
 A little gem that automaticly remembers the request parameters between requests without hassle.
-For example for remembering the filtering and sorting of a list,  when switching to a detail screen and back. 
+For example for remembering the filtering and sorting of a list,  when switching to a detail screen and back.
 
 ```ruby
 class MyController < ApplicationController
-	
   def index
     @order = sticky_params[:order]
     @q  = sticky_params[:q]
   end
-
 end
 ```
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,8 +22,9 @@ gem 'sticky_params'
 
 And then execute:
 
+```bash
     $ bundle
-
+```
 
 ## Usage
 
@@ -34,12 +32,10 @@ Just start using it, by simply replacing the normal params call with a sticky_pa
 
 ```ruby
 class MyController < ApplicationController
-	
   def index
     @order = sticky_params[:order]
     @q  = sticky_params[:q]
   end
-
 end
 ```
 
@@ -49,7 +45,6 @@ You can also store stuff in the sticky params hash
 sticky_params["keyname"] = "value"
 ```
 
-
 ### Remove sticky stuff
 
 Sticky parameters can be removed one by one, by simply passing a empty string.
@@ -64,21 +59,20 @@ To remove all sticky stuff for the current controller/action you can simply call
 sticky_params.clear!
 ```
 
-To remove all sticky stuff, for every action/controller you can use clear_all! 
+To remove all sticky stuff, for every action/controller you can use clear_all!
 But probably you don't want this ;)
+
 ```ruby
-sticky_params.clear_all! 
+sticky_params.clear_all!
 ```
 
-
-
 ### Inner workings
 
 Sticky params are stored in the session storage. They are stored in a
 session variable named 'sticky_params'.
 
 This session variable is a hash and it uses a prefix for storing the variables.
-By default the prefix is "controller_action_" 
+By default the prefix is "controller_action_"
 
 When retrieving a parameter from sticky_params it first tries to retrieve it from
 the normal params hash. When it's in the params hash, it stores the result in the
@@ -86,7 +80,6 @@ sticky_params hash.
 If the parameter isn't in the normal params hash it does a lookup in the session hash.
 Pretty simple.
 
-
 ## Common Pattern
 
 A pattern I used often with sticky_params, is using a request parameter 'reset' .
@@ -94,33 +87,32 @@ A pattern I used often with sticky_params, is using a request parameter 'reset'
 
 For example for a basic rest controller, I have an index action which shows all users.
 The list of users is sortable, searchable and paged. When selecting a user in this table
-I goto the user screen. When going back I want my selection to persist. 
+I goto the user screen. When going back I want my selection to persist.
 
 But when I enter the users index screen from my application-menu, I want to reset all my
 filters. I supply a parameter reset:
+
 ```ruby
-= link_to "Users", users_path( reset: 1 )
+link_to("Users", users_path(reset: 1))
 ```
 
 Normal links, for example the list button in the user screen
+
 ```ruby
-= link_to "Users", users_path 
+link_to("Users", users_path)
 ```
 
 In the controller the index action is implemented like this
 
 ```ruby
 class UsersController < ApplicationController
+  def index
+    sticky_params.clear! if params[:reset]
 
-	def index
-		sticky_params.reset! if params[:reset]
-
-		@order = sticky_params[:order]
-		@page = sticky_params[:page]
-
-		# ... other fancy controller stuf ...
-	end
-
+    @order = sticky_params[:order]
+    @page = sticky_params[:page]
+    # ... other fancy controller stuf ...
+  end
 end
 ```
 
@@ -129,12 +121,12 @@ you could force the reset parameter to always work in your application.
 
 ```ruby
 class ApplicationController < ActionController::Base
-	before_filter :sticky_params_reset
-	
+  before_filter :sticky_params_reset
+
 protected:
-	def sticky_params_reset
-		sticky_params.reset! if params[:reset]
-	end
+  def sticky_params_reset
+    sticky_params.clear! if params[:reset]
+  end
 end
 ```
 

data/lib/sticky_params/railtie.rb

@@ -1,11 +1,7 @@
 module StickyParams
-
   class Railtie < Rails::Railtie
-
     initializer "sticky_params.add_controller_extenion" do
       ActionController::Base.send :include, StickyParams
     end
-
   end
-
 end

data/lib/sticky_params/session_params.rb

@@ -1,17 +1,13 @@
 module StickyParams
-
   class SessionParams
-
     attr_reader :controller
     attr_accessor :prefix
-    
 
-    def initialize( controller )
-      @controller = controller 
+    def initialize(controller)
+      @controller = controller
       @prefix = "#{controller.controller_name}_#{controller.action_name}_"
     end
 
-
     def [](name)
       session_param_name = "#{prefix}#{name}"
       controller.session['sticky_params'] ||= {}
@@ -24,34 +20,27 @@ module StickyParams
         end
       elsif controller.session['sticky_params'][session_param_name]
         controller.session['sticky_params'][session_param_name]
-      else
-        nil
       end
     end
 
-
-    def []=(name,value)
+    def []=(name, value)
       session_param_name = "#{prefix}#{name}"
       controller.session['sticky_params'] ||= {}
       controller.session['sticky_params'][session_param_name] = controller.params[name] = value
     end
 
-
-    # clears all sticky params for the given controller/action name
+    # clears all sticky params for the current controller/action name
     def clear!
       if controller.session['sticky_params'].present?
-        controller.session['sticky_params'].reject! do |key,value|
-          key.index( prefix ) == 0
+        controller.session['sticky_params'].reject! do |key, _value|
+          key.index(prefix) == 0
         end
       end
     end
 
-
     # clears all sticky parameters
     def clear_all!
-      controller.session.delete('sticky_params') 
+      controller.session.delete('sticky_params')
     end
-
   end
-
 end

data/lib/sticky_params/version.rb

@@ -1,3 +1,3 @@
 module StickyParams
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/sticky_params.rb

@@ -2,8 +2,6 @@ require "sticky_params/version"
 require "sticky_params/railtie" if defined?(Rails)
 require "sticky_params/session_params"
 
-
-# 
 # Sticky Parameters is a nice hack that allows the 'remembering' a given param
 # between page requests. When a param is supplied it is stored in a session.
 #
@@ -12,18 +10,14 @@ require "sticky_params/session_params"
 # When an 'empty-string' is supplied as param, the sticky_param is removed
 #
 # Use it the following way. Simply use sticky_params in stead of params
-# <pre>  
+# <pre>
 #   selection = sticky_params[:name]
 # </pre>
-#
 
 module StickyParams
-
-
   # A sicky parameter is a parameter that 'keeps' it state between pages,
   # by storing the data in a session
   def sticky_params
     @sticky_params ||= ::StickyParams::SessionParams.new(self)
   end
-
-end
+end

data/sticky_params.gemspec

@@ -1,24 +1,23 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'sticky_params/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sticky_params"
+  spec.name          = 'sticky_params'
   spec.version       = StickyParams::VERSION
 
-  spec.authors       = ["Rick Blommers"]
-  spec.email         = ["rick@blommersit.nl"]
-  spec.summary       = "A rails gem that automaticly remembers request parameters between requests"
+  spec.authors       = ['Rick Blommers']
+  spec.email         = ['rick@blommersit.nl']
+  spec.summary       = 'A rails gem that automaticly remembers request parameters between requests'
   spec.description   = spec.summary
   spec.homepage      = "https://github.com/gamecreature/sticky_params"
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  # spec.add_development_dependency "bundler", "~> 1.7"
+  # spec.add_development_dependency "rake", "~> 10.0"
 end

metadata

@@ -1,43 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sticky_params
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Rick Blommers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-11 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.7'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
+date: 2020-04-29 00:00:00.000000000 Z
+dependencies: []
 description: A rails gem that automaticly remembers request parameters between requests
 email:
 - rick@blommersit.nl
@@ -74,8 +46,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: A rails gem that automaticly remembers request parameters between requests