padrino-cache 0.18.0 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa6bc0e683d74abea34d8a3abc2d7746455a312845e902a4f7c1bcec7ecb98f7
-  data.tar.gz: b71a9e04a9d13813d4ef142f0c76d54305e7107e7a44e42829b7572112763987
+  metadata.gz: ba34b4d72a0a4f039038801633b094117edb2548332855bfe6348700c1c4ed4f
+  data.tar.gz: 3f6382fa84609a885528064148e3b77674745bb2e14c3ed4f40f34da6972ef8b
 SHA512:
-  metadata.gz: d376e2451a706eea91c6a3ce7951c04ca2d36f4c5b36e7c725bc481d6d34d1fc7ac65969ff558a1854102979ac39e8feec143c94ad2b6b86bff3cbfdb520c240
-  data.tar.gz: 104b4daca715a68d1706e3fa264594fee61cb88469910e03c6a59348fcce93b58d7546c38974d2df18a1276a4228ef3ad89d47cc0b3c8d09347858bbb1841eb2
+  metadata.gz: 36573ec3921e7ff49e5cdeaddf9cd98eecd60e70272c51247821015e5115ebcea88a79de2ba954a599386cb0df32b00fd34b1afd537103565a18ddd7365bbaf9
+  data.tar.gz: 8bb374c1341562a7dcc2101e2e28bb38fe2eb76efa8c6cc6cf017c5d1855510cac823671f70218089846239f7fc633e7005b2d9199e5de526a154d82752f0869

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,29 @@ 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)
+            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 +154,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/test/test_padrino_cache.rb

@@ -381,6 +381,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.1
 platform: ruby
 authors:
 - Padrino Team
@@ -19,28 +19,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: padrino-helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: moneta
   requirement: !ruby/object:Gem::Requirement