background_cache 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Winton Welsh
+
+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 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,64 @@
+BackgroundCache
+===============
+
+Bust caches before your users do (in your Rails app).
+
+Requirements
+------------
+
+<pre>
+sudo gem install background_cache
+</pre>
+
+### config/environment.rb
+
+<pre>
+config.gem 'background_cache'
+</pre>
+
+Dynamic Configuration
+---------------------
+
+Create *lib/background\_cache\_config.rb*:
+
+<pre>
+BackgroundCache::Config.new do
+
+  # Configure a background cache in one call
+  
+  Tag::League.find(:all).each do |tag|
+    cache(
+      # Route params
+      :controller => 'sections',
+      :action => 'teams',
+      :tag => tag.permalink,
+      
+      # Background cache options
+      :group => 'every_hour',
+      :layout => false,
+      :only => "sections_teams_#{tag.permalink}"
+    )
+  end
+  
+  # Configure using block methods
+  
+  group('every_hour').layout(false).only("sections_teams_#{tag.permalink}") do
+    Tag::League.find(:all).each do |tag|
+      cache("/#{tag.permalink}")
+    end
+  end
+end
+</pre>
+
+The <code>cache</code> method takes route parameters or a path.
+
+The <code>only</code> and <code>except</code> methods/options take fragment ids or arrays of fragment ids.
+
+If no fragment is specified, all of the action's caches will regenerate.
+
+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).

data/Rakefile

@@ -0,0 +1,23 @@
+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

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/background_cache/config.rb

@@ -0,0 +1,121 @@
+require 'digest/sha2'
+
+module BackgroundCache
+  class Config
+    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
+      })
+    end
+    def except(value, &block)
+      set_option(:except, value, &block)
+    end
+    def group(value, &block)
+      set_option(:group, value, &block)
+    end
+    def layout(value, &block)
+      set_option(:layout, value, &block)
+    end
+    def only(value, &block)
+      set_option(:only, value, &block)
+    end
+    def set_option(key, value, &block)
+      @options ||= {}
+      @options[key] = value
+      if block
+        yield
+        @options = {}
+      end
+      self
+    end
+    # Find cache config from params
+    def self.from_controller(controller)
+      from_controller_and_fragment(controller)
+    end
+    def self.from_controller_and_fragment(controller, fragment={})
+      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? ||
+            (
+              (
+                # :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)
+                )
+              )
+            )
+          )
+        end
+      end
+    end
+    def self.caches
+      @@caches
+    end
+    def self.key
+      Digest::SHA256.hexdigest("--#{Time.now}--#{rand}--")
+    end
+    def self.load!
+      load RAILS_ROOT + "/lib/background_cache_config.rb"
+    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('/')
+    end
+  end
+end

data/lib/background_cache/controller.rb

@@ -0,0 +1,57 @@
+module BackgroundCache
+  module Controller
+    def self.included(base)
+      base.alias_method_chain :read_fragment, :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
+        RAILS_DEFAULT_LOGGER.info "Cached fragment busted (read_fragment method): #{key}"
+        nil
+      else
+        read_fragment_without_background_cache(key, options)
+      end
+    end
+    
+    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
+          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
+        end
+      end
+    end
+  end
+end

data/lib/background_cache/helper.rb

@@ -0,0 +1,25 @@
+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)
+      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)
+      else
+        cache_without_background_cache(name, options, &block)
+      end
+    end
+  end
+end

data/lib/background_cache.rb

@@ -0,0 +1,51 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../require")
+Require.lib!
+
+module BackgroundCache
+  
+  class AppInstance
+    include ActionController::UrlWriter
+    include Rack::Test::Methods
+    def app
+      ActionController::Dispatcher.new
+    end
+  end
+  
+  def self.cache!(group=nil)
+    key, 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}")
+    end
+  end
+  
+  def self.manual(url)
+    key, instance = boot
+    url = instance.url_for(url.merge(:only_path => true)) if url.respond_to?(:keys)
+    instance.get(url + "#{url.include?('?') ? '&' : '?'}background_cache=#{key}")
+    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
+  end
+end
+
+def BackgroundCache(url)
+  BackgroundCache.manual(url)
+end

data/rails/init.rb

@@ -0,0 +1,5 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../require")
+Require.rails_init!
+
+ActionController::Base.send(:include, BackgroundCache::Controller)
+ActionView::Helpers::CacheHelper.send(:include, BackgroundCache::Helper)

data/require.rb

@@ -0,0 +1,47 @@
+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.0'
+  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

data/spec/background_cache_spec.rb

