redis-objects 0.2.2 → 0.2.4

data/lib/redis/set.rb

@@ -13,10 +13,10 @@ class Redis
     attr_reader :key, :options, :redis
     
     # Create a new Set.
-    def initialize(key, redis=$redis, options={})
+    def initialize(key, *args)
       @key = key
-      @redis = redis
-      @options = options
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @redis = args.first || $redis
     end
 
     # Works like add.  Can chain together: list << 'a' << 'b'

data/lib/redis/sorted_set.rb

@@ -0,0 +1,275 @@
+class Redis
+  #
+  # Class representing a sorted set.
+  #
+  class SortedSet
+    # require 'enumerator'
+    # include Enumerable
+    require 'redis/helpers/core_commands'
+    include Redis::Helpers::CoreCommands
+    require 'redis/helpers/serialize'
+    include Redis::Helpers::Serialize
+
+    attr_reader :key, :options, :redis
+    
+    # Create a new SortedSet.
+    def initialize(key, *args)
+      @key = key
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @redis = args.first || $redis
+    end
+
+    # How to add values using a sorted set.  The key is the member, eg,
+    # "Peter", and the value is the score, eg, 163.  So:
+    #    num_posts['Peter'] = 163 
+    def []=(member, score)
+      add(member, score)
+    end
+
+    # Add a member and its corresponding value to Redis.  Note that the
+    # arguments to this are flipped; the member comes first rather than
+    # the score, since the member is the unique item (not the score).
+    def add(member, score)
+      redis.zadd(key, score, to_redis(member))
+    end
+
+    # Same functionality as Ruby arrays.  If a single number is given, return
+    # just the element at that index using Redis: ZRANGE. Otherwise, return
+    # a range of values using Redis: ZRANGE.
+    def [](index, length=nil)
+      if index.is_a? Range
+        range(index.first, index.last)
+      elsif length
+        range(index, length)
+      else
+        at(index)
+      end
+    end
+
+    # Return the score of the specified element of the sorted set at key. If the
+    # specified element does not exist in the sorted set, or the key does not exist
+    # at all, nil is returned. Redis: ZSCORE.
+    def score(member)
+      redis.zscore(key, to_redis(member)).to_i
+    end
+
+    # Return the rank of the member in the sorted set, with scores ordered from
+    # low to high. +revrank+ returns the rank with scores ordered from high to low.
+    # When the given member does not exist in the sorted set, nil is returned.
+    # The returned rank (or index) of the member is 0-based for both commands
+    def rank(member)
+      redis.zrank(key, to_redis(member)).to_i
+    end
+
+    def revrank(member)
+      redis.zrevrank(key, to_redis(member)).to_i
+    end
+
+    # Return all members of the sorted set with their scores.  Extremely CPU-intensive.
+    # Better to use a range instead.
+    def members(options={})
+      range(0, -1, options)
+    end
+
+    # Return a range of values from +start_index+ to +end_index+.  Can also use
+    # the familiar list[start,end] Ruby syntax. Redis: ZRANGE
+    def range(start_index, end_index, options={})
+      if options[:withscores]
+        val = from_redis redis.zrange(key, start_index, end_index, 'withscores')
+        ret = []
+        while k = val.shift and v = val.shift
+          ret << [k, v.to_i]
+        end
+        ret
+      else
+        from_redis redis.zrange(key, start_index, end_index)
+      end
+    end
+
+    # Return a range of values from +start_index+ to +end_index+ in reverse order. Redis: ZREVRANGE
+    def revrange(start_index, end_index, options={})
+      if options[:withscores]
+        val = from_redis redis.zrevrange(key, start_index, end_index, 'withscores')
+        ret = []
+        while k = val.shift and v = val.shift
+          ret << [k, v.to_i]
+        end
+        ret
+      else
+        from_redis redis.zrevrange(key, start_index, end_index)
+      end
+    end
+
+    # Return the all the elements in the sorted set at key with a score between min and max
+    # (including elements with score equal to min or max).  Options:
+    #     :count, :offset - passed to LIMIT
+    #     :withscores     - if true, scores are returned as well
+    # Redis: ZRANGEBYSCORE
+    def rangebyscore(min, max, options={})
+      args = []
+      args += ['limit', options[:offset] || 0, options[:limit] || options[:count]] if
+                options[:offset] || options[:limit] || options[:count]
+      args += ['withscores'] if options[:withscores]
+      from_redis redis.zrangebyscore(key, min, max, *args)
+    end
+
+    # Forwards compat (not yet implemented in Redis)
+    def revrangebyscore(min, max, options={})
+      args = []
+      args += ['limit', options[:offset] || 0, options[:limit] || options[:count]] if
+                options[:offset] || options[:limit] || options[:count]
+      args += ['withscores'] if options[:withscores]
+      from_redis redis.zrevrangebyscore(key, min, max, *args)
+    end
+
+    # Remove all elements in the sorted set at key with rank between start and end. Start and end are
+    # 0-based with rank 0 being the element with the lowest score. Both start and end can be negative
+    # numbers, where they indicate offsets starting at the element with the highest rank. For example:
+    # -1 is the element with the highest score, -2 the element with the second highest score and so forth. 
+    # Redis: ZREMRANGEBYRANK
+    def remrangebyrank(min, max)
+      redis.zremrangebyrank(key, min, max)
+    end
+
+    # Remove all the elements in the sorted set at key with a score between min and max (including
+    # elements with score equal to min or max). Redis: ZREMRANGEBYSCORE
+    def remrangebyscore(min, max)
+      redis.zremrangebyscore(key, min, max)
+    end
+
+    # Delete the value from the set.  Redis: ZREM
+    def delete(value)
+      redis.zrem(key, value)
+    end
+
+    # Increment the rank of that member atomically and return the new value. This
+    # method is aliased as incr() for brevity. Redis: ZINCRBY
+    def increment(member, by=1)
+      redis.zincrby(key, by, member).to_i
+    end
+    alias_method :incr, :increment
+    alias_method :incrby, :increment
+
+    # Convenience to calling increment() with a negative number. 
+    def decrement(by=1)
+      redis.zincrby(key, -by).to_i
+    end
+    alias_method :decr, :decrement
+    alias_method :decrby, :decrement
+
+    # Return the intersection with another set.  Can pass it either another set
+    # object or set name.  Also available as & which is a bit cleaner:
+    #
+    #    members_in_both = set1 & set2
+    #
+    # If you want to specify multiple sets, you must use +intersection+:
+    #
+    #    members_in_all = set1.intersection(set2, set3, set4)
+    #    members_in_all = set1.inter(set2, set3, set4)  # alias
+    #
+    # Redis: SINTER
+    def intersection(*sets)
+      from_redis redis.zinter(key, *keys_from_objects(sets))
+    end
+    alias_method :intersect, :intersection
+    alias_method :inter, :intersection
+    alias_method :&, :intersection
+    
+    # Calculate the intersection and store it in Redis as +name+. Returns the number
+    # of elements in the stored intersection. Redis: SUNIONSTORE
+    def interstore(name, *sets)
+      redis.zinterstore(name, key, *keys_from_objects(sets))
+    end
+
+    # Return the union with another set.  Can pass it either another set
+    # object or set name. Also available as | and + which are a bit cleaner:
+    #
+    #    members_in_either = set1 | set2
+    #    members_in_either = set1 + set2
+    #
+    # If you want to specify multiple sets, you must use +union+:
+    #
+    #    members_in_all = set1.union(set2, set3, set4)
+    #
+    # Redis: SUNION
+    def union(*sets)
+      from_redis redis.zunion(key, *keys_from_objects(sets))
+    end
+    alias_method :|, :union
+    alias_method :+, :union
+
+    # Calculate the union and store it in Redis as +name+. Returns the number
+    # of elements in the stored union. Redis: SUNIONSTORE
+    def unionstore(name, *sets)
+      redis.zunionstore(name, key, *keys_from_objects(sets))
+    end
+
+    # Return the difference vs another set.  Can pass it either another set
+    # object or set name. Also available as ^ or - which is a bit cleaner:
+    #
+    #    members_difference = set1 ^ set2
+    #    members_difference = set1 - set2
+    #
+    # If you want to specify multiple sets, you must use +difference+:
+    #
+    #    members_difference = set1.difference(set2, set3, set4)
+    #    members_difference = set1.diff(set2, set3, set4)
+    #
+    # Redis: SDIFF
+    def difference(*sets)
+      from_redis redis.zdiff(key, *keys_from_objects(sets))
+    end
+    alias_method :diff, :difference
+    alias_method :^, :difference
+    alias_method :-, :difference
+
+    # Calculate the diff and store it in Redis as +name+. Returns the number
+    # of elements in the stored union. Redis: SDIFFSTORE
+    def diffstore(name, *sets)
+      redis.zdiffstore(name, key, *keys_from_objects(sets))
+    end
+
+    # Returns true if the set has no members. Redis: SCARD == 0
+    def empty?
+      length == 0
+    end
+
+    def ==(x)
+      members == x
+    end
+    
+    def to_s
+      members.join(', ')
+    end
+
+    # Return the value at the given index. Can also use familiar list[index] syntax.
+    # Redis: ZRANGE
+    def at(index)
+      range(index, index).first
+    end
+
+    # Return the first element in the list. Redis: ZRANGE(0)
+    def first
+      at(0)
+    end
+
+    # Return the last element in the list. Redis: ZRANGE(-1)
+    def last
+      at(-1)
+    end
+    
+    # The number of members in the set. Aliased as size. Redis: ZCARD
+    def length
+      redis.zcard(key)
+    end
+    alias_method :size, :length
+
+    private
+    
+    def keys_from_objects(sets)
+      raise ArgumentError, "Must pass in one or more set names" if sets.empty?
+      sets.collect{|set| set.is_a?(Redis::SortedSet) ? set.key : set}
+    end
+    
+  end
+end

