request_store 1.4.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c517aaaa8dab4047c4aaff050b211e0ae064a17c
-  data.tar.gz: 60ca08c8030550b4b008f5af53009a50eeb32e41
+SHA256:
+  metadata.gz: e791505be9e9e0f6f8bf0b3229cb7840f473f71fdb6a4bb7f4d7375a06d11cdf
+  data.tar.gz: b8866d3e58f810f96e3ea1b4ef7b4491b69cdf0bc6df06e5610c6d8f3312e8dd
 SHA512:
-  metadata.gz: 3f7bae9168c5c94fb08a84f3ea0d2110a29853d36402b3c195e885df82ff0f0a35de0e92096732c6f20d0a233e7c32a2a91dfb142030f715e6929ee2dc943151
-  data.tar.gz: ed8c6184028da4cc114f5ad86bbf954d4a14be985df6bbe0c3fd6e81ce167f7428da53e2aa88bf5d7a4419b73c7dff7bcf865624e70861c5e1192934e599b2bc
+  metadata.gz: c76ab30766f74dda033ce70567b47df54128775dca712737a946a0c5263a7c668f3e039941efda725749070bc93745f7654f62cdccd695004f4dd84852fcb930
+  data.tar.gz: 771cc8e824566de385f8d266fe233ea43313dac648bc4d9fbbf8b7e2fe0e1cdabfc5c0633dc09c386a2966e4cccd978dc3e37d38f135574832919641861f29af

data/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  pull_request:
+
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 3.0
+          - 3.1
+          - 3.2
+          - 3.3
+          - ruby-head
+          - jruby-9.1
+          - jruby-9.2
+          - jruby-9.3
+          - jruby-head
+          - truffleruby-head
+
+    steps:
+    - uses: actions/checkout@v1
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # 'bundle install' and cache
+    - name: Test
+      run: bundle exec rake

data/.gitignore

@@ -1,17 +1,17 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -1,4 +1,13 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in request_store.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in request_store.gemspec
+gemspec
+
+case Gem::Version.new(RUBY_VERSION.dup)
+when ->(ruby_version) { ruby_version >= Gem::Version.new('2.2.0') }
+  gem 'rake', '~> 13'
+when ->(ruby_version) { ruby_version >= Gem::Version.new('2.0.0') }
+  gem 'rake', '~> 12.3.3'
+else
+  gem 'rake', '~> 11'
+end

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2012 Steve Klabnik
-
-MIT License
-
-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
+Copyright (c) 2012 Steve Klabnik
+
+MIT License
+
+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

