mock_redis 0.24.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d399a835c1f41a8eb0e5fc42a366e64fc399b5d76ebc23f0d40f73c9db4888e
-  data.tar.gz: 1442920d2b12e46d2d45ff9d8854e4ccf3665b5a5f9a4aef6d29669c9110d023
+  metadata.gz: e4a2d7e6a155059cb97120f7f95c1e992a87a3933be5fe337a443dc0a9ac30df
+  data.tar.gz: 135172a723e9d5bfb058eec85863387093d56e3a6d7729f28da425f2b239e4bb
 SHA512:
-  metadata.gz: 62b218977c75b5c7ffc80e3762bf0f7791c8f17dfe4f875a8874118583124736ab782e1c985dc92363d62e4366170306d9d0211b19cead2982f16cbff2c13557
-  data.tar.gz: 97b5eeb1c20e597d2ce35e9d109f62aaf3a2271f42c86515be1d7e0d627ad628173aee7d74062b119cf954538116f0b199d06eee5d1fe71b552dea543859a69e
+  metadata.gz: 1e1b5cba39d01b11b2c85442c5d9485285bf661316e5196448484bc78dd9d866c3829648cd547ac0996d454f113d054c3bc43728f917740870f5fe191c97b15c
+  data.tar.gz: bf5d20de1111be19c03cacb2639f303d0ced578656bfc5b4dae4e8cd6e28991be003e7a20702ab6825526fbee6f91ebcd676fbb27c9010792abd37a2e7eab218

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # MockRedis Changelog
 
