sticky_params 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95f2ebe1001e88bac518483e27d299e187c09e5f5002516bee8ce2e259222a75
-  data.tar.gz: df3e8ea4586ddd41cc7b759051f51077910d4a6629637e0d0b9586d8cb92f26e
+  metadata.gz: dd99a57715a3846a6f11b9e4922883177861cececfa89b11c815db6d1723d8f1
+  data.tar.gz: 2ccceedbeeecd024d6074ea9ba02c2d52b9385983392a11cd23a6f4317275ce5
 SHA512:
-  metadata.gz: cbe4b35d6555c246096d4a90fe404eb2f340336646e30d4e5dde718e3ddfaf17488387f2246775f7a1f4dba2efd5737223a97e68ce3eb18ecc5df5f63374ed69
-  data.tar.gz: 1e3d546c073fd3e29ca6578ab6c6776d80d905efcf68a6a45092fed579b16053dc61ee7ad899c43e79eda135d6e85f5d3774edcd86f1dd514c358253054c6608
+  metadata.gz: 163f301446312d74547fb8c31d5cc986ae12a01c611620104c9109a733f33af70e2123e69024a1c7b8312bb30976a87b357791d09e3fe6d05a96784067fb399b
+  data.tar.gz: 262fe467d410e449540c10605450f3bb0b839ecd73330f0d1fe1b77ae3d4a8dda5e2a4daac0661a709684e151075a65257f34ac7add620ffea637d92cdfe926b

data/README.md

@@ -1,6 +1,6 @@
 # StickyParams
 
-A little gem that automaticly remembers the request parameters between requests without hassle.
+A little gem that automatically 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
@@ -14,8 +14,10 @@ end
 
 ## Release Notes 2.1
 
+Release 2.1.1, Add the method `with_prefix`, to invoke a block of code with another sticky_params prefix.
+It also deduplicates code by moving it to the `StickyParams::BaseParams` class.
 
-Release 2.1, Sticky Params doesn't put ActionController::Parameters in a sesssion anymore.
+Release 2.1, Sticky Params doesn't put ActionController::Parameters in a session anymore.
 ActionController::Parameters were put directly into a session in 2.0. Which worked in rails < 7.
 In rails 7 this results in a `TypeError (can't dump IO)` when the session data is serialized.
 
@@ -23,7 +25,7 @@ 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.
+To get the 1.0 behavior, you can add the following to your ApplicationController.
 
 ```ruby
   def sticky_params

data/lib/sticky_params/base_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module StickyParams
+  class BaseParams
+    attr_reader :controller
+    attr_accessor :prefix
+
+    def initialize(controller)
+      @controller = controller
+      @prefix = "#{controller.controller_name}_#{controller.action_name}_"
+    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 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
+
+    # invokes the given block with another sticky_params prefix
+    # (accessing other session-params withing the block)
+    def with_prefix(new_prefix, &)
+      old_prefix = prefix
+      begin
+        self.prefix = new_prefix
+        yield self
+      ensure
+        self.prefix = old_prefix
+      end
+    end
+  end
+end

data/lib/sticky_params/session_params.rb

@@ -1,13 +1,5 @@
 module StickyParams
-  class SessionParams
-    attr_reader :controller
-    attr_accessor :prefix
-
-    def initialize(controller)
-      @controller = controller
-      @prefix = "#{controller.controller_name}_#{controller.action_name}_"
-    end
-
+  class SessionParams < BaseParams
     def [](name)
       session_param_name = "#{prefix}#{name}"
       controller.session['sticky_params'] ||= {}
@@ -22,25 +14,5 @@ module StickyParams
         controller.session['sticky_params'][session_param_name]
       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 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/strong_session_params.rb

@@ -1,13 +1,5 @@
 module StickyParams
-  class StrongSessionParams
-    attr_reader :controller
-    attr_accessor :prefix
-
-    def initialize(controller)
-      @controller = controller
-      @prefix = "#{controller.controller_name}_#{controller.action_name}_"
-    end
-
+  class StrongSessionParams < BaseParams
     def fetch_from_params(name, session_param_name)
       if controller.params[name].present?
         if controller.params[name].is_a?(ActionController::Parameters)
@@ -37,25 +29,5 @@ module StickyParams
         fetch_from_session(session_param_name)
       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 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 = "2.1.0"
+  VERSION = "2.1.1"
 end

data/lib/sticky_params.rb

@@ -1,5 +1,6 @@
 require "sticky_params/version"
 require "sticky_params/railtie" if defined?(Rails)
+require "sticky_params/base_params"
 require "sticky_params/session_params"
 require "sticky_params/strong_session_params"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sticky_params
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Rick Blommers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-09 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies: []
 description: A rails gem that automaticly remembers request parameters between requests
 email:
@@ -23,6 +23,7 @@ files:
 - README.md
 - Rakefile
 - lib/sticky_params.rb
+- lib/sticky_params/base_params.rb
 - lib/sticky_params/railtie.rb
 - lib/sticky_params/session_params.rb
 - lib/sticky_params/strong_session_params.rb
@@ -47,7 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: A rails gem that automaticly remembers request parameters between requests