background_cache 0.1.1 → 0.1.2

data/lib/background_cache/config.rb

@@ -2,6 +2,9 @@ require 'digest/sha2'
 
 module BackgroundCache
   class Config
+    class <<self
+      attr_accessor :manual
+    end
     def initialize(&block)
       @@caches = []
       self.instance_eval &block
@@ -49,48 +52,53 @@ module BackgroundCache
       params = controller.params
       params.delete 'background_cache'
       path = controller.request.env['REQUEST_URI'].gsub(/[&?]background_cache=.+/, '')
-      if defined?(@@caches) && !@@caches.empty?
-        @@caches.detect do |item|
-          # Basic params match (action, controller, etc)
-          (
-            (item[:path] && item[:path] == path) ||
-            item[:params] == params.symbolize_keys
-          ) &&
-          (
-            # No fragment specified
-            fragment.empty? ||
+      cache =
+        if defined?(@@caches) && !@@caches.empty?
+          @@caches.detect do |item|
+            # Basic params match (action, controller, etc)
+            (
+              (item[:path] && item[:path] == path) ||
+              item[:params] == params.symbolize_keys
+            ) &&
             (
+              # No fragment specified
+              fragment.empty? ||
               (
-                # :only not defined
-                !item[:only] ||
-                # :only matches fragment
-                item[:only] == fragment ||
                 (
-                  # :only is an array
-                  item[:only].respond_to?(:index) &&
-                  # :only includes matching fragment
-                  item[:only].include?(fragment)
-                )
-              ) &&
-              (
-                # :except not defined
-                !item[:except] ||
-                # :except not explicitly named
-                item[:except] != fragment ||
+                  # :only not defined
+                  !item[:only] ||
+                  # :only matches fragment
+                  item[:only] == fragment ||
+                  (
+                    # :only is an array
+                    item[:only].respond_to?(:index) &&
+                    # :only includes matching fragment
+                    item[:only].include?(fragment)
+                  )
+                ) &&
                 (
-                  # :except is an array
-                  item[:except].respond_to?(:index) &&
-                  # :except does not include matching fragment
-                  !item[:except].include?(fragment)
+                  # :except not defined
+                  !item[:except] ||
+                  # :except not explicitly named
+                  item[:except] != fragment ||
+                  (
+                    # :except is an array
+                    item[:except].respond_to?(:index) &&
+                    # :except does not include matching fragment
+                    !item[:except].include?(fragment)
+                  )
                 )
               )
             )
-          )
+          end
         end
+      if !cache && self.manual
+        cache = { :path => path, :layout => false }
       end
+      cache
     end
     def self.caches
-      @@caches
+      @@caches if defined?(@@caches)
     end
     def self.key
       Digest::SHA256.hexdigest("--#{Time.now}--#{rand}--")
@@ -100,22 +108,7 @@ module BackgroundCache
     end
     def self.unload!
       @@caches = []
-    end
-    # Unique cache id for storing last expired time
-    def self.unique_cache_id(cache)
-      id = []
-      join = lambda do |k, v|
-        id << (k.nil? || v.nil? ?
-          nil : [ k, v ].collect { |kv| kv.to_s.gsub(/\W/, '_') }.join('-')
-        )
-      end
-      cache[:params].each do |key, value|
-        join.call(key, value)
-      end
-      cache.each do |key, value|
-        join.call(key, value) unless key == :params
-      end
-      'background_cache/' + id.compact.join('/')
+      self.manual = nil
     end
   end
 end

data/lib/background_cache/controller.rb

@@ -19,37 +19,20 @@ module BackgroundCache
     
     class BackgroundCacheFilter
       def before(controller)
-        @background_cache = {
-          :key => controller.params.delete("background_cache"),
-          :load => controller.params.delete("background_cache_load")
-        }
-        if @background_cache[:key]
-          # Secure filters
-          key = ::ActionController::Base.cache_store.read('background_cache/key')
-          # Turn off the layout if necessary
-          if @background_cache[:key] == key
-            cache = BackgroundCache::Config.from_controller(controller)
-            # Store current layout, then disable it
-            if cache && cache[:layout] == false
-              @background_cache[:layout] = controller.active_layout
-              controller.class.layout(false)
-            end
+        unless BackgroundCache::Config.caches.empty?
+          cache = BackgroundCache::Config.from_controller(controller)
+          # Store current layout, then disable it
+          if cache && cache[:layout] == false
+            @background_cache_layout = controller.active_layout
+            controller.class.layout(false)
           end
         end
         true
       end
       def after(controller)
         # Restore layout
-        if @background_cache[:layout]
-          controller.class.layout(@background_cache[:layout])
-        end
-        if @background_cache[:load]
-          # Secure filters
-          key = ::ActionController::Base.cache_store.read('background_cache/key')
-          # Load the background cache config
-          if @background_cache[:load] == key
-            BackgroundCache::Config.load!
-          end
+        if @background_cache_layout
+          controller.class.layout(@background_cache_layout)
         end
       end
     end

