mock_redis 0.25.0 → 0.27.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4a2d7e6a155059cb97120f7f95c1e992a87a3933be5fe337a443dc0a9ac30df
-  data.tar.gz: 135172a723e9d5bfb058eec85863387093d56e3a6d7729f28da425f2b239e4bb
+  metadata.gz: f61e830490badf3dffbb7dff2ba426f7a359bbc9023243de838e4698318e8aaa
+  data.tar.gz: 21bc925aad3d1b8b67e799da8ea8015810a79f40f0d8962a08d32ca9cee9c9bc
 SHA512:
-  metadata.gz: 1e1b5cba39d01b11b2c85442c5d9485285bf661316e5196448484bc78dd9d866c3829648cd547ac0996d454f113d054c3bc43728f917740870f5fe191c97b15c
-  data.tar.gz: bf5d20de1111be19c03cacb2639f303d0ced578656bfc5b4dae4e8cd6e28991be003e7a20702ab6825526fbee6f91ebcd676fbb27c9010792abd37a2e7eab218
+  metadata.gz: 01c57f3b8db4fb7835a6cf83cbe67010f3a501945751b7f2c7138b5488f62b72734903592e9bf189b2e41d6c9c6caad4d33799c0158bf5707990cec853860961
+  data.tar.gz: 352e3efacf4b47935dcb20f4a427833858fe2229a33568251dc6f670b40ba5a0db22e484f92d5467ff26bd95b42696971211d86b97513efb9d6e65cd21d71740

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,28 @@
 # MockRedis Changelog
 
+### 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
+* Allow passing string `offset` to `getbit` ([#203](https://github.com/sds/mock_redis/pull/203))
+
+### 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))
+
 ### 0.25.0
 
 * Add support for `xread` command ([#190](https://github.com/sds/mock_redis/pull/190))

data/lib/mock_redis.rb

@@ -1,4 +1,5 @@
 require 'set'
+require 'ruby2_keywords'
 
 require 'mock_redis/assertions'
 require 'mock_redis/database'
@@ -84,7 +85,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
@@ -60,9 +57,12 @@ class MockRedis
       items
     end
 
-    def read(id)
+    def read(id, *opts_in)
+      opts = options opts_in, %w[count block]
       stream_id = MockRedis::Stream::Id.new(id)
-      members.select { |m| (stream_id < m[0]) }.map { |m| [m[0].to_s, m[1]] }
+      items = members.select { |m| (stream_id < m[0]) }.map { |m| [m[0].to_s, m[1]] }
+      return items.first(opts['count'].to_i) if opts.key?('count')
+      items
     end
 
     def each

data/lib/mock_redis/stream_methods.rb

@@ -66,14 +66,16 @@ class MockRedis
       end
     end
 
-    # TODO: Implement count and block parameters
-    def xread(keys, ids)
+    def xread(keys, ids, count: nil, block: nil)
+      args = []
+      args += ['COUNT', count] if count
+      args += ['BLOCK', block.to_i] if block
       result = {}
       keys = keys.is_a?(Array) ? keys : [keys]
       ids = ids.is_a?(Array) ? ids : [ids]
       keys.each_with_index do |key, index|
         with_stream_at(key) do |stream|
-          data = stream.read(ids[index])
+          data = stream.read(ids[index], *args)
           result[key] = data unless data.empty?
         end
       end

data/lib/mock_redis/string_methods.rb

@@ -93,6 +93,7 @@ class MockRedis
     def getbit(key, offset)
       assert_stringy(key)
 
+      offset = offset.to_i
       offset_of_byte = offset / 8
       offset_within_byte = offset % 8
 
@@ -201,18 +202,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 +223,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 +248,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.25.0'
+  VERSION = '0.27.3'
 end

data/mock_redis.gemspec

@@ -23,6 +23,8 @@ 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'

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/commands/xread_spec.rb

@@ -47,4 +47,20 @@ describe '#xread(keys, ids)' do
     expect(@redises.xread([@key, @key1], %w[1234567891234-2 1234567891234-1]))
       .to eq({ @key1 => [['1234567891234-2', { 'key1' => 'value2' }]] })
   end
+
+  it 'supports the block parameter' do
+    @redises.xadd(@key, { key: 'value' }, id: '1234567891234-0')
+    expect(@redises.xread(@key, '0-0', block: 1000))
+      .to eq({ @key => [['1234567891234-0', { 'key' => 'value' }]] })
+  end
+
+  it 'limits results with count' do
+    @redises.xadd(@key, { key: 'value' }, id: '1234567891234-0')
+    @redises.xadd(@key, { key: 'value' }, id: '1234567891234-1')
+    @redises.xadd(@key, { key: 'value' }, id: '1234567891234-2')
+    expect(@redises.xread(@key, '0-0', count: 1))
+      .to eq({ @key => [['1234567891234-0', { 'key' => 'value' }]] })
+    expect(@redises.xread(@key, '1234567891234-0', count: 1))
+      .to eq({ @key => [['1234567891234-1', { 'key' => 'value' }]] })
+  end
 end

data/spec/spec_helper.rb

@@ -40,8 +40,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.25.0
+  version: 0.27.3
 platform: ruby
 authors:
 - Shane da Silva
@@ -9,8 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2021-01-10 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
@@ -90,6 +104,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 +141,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 +310,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 +327,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