redis-store 1.0.0.1 → 1.1.0.rc

data/test/redis/factory_test.rb

@@ -0,0 +1,98 @@
+require 'test_helper'
+
+describe "Redis::Factory" do
+  describe ".create" do
+    describe "when not given any arguments" do
+      it "instantiates Redis::Store" do
+        store = Redis::Factory.create
+        store.must_be_kind_of(Redis::Store)
+        store.to_s.must_equal("Redis Client connected to 127.0.0.1:6379 against DB 0")
+      end
+    end
+
+    describe "when given a Hash" do
+      it "uses specified host" do
+        store = Redis::Factory.create :host => "localhost"
+        store.to_s.must_equal("Redis Client connected to localhost:6379 against DB 0")
+      end
+
+      it "uses specified port" do
+        store = Redis::Factory.create :host => "localhost", :port => 6380
+        store.to_s.must_equal("Redis Client connected to localhost:6380 against DB 0")
+      end
+
+      it "uses specified db" do
+        store = Redis::Factory.create :host => "localhost", :port => 6380, :db => 13
+        store.to_s.must_equal("Redis Client connected to localhost:6380 against DB 13")
+      end
+
+      it "uses specified namespace" do
+        store = Redis::Factory.create :namespace => "theplaylist"
+        store.to_s.must_equal("Redis Client connected to 127.0.0.1:6379 against DB 0 with namespace theplaylist")
+      end
+
+      it "uses specified key_prefix as namespace" do
+        store = Redis::Factory.create :key_prefix => "theplaylist"
+        store.to_s.must_equal("Redis Client connected to 127.0.0.1:6379 against DB 0 with namespace theplaylist")
+      end
+
+      it "uses specified password" do
+        store = Redis::Factory.create :password => "secret"
+        store.instance_variable_get(:@client).password.must_equal("secret")
+      end
+
+      it "allows/disable marshalling" do
+        store = Redis::Factory.create :marshalling => false
+        store.instance_variable_get(:@marshalling).must_equal(false)
+      end
+
+      it "should instantiate a Redis::DistributedStore store" do
+        store = Redis::Factory.create(
+          {:host => "localhost", :port => 6379},
+          {:host => "localhost", :port => 6380}
+        )
+        store.must_be_kind_of(Redis::DistributedStore)
+        store.nodes.map {|node| node.to_s }.must_equal([
+          "Redis Client connected to localhost:6379 against DB 0",
+          "Redis Client connected to localhost:6380 against DB 0",
+        ])
+      end
+    end
+
+    describe "when given a String" do
+      it "uses specified host" do
+        store = Redis::Factory.create "redis://127.0.0.1"
+        store.to_s.must_equal("Redis Client connected to 127.0.0.1:6379 against DB 0")
+      end
+
+      it "uses specified port" do
+        store = Redis::Factory.create "redis://127.0.0.1:6380"
+        store.to_s.must_equal("Redis Client connected to 127.0.0.1:6380 against DB 0")
+      end
+
+      it "uses specified db" do
+        store = Redis::Factory.create "redis://127.0.0.1:6380/13"
+        store.to_s.must_equal("Redis Client connected to 127.0.0.1:6380 against DB 13")
+      end
+
+      it "uses specified namespace" do
+        store = Redis::Factory.create "redis://127.0.0.1:6379/0/theplaylist"
+        store.to_s.must_equal("Redis Client connected to 127.0.0.1:6379 against DB 0 with namespace theplaylist")
+      end
+
+      it "uses specified password" do
+        store = Redis::Factory.create "redis://:secret@127.0.0.1:6379/0/theplaylist"
+        store.instance_variable_get(:@client).password.must_equal("secret")
+      end
+
+      it "instantiates Redis::DistributedStore" do
+        store = Redis::Factory.create "redis://127.0.0.1:6379", "redis://127.0.0.1:6380"
+        store.must_be_kind_of(Redis::DistributedStore)
+        store.nodes.map {|node| node.to_s }.must_equal([
+          "Redis Client connected to 127.0.0.1:6379 against DB 0",
+          "Redis Client connected to 127.0.0.1:6380 against DB 0",
+        ])
+      end
+    end
+  end
+end

