mock_redis 0.5.4 → 0.31.0

data/README.md

@@ -1,13 +1,27 @@
 # MockRedis
 
-A mock redis gem.
+[![Gem Version](https://badge.fury.io/rb/mock_redis.svg)](http://badge.fury.io/rb/mock_redis)
+![Build Status](https://github.com/sds/mock_redis/actions/workflows/tests.yml/badge.svg)
+[![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
+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.
 
+## Requirements
+
+Ruby 2.6+
+
+The current implementation is tested against Redis 6.2. 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.
 
@@ -27,11 +41,12 @@ of supported methods:
 
 * String methods: `get`, `set`, `append`, `incr`, etc.
 * List methods: `lpush`, `lpop`, `lrange`, `rpoplpush`, etc.
-* Set methods: `sadd`, `sinter`, `sismember`, etc.
-* Hash methods: `hset`, `hget`, `hgetall`, `hmget`, etc.
+* Set methods: `sadd`, `sinter`, `sismember`, `srandmember`, etc.
+* Hash methods: `hset`, `hget`, `hgetall`, `hmget`, `hincrby`, `hincrbyfloat` etc.
 * Sorted set methods: `zadd`, `zrank`, `zunionstore`, etc.
-* Expirations: `expire`, `ttl`, etc.
+* Expirations: `expire`, `pexpire`, `ttl`, `pttl`, etc.
 * Transactions: `multi`, `exec`, `discard`
+* Futures
 
 ## Mostly-Supported Commands
 
@@ -51,6 +66,9 @@ necessary exceptions.
 
 * `#info` just returns canned values; they don't update over time.
 
+* `#sort` supports ascending and descending sort. `ALPHA` sort is not yet
+  supported.
+
 ## Unsupported Commands
 
 Some stuff, we just can't do with a single Ruby object in a single
@@ -70,6 +88,8 @@ Ruby process.
 
 * `#slowlog` isn't available.
 
+* Scripting commands (`#script`, `#eval`, `#evalsha`) are just stubs—they won't execute anything
+
 ## Remaining Work
 
 There are some things we want to have in here, but that we just
@@ -79,16 +99,32 @@ please submit a pull request with your (tested!) implementation.
 * `#config(:get|:set|:resetstat)` isn't done. They can just return
   canned values.
 
-* `#sort` isn't done. We just haven't gotten to it yet. The input
-  validation will be a pain in the butt, but other than that, it
-  shouldn't be too bad.
+## 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
+
+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 2.2.11 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/Rakefile

@@ -1,10 +1,2 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.rspec_opts = %w(-fs --color)
-  t.pattern = "spec/**/*_spec.rb"
-end
-
-task :default => :spec

data/lib/mock_redis/assertions.rb

@@ -8,6 +8,5 @@ class MockRedis
         "ERR wrong number of arguments for '#{command}' command"
       end
     end
-
   end
 end

data/lib/mock_redis/connection_method.rb

@@ -0,0 +1,13 @@
+class MockRedis
+  module ConnectionMethod
+    def connection
+      {
+        :host => @base.host,
+        :port => @base.port,
+        :db => @base.db,
+        :id => @base.id,
+        :location => "#{@base.host}:#{@base.port}"
+      }
+    end
+  end
+end