background_cache 0.1.3 → 0.1.4

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.gem
+.bundle
+Gemfile.lock
+pkg
+spec/fixtures/rails/log/*
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/{MIT-LICENSE → LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Winton Welsh
+Copyright (c) 2010
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of 
 this software and associated documentation files (the "Software"), to deal in 

data/{README.markdown → README.md}

@@ -61,4 +61,4 @@ Rake task
 
 Add <code>rake background_cache</code> to cron. All cache configurations are busted every time it is run.
 
-To run a specific group of caches, run <code>rake background\_cache[every\_hour]</code> (as per the example above).
+To run a specific group of caches, run <code>rake background\_cache[every\_hour]</code> (as per the example above).

data/Rakefile

@@ -1,23 +1 @@
-require "#{File.dirname(__FILE__)}/require"
-Require.rakefile!
-
-# You can delete this after you use it
-desc "Rename project"
-task :rename do
-  name = ENV['NAME'] || File.basename(Dir.pwd)
-  begin
-    dir = Dir['**/gem_template*']
-    from = dir.pop
-    if from
-      rb = from.include?('.rb')
-      to = File.dirname(from) + "/#{name}#{'.rb' if rb}"
-      FileUtils.mv(from, to)
-    end
-  end while dir.length > 0
-  Dir["**/*"].each do |path|
-    next if path.include?('Rakefile')
-    if File.file?(path)
-      `sed -i "" 's/gem_template/#{name}/g' #{path}`
-    end
-  end
-end
+require 'bundler/gem_tasks'

data/background_cache.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+root = File.expand_path('../', __FILE__)
+lib = "#{root}/lib"
+
+$:.unshift lib unless $:.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name        = "background_cache"
+  s.version     = '0.1.4'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = [ "Winton Welsh" ]
+  s.email       = [ "mail@wintoni.us" ]
+  s.homepage    = "http://github.com/winton/background_cache"
+  s.summary     = %q{Bust caches before your users do}
+  s.description = %q{Bust caches before your users do.}
+
+  s.executables = `cd #{root} && git ls-files bin/*`.split("\n").collect { |f| File.basename(f) }
+  s.files = `cd #{root} && git ls-files`.split("\n")
+  s.require_paths = %w(lib)
+  s.test_files = `cd #{root} && git ls-files -- {features,test,spec}/*`.split("\n")
+
+  s.add_development_dependency "rack-test", "= 0.5.3"
+  s.add_development_dependency "rails", "= 2.3.10"
+  s.add_development_dependency "rspec", "~> 1.0"
+end

data/bin/background_cache

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require File.expand_path("../../lib/background_cache", __FILE__)

data/lib/background_cache/config.rb

@@ -1,113 +1,117 @@
-require 'digest/sha2'
-
 module BackgroundCache
   class Config
+    
     class <<self
-      attr_accessor :manual
+      attr_accessor :current_cache, :group
     end
+    
     def initialize(&block)
       @@caches = []
       self.instance_eval &block
     end
+    
     def cache(options)
-      # Method-style config
-      @options ||= {}
-      options = @options.merge(options)
-      # Store the cache options
-      @@caches.push({
-        :except => options.delete(:except),
-        :group => options.delete(:group),
-        :layout => options.delete(:layout),
-        :only => options.delete(:only),
-        :path => options.delete(:path),
-        :params => options
-      })
+      @options ||= []
+      options = @options.inject({}) { |hash, option| hash.merge(option) }.merge(options)
+      @@caches << self.class.build_cache(options)
     end
+    
     def except(value, &block)
-      set_option(:except, value, &block)
+      set_option({ :except => value }, &block)
     end
+    
     def group(value, &block)
-      set_option(:group, value, &block)
+      if self.class.group.nil? || value == self.class.group
+        set_option({ :group => value }, &block)
+      end
     end
+    
     def layout(value, &block)
-      set_option(:layout, value, &block)
+      set_option({ :layout => value }, &block)
     end
+    
     def only(value, &block)
-      set_option(:only, value, &block)
+      set_option({ :only => value }, &block)
     end
-    def set_option(key, value, &block)
-      @options ||= {}
-      @options[key] = value
+    
+    def set_option(hash, &block)
+      @options ||= []
+      @options << hash
       if block