@@ -0,0 +1,96 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+COMMENT_REGEX = /<!-- ".+" cached .+ -->\n/
+
+describe BackgroundCache do
+
+  include Rack::Test::Methods
+
+  def app
+    ActionController::Dispatcher.new
+  end
+  
+  before(:each) do
+    BackgroundCache::Config.unload!
+  end
+  
+  describe :Controller do
+  
+    it "should call load! with background_cache_load parameter" do
+      key = BackgroundCache.set_key!
+      BackgroundCache::Config.should_receive(:load!)
+      get('/', { :background_cache_load => key })
+    end
+  
+    it "should call from_controller with background_cache parameter" do
+      key = BackgroundCache.set_key!
+      BackgroundCache::Config.should_receive(:from_controller)
+      get('/', { :background_cache => key })
+    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 })
+      last_response.body.should == 'nil'
+    end
+  end
+  
+  describe :cache! do
+    
+    before(:each) do
+      ::ActionController::Base.cache_store.clear
+    end
+    
+    describe :test_1 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')
+        get('/')
+        ::ActionController::Base.cache_store.read('views/test').should == 'bust me'
+      end
+    
+      it "should bust the cache" do
+        ::ActionController::Base.cache_store.write('views/test', 'bust me')
+        BackgroundCache.cache!
+        ::ActionController::Base.cache_store.read('views/test').gsub(COMMENT_REGEX, '').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'
+      end
+    end
+    
+    describe :test_2 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')
+        get('/t2')
+        ::ActionController::Base.cache_store.read('views/test_2').should == 'bust me'
+      end
+    
+      it "should bust the cache" do
+        ::ActionController::Base.cache_store.write('views/test_2', 'bust me')
+        BackgroundCache.cache!
+        ::ActionController::Base.cache_store.read('views/test_2').gsub(COMMENT_REGEX, '').should == 'test 2'
+      end
+      
+      it "should not bust the excluded cache" do
+        ::ActionController::Base.cache_store.write('views/test_1', 'bust me')
+        BackgroundCache.cache!
+        ::ActionController::Base.cache_store.read('views/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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+  
+  def test_3
+    render :text => read_fragment('test_3').inspect, :layout => false
+  end
+end

data/spec/fixtures/rails/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/spec/fixtures/rails/app/views/application/test_1.html.erb

@@ -0,0 +1 @@
+<% cache 'test' do -%>test<% end -%>

data/spec/fixtures/rails/app/views/application/test_2.html.erb

@@ -0,0 +1,2 @@
+<% cache 'test_1' do -%>test<% end -%>
+<% cache 'test_2' do -%>test 2<% end -%>

data/spec/fixtures/rails/app/views/layouts/application.html.erb

@@ -0,0 +1,4 @@
+<html><body>
+	<% cache "layout_#{params[:action]}" do -%>1<% end -%>
+	<%= yield %>
+</body></html>

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

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

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

@@ -0,0 +1,45 @@
+# 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
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+  
+  parent_dir = File.expand_path(File.dirname(__FILE__) + "/../../../../../")
+  config.plugin_paths = [ parent_dir ]
+  config.plugins = [ 'background_cache' ]
+end

data/spec/fixtures/rails/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/spec/fixtures/rails/config/environments/production.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true
+
+# See everything in the log (default is :info)
+# config.log_level = :debug
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false
+
+# Enable threaded mode
+# config.threadsafe!

data/spec/fixtures/rails/config/environments/test.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql

data/spec/fixtures/rails/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying do debug a problem that might steem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/fixtures/rails/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/spec/fixtures/rails/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/spec/fixtures/rails/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,21 @@
+# Be sure to restart your server when you modify this file.
+
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+ActionController::Routing.generate_best_match = false
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/spec/fixtures/rails/config/initializers/session_store.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying cookie session data integrity.
+# If you change this key, all old sessions will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.session = {
+  :key         => '_rails_session',
+  :secret      => '2d856fb7e64d38ed267dcfa20309b82d4d7d655d4182af025ab09b8e304620c4c7a23268ca349fa58e2de65aa33f67f38d005270b1f8ee9e5a56d7abfbda47d3'
+}
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# ActionController::Base.session_store = :active_record_store

data/spec/fixtures/rails/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

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

@@ -0,0 +1,48 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing or commenting them out if you're using named routes and resources.
+  
+  #map.connect ':controller/:action/:id'
+  #map.connect ':controller/:action/:id.:format'
+  
+  map.connect '/', :controller => 'application', :action => 'test_1'
+  map.connect '/t2', :controller => 'application', :action => 'test_2'
+  map.connect '/t3', :controller => 'application', :action => 'test_3'
+end

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

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

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+RAILS_ENV = 'production'
+
+require File.expand_path("#{File.dirname(__FILE__)}/../require")
+Require.spec_helper!
+
+Spec::Runner.configure do |config|
+end

data/tasks/background_cache.rake

@@ -0,0 +1,4 @@
+desc "Background cache cron job"
+task :background_cache, :group, :needs => :environment do |t, args|
+  BackgroundCache.cache! args[:group]
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: background_cache
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Winton Welsh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-08 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 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: require
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.2.7
+    version: 
+description: 
+email: mail@wintoni.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- init.rb
+- lib/background_cache/config.rb
+- lib/background_cache/controller.rb
+- lib/background_cache/helper.rb
+- lib/background_cache.rb
+- MIT-LICENSE
+- 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
+- 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
+- tasks/background_cache.rake
+has_rdoc: true
+homepage: http://github.com/winton/background_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Bust caches before your users do
+test_files: []
+