mock_redis 0.21.0 → 0.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4443d90955b31a149afd0c66972a06993bf9b01f6bd826276c2d60edb49b3141
-  data.tar.gz: 2d096c0b7438b81720adcd50ecb36a8fa19df7a05c822ed4beee6d06d459f1b4
+  metadata.gz: d9dd8cc0a4f19edccfb6c7b3f1a82724f0da757ad7139f4a576eed1d0b815b8d
+  data.tar.gz: 980f4326447c75afb034b6292baab71bb723ca05689b04aa7ed4933bd8bbf356
 SHA512:
-  metadata.gz: bdcb30c9756e77fcc4f857f0bdaa01d73faa28b8ea7cc37aa669c0f5cf2e2967d3e216a32ff50c7c78f6945b313f8525073060daf9f980187d566202f3dbcda2
-  data.tar.gz: 17502b628f1a5a62fa2046b529ef0178d8b84453d3a8b83441e3f2eef72282d45a79e60bee34e9a871ea553deb08c1c286b915d4b2c6ffe52fab3e6e32a6cc56
+  metadata.gz: 53a8419ef9f62a4d276993714241f22f9da4087df9ce69158821ea42c735e4fc022f4ab9431bbef268eb562130cc139308fd46ad9eeef8941ef95d9b56afc083
+  data.tar.gz: 266de40ac11c22fa449d709380cec9461a93cd18c6950d31aee538b295c613ab2a0ee2fb828420ff02ea2e2351e92e2d565a9bad630abfd21abf8b8eab7c144d

data/.travis.yml

@@ -17,9 +17,9 @@ before_install:
   - echo PING | nc localhost 6379
 
 rvm:
-  - 2.4.6
-  - 2.5.5
-  - 2.6.3
+  - 2.4
+  - 2.5
+  - 2.6
 
 before_script:
   - git config --local user.email "travis@travis.ci"

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # MockRedis Changelog
 
+### 0.22.0
+
+* Gracefully handle cursors larger than the collection size in scan commands ([#171](https://github.com/sds/mock_redis/pull/171))
+* Add `zpopmin` and `zpopmax` commands ([#172](https://github.com/sds/mock_redis/pull/172))
+* Fix `hmset` to support array arguments ([#173](https://github.com/sds/mock_redis/pull/173))
+* Fix `hmset` to always treat keys as strings ([#173](https://github.com/sds/mock_redis/pull/173))
+* Remove unnecessary dependency on `rake` gem
+
 ### 0.21.0
 
 * Fix behavior of `time` to return array of two integers ([#161](https://github.com/sds/mock_redis/pull/161))

data/LICENSE.md

@@ -0,0 +1,21 @@
+MockRedis released under the MIT license.
+
+> Copyright (c) Shane da Silva. http://shane.io
+>
+> Permission is hereby granted, free of charge, to any person obtaining a copy
+> of this software and associated documentation files (the "Software"), to deal
+> in the Software without restriction, including without limitation the rights
+> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+> copies of the Software, and to permit persons to whom the Software is
+> furnished to do so, subject to the following conditions:
+>
+> The above copyright notice and this permission notice shall be included in
+> all copies or substantial portions of the Software.
+>
+> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+> SOFTWARE.

data/README.md

@@ -8,11 +8,20 @@ MockRedis provides the same interface as `redis-rb`, but it stores its
 data in memory instead of talking to a Redis server. It is intended
 for use in tests.
 
-The current implementation is tested against *Redis 4*. Older versions
-of Redis may return different results or not support some commands.
+## Requirements
+
+* Ruby 2.4+
+
+The current implementation is tested against **Redis 5**. Older versions may work, but can also return different results or not support some commands.
 
 ## Getting Started
 
+Install the gem:
+
+```bash
+gem install mock_redis
+```
+
 It's as easy as `require 'mock_redis'; mr = MockRedis.new`. Then you can
 call the same methods on it as you can call on a real `Redis` object.
 
@@ -90,17 +99,32 @@ please submit a pull request with your (tested!) implementation.
 * `#config(:get|:set|:resetstat)` isn't done. They can just return
   canned values.
 
-## Compatibility
+## Running tests
+
+We recommend running Redis within a Docker container to make development as simple as possible, but as long as you have a Redis instance listening on `localhost:6379` you should be good to go.
+
+1. Start Redis.
+   ```bash
+   docker run --rm -p 6379:6379 redis
+   ```
+2. Install dependencies.
+   ```bash
+   bundle install
+   ```
+3. Run tests.
+   ```bash
+   bundle exec rspec
+   ```
+
+These tests were written with Redis running on `localhost` without any
+passwords required. If you're using a different version of Redis, you
+may see failures due to error message text being different and other
+breaking changes over time.
+
+## Changelog
 
-As of version `0.19.0`, Ruby 2.2 and above are supported. For
-older versions of Ruby, use `0.18.0` or older.
+If you're interested in seeing the changes and bug fixes between each version of `mock_redis`, read the [MockRedis Changelog](CHANGELOG.md).
 
-## Running the Tests
+## License
 
-If you want to work on this, you'll probably want to run the
-tests. (Just kidding! There's no probably about it.) These tests were
-written with Redis running on `localhost` without any passwords
-required. If you're using a different version of Redis, you may see
-failures due to error message text being different. If you're running
-a really old version of Redis, you'll definitely see failures due to
-stuff that doesn't work!
+This project is released under the [MIT license](LICENSE.md).

data/lib/mock_redis/hash_methods.rb

@@ -84,10 +84,17 @@ class MockRedis
     end
 
     def hmset(key, *kvpairs)
+      if key.is_a? Array
+        err_msg = 'ERR wrong number of arguments for \'hmset\' command'
+        kvpairs = key[1..-1]
+        key = key[0]
+      end
+
       kvpairs.flatten!
       assert_has_args(kvpairs, 'hmset')
+
       if kvpairs.length.odd?
-        raise Redis::CommandError, 'ERR wrong number of arguments for HMSET'
+        raise Redis::CommandError, err_msg || 'ERR wrong number of arguments for HMSET'
       end
 
       kvpairs.each_slice(2) do |(k, v)|
@@ -143,7 +150,7 @@ class MockRedis
     private
 
     def with_hash_at(key, &blk)
-      with_thing_at(key, :assert_hashy, proc { {} }, &blk)
+      with_thing_at(key.to_s, :assert_hashy, proc { {} }, &blk)
     end
 
     def hashy?(key)

data/lib/mock_redis/utility_methods.rb

@@ -28,12 +28,15 @@ class MockRedis
       cursor = cursor.to_i
       match = opts[:match] || '*'
       key = opts[:key] || lambda { |x| x }
+      filtered_values = []
 
       limit = cursor + count
       next_cursor = limit >= values.length ? '0' : limit.to_s
 
-      filtered_values = values[cursor...limit].select do |val|
-        redis_pattern_to_ruby_regex(match).match(key.call(val))
+      unless values[cursor...limit].nil?
+        filtered_values = values[cursor...limit].select do |val|
+          redis_pattern_to_ruby_regex(match).match(key.call(val))
+        end
       end
 
       [next_cursor, filtered_values]

data/lib/mock_redis/version.rb

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

data/lib/mock_redis/zset_methods.rb

@@ -155,6 +155,24 @@ class MockRedis
       retval
     end
 
+    def zpopmin(key, count = 1)
+      with_zset_at(key) do |z|
+        pairs = z.sorted.first(count)
+        pairs.each { |pair| z.delete?(pair.last) }
+        retval = to_response(pairs, with_scores: true)
+        count == 1 ? retval.first : retval
+      end
+    end
+
+    def zpopmax(key, count = 1)
+      with_zset_at(key) do |z|
+        pairs = z.sorted.reverse.first(count)
+        pairs.each { |pair| z.delete?(pair.last) }
+        retval = to_response(pairs, with_scores: true)
+        count == 1 ? retval.first : retval
+      end
+    end
+
     def zrevrange(key, start, stop, options = {})
       with_zset_at(key) do |z|
         to_response(z.sorted.reverse[start..stop] || [], options)

data/mock_redis.gemspec

@@ -23,8 +23,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.4'
 
-  s.add_development_dependency 'rake', '>= 10', '< 12'
-  s.add_development_dependency 'redis', '~>4.1.0'
+  s.add_development_dependency 'redis', '~> 4.1.0'
   s.add_development_dependency 'rspec', '~> 3.0'
   s.add_development_dependency 'rspec-its', '~> 1.0'
   s.add_development_dependency 'timecop', '~> 0.9.1'

data/spec/commands/hmset_spec.rb

@@ -39,5 +39,31 @@ describe '#hmset(key, field, value [, field, value ...])' do
     end.should raise_error(Redis::CommandError)
   end
 
+  # The following tests address https://github.com/sds/mock_redis/issues/170
+  context 'keys are stored as strings' do
+    before do
+      @redises.hmset(1, :foo, :bar)
+      @redises.hmset(:a_sym, :boo, :bas)
+    end
+
+    it { expect(@redises.hgetall('1')).to eq @redises.hgetall(1) }
+    it { expect(@redises.hgetall('a_sym')).to eq @redises.hgetall(:a_sym) }
+    it { expect(@redises.del('1')).to eq 1 }
+    it { expect(@redises.del(1)).to eq 1 }
+    it { expect(@redises.del('a_sym')).to eq 1 }
+    it { expect(@redises.del(:a_sym)).to eq 1 }
+
+    after do
+      @redises.del(1)
+      @redises.del(:a_sym)
+    end
+  end
+
+  # The following tests address https://github.com/sds/mock_redis/issues/134
+  context 'hmset accepts an array as its only argument' do
+    it { expect(@redises.hmset([@key, :bar, :bas])).to eq 'OK' }
+    it { lambda { @redises.hmset([:foo, :bar]) }.should raise_error(Redis::CommandError) }
+  end
+
   it_should_behave_like 'a hash-only command'
 end

data/spec/commands/scan_spec.rb

@@ -42,6 +42,15 @@ describe '#scan' do
       end
     end
 
+    context 'when cursor is greater than collection size' do
+      let(:collection) { Array.new(count) { |i| "mock:key#{i}" } }
+      let(:expected) { ['0', []] }
+
+      it 'returns a 0 cursor and empty collection' do
+        expect(subject.scan(20, count: count, match: match)).to eq(expected)
+      end
+    end
+
     context 'when giving a custom match filter' do
       let(:match) { 'mock:key*' }
       let(:collection) { %w[mock:key mock:key2 mock:otherkey] }

data/spec/commands/zpopmax_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe '#zpopmax(key, count)' do
+  before(:each) do
+    @key = 'mock-redis-test:zpopmax'
+    @redises.del(@key)
+    @redises.zadd(@key, 1, 'one')
+    @redises.zadd(@key, 2, 'two')
+    @redises.zadd(@key, 3, 'three')
+  end
+
+  context 'when count is unspecified' do
+    it 'returns nil if the set does not exist' do
+      @redises.zpopmax('does-not-exist').should nil
+    end
+
+    it 'returns the highest ranked element' do
+      @redises.zpopmax(@key).should == ['three', 3]
+      @redises.zcard(@key).should == 2
+    end
+  end
+
+  context 'when count is 1' do
+    let(:count) { 1 }
+
+    it 'returns nil if the set does not exist' do
+      @redises.zpopmax('does-not-exist', count).should nil
+    end
+
+    it 'returns the highest ranked element' do
+      @redises.zpopmax(@key, count).should == ['three', 3]
+      @redises.zcard(@key).should == 2
+    end
+  end
+
+  context 'when count is greater than 1' do
+    let(:count) { 2 }
+
+    it 'returns empty array if the set does not exist' do
+      @redises.zpopmax('does-not-exist', count).should == []
+    end
+
+    it 'returns the highest ranked elements' do
+      @redises.zpopmax(@key, count).should == [['three', 3], ['two', 2]]
+      @redises.zcard(@key).should == 1
+    end
+  end
+
+  context 'when count is greater than the size of the set' do
+    let(:count) { 4 }
+
+    it 'returns the entire set' do
+      before = @redises.zrange(@key, 0, count, with_scores: true).reverse
+      @redises.zpopmax(@key, count).should == before
+      @redises.zcard(@key).should == 0
+    end
+  end
+
+  it_should_behave_like 'a zset-only command'
+end

data/spec/commands/zpopmin_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe '#zpopmin(key, count)' do
+  before(:each) do
+    @key = 'mock-redis-test:zpopmin'
+    @redises.del(@key)
+    @redises.zadd(@key, 1, 'one')
+    @redises.zadd(@key, 2, 'two')
+    @redises.zadd(@key, 3, 'three')
+  end
+
+  context 'when count is unspecified' do
+    it 'returns nil if the set does not exist' do
+      @redises.zpopmin('does-not-exist').should nil
+    end
+
+    it 'returns the lowest ranked element' do
+      @redises.zpopmin(@key).should == ['one', 1]
+      @redises.zcard(@key).should == 2
+    end
+  end
+
+  context 'when count is 1' do
+    let(:count) { 1 }
+
+    it 'returns nil if the set does not exist' do
+      @redises.zpopmin('does-not-exist', count).should nil
+    end
+
+    it 'returns the lowest ranked element' do
+      @redises.zpopmin(@key, count).should == ['one', 1]
+      @redises.zcard(@key).should == 2
+    end
+  end
+
+  context 'when count is greater than 1' do
+    let(:count) { 2 }
+
+    it 'returns empty array if the set does not exist' do
+      @redises.zpopmin('does-not-exist', count).should == []
+    end
+
+    it 'returns the lowest ranked elements' do
+      @redises.zpopmin(@key, count).should == [['one', 1], ['two', 2]]
+      @redises.zcard(@key).should == 1
+    end
+  end
+
+  context 'when count is greater than the size of the set' do
+    let(:count) { 4 }
+
+    it 'returns the entire set' do
+      before = @redises.zrange(@key, 0, count, with_scores: true)
+      @redises.zpopmin(@key, count).should == before
+      @redises.zcard(@key).should == 0
+    end
+  end
+
+  it_should_behave_like 'a zset-only command'
+end

data/spec/spec_helper.rb

@@ -27,7 +27,7 @@ module TypeCheckingHelper
   end
 
   def args_for_method(method)
-    return [] if method.to_s == 'spop'
+    return [] if %w[spop zpopmin zpopmax].include?(method.to_s)
     method_arity = @redises.real.method(method).arity
     if method_arity < 0 # -1 comes from def foo(*args)
       [1, 2] # probably good enough

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mock_redis
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.0
 platform: ruby
 authors:
 - Shane da Silva
@@ -9,28 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-26 00:00:00.000000000 Z
+date: 2019-10-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '10'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '12'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -105,7 +85,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/mock_redis.rb
@@ -266,6 +246,8 @@ files:
 - spec/commands/zcount_spec.rb
 - spec/commands/zincrby_spec.rb
 - spec/commands/zinterstore_spec.rb
+- spec/commands/zpopmax_spec.rb
+- spec/commands/zpopmin_spec.rb
 - spec/commands/zrange_spec.rb
 - spec/commands/zrangebyscore_spec.rb
 - spec/commands/zrank_spec.rb
@@ -446,6 +428,8 @@ test_files:
 - spec/commands/zcount_spec.rb
 - spec/commands/zincrby_spec.rb
 - spec/commands/zinterstore_spec.rb
+- spec/commands/zpopmax_spec.rb
+- spec/commands/zpopmin_spec.rb
 - spec/commands/zrange_spec.rb
 - spec/commands/zrangebyscore_spec.rb
 - spec/commands/zrank_spec.rb

data/LICENSE

@@ -1,19 +0,0 @@
-Copyright (c) 2011 Philotic, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.