mock_redis 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9dd8cc0a4f19edccfb6c7b3f1a82724f0da757ad7139f4a576eed1d0b815b8d
-  data.tar.gz: 980f4326447c75afb034b6292baab71bb723ca05689b04aa7ed4933bd8bbf356
+  metadata.gz: dd9fd0d5b4ccad106eee03697d49082baa7e34065ff76f67b7e18da9991847a9
+  data.tar.gz: 11f940cdee40f2646c3e6087faac7ac1c70e0aae5eaff7ddfc8839f0fb50e1b6
 SHA512:
-  metadata.gz: 53a8419ef9f62a4d276993714241f22f9da4087df9ce69158821ea42c735e4fc022f4ab9431bbef268eb562130cc139308fd46ad9eeef8941ef95d9b56afc083
-  data.tar.gz: 266de40ac11c22fa449d709380cec9461a93cd18c6950d31aee538b295c613ab2a0ee2fb828420ff02ea2e2351e92e2d565a9bad630abfd21abf8b8eab7c144d
+  metadata.gz: 347930a11a59575cd3a4bbc48cb689d46d25b27c6cfbdc28c28b6bfdfa1d833c317dd5ce7566ba016aae7b13b909629d078486bd95dee68f4e7e6b5cfc7e1e44
+  data.tar.gz: 689b8dc84b58c38201bf3220641f467cd56b3ef2d6c4efc12829ec08c3a84f6dbc1e2c8207fdb18808c10bdb71f878cc571d21df2548a9d240881fff8b9ddd68

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # MockRedis Changelog
 