+        @last_option_index ||= []
+        @last_option_index << (@options.length - 1)
         yield
-        @options = {}
+        @last_option_index.pop
+        if @last_option_index.empty?
+          @options = []
+        else
+          @options = @options[0..@last_option_index.last]
+        end
       end
       self
     end
-    # Find cache config from params
-    def self.from_controller(controller)
-      from_controller_and_fragment(controller)
+    
+    def self.build_cache(options)
+      {
+        :except => options.delete(:except),
+        :group => options.delete(:group),
+        :layout => options.delete(:layout),
+        :only => options.delete(:only),
+        :path => options.delete(:path),
+        :params => options
+      }
     end
-    def self.from_controller_and_fragment(controller, fragment={})
-      params = controller.params
-      path = controller.request.env['REQUEST_URI']
-      cache =
-        if defined?(@@caches) && !@@caches.empty?
-          @@caches.detect do |item|
-            # Basic params match (action, controller, etc)
+    
+    # Does controller and fragment match current cache?
+    def self.match?(fragment={})
+      cache = self.current_cache
+      cache &&
+      # Basic params match (action, controller, etc)
+      (
+        # No fragment specified
+        fragment.empty? ||
+        (
+          (
+            # :only not defined
+            !cache[:only] ||
+            # :only matches fragment
+            cache[:only] == fragment ||
             (
-              (item[:path] && item[:path] == path) ||
-              item[:params] == params.symbolize_keys
-            ) &&
+              # :only is an array
+              cache[:only].respond_to?(:compact) &&
+              # :only includes matching fragment
+              cache[:only].include?(fragment)
+            )
+          ) &&
+          (
+            # :except not defined
+            !cache[:except] ||
+            # :except not explicitly named
+            cache[:except] != fragment ||
             (
-              # 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 ||
-                  (
-                    # :except is an array
-                    item[:except].respond_to?(:index) &&
-                    # :except does not include matching fragment
-                    !item[:except].include?(fragment)
-                  )
-                )
-              )
+              # :except is an array
+              cache[:except].respond_to?(:compact) &&
+              # :except does not include matching fragment
+              !cache[:except].include?(fragment)
             )
-          end
-        end
-      if !cache && self.manual
-        cache = { :path => path, :layout => false }
-      end
-      cache
+          )
+        )
+      )
     end
+    
     def self.caches
       defined?(@@caches) ? @@caches : []
     end
-    def self.key
-      Digest::SHA256.hexdigest("--#{Time.now}--#{rand}--")
-    end
-    def self.load!
+    
+    def self.load!(group=nil)
+      self.group = group
       load RAILS_ROOT + "/lib/background_cache_config.rb"
+      self.group = nil
     end
+    
     def self.unload!
       @@caches = []
-      self.manual = nil
+      self.current_cache = nil
     end
   end
 end

data/lib/background_cache/controller.rb

@@ -1,15 +1,16 @@
 module BackgroundCache
   module Controller
+    
     def self.included(base)
       base.alias_method_chain :read_fragment, :background_cache
+      base.alias_method_chain :render, :background_cache
       base.around_filter BackgroundCacheFilter.new
     end
       
     private
     
     def read_fragment_with_background_cache(key, options=nil)
-      cache = BackgroundCache::Config.from_controller_and_fragment(self, key)
-      if cache
+      if BackgroundCache.active? && BackgroundCache.match?(key)
         RAILS_DEFAULT_LOGGER.info "Cached fragment busted (read_fragment method): #{key}"
         nil
       else
@@ -17,20 +18,33 @@ module BackgroundCache
       end
     end
     
+    def render_with_background_cache(options = nil, extra_options = {}, &block)
+      if BackgroundCache.active? && BackgroundCache::Config.current_cache[:layout] == false
+        [ options, extra_options ].each do |opts|
+          if opts.respond_to?(:keys) && (opts[:layout] || opts['layout'])
+            opts[opts[:layout] ? :layout : 'layout'] = false
+          end
+        end
+      end
+      render_without_background_cache(options, extra_options, &block)
+    end
+    
     class BackgroundCacheFilter
+      
       def before(controller)
-        unless BackgroundCache::Config.caches.empty?
-          cache = BackgroundCache::Config.from_controller(controller)
-          # Store current layout, then disable it
-          if cache && cache[:layout] == false
+        cache = BackgroundCache::Config.current_cache
+        if cache
+          if cache[:layout] == false
             @background_cache_layout = controller.active_layout
             controller.class.layout(false)
