padrino-cache 0.18.0 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6bc0e683d74abea34d8a3abc2d7746455a312845e902a4f7c1bcec7ecb98f7
-  data.tar.gz: b71a9e04a9d13813d4ef142f0c76d54305e7107e7a44e42829b7572112763987
+  metadata.gz: fbd32a2e65add5d5f0e143fb98a411b78c5926e97cd56f5bc6d5ea0976ab4fee
+  data.tar.gz: 36af9ade2e7efc5a564f8e243f900998e5b77c48b8b71472b1753c0ea6f9100f
 SHA512:
-  metadata.gz: d376e2451a706eea91c6a3ce7951c04ca2d36f4c5b36e7c725bc481d6d34d1fc7ac65969ff558a1854102979ac39e8feec143c94ad2b6b86bff3cbfdb520c240
-  data.tar.gz: 104b4daca715a68d1706e3fa264594fee61cb88469910e03c6a59348fcce93b58d7546c38974d2df18a1276a4228ef3ad89d47cc0b3c8d09347858bbb1841eb2
+  metadata.gz: 555e89a1b630f754c12fa127fda89c84beb18965a74290af21d9f798a298479a06d367674f3a14f7aa95b1204791ac2d559d3e0faec419a89da3832304a7174d
+  data.tar.gz: 1bfb38bbc845d74631f20c5f82c60d136acad4689584dfd830d256452bb6bff092c563b463e6aba3df67dd5b212ff298537d6c79ad317f46df9b775d0b2772cb

data/lib/padrino-cache/helpers/page.rb

@@ -60,7 +60,7 @@ module Padrino
         #
         # @api public
         def expires(time)
-          @route.cache_expires = time
+          @_cache_expires = time
         end
 
         ##
@@ -89,7 +89,11 @@ module Padrino
         #
         def cache_key(name = nil, &block)
           raise 'Can not provide both cache_key and a block' if name && block
-          @route.cache_key = name || block
+
+          @_cache_key = name || block
+          # A Symbol or a block is the same for every request, so later requests can look it up before the
+          # handler runs. Any other key (a String built from params) belongs to this request only.
+          @route.cache_key = @_cache_key if @_cache_key.is_a?(Symbol) || @_cache_key.is_a?(Proc)
         end
 
         CACHED_VERBS = { 'GET' => true, 'HEAD' => true }.freeze
@@ -97,21 +101,30 @@ module Padrino
         def self.padrino_route_added(route, verb, *)
           return unless route.cache && CACHED_VERBS[verb]
 
-          route.before_filters do
-            next unless settings.caching?
-            if (cached_response = load_cached_response)
-              content_type cached_response[:content_type]
-              halt 200, cached_response[:body]
-            end
-          end
+          # Remember the key and expiry set before this route (by an app-level before filter), so a route
+          # reached through pass starts from them rather than from this route's.
+          route.before_filters { @_cache_outer = [@_cache_key, @_cache_expires] }
+          # The lookup is the route's last condition: it runs after every before filter and condition, so
+          # access checks written there apply to cached pages too.
+          route.custom_conditions << instance_method(:serve_cached_response)
 
           route.after_filters do
-            save_cached_response(route.cache_expires) if settings.caching?
+            save_cached_response(@_cache_expires.nil? ? route.cache_expires : @_cache_expires) if settings.caching?
+            @_cache_key, @_cache_expires = @_cache_outer
           end
         end
 
         private
 
+        def serve_cached_response
+          if settings.caching? && (cached_response = load_cached_response)
+            env['sinatra.route'] = "#{request.request_method} #{@route.sinatra_pattern}"
+            content_type cached_response[:content_type]
+            halt 200, cached_response[:body]
+          end
+          true
+        end
+
         def load_cached_response
           began_at = Time.now
           route_cache_key = resolve_cache_key || env['PATH_INFO']
@@ -142,7 +155,7 @@ module Padrino
         # Resolve the cache_key when it's a block in the correct context.
         #
         def resolve_cache_key
-          key = @route.cache_key
+          key = @_cache_key || @route.cache_key
           key.is_a?(Proc) ? instance_eval(&key) : key
         end
 

data/padrino-cache.gemspec

@@ -8,16 +8,21 @@ Gem::Specification.new do |s|
   s.authors = ['Padrino Team', 'Nathan Esquenazi', "Davide D'Agostino", 'Arthur Chiu']
   s.email = 'padrinorb@gmail.com'
   s.summary = 'Page and fragment caching for Padrino'
-  s.homepage = 'http://www.padrinorb.com'
+  s.homepage = 'https://padrinorb.com'
   s.description = 'Caching support for memcached, page and fragment'
+  s.required_ruby_version = '>= 2.7.8'
   s.required_rubygems_version = '>= 1.3.6'
   s.version = Padrino.version
-  s.date = Time.now.strftime('%Y-%m-%d')
   s.license = 'MIT'
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/padrino/padrino-framework/issues',
+    'changelog_uri' => 'https://github.com/padrino/padrino-framework/blob/master/CHANGES.rdoc',
+    'documentation_uri' => 'https://padrinorb.com/guides/',
+    'source_code_uri' => 'https://github.com/padrino/padrino-framework'
+  }
 
   s.extra_rdoc_files = Dir['*.rdoc']
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
   s.rdoc_options  = ['--charset=UTF-8']

data/test/test_padrino_cache.rb

@@ -6,6 +6,19 @@ describe 'PadrinoCache' do
     `rm -rf #{tmp}`
   end
 
+  it 'names a page served from the cache in sinatra.route' do
+    routes = []
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      get('/page/:id', cache: true) { "page #{params[:id]}" }
+      after { routes << env['sinatra.route'] }
+    end
+    2.times { get '/page/1' }
+    assert_equal 'page 1', body
+    assert_equal ['GET /page/:id', 'GET /page/:id'], routes
+  end
+
   it 'should cache a fragment' do
     called = false
     mock_app do
@@ -381,6 +394,150 @@ describe 'PadrinoCache' do
     assert_equal 2, call_count
   end
 
+  it 'should not reuse a string cache key from another request' do
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      get '/post/:id', cache: true do
+        cache_key "post-#{params[:id]}"
+        "post #{params[:id]}"
+      end
+    end
+
+    get '/post/1'
+    assert_equal 'post 1', body
+    get '/post/2'
+    assert_equal 'post 2', body
+    get '/post/1'
+    assert_equal 'post 1', body
+  end
+
+  it 'should run controller before filters on a cached response' do
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      controller :secret, cache: true do
+        before { halt 403, 'denied' unless params[:ok] }
+        get(:index) { 'secret page' }
+      end
+    end
+
+    get '/secret?ok=1'
+    assert_equal 'secret page', body
+    get '/secret'
+    assert_equal 403, status
+    assert_equal 'denied', body
+  end
+
+  it 'should use a cache key set in a controller before filter for the lookup' do
+    calls = 0
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      controller :users, cache: true do
+        before { cache_key "user-#{params[:u]}" }
+        get(:show, with: :u) { calls += 1; "user #{params[:u]}" }
+      end
+    end
+
+    get '/users/show/a'
+    get '/users/show/b'
+    get '/users/show/a'
+    assert_equal 'user a', body
+    assert_equal 2, calls
+  end
+
+  it 'should not apply a cache key to the next route after pass' do
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      get '/x/:id', cache: true do
+        cache_key :shared
+        pass if params[:id] == 'skip'
+        "A #{params[:id]}"
+      end
+      get('/x/:id', cache: true) { "B #{params[:id]}" }
+    end
+
+    get '/x/skip'
+    assert_equal 'B skip', body
+    get '/x/1'
+    assert_equal 'A 1', body
+  end
+
+  it 'should check route conditions on a cached response' do
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      def self.protect(protected)
+        condition { halt 403, 'No secrets for you!' unless params[:key] == 's3cr3t' } if protected
+      end
+      controller cache: true, conditions: { protect: true } do
+        get('/private') { 'secret stuff' }
+      end
+    end
+
+    get '/private?key=s3cr3t'
+    assert_equal 'secret stuff', body
+    get '/private'
+    assert_equal 403, status
+    assert_equal 'No secrets for you!', body
+  end
+
+  it 'should keep a cache key from an app-level before filter for the route reached through pass' do
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      before { cache_key "u-#{params[:u]}" }
+      get('/z', cache: true) { pass }
+      get('/z', cache: true) { "B for #{params[:u]}" }
+    end
+
+    get '/z?u=alice'
+    assert_equal 'B for alice', body
+    get '/z?u=bob'
+    assert_equal 'B for bob', body
+  end
+
+  it 'should keep expires to the request that set it' do
+    stored = []
+    store = Object.new
+    store.define_singleton_method(:[]) { |_key| nil }
+    store.define_singleton_method(:store) { |key, _value, options| stored << [key, options[:expires]] }
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      set :cache, store
+      get '/foo', cache: true do
+        expires 100 if params[:long]
+        'foo'
+      end
+    end
+
+    get '/foo?long=1'
+    get '/foo'
+    assert_equal [['/foo', 100], ['/foo', nil]], stored
+  end
+
+  it 'should let expires false in a handler override the route expiry' do
+    stored = []
+    store = Object.new
+    store.define_singleton_method(:[]) { |_key| nil }
+    store.define_singleton_method(:store) { |key, _value, options| stored << [key, options[:expires]] }
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      set :cache, store
+      get '/ef', cache: true, expires: 60 do
+        expires false
+        'ef'
+      end
+    end
+
+    get '/ef'
+    assert_equal [['/ef', false]], stored
+  end
+
   it 'should resolve block cache keys' do
     call_count = 0
     mock_app do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: padrino-cache
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.18.2
 platform: ruby
 authors:
 - Padrino Team
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-31 00:00:00.000000000 Z
+date: 2026-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: padrino-core
@@ -19,28 +19,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: padrino-helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.2
 - !ruby/object:Gem::Dependency
   name: moneta
   requirement: !ruby/object:Gem::Requirement
@@ -77,10 +77,14 @@ files:
 - test/helper.rb
 - test/test_moneta_store.rb
 - test/test_padrino_cache.rb
-homepage: http://www.padrinorb.com
+homepage: https://padrinorb.com
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/padrino/padrino-framework/issues
+  changelog_uri: https://github.com/padrino/padrino-framework/blob/master/CHANGES.rdoc
+  documentation_uri: https://padrinorb.com/guides/
+  source_code_uri: https://github.com/padrino/padrino-framework
 post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
@@ -90,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="