redrecord 0.1 → 0.2

data/CHANGELOG

@@ -1 +1,4 @@
+
+v0.2. Support disabling cache on timeout
+
 v0.1. First version

data/Manifest

@@ -1,7 +1,7 @@
 CHANGELOG
+Manifest
 README
 Rakefile
 lib/redrecord.rb
 test/test_all.rb
 test/test_helper.rb
-Manifest

data/README

@@ -62,6 +62,33 @@ Other instance methods of interest:
 
 
 
+If redis is down?
+-----------------
+
+To enable talking to a redis server, set Redrecord.enabled=true
+
+If Redrecord can't access redis within a timeout (Redrecord.timeout=15 by
+default) then it sets enabled=false, disabling all redis access so your
+application can keep working without the cache.
+
+For testing purposes, you can set Redrecord.write_only = true
+This keeps the cache contents up to date but does not read back any cached
+content.
+
+
+Setup
+-----
+
+in your Gemfile:
+
+   gem 'redrecord'
+
+in your rails app config/initializers/redrecord.rb:
+
+   $redis = Redis.new(:host => 'localhost', :port => 6379, :db => 1)
+   Redrecord.redis = $redis
+   Redrecord.enabled = true
+
 
 
 Contact the author

data/lib/redrecord.rb

@@ -1,14 +1,27 @@
 
+require 'timeout'
+
 class Redrecord
 
   class << self
-    attr_accessor :redis
+    attr_accessor :redis, :enabled, :write_only, :timeout
     def update_queue
       Thread.current[:redrecord_update_queue] ||= []
     end
     def is_marshalled?(str)
       Marshal.dump(nil)[0,2] == str[0,2]
     end
+    def redis_op(op, *args)
+      if @enabled
+        begin
+          Timeout.timeout(@timeout || 15) do
+            redis.send(op, *args)
+          end
+        rescue Timeout::Error
+          @enabled = nil
+        end
+      end
+    end
   end
 
   module Model
@@ -92,11 +105,11 @@ class Redrecord
     end
     
     def remove_from_cache!
-      Redrecord.redis.del redrecord_key
+      Redrecord.redis_op :del, redrecord_key
     end
     
     def add_to_cache!
-      Redrecord.redis.hmset(redrecord_key,
+      Redrecord.redis_op(:hmset, redrecord_key,
         *(self.class.redrecord_cached_fields.map {|f|
           val = send("#{f}_without_cache")
           [f.to_s, String===val && !Redrecord.is_marshalled?(val) ? val : Marshal.dump(val)]
@@ -109,12 +122,12 @@ class Redrecord
     end
 
     def redrecord_redis_cache
-      @redrecord_redis_cache ||= Redrecord.redis.hgetall(redrecord_key)
+      @redrecord_redis_cache ||= Redrecord.redis_op(:hgetall, redrecord_key) unless Redrecord.write_only
     end
 
     def redrecord_cached_attrib_hash
       @redrecord_cached_attrib_hash ||= Hash.new do |h,k|
-        h[k.to_sym] = if(cached = (redrecord_redis_cache[k.to_s] unless new_record?))
+        h[k.to_sym] = if(cached = (redrecord_redis_cache && redrecord_redis_cache[k.to_s] unless new_record?))
           Redrecord.is_marshalled?(cached) ? Marshal.load(cached) : cached
         else
           send("#{k}_without_cache")

data/redrecord.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = "redrecord"
-  s.version = "0.1"
+  s.version = "0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andrew Snow"]
-  s.date = "2012-01-23"
+  s.date = "2012-01-25"
   s.description = "Redis cacheing for ActiveRecord"
   s.email = "andrew@modulus.org"
   s.extra_rdoc_files = ["CHANGELOG", "README", "lib/redrecord.rb"]
-  s.files = ["CHANGELOG", "README", "Rakefile", "lib/redrecord.rb", "test/test_all.rb", "test/test_helper.rb", "Manifest", "redrecord.gemspec"]
+  s.files = ["CHANGELOG", "Manifest", "README", "Rakefile", "lib/redrecord.rb", "test/test_all.rb", "test/test_helper.rb", "redrecord.gemspec"]
   s.homepage = "http://github.com/andys/redrecord"
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Redrecord", "--main", "README"]
   s.require_paths = ["lib"]

data/test/test_all.rb

@@ -9,6 +9,7 @@ require "#{File.dirname(__FILE__)}/test_helper"
 class TestRedrecord < Test::Unit::TestCase
   def setup
     $redis.flushdb
+    Redrecord.enabled = true
     @user = TestUser.new(1, 'John', 'Smith')
     $saved = {}
   end
@@ -29,7 +30,6 @@ class TestRedrecord < Test::Unit::TestCase
     assert_nil u2.recalculated
   end
 
-
   def test_cached_nil_attribute_save
     @user.save
     assert_equal Marshal.dump(nil), $redis.hget('TestUser:1', 'nil')
@@ -103,5 +103,22 @@ class TestRedrecord < Test::Unit::TestCase
       @user.attribs_with_cached_fields)
   end
 
+  def test_write_only_mode
+    Redrecord.write_only = true
+    @user.save
+    assert_equal 'John Smith', $redis.hget('TestUser:1', 'full_name')
+    
+    # different object should not get the value from redis
+    u2 = TestUser.new(1, 'Bob', 'Smith')
+    assert_equal 'Bob Smith', u2.full_name
+    assert u2.recalculated    
+  end
+
+  def test_disabled_mode
+    Redrecord.enabled = nil
+    @user.save
+    assert_nil $redis.hget('TestUser:1', 'full_name')
+  end
+
   
 end

data/test/test_helper.rb

@@ -1,5 +1,8 @@
-$redis = Redis.new(:host => 'localhost', :port => 6379) # TODO: dangerous!
+
+# WARNING: The database specified here will be CLEARED of ALL DATA
+$redis = Redis.new(:host => 'localhost', :port => 6379, :db => 15)
 Redrecord.redis = $redis
+Redrecord.enabled = true
 
 class TestModel
   extend ActiveModel::Callbacks

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redrecord
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-23 00:00:00.000000000 Z
+date: 2012-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &71893080 !ruby/object:Gem::Requirement
+  requirement: &81395770 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *71893080
+  version_requirements: *81395770
 - !ruby/object:Gem::Dependency
   name: active_model
-  requirement: &71892570 !ruby/object:Gem::Requirement
+  requirement: &81395260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *71892570
+  version_requirements: *81395260
 - !ruby/object:Gem::Dependency
   name: active_support
-  requirement: &71891930 !ruby/object:Gem::Requirement
+  requirement: &81394630 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *71891930
+  version_requirements: *81394630
 description: Redis cacheing for ActiveRecord
 email: andrew@modulus.org
 executables: []
@@ -54,12 +54,12 @@ extra_rdoc_files:
 - lib/redrecord.rb
 files:
 - CHANGELOG
+- Manifest
 - README
 - Rakefile
 - lib/redrecord.rb
 - test/test_all.rb
 - test/test_helper.rb
-- Manifest
 - redrecord.gemspec
 homepage: http://github.com/andys/redrecord
 licenses: []