mock_redis 0.19.0 → 0.24.0

data/lib/mock_redis/stream_methods.rb

@@ -0,0 +1,87 @@
+require 'mock_redis/assertions'
+require 'mock_redis/utility_methods'
+require 'mock_redis/stream'
+
+# TODO: Implement the following commands
+#
+#   * xread
+#   * xgroup
+#   * xreadgroup
+#   * xack
+#   * xpending
+#   * xclaim
+#   * xinfo
+#   * xtrim
+#   * xdel
+#
+# TODO: Complete support for
+#
+#   * xtrim
+#       - `approximate: true` argument is currently ignored
+#   * xadd
+#       - `approximate: true` argument (for capped streams) is currently ignored
+#
+# For details of these commands see
+#   * https://redis.io/topics/streams-intro
+#   * https://redis.io/commands#stream
+
+class MockRedis
+  module StreamMethods
+    include Assertions
+    include UtilityMethods
+
+    def xadd(key, entry, opts = {})
+      id = opts[:id] || '*'
+      with_stream_at(key) do |stream|
+        stream.add id, entry
+        stream.trim opts[:maxlen] if opts[:maxlen]
+        return stream.last_id
+      end
+    end
+
+    def xtrim(key, count)
+      with_stream_at(key) do |stream|
+        stream.trim count
+      end
+    end
+
+    def xlen(key)
+      with_stream_at(key) do |stream|
+        return stream.count
+      end
+    end
+
+    def xrange(key, first = '-', last = '+', count: nil)
+      args = [first, last, false]
+      args += ['COUNT', count] if count
+      with_stream_at(key) do |stream|
+        return stream.range(*args)
+      end
+    end
+
+    def xrevrange(key, last = '+', first = '-', count: nil)
+      args = [first, last, true]
+      args += ['COUNT', count] if count
+      with_stream_at(key) do |stream|
+        return stream.range(*args)
+      end
+    end
+
+    private
+
+    def with_stream_at(key, &blk)
+      with_thing_at(key, :assert_streamy, proc { Stream.new }, &blk)
+    end
+
+    def streamy?(key)
+      data[key].nil? || data[key].is_a?(Stream)
+    end
+
+    def assert_streamy(key)
+      unless streamy?(key)
+        raise Redis::CommandError,
+          'WRONGTYPE Operation against a key holding the wrong kind of value'
+      end
+    end
+  end
+end

data/lib/mock_redis/string_methods.rb

@@ -85,14 +85,11 @@ class MockRedis
     end
 
     def get(key)
+      key = key.to_s
       assert_stringy(key)
       data[key]
     end
 
-    def [](key)
-      get(key)
-    end
-
     def getbit(key, offset)
       assert_stringy(key)
 
@@ -159,6 +156,7 @@ class MockRedis
     def mget(*keys)
       assert_has_args(keys, 'mget')
 
+      keys.flatten!
       keys.map do |key|
         get(key) if stringy?(key)
       end
@@ -170,6 +168,8 @@ class MockRedis
 
     def mset(*kvpairs)
       assert_has_args(kvpairs, 'mset')
+      kvpairs = kvpairs.first if kvpairs.size == 1 && kvpairs.first.is_a?(Enumerable)
+
       if kvpairs.length.odd?
         raise Redis::CommandError, 'ERR wrong number of arguments for MSET'
       end
@@ -188,7 +188,7 @@ class MockRedis
     def msetnx(*kvpairs)
       assert_has_args(kvpairs, 'msetnx')
 
-      if kvpairs.each_slice(2).any? { |(k, _)| exists(k) }
+      if kvpairs.each_slice(2).any? { |(k, _)| exists?(k) }
         false
       else
         mset(*kvpairs)
@@ -201,17 +201,18 @@ class MockRedis
     end
 
     def set(key, value, options = {})
+      key = key.to_s
       return_true = false
       options = options.dup
       if options.delete(:nx)
-        if exists(key)
+        if exists?(key)
           return false
         else
           return_true = true
         end
       end
       if options.delete(:xx)
-        if exists(key)
+        if exists?(key)
           return_true = true
         else
           return false
