model-cache 0.2.0 → 0.2.2

data/README.textile

@@ -5,6 +5,8 @@ ModelCache is a simple caching plugin for Rails, using @memcached@. It provides
 * cache your instance methods, optionally with a time-to-live setting
 * cache some generic code (e.g. in your class methods)
 
+Both memcached client gems, @memcache-client@ and @memcached@ are supported. You are just expected to create an instance of the client and store it in the @CACHE@ constant.
+
 h1. Installation
 
 p. As a gem:
@@ -21,11 +23,16 @@ bc. script/plugin install http://github.com/moskyt/model_cache.git
 
 h1. Example
 
-p. @environment.rb@ or an initializer:
+p. Create an initializer, for example @config/initializers/memcached.rb@, containing this code (if you are using @memcache-client@):
 
 bc. require 'memcache'
 CACHE = MemCache.new('127.0.0.1')
 
+p. or, if using @memcached@ gem:
+
+bc. require 'memcached'
+CACHE = Memcached.new('127.0.0.1')
+
 p. Your model:
 
 bc.. class Stuff < ActiveRecord::Base
@@ -44,7 +51,7 @@ bc.. class Stuff < ActiveRecord::Base
 		...
 	end
 	
-	cache_method_for_time :third_expensive_method, 1.hour
+	cache_method :third_expensive_method, :time => 1.hour
 	
 	def partially_expensive_method
 		...
@@ -61,6 +68,22 @@ bc.. class Stuff < ActiveRecord::Base
 
 end
 
-p. Cached!
+p. If you want to cache somewhere else than in _ActiveRecord::Base_ classes, you need to include the module explicitly:
+
+bc.. class Another
+  include ModelCache
+  
+	def expensive_method
+		...
+	end
+	
+	cache_method :expensive_method  
+end
+
+p. @model-cache@ defines three methods for a cached method:
+
+* @__uncached_@_method_name_ -- the original method without the caching wrapper
+* @__is_cached_@_method_name_@?@ -- returns true if this method is cached (with respective arguments)
+* @__flush_@_method_name_ -- removes the cache entry explicitly from the cache
 
-Copyright (c) 2010 Frantisek Havluj, released under the MIT license
+p. Copyright (c) 2010 Frantisek Havluj, released under the MIT license

data/lib/model_cache.rb

@@ -26,9 +26,7 @@ module ModelCache
           cache_hit = true
         end
         if result == NIL_OBJECT
-          nil
-        else
-          result
+          result = nil
         end
       else
         raise "CACHE object not configured #{CACHE.inspect}!"
@@ -57,8 +55,9 @@ module ModelCache
 	
 	module ClassMethods
   	def cache_method(*args)
+  	  opts = args.extract_options!
   		args.each do |sym|
-  		  cache_method_for_time(sym, DEFAULT_TIME)
+  		  cache_method_for_time(sym, (opts[:time] || DEFAULT_TIME))
   		end
   	end
 
@@ -74,7 +73,7 @@ module ModelCache
   			ckey = [self.cache_key, sym, *args]
   			!!( Rails.configuration.action_controller.perform_caching && CACHE.get(ckey) )
   		end
-  		define_method :"__uncache_#{sym}" do |*args|
+  		define_method :"__flush_#{sym}" do |*args|
   			ckey = [self.cache_key, sym, *args]
   			CACHE.delete(ckey)
   		end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: model-cache
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors: 
 - Frantisek Havluj
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-22 00:00:00 +01:00
+date: 2010-02-03 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -29,7 +29,7 @@ files:
 - MIT-LICENSE
 - CHANGELOG
 has_rdoc: true
-homepage: http://github.com/moskyt/model-cache
+homepage: http://github.com/moskyt/model_cache
 licenses: []
 
 post_install_message: