redis-objects 1.5.1 → 2.0.0.alpha

data/spec/redis_objects_instance_spec.rb

@@ -2,6 +2,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 require 'redis/objects'
+Redis::Objects.redis = REDIS_HANDLE
 
 describe Redis::Value do
   before do
@@ -19,6 +20,21 @@ describe Redis::Value do
     @value.value.should == false
   end
 
+  it "should handle simple values" do
+    @value.should == nil
+    @value.value = 'Trevor Hoffman'
+    @value.should == 'Trevor Hoffman'
+    @value.get.should == 'Trevor Hoffman'
+    @value.exists?.should == true
+    @value.exists.should == 1
+    @value.del.should == 1
+    @value.should.be.nil
+    @value.exists?.should == false
+    @value.exists.should == 0
+    @value.value = 42
+    @value.value.should == '42'
+  end
+
   it "should compress non marshaled values" do
     @value = Redis::Value.new('spec/value', compress: true)
     @value.value = 'Trevor Hoffman'
@@ -39,17 +55,8 @@ describe Redis::Value do
     @value.value.should == nil
     @value.value = ''
     @value.value.should == ''
-  end
-
-  it "should handle simple values" do
-    @value.should == nil
-    @value.value = 'Trevor Hoffman'
-    @value.should == 'Trevor Hoffman'
-    @value.get.should == 'Trevor Hoffman'
-    @value.del.should == 1
-    @value.should.be.nil
-    @value.value = 42
-    @value.value.should == '42'
+    @value.delete
+    @value.value.should.be.nil
   end
 
   it "should handle complex marshaled values" do
@@ -88,7 +95,7 @@ describe Redis::Value do
     marshalled_string = Marshal.dump({json: 'marshal'})
     @value = Redis::Value.new('spec/marshal', :default => marshalled_string, :marshal => true)
     @value.value.should == marshalled_string
-    @value.clear
+    @value.delete
   end
 
   it "should support renaming values" do
@@ -499,6 +506,7 @@ describe Redis::Counter do
     @counter.incrbyfloat 2.0e2
     @counter.to_f.should == 5214.31
     @counter.clear
+    @counter.should.be.nil
   end
 
   it "should support an atomic block" do
@@ -545,6 +553,9 @@ describe Redis::Counter do
     @updated = @counter.decrement(1) { |updated| updated == 2 ? 'yep' : nil }
     @updated.should == 'yep'
     @counter.should == 2
+
+    @counter.value = nil
+    @counter.should == 0
   end
 
   it "should support #to_json" do
@@ -644,7 +655,7 @@ describe Redis::Lock do
     REDIS_HANDLE.get("test_lock").should.be.nil
   end
 
-  it "should not let non-expired locks be gettable" do
+  it "should not let blocks execute if they timeout" do
     expiry = 15
     lock = Redis::Lock.new(:test_lock, :expiration => expiry, :timeout => 0.1)
 
@@ -669,19 +680,68 @@ describe Redis::Lock do
     REDIS_HANDLE.get("test_lock").should.not.be.nil
   end
 
+  it "should handle a timeout of 0" do
+    expiry = 15
+    lock = Redis::Lock.new(:test_lock, :timeout => 0)
+
+    # create a fake lock
+    REDIS_HANDLE.set("test_lock", (Time.now + expiry).to_f)
+
+    gotit = false
+    error = nil
+    begin
+      lock.lock do
+        gotit = true
+      end
+    rescue => error
+    end
+
+    error.should.be.kind_of(Redis::Lock::LockTimeout)
+
+    # should not have the lock
+    gotit.should.not.be.true
+
+    # lock value should still be set
+    REDIS_HANDLE.get("test_lock").should.not.be.nil
+  end
+
+  it "should properly keep the lock across threads" do
+    lock = Redis::Lock.new(:test_lock0)
+
+    t1 = Thread.new do
+      lock.lock do
+        lock.exists?.should.be.true if RUNNING_LOCALLY
+        REDIS_HANDLE.exists?("test_lock0").should.be.true if RUNNING_LOCALLY
+        sleep 1.0  # hang onto the lock across other thread
+      end
+    end
+
+    t2 = Thread.new do
+      # check for the lock from another thread
+      lock.exists?.should.be.true if RUNNING_LOCALLY
+      REDIS_HANDLE.exists?("test_lock0").should.be.true if RUNNING_LOCALLY
+    end
+
+    t1.join
+    t2.join
+
+    # lock value should not be set since the lock was held for more than the expiry
+    lock.exists?.should.be.false
+    REDIS_HANDLE.exists?("test_lock0").should.be.false
+  end
+
   it "Redis should remove the key if lock is held past expiration" do
