request_store 1.4.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 057f28c37dcfc7b49f7443c8440af572892672ee
-  data.tar.gz: b5d14983640d8e012ca2c153e2b8dddaa6ace337
+SHA256:
+  metadata.gz: c9883603b6fb82a3e39d90b6e7509911f3813160d2fe267ad892536305c5d741
+  data.tar.gz: 437805cfcdfc5bc8c3c59bafe9d12bf4ae3ba1685e5261ca40dfce79f7cee845
 SHA512:
-  metadata.gz: cea24b9f63fa74fc0b0235d155133932fc018934b64dae3256266a320f060e2f10b004b48735926caaeacf64d28f5fcad336f3df4c5c436994a9c02ac5651994
-  data.tar.gz: 502ed5cb5807e7066fc3d2a0ac7d7f0d768af7f53c88f96e43c384ca57cfb9a371230f09c98692a8441c74e87c2402d68f09e48dc6aa8ba461892efc6af415c2
+  metadata.gz: bb19a5818c773c1e27ee3b1c215d1422bdabecf7929eaf235db48364c0a0f05467203c4c3b651ce9470c6d51f412d1f7d54e0c5043d44f0c2744d22a0e28d727
+  data.tar.gz: b0a56bde2842cecf4b291622e332130bed3c175d649f0659024594e4d38a49309a6e1ad40171afc6ee368045e98a93e6c8aa1c56f1235ed50d38d3197298e570

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@v4
+    - 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.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)
+# 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.4.0"
+  VERSION = "1.7.0"
 end

data/lib/request_store.rb

@@ -7,6 +7,10 @@ module RequestStore
     Thread.current[:request_store] ||= {}
   end
 
+  def self.store=(store)
+    Thread.current[:request_store] = store
+  end
+
   def self.clear!
     Thread.current[:request_store] = {}
   end
@@ -43,7 +47,7 @@ module RequestStore
     store.key?(key)
   end
 
-  def self.fetch(key, &block)
+  def self.fetch(key)
     store[key] = yield unless exist?(key)
     store[key]
   end

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

@@ -20,6 +20,13 @@ class RequestStoreTest < Minitest::Test
     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!

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.4.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Steve Klabnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-01 00:00:00.000000000 Z
+date: 2024-05-01 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,7 +73,7 @@ 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: {}
@@ -92,8 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: RequestStore gives you per-request global storage.

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