mock_redis 0.28.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dc2b4dd866fe426a0ee5b767bc46668c1ccb515f0b927feeac129b47f28a4a6
-  data.tar.gz: cccf8ea1f98f9376afadcc57738eef1578bd07166b08bb5a11eb6c3410412f23
+  metadata.gz: 2870385004370b0471f3cf495184d8e11f138e0cb13b9bef9bd43ed7ce2b35ff
+  data.tar.gz: 75475cf000d2075ad2565440aea2521fa1034248726b5070ff149d9518c00c3a
 SHA512:
-  metadata.gz: f8827a5223d959f27d33223904f0cdf705dfa280da700733ea83cb581ddc89ca3e427af39ec247ea05ebb79ecb9fe58ba3e8f2f1b7fd62204aacc65025f010cf
-  data.tar.gz: e1e3115c5577f1e22249f3c6b9fb3b82ac1be4b8a4967824cbea5f56ce35efec15154d1f9871de5ba3abc337cbe6d38c9d93787150c8e3262ba30b395bcb58b4
+  metadata.gz: 6e6f75b19c46fd81ef553dfe1af1f32b2dceb13e4b660835cd58b1760fa8445c09c2ef26bf67cf64adcf87e196de24798333350e0a07ca0fac39939e296659e4
+  data.tar.gz: 77c2c5fc3f67f654d402161541b1527c6779859a0ec6e61a5fb6048b7abfcab50728ba2c25617a2adf303b22a23e662a8f2ee7236085db02682e0e8ca690438a

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,63 @@
+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
+
+      - name: Code coverage reporting
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          flag-name: ruby${{ matrix.ruby-version }}-${{ matrix.redis-version }}
+          parallel: true
+
+  finish:
+    needs: rspec
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Finalize code coverage report
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.github_token }}
+          parallel-finished: true

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # MockRedis Changelog
 
+### 0.31.0
+
+* Allow `ping` to take argument
+* Raise `CommandError` on `hmget` with empty list of fields
+
+### 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))

data/Gemfile

@@ -9,4 +9,5 @@ gem 'overcommit', '0.53.0'
 # Pin tool versions (which are executed by Overcommit) for Travis builds
 gem 'rubocop', '0.82.0'
 
-gem 'coveralls', require: false
+gem 'simplecov', '~> 0.21.0'
+gem 'simplecov-lcov', '~> 0.8.0'

data/README.md

@@ -1,7 +1,7 @@
 # MockRedis
 
 [![Gem Version](https://badge.fury.io/rb/mock_redis.svg)](http://badge.fury.io/rb/mock_redis)
-[![Build Status](https://travis-ci.org/sds/mock_redis.svg)](https://travis-ci.org/sds/mock_redis)
+![Build Status](https://github.com/sds/mock_redis/actions/workflows/tests.yml/badge.svg)
 [![Coverage Status](https://coveralls.io/repos/sds/mock_redis/badge.svg)](https://coveralls.io/r/sds/mock_redis)
 
 MockRedis provides the same interface as `redis-rb`, but it stores its
@@ -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)
@@ -178,8 +178,8 @@ class MockRedis
       end
     end
 
-    def ping
-      'PONG'
+    def ping(response = 'PONG')
+      response
     end
 
     def quit
@@ -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
@@ -70,8 +75,10 @@ class MockRedis
     end
 
     def hmget(key, *fields)
+      fields.flatten!
+
       assert_has_args(fields, 'hmget')
-      fields.flatten.map { |f| hget(key, f) }
+      fields.map { |f| hget(key, f) }
     end
 
     def mapped_hmget(key, *fields)

data/lib/mock_redis/stream.rb

@@ -49,15 +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)
-      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 = 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/version.rb

@@ -2,5 +2,5 @@
 
 # Defines the gem version.
 class MockRedis
-  VERSION = '0.28.0'
+  VERSION = '0.31.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

@@ -22,6 +22,7 @@ class MockRedis
     :path => nil,
     :timeout => 5.0,
     :password => nil,
+    :logger => nil,
     :db => 0,
     :time_class => Time,
   }.freeze
@@ -65,6 +66,10 @@ class MockRedis
     options[:db]
   end
 
+  def logger
+    options[:logger]
+  end
+
   def time_at(timestamp)
     options[:time_class].at(timestamp)
   end
@@ -86,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)
@@ -139,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/expire_spec.rb

@@ -21,7 +21,7 @@ describe '#expire(key, seconds)' do
 
   it 'raises an error if seconds is bogus' do
     lambda do
-      @redises.expireat(@key, 'a couple minutes or so')
+      @redises.expire(@key, 'a couple minutes or so')
     end.should raise_error(Redis::CommandError)
   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/hmget_spec.rb

@@ -36,5 +36,11 @@ describe '#hmget(key, field [, field, ...])' do
     end.should raise_error(Redis::CommandError)
   end
 
+  it 'raises an error if given an empty list of fields' do
+    lambda do
+      @redises.hmget(@key, [])
+    end.should raise_error(Redis::CommandError)
+  end
+
   it_should_behave_like 'a hash-only command'
 end

data/spec/commands/hset_spec.rb

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

data/spec/commands/pexpire_spec.rb

@@ -21,7 +21,7 @@ describe '#pexpire(key, ms)' do
 
   it 'raises an error if ms is bogus' do
     lambda do
-      @redises.pexpireat(@key, 'a couple minutes or so')
+      @redises.pexpire(@key, 'a couple minutes or so')
     end.should raise_error(Redis::CommandError)
   end
 

data/spec/commands/ping_spec.rb

@@ -1,7 +1,11 @@
 require 'spec_helper'
 
 describe '#ping' do
-  it "returns 'PONG'" do
+  it 'returns "PONG" with no arguments' do
     @redises.ping.should == 'PONG'
   end
+
+  it 'returns the argument' do
+    @redises.ping('HELLO').should == 'HELLO'
+  end
 end

data/spec/commands/xadd_spec.rb

@@ -15,7 +15,7 @@ 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/)
+    expect(id).to match(/#{t}\d{3}-0/)
   end
 
   it 'adds data with symbols' do

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

@@ -1,11 +1,17 @@
-if ENV['TRAVIS']
-  # When running in Travis, report coverage stats to Coveralls.
-  require 'coveralls'
-  Coveralls.wear!
-else
-  # Otherwise render coverage information in coverage/index.html and display
-  # coverage percentage in the console.
-  require 'simplecov'
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec/'
+
+  if ENV['CI']
+    require 'simplecov-lcov'
+
+    SimpleCov::Formatter::LcovFormatter.config do |c|
+      c.report_with_single_file = true
+      c.single_report_path = 'coverage/lcov.info'
+    end
+
+    formatter SimpleCov::Formatter::LcovFormatter
+  end
 end
 
 require 'rspec/its'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mock_redis
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Shane da Silva
 - Samuel Merritt
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2022-04-10 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
@@ -295,7 +296,7 @@ homepage: https://github.com/sds/mock_redis
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -310,8 +311,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Redis mock that just lives in memory; useful for testing.
 test_files:

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