mock_redis 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c087a47dd536c50c70b1238484a41a46669ca210b53063efd87fc863c83aaa67
-  data.tar.gz: 41927d6f1904768faaa5f9bbeff4fa803f7dc1045aa76da8f885594326eab326
+  metadata.gz: b491b0b8e260ee631a3633b35154946ef5822a3310d6bc51ce977febe8559b8a
+  data.tar.gz: 795a9ec1aa340ee6b0733b3a539a0ff355dc5e71287f59ca03f2ae64ef9e770e
 SHA512:
-  metadata.gz: efe4f6cb8a7c3326e8ad06c1753a651dc41323ca1fb4a7f23a1ac080feb09a4192f5d140ddeb437ce7268c0325e9e8bc4270f6d68facc88696d9586b9342d388
-  data.tar.gz: 7392d8b37355b3c22dd7c51745df2f67497dfb88f2534a5cf5df606e07b6fe47cc7969e4e005da85b4a4e382ef8b7801e220f948db71313330079781a973ff75
+  metadata.gz: ea3fd9aabe7c3afac9c358dbe97a2ffb78277a1d0dab830d6b9983404a1a9f3b2b47f97022441b62884ce01fb6557b1b5a8ca334378bc18ba6c0863b577a947a
+  data.tar.gz: 4a487e49858bed2684e8695affe470801de0a6247c1a7281c1f1f3a6913f59ebe38fffee8fa0a41142d20d65cb8339cbb4dd4c2d03ddc2ed5d538760f59fc959

data/.travis.yml

@@ -20,6 +20,7 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
 
 before_script:
   - git config --local user.email "travis@travis.ci"

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # MockRedis Changelog
 