+### 0.23.0
+
+* Raise error when `setex` called with negative timeout ([#174](https://github.com/sds/mock_redis/pull/174))
+* Add support for `dump`/`restore` between MockRedis instances ([#176](https://github.com/sds/mock_redis/pull/176))
+* Fix warnings for ZSET methods on Ruby 2.7 ([#177](https://github.com/sds/mock_redis/pull/177))
+* Add support for returning time in pipelines ([#179](https://github.com/sds/mock_redis/pull/179))
+* Fix SET methods to correct set milliseconds with `px` ([#180](https://github.com/sds/mock_redis/pull/180))
+* Add support for unsorted sets within `zinterstore`/`zunionstore`([#182](https://github.com/sds/mock_redis/pull/182))
+
 ### 0.22.0
 
 * Gracefully handle cursors larger than the collection size in scan commands ([#171](https://github.com/sds/mock_redis/pull/171))

data/lib/mock_redis.rb

@@ -64,13 +64,6 @@ class MockRedis
     options[:db]
   end
 
-  def now
-    current_time = options[:time_class].now
-    miliseconds = (current_time.to_r - current_time.to_i) * 1_000
-    [current_time.to_i, miliseconds.to_i]
-  end
-  alias time now
-
   def time_at(timestamp)
     options[:time_class].at(timestamp)
   end

data/lib/mock_redis/database.rb

@@ -124,6 +124,22 @@ class MockRedis
       'OK'
     end
 
+    def dump(key)
+      value = data[key]
+      value ? Marshal.dump(value) : nil
+    end
+
+    def restore(key, ttl, value, replace: false)
+      if !replace && exists(key)
+        raise Redis::CommandError, 'BUSYKEY Target key name already exists.'
+      end
+      data[key] = Marshal.load(value) # rubocop:disable Security/MarshalLoad
+      if ttl > 0
+        pexpire(key, ttl)
+      end
+      'OK'
+    end
+
     def keys(format = '*')
       data.keys.grep(redis_pattern_to_ruby_regex(format))
     end
@@ -143,7 +159,7 @@ class MockRedis
     end
 
     def lastsave
-      @base.now.first
+      now.first
     end
 
     def persist(key)
@@ -224,6 +240,13 @@ class MockRedis
       end
     end
 
+    def now
+      current_time = @base.options[:time_class].now
+      miliseconds = (current_time.to_r - current_time.to_i) * 1_000
+      [current_time.to_i, miliseconds.to_i]
+    end
+    alias time now
+
     def type(key)
       if !exists(key)
         'none'
@@ -328,7 +351,7 @@ class MockRedis
     # This method isn't private, but it also isn't a Redis command, so
     # it doesn't belong up above with all the Redis commands.
     def expire_keys
-      now, miliseconds = @base.now
+      now, miliseconds = self.now
       now_ms = now * 1_000 + miliseconds
 
       to_delete = expire_times.take_while do |(time, _key)|

data/lib/mock_redis/string_methods.rb

@@ -233,7 +233,7 @@ class MockRedis
         if duration == 0
           raise Redis::CommandError, 'ERR invalid expire time in set'
         end
-        expire(key, duration / 1000.0)
+        pexpire(key, duration)
       end
 
       return_true ? true : 'OK'
@@ -313,9 +313,13 @@ class MockRedis
     end
 
     def setex(key, seconds, value)
-      set(key, value)
-      expire(key, seconds)
-      'OK'
+      if seconds <= 0
+        raise Redis::CommandError, 'ERR invalid expire time in setex'
+      else
+        set(key, value)
+        expire(key, seconds)
+        'OK'
+      end
     end
 
     def setnx(key, value)

data/lib/mock_redis/version.rb

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

data/lib/mock_redis/zset_methods.rb

@@ -26,7 +26,7 @@ class MockRedis
     end
 
     def zadd_one_member(key, score, member, zadd_options = {})
-      assert_scorey(score) unless score =~ /(\+|\-)inf/
+      assert_scorey(score) unless score.to_s =~ /(\+|\-)inf/
 
       with_zset_at(key) do |zset|
         if zadd_options[:incr]
@@ -282,7 +282,7 @@ class MockRedis
                      raise Redis::CommandError, 'ERR syntax error'
                    end
 
-      with_zsets_at(*keys) do |*zsets|
+      with_zsets_at(*keys, coercible: true) do |*zsets|
         zsets.zip(weights).map do |(zset, weight)|
           zset.reduce(Zset.new) do |acc, (score, member)|
             acc.add(score * weight, member)
@@ -293,16 +293,30 @@ class MockRedis
       end
     end
 
-    def with_zset_at(key, &blk)
-      with_thing_at(key, :assert_zsety, proc { Zset.new }, &blk)
+    def coerce_to_zset(set)
+      zset = Zset.new
+      set.each do |member|
+        zset.add(1.0, member)
+      end
+      zset
     end
 
-    def with_zsets_at(*keys, &blk)
+    def with_zset_at(key, coercible: false, &blk)
+      if coercible
+        with_thing_at(key, :assert_coercible_zsety, proc { Zset.new }) do |value|
+          blk.call value.is_a?(Set) ? coerce_to_zset(value) : value
+        end
+      else
+        with_thing_at(key, :assert_zsety, proc { Zset.new }, &blk)
+      end
+    end
+
+    def with_zsets_at(*keys, coercible: false, &blk)
       if keys.length == 1
-        with_zset_at(keys.first, &blk)
+        with_zset_at(keys.first, coercible: coercible, &blk)
       else
-        with_zset_at(keys.first) do |set|
-          with_zsets_at(*(keys[1..-1])) do |*sets|
+        with_zset_at(keys.first, coercible: coercible) do |set|
+          with_zsets_at(*(keys[1..-1]), coercible: coercible) do |*sets|
             yield(*([set] + sets))
           end
         end
@@ -313,6 +327,10 @@ class MockRedis
       data[key].nil? || data[key].is_a?(Zset)
     end
 
+    def coercible_zsety?(key)
+      zsety?(key) || data[key].is_a?(Set)
+    end
+
     def assert_zsety(key)
       unless zsety?(key)
         raise Redis::CommandError,
@@ -320,13 +338,20 @@ class MockRedis
       end
     end
 
+    def assert_coercible_zsety(key)
+      unless coercible_zsety?(key)
+        raise Redis::CommandError,
+          'WRONGTYPE Operation against a key holding the wrong kind of value'
+      end
+    end
+
     def looks_like_float?(x)
       # ugh, exceptions for flow control.
       !!Float(x) rescue false
     end
 
     def assert_scorey(value, message = 'ERR value is not a valid float')
-      return if value =~ /\(?(\-|\+)inf/
+      return if value.to_s =~ /\(?(\-|\+)inf/
 
       value = $1 if value.to_s =~ /\((.*)/
       unless looks_like_float?(value)

data/spec/commands/dump_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe '#dump(key)' do
+  before do
+    @key = 'mock-redis-test:45794'
+    # These are mock-only, since our dump/restore implementations
+    # aren't compatible with real redis.
+    @mock = @redises.mock
+  end
+
+  it 'returns nil for keys that do not exist' do
+    @mock.dump(@key).should be_nil
+  end
+
+  it 'returns a serialized value for keys that do exist' do
+    @mock.set(@key, '2')
+    @mock.dump(@key).should == Marshal.dump('2')
+  end
+end

data/spec/commands/pipelined_spec.rb

@@ -66,6 +66,26 @@ describe '#pipelined' do
     end
   end
 
+  context 'with redis time return value' do
+    let(:time_stub) { double 'Time', :now => Time.new(2019, 1, 2, 3, 4, 6, '+00:00') }
+    let(:options)   { { :time_class => time_stub } }
+
+    subject { MockRedis.new(options) }
+
+    it 'returns the time value' do
+      subject.set('foo', 'bar')
+
+      results = subject.pipelined do
+        subject.get('foo')
+        subject.host # defined on MockRedis, so not captured
+        subject.time
+        subject.echo('baz')
+      end
+
+      expect(results).to eq(['bar', [1_546_398_246, 0], 'baz'])
+    end
+  end
+
   context 'with nested pipelines' do
     let(:key1)   { 'hello' }
     let(:key2)   { 'world' }

data/spec/commands/restore_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe '#restore(key, ttl, value)' do
+  before do
+    @key = 'mock-redis-test:45794'
+    @src = MockRedis.new
+    @src.set(@key, '123')
+    @dumped_value = @src.dump(@key)
+    @dst = MockRedis.new
+    @now = Time.now.round
+    Time.stub(:now).and_return(@now)
+  end
+
+  it 'allows dump/restoring values between two redis instances' do
+    expect(@dst.restore(@key, 0, @dumped_value)).to eq('OK')
+    expect(@dst.get(@key)).to eq('123')
+    expect(@dst.pttl(@key)).to eq(-1)
+  end
+
+  context 'when the key being restored to already exists' do
+    before do
+      @dst.set(@key, '456')
+    end
+
+    it 'raises an error by default' do
+      expect { @dst.restore(@key, 0, @dumped_value) }.to raise_error(Redis::CommandError)
+      expect(@dst.get(@key)).to eq('456')
+    end
+
+    it 'allows replacing the key if replace==true' do
+      expect(@dst.restore(@key, 0, @dumped_value, replace: true)).to eq('OK')
+      expect(@dst.get(@key)).to eq('123')
+    end
+  end
+
+  it 'sets ttl in ms' do
+    @dst.restore(@key, 500, @dumped_value)
+    expect(@dst.pttl(@key)).to eq(500)
+  end
+
+  it 'can dump/restore more complex data types' do
+    key = 'a_hash'
+    @src.mapped_hmset(key, foo: 'bar')
+    @dst.restore(key, 0, @src.dump(key))
+    expect(@dst.hgetall(key)).to eq('foo' => 'bar')
+  end
+end

data/spec/commands/set_spec.rb

@@ -59,9 +59,11 @@ describe '#set(key, value)' do
 
       it 'accepts PX milliseconds' do
         key = 'mock-redis-test'
-        @mock.set(key, 1, px: 1000).should == 'OK'
+        @mock.set(key, 1, px: 500).should == 'OK'
         @mock.get(key).should_not be_nil
-        Time.stub(:now).and_return(@now + 2)
+        Time.stub(:now).and_return(@now + 300 / 1000.to_f)
+        @mock.get(key).should_not be_nil
+        Time.stub(:now).and_return(@now + 600 / 1000.to_f)
         @mock.get(key).should be_nil
       end
     end

data/spec/commands/setex_spec.rb

@@ -19,4 +19,20 @@ describe '#setex(key, seconds, value)' do
     @redises.real.ttl(@key).should > 0
     @redises.mock.ttl(@key).should > 0
   end
+
+  context 'when expiration time is zero' do
+    it 'raises Redis::CommandError' do
+      expect do
+        @redises.setex(@key, 0, 'value')
+      end.to raise_error(Redis::CommandError, 'ERR invalid expire time in setex')
+    end
+  end
+
+  context 'when expiration time is negative' do
+    it 'raises Redis::CommandError' do
+      expect do
+        @redises.setex(@key, -2, 'value')
+      end.to raise_error(Redis::CommandError, 'ERR invalid expire time in setex')
+    end
+  end
 end

data/spec/commands/zinterstore_spec.rb

@@ -42,6 +42,40 @@ describe '#zinterstore(destination, keys, [:weights => [w,w,], [:aggregate => :s
     end.should raise_error(Redis::CommandError)
   end
 
+  context 'when used with a set' do
+    before do
+      @primes_text = 'mock-redis-test:zinterstore:primes-text'
+
+      @redises.sadd(@primes_text, 'two')
+      @redises.sadd(@primes_text, 'three')
+      @redises.sadd(@primes_text, 'five')
+      @redises.sadd(@primes_text, 'seven')
+    end
+
+    it 'returns the number of elements in the new set' do
+      @redises.zinterstore(@dest, [@odds, @primes_text]).should == 3
+    end
+
+    it 'sums the scores, substituting 1.0 for set values' do
+      @redises.zinterstore(@dest, [@odds, @primes_text])
+      @redises.zrange(@dest, 0, -1, :with_scores => true).should ==
+        [['three', 4.0], ['five', 6.0], ['seven', 8.0]]
+    end
+  end
+
+  context 'when used with a non-coercible structure' do
+    before do
+      @non_set = 'mock-redis-test:zinterstore:non-set'
+
+      @redises.set(@non_set, 'one')
+    end
+    it 'raises an error for wrong value type' do
+      lambda do
+        @redises.zinterstore(@dest, [@odds, @non_set])
+      end.should raise_error(Redis::CommandError)
+    end
+  end
+
   context 'the :weights argument' do
     it 'multiplies the scores by the weights while aggregating' do
       @redises.zinterstore(@dest, [@odds, @primes], :weights => [2, 3])

data/spec/commands/zunionstore_spec.rb

@@ -41,6 +41,39 @@ describe '#zunionstore(destination, keys, [:weights => [w,w,], [:aggregate => :s
     end.should raise_error(Redis::CommandError)
   end
 
+  context 'when used with a set' do
+    before do
+      @set4 = 'mock-redis-test:zunionstore4'
+
+      @redises.sadd(@set4, 'two')
+      @redises.sadd(@set4, 'three')
+      @redises.sadd(@set4, 'four')
+    end
+
+    it 'returns the number of elements in the new set' do
+      @redises.zunionstore(@dest, [@set3, @set4]).should == 4
+    end
+
+    it 'sums the scores, substituting 1.0 for set values' do
+      @redises.zunionstore(@dest, [@set3, @set4])
+      @redises.zrange(@dest, 0, -1, :with_scores => true).should ==
+        [['four', 1.0], ['one', 1.0], ['two', 3.0], ['three', 4.0]]
+    end
+  end
+
+  context 'when used with a non-coercible structure' do
+    before do
+      @non_set = 'mock-redis-test:zunionstore4'
+
+      @redises.set(@non_set, 'one')
+    end
+    it 'raises an error for wrong value type' do
+      lambda do
+        @redises.zunionstore(@dest, [@set1, @non_set])
+      end.should raise_error(Redis::CommandError)
+    end
+  end
+
   context 'the :weights argument' do
     it 'multiplies the scores by the weights while aggregating' do
       @redises.zunionstore(@dest, [@set1, @set2, @set3], :weights => [2, 3, 5])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mock_redis
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Shane da Silva
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -131,6 +131,7 @@ files:
 - spec/commands/decrby_spec.rb
 - spec/commands/del_spec.rb
 - spec/commands/disconnect_spec.rb
+- spec/commands/dump_spec.rb
 - spec/commands/echo_spec.rb
 - spec/commands/eval_spec.rb
 - spec/commands/evalsha_spec.rb
@@ -198,6 +199,7 @@ files:
 - spec/commands/randomkey_spec.rb
 - spec/commands/rename_spec.rb
 - spec/commands/renamenx_spec.rb
+- spec/commands/restore_spec.rb
 - spec/commands/rpop_spec.rb
 - spec/commands/rpoplpush_spec.rb
 - spec/commands/rpush_spec.rb
@@ -291,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.1
 signing_key: 
 specification_version: 4
 summary: Redis mock that just lives in memory; useful for testing.
@@ -313,6 +315,7 @@ test_files:
 - spec/commands/decrby_spec.rb
 - spec/commands/del_spec.rb
 - spec/commands/disconnect_spec.rb
+- spec/commands/dump_spec.rb
 - spec/commands/echo_spec.rb
 - spec/commands/eval_spec.rb
 - spec/commands/evalsha_spec.rb
@@ -380,6 +383,7 @@ test_files:
 - spec/commands/randomkey_spec.rb
 - spec/commands/rename_spec.rb
 - spec/commands/renamenx_spec.rb
+- spec/commands/restore_spec.rb
 - spec/commands/rpop_spec.rb
 - spec/commands/rpoplpush_spec.rb
 - spec/commands/rpush_spec.rb