request_store 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4940fb899c4f08b98633877ca272f29dcdd4ade30456bc87a2529d38da9385e8
-  data.tar.gz: 8be86e88c85f7aeaa3b0ac1eee98da6b26f9c95595319fc010eb800e542eb3cf
+  metadata.gz: e791505be9e9e0f6f8bf0b3229cb7840f473f71fdb6a4bb7f4d7375a06d11cdf
+  data.tar.gz: b8866d3e58f810f96e3ea1b4ef7b4491b69cdf0bc6df06e5610c6d8f3312e8dd
 SHA512:
-  metadata.gz: 59f193bbe4aaa3e1a13d5540840b379eadfd654f3f30ac5c9f8dcd780357f0fcc88a2a70d85f3637934a9eff9297cf4d410ceb2829a8ccdc2f6c9cf0631d1579
-  data.tar.gz: 1727397fd735206c9260e5957a78ec9014966619024e7083d29e5ccab5b71178794a2aa1892f0801bbd4afd267a2b7a3b75728a0fc086d0575be2ac477040501
+  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/Gemfile

@@ -2,3 +2,12 @@ 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/README.md

@@ -1,4 +1,4 @@
-# RequestStore [![build status](https://travis-ci.org/steveklabnik/request_store.svg?branch=master)](https://travis-ci.org/steveklabnik/request_store) [![Code Climate](https://codeclimate.com/github/steveklabnik/request_store.svg)](https://codeclimate.com/github/steveklabnik/request_store)
+# 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:
@@ -58,6 +58,16 @@ 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+

data/lib/request_store/middleware.rb

@@ -16,12 +16,16 @@ module RequestStore
     def call(env)
       RequestStore.begin!
 
-      response = @app.call(env)
+      status, headers, body = @app.call(env)
 
-      returned = response << Rack::BodyProxy.new(response.pop) do
+      body = Rack::BodyProxy.new(body) do
         RequestStore.end!
         RequestStore.clear!
       end
+      
+      returned = true
+
+      [status, headers, body]
     ensure
       unless returned
         RequestStore.end!

data/lib/request_store/version.rb

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

data/lib/request_store.rb

@@ -3,28 +3,38 @@ 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
-    Thread.current[:request_store] ||= {}
+    scope[:request_store] ||= {}
   end
 
   def self.store=(store)
-    Thread.current[:request_store] = store
+    scope[:request_store] = store
   end
 
   def self.clear!
-    Thread.current[:request_store] = {}
+    scope[:request_store] = {}
   end
 
   def self.begin!
-    Thread.current[:request_store_active] = true
+    scope[:request_store_active] = true
   end
 
   def self.end!
-    Thread.current[:request_store_active] = false
+    scope[:request_store_active] = false
   end
 
   def self.active?
-    Thread.current[:request_store_active] || false
+    scope[:request_store_active] || false
   end
 
   def self.read(key)

data/request_store.gemspec

@@ -10,16 +10,15 @@ Gem::Specification.new do |gem|
   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.homepage      = "https://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 "rake"
   gem.add_development_dependency "minitest", "~> 5.0"
 end

data/test/middleware_test.rb

@@ -12,6 +12,7 @@ class MiddlewareTest < Minitest::Test
   def call_middleware(opts = {})
     _, _, proxy = @middleware.call(opts)
     proxy.close
+    proxy
   end
 
   def test_middleware_resets_store
@@ -23,6 +24,17 @@ class MiddlewareTest < Minitest::Test
     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})
@@ -63,3 +75,27 @@ class MiddlewareTest < Minitest::Test
     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

@@ -63,9 +63,9 @@ class RequestStoreTest < Minitest::Test
     assert_equal 4, RequestStore.delete(:foo) { 2 + 2 }
   end
 
-  def test_delegates_to_thread
+  def test_delegates_to_scope
     RequestStore.store[:foo] = 1
-    assert_equal 1, Thread.current[:request_store][:foo]
+    assert_equal 1, RequestStore.scope[:request_store][:foo]
   end
 
   def test_active_state

data/test/test_helper.rb

@@ -11,3 +11,19 @@ class RackApp
     [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.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Steve Klabnik
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-20 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,8 +92,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-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.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.2.3
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-  - jruby-18mode
-  - jruby-19mode
-  - ruby-head
-  - jruby-head
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head