preheat 0.1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+.DS_Store
+pkg
+doc
+

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "preheat"
+    gemspec.summary = "Keep your Rails.cache warm"
+    gemspec.description = "Keep your Rails.cache warm"
+    gemspec.email = "tomhallett@gmail.com"
+    gemspec.homepage = "http://github.com/tommyh/preheat"
+    gemspec.authors = ["Tom Hallett"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/preheat.rb

@@ -0,0 +1,31 @@
+class ActiveSupport::Cache::Store
+
+  def fetch_with_force(name, options = {})
+    options.merge!({:force => true})
+    if block_given?
+      fetch_without_force(name, options) do
+        yield
+      end
+    else
+      fetch_without_force(name, options)
+    end
+  end
+
+  #the singleton class_eval workaround for the aliasing is due to this issue:
+  # http://newsgroups.derkeiler.com/Archive/Comp/comp.lang.ruby/2006-05/msg00575.html
+  def enable_preheat
+    (class << self; self; end).class_eval { alias_method_chain :fetch, :force }
+  end
+
+  def disable_preheat
+    (class << self; self; end).class_eval { alias_method :fetch, :fetch_without_force }
+  end
+end
+
+module Preheat
+  def self.it
+    RAILS_CACHE.enable_preheat
+    yield if block_given?
+    RAILS_CACHE.disable_preheat
+  end
+end

data/spec/lib/preheat_spec.rb

@@ -0,0 +1,213 @@
+require 'rubygems'
+require 'spec'
+require 'active_support'
+require 'lib/preheat'
+
+describe ActiveSupport::Cache do
+
+  before do
+    @cache = ActiveSupport::Cache.lookup_store(:memory_store)
+    @cache.clear
+  end
+
+  describe "#fetch_with_force" do
+
+    context "block is not given" do
+
+      it "should set :force to true if its not set" do
+        @cache.should_receive(:fetch_without_force).with("city", hash_including(:force => true))
+        @cache.fetch_with_force("city")
+      end
+
+      [true, false].each do |force_value|
+        it "should keep :force to true if it is set to #{force_value}" do
+          @cache.should_receive(:fetch_without_force).with("city", hash_including(:force => true))
+          @cache.fetch_with_force("city", :force => force_value)
+        end
+      end
+
+      context "after preheat has been enabled" do
+        before do
+          @cache.enable_preheat
+        end
+
+        it "should correctly force a cache miss" do
+          @cache.read("dog").should be_nil
+          @cache.write("dog", "beagle").should == "beagle"
+          @cache.fetch("dog").should be_nil
+          @cache.read("dog").should == "beagle"
+        end
+      end
+    end
+
+    context "block is given" do
+      it "should set :force to true if its not set" do
+        @cache.should_receive(:fetch_without_force).with("city", hash_including(:force => true))
+        @cache.fetch_with_force("city") do
+          "London"
+        end
+      end
+
+      [true, false].each do |force_value|
+        it "should keep :force to true if it is set to #{force_value}" do
+          @cache.should_receive(:fetch_without_force).with("city", hash_including(:force => true))
+          @cache.fetch_with_force("city", :force => force_value) do
+            "London"
+          end
+        end
+      end
+
+      it "should call fetch_without_force with a block" do
+        @cache.should_receive(:fetch_without_force).with("city", hash_including(:force => true)).and_yield(anything)
+        @cache.fetch_with_force("city") do
+          "foo"
+        end
+      end
+
+      context "after preheat has been enabled" do
+        before do
+          @cache.enable_preheat
+        end
+
+        it "should correctly set the cache" do
+          @cache.read("dog").should be_nil
+          @cache.write("dog", "beagle").should == "beagle"
+          @cache.fetch("dog") do
+            "spaniel"
+          end.should == "spaniel"
+          @cache.read("dog").should == "spaniel"
+        end
+      end
+
+
+    end
+  end
+
+
+  describe "#enable_preheat" do
+    it "should switch force to be true for all fetch calls after it" do
+      @cache.should_receive(:fetch).exactly(2).times.with("before-enable")
+      @cache.should_receive(:fetch).exactly(2).times.with("after-enable",hash_including(:force => true))
+
+      @cache.fetch("before-enable")
+      @cache.fetch("before-enable") do
+        "Foo"
+      end
+
+      @cache.enable_preheat
+      @cache.fetch("after-enable")
+      @cache.fetch("after-enable") do
+        "Foo"
+      end
+    end
+  end
+
+  describe "#disable_preheat" do
+    it "should switch force to be default active support behavior for all fetch calls after it" do
+      @cache.should_receive(:fetch).exactly(2).times.with("after-disable")
+      @cache.should_receive(:fetch).exactly(2).times.with("before-disable",hash_including(:force => true))
+
+      @cache.enable_preheat
+      @cache.fetch("before-disable")
+      @cache.fetch("before-disable") do
+        "Foo"
+      end
+      @cache.disable_preheat
+      @cache.fetch("after-disable")
+      @cache.fetch("after-disable") do
+        "Foo"
+      end
+
+    end
+  end
+
+end
+
+
+describe Preheat do
+
+
+  before do
+    @cache = ActiveSupport::Cache.lookup_store(:memory_store)
+    silence_warnings {
+      Object.const_set "RAILS_CACHE", @cache
+    }
+    @cache.clear
+  end
+
+  describe "it" do
+
+    context "no block given" do
+      it "should enable preheat when called" do
+        @cache.should_receive(:enable_preheat)
+        @cache.stub!(:disable_preheat)
+        Preheat.it
+      end
+
+      it "should disable preheat when called" do
+        @cache.stub!(:enable_preheat)
+        @cache.should_receive(:disable_preheat)
+        Preheat.it
+      end
+    end
+
+    context "block given" do
+      it "should enable preheat when called" do
+        @cache.should_receive(:enable_preheat)
+        @cache.stub!(:disable_preheat)
+        Preheat.it do
+          "hello"
+        end
+      end
+
+      it "should disable preheat when called" do
+        @cache.stub!(:enable_preheat)
+        @cache.should_receive(:disable_preheat)
+        Preheat.it do
+          "goodbye"
+        end
+      end
+
+      it "should execute the block given" do
+        Preheat.it do
+          @cache.fetch("city") do
+            "test"
+          end
+        end
+        @cache.read("city").should == "test"
+      end
+    end
+
+  end
+
+
+  context "integration tests" do
+
+    it "should not suck :)" do
+      @cache.read("dog").should be_nil
+      @cache.write("dog", "beagle").should == "beagle"
+      @cache.fetch("dog").should == "beagle"
+      @cache.fetch("dog") do
+        "poodle"
+      end.should == "beagle"
+      @cache.fetch("dog", :force => true) do
+        "lab"
+      end.should == "lab"
+
+      @cache.fetch("dog") do
+        "spaniel"
+      end.should == "lab"
+
+      Preheat.it do
+        @cache.fetch("dog") do
+          "pug"
+        end.should == "pug"
+      end
+
+      @cache.read("dog").should == "pug"
+      @cache.fetch("dog") do
+        "bulldog"
+      end.should == "pug"
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: preheat
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tom Hallett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-28 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: Keep your Rails.cache warm
+email: tomhallett@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/preheat.rb
+- spec/lib/preheat_spec.rb
+has_rdoc: true
+homepage: http://github.com/tommyh/preheat
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Keep your Rails.cache warm
+test_files: 
+- spec/lib/preheat_spec.rb