mock_redis 0.19.0 → 0.20.0

data/lib/mock_redis/stream_methods.rb

@@ -0,0 +1,87 @@
+require 'mock_redis/assertions'
+require 'mock_redis/utility_methods'
+require 'mock_redis/stream'
+
+# TODO: Implement the following commands
+#
+#   * xread
+#   * xgroup
+#   * xreadgroup
+#   * xack
+#   * xpending
+#   * xclaim
+#   * xinfo
+#   * xtrim
+#   * xdel
+#
+# TODO: Complete support for
+#
+#   * xtrim
+#       - `approximate: true` argument is currently ignored
+#   * xadd
+#       - `approximate: true` argument (for capped streams) is currently ignored
+#
+# For details of these commands see
+#   * https://redis.io/topics/streams-intro
+#   * https://redis.io/commands#stream
+
+class MockRedis
+  module StreamMethods
+    include Assertions
+    include UtilityMethods
+
+    def xadd(key, entry, opts = {})
+      id = opts[:id] || '*'
+      with_stream_at(key) do |stream|
+        stream.add id, entry
+        stream.trim opts[:maxlen] if opts[:maxlen]
+        return stream.last_id
+      end
+    end
+
+    def xtrim(key, count)
+      with_stream_at(key) do |stream|
+        stream.trim count
+      end
+    end
+
+    def xlen(key)
+      with_stream_at(key) do |stream|
+        return stream.count
+      end
+    end
+
+    def xrange(key, first = '-', last = '+', count: nil)
+      args = [first, last, false]
+      args += ['COUNT', count] if count
+      with_stream_at(key) do |stream|
+        return stream.range(*args)
+      end
+    end
+
+    def xrevrange(key, last = '+', first = '-', count: nil)
+      args = [first, last, true]
+      args += ['COUNT', count] if count
+      with_stream_at(key) do |stream|
+        return stream.range(*args)
+      end
+    end
+
+    private
+
+    def with_stream_at(key, &blk)
+      with_thing_at(key, :assert_streamy, proc { Stream.new }, &blk)
+    end
+
+    def streamy?(key)
+      data[key].nil? || data[key].is_a?(Stream)
+    end
+
+    def assert_streamy(key)
+      unless streamy?(key)
+        raise Redis::CommandError,
+          'WRONGTYPE Operation against a key holding the wrong kind of value'
+      end
+    end
+  end
+end

data/lib/mock_redis/string_methods.rb

@@ -85,14 +85,11 @@ class MockRedis
     end
 
     def get(key)
+      key = key.to_s
       assert_stringy(key)
       data[key]
     end
 
-    def [](key)
-      get(key)
-    end
-
     def getbit(key, offset)
       assert_stringy(key)
 
@@ -159,6 +156,7 @@ class MockRedis
     def mget(*keys)
       assert_has_args(keys, 'mget')
 
+      keys.flatten!
       keys.map do |key|
         get(key) if stringy?(key)
       end
@@ -170,6 +168,8 @@ class MockRedis
 
     def mset(*kvpairs)
       assert_has_args(kvpairs, 'mset')
+      kvpairs = kvpairs.first if kvpairs.size == 1 && kvpairs.first.is_a?(Enumerable)
+
       if kvpairs.length.odd?
         raise Redis::CommandError, 'ERR wrong number of arguments for MSET'
       end
@@ -201,6 +201,7 @@ class MockRedis
     end
 
     def set(key, value, options = {})
+      key = key.to_s
       return_true = false
       options = options.dup
       if options.delete(:nx)
@@ -231,10 +232,6 @@ class MockRedis
       return_true ? true : 'OK'
     end
 
-    def []=(key, value, options = {})
-      set(key, value, options)
-    end
-
     def setbit(key, offset, value)
       assert_stringy(key, 'ERR bit is not an integer or out of range')
       retval = getbit(key, offset)

data/lib/mock_redis/transaction_wrapper.rb

@@ -11,12 +11,12 @@ class MockRedis
     def initialize(db)
       @db = db
       @transaction_futures = []
-      @in_multi = false
+      @multi_stack = []
       @multi_block_given = false
     end
 
     def method_missing(method, *args, &block)
-      if @in_multi
+      if in_multi?
         future = MockRedis::Future.new([method, *args])
         @transaction_futures << future
 
@@ -35,23 +35,25 @@ class MockRedis
       super
       @db = @db.clone
       @transaction_futures = @transaction_futures.clone
+      @multi_stack = @multi_stack.clone
     end
 
     def discard
-      unless @in_multi
+      unless in_multi?
         raise Redis::CommandError, 'ERR DISCARD without MULTI'
       end
-      @in_multi = false
-      @multi_block_given = false
+      pop_multi
+
       @transaction_futures = []
       'OK'
     end
 
     def exec
-      unless @in_multi
+      unless in_multi?
         raise Redis::CommandError, 'ERR EXEC without MULTI'
       end