+          else
+            @background_cache_layout = nil
           end
         end
         true
       end
+      
       def after(controller)
-        # Restore layout
         if @background_cache_layout
           controller.class.layout(@background_cache_layout)
         end

data/lib/background_cache/helper.rb

@@ -1,23 +1,30 @@
 module BackgroundCache
   module Helper
+    
     def self.included(base)
       base.alias_method_chain :cache, :background_cache
     end
+    
     def cache_with_background_cache(name = {}, options = nil, &block)
       # 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
+        cache = @controller.read_fragment(name, options)
+        match = (
+          BackgroundCache.active? &&
+          BackgroundCache.match?(name)
+        )
+        if !cache || match
           pos = output_buffer.length
           block.call
           output = [
-            "<!-- #{name.inspect} cached #{Time.now.strftime("%m/%d/%Y at %I:%M %p")} -->",
+            "<!-- #{name.inspect}#{' background' if match} cached #{Time.now.strftime("%m/%d/%Y at %I:%M %p")} -->",
             output_buffer[pos..-1]
           ].join("\n")
           @controller.write_fragment(name, output, options)
+        else
+          output_buffer.concat(cache)
         end
       else
         block.call

data/lib/background_cache/mem_cache.rb

@@ -0,0 +1,20 @@
+module BackgroundCache
+  module Memcache
+    
+    def self.included(base)
+      base.alias_method_chain :get, :background_cache
+    end
+
+    def get_with_background_cache(key, raw=false)
+      match = (
+        BackgroundCache.active? &&
+        BackgroundCache.match?(key)
+      )
+      if match
+        nil
+      else
+        get_without_background_cache(key, raw)
+      end
+    end
+  end
+end

data/lib/background_cache.rb

@@ -1,5 +1,14 @@
-require File.expand_path("#{File.dirname(__FILE__)}/../require")
-Require.lib!
+gem 'rack-test', '=0.5.3'
+
+require 'digest/sha2'
+require 'rack/test'
+
+$:.unshift File.dirname(__FILE__)
+
+require 'background_cache/config'
+require 'background_cache/controller'
+require 'background_cache/helper'
+require 'background_cache/mem_cache'
 
 module BackgroundCache
   
@@ -11,34 +20,48 @@ module BackgroundCache
     end
   end
   
+  def self.active?
+    BackgroundCache::Config.current_cache
+  end
+
   def self.cache!(group=nil)
     instance = self.boot
+    BackgroundCache::Config.load!(group)
     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)
+      self.manual(cache, instance)
     end
   end
-  
-  def self.manual(url)
-    instance = self.boot
-    BackgroundCache::Config.manual = true
-    url = instance.url_for(url.merge(:only_path => true)) if url.respond_to?(:keys)
+
+  def self.manual(cache, instance=nil)
+    unless instance
+      instance = self.boot
+    end
+    BackgroundCache::Config.current_cache = cache
+    url = cache[:path] || instance.url_for(cache[:params].merge(:only_path => true))
+    puts "(#{cache[:group]}) #{url}"
     instance.get(url)
+    BackgroundCache::Config.current_cache = nil
     url
   end
   
+  def self.match?(fragment={})
+    BackgroundCache::Config.match?(fragment)
+  end
+
   private
-  
+
   def self.boot
     instance = AppInstance.new
-    BackgroundCache::Config.load!
     instance
   end
 end
 
-def BackgroundCache(url)
-  BackgroundCache.manual(url)
+def BackgroundCache(path, layout=false)
+  BackgroundCache.manual(
+    BackgroundCache::Config.build_cache(
+      path.respond_to?(:keys) ? path : { :path => path, :layout => layout }
+    )
+  )
 end

data/rails/init.rb

@@ -1,5 +1,10 @@
-require File.expand_path("#{File.dirname(__FILE__)}/../require")
-Require.rails_init!
+begin
+  require 'memcache'
+rescue LoadError
+end
+
+require File.expand_path('../../lib/background_cache.rb', __FILE__)
 
 ActionController::Base.send(:include, BackgroundCache::Controller)