data/lib/redis/value.rb

@@ -9,10 +9,10 @@ class Redis
     include Redis::Helpers::Serialize
 
     attr_reader :key, :options, :redis
-    def initialize(key, redis=$redis, options={})
+    def initialize(key, *args)
       @key = key
-      @redis = redis
-      @options = options
+      @options = args.last.is_a?(Hash) ? args.pop : {}
+      @redis = args.first || $redis
       @redis.setnx(key, @options[:default]) if @options[:default]
     end
 

data/spec/redis_objects_instance_spec.rb

@@ -3,8 +3,10 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 require 'redis/counter'
 require 'redis/list'
-require 'redis/set'
 require 'redis/value'
+require 'redis/lock'
+require 'redis/set'
+require 'redis/sorted_set'
 
 describe Redis::Value do
   before :all do
@@ -46,6 +48,7 @@ describe Redis::Value do
     old.should be_nil
     old.value = 'Tuff'
     @value.renamenx('spec/value').should be_false
+    @value.value.should == 'Peter Pan'
   end
 
   after :all do
@@ -159,9 +162,11 @@ describe Redis::List do
     old = Redis::List.new('spec/list')
     old.should be_empty
     old << 'Tuff'
+    old.values.should == ['Tuff']
     @list.renamenx('spec/list').should be_false
     @list.renamenx(old).should be_false
     @list.renamenx('spec/foo').should be_true