-    lock = Redis::Lock.new(:test_lock, :expiration => 0.1)
+    lock = Redis::Lock.new(:test_lock1, :expiration => 0.1)
 
     lock.lock do
-      REDIS_HANDLE.exists("test_lock").should.be.true
-      sleep 0.3
-      # technically undefined behavior because we don't have a BG thread
-      # running and deleting lock keys - that is only triggered on block exit
-      #REDIS_HANDLE.exists("test_lock").should.be.false
+      lock.exists?.should.be.true
+      REDIS_HANDLE.exists?("test_lock1").should.be.true
+      sleep 1.0  # hang onto the lock > expiry
     end
 
     # lock value should not be set since the lock was held for more than the expiry
-    REDIS_HANDLE.exists("test_lock").should.be.false
+    lock.exists?.should.be.false
+    REDIS_HANDLE.exists?("test_lock1").should.be.false
   end
 
 
@@ -689,9 +749,9 @@ describe Redis::Lock do
     lock = Redis::Lock.new(:test_lock2, :expiration => 0.1)
 
     lock.lock do
-      REDIS_HANDLE.exists("test_lock2").should.be.true
-      sleep 0.3 # expired, key is deleted
-      REDIS_HANDLE.exists("test_lock2").should.be.false
+      REDIS_HANDLE.exists?("test_lock2").should.be.true
+      sleep 1.0 # expired, key is deleted
+      REDIS_HANDLE.exists?("test_lock2").should.be.false
       REDIS_HANDLE.set("test_lock2", "foo") # this is no longer a lock key, name is a coincidence
     end
 
@@ -699,17 +759,17 @@ describe Redis::Lock do
   end
 
   it "should manually delete the key if finished before expiration" do
-    lock = Redis::Lock.new(:test_lock3, :expiration => 0.5)
+    lock = Redis::Lock.new(:test_lock3, :expiration => 10.0)
 
     lock.lock do
-      REDIS_HANDLE.exists("test_lock3").should.be.true
+      REDIS_HANDLE.exists?("test_lock3").should.be.true
       sleep 0.1
-      REDIS_HANDLE.exists("test_lock3").should.be.true
+      REDIS_HANDLE.exists?("test_lock3").should.be.true
     end
 
-    # should delete the key because the lock block is done, regardless of time
+    # should delete the key because the lock block is done, regardless of expiry
     # for some strange reason, I have seen this test fail randomly, which is worrisome.
-    #REDIS_HANDLE.exists("test_lock3").should.be.false
+    REDIS_HANDLE.exists?("test_lock3").should.be.false
   end
 
 
@@ -929,6 +989,13 @@ describe Redis::HashKey do
     hsh['foo'].should == 'bar'
   end
 
+  it "should return multiple items via bulk_values" do
+    @hash['taco'] = 42
+    @hash['burrito'] = 99
+    res = @hash.bulk_values('taco', 'burrito')
+    res.should == ['42', '99']  # hashes don't convert
+  end
+
   it "should increment field" do
     @hash.incr('counter')
     @hash.incr('counter')
@@ -1036,7 +1103,9 @@ describe Redis::Set do
 
   it "should handle sets of simple values" do
     @set.should.be.empty
-    @set << 'a' << 'a' << 'a'
+    @set << 'a'
+    @set.randmember.should == 'a'
+    @set << 'a' << 'a'
     @set.should == ['a']
     @set.to_s.should == 'a'
     @set.get.should == ['a']
@@ -1077,11 +1146,13 @@ describe Redis::Set do
     coll = @set.select{|st| st == 'c'}
     coll.should == ['c']
     @set.sort.should == ['a','b','c']
+    @set.randmember.should.not == 'd'
     @set.delete_if{|m| m == 'c'}
     @set.sort.should == ['a','b']
 
     @set << nil
     @set.include?("").should.be.true
