aub-cache_advance 1.1.1 → 1.1.2

data/.gitignore

@@ -0,0 +1,3 @@
+rdoc
+pkg
+*.gem

data/CHANGELOG

@@ -0,0 +1,8 @@
+1.1.2
+
+	* Strip whitespace from keys in order to avoid errors from memcache.
+	* Symbolize cache names.
+
+1.1.1
+
+  * Fixed a bug where the enabled flag would expire, causing caches to be reenabled.

data/Rakefile

@@ -1,62 +1,22 @@
 require 'rubygems'
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require 'date'
 
-desc 'Default: run unit tests.'
-task :default => :test
+FileList['tasks/**/*.rake'].each { |file| load file }
 
-desc 'Test the system.'
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-end
-
-desc 'Generate documentation for the system.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Cache Advance'
-  rdoc.options << '--line-numbers' << '--inline-source' << "--main" << "README.textile"
-  rdoc.rdoc_files.include('README.textile')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-spec = Gem::Specification.new do |s|
-  s.name        = %q{cache_advance}
-  s.version     = "1.0.0"
-  s.summary     = %q{A system for spiffy declarative caching}
-  s.description = %q{A system for spiffy declarative caching}
-  s.homepage    = 'http://github.com/aub/cache_advance'
-
-  s.files        = FileList['[A-Z]*', 'lib/**/*.rb', 'rails/**/*.rb', 'test/**/*.rb']
-  s.require_path = 'lib'
-  s.test_files   = Dir[*['test/**/*_test.rb']]
-
-  s.has_rdoc         = true
-  s.extra_rdoc_files = ["README.textile"]
-  s.rdoc_options = ['--line-numbers', '--inline-source', "--main", "README.textile"]
-
-  s.authors = ["Aubrey Holland"]
-  s.email   = %q{aubrey@patch.com}
+task :default => 'test'
 
-  s.platform = Gem::Platform::RUBY
-  s.add_dependency(%q<activesupport>, [">= 1.0"])
-end
-
-Rake::GemPackageTask.new spec do |pkg|
-  pkg.need_tar = true
-  pkg.need_zip = true
-end
-
-desc "Clean files generated by rake tasks"
-task :clobber => [:clobber_rdoc, :clobber_package]
-
-desc "Generate a gemspec file"
-task :gemspec do
-  File.open("#{spec.name}.gemspec", 'w') do |f|
-    f.write spec.to_ruby
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = 'cache_advance'
+    gemspec.summary = 'A declarative system for caching with ActiveRecord'
+    gemspec.email = 'aubreyholland@gmail.com'
+    gemspec.homepage = 'http://github.com/aub/cache_advance/tree/master'
+    gemspec.description = 'hmm'
+    gemspec.authors = ['Aubrey Holland']
   end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
+

data/VERSION

@@ -0,0 +1 @@
+1.1.2

data/lib/cache_advance.rb

@@ -1,8 +1,6 @@
-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'
+%w( cache_set cached_key_list lock mapper named_cache named_cache_configuration).each do |file|
+  require File.join(File.dirname(__FILE__), 'cache_advance', file)
+end
 
 module CacheAdvance
   class UnknownNamedCacheException < Exception; end

data/lib/cache_advance/active_record_sweeper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 gem 'activerecord'
-require 'active_record'
+require 'active_record/observer'
 
 module CacheAdvance
   class ActiveRecordSweeper < ::ActiveRecord::Observer

data/lib/cache_advance/cache_set.rb

@@ -13,6 +13,7 @@ module CacheAdvance
     end
     
     def apply(cache_name, request, options, &block)
+      cache_name = cache_name.to_sym
       if CacheAdvance.caching_enabled
         named_cache = @named_caches[cache_name]
         raise UnknownNamedCacheException if named_cache.nil?
@@ -31,6 +32,7 @@ module CacheAdvance
     end
     
     def add_named_cache(name, options)
+      name = name.to_sym
       @named_caches[name] = NamedCache.new(name, options, self, @store)
     end
     

data/lib/cache_advance/lock.rb

@@ -34,7 +34,7 @@ module CacheAdvance
     end
 
     def exponential_sleep(count)
-      @runtime += Benchmark::measure { sleep((2**count) / 10.0) }
+      sleep((2**count) / 10.0)
     end
   end
-end
+end

data/lib/cache_advance/mapper.rb

@@ -1,3 +1,6 @@
+gem 'activesupport'
+require 'active_support/core_ext'
+
 module CacheAdvance
   class Mapper
     def initialize(cache_set)

data/lib/cache_advance/named_cache.rb

@@ -102,7 +102,7 @@ module CacheAdvance
           (qualifier.call(request) || '').to_s
         end
       end.join('/')
-      "#{@name}/#{suffix}/[#{qualifier_data}]"
+      "#{@name}/#{suffix}/[#{qualifier_data}]".gsub(/\s/, '')
     end
         
     def enabled_key

data/test/active_record_sweeper_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper.rb'
+require File.join(File.dirname(__FILE__), 'test_helper.rb')
 
 require 'cache_advance/active_record_sweeper'
 
@@ -24,7 +24,7 @@ class ActiveRecordSweeperTest < Test::Unit::TestCase
   end
   
   def test_should_expire_caches_on_changes
-    CacheAdvance::Caches.expects(:expire_for_class).with(:publication).times(3)
+    CacheAdvance.cache_set.expects(:expire_for_class).with(:publication).times(3)
     %w(after_create after_update after_destroy).each do |method|
       @sweeper.send(method, Publication.new)
     end

data/test/cache_mock.rb

