Merge #661

661: added REPLACE modifier for restore command r=badboy

Added support for REPLACE modifier to the RESTORE command. If :replace option is true, passes along the REPLACE modifier. If the modifier is missing, a Redis::CommandError is raised iff the key already exists. If the modifier is present, the key is overwritten.

Author: not-a-robot[bot]

lib/redis.rb

@@ -458,10 +458,16 @@ def dump(key)
   # @param [String] key
   # @param [String] ttl
   # @param [String] serialized_value
+  # @param [Hash] options
+  #   - `:replace => Boolean`: if false, raises an error if key already exists
+  # @raise [Redis::CommandError]
   # @return [String] `"OK"`
-  def restore(key, ttl, serialized_value)
+  def restore(key, ttl, serialized_value, options = {})
+    args = [:restore, key, ttl, serialized_value]
+    args << 'REPLACE' if options[:replace]
+
     synchronize do |client|
-      client.call([:restore, key, ttl, serialized_value])
+      client.call(args)
     end
   end
 

lib/redis/distributed.rb

@@ -144,8 +144,8 @@ def dump(key)
     end
 
     # Create a key using the serialized value, previously obtained using DUMP.
-    def restore(key, ttl, serialized_value)
-      node_for(key).restore(key, ttl, serialized_value)
+    def restore(key, ttl, serialized_value, options = {})
+      node_for(key).restore(key, ttl, serialized_value, options)
     end
 
     # Transfer a key from the connected instance to another instance.

test/lint/value_types.rb

@@ -93,6 +93,14 @@ def test_dump_and_restore
         assert r.restore("bar", 1000, w)
         assert_equal ["b", "c", "d"], r.lrange("bar", 0, -1)
         assert [0, 1].include? r.ttl("bar")
+
+        r.set("bar", "somethingelse")
+        assert_raises(Redis::CommandError) { r.restore("bar", 1000, w) } # ensure by default replace is false
+        assert_raises(Redis::CommandError) { r.restore("bar", 1000, w, :replace => false) }
+        assert_equal "somethingelse", r.get("bar")
+        assert r.restore("bar", 1000, w, :replace => true)
+        assert_equal ["b", "c", "d"], r.lrange("bar", 0, -1)
+        assert [0, 1].include? r.ttl("bar")
       end
     end