sticky_params 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13294e2e60564fda27ffa1ead2f59cccbbf6af95
+  data.tar.gz: 8775f676a8991a9a294a0edb441cd6f3bd9258e6
+SHA512:
+  metadata.gz: 74ade0f427847a50dc1b67fab75e9fa5caa52e77be70e0c06ecce28a9d3f9f6c5387cc29d4872df33b9c2015fa2e767a3f7e1ade07180f61e6b45c2d8d904752
+  data.tar.gz: c971993f6172b86b0c202334ee4d364eb356f9d37ff82d701aba84c7aae0bf65ec9bf7b9f00003e25a292976a25caa169d822a19455a105d240ed6acc5ada273

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Rick Blommers
+
+MIT License
+
+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,141 @@
+# 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. 
+
+```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:
+
+```ruby
+gem 'sticky_params'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+Just start using it, by simply replacing the normal params call with a sticky_params call:
+
+```ruby
+class MyController < ApplicationController
+	
+  def index
+    @order = sticky_params[:order]
+    @q  = sticky_params[:q]
+  end
+
+end
+```
+
+You can also store stuff in the sticky params hash
+
+```ruby
+sticky_params["keyname"] = "value"
+```
+
+
+### Remove sticky stuff
+
+Sticky parameters can be removed one by one, by simply passing a empty string.
+
+```ruby
+sticky_params[:order] = ""  # removes the keyname order from the session
+```
+
+To remove all sticky stuff for the current controller/action you can simply call clear!
+
+```ruby
+sticky_params.clear!
+```
+
+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! 
+```
+
+
+
+### 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_" 
+
+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
+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' .
+
+
+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. 
+
+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 )
+```
+
+Normal links, for example the list button in the user screen
+```ruby
+= link_to "Users", users_path 
+```
+
+In the controller the index action is implemented like this
+
+```ruby
+class UsersController < ApplicationController
+
+	def index
+		sticky_params.reset! if params[:reset]
+
+		@order = sticky_params[:order]
+		@page = sticky_params[:page]
+
+		# ... other fancy controller stuf ...
+	end
+
+end
+```
+
+For the lazy developer:
+you could force the reset parameter to always work in your application.
+
+```ruby
+class ApplicationController < ActionController::Base
+	before_filter :sticky_params_reset
+	
+protected:
+	def sticky_params_reset
+		sticky_params.reset! if params[:reset]
+	end
+end
+```
+
+have fun ;)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sticky_params.rb

@@ -0,0 +1,29 @@
+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.
+#
+# When the param isn't supplied it tries to recieve it from the session.
+#
+# 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>  
+#   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

data/lib/sticky_params/railtie.rb

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

@@ -0,0 +1,57 @@
+module StickyParams
+
+  class SessionParams
+
+    attr_reader :controller
+    attr_accessor :prefix
+    
+
+    def initialize( controller )
+      @controller = controller 
+      @prefix = "#{controller.controller_name}_#{controller.action_name}_"
+    end
+
+
+    def [](name)
+      session_param_name = "#{prefix}#{name}"
+      controller.session['sticky_params'] ||= {}
+      if controller.params[name]
+        if controller.params[name].present?
+          controller.session['sticky_params'][session_param_name] = controller.params[name]
+        else
+          controller.session['sticky_params'].delete session_param_name
+          nil
+        end
+      elsif controller.session['sticky_params'][session_param_name]
+        controller.session['sticky_params'][session_param_name]
+      else
+        nil
+      end
+    end
+
+
+    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
+    def clear!
+      if controller.session['sticky_params'].present?
+        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') 
+    end
+
+  end
+
+end

data/lib/sticky_params/version.rb

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

data/sticky_params.gemspec

@@ -0,0 +1,24 @@
+# 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.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.description   = spec.summary
+  spec.homepage      = "https://github.com/gamecreature/sticky_params"
+  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.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: sticky_params
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+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'
+description: A rails gem that automaticly remembers request parameters between requests
+email:
+- rick@blommersit.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sticky_params.rb
+- lib/sticky_params/railtie.rb
+- lib/sticky_params/session_params.rb
+- lib/sticky_params/version.rb
+- sticky_params.gemspec
+homepage: https://github.com/gamecreature/sticky_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
+signing_key: 
+specification_version: 4
+summary: A rails gem that automaticly remembers request parameters between requests
+test_files: []