sticky_params 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44455740df636d34ee63027b34b7733b24fe241a70313533d0c698ddfa38ba87
-  data.tar.gz: cab9e1b6c9bf1a728f147abd475fba7f4aeef9c8988c990ab906e213b8fc822b
+  metadata.gz: 9038e51804afe83d423ecc4b4903df48a31fd04923a2ba0e966589ebbbd45585
+  data.tar.gz: fad2fdf5976803a1f4ca0bc4c913ea410a85bd0ded788886b7400b7744d8fca4
 SHA512:
-  metadata.gz: d2cee252c15971b0acb0891c5169f595896f8e047f5792fa3bef29dbd7fcf58b2b06fa0afd470a9cb4fd06facc67ac61e2b8044d18e7aff2c387a6236b67d0ec
-  data.tar.gz: '05283ece5a2a758f24b150b5f6bc0a38394a65902d04434a3b866bf188eeb1d72b357af2614eeaf0c2a14f6cb9bc891b05554bb39375b0ce3b870c8d64a358c7'
+  metadata.gz: 76ee65c4c4889c7e54e3310a0f16bcee2414d98ab79353be63e12685c30b2df98b7971bf8f311ed24d9b5f144b276ba563ed69c695e877e2f56762b3be4e246b
+  data.tar.gz: 273163c5f66741711f666326b3960bb120ee657f880a1868eedea7cdc847112cf9152cf5dcf0d50276f6d79b13eff41cffece3c563b24eb849d1b15ac55edbd3

data/README.md

@@ -1,7 +1,7 @@
 # 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
@@ -12,6 +12,20 @@ class MyController < ApplicationController
 end
 ```
 
+## Release Notes 2.0
+
+Release 2.0 uses ActionController::Parameters instead of hashes.
+This enable the usage of the strong parameter permit construct.
+(In other words, sticky_params will work just like normal params)
+
+To get the 1.0 behaviour, you can add the following to your ApplicationController.
+
+```ruby
+  def sticky_params
+    @sticky_params ||= ::StickyParams::SessionParams.new(self)
+  end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,7 +37,7 @@ gem 'sticky_params'
 And then execute:
 
 ```bash
-    $ bundle
+bundle
 ```
 
 ## Usage
@@ -75,16 +89,14 @@ 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.
+the normal parameters. When it's found in the parameters, it stores the result in the sticky_params storage.
+If the parameter isn't in the normal aparameters 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.
@@ -116,12 +128,12 @@ class UsersController < ApplicationController
 end
 ```
 
-For the lazy developer:
+For the lazy developers.
 you could force the reset parameter to always work in your application.
 
 ```ruby
 class ApplicationController < ActionController::Base
-  before_filter :sticky_params_reset
+  before_action :sticky_params_reset
 
 protected:
   def sticky_params_reset

data/lib/sticky_params.rb

@@ -1,6 +1,7 @@
 require "sticky_params/version"
 require "sticky_params/railtie" if defined?(Rails)
 require "sticky_params/session_params"
+require "sticky_params/strong_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.
@@ -18,6 +19,6 @@ 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)
+    @sticky_params ||= ::StickyParams::StrongSessionParams.new(self)
   end
 end

data/lib/sticky_params/strong_session_params.rb

@@ -0,0 +1,62 @@
+module StickyParams
+  class StrongSessionParams
+    attr_reader :controller
+    attr_accessor :prefix
+
+    def initialize(controller)
+      @controller = controller
+      @prefix = "#{controller.controller_name}_#{controller.action_name}_"
+    end
+
+    def fetch_from_params(name, session_param_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
+    end
+
+    def fetch_from_session(session_param_name)
+      result = controller.session['sticky_params'][session_param_name]
+
+      # covert hash to action parameters for simulating a normal param
+      if result.is_a?(Hash)
+        result = ActionController::Parameters.new(result)
+        controller.session['sticky_params'][session_param_name] = result
+      end
+
+      result
+    end
+
+    def [](name)
+      session_param_name = "#{prefix}#{name}"
+      controller.session['sticky_params'] ||= ActionController::Parameters.new
+      if controller.params[name]
+        fetch_from_params(name, session_param_name)
+      elsif controller.session['sticky_params'][session_param_name]
+        fetch_from_session(session_param_name)
+      end
+    end
+
+    def []=(name, value)
+      session_param_name = "#{prefix}#{name}"
+      controller.session['sticky_params'] ||= ActionController::Parameters.new
+      controller.session['sticky_params'][session_param_name] = controller.params[name] = value
+    end
+
+    # 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
+        end
+      end
+    end
+
+    # clears all sticky parameters
+    def clear_all!
+      controller.session.delete('sticky_params')
+    end
+  end
+end

data/lib/sticky_params/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sticky_params
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Rick Blommers
@@ -25,6 +25,7 @@ files:
 - lib/sticky_params.rb
 - lib/sticky_params/railtie.rb
 - lib/sticky_params/session_params.rb
+- lib/sticky_params/strong_session_params.rb
 - lib/sticky_params/version.rb
 - sticky_params.gemspec
 homepage: https://github.com/gamecreature/sticky_params