mock_redis 0.19.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da2c2693b445e51b487e52f7c9b3986960417686792f9a5e554ca4d215c323e2
-  data.tar.gz: 8da2170fcc49e768133a61deb716d72cc18d66291567008d96287b8d2104b15c
+  metadata.gz: 0d399a835c1f41a8eb0e5fc42a366e64fc399b5d76ebc23f0d40f73c9db4888e
+  data.tar.gz: 1442920d2b12e46d2d45ff9d8854e4ccf3665b5a5f9a4aef6d29669c9110d023
 SHA512:
-  metadata.gz: 15b8b59cff1120de0befaee6cf08facfb120e239d3fbc1b6b55f40bb60c526f57e5cbb61f1d9f6fd5538067122e49b80e9e782590cd98070a3d49943ec8bb929
-  data.tar.gz: 52a09f0896a405137be0075db930bec09898dd96e3d5366a95ef6a189268348f91244c051dbe45db5b4b37023a12f87552868fcaf2a5383316bebe9bdaf44997
+  metadata.gz: 62b218977c75b5c7ffc80e3762bf0f7791c8f17dfe4f875a8874118583124736ab782e1c985dc92363d62e4366170306d9d0211b19cead2982f16cbff2c13557
+  data.tar.gz: 97b5eeb1c20e597d2ce35e9d109f62aaf3a2271f42c86515be1d7e0d627ad628173aee7d74062b119cf954538116f0b199d06eee5d1fe71b552dea543859a69e

data/.rubocop.yml

@@ -1,17 +1,35 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.4
 
-Layout/AlignParameters:
+Layout/ArgumentAlignment:
+  Enabled: false
+
+Layout/ParameterAlignment:
   Enabled: false
 
 Layout/DotPosition:
   Enabled: false
 
+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:
@@ -29,9 +47,6 @@ Metrics/CyclomaticComplexity:
 Metrics/ClassLength:
   Enabled: false
 
-Metrics/LineLength:
-  Max: 100
-
 Metrics/MethodLength:
   Enabled: false
 
@@ -51,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

@@ -1,7 +1,5 @@
 language: ruby
 
-sudo: false
-
 cache: bundler
 
 addons:
@@ -12,11 +10,16 @@ addons:
 services:
   - redis-server
 
+before_install:
+  - sudo sed -e 's/^bind.*/bind 127.0.0.1/' /etc/redis/redis.conf > redis.conf
+  - sudo mv redis.conf /etc/redis
+  - sudo service redis-server start
+  - echo PING | nc localhost 6379
+
 rvm:
-  - 2.2
-  - 2.3.7
-  - 2.4.4
-  - 2.5.1
+  - 2.4
+  - 2.5
+  - 2.6
 
 before_script:
   - git config --local user.email "travis@travis.ci"
@@ -27,7 +30,3 @@ script:
   - bundle exec rspec
   - bundle exec overcommit --sign
   - bundle exec overcommit --run
-
-matrix:
-  allow_failures:
-    - rvm: 2.1.0

data/CHANGELOG.md

@@ -1,5 +1,51 @@
 # MockRedis Changelog
 
+### 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))
+* Add support for `close` and `disconnect!` ([#163](https://github.com/sds/mock_redis/pull/163))
+* Fix `set` to properly handle (and ignore) other options ([#164](https://github.com/sds/mock_redis/pull/163))
+* Fix `srem` to allow array of integers as argument ([#166](https://github.com/sds/mock_redis/pull/166))
+* Fix `hdel` to allow array as argument ([#168](https://github.com/sds/mock_redis/pull/168))
+
+### 0.20.0
+
+* Add support for `count` parameter of `spop`
+* Fix `mget` and `mset` to accept array as parameters
+* Fix pipelined array replies
+* Fix nested pipelining
+* Allow nested multi
+* Require Redis gem 4.0.1 or newer
+* Add support for stream commands on Redis 5
+* Keep empty strings on type mismatch
+* Improve performance of `set_expiration`
+* Fix `watch` to allow multiple keys
+* Add `unlink` alias for `del`
+* Drop support for Ruby 2.3 or older
+
 ### 0.19.0
 
 * Require Ruby 2.2+

data/Gemfile

@@ -4,9 +4,9 @@ source 'http://rubygems.org'
 gemspec
 
 # Run all pre-commit hooks via Overcommit during CI runs
-gem 'overcommit', '0.45.0'
+gem 'overcommit', '0.53.0'
 
 # Pin tool versions (which are executed by Overcommit) for Travis builds
-gem 'rubocop', '0.58.2'
+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

@@ -1,18 +1,27 @@
 # MockRedis
 
 [![Gem Version](https://badge.fury.io/rb/mock_redis.svg)](http://badge.fury.io/rb/mock_redis)
-[![Build Status](https://travis-ci.org/brigade/mock_redis.svg)](https://travis-ci.org/brigade/mock_redis)
-[![Coverage Status](https://coveralls.io/repos/brigade/mock_redis/badge.svg)](https://coveralls.io/r/brigade/mock_redis)
+[![Build Status](https://travis-ci.org/sds/mock_redis.svg)](https://travis-ci.org/sds/mock_redis)
+[![Coverage Status](https://coveralls.io/repos/sds/mock_redis/badge.svg)](https://coveralls.io/r/sds/mock_redis)
 
 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,11 +64,6 @@ class MockRedis
     options[:db]
   end
 
-  def now
-    options[:time_class].now
-  end
-  alias time now
-
   def time_at(timestamp)
     options[:time_class].at(timestamp)
   end

data/lib/mock_redis/database.rb

@@ -10,6 +10,7 @@ require 'mock_redis/indifferent_hash'
 require 'mock_redis/info_method'
 require 'mock_redis/utility_methods'
 require 'mock_redis/geospatial_methods'
+require 'mock_redis/stream_methods'
 
 class MockRedis
   class Database
@@ -22,6 +23,7 @@ class MockRedis
     include InfoMethod
     include UtilityMethods
     include GeospatialMethods
+    include StreamMethods
 
     attr_reader :data, :expire_times
 
@@ -33,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
 
@@ -54,6 +56,8 @@ class MockRedis
     def disconnect
       nil
     end
+    alias close disconnect
+    alias disconnect! close
 
     def connected?
       true
@@ -73,6 +77,7 @@ class MockRedis
         each { |k| data.delete(k) }.
         length
     end
+    alias unlink del
 
     def echo(msg)
       msg.to_s
@@ -83,7 +88,8 @@ class MockRedis
     end
 
     def pexpire(key, ms)
-      now_ms = (@base.now.to_r * 1000).to_i
+      now, miliseconds = @base.now
+      now_ms = (now * 1000) + miliseconds
       pexpireat(key, now_ms + ms.to_i)
     end
 
@@ -100,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
@@ -109,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
 
@@ -137,11 +164,11 @@ class MockRedis
     end
 
     def lastsave
-      @base.now.to_i
+      now.first
     end
 
     def persist(key)
-      if exists(key) && has_expiration?(key)
+      if exists?(key) && has_expiration?(key)
         remove_expiration(key)
         true
       else
@@ -182,7 +209,7 @@ class MockRedis
         raise Redis::CommandError, 'ERR no such key'
       end
 
-      if exists(newkey)
+      if exists?(newkey)
         false
       else
         rename(key, newkey)
@@ -195,27 +222,38 @@ class MockRedis
     end
 
     def ttl(key)
-      if !exists(key)
+      if !exists?(key)
         -2
       elsif has_expiration?(key)
-        expiration(key).to_i - @base.now.to_i
+        now, = @base.now
+        expiration(key).to_i - now
       else
         -1
       end
     end
 
     def pttl(key)
-      if !exists(key)
+      now, miliseconds = @base.now
+      now_ms = now * 1000 + miliseconds
+
+      if !exists?(key)
         -2
       elsif has_expiration?(key)
-        (expiration(key).to_r * 1000).to_i - (@base.now.to_r * 1000).to_i
+        (expiration(key).to_r * 1000).to_i - now_ms
       else
         -1
       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'
@@ -290,7 +328,7 @@ class MockRedis
       Regexp.new(
         "^#{pattern}$".
         gsub(/([+|()])/, '\\\\\1').
-        gsub(/([^\\])\?/, '\\1.').
+        gsub(/(?<!\\)\?/, '\\1.').
         gsub(/([^\\])\*/, '\\1.*')
       )
     end
@@ -303,11 +341,9 @@ class MockRedis
 
     def set_expiration(key, time)
       remove_expiration(key)
-
-      expire_times << [time, key.to_s]
-      expire_times.sort! do |a, b|
-        a.first <=> b.first
-      end
+      found = expire_times.each_with_index.to_a.bsearch { |item, _| item.first >= time }
+      index = found ? found.last : -1
+      expire_times.insert(index, [time, key.to_s])
     end
 
     def zero_pad(string, desired_length)
@@ -320,10 +356,11 @@ 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 = @base.now
+      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.to_r * 1_000).to_i
+        (time.to_r * 1_000).to_i <= now_ms
       end
 
       to_delete.each do |(_time, key)|