data/test/redis/store/interface_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class InterfacedRedis < Redis
+  include Redis::Store::Interface
+end
+
+describe Redis::Store::Interface do
+  before do
+    @r = InterfacedRedis.new
+  end
+
+  it "should get an element" do
+    lambda { @r.get("key", :option => true) } #.wont_raise ArgumentError
+  end
+
+  it "should set an element" do
+    lambda { @r.set("key", "value", :option => true) } #.wont_raise ArgumentError
+  end
+
+  it "should setnx an element" do
+    lambda { @r.setnx("key", "value", :option => true) } #.wont_raise ArgumentError
+  end
+
+  it "should setex an element" do
+    lambda { @r.setex("key", 1, "value", :option => true) } #.wont_raise ArgumentError
+  end
+end

data/test/redis/store/marshalling_test.rb

@@ -0,0 +1,127 @@
+require 'test_helper'
+
+describe "Redis::Marshalling" do
+  def setup
+    @store = Redis::Store.new :marshalling => true
+    @rabbit = OpenStruct.new :name => "bunny"
+    @white_rabbit = OpenStruct.new :color => "white"
+    @store.set "rabbit", @rabbit
+    @store.del "rabbit2"
+  end
+
+  def teardown
+    @store.quit
+  end
+
+  it "unmarshals on get" do
+    @store.get("rabbit").must_equal(@rabbit)
+  end
+
+  it "marshals on set" do
+    @store.set "rabbit", @white_rabbit
+    @store.get("rabbit").must_equal(@white_rabbit)
+  end
+
+  if RUBY_VERSION.match /1\.9/
+    it "doesn't unmarshal on get if raw option is true" do
+      @store.get("rabbit", :raw => true).must_equal("\x04\bU:\x0FOpenStruct{\x06:\tnameI\"\nbunny\x06:\x06EF")
+    end
+  else
+    it "doesn't unmarshal on get if raw option is true" do
+      @store.get("rabbit", :raw => true).must_equal("\004\bU:\017OpenStruct{\006:\tname\"\nbunny")
+    end
+  end
+
+  it "doesn't marshal set if raw option is true" do
+    @store.set "rabbit", @white_rabbit, :raw => true
+    @store.get("rabbit", :raw => true).must_equal(%(#<OpenStruct color="white">))
+  end
+
+  it "doesn't unmarshal if get returns an empty string" do
+    @store.set "empty_string", ""
+    @store.get("empty_string").must_equal("")
+    # TODO use a meaningful Exception
+    # lambda { @store.get("empty_string").must_equal("") }.wont_raise Exception
+  end
+
+  it "doesn't set an object if already exist" do
+    @store.setnx "rabbit", @white_rabbit
+    @store.get("rabbit").must_equal(@rabbit)
+  end
+
+  it "marshals on set unless exists" do
+    @store.setnx "rabbit2", @white_rabbit
+    @store.get("rabbit2").must_equal(@white_rabbit)
+  end
+
+  it "doesn't marshal on set unless exists if raw option is true" do
+    @store.setnx "rabbit2", @white_rabbit, :raw => true
+    @store.get("rabbit2", :raw => true).must_equal(%(#<OpenStruct color="white">))
+  end
+
+  it "marshals on set expire" do
+    @store.setex "rabbit2", 1, @white_rabbit
+    @store.get("rabbit2").must_equal(@white_rabbit)
+    sleep 2
+    @store.get("rabbit2").must_be_nil
+  end
+
+  it "doesn't unmarshal on multi get" do
+    @store.set "rabbit2", @white_rabbit
+    rabbit, rabbit2 = @store.mget "rabbit", "rabbit2"
+    rabbit.must_equal(@rabbit)
+    rabbit2.must_equal(@white_rabbit)
+  end
+
+  if RUBY_VERSION.match /1\.9/
+    it "doesn't unmarshal on multi get if raw option is true" do
+      @store.set "rabbit2", @white_rabbit
+      rabbit, rabbit2 = @store.mget "rabbit", "rabbit2", :raw => true
+      rabbit.must_equal("\x04\bU:\x0FOpenStruct{\x06:\tnameI\"\nbunny\x06:\x06EF")
+      rabbit2.must_equal("\x04\bU:\x0FOpenStruct{\x06:\ncolorI\"\nwhite\x06:\x06EF")
+    end
+  else
+    it "doesn't unmarshal on multi get if raw option is true" do
+      @store.set "rabbit2", @white_rabbit
+      rabbit, rabbit2 = @store.mget "rabbit", "rabbit2", :raw => true
+      rabbit.must_equal("\004\bU:\017OpenStruct{\006:\tname\"\nbunny")
+      rabbit2.must_equal("\004\bU:\017OpenStruct{\006:\ncolor\"\nwhite")
+    end
+  end
+
+  describe "binary safety" do
+    it "marshals objects" do
+      utf8_key = [51339].pack("U*")
+      ascii_rabbit = OpenStruct.new(:name => [128].pack("C*"))
+
+      @store.set(utf8_key, ascii_rabbit)
+      @store.get(utf8_key).must_equal(ascii_rabbit)
+    end
+
+    it "gets and sets raw values" do
+      utf8_key = [51339].pack("U*")
+      ascii_string = [128].pack("C*")
+
+      @store.set(utf8_key, ascii_string, :raw => true)
+      @store.get(utf8_key, :raw => true).bytes.to_a.must_equal(ascii_string.bytes.to_a)
+    end
+
+    it "marshals objects on setnx" do
+      utf8_key = [51339].pack("U*")
+      ascii_rabbit = OpenStruct.new(:name => [128].pack("C*"))
+
+      @store.del(utf8_key)
+      @store.setnx(utf8_key, ascii_rabbit)
+      @store.get(utf8_key).must_equal(ascii_rabbit)
+    end
+
+    it "gets and sets raw values on setnx" do
+      utf8_key = [51339].pack("U*")
+      ascii_string = [128].pack("C*")
+
+      @store.del(utf8_key)
+      @store.setnx(utf8_key, ascii_string, :raw => true)
+      @store.get(utf8_key, :raw => true).bytes.to_a.must_equal(ascii_string.bytes.to_a)
+    end
+  end if defined?(Encoding)
+end

data/test/redis/store/namespace_test.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+
+describe "Redis::Store::Namespace" do
+  def setup
+    @namespace = "theplaylist"
+    @store  = Redis::Store.new :namespace => @namespace, :marshalling => false # TODO remove mashalling option
+    @client = @store.instance_variable_get(:@client)
+    @rabbit = "bunny"
+  end
+
+  def teardown
+    @store.quit
+  end
+
+  it "only decorates instances that need to be namespaced" do
+    store  = Redis::Store.new
+    client = store.instance_variable_get(:@client)
+    client.expects(:call).with([:get, "rabbit"])
+    store.get("rabbit")
+  end
+
+  it "doesn't namespace a key which is already namespaced" do
+    @store.send(:interpolate, "#{@namespace}:rabbit").must_equal("#{@namespace}:rabbit")
+  end
+
+  it "namespaces get"
+  it "namespaces set"
+  it "namespaces setnx"
+  it "namespaces del with single key"
+  it "namespaces del with multiple keys"
+  it "namespaces keys"
+  it "namespaces exists"
+  it "namespaces incrby"
+  it "namespaces decrby"
+  it "namespaces mget"
+
+  # it "should namespace get" do
+  #   @client.expects(:call).with([:get, "#{@namespace}:rabbit"]).once
+  #   @store.get("rabbit")
+  # end
+  #
+  # it "should namespace set" do
+  #   @client.should_receive(:call).with([:set, "#{@namespace}:rabbit", @rabbit])
+  #   @store.set "rabbit", @rabbit
+  # end
+  #
+  # it "should namespace setnx" do
+  #   @client.should_receive(:call).with([:setnx, "#{@namespace}:rabbit", @rabbit])
+  #   @store.setnx "rabbit", @rabbit
+  # end
+  #
+  # it "should namespace del with single key" do
+  #   @client.should_receive(:call).with([:del, "#{@namespace}:rabbit"])
+  #   @store.del "rabbit"
+  # end
+  #
+  # it "should namespace del with multiple keys" do
+  #   @client.should_receive(:call).with([:del, "#{@namespace}:rabbit", "#{@namespace}:white_rabbit"])
+  #   @store.del "rabbit", "white_rabbit"
+  # end
+  #
+  # it "should namespace keys" do
+  #   @store.set "rabbit", @rabbit
+  #   @store.keys("rabb*").should == [ "rabbit" ]
+  # end
+  #
+  # it "should namespace exists" do
+  #   @client.should_receive(:call).with([:exists, "#{@namespace}:rabbit"])
+  #   @store.exists "rabbit"
+  # end
+  #
+  # it "should namespace incrby" do
+  #   @client.should_receive(:call).with([:incrby, "#{@namespace}:counter", 1])
+  #   @store.incrby "counter", 1
+  # end
+  #
+  # it "should namespace decrby" do
+  #   @client.should_receive(:call).with([:decrby, "#{@namespace}:counter", 1])
+  #   @store.decrby "counter", 1
+  # end
+  #
+  # it "should namespace mget" do
+  #   @client.should_receive(:call).with([:mget, "#{@namespace}:rabbit", "#{@namespace}:white_rabbit"])
+  #   @store.mget "rabbit", "white_rabbit"
+  # end
+end

data/test/redis/store/version_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+describe Redis::Store::VERSION do
+  it "must be equal to 1.1.0.rc" do
+    Redis::Store::VERSION.must_equal '1.1.0.rc'
+  end
+end

data/test/redis/store_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+describe Redis::Store do
+  before do
+    @store  = Redis::Store.new
+    @client = @store.instance_variable_get(:@client)
+  end
+
+  it "returns useful informations about the server" do
+    @store.to_s.must_equal("Redis Client connected to #{@client.host}:#{@client.port} against DB #{@client.db}")
+  end
+
+  it "must force reconnection" do
+    @client.expects(:reconnect)
+    @store.reconnect
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,22 @@
+Bundler.setup
+gem 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha'
+require 'redis'
+require 'redis-store'
+
+$DEBUG = ENV["DEBUG"] === "true"
+
+Redis::DistributedStore.send(:class_variable_set, :@@timeout, 30)
+
+# http://mentalized.net/journal/2010/04/02/suppress_warnings_from_ruby/
+module Kernel
+  def suppress_warnings
+    original_verbosity = $VERBOSE
+    $VERBOSE = nil
+    result = yield
+    $VERBOSE = original_verbosity
+    return result
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: redis-store
 version: !ruby/object:Gem::Version 
-  hash: 93
-  prerelease: 
+  hash: 7712002
+  prerelease: 6
   segments: 
   - 1
-  - 0
-  - 0
   - 1
-  version: 1.0.0.1
+  - 0
+  - rc
+  version: 1.1.0.rc
 platform: ruby
 authors: 
 - Luca Guidi
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-06 00:00:00 Z
+date: 2011-12-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: redis
@@ -26,141 +26,125 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 7
         segments: 
         - 2
         - 2
-        - 1
-        version: 2.2.1
+        - 0
+        version: 2.2.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: rake
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 11
         segments: 
         - 0
-        version: "0"
+        - 9
+        - 2
+        - 2
+        version: 0.9.2.2
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: git
+  name: bundler
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 7712070
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 1
+        - rc
+        version: 1.1.rc
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rack-cache
+  name: mocha
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 55
         segments: 
         - 0
-        version: "0"
+        - 10
+        - 0
+        version: 0.10.0
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: merb
+  name: minitest
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 47
         segments: 
-        - 1
-        - 1
+        - 2
+        - 8
         - 0
-        version: 1.1.0
+        version: 2.8.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: purdytest
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 23
         segments: 
         - 1
-        - 3
         - 0
-        version: 1.3.0
+        - 0
+        version: 1.0.0
   type: :development
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: i18n
+  name: git
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 21
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
   type: :development
   version_requirements: *id007
-- !ruby/object:Gem::Dependency 
-  name: ruby-debug
-  prerelease: false
-  requirement: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id008
 description: Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks.
-email: guidi.luca@gmail.com
+email: 
+- guidi.luca@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.md
+extra_rdoc_files: []
+
 files: 
-- .travis.yml
-- CHANGELOG
 - Gemfile
 - MIT-LICENSE
 - README.md
 - Rakefile
-- VERSION
-- lib/action_controller/session/redis_session_store.rb
-- lib/active_support/cache/redis_store.rb
-- lib/cache/merb/redis_store.rb
-- lib/cache/sinatra/redis_store.rb
-- lib/i18n/backend/redis.rb
-- lib/rack/cache/redis_entitystore.rb
-- lib/rack/cache/redis_metastore.rb
-- lib/rack/session/merb.rb
-- lib/rack/session/redis.rb
 - lib/redis-store.rb
 - lib/redis/distributed_store.rb
 - lib/redis/factory.rb
@@ -170,29 +154,20 @@ files:
 - lib/redis/store/namespace.rb
 - lib/redis/store/ttl.rb
 - lib/redis/store/version.rb
+- lib/tasks/redis.tasks.rb
 - redis-store.gemspec
-- spec/action_controller/session/redis_session_store_spec.rb
-- spec/active_support/cache/redis_store_spec.rb
-- spec/cache/merb/redis_store_spec.rb
-- spec/cache/sinatra/redis_store_spec.rb
-- spec/config/node-one.conf
-- spec/config/node-two.conf
-- spec/config/redis.conf
-- spec/i18n/backend/redis_spec.rb
-- spec/rack/cache/entitystore/pony.jpg
-- spec/rack/cache/entitystore/redis_spec.rb
-- spec/rack/cache/metastore/redis_spec.rb
-- spec/rack/session/redis_spec.rb
-- spec/redis/distributed_store_spec.rb
-- spec/redis/factory_spec.rb
-- spec/redis/store/interface_spec.rb
-- spec/redis/store/marshalling_spec.rb
-- spec/redis/store/namespace_spec.rb
-- spec/redis/store/version_spec.rb
-- spec/redis/store_spec.rb
-- spec/spec_helper.rb
-- tasks/redis.tasks.rb
-homepage: http://github.com/jodosha/redis-store
+- test/config/node-one.conf
+- test/config/node-two.conf
+- test/config/redis.conf
+- test/redis/distributed_store_test.rb
+- test/redis/factory_test.rb
+- test/redis/store/interface_test.rb
+- test/redis/store/marshalling_test.rb
+- test/redis/store/namespace_test.rb
+- test/redis/store/version_test.rb
+- test/redis/store_test.rb
+- test/test_helper.rb
+homepage: ""
 licenses: []
 
 post_install_message: 
@@ -212,18 +187,31 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: redis-store
 rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Namespaced Rack::Session, Rack::Cache, I18n and cache Redis stores for Ruby web frameworks.
-test_files: []
-
+summary: Redis stores for Ruby frameworks
+test_files: 
+- test/config/node-one.conf
+- test/config/node-two.conf
+- test/config/redis.conf
+- test/redis/distributed_store_test.rb
+- test/redis/factory_test.rb
+- test/redis/store/interface_test.rb
+- test/redis/store/marshalling_test.rb
+- test/redis/store/namespace_test.rb
+- test/redis/store/version_test.rb
+- test/redis/store_test.rb
+- test/test_helper.rb
+has_rdoc: