cachy 0.1.4 → 0.1.5

data/{README.markdown → Readme.md}

@@ -8,7 +8,7 @@ Caching library to simplify and organize caching.
  - Global cache_version (expire everything Cachy cached, but not e.g. sessions)
  - ...
  - works out of the box with Rails
- - works with pure Memcache and [Moneta](http://github.com/wycats/moneta/tree/master)(-> Tokyo Cabinet / CouchDB / S3 / Berkeley DB / DataMapper / Memory store)
+ - works with pure Memcache, Redis and [Moneta](http://github.com/wycats/moneta/tree/master)(-> Tokyo Cabinet / CouchDB / S3 / Berkeley DB / DataMapper / Memory store)
 
 Install
 =======
@@ -104,6 +104,9 @@ Give me something that responds to read/write(Rails style) or []/store([Moneta](
 No I18n.available_locales ?
     Cachy.locales = [:de, :en, :fr]
 
+### Memcache timeout protection
+If Memcache timeouts keep killing your pages -> [catch MemCache timeouts](http://github.com/grosser/cachy/blob/master/lib/cachy/memcache_timeout_protection)
+
 TODO
 ====
  - optionally store dependent keys (:keys=>xxx), so that they can be setup up once and do not need to be remembered
@@ -114,6 +117,6 @@ Authors
 ###Contributors
  - [mindreframer](http://www.simplewebapp.de/roman)
 
-[Michael Grosser](http://pragmatig.wordpress.com)  
+[Michael Grosser](http://grosser.it)  
 grosser.michael@gmail.com  
-Hereby placed under public domain, do what you want, just do not hold me accountable...
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.1.5

data/cachy.gemspec

@@ -5,26 +5,26 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cachy}
-  s.version = "0.1.4"
+  s.version = "0.1.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2010-08-14}
+  s.date = %q{2010-10-29}
   s.email = %q{grosser.michael@gmail.com}
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
   s.files = [
-    "README.markdown",
-     "Rakefile",
+    "Rakefile",
+     "Readme.md",
      "VERSION",
      "cachy.gemspec",
      "lib/cachy.rb",
+     "lib/cachy/memcache_timeout_protection.rb",
      "lib/cachy/memcached_wrapper.rb",
      "lib/cachy/moneta_wrapper.rb",
+     "lib/cachy/redis_wrapper.rb",
      "lib/cachy/wrapper.rb",
      "spec/cachy/memcached_wrapper_spec.rb",
      "spec/cachy/moneta_wrapper_spec.rb",
+     "spec/cachy/redis_wrapper_spec.rb",
      "spec/cachy_spec.rb",
      "spec/spec_helper.rb",
      "spec/test_cache.rb"
@@ -37,6 +37,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/cachy/memcached_wrapper_spec.rb",
      "spec/cachy/moneta_wrapper_spec.rb",
+     "spec/cachy/redis_wrapper_spec.rb",
      "spec/cachy_spec.rb",
      "spec/test_cache.rb",
      "spec/spec_helper.rb"

data/lib/cachy.rb

@@ -116,18 +116,8 @@ class Cachy
 
   # Wrap non ActiveSupport style cache stores,
   # to get the same interface for all
-  def self.cache_store=(x)
-    if x.respond_to? :read and x.respond_to? :write
-      @cache_store=x
-    elsif x.respond_to? "[]" and x.respond_to? :set
-      require 'cachy/memcached_wrapper'
-      @cache_store = MemcachedWrapper.new(x)
-    elsif x.respond_to? "[]" and x.respond_to? :store
-      require 'cachy/moneta_wrapper'
-      @cache_store = MonetaWrapper.new(x)
-    else
-      raise "This cache_store type is not usable for Cachy!"
-    end
+  def self.cache_store=(cache)
+    @cache_store = wrap_cache(cache)
     @cache_store.write HEALTH_CHECK_KEY, 'yes'
   end
 
@@ -135,7 +125,13 @@ class Cachy
     @cache_store || raise("Use: Cachy.cache_store = your_cache_store")
   end
 
-  self.cache_store = ActionController::Base.cache_store if defined? ActionController::Base
+  def self.key_versions_cache_store=(cache)
+    @key_versions_cache_store = wrap_cache(cache)
+  end
+
+  def self.key_versions_cache_store
+    @key_versions_cache_store || cache_store
+  end
 
   # locales
   @@locales = nil
@@ -154,19 +150,39 @@ class Cachy
 
   private
 
-  def self.read_versions
-    data = cache_store.instance_variable_get('@data')
-    if data.respond_to? :read_error_occured # its a MemCache with read_error detection !
-      result = data[KEY_VERSIONS_KEY] || {}
-      @@cache_error = data.read_error_occured
-      result
+  def self.wrap_cache(cache)
+    if cache.respond_to? :read and cache.respond_to? :write
+      cache
+    elsif cache.class.to_s == 'Redis'
+      require 'cachy/redis_wrapper'
+      RedisWrapper.new(cache)
+    elsif cache.respond_to? "[]" and cache.respond_to? :set
+      require 'cachy/memcached_wrapper'
+      MemcachedWrapper.new(cache)
+    elsif cache.respond_to? "[]" and cache.respond_to? :store
+      require 'cachy/moneta_wrapper'
+      MonetaWrapper.new(cache)
     else
-      cache_store.read(KEY_VERSIONS_KEY) || {}
+      raise "This cache_store type is not usable for Cachy!"
     end
   end
 
+  def self.read_versions
+    store = key_versions_cache_store
+    result = store.read(KEY_VERSIONS_KEY) || {}
+    detect_cache_error(store)
+    result
+  end
+
   def self.write_version(data)
-    cache_store.write(KEY_VERSIONS_KEY, data) unless @@cache_error
+    key_versions_cache_store.write(KEY_VERSIONS_KEY, data) unless @@cache_error
+  end
+
+  def self.detect_cache_error(store)
+    data = store.instance_variable_get('@data')
+    if data.respond_to? :read_error_occurred
+      @@cache_error = data.read_error_occurred
+    end
   end
 
   def self.cache_healthy?
@@ -233,4 +249,6 @@ class Cachy
       {}
     end
   end
-end
+end
+
+Cachy.cache_store = ActionController::Base.cache_store if defined? ActionController::Base

data/lib/cachy/memcache_timeout_protection.rb

@@ -0,0 +1,30 @@
+# do not let MemCache timeouts kill your app,
+# mark as error and return read_error_callback (e.g. nil -> cache miss)
+require 'memcache'
+
+class MemCache
+  # Add your callback to stop timeouts from raising
+  #
+  # MemCache.read_error_callback = lambda{|error|
+  #   error.message << ' -- catched'
+  #   HoptoadNotifier.notify error
+  #   nil
+  # }
+
+  cattr_accessor :read_error_callback, :read_error_occurred
+
+  def cache_get_with_timeout_protection(*args)
+    begin
+      @read_error_occurred = false
+      cache_get_without_timeout_protection(*args)
+    rescue Exception => error
+      @read_error_occurred = true
+      if error.to_s == 'IO timeout' and self.class.read_error_callback
+        self.class.read_error_callback.call error
+      else
+        raise error
+      end
+    end
+  end
+  alias_method_chain :cache_get, :timeout_protection
+end

data/lib/cachy/memcached_wrapper.rb

@@ -1,6 +1,5 @@
 require 'cachy/wrapper'
 
-# Wrapper for Memcached
 class Cachy::MemcachedWrapper < Cachy::Wrapper
   def write(key, result, options={})
     @wrapped.set(key, result, options[:expires_in].to_i)

data/lib/cachy/redis_wrapper.rb

@@ -0,0 +1,20 @@
+require 'cachy/wrapper'
+require 'yaml'
+
+class Cachy::RedisWrapper < Cachy::Wrapper
+  def read(key)
+    result = @wrapped[key]
+    return if result.nil?
+    YAML.load(result)
+  end
+
+  def write(key, value, options={})
+    result = @wrapped.set(key, value.to_yaml)
+    @wrapped.expire(key, options[:expires_in].to_i) if options[:expires_in]
+    result
+  end
+
+  def delete(key)
+    @wrapped.del(key)
+  end
+end

data/spec/cachy/redis_wrapper_spec.rb

@@ -0,0 +1,67 @@
+require 'spec/spec_helper'
+
+class TestRedis
+  def self.to_s
+    'Redis'
+  end
+
+  def initialize
+    @wrapped = {}
+  end
+
+  def set(key, object)
+    @wrapped[key] = object
+  end
+
+  def expire(key, seconds)
+  end
+
+  def [](x)
+    @wrapped[x]
+  end
+
+  def clear
+    @wrapped.clear
+  end
+
+  def del(key)
+    @wrapped.delete(key)
+  end
+end
+
+describe "Cachy::RedisWrapper" do
+  before :all do
+    @cache = TestRedis.new
+    Cachy.cache_store = @cache
+  end
+
+  before do
+    @cache.clear
+  end
+
+  it "is wrapped" do
+    Cachy.cache_store.class.should == Cachy::RedisWrapper
+  end
+
+  it "can cache" do
+    Cachy.cache(:x){ 'SUCCESS' }
+    Cachy.cache(:x){ 'FAIL' }.should == 'SUCCESS'
+  end
+
+  it "can cache without expires" do
+    @cache.should_receive(:set).with('x_v1', "--- SUCCESS\n")
+    @cache.should_not_receive(:expire)
+    Cachy.cache(:x){ 'SUCCESS' }.should == 'SUCCESS'
+  end
+
+  it "can cache with expires" do
+    @cache.should_receive(:set).with('x_v1', "--- SUCCESS\n")
+    @cache.should_receive(:expire).with('x_v1', 1)
+    Cachy.cache(:x, :expires_in=>1){ 'SUCCESS' }.should == 'SUCCESS'
+  end
+
+  it "can expire" do
+    @cache.should_receive(:del).with('x_v1')
+    Cachy.expire(:x)
+  end
+end

data/spec/cachy_spec.rb

@@ -285,7 +285,7 @@ describe Cachy do
     before do
       @mock = mock = {}
       @cache.instance_eval{@data = mock}
-      def @mock.read_error_occured
+      def @mock.read_error_occurred
         false
       end
       def @mock.[](x)
@@ -300,13 +300,13 @@ describe Cachy do
 
     it "reads empty when it crashes" do
       @mock.should_receive(:[]).and_return nil # e.g. Timout happended
-      @mock.should_receive(:read_error_occured).and_return true
+      @mock.should_receive(:read_error_occurred).and_return true
       Cachy.send(:read_versions).should == {}
     end
 
     it "marks as error when it crashes" do
       Cachy.send(:class_variable_get, '@@cache_error').should == false
-      @mock.should_receive(:read_error_occured).and_return true
+      @mock.should_receive(:read_error_occurred).and_return true
       Cachy.send(:read_versions)
       Cachy.send(:class_variable_get, '@@cache_error').should == true
     end
@@ -330,6 +330,23 @@ describe Cachy do
     end
   end
 
+  describe :key_versions, 'with separate store' do
+    let(:key_cache){ TestCache.new }
+
+    it "reads from separate store" do
+      key_cache.write(Cachy::KEY_VERSIONS_KEY, :x => 1)
+      Cachy.key_versions_cache_store = key_cache
+      Cachy.key_versions.should == {:x => 1}
+    end
+
+    it "writes to separate store" do
+      key_cache.write(Cachy::KEY_VERSIONS_KEY, :x => 1)
+      Cachy.key_versions_cache_store = key_cache
+      Cachy.increment_key :x
+      Cachy.key_versions.should == {:x => 2}
+    end
+  end
+
   describe :delete_key do
     it "removes a key from key versions" do
       Cachy.cache(:xxx){1}

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Michael Grosser
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-14 00:00:00 +02:00
+date: 2010-10-29 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -24,19 +24,22 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- README.markdown
 - Rakefile
+- Readme.md
 - VERSION
 - cachy.gemspec
 - lib/cachy.rb
+- lib/cachy/memcache_timeout_protection.rb
 - lib/cachy/memcached_wrapper.rb
 - lib/cachy/moneta_wrapper.rb
+- lib/cachy/redis_wrapper.rb
 - lib/cachy/wrapper.rb
 - spec/cachy/memcached_wrapper_spec.rb
 - spec/cachy/moneta_wrapper_spec.rb
+- spec/cachy/redis_wrapper_spec.rb
 - spec/cachy_spec.rb
 - spec/spec_helper.rb
 - spec/test_cache.rb
@@ -73,6 +76,7 @@ summary: Caching library for projects that have many processes or many caches
 test_files: 
 - spec/cachy/memcached_wrapper_spec.rb
 - spec/cachy/moneta_wrapper_spec.rb
+- spec/cachy/redis_wrapper_spec.rb
 - spec/cachy_spec.rb
 - spec/test_cache.rb
 - spec/spec_helper.rb