+### 0.25.0
+
+* Add support for `xread` command ([#190](https://github.com/sds/mock_redis/pull/190))
+* Fix `mget` to raise error when passing empty array ([#191](https://github.com/sds/mock_redis/pull/191))
+* Fix `xadd` when `maxlen` is zero ([#192](https://github.com/sds/mock_redis/pull/192))
+
 ### 0.24.0
 
 * Fix handling of blocks within `multi` blocks ([#185](https://github.com/sds/mock_redis/pull/185))

data/lib/mock_redis/stream.rb

@@ -23,14 +23,29 @@ class MockRedis
 
     def add(id, values)
       @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'
+      end
       members.add [@last_id, Hash[values.map { |k, v| [k.to_s, v.to_s] }]]
       @last_id.to_s
     end
 
     def trim(count)
       deleted = @members.size - count
-      @members = @members.to_a[-count..-1].to_set
-      deleted
+      if deleted > 0
+        @members = if count == 0
+                     Set.new
+                   else
+                     @members.to_a[-count..-1].to_set
+                   end
+        deleted
+      else
+        0
+      end
     end
 
     def range(start, finish, reversed, *opts_in)
@@ -45,6 +60,11 @@ class MockRedis
       items
     end
 
+    def read(id)
+      stream_id = MockRedis::Stream::Id.new(id)
+      members.select { |m| (stream_id < m[0]) }.map { |m| [m[0].to_s, m[1]] }
+    end
+
     def each
       members.each { |m| yield m }
     end

data/lib/mock_redis/stream/id.rb

@@ -31,13 +31,6 @@ class MockRedis
             @timestamp = id
           end
           @sequence = @sequence.nil? ? sequence : @sequence.to_i
-          if @timestamp == 0 && @sequence == 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'
-          end
           if self <= min
             raise Redis::CommandError,
                   'ERR The ID specified in XADD is equal or smaller than ' \

data/lib/mock_redis/stream_methods.rb

@@ -4,7 +4,6 @@ require 'mock_redis/stream'
 
 # TODO: Implement the following commands
 #
-#   * xread
 #   * xgroup
 #   * xreadgroup
 #   * xack
@@ -67,6 +66,20 @@ class MockRedis
       end
     end
 
+    # TODO: Implement count and block parameters
+    def xread(keys, ids)
+      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])
+          result[key] = data unless data.empty?
+        end
+      end
+      result
+    end
+
     private
 
     def with_stream_at(key, &blk)

data/lib/mock_redis/string_methods.rb

@@ -154,9 +154,10 @@ class MockRedis
     end
 
     def mget(*keys)
+      keys.flatten!
+
       assert_has_args(keys, 'mget')
 
-      keys.flatten!
       keys.map do |key|
         get(key) if stringy?(key)
       end

data/lib/mock_redis/utility_methods.rb

@@ -18,7 +18,7 @@ class MockRedis
     end
 
     def clean_up_empties_at(key)
-      if data[key]&.empty? && data[key] != ''
+      if data[key]&.empty? && data[key] != '' && !data[key].is_a?(Stream)
         del(key)
       end
     end

data/lib/mock_redis/version.rb

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

data/spec/commands/del_spec.rb

@@ -1,6 +1,14 @@
 require 'spec_helper'
 
 describe '#del(key [, key, ...])' do
+  before :all do
+    sleep 1 - (Time.now.to_f % 1)
+  end
+
+  before :each do
+    @redises._gsub(/\d{3}-\d/, '...-.')
+  end
+
   it 'returns the number of keys deleted' do
     @redises.set('mock-redis-test:1', 1)
     @redises.set('mock-redis-test:2', 1)
@@ -32,4 +40,11 @@ describe '#del(key [, key, ...])' do
   it 'raises an error if an empty array is given' do
     expect { @redises.del [] }.to raise_error Redis::CommandError
   end
+
+  it 'removes a stream key' do
+    @redises.xadd('mock-redis-stream', { key: 'value' }, maxlen: 0)
+    expect(@redises.exists?('mock-redis-stream')).to eq true
+    @redises.del('mock-redis-stream')
+    expect(@redises.exists?('mock-redis-stream')).to eq false
+  end
 end

data/spec/commands/mget_spec.rb

@@ -49,5 +49,11 @@ describe '#mget(key [, key, ...])' do
         @redises.mget
       end.should raise_error(Redis::CommandError)
     end
+
+    it 'raises an error if you pass it empty array' do
+      lambda do
+        @redises.mget([])
+      end.should raise_error(Redis::CommandError)
+    end
   end
 end

data/spec/commands/xadd_spec.rb

@@ -101,4 +101,22 @@ describe '#xadd("mystream", { f1: "v1", f2: "v2" }, id: "0-0", maxlen: 1000, app
       ]
     )
   end
+
+  it 'supports a maxlen greater than the current size' do
+    @redises.xadd(@key, { key1: 'value1' }, id: '1234567891234-0')
+    @redises.xadd(@key, { key2: 'value2' }, id: '1234567891245-0', maxlen: 1000)
+    expect(@redises.xrange(@key, '-', '+')).to eq(
+      [
+        ['1234567891234-0', { 'key1' => 'value1' }],
+        ['1234567891245-0', { 'key2' => 'value2' }],
+      ]
+    )
+  end
+
+  it 'creates an empty stream with maxlen of 0' do
+    @redises.xadd(@key, { key: 'value' }, maxlen: 0)
+    expect(@redises.xlen(@key)).to eq 0
+    expect(@redises.xrange(@key, '-', '+')).to eq([])
+    expect(@redises.exists?(@key)).to eq true
+  end
 end

data/spec/commands/xrange_spec.rb

@@ -54,6 +54,19 @@ describe '#xrange("mystream", first: "0-1", last: "0-3", count: 10)' do
       )
     end
 
+    it 'returns all entries with a lower limit of 0-0' do
+      expect(@redises.xrange(@key, '0-0', '+')).to eq(
+        [
+          ['1234567891234-0', { 'key1' => 'value1' }],
+          ['1234567891245-0', { 'key2' => 'value2' }],
+          ['1234567891245-1', { 'key3' => 'value3' }],
+          ['1234567891278-0', { 'key4' => 'value4' }],
+          ['1234567891278-1', { 'key5' => 'value5' }],
+          ['1234567891299-0', { 'key6' => 'value6' }]
+        ]
+      )
+    end
+
     it 'returns entries with an upper limit' do
       expect(@redises.xrange(@key, '-', '1234567891285-0')).to eq(
         [

data/spec/commands/xread_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe '#xread(keys, ids)' do
+  before :all do
+    sleep 1 - (Time.now.to_f % 1)
+    @key = 'mock-redis-test:xread'
+    @key1 = 'mock-redis-test:xread1'
+  end
+
+  it 'reads a single entry' do
+    @redises.xadd(@key, { key: 'value' }, id: '1234567891234-0')
+    expect(@redises.xread(@key, '0-0'))
+      .to eq({ @key => [['1234567891234-0', { 'key' => 'value' }]] })
+  end
+
+  it 'reads multiple entries from the beginning of the stream' do
+    @redises.xadd(@key, { key0: 'value0' }, id: '1234567891234-0')
+    @redises.xadd(@key, { key1: 'value1' }, id: '1234567891234-1')
+    expect(@redises.xread(@key, '0-0'))
+      .to eq({ @key => [['1234567891234-0', { 'key0' => 'value0' }],
+                        ['1234567891234-1', { 'key1' => 'value1' }]] })
+  end
+
+  it 'reads entries greater than the ID passed' do
+    @redises.xadd(@key, { key0: 'value0' }, id: '1234567891234-0')
+    @redises.xadd(@key, { key1: 'value1' }, id: '1234567891234-1')
+    expect(@redises.xread(@key, '1234567891234-0'))
+      .to eq({ @key => [['1234567891234-1', { 'key1' => 'value1' }]] })
+  end
+
+  it 'reads from multiple streams' do
+    @redises.xadd(@key, { key: 'value' }, id: '1234567891234-0')
+    @redises.xadd(@key1, { key1: 'value1' }, id: '1234567891234-0')
+    expect(@redises.xread([@key, @key1], %w[0-0 0-0]))
+      .to eq({ @key => [['1234567891234-0', { 'key' => 'value' }]],
+               @key1 => [['1234567891234-0', { 'key1' => 'value1' }]] })
+  end
+
+  it 'reads from multiple streams at the given IDs' do
+    @redises.xadd(@key, { key: 'value0' }, id: '1234567891234-0')
+    @redises.xadd(@key, { key: 'value1' }, id: '1234567891234-1')
+    @redises.xadd(@key, { key: 'value2' }, id: '1234567891234-2')
+    @redises.xadd(@key1, { key1: 'value0' }, id: '1234567891234-0')
+    @redises.xadd(@key1, { key1: 'value1' }, id: '1234567891234-1')
+    @redises.xadd(@key1, { key1: 'value2' }, id: '1234567891234-2')
+    # The first stream won't return anything since we specify the last ID
+    expect(@redises.xread([@key, @key1], %w[1234567891234-2 1234567891234-1]))
+      .to eq({ @key1 => [['1234567891234-2', { 'key1' => 'value2' }]] })
+  end
+end

data/spec/commands/xtrim_spec.rb

@@ -16,6 +16,12 @@ describe '#xtrim("mystream", 1000, approximate: true)' do
     expect(@redises.xtrim(@key, 4)).to eq 2
   end
 
+  it 'returns 0 if count is greater than size' do
+    initial = @redises.xrange(@key, '-', '+')
+    expect(@redises.xtrim(@key, 1000)).to eq 0
+    expect(@redises.xrange(@key, '-', '+')).to eql(initial)
+  end
+
   it 'deletes the oldes elements' do
     @redises.xtrim(@key, 4)
     expect(@redises.xrange(@key, '-', '+')).to eq(

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mock_redis
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Shane da Silva
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -241,6 +241,7 @@ files:
 - spec/commands/xadd_spec.rb
 - spec/commands/xlen_spec.rb
 - spec/commands/xrange_spec.rb
+- spec/commands/xread_spec.rb
 - spec/commands/xrevrange_spec.rb
 - spec/commands/xtrim_spec.rb
 - spec/commands/zadd_spec.rb
@@ -425,6 +426,7 @@ test_files:
 - spec/commands/xadd_spec.rb
 - spec/commands/xlen_spec.rb
 - spec/commands/xrange_spec.rb
+- spec/commands/xread_spec.rb
 - spec/commands/xrevrange_spec.rb
 - spec/commands/xtrim_spec.rb
 - spec/commands/zadd_spec.rb