redis-kit 0.0.2 → 0.0.3

data/CHANGELOG.md

@@ -1,16 +1,21 @@
-0.0.2
-=====
+0.0.3 (March 8th, 2013)
+-----------------------
 
-* Add support for Ruby 2.0.0.
-* Drop support for Rails < 3.2 and Ruby < 1.9.3.
-* Fix bug whereby redis-kit would clobber Resque hooks, replacing them with its
-  own.
-* Allow MockRedis as a back-end (for tests).
+  * Add `RedisKit::Cache` with simple value caching helpers.
 
-0.0.1
-=====
+0.0.2 (March 4th, 2013)
+-----------------------
 
-* Initial release with support for:
+  * Add support for Ruby 2.0.0.
+  * Drop support for Rails < 3.2 and Ruby < 1.9.3.
+  * Fix bug whereby redis-kit would clobber Resque hooks, replacing them with
+    its own.
+  * Allow MockRedis as a back-end (for tests).
+
+0.0.1 (Unreleased)
+------------------
+
+  * Initial release with support for:
     * Rails 3.0, 3.1, 3.2
     * Ruby 1.9.1, 1.9.2, 1.9.3, 2.0
     * JRuby in 1.9 mode

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    redis-kit (0.0.1)
+    redis-kit (0.0.2)
       hiredis (~> 0.4.0)
       mock_redis (~> 0.6.0)
       redis (~> 3.0.0)
@@ -16,11 +16,9 @@ GEM
       pry (>= 0.9.10)
       terminal-table (>= 1.4.3)
       thor (>= 0.14.6)
-    guard-test (0.7.0)
-      guard (>= 1.1)
-      test-unit (~> 2.2)
+    guard-minitest (0.5.0)
+      guard (>= 0.4)
     hiredis (0.4.5)
-    hiredis (0.4.5-java)
     listen (0.7.3)
     lumberjack (1.0.2)
     method_source (0.8.1)
@@ -40,7 +38,6 @@ GEM
     slop (3.4.3)
     spoon (0.0.1)
     terminal-table (1.4.5)
-    test-unit (2.5.4)
     thor (0.17.0)
 
 PLATFORMS
@@ -48,8 +45,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  guard
-  guard-test
-  rake
-  rb-fsevent
+  guard (~> 1.6.0)
+  guard-minitest (~> 0.5.0)
+  rake (~> 10.0.0)
+  rb-fsevent (~> 0.9.0)
   redis-kit!

data/Guardfile

@@ -1,6 +1,8 @@
-guard :test do
-  watch(%r{^lib/(.+)\.rb$})     { |m| "test/#{m[1]}_test.rb" }
-  watch(%r{^test/.+_test\.rb$})
-  watch('test/test_helper.rb')  { "test" }
+group 'test' do
+  guard 'minitest' do
+    watch(%r|^test/(.*)_test\.rb|)
+    watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+    watch(%r|^test/test_helper\.rb|)   { "test" }
+  end
 end
 

data/README.md

@@ -14,6 +14,11 @@ Ruby when used with any of the following:
 * Resque
 * *More soon...*
 
+It also includes some (optional) classes that support common Redis uses:
+
+* RedisKit::Cache (`require 'redis-kit/cache') - Cache the results of code
+  blocks.
+
 Using RedisKit
 --------------
 
@@ -81,8 +86,84 @@ If `$redis` is a different Redis connection than `Resque.redis`, RedisKit will
 handle reconnecting the connection after Resque forks. If they're the same
 connection, Resque will handle the connection as usual.
 
+Extras
+======
+
+RedisKit::Cache
+---------------
+
+RedisKit::Cache is a simple caching helper that caches values in Redis with a
+configurable timeout.
+
+```ruby
+require 'redis-kit'
+require 'redis-kit/cache'
+
+# Result of block is cached for 10 seconds
+RedisKit::Cache.cached("my-key", 10) do
+  # ...
+end
+
+# Manually expire the cached value:
+RedisKit::Cache.expire("my-key")
+```
+
+The RedisKit::Cache::Helper helper module makes working with cached values in a
+class easy:
+
+```ruby
+require 'redis-kit'
+require 'redis-kit/cache'
+
+class MyCachedClass
+  include RedisKit::Cache::Helper
+
+  # This method's result will be cached in Redis for 10 seconds.
+  def expensive_stuff
+    cached("#{self.id}", 10) do
+      # ...
+    end
+  end
+
+  # Manually expire cached values, if needed:
+  def reset_stuff
+    expire("${self.id}")
+  end
+end
+```
+
+(Both the `cached` method and the `expire` methods are available at the class and
+instance levels.)
+
+You can set a class-wide namespace and default timeout:
+
+```ruby
+class MyCachedClass
+  include RedisKit::Cache::Helper
+  cache_timeout 600 # optional, default: 60 seconds
+  cache_namespace "my-cached-class" # optional, default: no namespace
+
+  # Cached for 10 minutes
+  def expensive_stuff
+    cached("#{self.id}") do
+      # ...
+    end
+  end
+end
+```
+
+Keep in mind that values are stored (and returned) by Redis as strings, so you
+may need to serialize / deserialize your data manually:
+
+```ruby
+value = cached("thing") do
+  JSON.dump(["cool", "values"])
+end
+value = JSON.load(value)
+```
+
 Support
--------
+=======
 
 RedisKit officially supports the following Rubies:
 
@@ -96,7 +177,7 @@ And the following libraries:
 * Resque >= 1.6
 
 Development
------------
+===========
 
 Set up and run tests with:
 
@@ -104,7 +185,7 @@ Set up and run tests with:
     make test
 
 TODO
-----
+====
 
 * Add generators for common files
   * Resque initializer

data/Rakefile

@@ -2,8 +2,9 @@ require "bundler/gem_tasks"
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
+  t.libs << "lib"
   t.libs << "test"
-  t.test_files = FileList['test/*_test.rb']
+  t.test_files = FileList['test/*_test.rb'] + FileList['test/lib/**/*_test.rb']
   t.verbose = true
 end
 task :default => :test

data/lib/redis-kit/cache/helper.rb

@@ -0,0 +1,45 @@
+module RedisKit
+  class Cache
+    module Helper
+      def self.included( base )
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def cache_namespace( value = nil )
+          @cache_namespace = value.to_s unless value == nil
+          @cache_namespace || ""
+        end
+
+        def cache_timeout( value = nil )
+          @cache_timeout = value if value
+          @cache_timeout || 60
+        end
+
+        def cached( key, timeout = nil, &block )
+          timeout ||= cache_timeout
+          RedisKit::Cache.get with_namespace( key ), timeout, &block
+        end
+
+        def expire( key )
+          RedisKit::Cache.expire with_namespace( key )
+        end
+
+        protected
+
+        def with_namespace( key )
+          cache_namespace != "" ? "#{cache_namespace}:#{key}" : key
+        end
+      end
+
+      def cached( key, timeout = nil, &block )
+        self.class.cached( key, timeout, &block )
+      end
+
+      def expire( key )
+        self.class.expire key
+      end
+    end
+  end
+end
+

data/lib/redis-kit/cache.rb

@@ -0,0 +1,23 @@
+module RedisKit
+  class Cache
+    class << self
+      def get( key, timeout, &block )
+        key = key.to_s
+        if value = RedisKit.redis.get( key )
+          value
+        else
+          value = yield
+          RedisKit.redis.setex key, timeout, value
+          value
+        end
+      end
+
+      def expire( key )
+        RedisKit.del key
+      end
+    end
+  end
+end
+
+require 'redis-kit/cache/helper'
+

data/lib/redis-kit/version.rb

@@ -1,3 +1,4 @@
 module RedisKit
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end
+

data/lib/redis-kit.rb

@@ -10,6 +10,14 @@ module RedisKit
 
   CUSTOM_CONFIG_KEYS = [:mock]
 
+  class << self
+    attr_writer :redis
+
+    def redis
+      @redis || $redis
+    end
+  end
+
   def self.new_redis( path, env )
     config = load_config( path, env )
     if config[:mock]

data/redis-kit.gemspec

@@ -21,8 +21,9 @@ Gem::Specification.new do |s|
   s.add_dependency "redis", "~> 3.0.0"
   s.add_dependency "hiredis", "~> 0.4.0" if RUBY_ENGINE != "jruby"
   s.add_dependency "mock_redis", "~> 0.6.0"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rb-fsevent"
-  s.add_development_dependency "guard"
-  s.add_development_dependency "guard-test"
+  s.add_development_dependency "rake", "~> 10.0.0"
+  s.add_development_dependency "rb-fsevent", "~> 0.9.0"
+  s.add_development_dependency "guard", "~> 1.6.0"
+  s.add_development_dependency "guard-minitest", "~> 0.5.0"
 end
+

data/test/redis-kit/cache/helper_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+require 'redis-kit/cache'
+
+class CachedClass
+  include RedisKit::Cache::Helper
+  cache_timeout 600
+  cache_namespace "foo"
+
+  def self.run
+    one = cached( "bar", 10 ) do
+      "one"
+    end
+    two = cached( "biz" ) do
+      "two"
+    end
+    one + two
+  end
+
+  def run
+    one = cached( "baz", 10 ) do
+      "one"
+    end
+    two = cached( "bix" ) do
+      "two"
+    end
+    one + two
+  end
+end
+
+describe RedisKit::Cache::Helper do
+  before do
+    RedisKit.redis = RedisKit.new_redis( good_config_path, "test_mock" )
+  end
+
+  it "provides helpers" do
+    CachedClass.run.must_equal "onetwo"
+    RedisKit.redis.get( "foo:bar" ).must_equal "one"
+    RedisKit.redis.ttl( "foo:bar" ).must_equal 10
+    RedisKit.redis.get( "foo:biz" ).must_equal "two"
+    RedisKit.redis.ttl( "foo:biz" ).must_equal 600
+
+    CachedClass.new.run.must_equal "onetwo"
+    RedisKit.redis.get( "foo:baz" ).must_equal "one"
+    RedisKit.redis.ttl( "foo:baz" ).must_equal 10
+    RedisKit.redis.get( "foo:bix" ).must_equal "two"
+    RedisKit.redis.ttl( "foo:bix" ).must_equal 600
+  end
+end
+

data/test/redis-kit/cache_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+require 'redis-kit/cache'
+
+describe RedisKit::Cache do
+  before do
+    RedisKit.redis = RedisKit.new_redis( good_config_path, "test_mock" )
+  end
+
+  after do
+    RedisKit.redis.del "test:*"
+  end
+
+  it "caches values" do
+    calculated = false
+    value = RedisKit::Cache.get( "test:foo", 60 ) do
+      calculated = true
+      "yep"
+    end
+    value.must_equal "yep"
+    calculated.must_equal true
+    RedisKit.redis.ttl( "test:foo" ).must_equal 60
+
+    # cache primed
+    calculated = false
+    value = RedisKit::Cache.get( "test:foo", 60 ) do
+      calculated = true
+      "yep"
+    end
+    value.must_equal "yep"
+    calculated.must_equal false
+  end
+end
+

data/test/redis-kit_test.rb

@@ -1,4 +1,4 @@
-require_relative "test_helper"
+require "test_helper"
 
 describe "RedisKit.load_config" do
   after do
@@ -70,3 +70,12 @@ describe "RedisKit.new_redis" do
   end
 end
 
+describe "RedisKit.redis" do
+  it "stores a global Redis connection" do
+    redis = RedisKit.new_redis( good_config_path, "test" )
+    RedisKit.redis.must_be_nil
+    RedisKit.redis = redis
+    RedisKit.redis.must_equal redis
+  end
+end
+

data/test/test_helper.rb

@@ -1,6 +1,6 @@
-require_relative "../lib/redis-kit"
 require 'minitest/spec'
 require 'minitest/autorun'
+require 'redis-kit'
 
 def jruby?
   RUBY_ENGINE == "jruby"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-kit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -64,65 +64,65 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.0.0
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: guard-test
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.0
 description: simple redis init for rails projects
 email:
 - tyson@stovepipestudios.com
@@ -140,6 +140,8 @@ files:
 - README.md
 - Rakefile
 - lib/redis-kit.rb
+- lib/redis-kit/cache.rb
+- lib/redis-kit/cache/helper.rb
 - lib/redis-kit/railtie.rb
 - lib/redis-kit/resque.rb
 - lib/redis-kit/version.rb
@@ -186,6 +188,8 @@ files:
 - test/railsapi/test/test_helper.rb
 - test/railsapi/test/unit/.gitkeep
 - test/railsapi/test/unit/redis-kit_test.rb
+- test/redis-kit/cache/helper_test.rb
+- test/redis-kit/cache_test.rb
 - test/redis-kit_test.rb
 - test/support/redis.blank.yml
 - test/support/redis.good.yml
@@ -258,6 +262,8 @@ test_files:
 - test/railsapi/test/test_helper.rb
 - test/railsapi/test/unit/.gitkeep
 - test/railsapi/test/unit/redis-kit_test.rb
+- test/redis-kit/cache/helper_test.rb
+- test/redis-kit/cache_test.rb
 - test/redis-kit_test.rb
 - test/support/redis.blank.yml
 - test/support/redis.good.yml