Updated internal APIs to match redis-rb 5.0

Author: nateware

CHANGELOG.rdoc

@@ -1,5 +1,13 @@
 = Changelog for Redis::Objects
 
+== 2.0.0.beta (30 Mar 2023)
+
+* Updated internal calls to match `redis-rb`
+
+* INCOMPAT: `Redis.current` is no longer allowed due to changes in `redis-rb`
+
+* INCOMPAT: The order of items popped off a list by the rarely-used command `list.pop(n)` to specify multiple elements is now reversed to match redis.
+
 == 1.7.0 (29 Apr 2022)
 
 * Bumped version to 1.7.0 to revert redis-rb version lock [Nate Wiger]

README.md

@@ -12,10 +12,10 @@ Currently 2.0 can be installed with `gem install redis-objects --pre` or by list
 explicitly in your Gemfile:
 ~~~ruby
 # Gemfile
-gem 'redis-objects', '>= 2.0.0.alpha'
+gem 'redis-objects', '>= 2.0.0.beta'
 ~~~
 You're encouraged to try it out in test code (not production) to ensure it works for you.
-Official release is expected later in 2022.
+Official release is expected later in 2023.
 
 Key Naming Changes
 ------------------

lib/redis/list.rb

@@ -31,11 +31,7 @@ def push(*values)
     # Remove a member from the end of the list. Redis: RPOP
     def pop(n=nil)
       if n
-        result, = redis.multi do
-          redis.lrange(key, -n, -1)
-          redis.ltrim(key, 0, -n - 1)
-        end
-        unmarshal result
+        unmarshal redis.rpop(key, n)
       else
         unmarshal redis.rpop(key)
       end
@@ -65,11 +61,7 @@ def unshift(*values)
     # Remove a member from the start of the list. Redis: LPOP
     def shift(n=nil)
       if n
-        result, = redis.multi do
-          redis.lrange(key, 0, n - 1)
-          redis.ltrim(key, n, -1)
-        end
-        unmarshal result
+        unmarshal redis.lpop(key, n)
       else
         unmarshal redis.lpop(key)
       end

lib/redis/objects.rb

@@ -62,7 +62,7 @@ def redis=(conn)
         @redis = Objects::ConnectionPoolProxy.proxy_if_needed(conn)
       end
       def redis
-        @redis || $redis || Redis.current ||
+        @redis || $redis ||
           raise(NotConnected, "Redis::Objects.redis not set to a Redis.new connection")
       end
 

lib/redis/objects/version.rb

@@ -1,5 +1,5 @@
 class Redis
   module Objects
-    VERSION = "2.0.0.alpha"
+    VERSION = "2.0.0.beta"
   end
 end

lib/redis/set.rb

@@ -15,7 +15,8 @@ def <<(value)
     # Redis: SADD
     def add(value)
       allow_expiration do
-        redis.sadd(key, marshal(value)) if value.nil? || !Array(value).empty?
+        value = '' if value.nil?
+        redis.sadd(key, marshal(value)) if !Array(value).empty? # allow empty adds
       end
     end
 

lib/redis/sorted_set.rb

@@ -211,7 +211,7 @@ def intersection(*sets)
         result = redis.zrange(temp_key, 0, -1)
       end
 
-      result.value
+      result
     end
     alias_method :intersect, :intersection
     alias_method :inter, :intersection
@@ -248,7 +248,7 @@ def union(*sets)
         result = redis.zrange(temp_key, 0, -1)
       end
 
-      result.value
+      result
     end
     alias_method :|, :union
     alias_method :+, :union

redis-objects.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Only fix this one version or else tests break
-  spec.add_dependency "redis"
+  spec.add_dependency "redis", '~> 5.0'
 
   # Ignore gemspec warnings on these.  Trying to fix them to versions breaks TravisCI
   spec.add_development_dependency "bundler"

spec/redis_objects_conn_spec.rb

@@ -96,14 +96,9 @@ def id
   end
 
   it "should support local handles with a vanilla redis connection" do
-    # Redis.current = nil  # reset from other tests
     Redis::Objects.redis = nil
     @redis_handle = Redis.new(:host => REDIS_HOST, :port => REDIS_PORT)
-
-    # Redis.current is lazily auto-populated to touch 6379
-    # This why we choose the weird 9212 port to avoid
-    # Redis.current.inspect.should == Redis.new.inspect
-    Redis::Objects.redis.inspect.should == Redis.new.inspect
+    raises_exception{ Redis::Objects.redis.inspect } # NotConnected
 
     v = Redis::Value.new('conn/value', @redis_handle)
     v.clear
@@ -141,14 +136,9 @@ def id
   end
 
   it "should support local handles with a connection_pool" do
-    # Redis.current = nil  # reset from other tests
     Redis::Objects.redis = nil
     @redis_handle = ConnectionPool.new { Redis.new(:host => REDIS_HOST, :port => REDIS_PORT) }
-
-    # Redis.current is lazily auto-populated to touch 6379
-    # This why we choose the weird 9212 port to avoid
-    # Redis.current.inspect.should == Redis.new.inspect
-    Redis::Objects.redis.inspect.should == Redis.new.inspect
+    raises_exception{ Redis::Objects.redis.inspect } # NotConnected
 
     v = Redis::Value.new('conn/value', @redis_handle)
     v.clear

spec/redis_objects_instance_spec.rb

@@ -148,7 +148,7 @@
       end
 
       it "#{meth} should set expiration when expireat option assigned" do
-        @value = Redis::Value.new('spec/value', :expireat => Time.now + 10.seconds)
+        @value = Redis::Value.new('spec/value', :expireat => Time.now + 10)
         @value.send(meth, 'monkey')
         @value.ttl.should > 0
       end
@@ -286,18 +286,28 @@
       @list.get.should == ['a','c','f','j','h','i','a']
     end
 
-    it "should support popping & shifting multiple values" do
+    it "should support popping and shifting multiple values" do
       @list.should.be.empty
 
-      @list << 'a' << 'b' << 'c'
-      @list.shift(2).should == ['a', 'b']
-      @list.shift(2).should == ['c']
-      @list.shift(2).should == []
+      @list << 'a' << 'b' << 'c' << 'd'
+      @list.should == ['a', 'b', 'c', 'd']
+      @list.shift
+      @list.should == ['b', 'c', 'd']
+      @list.shift(2).should == ['b', 'c']
+      @list.should == ['d']
+      @list.shift(2).should == ['d']
+      @list.shift(2).should == nil
 
-      @list << 'a' << 'b' << 'c'
-      @list.pop(2).should == ['b', 'c']
-      @list.pop(2).should == ['a']
-      @list.pop(2).should == []
+      @list << 'e' << 'f' << 'g'
+
+      # Old behavior
+      # @list.pop(2).should == ['f', 'g']
+
+      # New behavior
+      @list.pop(2).should == ['g', 'f']
+
+      @list.pop(2).should == ['e']
+      @list.pop(2).should == nil
     end
 
     it "should handle rpoplpush" do
@@ -412,7 +422,7 @@
       end
 
       it "#{meth} expireat: option" do
-        @list = Redis::List.new('spec/list_exp', :expireat => Time.now + 10.seconds)
+        @list = Redis::List.new('spec/list_exp', :expireat => Time.now + 10)
         @list.clear
         @list.send(meth, 'val')
         @list.ttl.should > 0
@@ -430,7 +440,7 @@
     end
 
     it "[]= expireat: option" do
-      @list = Redis::List.new('spec/list_exp', :expireat => Time.now + 10.seconds)
+      @list = Redis::List.new('spec/list_exp', :expireat => Time.now + 10)
       @list.clear
       @list.redis.rpush(@list.key, 'hello')
       @list[0] = 'world'
@@ -448,7 +458,7 @@
     end
 
     it "insert expireat: option" do
-      @list = Redis::List.new('spec/list_exp', :expireat => Time.now + 10.seconds)
+      @list = Redis::List.new('spec/list_exp', :expireat => Time.now + 10)
       @list.clear
       @list.redis.rpush(@list.key, 'hello')
       @list.insert 'BEFORE', 'hello', 'world'
@@ -586,7 +596,7 @@
           @counter.ttl.should <= 10
         end
         it "expireat: option" do
-          @counter = Redis::Counter.new('spec/counter_exp', :expireat => Time.now + 10.seconds)
+          @counter = Redis::Counter.new('spec/counter_exp', :expireat => Time.now + 10)
           @counter.send(meth)
           @counter.ttl.should > 0
           @counter.ttl.should <= 10
@@ -600,14 +610,14 @@
    [:set, :value=].each do |meth|
       describe meth do
         it "expiration: option" do
-          @counter = Redis::Counter.new('spec/counter_exp', :expireat => Time.now + 10.seconds)
+          @counter = Redis::Counter.new('spec/counter_exp', :expireat => Time.now + 10)
           @counter.send(meth, 99)
           @counter.should == 99
           @counter.ttl.should > 0
           @counter.ttl.should <= 10
         end
         it "expireat: option" do
-          @counter = Redis::Counter.new('spec/counter_exp', :expireat => Time.now + 10.seconds)
+          @counter = Redis::Counter.new('spec/counter_exp', :expireat => Time.now + 10)
           @counter.send(meth, 99)
           @counter.should == 99
           @counter.ttl.should > 0
@@ -805,22 +815,25 @@
 describe Redis::HashKey do
   describe "With Marshal" do
     before do
-      @hash = Redis::HashKey.new('test_hash', {:marshal_keys=>{'created_at'=>true}})
+      @hash = Redis::HashKey.new('test_hash', {:marshal_keys=>{'created_at' => true}})
       @hash.clear
     end
 
     it "should marshal specified keys" do
-      @hash['created_at'] = Time.now
+      time = Time.now
+      @hash['created_at'] = time
+      @hash['created_at'].should == time
       @hash['created_at'].class.should == Time
     end
 
     it "should not marshal unless required" do
-      @hash['updated_at'] = Time.now
+      @hash['updated_at'] = 10
+      @hash['updated_at'].should == "10"
       @hash['updated_at'].class.should == String
     end
 
     it "should marshall appropriate key with bulk set and get" do
-      @hash.bulk_set({'created_at'=>Time.now, 'updated_at'=>Time.now})
+      @hash.bulk_set({'created_at' => Time.now, 'updated_at' => 11})
 
       @hash['created_at'].class.should == Time
       @hash['updated_at'].class.should == String
@@ -849,7 +862,7 @@
     # no marshaling
     @hash.options[:marshal] = false
     v = {:json => 'data'}
-    @hash['abc'] = v
+    @hash['abc'] = v.to_s
     @hash['abc'].should == v.to_s
 
     @hash.options[:marshal] = true
@@ -1075,7 +1088,7 @@
       end
 
       it "#{meth} expireat: option" do
-        @hash = Redis::HashKey.new('spec/hash_expireat', :expireat => Time.now + 10.seconds)
+        @hash = Redis::HashKey.new('spec/hash_expireat', :expireat => Time.now + 10)
         @hash.clear
         @hash.send(meth, *args)
         @hash.ttl.should > 0
@@ -1294,7 +1307,7 @@
       end
 
       it "should set expiration when expireat option assigned" do
-        @set = Redis::Set.new('spec/set', :expireat => Time.now + 10.seconds)
+        @set = Redis::Set.new('spec/set', :expireat => Time.now + 10)
         @set.send(meth, 'val')
         @set.ttl.should > 0
         @set.ttl.should <= 10
@@ -1558,7 +1571,7 @@
   end
 
   it 'should set expiration when expireat option assigned' do
-    @set = Redis::SortedSet.new('spec/zset', :expireat => Time.now + 10.seconds)
+    @set = Redis::SortedSet.new('spec/zset', :expireat => Time.now + 10)
     @set['val'] = 1
     @set.ttl.should > 0
     @set.ttl.should <= 10
@@ -1590,7 +1603,7 @@
         @set.ttl.should <= 10
       end
       it "#{meth} expireat: option" do
-        @set = Redis::SortedSet.new('spec/zset_exp', :expireat => Time.now + 10.seconds)
+        @set = Redis::SortedSet.new('spec/zset_exp', :expireat => Time.now + 10)
         @set.clear
         @set.send(meth, 'somekey', 12)
         @set.ttl.should > 0
@@ -1607,7 +1620,7 @@
         @set.ttl.should <= 10
       end
       it "#{meth} expireat: option" do
-        @set = Redis::SortedSet.new('spec/zset_exp', :expireat => Time.now + 10.seconds)
+        @set = Redis::SortedSet.new('spec/zset_exp', :expireat => Time.now + 10)
         @set.clear
         @set.send(meth, 'somekey' => 12)
         @set.ttl.should > 0
@@ -1626,7 +1639,7 @@
       end
 
       it "#{meth} expireat: option" do
-        @set = Redis::SortedSet.new('spec/zset_exp', :expireat => Time.now + 10.seconds)
+        @set = Redis::SortedSet.new('spec/zset_exp', :expireat => Time.now + 10)
         @set.clear
         @set.redis.zadd(@set.key, 1, "1")
         @set.send(meth, 'sets', Redis::SortedSet.new('other'))
@@ -1646,7 +1659,7 @@
     end
 
     it "delete expireat: option" do
-      @set = Redis::SortedSet.new('spec/zset_exp', :expireat => Time.now + 10.seconds)
+      @set = Redis::SortedSet.new('spec/zset_exp', :expireat => Time.now + 10)
       @set.clear
       @set.redis.zadd(@set.key, 1, "1")
       @set.redis.zadd(@set.key, 2, "2")

spec/spec_helper.rb

@@ -10,7 +10,7 @@
 end
 
 # For the incompatible change from redis.rb
-Redis.exists_returns_integer =  true
+# Redis.exists_returns_integer =  true
 
 # Avoid phantom remote test failures
 RUNNING_LOCALLY = !ENV['TRAVIS']
@@ -61,7 +61,7 @@ def kill_redis
   Process.kill "TERM", pid
   Process.kill "KILL", pid
   File.unlink pidfile
-  File.unlink rdbfile if File.exists? rdbfile
+  File.unlink rdbfile if File.exist? rdbfile
 end
 
 # Start redis-server except under JRuby