model-cache 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.1.0 	2010-01-12		
+intial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Frantisek Havluj
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,52 @@
+h1. ModelCache
+
+ModelCache is a simple caching plugin for Rails, using memcached. It provides caching abilities for your models, allowing to:
+* cache blocks of code in your model instance methods, based on a generic key (ActiveRecord cache_key is added behind the scenes)
+* cache your instance methods, optionally with a time-to-live setting
+* cache some generic code (e.g. in your class methods)
+
+h1. Example
+
+p. environment.rb:
+
+bc. require 'memcache'
+CACHE = MemCache.new('127.0.0.1')
+
+p. Your model:
+
+bc.. class Stuff < ActiveRecord::Base
+
+	def expensive_method
+		...
+	end
+	
+	def another_expensive_method
+		...
+	end
+	
+	cache_method :expensive_method, :another_expensive_method
+	
+	def third_expensive_method
+		...
+	end
+	
+	cache_method_for_time :third_expensive_method, 1.hour
+	
+	def partially_expensive_method
+		...
+		cache :calculation do
+			...
+		end
+	end
+	
+	def self.some_class_method
+		ModelCache.cache(:this_would_be_persistent, 5.minutes) do
+			...
+		end
+	end
+
+end
+
+p. Cached!
+
+Copyright (c) 2010 Frantisek Havluj, released under the MIT license

data/init.rb

@@ -0,0 +1,2 @@
+# include the library
+ActiveRecord::Base.send(:include, ModelCache)

data/lib/model-cache.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/../init.rb'

data/lib/model_cache.rb

@@ -0,0 +1,62 @@
+module ModelCache  
+	
+	DO_CACHE = Rails.configuration.action_controller.perform_caching
+	NIL_OBJECT = Object.new
+	DEFAULT_TIME = 12.hours
+	
+	def self.included(klass)
+	  klass.extend ClassMethods
+  end
+	
+	def cache(key, time = DEFAULT_TIME, &block)
+	  ModelCache::cache([self.cache_key, key], time, &block)
+  end
+	
+	def self.cache(ckey, time = DEFAULT_TIME, &block)
+    if DO_CACHE && (result = CACHE.get(ckey))
+      if result == NIL_OBJECT
+        nil
+      else
+        result
+      end
+    else
+      result = block.call
+      if DO_CACHE
+        if result
+          CACHE.set(ckey, result, time)
+        else
+          CACHE.set(ckey, NIL_OBJECT, time)
+        end
+      end
+      result
+    end
+  end
+	
+	
+	module ClassMethods
+  	def cache_method(*args)
+  		args.each do |sym|
+  		  cache_method_for_time(sym, DEFAULT_TIME)
+  		end
+  	end
+
+  	def cache_method_for_time(sym, time)
+  		alias_method :"__noncached_#{sym}", sym
+  		define_method sym do |*args|
+  			ckey = [self.cache_key, sym, *args]
+  			ModelCache.cache(ckey, time) do
+          self.send(:"__noncached_#{sym}", *args)
+  			end
+  		end    
+  		define_method :"__is_cached_#{sym}?" do |*args|
+  			ckey = [self.cache_key, sym, *args]
+  			!!( DO_CACHE && CACHE.get(ckey) )
+  		end
+  		define_method :"__uncache_#{sym}" do |*args|
+  			ckey = [self.cache_key, sym, *args]
+  			CACHE.delete(ckey)
+  		end
+  	end
+	end
+	
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: model-cache
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Frantisek Havluj
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-12 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: moskyt@rozhled.cz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/model-cache.rb
+- lib/model_cache.rb
+- init.rb
+- README.rdoc
+- MIT-LICENSE
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/moskyt/model-cache
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Rails plugin for caching in models.
+test_files: []
+