testy_cookie 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 384c7f2580df5b1770079715553e53e3b70b086b926ffd041a048b3d29b4ba86
+  data.tar.gz: 63ae8ea44b06a00779f96fe6e8a90bb10296efdde57f54501d1d24d08c543945
+SHA512:
+  metadata.gz: b5357627e4477c395d3373cfae8b8bdd39c6c94b26e7d6c10867acff294bf0f586fef2d40319980d3e8cd9a8ed78005eb19fd2a7b48336903b524e7bb638aadd
+  data.tar.gz: 690bb781ff91473eb1b8b96a7d7e28a1208472acd775650477066921d6317c6b8fa20c3575b73e4c4ecfcf42c9382d936d83ddf33f3054af99d7b7547f902864

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Lucas Mendelowski
+
+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,37 @@
+# TestyCookie
+
+`TestyCookie` provides a helper to access plain, permanent, signed and encrypted cookies consistently in Rails controller / integration / 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 `ActionController::TestCase` tests and RSpec controller specs (which are going to be deprecated), it's just an alias for the default `cookies` method.
+
+## Usage
+
+Inside your controller / integration / request test, call `cookies_jar` helper to access cookies jar:
+
+```ruby
+cookies_jar.encrypted[:key]
+cookies_jar.signed[:key] = value
+cookies_jar.signed.encrypted.permanent[:key] = value
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "testy_cookie"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.expand_path("test", __dir__))
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rails/plugin/test"
+
+task :test_dummy do
+  Dir.chdir("test/dummy") do
+    system "bin/rake test"
+  end
+end
+
+Rake::Task[:test].enhance [:test_dummy]
+
+task default: :test

data/lib/testy_cookie/helper.rb

@@ -0,0 +1,8 @@
+module TestyCookie
+  module Helper
+    def cookies_jar
+      @cookies_jar ||= Jar.new(self)
+      @cookies_jar.cookies
+    end
+  end
+end

data/lib/testy_cookie/jar.rb

@@ -0,0 +1,52 @@
+module TestyCookie
+  class Jar
+    # @param context [ActionController::TestCase, ActionDispatch::IntegrationTest, RSpec::ExampleGroup] the test context
+    def initialize(context)
+      @context = context
+    end
+
+    # @return [ActionDispatch::Cookies::CookieJar] the cookie jar to use
+    def cookies
+      if @context.cookies.is_a?(ActionDispatch::Cookies::CookieJar)
+        @context.cookies
+      else
+        Proxy.new(response_cookies || request_cookies, @context.cookies, nil)
+      end
+    end
+
+    private
+
+    def request
+      # Memoize the request object until the next request is made and cookies jar needs to be reevaluated
+      if @request != @context.request
+        @request = @context.request
+        @request_cookies = nil
+      end
+
+      @request
+    end
+
+    def request_cookies
+      @request_cookies ||= ActionDispatch::Request.new(Rails.application.env_config.deep_dup).cookie_jar
+    end
+
+    def response
+      # Memoize the response object until the next request is made and cookies jar needs to be reevaluated
+      if @response != @context.response
+        @response = @context.response
+        @response_cookies = nil
+      end
+
+      @response
+    end
+
+    def response_cookies
+      return unless response.present?
+      # We need to check for `path_parameters` in request because controller tests initialize
+      # request and response objects before the actual controller action is called.
+      return unless request&.path_parameters.present?
+
+      @response_cookies ||= ActionDispatch::Cookies::CookieJar.build(request, @context.cookies.to_hash)
+    end
+  end
+end

data/lib/testy_cookie/proxy.rb

@@ -0,0 +1,45 @@
+module TestyCookie
+  # Proxy for propagating cookie changes to `Rack::Test::CookieJar`
+  class Proxy < SimpleDelegator
+    # @param cookies [ActionDispatch::Cookies::CookieJar] the cookie jar to delegate to
+    # @param raw_cookies [Rack::Test::CookieJar] the cookies to propagate changes to
+    # @param parent [Proxy, nil] the parent proxy to chain cookie operations
+    def initialize(cookies, raw_cookies, parent)
+      super(cookies)
+      @parent = parent
+      @raw_cookies = raw_cookies
+    end
+
+    # @param key [String] the cookie key
+    # @param value [String] the cookie value
+    def []=(key, value)
+      super
+      assign(key)
+    end
+
+    # @return [Proxy] proxy to the encrypted cookie jar
+    def encrypted
+      self.class.new(__getobj__.encrypted, @raw_cookies, self)
+    end
+
+    # @return [Proxy] proxy to the permanent cookie jar
+    def permanent
+      self.class.new(__getobj__.permanent, @raw_cookies, self)
+    end
+
+    # @return [Proxy] proxy the signed cookie jar
+    def signed
+      self.class.new(__getobj__.signed, @raw_cookies, self)
+    end
+
+    protected
+
+    def assign(key)
+      if @parent.present?
+        @parent.assign(key)
+      else
+        @raw_cookies[key] = __getobj__[key]
+      end
+    end
+  end
+end

data/lib/testy_cookie/railtie.rb

@@ -0,0 +1,14 @@
+module TestyCookie
+  class Railtie < ::Rails::Railtie
+    initializer "testy_cookie.add_helpers" do
+      ActiveSupport::TestCase.send(:include, TestyCookie::Helper)
+
+      if defined?(RSpec) && RSpec.respond_to?(:configure)
+        RSpec.configure do |config|
+          config.include TestyCookie::Helper, type: :controller
+          config.include TestyCookie::Helper, type: :request
+        end
+      end
+    end
+  end
+end

data/lib/testy_cookie/version.rb

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

data/lib/testy_cookie.rb

@@ -0,0 +1,8 @@
+require "testy_cookie/helper"
+require "testy_cookie/jar"
+require "testy_cookie/proxy"
+require "testy_cookie/railtie"
+require "testy_cookie/version"
+
+module TestyCookie
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: testy_cookie
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lucas Mendelowski
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-02-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: |-
+  TestyCookie provides a helper to access plain, permanent, signed and encrypted cookies
+  in Rails controller / integration / request tests.
+email:
+- lucas@mendelowski.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/testy_cookie.rb
+- lib/testy_cookie/helper.rb
+- lib/testy_cookie/jar.rb
+- lib/testy_cookie/proxy.rb
+- lib/testy_cookie/railtie.rb
+- lib/testy_cookie/version.rb
+homepage: https://github.com/lcmen/testy_cookie
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lcmen/testy_cookie
+  source_code_uri: https://github.com/lcmen/testy_cookie
+  changelog_uri: https://github.com/lcmen/testy_cookie/blob/main/CHANGELOG.md
+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: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Helpers for accessing cookies in Rails tests.
+test_files: []