mock_redis 0.27.1 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbd4308bd9413896742121468e39d64096e55b7760453a4220696aaa0554e38e
-  data.tar.gz: 0f8e0c66ac4533044ad91ee89a383bba1297cc186fdf514c66923a6188024b0c
+  metadata.gz: a2607bfdcb34be30d5f98395241f578ca9980f73b1d2f1ac37fa3a1baa736ba1
+  data.tar.gz: 7b4c15ece6a897bfa29c86512f9364b73b03eed78dc4764e4c542a056ec5c472
 SHA512:
-  metadata.gz: 6fde8339234a0e1c8022cd63208e8e279cc834ff4280c6690d85a516259f7c29ac36fd3882a433a94af4e4e0bb584a7c332c823cc54db59556b17e7bf42d2f97
-  data.tar.gz: 4f7d508739c4eef78afa8e155d2ec4166f5b5b644f37f846a59f9b555c34bb948d545fca55c3d2c7dae2781fe90c24c7fabb804b3406f97030e8ee4e68eff9f4
+  metadata.gz: 28d6b6302b703e48245d3bb0e2511d446c5a58bd3620eabbfa806f1c58835b48ac4f2082961a8e1110fca1b1246cc1b9c06cb590d8e8eb53facb2716e98fec9f
+  data.tar.gz: 2d749de988854e1bb5ff64e38f596d1f0efa508e2e78ab90980f86d217e791be617851bc0aaa8593a0497c233258256544e95fe86bc50ff784140a6a63b83e9b

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # MockRedis Changelog
 
+### 0.29.0
+
+* Add support for `logger` option ([#211](https://github.com/sds/mock_redis/pull/211))
+* Fix `zadd` to not perform conditional type conversion ([#214](https://github.com/sds/mock_redis/pull/214))
+* Fix `hdel` to raise error when called with empty array ([#215](https://github.com/sds/mock_redis/pull/215))
+
+### 0.28.0
+
+* Fix `hmset` exception ([#206](https://github.com/sds/mock_redis/pull/206))
+* Fix `hmset` to accept hashes in addition to key/value pairs ([#208](https://github.com/sds/mock_redis/pull/208))
+* Fix stream ID regex to support `(` ([#209](https://github.com/sds/mock_redis/pull/209))
+* Allow `mget` to accept a block ([#210](https://github.com/sds/mock_redis/pull/210))
+
+### 0.27.3
+
+* Ensure `ruby2_keywords` dependency is `require`d at runtime
+
+### 0.27.2
+
+* Switch `ruby2_keywords` gem from development dependency to runtime dependency
+
 ### 0.27.1
 
 * Fix missing `ruby2_keywords` gem

data/README.md

@@ -12,7 +12,7 @@ for use in tests.
 
 * Ruby 2.4+
 
-The current implementation is tested against **Redis 5**. Older versions may work, but can also return different results or not support some commands.
+The current implementation is tested against **Redis 6**. Older versions may work, but can also return different results or not support some commands.
 
 ## Getting Started
 

data/lib/mock_redis.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'ruby2_keywords'
 
 require 'mock_redis/assertions'
 require 'mock_redis/database'
@@ -21,6 +22,7 @@ class MockRedis
     :path => nil,
     :timeout => 5.0,
     :password => nil,
+    :logger => nil,
     :db => 0,
     :time_class => Time,
   }.freeze
@@ -64,6 +66,10 @@ class MockRedis
     options[:db]
   end
 
+  def logger
+    options[:logger]
+  end
+
   def time_at(timestamp)
     options[:time_class].at(timestamp)
   end
@@ -85,7 +91,9 @@ class MockRedis
   end
 
   ruby2_keywords def method_missing(method, *args, &block)
-    @db.send(method, *args, &block)
+    logging([[method, *args]]) do
+      @db.send(method, *args, &block)
+    end
   end
 
   def initialize_copy(source)
@@ -138,4 +146,28 @@ class MockRedis
 
     options
   end
+
+  def logging(commands)
+    return yield unless logger&.debug?
+
+    begin
+      commands.each do |name, *args|
+        logged_args = args.map do |a|
+          if a.respond_to?(:inspect) then a.inspect
+          elsif a.respond_to?(:to_s) then a.to_s
+          else
+            # handle poorly-behaved descendants of BasicObject
+            klass = a.instance_exec { (class << self; self end).superclass }
+            "\#<#{klass}:#{a.__id__}>"
+          end
+        end
+        logger.debug("[MockRedis] command=#{name.to_s.upcase} args=#{logged_args.join(' ')}")
+      end
+
+      t1 = Time.now
+      yield
+    ensure
+      logger.debug("[MockRedis] call_time=%0.2f ms" % ((Time.now - t1) * 1000)) if t1
+    end
+  end
 end

data/lib/mock_redis/hash_methods.rb

@@ -10,6 +10,11 @@ class MockRedis
       with_hash_at(key) do |hash|
         orig_size = hash.size
         fields = Array(fields).flatten.map(&:to_s)
+
+        if fields.empty?
+          raise Redis::CommandError, "ERR wrong number of arguments for 'hdel' command"
+        end
+
         hash.delete_if { |k, _v| fields.include?(k) }
         orig_size - hash.size
       end
@@ -94,7 +99,7 @@ class MockRedis
       assert_has_args(kvpairs, 'hmset')
 
       if kvpairs.length.odd?
-        raise Redis::CommandError, err_msg || 'ERR wrong number of arguments for HMSET'
+        raise Redis::CommandError, err_msg || 'ERR wrong number of arguments for \'hmset\' command'
       end
 
       kvpairs.each_slice(2) do |(k, v)|
@@ -131,6 +136,10 @@ class MockRedis
     def hset(key, *args)
       added = 0
       with_hash_at(key) do |hash|
+        if args.length == 1 && args[0].is_a?(Hash)
+          args = args[0].to_a.flatten
+        end
+
         args.each_slice(2) do |field, value|
           added += 1 unless hash.key?(field.to_s)
           hash[field.to_s] = value.to_s

data/lib/mock_redis/stream.rb

@@ -49,9 +49,15 @@ class MockRedis
       opts = options opts_in, ['count']
       start_id = MockRedis::Stream::Id.new(start)
       finish_id = MockRedis::Stream::Id.new(finish, sequence: Float::INFINITY)
-      items = members
-              .select { |m| (start_id <= m[0]) && (finish_id >= m[0]) }
-              .map { |m| [m[0].to_s, m[1]] }
+      if start_id.exclusive
+        items = members
+                .select { |m| (start_id < m[0]) && (finish_id >= m[0]) }
+                .map { |m| [m[0].to_s, m[1]] }
+      else
+        items = members
+                .select { |m| (start_id <= m[0]) && (finish_id >= m[0]) }
+                .map { |m| [m[0].to_s, m[1]] }
+      end
       items.reverse! if reversed
       return items.first(opts['count'].to_i) if opts.key?('count')
       items

data/lib/mock_redis/stream/id.rb

@@ -3,9 +3,10 @@ class MockRedis
     class Id
       include Comparable
 
-      attr_accessor :timestamp, :sequence
+      attr_accessor :timestamp, :sequence, :exclusive
 
       def initialize(id, min: nil, sequence: 0)
+        @exclusive = false
         case id
         when '*'
           @timestamp = (Time.now.to_f * 1000).to_i
@@ -20,8 +21,12 @@ class MockRedis
           @timestamp = @sequence = Float::INFINITY
         else
           if id.is_a? String
-            (_, @timestamp, @sequence) = id.match(/^(\d+)-?(\d+)?$/)
-                                           .to_a
+            # See https://redis.io/topics/streams-intro
+            # Ids are a unix timestamp in milliseconds followed by an
+            # optional dash sequence number, e.g. -0. They can also optionally
+            # be prefixed with '(' to change the XRANGE to exclusive.
+            (_, @timestamp, @sequence) = id.match(/^\(?(\d+)-?(\d+)?$/).to_a
+            @exclusive = true if id[0] == '('
             if @timestamp.nil?
               raise Redis::CommandError,
                     'ERR Invalid stream ID specified as stream command argument'

data/lib/mock_redis/string_methods.rb

@@ -154,14 +154,16 @@ class MockRedis
       new_value
     end
 
-    def mget(*keys)
+    def mget(*keys, &blk)
       keys.flatten!
 
       assert_has_args(keys, 'mget')
 
-      keys.map do |key|
+      data = keys.map do |key|
         get(key) if stringy?(key)
       end
+
+      blk ? blk.call(data) : data
     end
 
     def mapped_mget(*keys)

data/lib/mock_redis/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 class MockRedis
-  VERSION = '0.27.1'
+  VERSION = '0.29.0'
 end

data/lib/mock_redis/zset.rb

@@ -23,12 +23,7 @@ class MockRedis
 
     def add(score, member)
       members.add(member)
-      scores[member] =
-        if score.to_f.to_i == score.to_f
-          score.to_f.to_i
-        else
-          score.to_f
-        end
+      scores[member] = score.to_f
       self
     end
 

data/mock_redis.gemspec

@@ -23,9 +23,10 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.4'
 
+  s.add_runtime_dependency 'ruby2_keywords'
+
   s.add_development_dependency 'redis', '~> 4.2.0'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its', '~> 1.0'
-  s.add_development_dependency 'ruby2_keywords'
   s.add_development_dependency 'timecop', '~> 0.9.1'
 end

data/spec/commands/hdel_spec.rb

@@ -66,5 +66,12 @@ describe '#hdel(key, field)' do
     @redises.get(@key).should be_nil
   end
 
+  it 'raises error if an empty array is passed' do
+    expect { @redises.hdel(@key, []) }.to raise_error(
+      Redis::CommandError,
+      "ERR wrong number of arguments for 'hdel' command"
+    )
+  end
+
   it_should_behave_like 'a hash-only command'
 end

data/spec/commands/hset_spec.rb

@@ -34,5 +34,9 @@ describe '#hset(key, field)' do
     @redises.hget(@key, '1').should == 'one'
   end
 
+  it 'stores fields sent in a hash' do
+    @redises.hset(@key, {'k1' => 'v1', 'k2' => 'v2'}).should == 2
+  end
+
   it_should_behave_like 'a hash-only command'
 end

data/spec/commands/mget_spec.rb

@@ -56,4 +56,10 @@ describe '#mget(key [, key, ...])' do
       end.should raise_error(Redis::CommandError)
     end
   end
+
+  context 'emulate block' do
+    it 'returns an array of values' do
+      @redises.mget(@key1, @key2) { |values| values.map(&:to_i) }.should == [1, 2]
+    end
+  end
 end

data/spec/commands/xadd_spec.rb

@@ -14,20 +14,20 @@ describe '#xadd("mystream", { f1: "v1", f2: "v2" }, id: "0-0", maxlen: 1000, app
 
   it 'returns an id based on the timestamp' do
     t = Time.now.to_i
-    id = @redises.xadd(@key, key: 'value')
-    expect(@redises.xadd(@key, key: 'value')).to match(/#{t}\d{3}-0/)
+    id = @redises.xadd(@key, { key: 'value' })
+    expect(@redises.xadd(@key, { key: 'value' })).to match(/#{t}\d{3}-0/)
   end
 
   it 'adds data with symbols' do
-    @redises.xadd(@key, symbol_key: :symbol_value)
+    @redises.xadd(@key, { symbol_key: :symbol_value })
     expect(@redises.xrange(@key, '-', '+').last[1])
       .to eq('symbol_key' => 'symbol_value')
   end
 
   it 'increments the sequence number with the same timestamp' do
     Timecop.freeze do
-      @redises.xadd(@key, key: 'value')
-      expect(@redises.xadd(@key, key: 'value')).to match(/\d+-1/)
+      @redises.xadd(@key, { key: 'value' })
+      expect(@redises.xadd(@key, { key: 'value' })).to match(/\d+-1/)
     end
   end
 
@@ -67,7 +67,7 @@ describe '#xadd("mystream", { f1: "v1", f2: "v2" }, id: "0-0", maxlen: 1000, app
   it 'caters for the current time being before the last time' do
     t = (Time.now.to_f * 1000).to_i + 2000
     @redises.xadd(@key, { key: 'value' }, id: "#{t}-0")
-    expect(@redises.xadd(@key, key: 'value')).to match(/#{t}-1/)
+    expect(@redises.xadd(@key, { key: 'value' })).to match(/#{t}-1/)
   end
 
   it 'appends a sequence number if it is missing' do

data/spec/commands/xlen_spec.rb

@@ -14,9 +14,9 @@ describe '#xlen(key)' do
 
   it 'returns the number of items in the stream' do
     expect(@redises.xlen(@key)).to eq 0
-    @redises.xadd(@key, key: 'value')
+    @redises.xadd(@key, { key: 'value' })
     expect(@redises.xlen(@key)).to eq 1
-    3.times { @redises.xadd(@key, key: 'value') }
+    3.times { @redises.xadd(@key, { key: 'value' }) }
     expect(@redises.xlen(@key)).to eq 4
   end
 end

data/spec/commands/xrange_spec.rb

@@ -79,13 +79,23 @@ describe '#xrange("mystream", first: "0-1", last: "0-3", count: 10)' do
       )
     end
 
-    it 'returns entries with both a lower and an upper limit' do
-      expect(@redises.xrange(@key, '1234567891239-0', '1234567891285-0')).to eq(
+    it 'returns entries with both a lower and an upper limit inclusive' do
+      expect(@redises.xrange(@key, '1234567891245-0', '1234567891278-0')).to eq(
         [
           ['1234567891245-0', { 'key2' => 'value2' }],
           ['1234567891245-1', { 'key3' => 'value3' }],
+          ['1234567891278-0', { 'key4' => 'value4' }]
+        ]
+      )
+    end
+
+    it 'returns entries with both a lower and an upper limit exclusive' do
+      expect(@redises.xrange(@key, '(1234567891245-0', '1234567891285-1')).to eq(
+        [
+          # We no longer get '1234567891245-0'
+          ['1234567891245-1', { 'key3' => 'value3' }],
           ['1234567891278-0', { 'key4' => 'value4' }],
-          ['1234567891278-1', { 'key5' => 'value5' }]
+          ['1234567891278-1', { 'key5' => 'value5' }] # Note sequence -1
         ]
       )
     end

data/spec/commands/zadd_spec.rb

@@ -23,6 +23,12 @@ describe '#zadd(key, score, member)' do
     @redises.zrange(@key, 0, -1).should == [member.to_s]
   end
 
+  it 'allows scores to be set to Float::INFINITY' do
+    member = '1'
+    @redises.zadd(@key, Float::INFINITY, member)
+    @redises.zrange(@key, 0, -1).should == [member]
+  end
+
   it 'updates the score' do
     @redises.zadd(@key, 1, 'foo')
     @redises.zadd(@key, 2, 'foo')

data/spec/mock_redis_spec.rb

@@ -81,4 +81,13 @@ describe MockRedis do
       end
     end
   end
+
+  describe 'supplying a logger' do
+    it 'logs redis commands' do
+      logger = double('Logger', debug?: true, debug: nil)
+      mock_redis = MockRedis.new(logger: logger)
+      expect(logger).to receive(:debug).with(/command=HMGET args="hash" "key1" "key2"/)
+      mock_redis.hmget("hash", "key1", "key2")
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -11,7 +11,6 @@ end
 require 'rspec/its'
 require 'redis'
 $LOAD_PATH.unshift(File.expand_path(File.join(__FILE__, '..', '..', 'lib')))
-require 'ruby2_keywords'
 require 'mock_redis'
 require 'timecop'
 

metadata

@@ -1,16 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: mock_redis
 version: !ruby/object:Gem::Version
-  version: 0.27.1
+  version: 0.29.0
 platform: ruby
 authors:
 - Shane da Silva
 - Samuel Merritt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2021-08-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby2_keywords
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -53,20 +67,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: ruby2_keywords
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -295,7 +295,7 @@ homepage: https://github.com/sds/mock_redis
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -311,7 +311,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Redis mock that just lives in memory; useful for testing.
 test_files: