mock_redis 0.21.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4443d90955b31a149afd0c66972a06993bf9b01f6bd826276c2d60edb49b3141
-  data.tar.gz: 2d096c0b7438b81720adcd50ecb36a8fa19df7a05c822ed4beee6d06d459f1b4
+  metadata.gz: c087a47dd536c50c70b1238484a41a46669ca210b53063efd87fc863c83aaa67
+  data.tar.gz: 41927d6f1904768faaa5f9bbeff4fa803f7dc1045aa76da8f885594326eab326
 SHA512:
-  metadata.gz: bdcb30c9756e77fcc4f857f0bdaa01d73faa28b8ea7cc37aa669c0f5cf2e2967d3e216a32ff50c7c78f6945b313f8525073060daf9f980187d566202f3dbcda2
-  data.tar.gz: 17502b628f1a5a62fa2046b529ef0178d8b84453d3a8b83441e3f2eef72282d45a79e60bee34e9a871ea553deb08c1c286b915d4b2c6ffe52fab3e6e32a6cc56
+  metadata.gz: efe4f6cb8a7c3326e8ad06c1753a651dc41323ca1fb4a7f23a1ac080feb09a4192f5d140ddeb437ce7268c0325e9e8bc4270f6d68facc88696d9586b9342d388
+  data.tar.gz: 7392d8b37355b3c22dd7c51745df2f67497dfb88f2534a5cf5df606e07b6fe47cc7969e4e005da85b4a4e382ef8b7801e220f948db71313330079781a973ff75

data/.rubocop.yml

@@ -3,10 +3,10 @@ inherit_from: .rubocop_todo.yml
 AllCops:
   TargetRubyVersion: 2.4
 
-Layout/AlignArguments:
+Layout/ArgumentAlignment:
   Enabled: false
 
-Layout/AlignParameters:
+Layout/ParameterAlignment:
   Enabled: false
 
 Layout/DotPosition:
@@ -15,9 +15,21 @@ Layout/DotPosition:
 Layout/EmptyLineAfterGuardClause:
   Enabled: false
 
+Layout/LineLength:
+  Max: 100
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
 Lint/AssignmentInCondition:
   Enabled: false
 
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
 # We use this a lot in specs where it's perfectly valid
 Lint/Void:
   Exclude:
@@ -35,9 +47,6 @@ Metrics/CyclomaticComplexity:
 Metrics/ClassLength:
   Enabled: false
 
-Metrics/LineLength:
-  Max: 100
-
 Metrics/MethodLength:
   Enabled: false
 
@@ -57,6 +66,18 @@ Style/Documentation:
 Style/DoubleNegation:
   Enabled: false
 
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 # We have too much code that relies on modifying strings
 Style/FrozenStringLiteralComment:
   Enabled: false

data/.rubocop_todo.yml

@@ -9,7 +9,7 @@
 # Offense count: 17
 # Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
 # AllowedNames: io, id, to, by, on, in, at, ip
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   Exclude:
     - 'lib/mock_redis/database.rb'
     - 'lib/mock_redis/expire_wrapper.rb'

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,38 @@
 # MockRedis Changelog
 
+### 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))
+* 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))
+* Fix handling of multiple consecutive `?` characters in key pattern matching ([#186](https://github.com/sds/mock_redis/pull/186))
+* Change `exists` to return an integer and add `exists?` ([#188](https://github.com/sds/mock_redis/pull/188))
+
+### 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))
+* 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/Gemfile

@@ -4,9 +4,9 @@ source 'http://rubygems.org'
 gemspec
 
 # Run all pre-commit hooks via Overcommit during CI runs
-gem 'overcommit', '0.48.0'
+gem 'overcommit', '0.53.0'
 
 # Pin tool versions (which are executed by Overcommit) for Travis builds
-gem 'rubocop', '0.68.1'
+gem 'rubocop', '0.82.0'
 
 gem 'coveralls', require: false

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.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

@@ -35,7 +35,7 @@ class MockRedis
 
     def initialize_copy(_source)
       @data = @data.clone
-      @data.keys.each { |k| @data[k] = @data[k].clone }
+      @data.each_key { |k| @data[k] = @data[k].clone }
       @expire_times = @expire_times.map(&:clone)
     end
 
@@ -106,7 +106,7 @@ class MockRedis
         raise Redis::CommandError, 'ERR value is not an integer or out of range'
       end
 
-      if exists(key)
+      if exists?(key)
         timestamp = Rational(timestamp_ms.to_i, 1000)
         set_expiration(key, @base.time_at(timestamp))
         true
@@ -115,12 +115,33 @@ class MockRedis
       end
     end
 
-    def exists(key)
-      data.key?(key)
+    def exists(*keys)
+      keys.count { |key| data.key?(key) }
+    end
+
+    def exists?(*keys)
+      keys.each { |key| return true if data.key?(key) }
+      false
     end
 
     def flushdb
-      data.keys.each { |k| del(k) }
+      data.each_key { |k| del(k) }
+      '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
 
@@ -143,11 +164,11 @@ class MockRedis
     end
 
     def lastsave
-      @base.now.first
+      now.first
     end
 
     def persist(key)
-      if exists(key) && has_expiration?(key)
+      if exists?(key) && has_expiration?(key)
         remove_expiration(key)
         true
       else
@@ -188,7 +209,7 @@ class MockRedis
         raise Redis::CommandError, 'ERR no such key'
       end
 
-      if exists(newkey)
+      if exists?(newkey)
         false
       else
         rename(key, newkey)
@@ -201,7 +222,7 @@ class MockRedis
     end
 
     def ttl(key)
-      if !exists(key)
+      if !exists?(key)
         -2
       elsif has_expiration?(key)
         now, = @base.now
@@ -215,7 +236,7 @@ class MockRedis
       now, miliseconds = @base.now
       now_ms = now * 1000 + miliseconds
 
-      if !exists(key)
+      if !exists?(key)
         -2
       elsif has_expiration?(key)
         (expiration(key).to_r * 1000).to_i - now_ms
@@ -224,8 +245,15 @@ 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)
+      if !exists?(key)
         'none'
       elsif hashy?(key)
         'hash'
@@ -300,7 +328,7 @@ class MockRedis
       Regexp.new(
         "^#{pattern}$".
         gsub(/([+|()])/, '\\\\\1').
-        gsub(/([^\\])\?/, '\\1.').
+        gsub(/(?<!\\)\?/, '\\1.').
         gsub(/([^\\])\*/, '\\1.*')
       )
     end
@@ -328,8 +356,8 @@ 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_ms = now * 1_000 + miliseconds
+      now_sec, miliseconds = now
+      now_ms = now_sec * 1_000 + miliseconds
 
       to_delete = expire_times.take_while do |(time, _key)|
         (time.to_r * 1_000).to_i <= now_ms

data/lib/mock_redis/future.rb

@@ -17,7 +17,7 @@ class MockRedis
 
     def store_result(result)
       @result_set = true
-      @result = result
+      @result = @block ? @block.call(result) : result
     end
   end
 end

data/lib/mock_redis/geospatial_methods.rb

@@ -38,7 +38,7 @@ class MockRedis
       lng2, lat2 = geohash_decode(hash2)
 
       distance = geohash_distance(lng1, lat1, lng2, lat2) / to_meter
-      format('%.4f', distance)
+      format('%<distance>.4f', distance: distance)
     end
 
     def geohash(key, members)
@@ -95,8 +95,8 @@ class MockRedis
       lat = Float(point[1])
 
       unless LNG_RANGE.include?(lng) && LAT_RANGE.include?(lat)
-        lng = format('%.6f', lng)
-        lat = format('%.6f', lat)
+        lng = format('%<long>.6f', long: lng)
+        lat = format('%<lat>.6f', lat: lat)
         raise Redis::CommandError,
           "ERR invalid longitude,latitude pair #{lng},#{lat}"
       end
@@ -201,7 +201,7 @@ class MockRedis
     end
 
     def format_decoded_coord(coord)
-      coord = format('%.17f', coord)
+      coord = format('%<coord>.17f', coord: coord)
       l = 1
       l += 1 while coord[-l] == '0'
       coord = coord[0..-l]

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)|
@@ -121,10 +128,15 @@ class MockRedis
       end
     end
 
-    def hset(key, field, value)
-      field_exists = hexists(key, field)
-      with_hash_at(key) { |h| h[field.to_s] = value.to_s }
-      !field_exists
+    def hset(key, *args)
+      added = 0
+      with_hash_at(key) do |hash|
+        args.each_slice(2) do |field, value|
+          added += 1 unless hash.key?(field.to_s)
+          hash[field.to_s] = value.to_s
+        end
+      end
+      added
     end
 
     def hsetnx(key, field, value)
@@ -143,7 +155,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)