padrino-cache 0.12.2 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90a12b145c168c1bf06eed80003c8a2192ea4da8
-  data.tar.gz: d7037b8f473894021d164bf29a78b477b38f915d
+  metadata.gz: 1e64349dade4e85cb293e1b2de5381bf21d7f45c
+  data.tar.gz: 6fa8e3ab11b1ba47667497d81937e629eea2dcda
 SHA512:
-  metadata.gz: 465103c327fef8882fbbf3365976eb4ca2c4da7522cef9106d187a255df2bf0baea14ef9d656eb24245370c5c1644aaac27834fe6fb86b0d14426183a490d75e
-  data.tar.gz: 5dac09e66c5faa7732d3b77f695508be00a0aa5a761d74de881e3c9f7f3a002db765bb90d7c5e32285ae95980ee05488f2a329c36a1a3e6ef955dddb254b7881
+  metadata.gz: 0f408303e59ce1e0dbd4cf3f99fcfa42d0e8a3e1e3c007834066bcaf10793b961e4161332536ba6baac59683a50bec95f73b8cad9c177fea3ee86567b37e23a3
+  data.tar.gz: dfabcbecfa9dcb42c1f20af48209247bc0f785e2e97a417618f229393948f0e015a0e3f54e5aa11834698a89d1ba94f5ca9ec6fb60a0b457a62904d99d7ff551

data/lib/padrino-cache.rb

@@ -101,8 +101,12 @@ module Padrino
         app.set :cache, Padrino::Cache.new(:File,
                                            :dir => Padrino.root('tmp', defined?(app.app_name) ? app.app_name.to_s : '', 'cache'))
         app.disable :caching
+        included(app)
+      end
+
+      def included(base)
+        base.extend Padrino::Cache::Helpers::Page::ClassMethods
       end
-      alias :included :registered
 
       def padrino_route_added(route, verb, path, args, options, block)
         Padrino::Cache::Helpers::Page.padrino_route_added(route, verb, path, args, options, block)

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

@@ -60,8 +60,7 @@ module Padrino
         #
         # @api public
         def expires(time)
-          @route.cache_expires = time if @route
-          @_last_expires       = time
+          @route.cache_expires = time
         end
 
         def expires_in(time)
@@ -94,55 +93,80 @@ module Padrino
         #   end
         #
         def cache_key(name = nil, &block)
-          raise "Can not provide both cache_key and a block" if name && block
-          @route.cache_key = block_given? ? block : name
+          fail "Can not provide both cache_key and a block" if name && block
+          @route.cache_key = name || block
         end
 
-        def self.padrino_route_added(route, verb, path, args, options, block)
-          if route.cache and %w(GET HEAD).include?(verb)
-            route.before_filters do
-              if settings.caching?
-                began_at     = Time.now
-
-                value = settings.cache[resolve_cache_key || env['PATH_INFO']]
-                logger.debug "GET Cache", began_at, @route.cache_key || env['PATH_INFO'] if defined?(logger) && value
-
-                if value.kind_of?(Hash)
-                  content_type value[:content_type]
-                  halt 200, value[:body]
-                elsif value
-                  halt 200, value
-                end
-              end
-            end
+        CACHED_VERBS = { 'GET' => true, 'HEAD' => true }.freeze
+
+        def self.padrino_route_added(route, verb, *)
+          return unless route.cache && CACHED_VERBS[verb]
 
-            route.after_filters do
-              if settings.caching? && @_response_buffer.kind_of?(String)
-                began_at     = Time.now
-                content = {
-                  :body         => @_response_buffer,
-                  :content_type => @_content_type
-                }
-
-                if @_last_expires
-                  settings.cache.store(resolve_cache_key || env['PATH_INFO'], content, :expires => @_last_expires)
-                  @_last_expires = nil
-                else
-                  settings.cache.store(resolve_cache_key || env['PATH_INFO'], content)
-                end
-
-                logger.debug "SET Cache", began_at, @route.cache_key || env['PATH_INFO'] if defined?(logger)
-              end
+          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
+
+          route.after_filters do
+            save_cached_response(route.cache_expires) if settings.caching?
+          end
         end
 
         private
+
+        def load_cached_response
+          began_at = Time.now
+          route_cache_key = resolve_cache_key || env['PATH_INFO']
+
+          value = settings.cache[route_cache_key]
+          logger.debug "GET Cache", began_at, route_cache_key if defined?(logger) && value
+
+          value
+        end
+
+        def save_cached_response(cache_expires)
+          return unless @_response_buffer.kind_of?(String)
+
+          began_at = Time.now
+          route_cache_key = resolve_cache_key || env['PATH_INFO']
+
+          content = {
+            :body         => @_response_buffer,
+            :content_type => @_content_type
+          }
+
+          settings.cache.store(route_cache_key, content, :expires => cache_expires)
+
+          logger.debug "SET Cache", began_at, route_cache_key if defined?(logger)
+        end
+
         ##
         # Resolve the cache_key when it's a block in the correct context.
         #
         def resolve_cache_key
-          @route.cache_key.is_a?(Proc) ? instance_eval(&@route.cache_key) : @route.cache_key
+          key = @route.cache_key
+          key.is_a?(Proc) ? instance_eval(&key) : key
+        end
+
+        module ClassMethods
+          ##
+          # A method to set `expires` time inside `controller` blocks.
+          #
+          # @example
+          #   controller :users do
+          #     expires 15
+          #
+          #     get :show do
+          #       'shown'
+          #     end
+          #   end
+          #
+          def expires(time)
+            @_expires = time
+          end
         end
       end
     end

data/test/test_padrino_cache.rb

@@ -38,6 +38,57 @@ describe "PadrinoCache" do
     refute_equal false, called
   end
 
+  it 'should cache HEAD verb' do
+    called_times = 0
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      get('/foo', :cache => true){ called_times += 1; called_times.to_s }
+    end
+    head "/foo"
+    head "/foo"
+    assert_equal 1, called_times
+  end
+
+  it 'should not cache POST verb' do
+    called_times = 0
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      post('/foo', :cache => true){ called_times += 1; called_times.to_s }
+    end
+    post "/foo"
+    assert_equal 1, called_times
+    post "/foo"
+    assert_equal 2, called_times
+  end
+
+  it 'should not cache DELETE verb' do
+    called_times = 0
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      delete('/foo', :cache => true){ called_times += 1; called_times.to_s }
+    end
+    delete "/foo"
+    assert_equal 1, called_times
+    delete "/foo"
+    assert_equal 2, called_times
+  end
+
+  it 'should not cache PUT verb' do
+    called_times = 0
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      put('/foo', :cache => true){ called_times += 1; called_times.to_s }
+    end
+    put "/foo"
+    assert_equal 1, called_times
+    put "/foo"
+    assert_equal 2, called_times
+  end
+
   it 'should delete from the cache' do
     called = false
     mock_app do
@@ -115,7 +166,7 @@ describe "PadrinoCache" do
     assert_equal 'test page again', body
   end
 
-  it 'should accept allow controller-wide caching' do
+  it 'should allow controller-wide caching' do
     called = false
     mock_app do
       controller :cache => true do
@@ -132,6 +183,26 @@ describe "PadrinoCache" do
     assert_equal 'test', body
   end
 
+  it 'should allow controller-wide expires' do
+    called = false
+    mock_app do
+      register Padrino::Cache
+      controller :cache => true do
+        enable :caching
+        expires 1
+        get("/foo"){ called ? halt(500) : (called = 'test') }
+      end
+    end
+    get "/foo"
+    assert_equal 200, status
+    assert_equal 'test', body
+    get "/foo"
+    assert_equal 200, status
+    assert_equal 'test', body
+    Time.stub(:now, Time.now + 2) { get "/foo" }
+    assert_equal 500, status
+  end
+
   it 'should allow cache disabling on a per route basis' do
     called = false
     mock_app do
@@ -346,4 +417,44 @@ describe "PadrinoCache" do
     assert_equal 'bar', body
     assert_equal 1, counter
   end
+
+  it 'should allow different expiring times for different pages' do
+    skip
+    called_times_a = 0
+    called_times_b = 0
+    mock_app do
+      register Padrino::Cache
+      enable :caching
+      controller :cache => true do
+        get("/foo") do
+          expires 1
+          called_times_a += 1
+          called_times_b.to_s
+        end
+        get("/bar") do
+          expires 3
+          called_times_b += 1
+          called_times_b.to_s
+        end
+      end
+    end
+    Time.stub(:now, Time.now) { get "/foo"; get "/bar" }
+    assert_equal 1, called_times_a
+    assert_equal 1, called_times_b
+    Time.stub(:now, Time.now + 0.5) { get "/foo"; get "/bar" }
+    assert_equal 1, called_times_a
+    assert_equal 1, called_times_b
+    Time.stub(:now, Time.now + 2) { get "/foo"; get "/bar" }
+    assert_equal 2, called_times_a
+    assert_equal 1, called_times_b
+    Time.stub(:now, Time.now + 2.5) { get "/foo"; get "/bar" }
+    assert_equal 2, called_times_a
+    assert_equal 1, called_times_b
+    Time.stub(:now, Time.now + 4) { get "/foo"; get "/bar" }
+    assert_equal 3, called_times_a
+    assert_equal 2, called_times_b
+    Time.stub(:now, Time.now + 5.5) { get "/foo"; get "/bar" }
+    assert_equal 4, called_times_a
+    assert_equal 2, called_times_b
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: padrino-cache
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.12.3
 platform: ruby
 authors:
 - Padrino Team
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-08-13 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.12.2
+        version: 0.12.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.12.3
 - !ruby/object:Gem::Dependency
   name: padrino-helpers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.12.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.12.3
 - !ruby/object:Gem::Dependency
   name: moneta
   requirement: !ruby/object:Gem::Requirement