data/lib/background_cache/helper.rb

@@ -4,21 +4,23 @@ module BackgroundCache
       base.alias_method_chain :cache, :background_cache
     end
     def cache_with_background_cache(name = {}, options = nil, &block)
-      cache = BackgroundCache::Config.from_controller_and_fragment(controller, name)
-      if cache
-        RAILS_DEFAULT_LOGGER.info "Cached fragment busted (cache block): #{name.inspect}"
-        # http://api.rubyonrails.org/classes/ActionView/Helpers/CacheHelper.html
-        # http://api.rubyonrails.org/classes/ActionController/Caching/Fragments.html
-        # ActionController::Caching::Fragments#fragment_for (undocumented)
-        pos = output_buffer.length
-        block.call
-        output = [
-          "<!-- #{name.inspect} cached #{Time.now.strftime("%m/%d/%Y at %I:%M %p")} -->",
-          output_buffer[pos..-1]
-        ].join("\n")
-        @controller.write_fragment(name, output, options)
+      # http://railsapi.com/doc/rails-v2.3.8/classes/ActionView/Helpers/CacheHelper.html
+      # ActionController::Caching::Fragments#fragment_for (undocumented)
+      #   actionpack/lib/action_controller/caching/fragments.rb
+      if @controller.perform_caching
+        if cache = @controller.read_fragment(name, options)
+          output_buffer.concat(cache)
+        else
+          pos = output_buffer.length
+          block.call
+          output = [
+            "<!-- #{name.inspect} cached #{Time.now.strftime("%m/%d/%Y at %I:%M %p")} -->",
+            output_buffer[pos..-1]
+          ].join("\n")
+          @controller.write_fragment(name, output, options)
+        end
       else
-        cache_without_background_cache(name, options, &block)
+        block.call
       end
     end
   end

data/lib/background_cache.rb

@@ -12,37 +12,30 @@ module BackgroundCache
   end
   
   def self.cache!(group=nil)
-    key, instance = boot
+    instance = boot
     caches = BackgroundCache::Config.caches
     caches.each do |cache|
       next if group && cache[:group] != group
       url = cache[:path] || instance.url_for(cache[:params].merge(:only_path => true))
       puts "(#{cache[:group]}) #{url}"
-      instance.get(url + "#{url.include?('?') ? '&' : '?'}background_cache=#{key}")
+      instance.get(url)
     end
   end
   
   def self.manual(url)
-    key, instance = boot
+    instance = boot
+    BackgroundCache::Config.manual = true
     url = instance.url_for(url.merge(:only_path => true)) if url.respond_to?(:keys)
-    instance.get(url + "#{url.include?('?') ? '&' : '?'}background_cache=#{key}")
+    instance.get(url)
     url
   end
   
   private
   
   def self.boot
-    key = set_key!
     instance = AppInstance.new
-    instance.get("/?background_cache_load=#{key}")
-    load RAILS_ROOT + "/lib/background_cache_config.rb"
-    [ key, instance ]
-  end
-  
-  def self.set_key!
-    key = BackgroundCache::Config.key
-    ::ActionController::Base.cache_store.write('background_cache/key', key)
-    key
+    BackgroundCache::Config.load!
+    instance
   end
 end
 

data/require.rb

@@ -18,7 +18,7 @@ Require do
     name 'background_cache'
     homepage "http://github.com/winton/#{name}"
     summary "Bust caches before your users do"
-    version '0.1.1'
+    version '0.1.2'
   end
   
   bin { require 'lib/background_cache' }

data/spec/background_cache_spec.rb

@@ -1,7 +1,5 @@
 require File.dirname(__FILE__) + "/spec_helper"
 
-COMMENT_REGEX = /<!-- ".+" cached .+ -->\n/
-
 describe BackgroundCache do
 
   include Rack::Test::Methods
@@ -16,23 +14,22 @@ describe BackgroundCache do
   
   describe :Controller do
   
-    it "should call load! with background_cache_load parameter" do
-      key = BackgroundCache.set_key!
+    it "should call load! when cache! called" do
       BackgroundCache::Config.should_receive(:load!)
-      get('/', { :background_cache_load => key })
+      BackgroundCache.cache!
     end
   
-    it "should call from_controller with background_cache parameter" do
-      key = BackgroundCache.set_key!
+    it "should call from_controller when cached request happens" do
+      BackgroundCache.cache!
       BackgroundCache::Config.should_receive(:from_controller)
-      get('/', { :background_cache => key })
+      get('/')
     end
     
     it "should alias read_fragment and return null when it is called on matching cache" do
-      key = BackgroundCache.set_key!
-      get('/', { :background_cache_load => key })
-      ::ActionController::Base.cache_store.write('views/test_3', 'bust me')
-      get('/t3', { :background_cache => key })
+      BackgroundCache.cache!
+      get('/')
+      cache_write('test_3', 'bust me')
+      get('/t3')
       last_response.body.should == 'nil'
     end
   end
@@ -47,21 +44,43 @@ describe BackgroundCache do
     
       it "should be caching normally" do
         get('/')
-        ::ActionController::Base.cache_store.read('views/test').should == 'test'
-        ::ActionController::Base.cache_store.write('views/test', 'bust me')
+        cache_read('test').should == 'test'
+        cache_write('test', 'bust me')
         get('/')
-        ::ActionController::Base.cache_store.read('views/test').should == 'bust me'
+        cache_read('test').should == 'bust me'
       end
     
       it "should bust the cache" do
-        ::ActionController::Base.cache_store.write('views/test', 'bust me')
+        cache_write('test', 'bust me')
         BackgroundCache.cache!
-        ::ActionController::Base.cache_store.read('views/test').gsub(COMMENT_REGEX, '').should == 'test'
+        cache_read('test').should == 'test'
       end
       
       it "should render the layout" do
         BackgroundCache.cache!
-        ::ActionController::Base.cache_store.read('views/layout_test_1').gsub(COMMENT_REGEX, '').should == '1'
+        cache_read('layout_test_1').should == '1'
+      end
+    end
+    
+    describe :test_1b do
+    
+      it "should be caching normally" do
+        get('/')
+        cache_read('test').should == 'test'
+        cache_write('test', 'bust me')
+        get('/')
+        cache_read('test').should == 'bust me'
+      end
+    
+      it "should bust the cache (manual override)" do
+        cache_write('test', 'bust me')
+        BackgroundCache.manual('/b')
+        cache_read('test').should == 'test'
+      end
+      
+      it "should not render the layout" do
+        BackgroundCache.manual('/b')
+        cache_read('layout_test_1').should == nil
       end
     end
     
@@ -69,27 +88,27 @@ describe BackgroundCache do
     
       it "should be caching normally" do
         get('/t2')
-        ::ActionController::Base.cache_store.read('views/test_2').should == 'test 2'
-        ::ActionController::Base.cache_store.write('views/test_2', 'bust me')
+        cache_read('test_2').should == 'test 2'
+        cache_write('test_2', 'bust me')
         get('/t2')
-        ::ActionController::Base.cache_store.read('views/test_2').should == 'bust me'
+        cache_read('test_2').should == 'bust me'
       end
     
       it "should bust the cache" do
-        ::ActionController::Base.cache_store.write('views/test_2', 'bust me')
+        cache_write('test_2', 'bust me')
         BackgroundCache.cache!
-        ::ActionController::Base.cache_store.read('views/test_2').gsub(COMMENT_REGEX, '').should == 'test 2'
+        cache_read('test_2').should == 'test 2'
       end
       
       it "should not bust the excluded cache" do
-        ::ActionController::Base.cache_store.write('views/test_1', 'bust me')
+        cache_write('test_1', 'bust me')
         BackgroundCache.cache!
-        ::ActionController::Base.cache_store.read('views/test_1').should == 'bust me'
+        cache_read('test_1').should == 'bust me'
       end
       
       it "should not render the layout" do
         BackgroundCache.cache!
-        ::ActionController::Base.cache_store.read('views/layout_test_2').should == nil
+        cache_read('layout_test_2').should == nil
       end
     end
   end

data/spec/fixtures/rails/config/routes.rb

@@ -43,6 +43,7 @@ ActionController::Routing::Routes.draw do |map|
   #map.connect ':controller/:action/:id.:format'
   
   map.connect '/', :controller => 'application', :action => 'test_1'
+  map.connect '/b', :controller => 'application', :action => 'test_1'
   map.connect '/t2', :controller => 'application', :action => 'test_2'
   map.connect '/t3', :controller => 'application', :action => 'test_3'
 end

data/spec/spec_helper.rb

@@ -5,3 +5,14 @@ Require.spec_helper!
 
 Spec::Runner.configure do |config|
 end
+
+COMMENT_REGEX = /<!-- ".+" cached .+ -->\n/
+
+def cache_read(key)
+  value = ::ActionController::Base.cache_store.read('views/' + key)
+  value ? value.gsub(COMMENT_REGEX, '') : value
+end
+
+def cache_write(key, value)
+  ::ActionController::Base.cache_store.write('views/' + key, value)
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: background_cache
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Winton Welsh
@@ -9,29 +15,41 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-16 00:00:00 -07:00
+date: 2010-09-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack-test
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 5
+        - 3
         version: 0.5.3
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: require
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 2
+        - 7
         version: 0.2.7
-    version: 
+  type: :runtime
+  version_requirements: *id002
 description: 
 email: mail@wintoni.us
 executables: []
@@ -82,21 +100,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Bust caches before your users do