+    old.values.should == ['Tuff']
     @list.clear
     @list.redis.del('spec/list2')
   end
@@ -171,6 +176,134 @@ describe Redis::List do
   end
 end
 
+describe Redis::Counter do
+  before :all do
+    @counter  = Redis::Counter.new('spec/counter')
+    @counter2 = Redis::Counter.new('spec/counter')
+  end
+
+  before :each do
+    @counter.reset
+  end
+
+  it "should support increment/decrement of counters" do
+    @counter.key.should == 'spec/counter'
+    @counter.incr(10)
+    @counter.should == 10
+    
+    # math proxy ops
+    (@counter == 10).should be_true
+    (@counter <= 10).should be_true
+    (@counter < 11).should be_true
+    (@counter > 9).should be_true
+    (@counter >= 10).should be_true
+    "#{@counter}".should == "10"
+
+    @counter.increment.should == 11
+    @counter.increment.should == 12
+    @counter2.increment.should == 13
+    @counter2.increment(2).should == 15
+    @counter.decrement.should == 14
+    @counter2.decrement.should == 13
+    @counter.decrement.should == 12
+    @counter2.decrement(4).should == 8
+    @counter.should == 8
+    @counter.reset.should be_true
+    @counter.should == 0
+    @counter.reset(15).should be_true
+    @counter.should == 15
+  end
+
+  after :all do
+    @counter.delete
+  end
+end
+
+describe Redis::Lock do
+  before :each do
+    $redis.flushall
+  end
+
+  it "should set the value to the expiration" do
+    start = Time.now
+    expiry = 15
+    lock = Redis::Lock.new(:test_lock, :expiration => expiry)
+    lock.lock do
+      expiration = $redis.get("test_lock").to_f
+
+      # The expiration stored in redis should be 15 seconds from when we started
+      # or a little more
+      expiration.should be_close((start + expiry).to_f, 2.0)
+    end
+
+    # key should have been cleaned up
+    $redis.get("test_lock").should be_nil
+  end
+
+  it "should set value to 1 when no expiration is set" do
+    lock = Redis::Lock.new(:test_lock)
+    lock.lock do
+      $redis.get('test_lock').should == '1'
+    end
+
+    # key should have been cleaned up
+    $redis.get("test_lock").should be_nil
+  end
+
+  it "should let lock be gettable when lock is expired" do
+    expiry = 15
+    lock = Redis::Lock.new(:test_lock, :expiration => expiry, :timeout => 0.1)
+
+    # create a fake lock in the past
+    $redis.set("test_lock", Time.now-(expiry + 60))
+
+    gotit = false
+    lock.lock do
+      gotit = true
+    end
+
+    # should get the lock because it has expired
+    gotit.should be_true
+    $redis.get("test_lock").should be_nil
+  end
+
+  it "should not let non-expired locks be gettable" do
+    expiry = 15
+    lock = Redis::Lock.new(:test_lock, :expiration => expiry, :timeout => 0.1)
+
+    # create a fake lock
+    $redis.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.get("test_lock").should_not be_nil
+  end
+
+  it "should not remove the key if lock is held past expiration" do
+    lock = Redis::Lock.new(:test_lock, :expiration => 0.0)
+
+    lock.lock do
+      sleep 1.1
+    end
+
+    # lock value should still be set since the lock was held for more than the expiry
+    $redis.get("test_lock").should_not be_nil
+  end
+end
+
 describe Redis::Set do
   before :all do
     @set = Redis::Set.new('spec/set')
@@ -288,45 +421,157 @@ describe Redis::Set do
   end
 end
 
-describe Redis::Counter do
+describe Redis::SortedSet do
   before :all do
-    @counter  = Redis::Counter.new('spec/counter')
-    @counter2 = Redis::Counter.new('spec/counter')
+    @set = Redis::SortedSet.new('spec/zset')
+    @set_1 = Redis::SortedSet.new('spec/zset_1')
+    @set_2 = Redis::SortedSet.new('spec/zset_2')
+    @set_3 = Redis::SortedSet.new('spec/zset_3')
   end
 
   before :each do
-    @counter.reset
+    @set.clear
+    @set_1.clear
+    @set_2.clear
+    @set_3.clear
   end
 
-  it "should support increment/decrement of counters" do
-    @counter.key.should == 'spec/counter'
-    @counter.incr(10)
-    @counter.should == 10
+  it "should handle sets of simple values" do
+    @set.should be_empty
+    @set['a'] = 11
+    @set['a'] = 21
+    @set.add('a', 5)
+    @set.score('a').should == 5
+    @set['a'] = 3
+    @set['b'] = 5
+    @set['c'] = 4
+
+    @set[0,-1].should == ['a','c','b']
+    @set.range(0,-1).should == ['a','c','b']
+    @set.revrange(0,-1).should == ['b','c','a']
+    @set[0..1].should == ['a','c']
+    @set[1].should == 'c'
+    @set.at(1).should == 'c'
+    @set.first.should == 'a'
+    @set.last.should == 'b'
+
+    @set.members.should == ['a','c','b']
+    @set.members(:withscores => true).should == [['a',3],['c',4],['b',5]]
+
+    @set['b'] = 5
+    @set['b'] = 6
+    @set.score('b').should == 6
+    @set.delete('c')
+    @set.to_s.should == 'a, b'
+    @set.should == ['a','b']
+    @set.members.should == ['a','b']
+    @set['d'] = 0
     
-    # math proxy ops
-    (@counter == 10).should be_true
-    (@counter <= 10).should be_true
-    (@counter < 11).should be_true
-    (@counter > 9).should be_true
-    (@counter >= 10).should be_true
-    "#{@counter}".should == "10"
+    @set.rangebyscore(0, 4).should == ['d','a']
+    @set.rangebyscore(0, 4, :count => 1).should == ['d']
+    @set.rangebyscore(0, 4, :count => 2).should == ['d','a']
+    @set.rangebyscore(0, 4, :limit => 2).should == ['d','a']
+
+    # Redis 1.3.5
+    # @set.rangebyscore(0,4, :withscores => true).should == [['d',4],['a',3]]
+    # @set.revrangebyscore(0,4).should == ['d','a']
+    # @set.revrangebyscore(0,4, :count => 2).should == ['a','d']
+    # @set.rank('b').should == 2
+    # @set.revrank('b').should == 3
+
+    @set['f'] = 100
+    @set['g'] = 110
+    @set['h'] = 120
+    @set['j'] = 130
+    @set.incr('h', 20)
+    @set.remrangebyscore(100, 120)
+    @set.members.should == ['d','a','b','j','h']
+
+    # Redis 1.3.5
+    # @set['h'] = 12
+    # @set['j'] = 13
+    # @set.remrangebyrank(4,-1)
+    # @set.members.should == ['d','a','b']
+
+    @set.delete('d')
+    @set['c'] = 200
+    @set.members.should == ['a','b','j','h','c']
+    @set.delete('c')
+    @set.length.should == 4
+    @set.size.should == 4
+  end
 