+### 0.27.0
+
+* Fix handling of keyword arguments on Ruby 3 ([#199](https://github.com/sds/mock_redis/pull/199))
+* Allow passing string `offset` to `setbit` ([#200](https://github.com/sds/mock_redis/pull/200))
+* Add `connection` method ([#201](https://github.com/sds/mock_redis/pull/201))
+
 ### 0.26.0
 
 * Add block and count support to `xread` ([#194](https://github.com/sds/mock_redis/pull/194))

data/Gemfile

@@ -9,4 +9,6 @@ gem 'overcommit', '0.53.0'
 # Pin tool versions (which are executed by Overcommit) for Travis builds
 gem 'rubocop', '0.82.0'
 
+gem 'ruby2_keywords'
+
 gem 'coveralls', require: false

data/lib/mock_redis.rb

@@ -84,7 +84,7 @@ class MockRedis
     super || @db.respond_to?(method, include_private)
   end
 
-  def method_missing(method, *args, &block)
+  ruby2_keywords def method_missing(method, *args, &block)
     @db.send(method, *args, &block)
   end
 

data/lib/mock_redis/connection_method.rb

@@ -0,0 +1,13 @@
+class MockRedis
+  module ConnectionMethod
+    def connection
+      {
+        :host => @base.host,
+        :port => @base.port,
+        :db => @base.db,
+        :id => @base.id,
+        :location => "#{@base.host}:#{@base.port}"
+      }
+    end
+  end
+end

data/lib/mock_redis/database.rb

@@ -11,6 +11,7 @@ require 'mock_redis/info_method'
 require 'mock_redis/utility_methods'
 require 'mock_redis/geospatial_methods'
 require 'mock_redis/stream_methods'
+require 'mock_redis/connection_method'
 
 class MockRedis
   class Database
@@ -24,6 +25,7 @@ class MockRedis
     include UtilityMethods
     include GeospatialMethods
     include StreamMethods
+    include ConnectionMethod
 
     attr_reader :data, :expire_times
 

data/lib/mock_redis/expire_wrapper.rb

@@ -12,7 +12,7 @@ class MockRedis
       @db = db
     end
 
-    def method_missing(method, *args, &block)
+    ruby2_keywords def method_missing(method, *args, &block)
       @db.expire_keys
       @db.send(method, *args, &block)
     end

data/lib/mock_redis/geospatial_methods.rb

@@ -12,7 +12,7 @@ class MockRedis
     D_R = Math::PI / 180.0
     EARTH_RADIUS_IN_METERS = 6_372_797.560856
 
-    def geoadd(key, *args)
+    ruby2_keywords def geoadd(key, *args)
       points = parse_points(args)
 
       scored_points = points.map do |point|

data/lib/mock_redis/multi_db_wrapper.rb

@@ -17,7 +17,7 @@ class MockRedis
       super || current_db.respond_to?(method, include_private)
     end
 
-    def method_missing(method, *args, &block)
+    ruby2_keywords def method_missing(method, *args, &block)
       current_db.send(method, *args, &block)
     end
 

data/lib/mock_redis/pipelined_wrapper.rb

@@ -18,7 +18,7 @@ class MockRedis
       @pipelined_futures = @pipelined_futures.clone
     end
 
-    def method_missing(method, *args, &block)
+    ruby2_keywords def method_missing(method, *args, &block)
       if in_pipeline?
         future = MockRedis::Future.new([method, *args], block)
         @pipelined_futures << future

data/lib/mock_redis/stream.rb

@@ -25,10 +25,7 @@ class MockRedis
       @last_id = MockRedis::Stream::Id.new(id, min: @last_id)
       if @last_id.to_s == '0-0'
         raise Redis::CommandError,
-              'ERR The ID specified in XADD is equal or smaller than ' \
-              'the target stream top item'
-        # TOOD: Redis version 6.0.4, w redis 4.2.1 generates the following error message:
-        # 'ERR The ID specified in XADD must be greater than 0-0'
+          'ERR The ID specified in XADD must be greater than 0-0'
       end
       members.add [@last_id, Hash[values.map { |k, v| [k.to_s, v.to_s] }]]
       @last_id.to_s

data/lib/mock_redis/string_methods.rb

@@ -201,18 +201,19 @@ class MockRedis
       msetnx(*hash.to_a.flatten)
     end
 
-    def set(key, value, options = {})
+    # Parameer list required to ensure the ArgumentError is returned correctly
+    # rubocop:disable Metrics/ParameterLists
+    def set(key, value, ex: nil, px: nil, nx: nil, xx: nil, keepttl: nil)
       key = key.to_s
       return_true = false
-      options = options.dup
-      if options.delete(:nx)
+      if nx
         if exists?(key)
           return false
         else
           return_true = true
         end
       end
-      if options.delete(:xx)
+      if xx
         if exists?(key)
           return_true = true
         else
@@ -221,27 +222,24 @@ class MockRedis
       end
       data[key] = value.to_s
 
-      duration = options.delete(:ex)
-      if duration
-        if duration == 0
+      remove_expiration(key) unless keepttl
+      if ex
+        if ex == 0
           raise Redis::CommandError, 'ERR invalid expire time in set'
         end
-        expire(key, duration)
+        expire(key, ex)
       end
 
-      duration = options.delete(:px)
-      if duration
-        if duration == 0
+      if px
+        if px == 0
           raise Redis::CommandError, 'ERR invalid expire time in set'
         end
-        pexpire(key, duration)
-      end
-      unless options.empty?
-        raise ArgumentError, "unknown keyword: #{options.keys[0]}"
+        pexpire(key, px)
       end
 
       return_true ? true : 'OK'
     end
+    # rubocop:enable Metrics/ParameterLists
 
     def setbit(key, offset, value)
       assert_stringy(key, 'ERR bit is not an integer or out of range')
@@ -249,6 +247,7 @@ class MockRedis
 
       str = data[key] || ''
 
+      offset = offset.to_i
       offset_of_byte = offset / 8
       offset_within_byte = offset % 8
 

data/lib/mock_redis/transaction_wrapper.rb

@@ -15,7 +15,7 @@ class MockRedis
       @multi_block_given = false
     end
 
-    def method_missing(method, *args, &block)
+    ruby2_keywords def method_missing(method, *args, &block)
       if in_multi?
         future = MockRedis::Future.new([method, *args], block)
         @transaction_futures << future

data/lib/mock_redis/version.rb

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

data/spec/commands/connection_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe '#connection' do
+  let(:redis) { @redises.mock }
+
+  it 'returns the correct values' do
+    redis.connection.should == {
+      :host => '127.0.0.1',
+      :port => 6379,
+      :db => 0,
+      :id => 'redis://127.0.0.1:6379/0',
+      :location => '127.0.0.1:6379'
+    }
+  end
+end

data/spec/commands/del_spec.rb

@@ -6,7 +6,9 @@ describe '#del(key [, key, ...])' do
   end
 
   before :each do
-    @redises._gsub(/\d{3}-\d/, '...-.')
+    # TODO: Redis appears to be returning a timestamp a few seconds in the future
+    # so we're ignoring the last 5 digits (time in milliseconds)
+    @redises._gsub(/\d{5}-\d/, '...-.')
   end
 
   it 'returns the number of keys deleted' do

data/spec/commands/set_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe '#set(key, value)' do
+  let(:key) { 'mock-redis-test' }
+
   it "responds with 'OK'" do
     @redises.set('mock-redis-test', 1).should == 'OK'
   end
@@ -19,26 +21,72 @@ describe '#set(key, value)' do
     end
 
     it 'accepts NX' do
-      key = 'mock-redis-test'
       @redises.del(key)
       @redises.set(key, 1, nx: true).should == true
       @redises.set(key, 1, nx: true).should == false
     end
 
     it 'accepts XX' do
-      key = 'mock-redis-test'
       @redises.del(key)
       @redises.set(key, 1, xx: true).should == false
       @redises.set(key, 1).should == 'OK'
       @redises.set(key, 1, xx: true).should == true
     end
 
+    it 'sets the ttl to -1' do
+      @redises.set(key, 1)
+      expect(@redises.ttl(key)).to eq(-1)
+    end
+
+    context 'with an expiry time' do
+      before :each do
+        Timecop.freeze
+        @redises.set(key, 1, ex: 90)
+      end
+
+      after :each do
+        @redises.del(key)
+        Timecop.return
+      end
+
+      it 'has the TTL set' do
+        expect(@redises.ttl(key)).to eq 90
+      end
+
+      it 'resets the TTL without keepttl' do
+        expect do
+          @redises.set(key, 2)
+        end.to change { @redises.ttl(key) }.from(90).to(-1)
+      end
+
+      it 'does not change the TTL with keepttl: true' do
+        expect do
+          @redises.set(key, 2, keepttl: true)
+        end.not_to change { @redises.ttl(key) }.from(90)
+      end
+    end
+
+    it 'accepts KEEPTTL' do
+      expect(@redises.set(key, 1, keepttl: true)).to eq 'OK'
+    end
+
+    it 'does not set TTL without ex' do
+      @redises.set(key, 1)
+      expect(@redises.ttl(key)).to eq(-1)
+    end
+
+    it 'sets the TTL' do
+      Timecop.freeze do
+        @redises.set(key, 1, ex: 90)
+        expect(@redises.ttl(key)).to eq 90
+      end
+    end
+
     it 'raises on unknown options' do
-      key = 'mock-redis-test'
       @redises.del(key)
       expect do
         @redises.set(key, 1, logger: :something)
-      end.to raise_error(ArgumentError, 'unknown keyword: logger')
+      end.to raise_error(ArgumentError, /unknown keyword/)
     end
 
     context '[mock only]' do
@@ -52,7 +100,6 @@ describe '#set(key, value)' do
       end
 
       it 'accepts EX seconds' do
-        key = 'mock-redis-test'
         @mock.set(key, 1, ex: 1).should == 'OK'
         @mock.get(key).should_not be_nil
         Time.stub(:now).and_return(@now + 2)
@@ -60,7 +107,6 @@ describe '#set(key, value)' do
       end
 
       it 'accepts PX milliseconds' do
-        key = 'mock-redis-test'
         @mock.set(key, 1, px: 500).should == 'OK'
         @mock.get(key).should_not be_nil
         Time.stub(:now).and_return(@now + 300 / 1000.to_f)

data/spec/commands/xadd_spec.rb

@@ -7,11 +7,14 @@ describe '#xadd("mystream", { f1: "v1", f2: "v2" }, id: "0-0", maxlen: 1000, app
   end
 
   before :each do
-    @redises._gsub(/\d{3}-\d/, '...-.')
+    # TODO: Redis appears to be returning a timestamp a few seconds in the future
+    # so we're ignoring the last 5 digits (time in milliseconds)
+    @redises._gsub(/\d{5}-\d/, '....-.')
   end
 
   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/)
   end
 
@@ -52,10 +55,7 @@ describe '#xadd("mystream", { f1: "v1", f2: "v2" }, id: "0-0", maxlen: 1000, app
     expect { @redises.xadd('mock-redis-test:unknown-stream', { key: 'value' }, id: '0') }
       .to raise_error(
         Redis::CommandError,
-        'ERR The ID specified in XADD is equal or smaller than the target ' \
-        'stream top item'
-        # TOOD: Redis version 6.0.4, w redis 4.2.1 generates the following error message:
-        # 'ERR The ID specified in XADD must be greater than 0-0'
+        'ERR The ID specified in XADD must be greater than 0-0'
       )
   end
 

data/spec/commands/xlen_spec.rb

@@ -7,7 +7,9 @@ describe '#xlen(key)' do
   end
 
   before :each do
-    @redises._gsub(/\d{3}-\d/, '...-.')
+    # TODO: Redis appears to be returning a timestamp a few seconds in the future
+    # so we're ignoring the last 5 digits (time in milliseconds)
+    @redises._gsub(/\d{5}-\d/, '...-.')
   end
 
   it 'returns the number of items in the stream' do

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ end
 require 'rspec/its'
 require 'redis'
 $LOAD_PATH.unshift(File.expand_path(File.join(__FILE__, '..', '..', 'lib')))
+require 'ruby2_keywords'
 require 'mock_redis'
 require 'timecop'
 
@@ -40,8 +41,6 @@ end
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = [:expect, :should]
-    # Allow for a large output so we can debug error messages
-    c.max_formatted_output_length = 1_000_000
   end
 
   config.mock_with :rspec do |c|

data/spec/support/redis_multiplexer.rb

@@ -23,7 +23,7 @@ class RedisMultiplexer < BlankSlate
     @gsub_from = @gsub_to = ''
   end
 
-  def method_missing(method, *args, &blk)
+  ruby2_keywords def method_missing(method, *args, &blk)
     # If we're in a Redis command that accepts a block, and we execute more
     # redis commands, ONLY execute them on the Redis implementation that the
     # block came from.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mock_redis
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Shane da Silva
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -90,6 +90,7 @@ files:
 - Rakefile
 - lib/mock_redis.rb
 - lib/mock_redis/assertions.rb
+- lib/mock_redis/connection_method.rb
 - lib/mock_redis/database.rb
 - lib/mock_redis/exceptions.rb
 - lib/mock_redis/expire_wrapper.rb
@@ -126,6 +127,7 @@ files:
 - spec/commands/brpop_spec.rb
 - spec/commands/brpoplpush_spec.rb
 - spec/commands/connected_spec.rb
+- spec/commands/connection_spec.rb
 - spec/commands/dbsize_spec.rb
 - spec/commands/decr_spec.rb
 - spec/commands/decrby_spec.rb
@@ -294,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Redis mock that just lives in memory; useful for testing.
@@ -311,6 +313,7 @@ test_files:
 - spec/commands/brpop_spec.rb
 - spec/commands/brpoplpush_spec.rb
 - spec/commands/connected_spec.rb
+- spec/commands/connection_spec.rb
 - spec/commands/dbsize_spec.rb
 - spec/commands/decr_spec.rb
 - spec/commands/decrby_spec.rb