ziggy 0.1.7

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Oliver Searle-Barnes
+ 
+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.markdown

@@ -0,0 +1,103 @@
+ziggy
+=====
+
+Cache any method on any class using Rails.cache
+
+Install
+-------
+
+    $ gem sources -a http://gems.github.com (you only have to do this once)
+    $ sudo gem install opsb-ziggy
+
+Introduction
+------------
+
+ziggy will cache methods and then expire them. The results from method invocations are stored in and read from the Rails.cache using Rails.cache.write(key, value) and Rails.cache.read(key).
+
+### Cache a method
+
+	class TwitterUser
+	  include Ziggy
+	  cached :timeline
+
+	  def timeline
+		twitter_client.timeline
+	  end
+
+	  ...
+
+	end
+
+### Cache many methods
+
+	class TwitterUser
+	  include Ziggy
+	  cached :timeline, :direct_messages
+
+	  def timeline
+		twitter_client.timeline
+	  end
+
+	  def direct_messages
+	    twitter_client.direct_messages
+	  end
+
+	  ...
+
+	end
+
+### expire_after
+
+The default expire_after time is 2.5.minutes, to customise do
+
+	class TwitterUser
+	  include Ziggy
+	  cached :timeline, :expire_after => 1.5.minutes
+
+	  def timeline
+		twitter_client.timeline
+	  end
+
+	  ...
+
+	end
+
+### Customise key
+
+The method name and arguments are always used as the base of the cache key. You can customise the start of the cache key using a block.
+
+    class TwitterUser
+      include Ziggy
+      cached :timeline { |twitterUser| twitterUser.screen_name }
+
+	  def timeline
+		twitter_client.timeline
+	  end
+
+	  ...
+
+	end
+
+### Different options for different methods
+
+	class TwitterUser
+	  include Ziggy
+	  cached :timeline, :expire_after => 1.minutes { |twitterUser| twitterUser.screen_name }
+	  cached :direct_messages, :expire_after => 10.minutes { |twitterUser| twitterUser.screen_name }
+
+	  def timeline
+		twitter_client.timeline
+	  end
+
+	  def direct_messages
+	    twitter_client.direct_messages
+	  end
+
+	  ...
+
+	end
+	
+### Disable ziggy
+Perhaps you want to disable ziggy for tests? Add the following to your test.rb
+
+    Ziggy::active = false

data/RakeFile

@@ -0,0 +1,15 @@
+task :default => [:gemspec]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "ziggy"
+    gemspec.summary = "Cache any method on any class"
+    gemspec.description = "ziggy can be used to cache any method on any class and allows custom keys and expiration times"
+    gemspec.email = "oliver@opsb.co.uk"
+    gemspec.homepage = "http://github.com/opsb/ziggy"
+    gemspec.authors = ["Oliver Searle-Barnes"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 7
+:major: 0

data/lib/ziggy.rb

@@ -0,0 +1,70 @@
+module Ziggy
+  @@active = true
+  
+  def self.active=(active)
+    @@active = active
+  end
+  
+  def self.active
+    @@active
+  end
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.instance_eval do
+      @should_be_cached = []
+      @cached = []  
+      @keygens = {}
+      @expire_after = {}
+    end
+  end
+
+  module ClassMethods
+    def cached(*cachable_methods, &block)
+      return unless Ziggy::active
+      opts = (cachable_methods.pop if cachable_methods.last.kind_of? Hash) || {}
+      @should_be_cached += cachable_methods
+      cachable_methods.each do |m| 
+        @keygens[m] = block
+        @expire_after[m] = opts[:expire_after] || 2.5.minutes
+      end
+    end
+    
+    def should_be_cached?(method)
+      @should_be_cached.include? method
+    end
+    
+    def cached?(method)
+      @cached.include? method
+    end
+    
+    def method_added(method)
+      return unless should_be_cached?(method) && !cached?(method)
+      @cached << method
+      method_without_cache = "#{method}_without_cache".to_sym
+      class_eval do 
+        alias_method method_without_cache, method 
+        define_method(method) do |*args|
+          key = self.class.build_key(self, method, args)
+          return Rails.cache.read(key) if Rails.cache.exist?(key)
+          result = send(method_without_cache, *args)
+          Rails.cache.write(key, result, :expires_in => self.class.expire_after(method))
+          result
+        end
+      end
+      logger.debug "Caching added to #{self}.#{method}"
+    end    
+    
+    def expire_after(method)
+      @expire_after[method]
+    end
+    
+    def build_key(instance, method, args)
+      invocation_key = "#{method}#{ args.collect{ |a| a.to_s } }"
+      keygen = @keygens[method]
+      differentiator = (keygen.call(instance) unless keygen.nil?) || ""
+      differentiator + invocation_key
+    end    
+  end
+  
+end

data/ziggy.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ziggy}
+  s.version = "0.1.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Oliver Searle-Barnes"]
+  s.date = %q{2009-07-19}
+  s.description = %q{ziggy can be used to cache any method on any class and allows custom keys and expiration times}
+  s.email = %q{oliver@opsb.co.uk}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.markdown"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.markdown",
+     "RakeFile",
+     "VERSION.yml",
+     "lib/ziggy.rb",
+     "ziggy.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/opsb/ziggy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Cache any method on any class}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: ziggy
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 7
+  version: 0.1.7
+platform: ruby
+authors: 
+- Oliver Searle-Barnes
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-19 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: ziggy can be used to cache any method on any class and allows custom keys and expiration times
+email: oliver@opsb.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- LICENSE
+- README.markdown
+- RakeFile
+- VERSION.yml
+- lib/ziggy.rb
+- ziggy.gemspec
+has_rdoc: true
+homepage: http://github.com/opsb/ziggy
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 2
+summary: Cache any method on any class
+test_files: []
+