cached_model 1.1.0 → 1.2.0

data/Rakefile

@@ -8,7 +8,7 @@ $VERBOSE = nil
 
 spec = Gem::Specification.new do |s|
   s.name = 'cached_model'
-  s.version = '1.1.0'
+  s.version = '1.2.0'
   s.summary = 'An ActiveRecord::Base model that caches records'
   s.authors = 'Robert Cottrell, Eric Hodel'
   s.email = 'bob@robotcoop.com'
@@ -17,7 +17,7 @@ spec = Gem::Specification.new do |s|
   s.files = File.read('Manifest.txt').split($/)
   s.require_path = 'lib'
 
-  s.add_dependency 'memcache-client', '1.0.3'
+  s.add_dependency 'memcache-client', '>= 1.0.3'
 end
 
 desc 'Run tests'

data/lib/cached_model.rb

@@ -1,11 +1,22 @@
-$TESTING = (defined? $TESTING) ? $TESTING : false
+$TESTING_CM = defined? $TESTING_CM
 
 require 'timeout'
-require 'memcache_util' unless $TESTING == :cached_model
+require 'memcache_util' unless $TESTING_CM
 
 ##
 # An abstract ActiveRecord descendant that caches records in memcache and in
 # local memory.
+#
+# CachedModel can store into both a local in-memory cache and in memcached.
+# By default memcached is enabled and the local cache is disabled.
+#
+# Local cache use can be enabled or disabled with
+# CachedModel::use_local_cache=.  If you do enable the local cache be sure to
+# add a before filter that calls CachedModel::cache_reset for every request.
+#
+# memcached use can be enabled or disabled with CachedModel::use_memcache=.
+#
+# You can adjust the memcached TTL with CachedModel::ttl=
 
 class CachedModel < ActiveRecord::Base
 
@@ -58,27 +69,25 @@ class CachedModel < ActiveRecord::Base
   end
 
   ##
-  # Override the flawed assumption ActiveRecord::Base makes about inheritance.
+  # We only work on 1.1.2 + because Rails broke backwards compatibility
+  # despite a bug http://dev.rubyonrails.org/ticket/3704
 
-  def self.descends_from_active_record?
-    superclass == CachedModel
-  end
+  if Rails::VERSION::MAJOR > 1 or
+     (Rails::VERSION::MAJOR == 1 and Rails::VERSION::MINOR > 1) or
+     (Rails::VERSION::MAJOR == 1 and Rails::VERSION::MINOR == 1 and
+      Rails::VERSION::TINY >= 2) then
 
-  ##
-  # Override the flawed assumption ActiveRecord::Base makes about inheritance.
-
-  def self.class_name_of_active_record_descendant(klass)
-    if klass.superclass == CachedModel then
-      return klass.name
-    elsif klass.superclass.nil? then
-      raise ActiveRecordError, "#{name} doesn't descend from ActiveRecord::Base"
-    else
-      class_name_of_active_record_descendant klass.superclass
-    end
+    ##
+    # Override the flawed assumption ActiveRecord::Base makes about
+    # inheritance.
+
+    self.abstract_class = true
+  else
+    raise NotImplementedError, 'upgrade to Rails 1.1.2+'
   end
 
   ##
-  # Invalidate the cache entry for an record.  The update method will
+  # Invalidate the cache entry for a record.  The update method will
   # automatically invalidate the cache when updates are made through
   # ActiveRecord model record.  However, several methods update tables with
   # direct sql queries for effeciency.  These methods should call this method
@@ -105,33 +114,45 @@ class CachedModel < ActiveRecord::Base
   ##
   # Override the find method to look for values in the cache before going to
   # the database.
+  #--
+  # TODO Push a bunch of code down into find_by_sql where it really should
+  # belong.
 
   def self.find(*args)
     args[0] = args.first.to_i if args.first =~ /\A\d+\Z/
     # Only handle simple find requests.  If the request was more complicated,
     # let the base class handle it, but store the retrieved records in the
     # local cache in case we need them later.
-    if ($TESTING and $TESTING != :cached_model) or
-       args.length != 1 or not Fixnum === args.first then
+    if args.length != 1 or not Fixnum === args.first then
+      # Rails requires multiple levels of indirection to look up a record
+      # First call super
       records = super
-      # Rails requires two levels of indirection to look up a record
-      return records if args.first == :all and @skip_find_hack
+      # Then, if it was a :all, just return
+      return records if args.first == :all
       return records if RAILS_ENV == 'test'
       case records
       when Array then
         records.each { |r| r.cache_store }
-      when CachedModel then
-        records.cache_store # Model.find 1 gets cached here
       end
       return records
     end
 
+    return super
+  end
+
+  ##
+  # Find by primary key from the cache.
+
+  def self.find_by_sql(*args)
+    return super unless args.first =~ /^SELECT \* FROM #{table_name} WHERE \(#{table_name}\.#{primary_key} = '?(\d+)'?\) +LIMIT 1/
+
+    id = $1.to_i
+
     # Try to find the record in the local cache.
-    id = args.first
     cache_key_local = "#{name}:#{id}"
     if CachedModel.use_local_cache? then
       record = CachedModel.cache_local[cache_key_local]
-      return record unless record.nil?
+      return [record] unless record.nil?
     end
 
     # Try to find the record in memcache and add it to the local cache
@@ -141,41 +162,14 @@ class CachedModel < ActiveRecord::Base
         if CachedModel.use_local_cache? then
           CachedModel.cache_local[cache_key_local] = record
         end
-        return record
+        return [record]
       end
     end
 
-    # Fetch the record from the DB.  Inside the mulitple levels of indirection
-    # of find it will get cached.
-    #
-    # We don't want the subsequent find_by_sql to loop back here, so guard
-    # the call.
-    #
-    # NOTE This guard is not thread safe, beware use of CachedModel where
-    # ActiveRecord's thread safety is disabled.
-    begin
-      @skip_find_hack = true
-      record = super(args).first
-    ensure
-      @skip_find_hack = false
-    end
-
-    return record
-  end
-
-  ##
-  # Skip the special handling for find by primary key if this method was
-  # called from find. If this is really a lookup for a single row by primary
-  # key, use a simple find call instead.
-
-  def self.find_by_sql(*args)
-    unless @skip_find_hack or ($TESTING and $TESTING != :cached_model) then
-      if args.first =~ /SELECT \* FROM #{table_name} WHERE \(#{table_name}\.#{primary_key} = '?(\d+)'?\) LIMIT 1/ then
-        return [find($1.to_i)]
-      end
-    end
-
-    return super
+    # Fetch the record from the DB
+    records = super
+    records.first.cache_store # only one
+    return records
   end
 
   ##

data/test/test_cached_model.rb

@@ -1,9 +1,17 @@
 require 'test/unit'
 
-$TESTING = :cached_model
+$TESTING = true
+$TESTING_CM = true
 
 RAILS_ENV = 'production'
 
+module Rails; end
+module Rails::VERSION
+  MAJOR = 1
+  MINOR = 1
+  TINY = 2
+end
+
 module ActiveRecord; end
 
 class ActiveRecord::Base
@@ -12,19 +20,31 @@ class ActiveRecord::Base
 
   attr_accessor :id, :attributes
 
+  def self.abstract_class=(arg)
+    @abstract_class = arg
+  end
+
+  def self.abstract_class?
+    return !!@abstract_class
+  end
+
+  ##
+  # Need doco, blech
+
   def self.find(*args)
     args.flatten!
     case args.first
     when :first then
-      return find(:all, *args)
+      return find(:all, *args).first
     when :all then
-      [new]
+      return find_by_sql("SELECT * FROM #{table_name} WHERE (#{table_name}.#{primary_key} = '#{args.last}')  LIMIT 1")
     else
       case args.length
       when 1 then
         return find(:first, *args) if Fixnum === args.first
         raise "Dunno what to do"
       when 2 then
+        return find(args.first) if Hash === args.last
         return new
       when 3 then
         return [new, new, new]
@@ -134,6 +154,11 @@ class TestCachedModel < Test::Unit::TestCase
     CachedModel.use_memcache = DEFAULT_USE_MEMCACHE
   end
 
+  def test_class_abstract_class_eh
+    assert_equal true, CachedModel.abstract_class?, 'CachedModel is abstract'
+    assert_equal false, Concrete.abstract_class?, 'Concrete is not abstract'
+  end
+
   def test_class_cache_delete
     CachedModel.use_local_cache = true
     CachedModel.use_memcache = true
@@ -200,11 +225,6 @@ class TestCachedModel < Test::Unit::TestCase
     assert_equal false, Cache.cache.empty?
   end
 
-  def test_class_descends_from_active_record?
-    assert_equal true, Concrete.descends_from_active_record?
-    assert_equal false, STILameness.descends_from_active_record?
-  end
-
   def test_class_find_complex
     CachedModel.use_local_cache = true
     CachedModel.use_memcache = true
@@ -295,23 +315,14 @@ class TestCachedModel < Test::Unit::TestCase
     assert_equal record, Cache.cache[record.cache_key_memcache]
   end
 
-  def test_class_find_by_sql_skip_hack
-    Concrete.instance_variable_set :@skip_find_hack, true
-    q = "SELECT * FROM concrete WHERE (concrete.id = #{@model.id + 1}) LIMIT 1"
+  def test_class_find_by_sql_extra_space
+    CachedModel.use_local_cache = true
+    q = "SELECT * FROM concrete WHERE (concrete.id = #{@model.id + 1})  LIMIT 1"
     record = Concrete.find_by_sql(q).first
     assert_equal @model.id + 1, record.id
 
-    assert_equal true, CachedModel.cache_local.empty?
-    assert_equal true, Cache.cache.empty?
-  ensure
-    Concrete.instance_variable_set :@skip_find_hack, false
-  end
-
-  def test_class_name_of_active_record_descendant
-    assert_equal "Concrete",
-                 CachedModel.class_name_of_active_record_descendant(Concrete)
-    assert_equal "Concrete",
-                 CachedModel.class_name_of_active_record_descendant(STILameness)
+    assert_equal record, CachedModel.cache_local[record.cache_key_local]
+    assert_equal record, Cache.cache[record.cache_key_memcache]
   end
 
   def test_class_ttl

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11.6
+rubygems_version: 0.8.99
 specification_version: 1
 name: cached_model
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
-date: 2006-02-19 00:00:00 -08:00
+  version: 1.2.0
+date: 2006-08-10 00:00:00 -07:00
 summary: An ActiveRecord::Base model that caches records
 require_paths: 
 - lib
@@ -53,7 +53,7 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
         version: 1.0.3
     version: