mock_redis 0.0.1

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'rspec'
+require 'redis'
+$LOAD_PATH.unshift(File.expand_path(File.join(__FILE__, "..", "..", "lib")))
+require 'mock_redis'
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..')))
+Dir["spec/support/**/*.rb"].each {|x| require x}
+
+module TypeCheckingHelper
+  def method_from_description
+    # extracting this from the RSpec description string may or may not
+    # be a good idea. On the one hand, it enforces the convention of
+    # putting the method name in the right place; on the other hand,
+    # it's pretty magic-looking.
+    self.example.full_description.match(/#(\w+)/).captures.first
+  end
+
+  def args_for_method(method)
+    method_arity = @redises.real.method(method).arity
+    if method_arity < 0   # -1 comes from def foo(*args)
+      [1, 2]    # probably good enough
+    else
+      1.upto(method_arity - 1).to_a
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(TypeCheckingHelper)
+
+  config.before(:all) do
+    @redises = RedisMultiplexer.new
+  end
+
+  config.before(:each) do
+    # databases mentioned in our tests
+    [1, 0].each do |db|
+      @redises.send_without_checking(:select, db)
+      @redises.send_without_checking(:keys, "mock-redis-test:*").each do |key|
+        @redises.send_without_checking(:del, key)
+      end
+    end
+  end
+end

data/spec/support/redis_multiplexer.rb

@@ -0,0 +1,91 @@
+class BlankSlate
+  instance_methods.each {|m| undef_method(m) unless m =~ /^__/ || ['inspect', 'object_id'].include?(m.to_s)}
+end
+
+class RedisMultiplexer < BlankSlate
+  MismatchedResponse = Class.new(StandardError)
+
+  def initialize(*a)
+    @mock_redis = MockRedis.new(*a)
+    @real_redis = Redis.new(*a)
+  end
+
+  def method_missing(method, *args, &blk)
+    mock_retval, mock_error = catch_errors { @mock_redis.send(method, *args, &blk) }
+    real_retval, real_error = catch_errors { @real_redis.send(method, *args, &blk) }
+
+    mock_retval = handle_special_cases(method, mock_retval)
+    real_retval = handle_special_cases(method, real_retval)
+
+    if (!equalish?(mock_retval, real_retval) && !mock_error && !real_error)
+      # no exceptions, just different behavior
+      raise MismatchedResponse,
+        "Mock failure: responses not equal.\n" +
+        "Redis.#{method}(#{args.inspect}) returned #{real_retval.inspect}\n" +
+        "MockRedis.#{method}(#{args.inspect}) returned #{mock_retval.inspect}\n"
+    elsif (!mock_error && real_error)
+      raise MismatchedResponse,
+        "Mock failure: didn't raise an error when it should have.\n" +
+        "Redis.#{method}(#{args.inspect}) raised #{real_error.inspect}\n" +
+        "MockRedis.#{method}(#{args.inspect}) raised nothing " +
+        "and returned #{mock_retval.inspect}"
+    elsif (!real_error && mock_error)
+      raise MismatchedResponse,
+        "Mock failure: raised an error when it shouldn't have.\n" +
+        "Redis.#{method}(#{args.inspect}) returned #{real_retval.inspect}\n" +
+        "MockRedis.#{method}(#{args.inspect}) raised #{mock_error.inspect}"
+    elsif (mock_error && real_error && !equalish?(mock_error, real_error))
+      raise MismatchedResponse,
+        "Mock failure: raised the wrong error.\n" +
+        "Redis.#{method}(#{args.inspect}) raised #{real_error.inspect}\n" +
+        "MockRedis.#{method}(#{args.inspect}) raised #{mock_error.inspect}"
+    end
+
+    raise mock_error if mock_error
+    mock_retval
+  end
+
+  def equalish?(a, b)
+    if a == b
+      true
+    elsif a.is_a?(Array) && b.is_a?(Array)
+      a.zip(b).all? {|(x,y)| equalish?(x,y)}
+    elsif a.is_a?(Exception) && b.is_a?(Exception)
+      a.class == b.class && a.message == b.message
+    else
+      false
+    end
+  end
+
+  def mock() @mock_redis end
+  def real() @real_redis end
+
+  # Some commands require special handling due to nondeterminism in
+  # the returned values.
+  def handle_special_cases(method, value)
+    case method.to_s
+    when 'keys', 'hkeys', 'sdiff', 'sinter', 'smembers', 'sunion'
+      # The order is irrelevant, but [a,b] != [b,a] in Ruby, so we
+      # sort the returned values so we can ignore the order.
+      value.sort if value
+    else
+      value
+    end
+  end
+
+  # Used in cleanup before() blocks.
+  def send_without_checking(method, *args)
+    @mock_redis.send(method, *args)
+    @real_redis.send(method, *args)
+  end
+
+  def catch_errors
+    begin
+      retval = yield
+      [retval, nil]
+    rescue StandardError => e
+      [nil, e]
+    end
+  end
+end
+

data/spec/support/shared_examples/only_operates_on_hashes.rb

@@ -0,0 +1,13 @@
+shared_examples_for "a hash-only command" do
+  it "raises an error for non-hash values" do
+    key = 'mock-redis-test:hash-only'
+
+    method = method_from_description
+    args = args_for_method(method).unshift(key)
+
+    @redises.set(key, 1)
+    lambda do
+      @redises.send(method, *args)
+    end.should raise_error(RuntimeError)
+  end
+end

data/spec/support/shared_examples/only_operates_on_lists.rb

@@ -0,0 +1,13 @@
+shared_examples_for "a list-only command" do
+  it "raises an error for non-list values" do
+    key = 'mock-redis-test:list-only'
+
+    method = method_from_description
+    args = args_for_method(method).unshift(key)
+
+    @redises.set(key, 1)
+    lambda do
+      @redises.send(method, *args)
+    end.should raise_error(RuntimeError)
+  end
+end

data/spec/support/shared_examples/only_operates_on_sets.rb

@@ -0,0 +1,13 @@
+shared_examples_for "a set-only command" do
+  it "raises an error for non-set values" do
+    key = 'mock-redis-test:set-only'
+
+    method = method_from_description
+    args = args_for_method(method).unshift(key)
+
+    @redises.set(key, 1)
+    lambda do
+      @redises.send(method, *args)
+    end.should raise_error(RuntimeError)
+  end
+end

data/spec/support/shared_examples/only_operates_on_strings.rb

@@ -0,0 +1,13 @@
+shared_examples_for "a string-only command" do
+  it "raises an error for non-string values" do
+    key = "mock-redis-test:string-only-command"
+
+    method = method_from_description
+    args = args_for_method(method).unshift(key)
+
+    @redises.lpush(key, 1)
+    lambda do
+      @redises.send(method, *args)
+    end.should raise_error(RuntimeError)
+  end
+end

data/spec/support/shared_examples/only_operates_on_zsets.rb

@@ -0,0 +1,57 @@
+shared_examples_for "a zset-only command" do
+  it "raises an error for non-zset values" do
+    key = 'mock-redis-test:zset-only'
+
+    method = method_from_description
+    args = args_for_method(method).unshift(key)
+
+    @redises.set(key, 1)
+    lambda do
+      @redises.send(method, *args)
+    end.should raise_error(RuntimeError)
+  end
+end
+
+shared_examples_for "arg 1 is a score" do
+  before { @_arg_index = 1 }
+  it_should_behave_like "arg N is a score"
+end
+
+shared_examples_for "arg 2 is a score" do
+  before { @_arg_index = 2 }
+  it_should_behave_like "arg N is a score"
+end
+
+shared_examples_for "arg N is a score" do
+  before do
+    key = 'mock-redis-test:zset-only'
+
+    @method = method_from_description
+    @args = args_for_method(@method).unshift(key)
+  end
+
+  it "is okay with positive ints" do
+    @args[@_arg_index] = 1
+    lambda { @redises.send(@method, *@args) }.should_not raise_error
+  end
+
+  it "is okay with negative ints" do
+    @args[@_arg_index] = -1
+    lambda { @redises.send(@method, *@args) }.should_not raise_error
+  end
+
+  it "is okay with positive floats" do
+    @args[@_arg_index] = 1.5
+    lambda { @redises.send(@method, *@args) }.should_not raise_error
+  end
+
+  it "is okay with negative floats" do
+    @args[@_arg_index] = 1.5
+    lambda { @redises.send(@method, *@args) }.should_not raise_error
+  end
+
+  it "rejects non-numbers" do
+    @args[@_arg_index] = 'foo'
+    lambda { @redises.send(@method, *@args) }.should raise_error(RuntimeError)
+  end
+end

data/spec/transactions_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe 'transactions (multi/exec/discard)' do
+  before(:each) do
+    @redises.discard rescue nil
+  end
+
+  context "#multi" do
+    it "responds with 'OK'" do
+      @redises.multi.should == 'OK'
+    end
+
+    it "forbids nesting" do
+      @redises.multi
+      lambda do
+        @redises.multi
+      end.should raise_error(RuntimeError)
+    end
+  end
+
+  context "#discard" do
+    it "responds with 'OK' after #multi" do
+      @redises.multi
+      @redises.discard.should == 'OK'
+    end
+
+    it "can't be run outside of #multi/#exec" do
+      lambda do
+        @redises.discard
+      end.should raise_error(RuntimeError)
+    end
+  end
+
+  context "#exec" do
+    it "raises an error outside of #multi" do
+      lambda do
+        @redises.exec.should raise_error
+      end
+    end
+  end
+
+  context "saving up commands for later" do
+    before(:each) do
+      @redises.multi
+      @string = 'mock-redis-test:string'
+      @list = 'mock-redis-test:list'
+    end
+
+    it "makes commands respond with 'QUEUED'" do
+      @redises.set(@string, 'string').should == 'QUEUED'
+      @redises.lpush(@list, 'list').should == 'QUEUED'
+    end
+
+    it "gives you the commands' responses when you call #exec" do
+      @redises.set(@string, 'string')
+      @redises.lpush(@list, 'list')
+      @redises.lpush(@list, 'list')
+
+      @redises.exec.should == ['OK', 1, 2]
+    end
+
+    it "does not raise exceptions, but rather puts them in #exec's response" do
+      @redises.set(@string, 'string')
+      @redises.lpush(@string, 'oops!')
+      @redises.lpush(@list, 'list')
+
+      responses = @redises.exec
+      responses[0].should == 'OK'
+      responses[1].should be_a(RuntimeError)
+      responses[2].should == 1
+    end
+  end
+end

metadata

@@ -0,0 +1,358 @@
+--- !ruby/object:Gem::Specification 
+name: mock_redis
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Samuel Merritt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 2
+        - 1
+        version: 2.2.1
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Instantiate one with `redis = MockRedis.new` and treat it like you would a normal Redis object. It supports all the usual Redis operations.
+email: 
+- spam@andcheese.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mock_redis.rb
+- lib/mock_redis/assertions.rb
+- lib/mock_redis/database.rb
+- lib/mock_redis/exceptions.rb
+- lib/mock_redis/expire_wrapper.rb
+- lib/mock_redis/hash_methods.rb
+- lib/mock_redis/list_methods.rb
+- lib/mock_redis/multi_db_wrapper.rb
+- lib/mock_redis/set_methods.rb
+- lib/mock_redis/string_methods.rb
+- lib/mock_redis/transaction_wrapper.rb
+- lib/mock_redis/undef_redis_methods.rb
+- lib/mock_redis/utility_methods.rb
+- lib/mock_redis/version.rb
+- lib/mock_redis/zset.rb
+- lib/mock_redis/zset_methods.rb
+- mock_redis.gemspec
+- spec/cloning_spec.rb
+- spec/commands/append_spec.rb
+- spec/commands/auth_spec.rb
+- spec/commands/bgrewriteaof_spec.rb
+- spec/commands/bgsave_spec.rb
+- spec/commands/blpop_spec.rb
+- spec/commands/brpop_spec.rb
+- spec/commands/brpoplpush_spec.rb
+- spec/commands/dbsize_spec.rb
+- spec/commands/decr_spec.rb
+- spec/commands/decrby_spec.rb
+- spec/commands/del_spec.rb
+- spec/commands/echo_spec.rb
+- spec/commands/exists_spec.rb
+- spec/commands/expire_spec.rb
+- spec/commands/expireat_spec.rb
+- spec/commands/flushall_spec.rb
+- spec/commands/flushdb_spec.rb
+- spec/commands/get_spec.rb
+- spec/commands/getbit_spec.rb
+- spec/commands/getrange_spec.rb
+- spec/commands/getset_spec.rb
+- spec/commands/hdel_spec.rb
+- spec/commands/hexists_spec.rb
+- spec/commands/hget_spec.rb
+- spec/commands/hgetall_spec.rb
+- spec/commands/hincrby_spec.rb
+- spec/commands/hkeys_spec.rb
+- spec/commands/hlen_spec.rb
+- spec/commands/hmget_spec.rb
+- spec/commands/hmset_spec.rb
+- spec/commands/hset_spec.rb
+- spec/commands/hsetnx_spec.rb
+- spec/commands/hvals_spec.rb
+- spec/commands/incr_spec.rb
+- spec/commands/incrby_spec.rb
+- spec/commands/info_spec.rb
+- spec/commands/keys_spec.rb
+- spec/commands/lastsave_spec.rb
+- spec/commands/lindex_spec.rb
+- spec/commands/linsert_spec.rb
+- spec/commands/llen_spec.rb
+- spec/commands/lpop_spec.rb
+- spec/commands/lpush_spec.rb
+- spec/commands/lpushx_spec.rb
+- spec/commands/lrange_spec.rb
+- spec/commands/lrem_spec.rb
+- spec/commands/lset_spec.rb
+- spec/commands/ltrim_spec.rb
+- spec/commands/mget_spec.rb
+- spec/commands/mset_spec.rb
+- spec/commands/msetnx_spec.rb
+- spec/commands/persist_spec.rb
+- spec/commands/ping_spec.rb
+- spec/commands/quit_spec.rb
+- spec/commands/randomkey_spec.rb
+- spec/commands/rename_spec.rb
+- spec/commands/renamenx_spec.rb
+- spec/commands/rpop_spec.rb
+- spec/commands/rpoplpush_spec.rb
+- spec/commands/rpush_spec.rb
+- spec/commands/rpushx_spec.rb
+- spec/commands/sadd_spec.rb
+- spec/commands/save_spec.rb
+- spec/commands/scard_spec.rb
+- spec/commands/sdiff_spec.rb
+- spec/commands/sdiffstore_spec.rb
+- spec/commands/select_spec.rb
+- spec/commands/set_spec.rb
+- spec/commands/setbit_spec.rb
+- spec/commands/setex_spec.rb
+- spec/commands/setnx_spec.rb
+- spec/commands/setrange_spec.rb
+- spec/commands/sinter_spec.rb
+- spec/commands/sinterstore_spec.rb
+- spec/commands/sismember_spec.rb
+- spec/commands/smembers_spec.rb
+- spec/commands/smove_spec.rb
+- spec/commands/spop_spec.rb
+- spec/commands/srandmember_spec.rb
+- spec/commands/srem_spec.rb
+- spec/commands/strlen_spec.rb
+- spec/commands/sunion_spec.rb
+- spec/commands/sunionstore_spec.rb
+- spec/commands/ttl_spec.rb
+- spec/commands/type_spec.rb
+- spec/commands/unwatch_spec.rb
+- spec/commands/watch_spec.rb
+- spec/commands/zadd_spec.rb
+- spec/commands/zcard_spec.rb
+- spec/commands/zcount_spec.rb
+- spec/commands/zincrby_spec.rb
+- spec/commands/zinterstore_spec.rb
+- spec/commands/zrange_spec.rb
+- spec/commands/zrangebyscore_spec.rb
+- spec/commands/zrank_spec.rb
+- spec/commands/zrem_spec.rb
+- spec/commands/zremrangebyrank_spec.rb
+- spec/commands/zremrangebyscore_spec.rb
+- spec/commands/zrevrange_spec.rb
+- spec/commands/zrevrangebyscore_spec.rb
+- spec/commands/zrevrank_spec.rb
+- spec/commands/zscore_spec.rb
+- spec/commands/zunionstore_spec.rb
+- spec/spec_helper.rb
+- spec/support/redis_multiplexer.rb
+- spec/support/shared_examples/only_operates_on_hashes.rb
+- spec/support/shared_examples/only_operates_on_lists.rb
+- spec/support/shared_examples/only_operates_on_sets.rb
+- spec/support/shared_examples/only_operates_on_strings.rb
+- spec/support/shared_examples/only_operates_on_zsets.rb
+- spec/transactions_spec.rb
+has_rdoc: true
+homepage: https://github.com/smerritt/mock_redis
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: Redis mock that just lives in memory; useful for testing.
+test_files: 
+- spec/cloning_spec.rb
+- spec/commands/append_spec.rb
+- spec/commands/auth_spec.rb
+- spec/commands/bgrewriteaof_spec.rb
+- spec/commands/bgsave_spec.rb
+- spec/commands/blpop_spec.rb
+- spec/commands/brpop_spec.rb
+- spec/commands/brpoplpush_spec.rb
+- spec/commands/dbsize_spec.rb
+- spec/commands/decr_spec.rb
+- spec/commands/decrby_spec.rb
+- spec/commands/del_spec.rb
+- spec/commands/echo_spec.rb
+- spec/commands/exists_spec.rb
+- spec/commands/expire_spec.rb
+- spec/commands/expireat_spec.rb
+- spec/commands/flushall_spec.rb
+- spec/commands/flushdb_spec.rb
+- spec/commands/get_spec.rb
+- spec/commands/getbit_spec.rb
+- spec/commands/getrange_spec.rb
+- spec/commands/getset_spec.rb
+- spec/commands/hdel_spec.rb
+- spec/commands/hexists_spec.rb
+- spec/commands/hget_spec.rb
+- spec/commands/hgetall_spec.rb
+- spec/commands/hincrby_spec.rb
+- spec/commands/hkeys_spec.rb
+- spec/commands/hlen_spec.rb
+- spec/commands/hmget_spec.rb
+- spec/commands/hmset_spec.rb
+- spec/commands/hset_spec.rb
+- spec/commands/hsetnx_spec.rb
+- spec/commands/hvals_spec.rb
+- spec/commands/incr_spec.rb
+- spec/commands/incrby_spec.rb
+- spec/commands/info_spec.rb
+- spec/commands/keys_spec.rb
+- spec/commands/lastsave_spec.rb
+- spec/commands/lindex_spec.rb
+- spec/commands/linsert_spec.rb
+- spec/commands/llen_spec.rb
+- spec/commands/lpop_spec.rb
+- spec/commands/lpush_spec.rb
+- spec/commands/lpushx_spec.rb
+- spec/commands/lrange_spec.rb
+- spec/commands/lrem_spec.rb
+- spec/commands/lset_spec.rb
+- spec/commands/ltrim_spec.rb
+- spec/commands/mget_spec.rb
+- spec/commands/mset_spec.rb
+- spec/commands/msetnx_spec.rb
+- spec/commands/persist_spec.rb
+- spec/commands/ping_spec.rb
+- spec/commands/quit_spec.rb
+- spec/commands/randomkey_spec.rb
+- spec/commands/rename_spec.rb
+- spec/commands/renamenx_spec.rb
+- spec/commands/rpop_spec.rb
+- spec/commands/rpoplpush_spec.rb
+- spec/commands/rpush_spec.rb
+- spec/commands/rpushx_spec.rb
+- spec/commands/sadd_spec.rb
+- spec/commands/save_spec.rb
+- spec/commands/scard_spec.rb
+- spec/commands/sdiff_spec.rb
+- spec/commands/sdiffstore_spec.rb
+- spec/commands/select_spec.rb
+- spec/commands/set_spec.rb
+- spec/commands/setbit_spec.rb
+- spec/commands/setex_spec.rb
+- spec/commands/setnx_spec.rb
+- spec/commands/setrange_spec.rb
+- spec/commands/sinter_spec.rb
+- spec/commands/sinterstore_spec.rb
+- spec/commands/sismember_spec.rb
+- spec/commands/smembers_spec.rb
+- spec/commands/smove_spec.rb
+- spec/commands/spop_spec.rb
+- spec/commands/srandmember_spec.rb
+- spec/commands/srem_spec.rb
+- spec/commands/strlen_spec.rb
+- spec/commands/sunion_spec.rb
+- spec/commands/sunionstore_spec.rb
+- spec/commands/ttl_spec.rb
+- spec/commands/type_spec.rb
+- spec/commands/unwatch_spec.rb
+- spec/commands/watch_spec.rb
+- spec/commands/zadd_spec.rb
+- spec/commands/zcard_spec.rb
+- spec/commands/zcount_spec.rb
+- spec/commands/zincrby_spec.rb
+- spec/commands/zinterstore_spec.rb
+- spec/commands/zrange_spec.rb
+- spec/commands/zrangebyscore_spec.rb
+- spec/commands/zrank_spec.rb
+- spec/commands/zrem_spec.rb
+- spec/commands/zremrangebyrank_spec.rb
+- spec/commands/zremrangebyscore_spec.rb
+- spec/commands/zrevrange_spec.rb
+- spec/commands/zrevrangebyscore_spec.rb
+- spec/commands/zrevrank_spec.rb
+- spec/commands/zscore_spec.rb
+- spec/commands/zunionstore_spec.rb
+- spec/spec_helper.rb
+- spec/support/redis_multiplexer.rb
+- spec/support/shared_examples/only_operates_on_hashes.rb
+- spec/support/shared_examples/only_operates_on_lists.rb
+- spec/support/shared_examples/only_operates_on_sets.rb
+- spec/support/shared_examples/only_operates_on_strings.rb
+- spec/support/shared_examples/only_operates_on_zsets.rb
+- spec/transactions_spec.rb