redis_store_jr 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Nick Plante
+
+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,47 @@
+= Redis Store Jr.
+
+This is a vastly simplified version of RedisStore.
+
+Most of the code was lifted directly from an earlier version of Luca Guidi's
+redis-store gem. It does *not* support Sinatra, Merb, or many of the other
+options that his Gem does. So if you're looking for that stuff, you probably
+want to take a look at the [the original
+project](http://github.com/jodosha/redis-store).
+
+On the other hand, if you're looking for a super-simple Redis store interface
+that works reliably with Rails and Redis 1.2, without the complicated
+(and often unnecessary) dependencies, look no further.
+
+== Installation
+
+We assume you already have [Redis](http://code.google.com/p/redis/) set up and
+running. If not, you know what to do.
+
+In your environment.rb:
+
+  config.gem 'redis_store_jr', :lib => 'redis_store'
+
+Or your Gemfile:
+
+  gem 'redis_store_jr', :require => 'redis_store' 
+
+In your production (or staging) environment config:
+
+  require 'redis_store'
+  config.cache_store = :redis_store, 'localhost:6379'
+
+This has only been tested on Rails 2.3.x. No guarantees about Rails 3.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Nick Plante. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "redis_store_jr"
+    gem.summary = %Q{Simple Redis Cache Store for Rails}
+    gem.description = %Q{Simple Redis Cache Store for Rails}
+    gem.email = "nap@zerosum.org"
+    gem.homepage = "http://github.com/zapnap/redis_store_jr"
+    gem.authors = ["Nick Plante"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "redis", "~>1.0"
+    gem.add_development_dependency "activesupport", "~>2.3"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/redis_store/cache/redis_store.rb

@@ -0,0 +1,81 @@
+module ActiveSupport
+  module Cache
+    # A cache store implementation which stores data in Redis.
+    class RedisStore < Store
+      # Creates a new RedisStore client object, with the given Redis server
+      # address. The address should be given as a string. For example:
+      #
+      #   ActiveSupport::Cache::RedisStore.new("localhost:6379/22")
+      #
+      # If no addresses are specified, then RedisStore will connect to the
+      # default Redis server port on localhost.
+      #
+      def initialize(address_or_options = {})
+        @data = ::RedisStore::MarshalledClient.new(::RedisStore::Config.new(address_or_options))
+      end
+
+      # Read a value from the cache.
+      def read(key, options = nil)
+        super
+        @data.marshalled_get(key, options)
+      end
+
+      # Write a value to the cache.
+      #
+      # Possible options:
+      # - +:unless_exist+ - set to true if you don't want to update the cache
+      #   if the key is already set.
+      # - +:expires_in+ - the number of seconds that this value may stay in
+      #   the cache. See ActiveSupport::Cache::Store#write for an example.
+      #
+      def write(key, value, options = nil)
+        super
+        method = options && options[:unless_exist] ? :marshalled_setnx : :marshalled_set
+        @data.send(method, key, value, options)
+      end
+
+      # Deleted a named value from the cache.
+      def delete(key, options = nil)
+        super
+        @data.del(key)
+      end
+
+      # Check for the existence of a particular key value.
+      def exist?(key, options = nil)
+        super
+        @data.exists(key)
+      end
+
+      # Note: to comply with the established cache store interface, matcher
+      # should be a Regexp. However, converting Regexps to globs (supported by
+      # Redis) is non-trivial.
+      #
+      # For now, we accept a string. Sorry about the conditional logic that is
+      # sure to follow :(.
+      #
+      def delete_matched(matcher, options = nil)
+        super
+        raise ArgumentError.new("Sorry, matcher must be a String") unless matcher.is_a?(String)
+        @data.keys(matcher).each { |key| @data.del(key) }
+      end
+
+      # Note: if key does not exist it will be initialized and return '1'.
+      def increment(key, amount = 1)
+        @data.incrby(key, amount)
+      end
+
+      # Note: if key does not exist it will be initialized and return '0'.
+      def decrement(key, amount = 1)
+        @data.decrby(key, amount)
+      end
+
+      def clear
+        @data.flushdb
+      end
+
+      def stats
+        @data.info
+      end
+    end
+  end
+end

data/lib/redis_store/marshalled_client.rb

@@ -0,0 +1,56 @@
+class RedisStore
+  class MarshalledClient < Redis::Client
+    def marshalled_set(key, val, options = nil)
+      val = marshal_value(val, options)
+      if expires_in = expires_in(options)
+        set_with_expire(key, val, expires_in)
+      else
+        set(key, val)
+      end
+    end
+
+    def marshalled_setnx(key, val, options = nil)
+      val = marshal_value(val, options)
+      if expires_in = expires_in(options)
+        setnx_with_expire(key, val, expires_in)
+      else
+        setnx(key, val)
+      end
+    end
+
+    def setnx_with_expire(key, value, ttl)
+      multi do
+        setnx(key, val)
+        expire(key, expires_in)
+      end
+    end
+
+    def marshalled_get(key, options = nil)
+      result = call_command([:get, key])
+      result = Marshal.load result if unmarshal?(result, options)
+      result
+    end
+
+    private
+
+    def marshal_value(val, options)
+      raw?(options) ? val : Marshal.dump(val)
+    end
+
+    def unmarshal?(result, options)
+      result && result.size > 0 && !raw?(options)
+    end
+
+    def raw?(options)
+      options && options[:raw]
+    end
+
+    def expires_in(options)
+      if options
+        options[:expire_after] || options[:expire_in]
+      else
+        nil
+      end
+    end
+  end
+end

data/lib/redis_store.rb

@@ -0,0 +1,26 @@
+gem 'redis', '~> 1.0'
+gem 'activesupport', '~> 2.3'
+
+require 'redis'
+require 'active_support'
+
+require 'redis_store/marshalled_client'
+require 'redis_store/cache/redis_store'
+
+class RedisStore
+  class Config < Hash
+    def initialize(address_or_options)
+      options = if address_or_options.is_a?(Hash)
+        address_or_options
+      else
+        host, port = address_or_options.split(/\:/)
+        port, db = port.split(/\//) if port
+        { :host => host, :port => port, :db => db }
+      end
+
+      self[:host] = options[:host] if options[:host]
+      self[:port] = options[:port] if options[:port]
+      self[:db] = options[:db] if options[:db]
+    end
+  end
+end

data/spec/cache_spec.rb

@@ -0,0 +1,125 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe ActiveSupport::Cache::RedisStore do
+  before(:each) do
+    @store  = ActiveSupport::Cache::RedisStore.new('localhost:6379')
+    @store.clear
+
+    @obj = OpenStruct.new(:name => 'Test')
+    @store.write('abc', @obj)
+  end
+
+  it 'should read and write data' do
+    with_store do |store|
+      store.write('abc', @obj)
+      store.read('abc').should == @obj
+    end
+  end
+
+  it 'should read and write data with an expiration' do
+    with_store do |store|
+      store.write('abc', @obj, :expire_in => 1.second)
+      store.read('abc').should == @obj ; sleep 2
+      store.read('abc').should be_nil
+    end
+  end
+
+  it 'should only write data if not already set' do
+    with_store do |store|
+      new = OpenStruct.new(:name => 'New')
+      store.write('abc', new, :unless_exist => true)
+      store.read('abc').should == @obj
+    end
+  end
+
+  it 'should read raw data' do
+    with_store do |store|
+      store.read('abc', :raw => true).should == Marshal.dump(@obj)
+    end
+  end
+
+  it 'should write raw data' do
+    with_store do |store|
+      store.write('abc', @obj, :raw => true)
+      store.read('abc', :raw => true).should == %(#<OpenStruct name="Test">)
+    end
+  end
+
+  it 'should delete data' do
+    with_store do |store|
+      store.delete('abc')
+      store.read('abc').should be_nil
+    end
+  end
+
+  it 'should delete matched data given a string glob matcher' do
+    with_store do |store|
+      store.write('abd', @obj)
+      store.write('axe', @obj)
+
+      store.delete_matched('ab*')
+      store.read('abc').should be_nil
+      store.read('abd').should be_nil
+      store.read('axe').should_not be_nil
+    end
+  end
+
+  it 'should delete matched data given a regexp'
+
+  it 'should verify existence of an object' do
+    with_store do |store|
+      store.exist?('abd').should be_false
+      store.exist?('abc').should be_true
+    end
+  end
+
+  it 'should increment a key' do
+    with_store do |store|
+      3.times { store.increment('ct') }
+      store.read('ct', :raw => true).to_i.should == 3
+    end
+  end
+
+  it 'should decrement a key' do
+    with_store do |store|
+      3.times { store.increment('ct') }
+      2.times { store.decrement('ct') }
+      store.read('ct', :raw => true).to_i.should == 1
+    end
+  end
+
+  it 'should increment a key by a given value' do
+    with_store do |store|
+      store.increment('ct')
+      store.increment('ct', 3)
+      store.read('ct', :raw => true).to_i.should == 4
+    end
+  end
+
+  it 'should decrement a key by a given value' do
+    with_store do |store|
+      3.times { store.increment('ct') }
+      store.decrement('ct', 2)
+      store.read('ct', :raw => true).to_i.should == 1
+    end
+  end
+
+  it 'should clear the store' do
+    with_store do |store|
+      store.clear
+      store.read('abc').should be_nil
+    end
+  end
+
+  it 'should return store stats' do
+    with_store do |store|
+      store.stats.should_not be_nil
+    end
+  end
+
+  private
+
+  def with_store
+    yield @store
+  end
+end

data/spec/marshalled_client_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe RedisStore::MarshalledClient do
+  before(:each) do
+    @store = RedisStore::MarshalledClient.new
+    @obj = OpenStruct.new(:name => 'Test')
+    @store.marshalled_set('abc', @obj)
+  end
+
+  after(:each) do
+    @store.quit
+  end
+
+  it 'should unmarshal an object on get' do
+    @store.marshalled_get('abc').should === @obj
+  end
+
+  it 'should marshal object on set' do
+    @store.marshalled_set('abc', @obj)
+    @store.marshalled_get('abc').should === @obj
+  end
+
+  it 'should not unmarshal object on get if raw option is true' do
+    @store.marshalled_get('abc', :raw => true).should == "\004\bU:\017OpenStruct{\006:\tname\"\tTest"
+  end
+
+  it 'should not marshal object on set if raw option is true' do
+    @store.marshalled_set('abc', @obj, :raw => true)
+    @store.marshalled_get('abc', :raw => true).should == %(#<OpenStruct name="Test">)
+  end
+
+  it 'should not unmarshal object if getting an empty string' do
+    @store.marshalled_set('empty_string', '')
+    lambda { @store.marshalled_get('empty_string').should == '' }.should_not raise_error
+  end
+
+  it 'should not set an object if it already exists' do
+    new = OpenStruct.new(:name => 'New')
+    @store.marshalled_setnx('abc', new)
+    @store.marshalled_get('abc').should === @obj
+  end
+
+  it 'should marshal object on set_unless_exists' do
+    @store.marshalled_setnx('def', @obj)
+    @store.marshalled_get('def').should === @obj
+  end
+
+  it 'should not marshal object on set_unless_exists if raw option is true' do
+    @store.marshalled_setnx('def', @obj, :raw => true)
+    @store.marshalled_get('def', :raw => true).should == "\004\bU:\017OpenStruct{\006:\tname\"\tTest"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'redis_store'
+require 'ostruct'
+
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification 
+name: redis_store_jr
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nick Plante
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-04 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id004
+description: Simple Redis Cache Store for Rails
+email: nap@zerosum.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/redis_store.rb
+- lib/redis_store/cache/redis_store.rb
+- lib/redis_store/marshalled_client.rb
+- spec/cache_spec.rb
+- spec/marshalled_client_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/zapnap/redis_store_jr
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Simple Redis Cache Store for Rails
+test_files: 
+- spec/cache_spec.rb
+- spec/marshalled_client_spec.rb
+- spec/spec_helper.rb