testy_cookie 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 384c7f2580df5b1770079715553e53e3b70b086b926ffd041a048b3d29b4ba86
-  data.tar.gz: 63ae8ea44b06a00779f96fe6e8a90bb10296efdde57f54501d1d24d08c543945
+  metadata.gz: 9058e564410e428c62d5a15b0212da57b831a9dd3d23b9657199db26501290b2
+  data.tar.gz: '078ba0cb6cea4d6f4ea85215356c338ad8cddb6d5858e0d2b59e520fdde5af9d'
 SHA512:
-  metadata.gz: b5357627e4477c395d3373cfae8b8bdd39c6c94b26e7d6c10867acff294bf0f586fef2d40319980d3e8cd9a8ed78005eb19fd2a7b48336903b524e7bb638aadd
-  data.tar.gz: 690bb781ff91473eb1b8b96a7d7e28a1208472acd775650477066921d6317c6b8fa20c3575b73e4c4ecfcf42c9382d936d83ddf33f3054af99d7b7547f902864
+  metadata.gz: 2da1663b2b3d7336b510dbbcd362477b7c6240d7a059f1f46e9996b1fbf2b732f44d2b20d0bcd3fbf5a000807ea1cab4c9fa269201e014f4f57100fa01d55a97
+  data.tar.gz: d8689d075e88e0289364564ad5eb84f0627d7cb8692c8dd67fd3bec8ec71b1656796431c3ab93a0189b0c4bc92d0e67fc95792bc877484ce2588d2aee2cfb2d2

data/README.md

@@ -1,21 +1,21 @@
 # TestyCookie
 
-`TestyCookie` provides a helper to access plain, permanent, signed and encrypted cookies consistently in Rails controller / integration / request tests.
+`TestyCookie` gem provides a helper for accessing plain, permanent, signed, and encrypted cookies in Rails controller, integration, and request tests.
 
 ## Why do I need a custom helper?
 
-`ActionDispatch::IntegrationTest` based tests and RSpec request specs do not provide `encrypted`, `permanent` and `signed` stores on the default `cookies` jar. `TestyCookie` workaround it by initializing `ActionDispatch::Cookies::CookieJar` instance and propagating all changes back to the original `cookies` object (`Rack::Test::CookieJar` instance).
+In Rails, `ActionDispatch::IntegrationTest` based tests and RSpec request specs do not provide `encrypted`, `permanent` and `signed` stores when the default `cookies` helper is used (it returns `Rack::Test::CookieJar` instance). `TestyCookie` resolves this limitation by initializing a proper `ActionDispatch::Cookies::CookieJar` instance which support these stores. The included helper also propagates any changes back to the original `Rack::Test::CookieJar` instance making them correctly read in application controllers.
 
-In `ActionController::TestCase` tests and RSpec controller specs (which are going to be deprecated), it's just an alias for the default `cookies` method.
+In `ActionController::TestCase` tests and RSpec controller specs, `cookie_jar` serves as an alias for the default `cookies` method which returns `ActionDispatch::Cookies::CookieJar` instance correctly.
 
 ## Usage
 
-Inside your controller / integration / request test, call `cookies_jar` helper to access cookies jar:
+Inside your controller / integration / request test, call `cookie_jar` helper to access cookies:
 
 ```ruby
-cookies_jar.encrypted[:key]
-cookies_jar.signed[:key] = value
-cookies_jar.signed.encrypted.permanent[:key] = value
+cookie_jar.encrypted[:key]
+cookie_jar.signed[:key] = value
+cookie_jar.signed.encrypted.permanent[:key] = value
 ```
 
 ## Installation

data/Rakefile

@@ -10,6 +10,9 @@ task :test_dummy do
   end
 end
 
-Rake::Task[:test].enhance [:test_dummy]
+task :test_all do
+  Rake::Task["test"].invoke
+  Rake::Task[:test_dummy].invoke
+end
 
-task default: :test
+task default: :test_all

data/lib/testy_cookie/helper.rb

@@ -1,8 +1,16 @@
 module TestyCookie
   module Helper
+    def cookie_jar
+      @_testy_cookie_cookie_jar ||= Jar.new(self)
+      @_testy_cookie_cookie_jar.cookies
+    end
+
     def cookies_jar
-      @cookies_jar ||= Jar.new(self)
-      @cookies_jar.cookies
+      DEPRECATOR.warn(<<~MSG.squish.freeze)
+        `cookies_jar` is deprecated and will be removed in the next major version. Please use `cookie_jar` instead.
+      MSG
+
+      cookie_jar
     end
   end
 end

data/lib/testy_cookie/railtie.rb

@@ -10,5 +10,9 @@ module TestyCookie
         end
       end
     end
+
+    initializer "testy_cookie.deprecator" do |app|
+      app.deprecators[:testy_cookie] = DEPRECATOR
+    end
   end
 end

data/lib/testy_cookie/version.rb

@@ -1,3 +1,3 @@
 module TestyCookie
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/testy_cookie.rb

@@ -5,4 +5,5 @@ require "testy_cookie/railtie"
 require "testy_cookie/version"
 
 module TestyCookie
+  DEPRECATOR = ActiveSupport::Deprecation.new("2.0", "TestyCookie")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testy_cookie
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Lucas Mendelowski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-22 00:00:00.000000000 Z
+date: 2024-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails