mock_redis 0.27.2 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a02f4ad5b82a9a913511533ca04c80bb75025dd0a4a1537917b57d65d34982c
-  data.tar.gz: 0fac5aab079e4cbad0cab684f3c670ae7f0b17650670347eae1402306d2f05e3
+  metadata.gz: 15bcc9fb58837462df30acd61176547493ce217061459f2c73e134f8ce15c5ab
+  data.tar.gz: 46df9da818b1b4cdf817a2d8700d6321c182934379974aaa21393bd588b6ab04
 SHA512:
-  metadata.gz: f5276d3d1f052bdf6c7e1ab8a78b450091ca673deb8e15bd02d4ee2e1f22aa43e98bff1cc33e03fd370e4db790ce3b59caadc5675358ffa85687e2972be873f5
-  data.tar.gz: ad4882bf89ce3654b99f2b90880b43a693dbd4ee7569458539d2e115dacc896ae4e86f766fbb9fed5cbab5868172b711c76d2fa7c37f9f05fc7a5a96495f6d47
+  metadata.gz: 7322c682d6b702f98afcfd42aac3fe7c6676d63e064d977ddbbfdbaf0f40bca96cd88636e7fd43384dc00455e4421f56555342aabe5707af28ea084587060db9
+  data.tar.gz: 36fa3abf3f2eef55e305a79ea6010edf90ba561e89b10466942f4f8f587c82cb400d97dae0cd330ff8bb73a494cff5171a8b3ab09485cdf76ae0804e9d1af0bb

data/.github/workflows/lint.yml

@@ -0,0 +1,31 @@
+name: Lint
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  overcommit:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1.97.0
+        with:
+          ruby-version: 2.7
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Prepare environment
+        run: |
+          git config --local user.email "gh-actions@example.com"
+          git config --local user.name "GitHub Actions"
+          bundle exec overcommit --sign
+
+      - name: Run pre-commit checks
+        run: bundle exec overcommit --run

data/.github/workflows/tests.yml

@@ -0,0 +1,45 @@
+name: Tests
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  rspec:
+    timeout-minutes: 10
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version:
+          - '2.6'
+          - '2.7'
+          - '3.0'
+        redis-version:
+          - '6.2'
+
+    services:
+      redis:
+          image: redis:${{ matrix.redis-version }}-alpine
+          options: >-
+            --health-cmd "redis-cli ping"
+            --health-interval 10s
+            --health-timeout 5s
+            --health-retries 5
+          ports:
+            - 6379:6379
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1.97.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Run tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # MockRedis Changelog
 
+### 0.30.0
+
+* Drop support for Ruby 2.4 and Ruby 2.5 since they are EOL
+* Fix `expire` to to raise error on invalid integer
+
+### 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

data/README.md

@@ -10,9 +10,9 @@ for use in tests.
 
 ## Requirements
 
-* Ruby 2.4+
+Ruby 2.6+
 
-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.2. Older versions may work, but can also return different results or not support some commands.
 
 ## Getting Started
 

data/lib/mock_redis/database.rb

@@ -86,27 +86,27 @@ class MockRedis
     end
 
     def expire(key, seconds)
+      assert_valid_integer(seconds)
+
       pexpire(key, seconds.to_i * 1000)
     end
 
     def pexpire(key, ms)
+      assert_valid_integer(ms)
+
       now, miliseconds = @base.now
       now_ms = (now * 1000) + miliseconds
       pexpireat(key, now_ms + ms.to_i)
     end
 
     def expireat(key, timestamp)
-      unless looks_like_integer?(timestamp.to_s)
-        raise Redis::CommandError, 'ERR value is not an integer or out of range'
-      end
+      assert_valid_integer(timestamp)
 
       pexpireat(key, timestamp.to_i * 1000)
     end
 
     def pexpireat(key, timestamp_ms)
-      unless looks_like_integer?(timestamp_ms.to_s)
-        raise Redis::CommandError, 'ERR value is not an integer or out of range'
-      end
+      assert_valid_integer(timestamp_ms)
 
       if exists?(key)
         timestamp = Rational(timestamp_ms.to_i, 1000)
@@ -280,6 +280,13 @@ class MockRedis
 
     private
 
+    def assert_valid_integer(integer)
+      unless looks_like_integer?(integer.to_s)
+        raise Redis::CommandError, 'ERR value is not an integer or out of range'
+      end
+      integer
+    end
+
     def assert_valid_timeout(timeout)
       if !looks_like_integer?(timeout.to_s)
         raise Redis::CommandError, 'ERR timeout is not an integer or out of range'

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/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/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]] }
+      items = if start_id.exclusive
+                members
+                  .select { |m| (start_id < m[0]) && (finish_id >= m[0]) }
+                  .map { |m| [m[0].to_s, m[1]] }
+              else
+                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/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.2'
+  VERSION = '0.30.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/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,30 @@ 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
+      if t1
+        logger.debug(format('[MockRedis] call_time=%<time>0.2f ms', time: ((Time.now - t1) * 1000)))
+      end
+    end
+  end
 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(id).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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mock_redis
 version: !ruby/object:Gem::Version
-  version: 0.27.2
+  version: 0.30.0
 platform: ruby
 authors:
 - Shane da Silva
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-07 00:00:00.000000000 Z
+date: 2022-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby2_keywords
@@ -89,6 +89,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/lint.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".mailmap"
 - ".overcommit.yml"
@@ -96,7 +98,6 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".simplecov"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.md
@@ -310,7 +311,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Redis mock that just lives in memory; useful for testing.

data/.travis.yml

@@ -1,33 +0,0 @@
-language: ruby
-
-cache: bundler
-
-addons:
-  apt:
-    packages:
-      - redis-server
-
-services:
-  - redis-server
-
-before_install:
-  - sudo sed -e 's/^bind.*/bind 127.0.0.1/' /etc/redis/redis.conf > redis.conf
-  - sudo mv redis.conf /etc/redis
-  - sudo service redis-server start
-  - echo PING | nc localhost 6379
-
-rvm:
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-
-before_script:
-  - git config --local user.email "travis@travis.ci"
-  - git config --local user.name "Travis CI"
-
-script:
-  - redis-cli --version
-  - bundle exec rspec
-  - bundle exec overcommit --sign
-  - bundle exec overcommit --run