-ActionView::Helpers::CacheHelper.send(:include, BackgroundCache::Helper)
+ActionView::Helpers::CacheHelper.send(:include, BackgroundCache::Helper)
+::MemCache.send(:include, BackgroundCache::Memcache) if defined?(::MemCache)

data/spec/background_cache_spec.rb

@@ -18,16 +18,12 @@ describe BackgroundCache do
       BackgroundCache::Config.should_receive(:load!)
       BackgroundCache.cache!
     end
-  
-    it "should call from_controller when cached request happens" do
-      BackgroundCache.cache!
-      BackgroundCache::Config.should_receive(:from_controller)
-      get('/')
-    end
     
     it "should alias read_fragment and return null when it is called on matching cache" do
       BackgroundCache.cache!
-      get('/')
+      BackgroundCache::Config.current_cache = BackgroundCache::Config.caches.detect do |cache|
+        cache[:params][:action] == 'test_3'
+      end
       cache_write('test_3', 'bust me')
       get('/t3')
       last_response.body.should == 'nil'
@@ -74,12 +70,12 @@ describe BackgroundCache do
     
       it "should bust the cache (manual override)" do
         cache_write('test', 'bust me')
-        BackgroundCache.manual('/b')
+        BackgroundCache('/b')
         cache_read('test').should == 'test'
       end
       
       it "should not render the layout" do
-        BackgroundCache.manual('/b')
+        BackgroundCache('/b')
         cache_read('layout_test_1').should == nil
       end
     end
@@ -111,5 +107,21 @@ describe BackgroundCache do
         cache_read('layout_test_2').should == nil
       end
     end
+    
+    describe :test_3 do
+    
+      it "should be caching normally" do
+        get('/t3')
+        cache_read('layout_test_3').should == '1'
+        cache_write('layout_test_3', 'bust me')
+        get('/t3')
+        cache_read('layout_test_3').should == 'bust me'
+      end
+      
+      it "should not render the layout" do
+        BackgroundCache.cache!
+        cache_read('layout_test_3').should == nil
+      end
+    end
   end
 end

data/spec/fixtures/rails/app/controllers/application_controller.rb

@@ -9,6 +9,6 @@ class ApplicationController < ActionController::Base
   # filter_parameter_logging :password
   
   def test_3
-    render :text => read_fragment('test_3').inspect, :layout => false
+    render :text => read_fragment('test_3').inspect, :layout => 'application'
   end
 end

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

@@ -1,7 +1,7 @@
 # Be sure to restart your server when you modify this file
 
 # Specifies gem version of Rails to use when vendor/rails is not present
-RAILS_GEM_VERSION = '2.3.5' unless defined? RAILS_GEM_VERSION
+RAILS_GEM_VERSION = '2.3.10' unless defined? RAILS_GEM_VERSION
 
 # Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')

data/spec/fixtures/rails/lib/background_cache_config.rb

@@ -1,15 +1,15 @@
-BackgroundCache::Config.new do |config|
-  config.cache(
-    :path => '/'
-  )
-  config.layout(false).only('test_2') do
-    config.cache(
+BackgroundCache::Config.new do
+  cache(:path => '/')
+  layout(false) do
+    only('test_2') do
+      cache(
+        :controller => 'application',
+        :action => 'test_2'
+      )
+    end
+    cache(
       :controller => 'application',
-      :action => 'test_2'
+      :action => 'test_3'
     )
   end
-  config.cache(
-    :controller => 'application',
-    :action => 'test_3'
-  )
 end

data/spec/spec_helper.rb

@@ -1,12 +1,14 @@
-RAILS_ENV = 'production'
+require "pp"
+require "bundler"
 
-require File.expand_path("#{File.dirname(__FILE__)}/../require")
-Require.spec_helper!
+Bundler.require(:development)
 
-Spec::Runner.configure do |config|
-end
+COMMENT_REGEX = /<!-- .+ cached .+ -->\n/
+RAILS_ENV = 'production'
+
+require 'spec/fixtures/rails/config/environment'
 
-COMMENT_REGEX = /<!-- ".+" cached .+ -->\n/
+$root = File.expand_path('../../', __FILE__)
 
 def cache_read(key)
   value = ::ActionController::Base.cache_store.read('views/' + key)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: background_cache
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
+  hash: 19
+  prerelease: 
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Winton Welsh
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-15 00:00:00 -07:00
-default_executable: 
+date: 2011-10-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack-test
@@ -32,43 +31,63 @@ dependencies:
         - 5
         - 3
         version: 0.5.3
-  type: :runtime
+  type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: require
+  name: rails
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 23
         segments: 
-        - 0
         - 2
-        - 7
-        version: 0.2.7
-  type: :runtime
+        - 3
+        - 10
+        version: 2.3.10
+  type: :development
   version_requirements: *id002
-description: 
-email: mail@wintoni.us
-executables: []
-
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id003
+description: Bust caches before your users do.
+email: 
+- mail@wintoni.us
+executables: 
+- background_cache
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- background_cache.gemspec
+- bin/background_cache
 - init.rb
+- lib/background_cache.rb
 - lib/background_cache/config.rb
 - lib/background_cache/controller.rb
 - lib/background_cache/helper.rb
-- lib/background_cache.rb
-- MIT-LICENSE
+- lib/background_cache/mem_cache.rb
 - rails/init.rb
-- Rakefile
-- README.markdown
-- require.rb
 - spec/background_cache_spec.rb
 - spec/fixtures/rails/app/controllers/application_controller.rb
 - spec/fixtures/rails/app/helpers/application_helper.rb
@@ -90,7 +109,6 @@ files:
 - spec/fixtures/rails/lib/background_cache_config.rb
 - spec/spec_helper.rb
 - tasks/background_cache.rake
-has_rdoc: true
 homepage: http://github.com/winton/background_cache
 licenses: []
 
@@ -120,9 +138,28 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Bust caches before your users do
-test_files: []
-
+test_files: 
+- spec/background_cache_spec.rb
+- spec/fixtures/rails/app/controllers/application_controller.rb
+- spec/fixtures/rails/app/helpers/application_helper.rb
+- spec/fixtures/rails/app/views/application/test_1.html.erb
+- spec/fixtures/rails/app/views/application/test_2.html.erb
+- spec/fixtures/rails/app/views/layouts/application.html.erb
+- spec/fixtures/rails/config/boot.rb
+- spec/fixtures/rails/config/environment.rb
+- spec/fixtures/rails/config/environments/development.rb
+- spec/fixtures/rails/config/environments/production.rb
+- spec/fixtures/rails/config/environments/test.rb
+- spec/fixtures/rails/config/initializers/backtrace_silencers.rb
+- spec/fixtures/rails/config/initializers/inflections.rb
+- spec/fixtures/rails/config/initializers/mime_types.rb
+- spec/fixtures/rails/config/initializers/new_rails_defaults.rb
+- spec/fixtures/rails/config/initializers/session_store.rb
+- spec/fixtures/rails/config/locales/en.yml
+- spec/fixtures/rails/config/routes.rb
+- spec/fixtures/rails/lib/background_cache_config.rb
+- spec/spec_helper.rb

data/require.rb

@@ -1,47 +0,0 @@
-require 'rubygems'
-gem 'require'
-require 'require'
-
-Require do
-  gem :require, '=0.2.7'
-  gem(:'rack-test', '=0.5.3') { require 'rack/test' }
-  gem(:rake, '=0.8.7') { require 'rake' }
-  gem :rspec, '=1.3.0'
-  
-  gemspec do
-    author 'Winton Welsh'
-    dependencies do
-      gem :'rack-test'
-      gem :require
-    end
-    email 'mail@wintoni.us'
-    name 'background_cache'
-    homepage "http://github.com/winton/#{name}"
-    summary "Bust caches before your users do"
-    version '0.1.3'
-  end
-  
-  bin { require 'lib/background_cache' }
-  
-  lib do
-    gem :'rack-test'
-    require 'lib/background_cache/config'
-    require 'lib/background_cache/controller'
-    require 'lib/background_cache/helper'
-  end
-  
-  rails_init { require 'lib/background_cache' }
-  
-  rakefile do
-    gem(:rake) { require 'rake/gempackagetask' }
-    gem(:rspec) { require 'spec/rake/spectask' }
-    require 'require/tasks'
-  end
-  
-  spec_helper do
-    gem :'rack-test'
-    require 'require/spec_helper'
-    require 'pp'
-    require 'spec/fixtures/rails/config/environment'
-  end
-end