-    @counter.increment.should == 11
-    @counter.increment.should == 12
-    @counter2.increment.should == 13
-    @counter2.increment(2).should == 15
-    @counter.decrement.should == 14
-    @counter2.decrement.should == 13
-    @counter.decrement.should == 12
-    @counter2.decrement(4).should == 8
-    @counter.should == 8
-    @counter.reset.should be_true
-    @counter.should == 0
-    @counter.reset(15).should be_true
-    @counter.should == 15
+  # Not until Redis 1.3.5 with hashes
+  xit "Redis 1.3.5: should handle set intersections, unions, and diffs" do
+    @set_1['a'] = 5
+    @set_2['b'] = 18
+    @set_2['c'] = 12
+
+    @set_2['a'] = 10
+    @set_2['b'] = 15
+    @set_2['c'] = 15
+
+    (@set_1 & @set_2).sort.should == ['c','d','e']
+
+    @set_1 << 'a' << 'b' << 'c' << 'd' << 'e'
+    @set_2 << 'c' << 'd' << 'e' << 'f' << 'g'
+    @set_3 << 'a' << 'd' << 'g' << 'l' << 'm'
+    @set_1.sort.should == %w(a b c d e)
+    @set_2.sort.should == %w(c d e f g)
+    @set_3.sort.should == %w(a d g l m)
+    (@set_1 & @set_2).sort.should == ['c','d','e']
+    @set_1.intersection(@set_2).sort.should == ['c','d','e']
+    @set_1.intersection(@set_2, @set_3).sort.should == ['d']
+    @set_1.intersect(@set_2).sort.should == ['c','d','e']
+    @set_1.inter(@set_2, @set_3).sort.should == ['d']
+    @set_1.interstore(INTERSTORE_KEY, @set_2).should == 3
+    @set_1.redis.smembers(INTERSTORE_KEY).sort.should == ['c','d','e']
+    @set_1.interstore(INTERSTORE_KEY, @set_2, @set_3).should == 1
+    @set_1.redis.smembers(INTERSTORE_KEY).sort.should == ['d']
+
+    (@set_1 | @set_2).sort.should == ['a','b','c','d','e','f','g']
+    (@set_1 + @set_2).sort.should == ['a','b','c','d','e','f','g']
+    @set_1.union(@set_2).sort.should == ['a','b','c','d','e','f','g']
+    @set_1.union(@set_2, @set_3).sort.should == ['a','b','c','d','e','f','g','l','m']
+    @set_1.unionstore(UNIONSTORE_KEY, @set_2).should == 7
+    @set_1.redis.smembers(UNIONSTORE_KEY).sort.should == ['a','b','c','d','e','f','g']
+    @set_1.unionstore(UNIONSTORE_KEY, @set_2, @set_3).should == 9
+    @set_1.redis.smembers(UNIONSTORE_KEY).sort.should == ['a','b','c','d','e','f','g','l','m']
+
+    (@set_1 ^ @set_2).sort.should == ["a", "b"]
+    (@set_1 - @set_2).sort.should == ["a", "b"]
+    (@set_2 - @set_1).sort.should == ["f", "g"]
+    @set_1.difference(@set_2).sort.should == ["a", "b"]
+    @set_1.diff(@set_2).sort.should == ["a", "b"]
+    @set_1.difference(@set_2, @set_3).sort.should == ['b']
+    @set_1.diffstore(DIFFSTORE_KEY, @set_2).should == 2
+    @set_1.redis.smembers(DIFFSTORE_KEY).sort.should == ['a','b']
+    @set_1.diffstore(DIFFSTORE_KEY, @set_2, @set_3).should == 1
+    @set_1.redis.smembers(DIFFSTORE_KEY).sort.should == ['b']
+  end
+
+  it "should support renaming sets" do
+    @set.should be_empty
+    @set['zynga'] = 151
+    @set['playfish'] = 202
+    @set.members.should == ['zynga','playfish']
+    @set.key.should == 'spec/zset'
+    @set.rename('spec/zset2').should be_true
+    @set.key.should == 'spec/zset2'
+    old = Redis::SortedSet.new('spec/zset')
+    old.should be_empty
+    old['tuff'] = 54
+    @set.renamenx('spec/zset').should be_false
+    @set.renamenx(old).should be_false
+    @set.renamenx('spec/zfoo').should be_true
+    @set.clear
+    @set.redis.del('spec/zset2')
   end
 
   after :all do
-    @counter.delete
+    @set.clear
+    @set_1.clear
+    @set_2.clear
+    @set_3.clear
   end
-end
+end

data/spec/redis_objects_model_spec.rb

@@ -58,7 +58,7 @@ describe Redis::Objects do
 
   it "should provide a connection method" do
     Roster.redis.should == Redis::Objects.redis
-    Roster.redis.should be_kind_of(Redis)
+    # Roster.redis.should be_kind_of(Redis)
   end
 
   it "should create counter accessors" do
@@ -282,6 +282,19 @@ describe Redis::Objects do
     end
     error.should be_kind_of(NoMethodError)
   end
+
+  it "should support obtain_lock as a class method" do
+    error = nil
+    begin
+      Roster.obtain_lock(:resort, 2) do
+        Roster.redis.get("roster:2:resort_lock").should_not be_nil
+      end
+    rescue => error
+    end
+
+    error.should be_nil
+    Roster.redis.get("roster:2:resort_lock").should be_nil
+  end
   
   it "should handle simple values" do
     @roster.starting_pitcher.should == nil
@@ -635,4 +648,5 @@ describe Redis::Objects do
     error.should_not be_nil
     error.should be_kind_of(Redis::Lock::LockTimeout)
   end
+
 end