aub-cache_advance 1.0.1 → 1.0.2

data/cache_advance.gemspec

@@ -1,5 +1,5 @@
 Gem::Specification.new do |s|
-  s.version = '1.0.1'
+  s.version = '1.0.2'
   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_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(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.homepage = %q{http://github.com/aub/cache_advance}
   s.require_paths = ['lib']
   s.rubygems_version = %q{1.2.0}

data/lib/cache_advance/cache_set.rb

@@ -3,7 +3,7 @@ module CacheAdvance
     attr_reader :named_caches
     attr_reader :qualifiers
     attr_reader :plugins
-    attr_accessor :observer_type
+    attr_accessor :sweeper_type
     attr_accessor :cache
     
     def initialize
@@ -35,7 +35,7 @@ module CacheAdvance
     end
     
     def create_sweepers
-      observer_type.initialize_observed(@named_caches.values.map { |c| c.expiration_types }.flatten.compact.uniq)
+      sweeper_type.initialize_observed(@named_caches.values.map { |c| c.expiration_types }.flatten.compact.uniq)
     end
     
     def expire_for_class(class_name)

data/lib/cache_advance/named_cache.rb

@@ -2,10 +2,10 @@ module CacheAdvance
   class NamedCache
     STORED_KEY = 'STORED_CACHES'
     
-    def initialize(name, params, configuration, cache)
+    def initialize(name, params, cache_set, cache)
       @name = name.to_s
       @params = params
-      @configuration = configuration
+      @cache_set = cache_set
       @cache = cache
     end
     
@@ -14,7 +14,7 @@ module CacheAdvance
       key << suffix.to_s
               
       qualifiers.each do |q|
-        if (qualifier = @configuration.qualifiers[q])
+        if (qualifier = @cache_set.qualifiers[q])
           this_one = qualifier.call(request)
           key << this_one.to_s unless this_one.nil?
         end
@@ -76,7 +76,7 @@ module CacheAdvance
     protected
         
     def call_plugins(method, key, request)
-      @configuration.plugins.each { |p| p.send(method, @name, key, request) if p.respond_to?(method) }
+      @cache_set.plugins.each { |p| p.send(method, @name, key, request) if p.respond_to?(method) }
     end
     
     def add_to_cached_keys_list(key)

data/rails/init.rb

@@ -1,9 +1,10 @@
 require 'cache_advance'
-require 'cache_advance/active_record_observer'
+require 'cache_advance/active_record_sweeper'
 require 'cache_advance/rails_cache'
 require 'config/caches'
 require 'dispatcher'
 
+# This is the helper method that can be used in rails views/controllers/helpers.
 ActionController::Base.helper do  
   def cache_it(cache, options={}, &block)
     CacheAdvance::Caches.apply(cache, request, options) do
@@ -12,13 +13,19 @@ ActionController::Base.helper do
   end
 end
 
+# This will get called after the standard rails environment is initialized.
 config.after_initialize do
-  CacheAdvance::Caches.observer_type = CacheAdvance::ActiveRecordObserver
+  
+  # Setup the sweeper_type and cache as appropriate for Rails.
+  CacheAdvance::Caches.sweeper_type = CacheAdvance::ActiveRecordSweeper
   CacheAdvance::Caches.cache = CacheAdvance::RailsCache.new
   
+  # This hooks the sweepers into the observer system and adds it to the list. 
   CacheAdvance::Caches.create_sweepers
-  ActiveRecord::Base.observers << CacheAdvance::ActiveRecordObserver
+  ActiveRecord::Base.observers << CacheAdvance::ActiveRecordSweeper
   
+  # In development mode, the models we observe get reloaded with each request. Using
+  # this hook allows us to reload the observer relationships each time as well.
   ActionController::Dispatcher.to_prepare(:cache_advance_reload) do
     CacheAdvance::ActiveRecordSweeper.instance.reload_sweeper
   end

data/test/cache_mock.rb

@@ -0,0 +1,15 @@
+module CacheAdvance
+  class CacheMock
+    def read(key)
+      'abc'
+    end
+    
+    def write(key, value)
+      
+    end
+    
+    def delete(key)
+      
+    end
+  end
+end

data/test/cache_set_test.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/test_helper.rb'
 
 class Plugin; end
 
-require 'cache_advance/active_record_observer'
+require 'cache_advance/active_record_sweeper'
 
 class CacheSetTest < Test::Unit::TestCase
   def setup
@@ -30,10 +30,10 @@ class CacheSetTest < Test::Unit::TestCase
   end
   
   def test_should_pass_expiration_types_to_the_sweeper
-    @cache_set.observer_type = CacheAdvance::ActiveRecordObserver
+    @cache_set.sweeper_type = CacheAdvance::ActiveRecordSweeper
     @cache_set.add_named_cache(:kewl, { :expiration_types => [:publication, :article] })
     @cache_set.add_named_cache(:howza, { :expiration_types => [:publication] })
-    CacheAdvance::ActiveRecordObserver.expects(:initialize_observed).with([:publication, :article])
+    CacheAdvance::ActiveRecordSweeper.expects(:initialize_observed).with([:publication, :article])
     @cache_set.create_sweepers
   end
 end

data/test/named_cache_test.rb

@@ -1,7 +1,126 @@
 require File.dirname(__FILE__) + '/test_helper.rb'
 
 class NamedCacheTest < Test::Unit::TestCase
-  def test_fake
-    assert true
+  
+  def setup
+    @request = mock
+  end
+  
+  def test_key_for_in_basic_case
+    create_named_cache
+    assert_equal 'test_cache', @named_cache.key_for(@request)
+    assert_equal 'test_cachesuf', @named_cache.key_for(@request, 'suf')
+  end
+  
+  def test_key_with_qualifiers
+    
+  end
+  
+  protected
+  
+  def create_named_cache(options={})
+    @name = options[:name] || 'test_cache'
+    @params = {}
+    @cache_set = CacheAdvance::CacheSet.new
+    @cache = CacheAdvance::CacheMock.new
+    @named_cache = CacheAdvance::NamedCache.new(@name, @params, @cache_set, @cache)
   end
 end
+
+
+# module CacheAdvance  
+#   class NamedCache
+#     STORED_KEY = 'STORED_CACHES'
+#     
+#     def initialize(name, params, configuration, cache)
+#       @name = name.to_s
+#       @params = params
+#       @configuration = configuration
+#       @cache = cache
+#     end
+#     
+#     def key_for(request, suffix='')
+#       key = @name.dup
+#       key << suffix.to_s
+#               
+#       qualifiers.each do |q|
+#         if (qualifier = @configuration.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)
+#       key = key_for(request, options[:key])
+# 
+#       if (cache = @cache.read(key))
+#         call_plugins('after_read', key, request)
+#         return cache
+#       end
+#       
+#       call_plugins('before_write', key, request)
+#       result = block.call
+#       @cache.write(key, result, rails_options)      
+#       call_plugins('after_write', key, request)
+#       
+#       add_to_cached_keys_list(key)
+#       
+#       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
+#       end
+#     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
+#     end
+#     
+#     def expiration_types
+#       Array(@params[:expiration_types])
+#     end
+#     
+#     def expiration_time
+#       @params[:expiration_time]
+#     end
+#     
+#     def qualifiers
+#       Array(@params[:qualifiers])
+#     end
+#     
+#     protected
+#         
+#     def call_plugins(method, key, request)
+#       @configuration.plugins.each { |p| p.send(method, @name, key, request) if p.respond_to?(method) }
+#     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))
+#         end
+#       end
+#     end
+#   end
+# end
+

data/test/test_helper.rb

@@ -7,3 +7,4 @@ require 'ruby-debug'
 
 require 'cache_advance'
 require 'mocha'
+require 'cache_mock'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aub-cache_advance
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Aubrey Holland
@@ -33,6 +33,7 @@ files:
 - 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