+    @set.sort.should == ['','a','b']
   end
 
   it "should handle empty array adds" do
@@ -1197,6 +1268,12 @@ describe Redis::Set do
     @set_1.value.should == ['a']
   end
 
+  it "should support moving between sets" do
+    @set_1 << 'X' << 'Y' << 'Z'
+    @set_1.move('X', @set_2)
+    @set_2.should == ['X']
+  end
+
   it "should respond to #to_json" do
     @set_1 << 'a'
     JSON.parse(@set_1.to_json)['value'].should == ['a']
@@ -1296,6 +1373,9 @@ describe Redis::SortedSet do
     @set.to_s.should == 'a, b'
     @set.should == ['a','b']
     @set.members.should == ['a','b']
+    @set.member?('a').should == true
+    @set.member?('b').should == true
+    @set.member?('c').should == false
     @set['d'] = 0
 
     @set.rangebyscore(0, 4).should == ['d','a']
@@ -1345,6 +1425,10 @@ describe Redis::SortedSet do
 
     @set.delete_if{|m| m == 'b'}
     @set.size.should == 3
+
+    # this is destructive so must come last
+    res = @set.remrangebyrank(0, 2)
+    res.should == 3
   end
 
   it "should handle inserting multiple values at once" do

data/spec/redis_objects_model_spec.rb

@@ -2,6 +2,7 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 require 'redis/objects'
+Redis::Objects.redis = REDIS_HANDLE
 
 class Roster
   include Redis::Objects
@@ -9,16 +10,20 @@ class Roster
   counter :pitchers, :limit => :max_pitchers
   counter :basic
   hash_key :contact_information, :marshal_keys=>{'updated_at'=>true}
-  lock :resort, :timeout => 2
+  redis_lock :resort, :timeout => 2
   value :starting_pitcher, :marshal => true
   list :player_stats, :marshal => true
   set :outfielders, :marshal => true
   sorted_set :rank
+  redis_lock :per_field
 
   # global class counters
   counter :total_players_online, :global => true
   set :all_players_online, :global => true
   value :last_player, :global => true
+  redis_lock :nasty_global_mutex, :global => true  # remember it appends "_lock"
+  sorted_set :global_player_leaderboard, :global => true
+  hash_key :global_player_online_status, :global => true
 
   # custom keys
   counter :player_totals, :key => 'players/#{username}/total'
@@ -210,6 +215,21 @@ describe Redis::Objects do
      end
   end
 
+  it "should handle obtaining / clearing locks" do
+    # class-level calls for Admin reasons
+    # this is a really weird API and I wonder if anyone actually uses it
+    id = 88
+    roster = Roster.new(id)
+    roster.per_field_lock.exists?.should == false
+    Roster.obtain_lock(:per_field, id) do
+      roster.per_field_lock.exists?.should == true
+    end
+    roster.per_field_lock.exists?.should == false
+
+    Roster.clear_lock(:per_field, id)
+    roster.per_field_lock.exists?.should == false
+  end
+
   it "should support increment/decrement of counters" do
     @roster.available_slots.key.should == 'roster:1:available_slots'
     @roster.available_slots.should == 10
@@ -273,6 +293,26 @@ describe Redis::Objects do
     Roster.get_counter(:total_players_online).should == 111
   end
 
+  it "should support class-level manipulation of global objects" do
+    Roster.nasty_global_mutex_lock.exists?.should == false
+    Roster.nasty_global_mutex_lock do
+      Roster.nasty_global_mutex_lock.exists?.should == true
+    end
+    Roster.nasty_global_mutex_lock.exists?.should == false
+
+    Roster.global_player_leaderboard.exists?.should == false
+    Roster.global_player_leaderboard.add('nate', 22)
+    Roster.global_player_leaderboard.add('jim', 11)
+    Roster.global_player_leaderboard.rank('nate').should == 1 # 0-based
+
+    Roster.global_player_online_status.exists?.should == false
+    Roster.global_player_online_status['nate'] = 'online'
+    Roster.global_player_online_status['jeff'] = 'offline'
+    Roster.global_player_online_status['nate'].should == 'online'
+    Roster.global_player_online_status['jeff'].should == 'offline'
+    Roster.global_player_online_status['bobby'].should.be.nil
+  end
+
   it "should take an atomic block for increment/decrement" do
     a = false
     @roster.available_slots.should == 10
@@ -431,6 +471,13 @@ describe Redis::Objects do
     end
     error.should.be.kind_of(NoMethodError)
 
+    error = nil
+    begin
+      Roster.increment_counter(:available_slots, nil)
+    rescue => error
+    end
+    error.should.be.kind_of(Redis::Objects::MissingID)
+
     error = nil
     begin
       Roster.obtain_lock(:badness, 2){}
@@ -919,9 +966,13 @@ describe Redis::Objects do
   end
 
   it "should pick up class methods from superclass automatically" do
+    Roster.redis_prefix.should == 'roster'
     CounterRoster = Class.new(Roster)
+    CounterRoster.redis_prefix.should == 'counter_roster'
     CounterRoster.counter :extended_counter
     extended_roster = CounterRoster.new
+    Roster.redis_prefix.should == 'roster'
+    extended_roster.class.redis_prefix.should == 'counter_roster'
     extended_roster.basic.should.be.kind_of(Redis::Counter)
     extended_roster.extended_counter.should.be.kind_of(Redis::Counter)
     @roster.respond_to?(:extended_counter).should == false
@@ -934,7 +985,7 @@ describe Redis::Objects do
     @roster.respond_to?(:extended_hash_key).should == false
 
     LockRoster = Class.new(Roster)
-    LockRoster.lock :extended
+    LockRoster.redis_lock :extended
     extended_roster = LockRoster.new
     extended_roster.resort_lock.should.be.kind_of(Redis::Lock)
     extended_roster.extended_lock.should.be.kind_of(Redis::Lock)
@@ -1042,4 +1093,10 @@ describe Redis::Objects do
     @roster.redis_instance_keys.include?('roster:1:player_stats').should == true
     @roster.redis_instance_keys.include?('players:all_stats').should == false
   end
+
+  it "should handle per-class connection handles" do
+    redis = Roster.redis
+    Roster.redis = redis
+    Roster.redis.should == redis
+  end
 end

data/spec/spec_helper.rb

@@ -9,6 +9,21 @@ if $0 =~ /\brspec$/
   raise "\n===\nThese tests are in bacon, not rspec.  Try: bacon #{ARGV * ' '}\n===\n"
 end
 
+# For the incompatible change from redis.rb
+Redis.exists_returns_integer =  true
+
+# Avoid phantom remote test failures
+RUNNING_LOCALLY = !ENV['TRAVIS']
+
+# Code coverage reports
+require 'simplecov'
+SimpleCov.start
+
+require 'simplecov-cobertura'
+SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+
+#require "active_support/xml_mini"
+require "active_support"
 require "active_support/testing/time_helpers"
 include ActiveSupport::Testing::TimeHelpers
 
@@ -69,8 +84,6 @@ end
 
 # Grab a global handle
 REDIS_HANDLE = Redis.new(:host => REDIS_HOST, :port => REDIS_PORT)
-#$redis = REDIS_HANDLE
-Redis.current = REDIS_HANDLE
 
 SORT_ORDER = {:order => 'desc alpha'}
 SORT_LIMIT = {:limit => [2, 2]}

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: redis-objects
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0.alpha
 platform: ruby
 authors:
 - Nate Wiger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Map Redis types directly to Ruby objects. Works with any class or ORM.
 email:
 - nwiger@gmail.com
@@ -160,6 +188,7 @@ files:
 - lib/redis/value.rb
 - redis-objects.gemspec
 - spec/redis_autoload_objects_spec.rb
+- spec/redis_legacy_key_naming_spec.rb
 - spec/redis_namespace_compat_spec.rb
 - spec/redis_objects_active_record_spec.rb
 - spec/redis_objects_conn_spec.rb
@@ -182,16 +211,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Map Redis types directly to Ruby objects
 test_files:
 - spec/redis_autoload_objects_spec.rb
+- spec/redis_legacy_key_naming_spec.rb
 - spec/redis_namespace_compat_spec.rb
 - spec/redis_objects_active_record_spec.rb
 - spec/redis_objects_conn_spec.rb