@@ -219,20 +220,26 @@ class MockRedis
       end
       data[key] = value.to_s
 
-      # take latter
-      expire_option = options.to_a.last
-      if expire_option
-        type, duration = expire_option
+      duration = options.delete(:ex)
+      if duration
         if duration == 0
           raise Redis::CommandError, 'ERR invalid expire time in set'
         end
-        expire(key, type.to_sym == :ex ? duration : duration / 1000.0)
+        expire(key, duration)
       end
-      return_true ? true : 'OK'
-    end
 
-    def []=(key, value, options = {})
-      set(key, value, options)
+      duration = options.delete(:px)
+      if duration
+        if duration == 0
+          raise Redis::CommandError, 'ERR invalid expire time in set'
+        end
+        pexpire(key, duration)
+      end
+      unless options.empty?
+        raise ArgumentError, "unknown keyword: #{options.keys[0]}"
+      end
+
+      return_true ? true : 'OK'
     end
 
     def setbit(key, offset, value)
@@ -309,13 +316,17 @@ class MockRedis
     end
 
     def setex(key, seconds, value)
-      set(key, value)
-      expire(key, seconds)
-      'OK'
+      if seconds <= 0
+        raise Redis::CommandError, 'ERR invalid expire time in setex'
+      else
+        set(key, value)
+        expire(key, seconds)
+        'OK'
+      end
     end
 
     def setnx(key, value)
-      if exists(key)
+      if exists?(key)
         false
       else
         set(key, value)

data/lib/mock_redis/transaction_wrapper.rb

@@ -11,13 +11,13 @@ class MockRedis
     def initialize(db)
       @db = db
       @transaction_futures = []
-      @in_multi = false
+      @multi_stack = []
       @multi_block_given = false
     end
 
     def method_missing(method, *args, &block)
-      if @in_multi
-        future = MockRedis::Future.new([method, *args])
+      if in_multi?
+        future = MockRedis::Future.new([method, *args], block)
         @transaction_futures << future
 
         if @multi_block_given
@@ -35,30 +35,32 @@ class MockRedis
       super
       @db = @db.clone
       @transaction_futures = @transaction_futures.clone
+      @multi_stack = @multi_stack.clone
     end
 
     def discard
-      unless @in_multi
+      unless in_multi?
         raise Redis::CommandError, 'ERR DISCARD without MULTI'
       end
-      @in_multi = false
-      @multi_block_given = false
+      pop_multi
+
       @transaction_futures = []
       'OK'
     end
 
     def exec
-      unless @in_multi
+      unless in_multi?
         raise Redis::CommandError, 'ERR EXEC without MULTI'
       end
-      @in_multi = false
+      pop_multi
+      return if in_multi?
       @multi_block_given = false
 
       responses = @transaction_futures.map do |future|
         begin
           result = send(*future.command)
           future.store_result(result)
-          result
+          future.value
         rescue StandardError => e
           e
         end
@@ -68,12 +70,21 @@ class MockRedis
       responses
     end
 
+    def in_multi?
+      @multi_stack.any?
+    end
+
+    def push_multi
+      @multi_stack.push(@multi_stack.size + 1)
+    end
+
+    def pop_multi
+      @multi_stack.pop
+    end
+
     def multi
-      if @in_multi
-        raise Redis::CommandError, 'ERR MULTI calls can not be nested'
-      end
-      @in_multi = true
       if block_given?
+        push_multi
         @multi_block_given = true
         begin
           yield(self)
@@ -83,6 +94,8 @@ class MockRedis
           raise e
         end
       else
+        raise Redis::CommandError, 'ERR MULTI calls can not be nested' if in_multi?
+        push_multi
         'OK'
       end
     end
@@ -95,7 +108,7 @@ class MockRedis
       'OK'
     end
 
-    def watch(_)
+    def watch(*_)
       if block_given?
         yield self
       else

data/lib/mock_redis/utility_methods.rb

@@ -18,7 +18,7 @@ class MockRedis
     end
 
     def clean_up_empties_at(key)
-      if data[key] && data[key].empty?
+      if data[key]&.empty? && data[key] != ''
         del(key)
       end
     end
@@ -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.19.0'.freeze
+  VERSION = '0.24.0'
 end

data/lib/mock_redis/zset_methods.rb

@@ -11,7 +11,7 @@ class MockRedis
       zadd_options = {}
       zadd_options = args.pop if args.last.is_a?(Hash)
 
-      if zadd_options && zadd_options.include?(:nx) && zadd_options.include?(:xx)
+      if zadd_options&.include?(:nx) && zadd_options&.include?(:xx)
         raise Redis::CommandError, 'ERR XX and NX options at the same time are not compatible'
       end
 
@@ -26,7 +26,7 @@ class MockRedis
     end
 
     def zadd_one_member(key, score, member, zadd_options = {})
-      assert_scorey(score) unless score =~ /(\+|\-)inf/
+      assert_scorey(score) unless score.to_s =~ /(\+|\-)inf/
 
       with_zset_at(key) do |zset|
         if zadd_options[:incr]
@@ -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)
@@ -211,7 +229,7 @@ class MockRedis
     def zscore(key, member)
       with_zset_at(key) do |z|
         score = z.score(member.to_s)
-        score.to_f if score
+        score&.to_f
       end
     end
 
@@ -264,7 +282,7 @@ class MockRedis
                      raise Redis::CommandError, 'ERR syntax error'
                    end
 
-      with_zsets_at(*keys) do |*zsets|
+      with_zsets_at(*keys, coercible: true) do |*zsets|
         zsets.zip(weights).map do |(zset, weight)|
           zset.reduce(Zset.new) do |acc, (score, member)|
             acc.add(score * weight, member)
@@ -275,16 +293,30 @@ class MockRedis
       end
     end
 
-    def with_zset_at(key, &blk)
-      with_thing_at(key, :assert_zsety, proc { Zset.new }, &blk)
+    def coerce_to_zset(set)
+      zset = Zset.new
+      set.each do |member|
+        zset.add(1.0, member)
+      end
+      zset
     end
 
-    def with_zsets_at(*keys, &blk)
+    def with_zset_at(key, coercible: false, &blk)
+      if coercible
+        with_thing_at(key, :assert_coercible_zsety, proc { Zset.new }) do |value|
+          blk.call value.is_a?(Set) ? coerce_to_zset(value) : value
+        end
+      else
+        with_thing_at(key, :assert_zsety, proc { Zset.new }, &blk)
+      end
+    end
+
+    def with_zsets_at(*keys, coercible: false, &blk)
       if keys.length == 1
-        with_zset_at(keys.first, &blk)
+        with_zset_at(keys.first, coercible: coercible, &blk)
       else
-        with_zset_at(keys.first) do |set|
-          with_zsets_at(*(keys[1..-1])) do |*sets|
+        with_zset_at(keys.first, coercible: coercible) do |set|
+          with_zsets_at(*(keys[1..-1]), coercible: coercible) do |*sets|
             yield(*([set] + sets))
           end
         end
@@ -295,6 +327,10 @@ class MockRedis
       data[key].nil? || data[key].is_a?(Zset)
     end
 
+    def coercible_zsety?(key)
+      zsety?(key) || data[key].is_a?(Set)
+    end
+
     def assert_zsety(key)
       unless zsety?(key)
         raise Redis::CommandError,
@@ -302,13 +338,20 @@ class MockRedis
       end
     end
 
+    def assert_coercible_zsety(key)
+      unless coercible_zsety?(key)
+        raise Redis::CommandError,
+          'WRONGTYPE Operation against a key holding the wrong kind of value'
+      end
+    end
+
     def looks_like_float?(x)
       # ugh, exceptions for flow control.
       !!Float(x) rescue false
     end
 
     def assert_scorey(value, message = 'ERR value is not a valid float')
-      return if value =~ /\(?(\-|\+)inf/
+      return if value.to_s =~ /\(?(\-|\+)inf/
 
       value = $1 if value.to_s =~ /\((.*)/
       unless looks_like_float?(value)