sticky_params 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9038e51804afe83d423ecc4b4903df48a31fd04923a2ba0e966589ebbbd45585
-  data.tar.gz: fad2fdf5976803a1f4ca0bc4c913ea410a85bd0ded788886b7400b7744d8fca4
+  metadata.gz: dd99a57715a3846a6f11b9e4922883177861cececfa89b11c815db6d1723d8f1
+  data.tar.gz: 2ccceedbeeecd024d6074ea9ba02c2d52b9385983392a11cd23a6f4317275ce5
 SHA512:
-  metadata.gz: 76ee65c4c4889c7e54e3310a0f16bcee2414d98ab79353be63e12685c30b2df98b7971bf8f311ed24d9b5f144b276ba563ed69c695e877e2f56762b3be4e246b
-  data.tar.gz: 273163c5f66741711f666326b3960bb120ee657f880a1868eedea7cdc847112cf9152cf5dcf0d50276f6d79b13eff41cffece3c563b24eb849d1b15ac55edbd3
+  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
@@ -12,13 +12,20 @@ class MyController < ApplicationController
 end
 ```
 
-## Release Notes 2.0
+## Release Notes 2.1
 
-Release 2.0 uses ActionController::Parameters instead of hashes.
+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 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.
+
+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,16 +1,13 @@
 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?
-        controller.session['sticky_params'][session_param_name] = controller.params[name]
+        if controller.params[name].is_a?(ActionController::Parameters)
+          controller.session['sticky_params'][session_param_name] = controller.params[name].to_unsafe_hash
+        else
+          controller.session['sticky_params'][session_param_name] = controller.params[name]
+        end
+        controller.params[name]
       else
         controller.session['sticky_params'].delete session_param_name
         nil
@@ -19,44 +16,18 @@ module StickyParams
 
     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
+      result.is_a?(Hash) ? ActionController::Parameters.new(result) : result
     end
 
     def [](name)
       session_param_name = "#{prefix}#{name}"
-      controller.session['sticky_params'] ||= ActionController::Parameters.new
+      controller.session['sticky_params'] ||= {}
       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
+end

data/lib/sticky_params/version.rb

@@ -1,3 +1,3 @@
 module StickyParams
-  VERSION = "2.0.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"
 

data/sticky_params.gemspec

@@ -1,23 +1,21 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $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.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.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"
+  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.required_ruby_version = ">= 2.0"
+  spec.require_paths         = ['lib']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sticky_params
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Rick Blommers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-29 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
@@ -32,7 +33,7 @@ homepage: https://github.com/gamecreature/sticky_params
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -40,15 +41,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.4.15
+signing_key:
 specification_version: 4
 summary: A rails gem that automaticly remembers request parameters between requests
 test_files: []