-      @in_multi = false
+      pop_multi
+      return if in_multi?
       @multi_block_given = false
 
       responses = @transaction_futures.map do |future|
@@ -68,12 +70,21 @@ class MockRedis
       responses
     end
 
+    def in_multi?
+      @multi_stack.any?
+    end
+
+    def push_multi
+      @multi_stack.push(@multi_stack.size + 1)
+    end
+
+    def pop_multi
+      @multi_stack.pop
+    end
+
     def multi
-      if @in_multi
-        raise Redis::CommandError, 'ERR MULTI calls can not be nested'
-      end
-      @in_multi = true
       if block_given?
+        push_multi
         @multi_block_given = true
         begin
           yield(self)
@@ -83,6 +94,8 @@ class MockRedis
           raise e
         end
       else
+        raise Redis::CommandError, 'ERR MULTI calls can not be nested' if in_multi?
+        push_multi
         'OK'
       end
     end
@@ -95,7 +108,7 @@ class MockRedis
       'OK'
     end
 
-    def watch(_)
+    def watch(*_)
       if block_given?
         yield self
       else

data/lib/mock_redis/utility_methods.rb

@@ -18,7 +18,7 @@ class MockRedis
     end
 
     def clean_up_empties_at(key)
-      if data[key] && data[key].empty?
+      if data[key]&.empty? && data[key] != ''
         del(key)
       end
     end

data/lib/mock_redis/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 class MockRedis
-  VERSION = '0.19.0'.freeze
+  VERSION = '0.20.0'
 end

data/lib/mock_redis/zset_methods.rb

@@ -11,7 +11,7 @@ class MockRedis
       zadd_options = {}
       zadd_options = args.pop if args.last.is_a?(Hash)
 
-      if zadd_options && zadd_options.include?(:nx) && zadd_options.include?(:xx)
+      if zadd_options&.include?(:nx) && zadd_options&.include?(:xx)
         raise Redis::CommandError, 'ERR XX and NX options at the same time are not compatible'
       end
 
@@ -211,7 +211,7 @@ class MockRedis
     def zscore(key, member)
       with_zset_at(key) do |z|
         score = z.score(member.to_s)
-        score.to_f if score
+        score&.to_f
       end
     end
 

data/mock_redis.gemspec

@@ -6,9 +6,9 @@ Gem::Specification.new do |s|
   s.version     = MockRedis::VERSION
   s.license     = 'MIT'
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Brigade Engineering', 'Samuel Merritt']
-  s.email       = ['eng@brigade.com']
-  s.homepage    = 'https://github.com/brigade/mock_redis'
+  s.authors     = ['Shane da Silva', 'Samuel Merritt']
+  s.email       = ['shane@dasilva.io']
+  s.homepage    = 'https://github.com/sds/mock_redis'
   s.summary     = 'Redis mock that just lives in memory; useful for testing.'
 
   s.description = <<-MSG.strip.gsub(/\s+/, ' ')
@@ -21,10 +21,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 2.2'
+  s.required_ruby_version = '>= 2.4'
 
   s.add_development_dependency 'rake', '>= 10', '< 12'
-  s.add_development_dependency 'redis', '~> 3.3.0'
+  s.add_development_dependency 'redis', '~>4.1.0'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its', '~> 1.0'
+  s.add_development_dependency 'timecop', '~> 0.9.1'
 end

data/spec/commands/geodist_spec.rb

@@ -80,13 +80,14 @@ describe '#geodist' do
 
     context 'with less than 3 arguments' do
       [1, 2].each do |count|
-        let(:message) { "ERR wrong number of arguments for 'geodist' command" }
-
         context "with #{count} arguments" do
           it 'raises an error' do
             args = list.slice(0, count)
             expect { @redises.geodist(*args) }
-              .to raise_error(Redis::CommandError, message)
+              .to raise_error(
+                ArgumentError,
+                /wrong number of arguments \((given\s)?#{count}(,\sexpected\s|\sfor\s)3?\.\.4\)$/
+              )
           end
         end
       end
@@ -98,7 +99,10 @@ describe '#geodist' do
       it 'raises an error' do
         args = list.slice(0, 5)
         expect { @redises.geodist(*args) }
-          .to raise_error(Redis::CommandError, message)
+          .to raise_error(
+            ArgumentError,
+            /wrong number of arguments \((given\s)?5(,\sexpected\s|\sfor\s)3?\.\.4\)$/
+          )
       end
     end
   end

data/spec/commands/geohash_spec.rb

@@ -17,13 +17,13 @@ describe '#geohash' do
       end
 
       it 'returns decoded coordinates pairs for each point' do
-        results = @redises.geohash(key, 'SF', 'LA')
+        results = @redises.geohash(key, %w[SF LA])
         expect(results).to be == expected_result
       end
 
       context 'with non-existing points only' do
         it 'returns array filled with nils' do
-          results = @redises.geohash(key, 'FF', 'FA')
+          results = @redises.geohash(key, %w[FF FA])
           expect(results).to be == [nil, nil]
         end
       end
@@ -34,7 +34,7 @@ describe '#geohash' do
         end
 
         it 'returns mixture of nil and coordinates pair' do
-          results = @redises.geohash(key, 'SF', 'FA')
+          results = @redises.geohash(key, %w[SF FA])
           expect(results).to be == expected_result
         end
       end
@@ -45,7 +45,7 @@ describe '#geohash' do
     before { @redises.del(key) }
 
     it 'returns empty array' do
-      results = @redises.geohash(key, 'SF', 'LA')
+      results = @redises.geohash(key, %w[SF LA])
       expect(results).to be == [nil, nil]
     end
   end

data/spec/commands/geopos_spec.rb

@@ -20,13 +20,13 @@ describe '#geopos' do
       end
 
       it 'returns decoded coordinates pairs for each point' do
-        coords = @redises.geopos(key, 'SF', 'LA')
+        coords = @redises.geopos(key, %w[SF LA])
         expect(coords).to be == expected_result
       end
 
       context 'with non-existing points only' do
         it 'returns array filled with nils' do
-          coords = @redises.geopos(key, 'FF', 'FA')
+          coords = @redises.geopos(key, %w[FF FA])
           expect(coords).to be == [nil, nil]
         end
       end
@@ -37,7 +37,7 @@ describe '#geopos' do
         end
 
         it 'returns mixture of nil and coordinates pair' do
-          coords = @redises.geopos(key, 'SF', 'FA')
+          coords = @redises.geopos(key, %w[SF FA])
           expect(coords).to be == expected_result
         end
       end
@@ -48,7 +48,7 @@ describe '#geopos' do
     before { @redises.del(key) }
 
     it 'returns empty array' do
-      coords = @redises.geopos(key, 'SF', 'LA')
+      coords = @redises.geopos(key, %w[SF LA])
       expect(coords).to be == [nil, nil]
     end
   end

data/spec/commands/get_spec.rb

@@ -24,6 +24,7 @@ describe '#get(key)' do
 
     @redises.set(key, 'hello')
     @redises.get(key.to_s).should == 'hello'
+    @redises.get(key).should == 'hello'
   end
 
   it_should_behave_like 'a string-only command'

data/spec/commands/hdel_spec.rb

@@ -39,14 +39,14 @@ describe '#hdel(key, field)' do
   end
 
   it 'supports a variable number of arguments' do
-    @redises.hdel(@key, %w[k1 k2])
+    @redises.hdel(@key, 'k1', 'k2')
     @redises.get(@key).should be_nil
   end
 
   it 'treats variable arguments as strings' do
     field = 2
     @redises.hset(@key, field, 'two')
-    @redises.hdel(@key, [field])
+    @redises.hdel(@key, field)
     @redises.hget(@key, field).should be_nil
   end
 

data/spec/commands/mget_spec.rb

@@ -9,26 +9,45 @@ describe '#mget(key [, key, ...])' do
     @redises.set(@key2, 2)
   end
 
-  it 'returns an array of values' do
-    @redises.mget(@key1, @key2).should == %w[1 2]
-  end
+  context 'emulate param array' do
+    it 'returns an array of values' do
+      @redises.mget([@key1, @key2]).should == %w[1 2]
+    end
 
-  it 'returns nil for missing keys' do
-    @redises.mget(@key1, 'mock-redis-test:not-found', @key2).
-      should == ['1', nil, '2']
-  end
+    it 'returns an array of values' do
+      @redises.mget([@key1, @key2]).should == %w[1 2]
+    end
 
-  it 'returns nil for non-string keys' do
-    list = 'mock-redis-test:mget-list'
+    it 'returns nil for non-string keys' do
+      list = 'mock-redis-test:mget-list'
 
-    @redises.lpush(list, 'bork bork bork')
+      @redises.lpush(list, 'bork bork bork')
 
-    @redises.mget(@key1, @key2, list).should == ['1', '2', nil]
+      @redises.mget([@key1, @key2, list]).should == ['1', '2', nil]
+    end
   end
 
-  it 'raises an error if you pass it 0 arguments' do
-    lambda do
-      @redises.mget
-    end.should raise_error(Redis::CommandError)
+  context 'emulate params strings' do
+    it 'returns an array of values' do
+      @redises.mget(@key1, @key2).should == %w[1 2]
+    end
+
+    it 'returns nil for missing keys' do
+      @redises.mget(@key1, 'mock-redis-test:not-found', @key2).should == ['1', nil, '2']
+    end
+
+    it 'returns nil for non-string keys' do
+      list = 'mock-redis-test:mget-list'
+
+      @redises.lpush(list, 'bork bork bork')
+
+      @redises.mget(@key1, @key2, list).should == ['1', '2', nil]
+    end
+
+    it 'raises an error if you pass it 0 arguments' do
+      lambda do
+        @redises.mget
+      end.should raise_error(Redis::CommandError)
+    end
   end
 end