aub-cache_advance 1.0.9 → 1.1.0

data/cache_advance.gemspec

@@ -1,5 +1,5 @@
 Gem::Specification.new do |s|
-  s.version = '1.0.9'
+  s.version = '1.1.0'
   s.date = %q{2009-01-08}
  
   s.name = %q{cache_advance}
@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.authors = ['Aubrey Holland']
   s.description = %q{A system for spiffy declarative caching}
   s.email = %q{aubrey@patch.com}
-  s.files = %w(cache_advance.gemspec lib/cache_advance/active_record_sweeper.rb lib/cache_advance/cache_set.rb lib/cache_advance/mapper.rb lib/cache_advance/named_cache.rb lib/cache_advance/rails_cache.rb lib/cache_advance.rb rails/init.rb Rakefile README.textile test/active_record_sweeper_test.rb test/cache_mock.rb test/cache_set_test.rb test/mapper_test.rb test/named_cache_test.rb test/rails_cache_test.rb test/test_helper.rb TODO.textile)
+  s.files = %w(README.textile Rakefile TODO.textile cache_advance.gemspec lib/cache_advance.rb lib/cache_advance/active_record_sweeper.rb lib/cache_advance/cache_set.rb lib/cache_advance/cached_key_list.rb lib/cache_advance/lock.rb lib/cache_advance/mapper.rb lib/cache_advance/named_cache.rb lib/cache_advance/named_cache_configuration.rb rails/init.rb test/active_record_sweeper_test.rb test/cache_mock.rb test/cache_set_test.rb test/mapper_test.rb test/named_cache_test.rb test/spec/db/schema.rb test/spec/mapper_spec.rb test/spec/mocks/memcache.rb test/spec/spec_helper.rb test/test_helper.rb)
   s.homepage = %q{http://github.com/aub/cache_advance}
   s.require_paths = ['lib']
   s.rubygems_version = %q{1.2.0}
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.has_rdoc = true
   s.extra_rdoc_files = ['README.textile']
   s.rdoc_options = ['--line-numbers', '--inline-source', '--main', 'README.textile']
-  s.test_files = %w(test/active_record_sweeper_test.rb test/cache_set_test.rb test/mapper_test.rb test/named_cache_test.rb test/rails_cache_test.rb)
+  s.test_files = %w(test/active_record_sweeper_test.rb test/cache_set_test.rb test/mapper_test.rb test/named_cache_test.rb)
   
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/cache_advance.rb

@@ -1,9 +1,23 @@
-require 'cache_advance/named_cache'
 require 'cache_advance/cache_set'
+require 'cache_advance/cached_key_list'
 require 'cache_advance/mapper'
+require 'cache_advance/named_cache'
+require 'cache_advance/named_cache_configuration'
 
 module CacheAdvance
   class UnknownNamedCacheException < Exception; end
-  
-  Caches = CacheSet.new
+
+  class << self
+    attr_reader :cache_set
+    attr_accessor :caching_enabled
+  end
+
+  @cache_set = nil
+  @caching_enabled = true
+
+  def self.define_caches(store)
+    @cache_set = CacheSet.new(store)
+    yield Mapper.new(@cache_set)
+    @cache_set.setup_complete # This allows the cache set to finalize some of its configuration
+  end
 end

data/lib/cache_advance/active_record_sweeper.rb

@@ -26,7 +26,7 @@ module CacheAdvance
     
     def expire_caches_for(object)
       class_symbol = object.class.name.underscore.to_sym
-      CacheAdvance::Caches.expire_for_class(class_symbol)
+      CacheAdvance.cache_set.expire_for_class(class_symbol)
     end
   end
 end

data/lib/cache_advance/cache_set.rb

@@ -4,16 +4,22 @@ module CacheAdvance
     attr_reader :qualifiers
     attr_reader :plugins
     
-    def initialize
-      @named_caches = {}
-      @qualifiers = {}
-      @plugins = []
+    def initialize(store)
+      @store, @named_caches, @qualifiers, @plugins = store, {}, {}, []
+    end
+    
+    def setup_complete
+      
     end
     
     def apply(cache_name, request, options, &block)
-      named_cache = @named_caches[cache_name]
-      raise UnknownNamedCacheException if named_cache.nil?
-      named_cache.value_for(request, options, &block)
+      if CacheAdvance.caching_enabled
+        named_cache = @named_caches[cache_name]
+        raise UnknownNamedCacheException if named_cache.nil?
+        named_cache.value_for(request, options, &block)
+      else
+        block.call
+      end
     end
     
     def add_qualifier(name, proc)
@@ -25,7 +31,7 @@ module CacheAdvance
     end
     
     def add_named_cache(name, options)
-      @named_caches[name] = NamedCache.new(name, options, self, @cache)
+      @named_caches[name] = NamedCache.new(name, options, self, @store)
     end
     
     def define_caches
@@ -42,10 +48,6 @@ module CacheAdvance
       end
     end
     
-    def cache_type=(type)
-      @cache = type.new
-    end
-    
     def sweeper_type=(type)
       @sweeper_type = type
     end

data/lib/cache_advance/cached_key_list.rb

@@ -0,0 +1,46 @@
+module CacheAdvance
+  class CachedKeyList
+    def initialize(store, cache_key, expiration_time=nil)
+      @store, @cache_key, @expiration_time = store, cache_key, expiration_time
+    end
+    
+    def all_keys
+      key_list.keys
+    end
+    
+    def add_key(key)
+      Lock.new(@store).execute_locked(@cache_key) do
+        data = key_list
+        unless data.has_key?(key)
+          data[key] = @expiration_time.nil? ? nil : Time.now + @expiration_time
+          @store.set(@cache_key, data)
+        end
+      end
+    end
+    
+    def delete_key(key)
+      Lock.new(@store).execute_locked(@cache_key) do
+        data = key_list
+        if data.has_key?(key)
+          data.delete(key)
+          @store.set(@cache_key, data)
+        end
+      end
+    end
+    
+    def clear
+      @store.set(@cache_key, {})
+    end
+    
+    protected
+    
+    def key_list
+      list = @store.get(@cache_key) || {}
+      if @expiration_time
+        now = Time.now
+        list.delete_if { |k,v| v <= now }
+      end
+      list
+    end
+  end
+end

data/lib/cache_advance/lock.rb

@@ -0,0 +1,40 @@
+module CacheAdvance
+  class Lock
+
+    class LockAcquisitionFailureException < Exception; end
+    
+    DEFAULT_RETRIES = 5
+    DEFAULT_EXPIRATION_TIME = 30
+
+    def initialize(store)
+      @store = store
+    end
+    
+    def execute_locked(key, lock_expiry = DEFAULT_EXPIRATION_TIME, retries = DEFAULT_RETRIES)
+      begin
+        acquire(key, lock_expiry, retries)
+        yield
+      ensure
+        release_lock(key)
+      end
+    end
+    
+    def acquire(key, lock_expiry = DEFAULT_EXPIRATION_TIME, retries = DEFAULT_RETRIES)
+      retries.times do |count|
+        begin
+          return if @store.set("lock/#{key}", Process.pid, lock_expiry) == "STORED\r\n"
+        end
+        exponential_sleep(count) unless count == retries - 1
+      end
+      raise LockAcquisitionFailureException, "Couldn't acquire memcache lock for: #{key}"
+    end
+
+    def release_lock(key)
+      @store.delete("lock/#{key}")
+    end
+
+    def exponential_sleep(count)
+      @runtime += Benchmark::measure { sleep((2**count) / 10.0) }
+    end
+  end
+end

data/lib/cache_advance/named_cache.rb

@@ -1,53 +1,37 @@
-module CacheAdvance  
+module CacheAdvance
   class NamedCache
-    STORED_KEY = 'STORED_CACHES'
+
+    ENABLED_CHECK_INTERVAL = 60
     
-    def initialize(name, params, cache_set, cache)
+    def initialize(name, params, cache_set, store)
       @name = name.to_s
       @params = params
       @cache_set = cache_set
-      @cache = cache
+      @store = store
+      @cached_key_list = CachedKeyList.new(@store, "#{@name}/STORED_CACHES", expiration_time)
+      @enabled_check_time = Time.now + ENABLED_CHECK_INTERVAL
+      @enabled = nil
     end
-    
-    def key_for(request, suffix='')
-      key = @name.dup
-      key << suffix.to_s
-              
-      qualifiers.each do |q|
-        if (qualifier = @cache_set.qualifiers[q])
-          this_one = qualifier.call(request)
-          key << this_one.to_s unless this_one.nil?
-        end
-      end if qualifiers
-      key
-    end
-    
+        
     def value_for(request, options, &block)
+      return block.call unless enabled?
+      
       key = key_for(request, options[:key])
-
-      if (cache = @cache.read(key))
-        each_plugin { |p| p.send('after_read', @name, key, request, cache) if p.respond_to?('after_read') }
-        return cache
+      
+      if (value = read_from_store(key))
+        each_plugin { |p| p.send('after_read', @name, key, request, value) if p.respond_to?('after_read') }
+        return value
       end
-
+      
       each_plugin { |p| p.send('before_render', @name, key, request) if p.respond_to?('before_render') }
       result = block.call
       each_plugin { |p| p.send('after_render', @name, key, request, result) if p.respond_to?('after_render') }
       each_plugin { |p| p.send('before_write', @name, key, request, result) if p.respond_to?('before_write') }
-      @cache.write(key, result, rails_options)
-      each_plugin { |p| p.send('after_write', @name, key, request, result) if p.respond_to?('after_write') }
-      
-      add_to_cached_keys_list(key)
-      
+      write_to_store(key, result)
+      each_plugin { |p| p.send('after_write', @name, key, request, result) if p.respond_to?('after_write') }      
       result
     end
-    
-    def rails_options
-      options = {}
-      options[:expires_in] = expiration_time if expiration_time
-      options
-    end
-    
+        
     def expire_for(type)
       if expiration_types.include?(type)
         expire_all
@@ -55,45 +39,82 @@ module CacheAdvance
     end
     
     def expire_all
-      if (data = @cache.read(@name + STORED_KEY))
-        data = Array(Marshal.load(data))
-        data.each { |key| @cache.delete(key) }
-      else
-        @cache.delete(@name)
-      end
+      delete_all_from_store
+    end
+        
+    def all_cached_keys
+      @cached_key_list.all_keys
     end
     
     def expiration_types
       Array(@params[:expiration_types])
     end
     
-    def expiration_time
-      @params[:expiration_time]
+    def title
+      @params[:title] || @name.to_s
     end
     
-    def qualifiers
-      Array(@params[:qualifiers])
+    def enabled=(state)
+      @enabled = !!state
+      write_to_store(enabled_key, @enabled, false)
+    end
+    
+    def enabled?
+      if @enabled.nil? || Time.now >= @enabled_check_time
+        @enabled = [nil, true].include?(read_from_store(enabled_key))
+        @enabled_check_time = Time.now + ENABLED_CHECK_INTERVAL
+      end
+      @enabled
     end
     
     protected
         
+    def read_from_store(key)
+      @store.get(key)
+    end
+    
+    def write_to_store(key, value, add_to_key_list=true)
+      expiration_time ? @store.set(key, value, expiration_time) : @store.set(key, value)
+      if add_to_key_list
+        @cached_key_list.add_key(key)
+      end
+    end
+
+    def delete_from_store(key)
+      @store.delete(key)
+      @cached_key_list.delete_key(key)
+    end
+        
+    def delete_all_from_store
+      @cached_key_list.all_keys.each { |key| delete_from_store(key) }
+      @cached_key_list.clear
+    end
+        
     def each_plugin
       @cache_set.plugins.each do |p|
         yield p
       end
     end
     
-    def add_to_cached_keys_list(key)
-      unless expiration_types.blank? || key == @name
-        if (data = @cache.read(@name + STORED_KEY))
-          data = Array(Marshal.load(data))
-        else
-          data = []
-        end
-        unless data.include?(key)
-          @cache.write(@name + STORED_KEY, Marshal.dump(data << key))
+    def key_for(request, suffix='')
+      qualifier_data = qualifiers.map do |q|
+        if (qualifier = @cache_set.qualifiers[q])
+          (qualifier.call(request) || '').to_s
         end
-      end
+      end.join('/')
+      "#{@name}/#{suffix}/[#{qualifier_data}]"
+    end
+        
+    def enabled_key
+      "#{@name}/ENABLED_STATUS"
+    end  
+      
+    def expiration_time
+      @params[:expiration_time]
+    end
+    
+    def qualifiers
+      Array(@params[:qualifiers])
     end
   end
 end

data/lib/cache_advance/named_cache_configuration.rb

@@ -0,0 +1,7 @@
+module CacheAdvance
+  class NamedCacheConfiguration
+    def initialize(options)
+      @options = options
+    end
+  end
+end

data/rails/init.rb

@@ -1,20 +1,20 @@
 require 'cache_advance'
 require 'cache_advance/active_record_sweeper'
-require 'cache_advance/rails_cache'
-
-# Setup the sweeper and cache types as appropriate for Rails.
-CacheAdvance::Caches.sweeper_type = CacheAdvance::ActiveRecordSweeper
-CacheAdvance::Caches.cache_type = CacheAdvance::RailsCache
 
 require "#{RAILS_ROOT}/config/caches"
 require 'dispatcher'
 
+# Setup the sweeper and cache types as appropriate for Rails.
+CacheAdvance.cache_set.sweeper_type = CacheAdvance::ActiveRecordSweeper
+
+CacheAdvance.caching_enabled = config.action_controller.perform_caching
+
 # This is the helper method that can be used in rails views/controllers/helpers.
 # If caching is disabled, just make it yield the results of the block.
 if config.action_controller.perform_caching
   ActionController::Base.helper do
     def cache_it(cache, options={}, &block)
-      CacheAdvance::Caches.apply(cache, request, options) do
+      CacheAdvance.cache_set.apply(cache, request, options) do
         capture(&block)
       end
     end
@@ -26,7 +26,7 @@ else
     end
   end
 end
-
+ 
 ActionMailer::Base.helper do
   def cache_it(cache, options={}, &block)
     capture(&block)
@@ -37,7 +37,7 @@ end
 config.after_initialize do
   if config.action_controller.perform_caching
     # This hooks the sweepers into the observer system and adds it to the list.
-    CacheAdvance::Caches.create_sweepers
+    CacheAdvance.cache_set.create_sweepers
     ActiveRecord::Base.observers << CacheAdvance::ActiveRecordSweeper
 
     # In development mode, the models we observe get reloaded with each request. Using

data/test/spec/db/schema.rb

@@ -0,0 +1,18 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table "publications", :force => true do |t|
+    t.string "name", "subdomain"
+  end
+
+  create_table "articles", :force => true do |t|
+    t.references 'publication'
+    t.string 'title'
+  end
+end
+
+class Publication < ActiveRecord::Base
+  has_many :articles
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :publication
+end

data/test/spec/mapper_spec.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+module CacheAdvance
+  before :each do
+    @cache_set = CacheSet.new
+    @mapper = Mapper.new(@cache_set)
+  end
+  
+  describe 'Mapper' do
+    it 'should pass qualifiers directly to the cache set' do
+      proc = Proc.new { 2 }
+      @cache_set.should_receive(:add_qualifier).with(proc)
+      @mapper.qualifier(:testy, proc)
+    end
+  end
+end

data/test/spec/mocks/memcache.rb

@@ -0,0 +1,41 @@
+class MemCache
+  attr_reader :data
+  
+  def initialize
+    @data = {}
+  end
+  
+  def decr(key, amount = 1)
+  end
+
+  def get(key, raw = false)
+    return @data[key]
+  end
+
+  def get_multi(*keys)
+  end
+
+  def incr(key, amount = 1)
+  end
+
+  def set(key, value, expiry = 0, raw = false)
+    @data[key] = value
+  end
+
+  def add(key, value, expiry = 0, raw = false)
+  end
+
+  def delete(key, expiry = 0)
+    @data.delete(key)
+  end
+
+  def flush_all
+  end
+
+  def reset
+    @data = {}
+  end
+
+  def stats
+  end
+end

data/test/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+$: << File.join(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'ruby-debug'
+
+gem 'sqlite3-ruby'
+require 'spec'
+require 'cache_advance'
+
+require 'activerecord'
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :dbfile => ':memory:'
+)
+
+require File.join(File.dirname(__FILE__), 'db', 'schema')
+require File.join(File.dirname(__FILE__), 'mocks', 'memcache')
+
+Spec::Runner.configure do |config|
+  # config.mock_with :rr
+  config.before :each do
+    @memcache = MemCache.new
+
+    CacheAdvance.define_caches(@memcache) do |cache_config|
+      cache_config.publication
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aub-cache_advance
 version: !ruby/object:Gem::Version 
-  version: 1.0.9
+  version: 1.1.0
 platform: ruby
 authors: 
 - Aubrey Holland
@@ -22,24 +22,29 @@ extensions: []
 extra_rdoc_files: 
 - README.textile
 files: 
+- README.textile
+- Rakefile
+- TODO.textile
 - cache_advance.gemspec
+- lib/cache_advance.rb
 - lib/cache_advance/active_record_sweeper.rb
 - lib/cache_advance/cache_set.rb
+- lib/cache_advance/cached_key_list.rb
+- lib/cache_advance/lock.rb
 - lib/cache_advance/mapper.rb
 - lib/cache_advance/named_cache.rb
-- lib/cache_advance/rails_cache.rb
-- lib/cache_advance.rb
+- lib/cache_advance/named_cache_configuration.rb
 - rails/init.rb
-- Rakefile
-- README.textile
 - test/active_record_sweeper_test.rb
 - test/cache_mock.rb
 - test/cache_set_test.rb
 - test/mapper_test.rb
 - test/named_cache_test.rb
-- test/rails_cache_test.rb
+- test/spec/db/schema.rb
+- test/spec/mapper_spec.rb
+- test/spec/mocks/memcache.rb
+- test/spec/spec_helper.rb
 - test/test_helper.rb
-- TODO.textile
 has_rdoc: true
 homepage: http://github.com/aub/cache_advance
 post_install_message: 
@@ -74,4 +79,3 @@ test_files:
 - test/cache_set_test.rb
 - test/mapper_test.rb
 - test/named_cache_test.rb
-- test/rails_cache_test.rb

data/lib/cache_advance/rails_cache.rb

@@ -1,15 +0,0 @@
-module CacheAdvance
-  class RailsCache
-    def read(key)
-      Rails.cache.read(key)
-    end
-    
-    def write(key, value, options={})
-      Rails.cache.write(key, value, options)
-    end
-    
-    def delete(key)
-      Rails.cache.delete(key)
-    end
-  end
-end

data/test/rails_cache_test.rb

@@ -1,7 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
-
-class RailsCacheTest < Test::Unit::TestCase
-  def test_empty
-    assert true
-  end
-end