@@ -1,137 +1,147 @@
-# RequestStore [![build status](https://travis-ci.org/steveklabnik/request_store.png?branch=master)](https://travis-ci.org/steveklabnik/request_store) [![Code Climate](https://codeclimate.com/github/steveklabnik/request_store.png)](https://codeclimate.com/github/steveklabnik/request_store)
-
-Ever needed to use a global variable in Rails? Ugh, that's the worst. If you
-need global state, you've probably reached for `Thread.current`. Like this:
-
-```ruby
-def self.foo
-  Thread.current[:foo] ||= 0
-end
-
-def self.foo=(value)
-  Thread.current[:foo] = value
-end
-```
-
-Ugh! I hate it. But you gotta do what you gotta do...
-
-### The problem
-
-Everyone's worrying about concurrency these days. So people are using those
-fancy threaded web servers, like Thin or Puma. But if you use `Thread.current`,
-and you use one of those servers, watch out! Values can stick around longer
-than you'd expect, and this can cause bugs. For example, if we had this in
-our controller:
-
-```ruby
-def index
-  Thread.current[:counter] ||= 0
-  Thread.current[:counter] += 1
-
-  render :text => Thread.current[:counter]
-end
-```
-
-If we ran this on MRI with Webrick, you'd get `1` as output, every time. But if
-you run it with Thin, you get `1`, then `2`, then `3`...
-
-### The solution
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'request_store'
-```
-
-And change the code to this:
-
-```ruby
-def index
-  RequestStore.store[:foo] ||= 0
-  RequestStore.store[:foo] += 1
-
-  render :text => RequestStore.store[:foo]
-end
-```
-
-Yep, everywhere you used `Thread.current` just change it to
-`RequestStore.store`. Now no matter what server you use, you'll get `1` every
-time: the storage is local to that request.
-
-### Rails 2 compatibility
-
-The gem includes a Railtie that will configure everything properly for Rails 3+
-apps, but if your app is tied to an older (2.x) version, you will have to
-manually add the middleware yourself.  Typically this should just be a matter
-of adding:
-
-```ruby
-config.middleware.use RequestStore::Middleware
-```
-
-into your config/environment.rb.
-
-### No Rails? No Problem!
-
-A Railtie is added that configures the Middleware for you, but if you're not
-using Rails, no biggie! Just use the Middleware yourself, however you need.
-You'll probably have to shove this somewhere:
-
-```ruby
-use RequestStore::Middleware
-```
-
-#### No Rails + Rack::Test
-
-In order to have `RequestStore` storage cleared between requests, add it to the
-`app`:
-
-```ruby
-# spec_helper.rb
-
-def app
-  Rack::Builder.new do
-    use RequestStore::Middleware
-    run MyApp
-  end
-end
-```
-
-## Using with Sidekiq
-
-This gem uses a Rack middleware to clear the store object after every request,
-but that doesn't translate well to background processing with
-[Sidekiq](https://github.com/mperham/sidekiq).
-
-A companion library,
-[request_store-sidekiq](https://rubygems.org/gems/request_store-sidekiq)
-creates a Sidekiq middleware that will ensure the store is cleared after each
-job is processed, for security and consistency with how this is done in Rack.
-
-## Semantic Versioning
-
-This project conforms to [semver](http://semver.org/). As a result of this
-policy, you can (and should) specify a dependency on this gem using the
-[Pessimistic Version Constraint](http://guides.rubygems.org/patterns/) with
-two digits of precision. For example:
-
-```ruby
-spec.add_dependency 'request_store', '~> 1.0'
-```
-
-This means your project is compatible with request_store 1.0 up until 2.0.
-You can also set a higher minimum version:
-
-```ruby
-spec.add_dependency 'request_store', '~> 1.1'
-```
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
-Don't forget to run the tests with `rake`.
+# RequestStore [![CI](https://github.com/steveklabnik/request_store/actions/workflows/ci.yml/badge.svg)](https://github.com/steveklabnik/request_store/actions/workflows/ci.yml) [![Code Climate](https://codeclimate.com/github/steveklabnik/request_store.svg)](https://codeclimate.com/github/steveklabnik/request_store)
+
+Ever needed to use a global variable in Rails? Ugh, that's the worst. If you
+need global state, you've probably reached for `Thread.current`. Like this:
+
+```ruby
+def self.foo
+  Thread.current[:foo] ||= 0
+end
+
+def self.foo=(value)
+  Thread.current[:foo] = value
+end
+```
+
+Ugh! I hate it. But you gotta do what you gotta do...
+
+### The problem
+
+Everyone's worrying about concurrency these days. So people are using those
+fancy threaded web servers, like Thin or Puma. But if you use `Thread.current`,
+and you use one of those servers, watch out! Values can stick around longer
+than you'd expect, and this can cause bugs. For example, if we had this in
+our controller:
+
+```ruby
+def index
+  Thread.current[:counter] ||= 0
+  Thread.current[:counter] += 1
+
+  render :text => Thread.current[:counter]
+end
+```
+
+If we ran this on MRI with Webrick, you'd get `1` as output, every time. But if
+you run it with Thin, you get `1`, then `2`, then `3`...
+
+### The solution
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'request_store'
+```
+
+And change the code to this:
+
+```ruby
+def index
+  RequestStore.store[:foo] ||= 0
+  RequestStore.store[:foo] += 1
+
+  render :text => RequestStore.store[:foo]
+end
+```
+
+Yep, everywhere you used `Thread.current` just change it to
+`RequestStore.store`. Now no matter what server you use, you'll get `1` every
+time: the storage is local to that request.
+
+### API
+
+The `fetch` method returns the stored value if it already exists. If no stored value exists, it uses the provided block to add a new stored value.
+
+```ruby
+top_posts = RequestStore.fetch(:top_posts) do
+  # code to obtain the top posts
+end
+```
+
+### Rails 2 compatibility
+
+The gem includes a Railtie that will configure everything properly for Rails 3+
+apps, but if your app is tied to an older (2.x) version, you will have to
+manually add the middleware yourself.  Typically this should just be a matter
+of adding:
+
+```ruby
+config.middleware.use RequestStore::Middleware
+```
+
+into your config/environment.rb.
+
+### No Rails? No Problem!
+
+A Railtie is added that configures the Middleware for you, but if you're not
+using Rails, no biggie! Just use the Middleware yourself, however you need.
+You'll probably have to shove this somewhere:
+
+```ruby
+use RequestStore::Middleware
+```
+
+#### No Rails + Rack::Test
+
+In order to have `RequestStore` storage cleared between requests, add it to the
+`app`:
+
+```ruby
+# spec_helper.rb
+
+def app
+  Rack::Builder.new do
+    use RequestStore::Middleware
+    run MyApp
+  end
+end
+```
+
+## Using with Sidekiq
+
+This gem uses a Rack middleware to clear the store object after every request,
+but that doesn't translate well to background processing with
+[Sidekiq](https://github.com/mperham/sidekiq).
+
+A companion library,
+[request_store-sidekiq](https://rubygems.org/gems/request_store-sidekiq)
+creates a Sidekiq middleware that will ensure the store is cleared after each
+job is processed, for security and consistency with how this is done in Rack.
+
+## Semantic Versioning
+
+This project conforms to [semver](http://semver.org/). As a result of this
+policy, you can (and should) specify a dependency on this gem using the
+[Pessimistic Version Constraint](http://guides.rubygems.org/patterns/) with
+two digits of precision. For example:
+
+```ruby
+spec.add_dependency 'request_store', '~> 1.0'
+```
+
+This means your project is compatible with request_store 1.0 up until 2.0.
+You can also set a higher minimum version:
+
+```ruby
+spec.add_dependency 'request_store', '~> 1.1'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Don't forget to run the tests with `rake`.

data/Rakefile

@@ -1,12 +1,12 @@
-require "bundler/gem_tasks"
-
-require 'rake/testtask'
-
-Rake::TestTask.new do |t|
-  t.libs << "lib"
-  t.test_files = FileList['test/*_test.rb']
-  t.ruby_opts = ['-r./test/test_helper.rb']
-  t.verbose = true
-end
-
-task :default => :test
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.test_files = FileList['test/*_test.rb']
+  t.ruby_opts = ['-r./test/test_helper.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/request_store/middleware.rb

@@ -1,32 +1,36 @@
-require 'rack/body_proxy'
-
-# A middleware that ensures the RequestStore stays around until
-# the last part of the body is rendered. This is useful when
-# using streaming.
-#
-# Uses Rack::BodyProxy, adapted from Rack::Lock's usage of the
-# same pattern.
-
-module RequestStore
-  class Middleware
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      RequestStore.begin!
-
-      response = @app.call(env)
-
-      returned = response << Rack::BodyProxy.new(response.pop) do
-        RequestStore.end!
-        RequestStore.clear!
-      end
-    ensure
-      unless returned
-        RequestStore.end!
-        RequestStore.clear!
-      end
-    end
-  end
-end
+require 'rack/body_proxy'
+
+# A middleware that ensures the RequestStore stays around until
+# the last part of the body is rendered. This is useful when
+# using streaming.
+#
+# Uses Rack::BodyProxy, adapted from Rack::Lock's usage of the
+# same pattern.
+
+module RequestStore
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      RequestStore.begin!
+
+      status, headers, body = @app.call(env)
+
+      body = Rack::BodyProxy.new(body) do
+        RequestStore.end!
+        RequestStore.clear!
+      end
+      
+      returned = true
+
+      [status, headers, body]
+    ensure
+      unless returned
+        RequestStore.end!
+        RequestStore.clear!
+      end
+    end
+  end
+end

data/lib/request_store/railtie.rb

@@ -1,21 +1,21 @@
-module RequestStore
-  class Railtie < ::Rails::Railtie
-    initializer "request_store.insert_middleware" do |app|
-      if ActionDispatch.const_defined? :RequestId
-        app.config.middleware.insert_after ActionDispatch::RequestId, RequestStore::Middleware
-      else
-        app.config.middleware.insert_after Rack::MethodOverride, RequestStore::Middleware
-      end
-
-      if ActiveSupport.const_defined?(:Reloader) && ActiveSupport::Reloader.respond_to?(:to_complete)
-        ActiveSupport::Reloader.to_complete do
-          RequestStore.clear!
-        end
-      elsif ActionDispatch.const_defined?(:Reloader) && ActionDispatch::Reloader.respond_to?(:to_cleanup)
-        ActionDispatch::Reloader.to_cleanup do
-          RequestStore.clear!
-        end
-      end
-    end
-  end
-end
+module RequestStore
+  class Railtie < ::Rails::Railtie
+    initializer "request_store.insert_middleware" do |app|
+      if ActionDispatch.const_defined? :RequestId
+        app.config.middleware.insert_after ActionDispatch::RequestId, RequestStore::Middleware
+      else
+        app.config.middleware.insert_after Rack::MethodOverride, RequestStore::Middleware
+      end
+
+      if ActiveSupport.const_defined?(:Reloader) && ActiveSupport::Reloader.respond_to?(:to_complete)
+        ActiveSupport::Reloader.to_complete do
+          RequestStore.clear!
+        end
+      elsif ActionDispatch.const_defined?(:Reloader) && ActionDispatch::Reloader.respond_to?(:to_cleanup)
+        ActionDispatch::Reloader.to_cleanup do
+          RequestStore.clear!
+        end
+      end
+    end
+  end
+end

data/lib/request_store/version.rb

@@ -1,3 +1,3 @@
-module RequestStore
-  VERSION = "1.4.1"
-end
+module RequestStore
+  VERSION = "1.6.0"
+end

data/lib/request_store.rb

@@ -1,54 +1,68 @@
-require "request_store/version"
-require "request_store/middleware"
-require "request_store/railtie" if defined?(Rails::Railtie)
-
-module RequestStore
-  def self.store
-    Thread.current[:request_store] ||= {}
-  end
-
-  def self.clear!
-    Thread.current[:request_store] = {}
-  end
-
-  def self.begin!
-    Thread.current[:request_store_active] = true
-  end
-
-  def self.end!
-    Thread.current[:request_store_active] = false
-  end
-
-  def self.active?
-    Thread.current[:request_store_active] || false
-  end
-
-  def self.read(key)
-    store[key]
-  end
-
-  def self.[](key)
-    store[key]
-  end
-
-  def self.write(key, value)
-    store[key] = value
-  end
-
-  def self.[]=(key, value)
-    store[key] = value
-  end
-
-  def self.exist?(key)
-    store.key?(key)
-  end
-
-  def self.fetch(key)
-    store[key] = yield unless exist?(key)
-    store[key]
-  end
-
-  def self.delete(key, &block)
-    store.delete(key, &block)
-  end
-end
+require "request_store/version"
+require "request_store/middleware"
+require "request_store/railtie" if defined?(Rails::Railtie)
+
+module RequestStore
+  if Fiber.respond_to?(:[])
+    def self.scope
+      Fiber
+    end
+  else
+    def self.scope
+      Thread.current
+    end
+  end
+
+  def self.store
+    scope[:request_store] ||= {}
+  end
+
+  def self.store=(store)
+    scope[:request_store] = store
+  end
+
+  def self.clear!
+    scope[:request_store] = {}
+  end
+
+  def self.begin!
+    scope[:request_store_active] = true
+  end
+
+  def self.end!
+    scope[:request_store_active] = false
+  end
+
+  def self.active?
+    scope[:request_store_active] || false
+  end
+
+  def self.read(key)
+    store[key]
+  end
+
+  def self.[](key)
+    store[key]
+  end
+
+  def self.write(key, value)
+    store[key] = value
+  end
+
+  def self.[]=(key, value)
+    store[key] = value
+  end
+
+  def self.exist?(key)
+    store.key?(key)
+  end
+
+  def self.fetch(key)
+    store[key] = yield unless exist?(key)
+    store[key]
+  end
+
+  def self.delete(key, &block)
+    store.delete(key, &block)
+  end
+end

data/request_store.gemspec

@@ -1,25 +1,24 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'request_store/version'
-
-Gem::Specification.new do |gem|
-  gem.name          = "request_store"
-  gem.version       = RequestStore::VERSION
-  gem.authors       = ["Steve Klabnik"]
-  gem.email         = ["steve@steveklabnik.com"]
-  gem.description   = %q{RequestStore gives you per-request global storage.}
-  gem.summary       = %q{RequestStore gives you per-request global storage.}
-  gem.homepage      = "http://github.com/steveklabnik/request_store"
-  gem.licenses      = ["MIT"]
-
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ["lib"]
-
-  gem.add_dependency "rack", ">= 1.4"
-
-  gem.add_development_dependency "rake", "~> 10.5"
-  gem.add_development_dependency "minitest", "~> 5.0"
-end
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'request_store/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "request_store"
+  gem.version       = RequestStore::VERSION
+  gem.authors       = ["Steve Klabnik"]
+  gem.email         = ["steve@steveklabnik.com"]
+  gem.description   = %q{RequestStore gives you per-request global storage.}
+  gem.summary       = %q{RequestStore gives you per-request global storage.}
+  gem.homepage      = "https://github.com/steveklabnik/request_store"
+  gem.licenses      = ["MIT"]
+
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "rack", ">= 1.4"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest", "~> 5.0"
+end

data/test/middleware_test.rb

@@ -1,65 +1,101 @@
-require 'minitest/test'
-require 'minitest/autorun'
-
-require 'request_store'
-
-class MiddlewareTest < Minitest::Test
-  def setup
-    @app = RackApp.new
-    @middleware = RequestStore::Middleware.new(@app)
-  end
-
-  def call_middleware(opts = {})
-    _, _, proxy = @middleware.call(opts)
-    proxy.close
-  end
-
-  def test_middleware_resets_store
-    2.times do
-      call_middleware
-    end
-
-    assert_equal 1, @app.last_value
-    assert_equal({}, RequestStore.store)
-  end
-
-  def test_middleware_resets_store_on_error
-    e = assert_raises RuntimeError do
-      call_middleware({:error => true})
-    end
-
-    assert_equal 'FAIL', e.message
-    assert_equal({}, RequestStore.store)
-  end
-
-  def test_middleware_begins_store
-    call_middleware
-    assert_equal true, @app.store_active
-  end
-
-  def test_middleware_ends_store
-    call_middleware
-
-    assert_equal false, RequestStore.active?
-  end
-
-  def test_middleware_ends_store_on_error
-    assert_raises RuntimeError do
-      call_middleware({:error => true})
-    end
-
-    assert_equal false, RequestStore.active?
-  end
-
-  def test_middleware_stores_until_proxy_closes
-    _, _, proxy = @middleware.call({})
-
-    assert_equal 1, @app.last_value
-    assert RequestStore.active?
-
-    proxy.close
-
-    refute RequestStore.active?
-    refute RequestStore.store[:foo]
-  end
-end
+require 'minitest/test'
+require 'minitest/autorun'
+
+require 'request_store'
+
+class MiddlewareTest < Minitest::Test
+  def setup
+    @app = RackApp.new
+    @middleware = RequestStore::Middleware.new(@app)
+  end
+
+  def call_middleware(opts = {})
+    _, _, proxy = @middleware.call(opts)
+    proxy.close
+    proxy
+  end
+
+  def test_middleware_resets_store
+    2.times do
+      call_middleware
+    end
+
+    assert_equal 1, @app.last_value
+    assert_equal({}, RequestStore.store)
+  end
+
+  def test_middleware_does_not_mutate_response_and_does_not_overflow_stack
+    10000.times do
+      call_middleware
+    end
+
+    resp = call_middleware
+    assert resp.is_a?(::Rack::BodyProxy)
+    assert_equal ["response"], resp.to_a
+    assert_equal ["response"], resp.instance_variable_get(:@body)
+  end
+
+  def test_middleware_resets_store_on_error
+    e = assert_raises RuntimeError do
+      call_middleware({:error => true})
+    end
+
+    assert_equal 'FAIL', e.message
+    assert_equal({}, RequestStore.store)
+  end
+
+  def test_middleware_begins_store
+    call_middleware
+    assert_equal true, @app.store_active
+  end
+
+  def test_middleware_ends_store
+    call_middleware
+
+    assert_equal false, RequestStore.active?
+  end
+
+  def test_middleware_ends_store_on_error
+    assert_raises RuntimeError do
+      call_middleware({:error => true})
+    end
+
+    assert_equal false, RequestStore.active?
+  end
+
+  def test_middleware_stores_until_proxy_closes
+    _, _, proxy = @middleware.call({})
+
+    assert_equal 1, @app.last_value
+    assert RequestStore.active?
+
+    proxy.close
+
+    refute RequestStore.active?
+    refute RequestStore.store[:foo]
+  end
+end
+
+class MiddlewareWithConstResponseTest < Minitest::Test
+  def setup
+    @app = RackAppWithConstResponse.new
+    @middleware = RequestStore::Middleware.new(@app)
+  end
+
+  def call_middleware(opts = {})
+    _, _, proxy = @middleware.call(opts)
+    proxy.close
+    proxy
+  end
+
+  def test_middleware_does_not_mutate_response_and_does_not_overflow_stack
+    10000.times do
+      call_middleware
+    end
+
+    resp = call_middleware
+    assert resp.is_a?(::Rack::BodyProxy)
+    assert_equal ["response"], resp.to_a
+    assert_equal ["response"], resp.instance_variable_get(:@body)
+  end
+end

data/test/request_store_test.rb

@@ -1,73 +1,80 @@
-require 'minitest/autorun'
-
-require 'request_store'
-
-class RequestStoreTest < Minitest::Test
-  def setup
-    RequestStore.clear!
-  end
-
-  def teardown
-    RequestStore.clear!
-  end
-
-  def test_initial_state
-    Thread.current[:request_store] = nil
-    assert_equal RequestStore.store, Hash.new
-  end
-
-  def test_init_with_hash
-    assert_equal Hash.new, RequestStore.store
-  end
-
-  def test_clear
-    RequestStore.store[:foo] = 1
-    RequestStore.clear!
-    assert_equal Hash.new, RequestStore.store
-  end
-
-  def test_quacks_like_hash
-    RequestStore.store[:foo] = 1
-    assert_equal 1, RequestStore.store[:foo]
-    assert_equal 1, RequestStore.store.fetch(:foo)
-  end
-
-  def test_read
-    RequestStore.store[:foo] = 1
-    assert_equal 1, RequestStore.read(:foo)
-    assert_equal 1, RequestStore[:foo]
-  end
-
-  def test_write
-    RequestStore.write(:foo, 1)
-    assert_equal 1, RequestStore.store[:foo]
-    RequestStore[:foo] = 2
-    assert_equal 2, RequestStore.store[:foo]
-  end
-
-  def test_fetch
-    assert_equal 2, RequestStore.fetch(:foo) { 1 + 1 }
-    assert_equal 2, RequestStore.fetch(:foo) { 2 + 2 }
-  end
-
-  def test_delete
-    assert_equal 2, RequestStore.fetch(:foo) { 1 + 1 }
-    assert_equal 2, RequestStore.delete(:foo) { 2 + 2 }
-    assert_equal 4, RequestStore.delete(:foo) { 2 + 2 }
-  end
-
-  def test_delegates_to_thread
-    RequestStore.store[:foo] = 1
-    assert_equal 1, Thread.current[:request_store][:foo]
-  end
-
-  def test_active_state
-    assert_equal false, RequestStore.active?
-
-    RequestStore.begin!
-    assert_equal true, RequestStore.active?
-
-    RequestStore.end!
-    assert_equal false, RequestStore.active?
-  end
-end
+require 'minitest/autorun'
+
+require 'request_store'
+
+class RequestStoreTest < Minitest::Test
+  def setup
+    RequestStore.clear!
+  end
+
+  def teardown
+    RequestStore.clear!
+  end
+
+  def test_initial_state
+    Thread.current[:request_store] = nil
+    assert_equal RequestStore.store, Hash.new
+  end
+
+  def test_init_with_hash
+    assert_equal Hash.new, RequestStore.store
+  end
+
+  def test_assign_store
+    store_obj = { test_key: 'test' }
+    RequestStore.store = store_obj
+    assert_equal 'test', RequestStore.store[:test_key]
+    assert_equal store_obj, RequestStore.store
+  end
+
+  def test_clear
+    RequestStore.store[:foo] = 1
+    RequestStore.clear!
+    assert_equal Hash.new, RequestStore.store
+  end
+
+  def test_quacks_like_hash
+    RequestStore.store[:foo] = 1
+    assert_equal 1, RequestStore.store[:foo]
+    assert_equal 1, RequestStore.store.fetch(:foo)
+  end
+
+  def test_read
+    RequestStore.store[:foo] = 1
+    assert_equal 1, RequestStore.read(:foo)
+    assert_equal 1, RequestStore[:foo]
+  end
+
+  def test_write
+    RequestStore.write(:foo, 1)
+    assert_equal 1, RequestStore.store[:foo]
+    RequestStore[:foo] = 2
+    assert_equal 2, RequestStore.store[:foo]
+  end
+
+  def test_fetch
+    assert_equal 2, RequestStore.fetch(:foo) { 1 + 1 }
+    assert_equal 2, RequestStore.fetch(:foo) { 2 + 2 }
+  end
+
+  def test_delete
+    assert_equal 2, RequestStore.fetch(:foo) { 1 + 1 }
+    assert_equal 2, RequestStore.delete(:foo) { 2 + 2 }
+    assert_equal 4, RequestStore.delete(:foo) { 2 + 2 }
+  end
+
+  def test_delegates_to_scope
+    RequestStore.store[:foo] = 1
+    assert_equal 1, RequestStore.scope[:request_store][:foo]
+  end
+
+  def test_active_state
+    assert_equal false, RequestStore.active?
+
+    RequestStore.begin!
+    assert_equal true, RequestStore.active?
+
+    RequestStore.end!
+    assert_equal false, RequestStore.active?
+  end
+end

data/test/test_helper.rb

@@ -1,13 +1,29 @@
-class RackApp
-  attr_reader :last_value, :store_active
-
-  def call(env)
-    RequestStore.store[:foo] ||= 0
-    RequestStore.store[:foo] += 1
-    @last_value = RequestStore.store[:foo]
-    @store_active = RequestStore.active?
-    raise 'FAIL' if env[:error]
-
-    [200, {}, ["response"]]
-  end
-end
+class RackApp
+  attr_reader :last_value, :store_active
+
+  def call(env)
+    RequestStore.store[:foo] ||= 0
+    RequestStore.store[:foo] += 1
+    @last_value = RequestStore.store[:foo]
+    @store_active = RequestStore.active?
+    raise 'FAIL' if env[:error]
+
+    [200, {}, ["response"]]
+  end
+end
+
+class RackAppWithConstResponse
+  RESPONSE = [200, {}, ["response"]]
+
+  attr_reader :last_value, :store_active
+
+  def call(env)
+    RequestStore.store[:foo] ||= 0
+    RequestStore.store[:foo] += 1
+    @last_value = RequestStore.store[:foo]
+    @store_active = RequestStore.active?
+    raise 'FAIL' if env[:error]
+
+    RESPONSE
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: request_store
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Steve Klabnik
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-03-16 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -59,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -73,11 +73,11 @@ files:
 - test/middleware_test.rb
 - test/request_store_test.rb
 - test/test_helper.rb
-homepage: http://github.com/steveklabnik/request_store
+homepage: https://github.com/steveklabnik/request_store
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,9 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: RequestStore gives you per-request global storage.
 test_files:

data/.travis.yml

@@ -1,18 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 1.8.7
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.3
-  - jruby-18mode
-  - jruby-19mode
-  - ruby-head
-  - jruby-head
-  - ree
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head