@@ -1,15 +1,21 @@
 module CacheAdvance
   class CacheMock
-    def read(key)
-      'abc'
+    def initialize
+      @values = {}
+    end
+
+    def get(key)
+      @values[key]
     end
     
-    def write(key, value)
-      
+    def set(key, value, options={})
+      result = @values.has_key?(key) ? @values[key] : "STORED\r\n"
+      @values[key] = value
+      result
     end
     
     def delete(key)
-      
+      @values[key] = nil
     end
   end
-end
+end

data/test/cache_set_test.rb

@@ -6,7 +6,8 @@ require 'cache_advance/active_record_sweeper'
 
 class CacheSetTest < Test::Unit::TestCase
   def setup
-    @cache_set = CacheAdvance::CacheSet.new
+    @cache = CacheAdvance::CacheMock.new
+    @cache_set = CacheAdvance::CacheSet.new(@cache)
   end
   
   def test_define_caches_should_yield_a_mapper

data/test/key_test.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class KeyTest < Test::Unit::TestCase
+
+  def setup
+    @cache = CacheAdvance::CacheMock.new
+    @cache_set = CacheAdvance::CacheSet.new(@cache)
+  end
+
+  def test_should_symbolize_the_cache_name
+    @cache_set.add_named_cache('booya', {})
+    assert_nothing_raised do
+      @cache_set.apply(:booya, nil, :key => 'abc') do
+        '123'
+      end
+    end
+  end
+
+  def test_should_symbolize_the_cache_name_when_using_it 
+    @cache_set.add_named_cache(:booya, {})
+    assert_nothing_raised do
+      @cache_set.apply('booya', nil, :key => 'abc') do
+        '123'
+      end
+    end
+  end
+
+  def test_should_remove_whitespace_from_the_key
+    @cache_set.add_named_cache(:booya, {})
+    result = @cache_set.apply(:booya, nil, :key => 'abc def') do
+      '123'
+    end
+    assert_equal '123', @cache.get('booya/abcdef/[]')
+    assert_equal '123', result
+    @cache.set('booya/abcdef/[]', '234')
+    result = @cache_set.apply(:booya, nil, :key => 'abc def') do
+      '123'
+    end
+    assert_equal '234', result
+  end
+end

data/test/mapper_test.rb

@@ -6,7 +6,8 @@ end
 class MapperTest < Test::Unit::TestCase
   
   def setup
-    @cache_set = CacheAdvance::CacheSet.new
+    @cache = CacheAdvance::CacheMock.new
+    @cache_set = CacheAdvance::CacheSet.new(@cache)
     @mapper = CacheAdvance::Mapper.new(@cache_set)
   end
   

data/test/named_cache_test.rb

@@ -8,8 +8,8 @@ class NamedCacheTest < Test::Unit::TestCase
   
   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')
+    assert_equal 'test_cache//[]', @named_cache.send(:key_for, @request)
+    assert_equal 'test_cache/suf/[]', @named_cache.send(:key_for, @request, 'suf')
   end
   
   def test_key_with_qualifiers
@@ -21,106 +21,9 @@ class NamedCacheTest < Test::Unit::TestCase
   def create_named_cache(options={})
     @name = options[:name] || 'test_cache'
     @params = {}
-    @cache_set = CacheAdvance::CacheSet.new
     @cache = CacheAdvance::CacheMock.new
+    @cache_set = CacheAdvance::CacheSet.new(@cache)
     @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
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: aub-cache_advance
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors: 
 - Aubrey Holland
@@ -9,12 +9,12 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-08 00:00:00 -08:00
+date: 2009-05-26 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: A system for spiffy declarative caching
-email: aubrey@patch.com
+description: hmm
+email: aubreyholland@gmail.com
 executables: []
 
 extensions: []
@@ -22,10 +22,12 @@ extensions: []
 extra_rdoc_files: 
 - README.textile
 files: 
+- .gitignore
+- CHANGELOG
 - README.textile
 - Rakefile
 - TODO.textile
-- cache_advance.gemspec
+- VERSION
 - lib/cache_advance.rb
 - lib/cache_advance/active_record_sweeper.rb
 - lib/cache_advance/cache_set.rb
@@ -38,21 +40,15 @@ files:
 - test/active_record_sweeper_test.rb
 - test/cache_mock.rb
 - test/cache_set_test.rb
+- test/key_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
-has_rdoc: true
-homepage: http://github.com/aub/cache_advance
+has_rdoc: false
+homepage: http://github.com/aub/cache_advance/tree/master
 post_install_message: 
 rdoc_options: 
-- --line-numbers
-- --inline-source
-- --main
-- README.textile
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -72,10 +68,13 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
-summary: A system for spiffy declarative caching
+specification_version: 3
+summary: A declarative system for caching with ActiveRecord
 test_files: 
 - test/active_record_sweeper_test.rb
+- test/cache_mock.rb
 - test/cache_set_test.rb
+- test/key_test.rb
 - test/mapper_test.rb
 - test/named_cache_test.rb
+- test/test_helper.rb

data/cache_advance.gemspec

@@ -1,24 +0,0 @@
-Gem::Specification.new do |s|
-  s.version = '1.1.1'
-  s.date = %q{2009-01-08}
- 
-  s.name = %q{cache_advance}
-  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
-  s.authors = ['Aubrey Holland']
-  s.description = %q{A system for spiffy declarative caching}
-  s.email = %q{aubrey@patch.com}
-  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}
-  s.summary = %q{A system for spiffy declarative caching}
-  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)
-  
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-  end
-end

data/test/spec/db/schema.rb

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

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

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

@@ -1,30 +0,0 @@
-$: << 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