preheatable_cache 0.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+gem 'rake'
+gem 'rspec'
+gem 'memcache-client', :require => 'memcache'
+gem 'activesupport', '2.3.8', :require => 'active_support'
+gem 'actionpack', '2.3.8', :require => 'action_pack'

data/Gemfile.lock

@@ -0,0 +1,21 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (2.3.8)
+      activesupport (= 2.3.8)
+      rack (~> 1.1.0)
+    activesupport (2.3.8)
+    memcache-client (1.8.5)
+    rack (1.1.0)
+    rake (0.8.7)
+    rspec (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (= 2.3.8)
+  activesupport (= 2.3.8)
+  memcache-client
+  rake
+  rspec

data/Rakefile

@@ -0,0 +1,19 @@
+task :default => :spec
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color --backtrace']}
+
+begin
+  require 'jeweler'
+  project_name = 'preheatable_cache'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.summary = "Reduce cache requests by preheating via multi_get"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/Readme.md

@@ -0,0 +1,27 @@
+Reduce cache requests by preheating via multi_get.
+
+Makes Rails MemCacheStore preheatable via read_multi, for keys that will later be used.  
+Clears the preheated cache after each request.
+
+ - not threadsave
+ - not altered when writing/incrementing/... underlying cache store
+
+# Install
+    script/plugin install http://github.com/grosser/preheatable_cache
+
+# Usage
+
+    # controller - multi_get to fetch all keys at once
+    Rails.cache.preheat @products.map{|p| "views/product_#{p.id}" }
+
+    # view - no requests to the cache server
+    <% cache "product_#{product.id}" do %>
+      ...
+    <% end %>
+
+
+Author
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

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

data/init.rb

@@ -0,0 +1 @@
+require 'preheatable_cache'

data/lib/preheatable_cache.rb

@@ -0,0 +1,73 @@
+module PreheatableCache
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+  
+  NULL = 'preheatable_cache:null'
+
+  def self.included(base)
+    base.class_eval do
+      def read_with_preheatable_cache(key, options=nil)
+        if not @preheatable_cache
+          return read_without_preheatable_cache(key, options)
+        end
+
+        locally_cached = @preheatable_cache[key]
+        if locally_cached == NULL
+          nil
+        elsif locally_cached.nil?
+          read_without_preheatable_cache(key, options)
+        else
+          # keep preheatable cached immutable
+          locally_cached.duplicable? ? locally_cached.dup : locally_cached
+        end
+      end
+
+      alias_method_chain :read, :preheatable_cache
+    end
+  end
+
+  def preheat(keys)
+    @preheatable_cache ||= {}
+
+    data = fetch_via_read_multi(keys)
+    store_into_preheatable_cache data
+    add_cache_clearing_callback
+
+    data
+  end
+
+  def clear_preheatable_cache
+    @preheatable_cache = nil
+  end
+
+  private
+
+  def add_cache_clearing_callback
+    return if @clear_callback_added
+    @clear_callback_added = true
+    ActionDispatch::Callbacks.before proc{ clear_preheatable_cache }
+  end
+
+  def fetch_via_read_multi(keys)
+    if respond_to?(:read_multi)
+      hash = read_multi(keys)
+      # add keys for unfound values
+      keys.each{|k| hash[k] = nil if hash[k].nil? }
+      hash
+    else
+      keys.map{|key| read_without_preheatable_cache(key) }
+    end
+  end
+
+  def store_into_preheatable_cache(data)
+    data.each do |key, value|
+      @preheatable_cache[key] = if value.nil?
+        NULL
+      else
+        value
+      end
+    end
+  end
+end
+
+# must be included in lowest classes, to overwrite reads
+ActiveSupport::Cache::MemCacheStore.send(:include, PreheatableCache)

data/preheatable_cache.gemspec

@@ -0,0 +1,44 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{preheatable_cache}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2010-08-14}
+  s.email = %q{grosser.michael@gmail.com}
+  s.files = [
+    "Gemfile",
+     "Gemfile.lock",
+     "Rakefile",
+     "Readme.md",
+     "VERSION",
+     "init.rb",
+     "lib/preheatable_cache.rb",
+     "preheatable_cache.gemspec",
+     "spec/preheatable_cache_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/preheatable_cache}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Reduce cache requests by preheating via multi_get}
+  s.test_files = [
+    "spec/preheatable_cache_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/spec/preheatable_cache_spec.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+
+$LOAD_PATH << 'lib'
+require 'active_support/all' # very messy to get working with 2.3 otherwise
+require 'action_controller'
+require 'preheatable_cache'
+
+describe PreheatableCache do
+  let(:cache){ ActiveSupport::Cache::MemCacheStore.new }
+  let(:store){ cache.instance_variable_get '@data' }
+
+  describe :read do
+    before do
+      store.set('xxx', nil)
+    end
+
+    it "reads nil as usual" do
+      cache.read('xxx').should == nil
+    end
+
+    it "reads as usual" do
+      store.set('xxx', 1)
+      cache.read('xxx').should == 1
+    end
+
+    it "uses get when reading" do
+      cache.write('xxx', 1)
+      store.should_receive(:get).and_return 2
+      cache.read('xxx').should == 2
+    end
+
+    it "does not use get when it is preheated" do
+      cache.write('xxx', 1)
+      cache.preheat ['xxx']
+      store.should_not_receive(:get)
+      cache.read('xxx')
+    end
+
+    it "does not use get when it is preheated with nil" do
+      cache.preheat ['xxx']
+      store.should_not_receive(:get)
+      cache.read('xxx').should == nil
+    end
+
+    it "uses get when preheated cache was cleared" do
+      cache.write('xxx', 1)
+      cache.preheat ['xxx']
+      cache.clear_preheatable_cache
+      store.should_receive(:get).and_return 2
+      cache.read('xxx').should == 2
+    end
+  end
+
+  it "has a VERSION" do
+    PreheatableCache::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: preheatable_cache
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-14 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- VERSION
+- init.rb
+- lib/preheatable_cache.rb
+- preheatable_cache.gemspec
+- spec/preheatable_cache_spec.rb
+has_rdoc: true
+homepage: http://github.com/grosser/preheatable_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Reduce cache requests by preheating via multi_get
+test_files: 
+- spec/preheatable_cache_spec.rb