familia 0.7.1 → 0.9.0

data/lib/familia/redisobject.rb

@@ -1,25 +1,25 @@
 
 module Familia
-  
+
   class RedisObject
     @registration = {}
     @classes = []
-    
+
     # To be called inside every class that inherits RedisObject
     # +meth+ becomes the base for the class and instances methods
     # that are created for the given +klass+ (e.g. Obj.list)
     def RedisObject.register klass, meth
       registration[meth] = klass
     end
-    
+
     def RedisObject.registration
       @registration
     end
-    
+
     def RedisObject.classes
       @classes
     end
-    
+
     @db, @ttl = nil, nil
     class << self
       attr_accessor :parent
@@ -45,40 +45,40 @@ module Familia
         super(obj)
       end
     end
-    
+
     attr_reader :name, :parent
     attr_writer :redis
 
       # RedisObject instances are frozen. `cache` is a hash
       # for you to store values retreived from Redis. This is
       # not used anywhere by default, but you're encouraged
-      # to use it in your specific scenarios. 
+      # to use it in your specific scenarios.
     attr_reader :cache
-    
-    # +name+: If parent is set, this will be used as the suffix 
+
+    # +name+: If parent is set, this will be used as the suffix
     # for rediskey. Otherwise this becomes the value of the key.
     # If this is an Array, the elements will be joined.
-    # 
+    #
     # Options:
     #
-    # :class => A class that responds to Familia.load_method and 
+    # :class => A class that responds to Familia.load_method and
     # Familia.dump_method. These will be used when loading and
-    # saving data from/to redis to unmarshal/marshal the class. 
+    # saving data from/to redis to unmarshal/marshal the class.
     #
     # :reference => When true the index of the given value will be
-    # stored rather than the marshaled value. This assumes that 
-    # the marshaled object is stored at a separate key. When read, 
-    # from_redis looks for that separate key and returns the 
-    # unmarshaled object. :class must be specified. Default: false. 
+    # stored rather than the marshaled value. This assumes that
+    # the marshaled object is stored at a separate key. When read,
+    # from_redis looks for that separate key and returns the
+    # unmarshaled object. :class must be specified. Default: false.
     #
-    # :extend => Extend this instance with the functionality in an 
+    # :extend => Extend this instance with the functionality in an
     # other module. Literally: "self.extend opts[:extend]".
     #
     # :parent => The Familia object that this redis object belongs
     # to. This can be a class that includes Familia or an instance.
-    # 
+    #
     # :ttl => the time to live in seconds. When not nil, this will
-    # set the redis expire for this key whenever #save is called. 
+    # set the redis expire for this key whenever #save is called.
     # You can also call it explicitly via #update_expiration.
     #
     # :quantize => append a quantized timestamp to the rediskey.
@@ -99,7 +99,7 @@ module Familia
     #
     # :redis => an instance of Redis.
     #
-    # Uses the redis connection of the parent or the value of 
+    # Uses the redis connection of the parent or the value of
     # opts[:redis] or Familia.redis (in that order).
     def initialize name, opts={}
       @name, @opts = name, opts
@@ -108,57 +108,57 @@ module Familia
       self.extend @opts[:extend] if Module === @opts[:extend]
       @db = @opts.delete(:db)
       @parent = @opts.delete(:parent)
-      @ttl ||= @opts.delete(:ttl) 
+      @ttl ||= @opts.delete(:ttl)
       @redis ||= @opts.delete(:redis)
       @cache = {}
       init if respond_to? :init
     end
-    
+
     def clear_cache
       @cache.clear
     end
-    
+
     def echo meth, trace
       redis.echo "[#{self.class}\##{meth}] #{trace} (#{@opts[:class]}\#)"
     end
-    
+
     def redis
       return @redis if @redis
       parent? ? parent.redis : Familia.redis(db)
     end
-    
+
     # Returns the most likely value for db, checking (in this order):
     #   * the value from :class if it's a Familia object
     #   * the value from :parent
     #   * the value self.class.db
     #   * assumes the db is 0
-    # 
-    # After this is called once, this method will always return the 
+    #
+    # After this is called once, this method will always return the
     # same value.
-    def db 
+    def db
       # Note it's important that we select this value at the last
-      # possible moment rather than in initialize b/c the value 
-      # could be modified after that but before this is called. 
+      # possible moment rather than in initialize b/c the value
+      # could be modified after that but before this is called.
       if @opts[:class] && @opts[:class].ancestors.member?(Familia)
-        @opts[:class].db 
+        @opts[:class].db
       elsif parent?
         parent.db
       else
         self.class.db || @db || 0
       end
     end
-    
+
     def ttl
-      @ttl || 
-      (parent.ttl if parent?) || 
-      (@opts[:class].ttl if class?) || 
+      @ttl ||
+      (parent.ttl if parent?) ||
+      (@opts[:class].ttl if class?) ||
       (self.class.ttl if self.class.respond_to?(:ttl))
     end
-    
-    # returns a redis key based on the parent 
+
+    # returns a redis key based on the parent
     # object so it will include the proper index.
     def rediskey
-      if parent? 
+      if parent?
         # We need to check if the parent has a specific suffix
         # for the case where we have specified one other than :object.
         suffix = parent.kind_of?(Familia) && parent.class.suffix != :object ? parent.class.suffix : name
@@ -179,33 +179,33 @@ module Familia
       end
       k
     end
-    
+
     def class?
       !@opts[:class].to_s.empty? && @opts[:class].kind_of?(Familia)
     end
-    
+
     def parent?
       Class === parent || Module === parent || parent.kind_of?(Familia)
     end
-    
+
     def qstamp quantum=nil, pattern=nil, now=Familia.now
       quantum ||= ttl || 10.minutes
       pattern ||= '%H%M'
       rounded = now - (now % quantum)
       Time.at(rounded).utc.strftime(pattern)
     end
-    
+
     def update_expiration(ttl=nil)
       ttl ||= self.ttl
       return if ttl.to_i.zero?  # nil will be zero
       Familia.ld "#{rediskey} to #{ttl}"
       expire ttl.to_i
     end
-    
+
     def move db
       redis.move rediskey, db
     end
-        
+
     def rename newkey
       redis.rename rediskey, newkey
     end
@@ -213,50 +213,50 @@ module Familia
     def renamenx newkey
       redis.renamenx rediskey, newkey
     end
-    
-    def type 
+
+    def type
       redis.type rediskey
     end
-    
-    def delete 
+
+    def delete
       redis.del rediskey
     end
     alias_method :clear, :delete
     alias_method :del, :delete
-    
-    #def destroy! 
+
+    #def destroy!
     #  clear
     #  # TODO: delete redis objects for this instance
     #end
-    
+
     def exists?
       redis.exists(rediskey) && !size.zero?
     end
-    
+
     def realttl
       redis.ttl rediskey
     end
-    
+
     def expire sec
       redis.expire rediskey, sec.to_i
     end
-    
+
     def expireat unixtime
       redis.expireat rediskey, unixtime
     end
-    
+
     def persist
       redis.persist rediskey
     end
-    
+
     def dump_method
       @opts[:dump_method] || Familia.dump_method
     end
-    
+
     def load_method
       @opts[:load_method] || Familia.load_method
     end
-    
+
     def to_redis v
       return v unless @opts[:class]
       ret = case @opts[:class]
@@ -265,7 +265,7 @@ module Familia
       else
         if ::String === v
           v
-          
+
         elsif @opts[:reference] == true
           unless v.respond_to? :index
             raise Familia::Problem, "#{v.class} does not have an index method"
@@ -277,17 +277,17 @@ module Familia
 
         elsif v.respond_to? dump_method
           v.send dump_method
-          
+
         else
           raise Familia::Problem, "No such method: #{v.class}.#{dump_method}"
         end
       end
       if ret.nil?
-        Familia.ld "[#{self.class}\#to_redis] nil returned for #{@opts[:class]}\##{name}" 
+        Familia.ld "[#{self.class}\#to_redis] nil returned for #{@opts[:class]}\##{name}"
       end
       ret
     end
-    
+
     def multi_from_redis *values
       Familia.ld "multi_from_redis: (#{@opts}) #{values}"
       return [] if values.empty?
@@ -301,17 +301,17 @@ module Familia
         @opts[:class].induced_from v
       else
         objs = values
-        
+
         if @opts[:reference] == true
           objs = @opts[:class].rawmultiget *values
         end
         objs.compact!
         if @opts[:class].respond_to? load_method
-          objs.collect! { |obj| 
+          objs.collect! { |obj|
             begin
               v = @opts[:class].send load_method, obj
               if v.nil?
-                Familia.ld "[#{self.class}\#multi_from_redis] nil returned for #{@opts[:class]}\##{name}" 
+                Familia.ld "[#{self.class}\#multi_from_redis] nil returned for #{@opts[:class]}\##{name}"
               end
               v
             rescue => ex
@@ -328,28 +328,28 @@ module Familia
       end
       ret
     end
-    
+
     def from_redis v
       return @opts[:default] if v.nil?
       return v unless @opts[:class]
       ret = multi_from_redis v
       ret.first unless ret.nil? # return the object or nil
-    end 
-    
+    end
+
   end
-  
-  
+
+
   class List < RedisObject
-    
+
     def size
       redis.llen rediskey
     end
     alias_method :length, :size
-    
+
     def empty?
       size == 0
     end
-    
+
     def push *values
       echo :push, caller[0] if Familia.debug
       values.flatten.compact.each { |v| redis.rpush rediskey, to_redis(v) }
@@ -357,12 +357,12 @@ module Familia
       update_expiration
       self
     end
-    
+
     def << v
       push v
     end
     alias_method :add, :<<
-    
+
     def unshift *values
       values.flatten.compact.each { |v| redis.lpush rediskey, to_redis(v) }
       # TODO: test maxlength
@@ -370,15 +370,15 @@ module Familia
       update_expiration
       self
     end
-    
+
     def pop
       from_redis redis.rpop(rediskey)
     end
-    
+
     def shift
       from_redis redis.lpop(rediskey)
     end
-    
+
     def [] idx, count=nil
       if idx.is_a? Range
         range idx.first, idx.last
@@ -393,23 +393,23 @@ module Familia
       end
     end
     alias_method :slice, :[]
-    
+
     def delete v, count=0
       redis.lrem rediskey, count, to_redis(v)
     end
     alias_method :remove, :delete
     alias_method :rem, :delete
     alias_method :del, :delete
-    
+
     def range sidx=0, eidx=-1
       el = rangeraw sidx, eidx
       multi_from_redis *el
     end
-    
+
     def rangeraw sidx=0, eidx=-1
       redis.lrange(rediskey, sidx, eidx)
     end
-    
+
     def members count=-1
       echo :members, caller[0] if Familia.debug
       count -= 1 if count > 0
@@ -417,36 +417,36 @@ module Familia
     end
     alias_method :all, :members
     alias_method :to_a, :members
-    
+
     def membersraw count=-1
       count -= 1 if count > 0
       rangeraw 0, count
     end
-    
+
     #def revmembers count=1  #TODO
     #  range -count, 0
     #end
-    
+
     def each &blk
       range.each &blk
     end
-    
+
     def each_with_index &blk
       range.each_with_index &blk
     end
-    
+
     def eachraw &blk
       rangeraw.each &blk
     end
-    
+
     def eachraw_with_index &blk
       rangeraw.each_with_index &blk
     end
-    
+
     def collect &blk
       range.collect &blk
     end
-    
+
     def select &blk
       range.select &blk
     end
@@ -454,15 +454,15 @@ module Familia
     def collectraw &blk
       rangeraw.collect &blk
     end
-    
+
     def selectraw &blk
       rangeraw.select &blk
     end
-    
+
     def at idx
       from_redis redis.lindex(rediskey, idx)
     end
-    
+
     def first
       at 0
     end
@@ -470,12 +470,12 @@ module Familia
     def last
       at -1
     end
-    
+
     # TODO: def replace
     ## Make the value stored at KEY identical to the given list
     #define_method :"#{name}_sync" do |*latest|
     #  latest = latest.flatten.compact
-    #  # Do nothing if we're given an empty Array. 
+    #  # Do nothing if we're given an empty Array.
     #  # Otherwise this would clear all current values
     #  if latest.empty?
     #    false
@@ -492,31 +492,31 @@ module Familia
     #    true
     #  end
     #end
-    
+
     Familia::RedisObject.register self, :list
   end
-  
+
   class Set < RedisObject
-    
+
     def size
       redis.scard rediskey
     end
     alias_method :length, :size
-    
+
     def empty?
       size == 0
     end
-    
+
     def add *values
       values.flatten.compact.each { |v| redis.sadd rediskey, to_redis(v) }
       update_expiration
       self
     end
-    
+
     def << v
       add v
     end
-    
+
     def members
       echo :members, caller[0] if Familia.debug
       el = membersraw
@@ -528,19 +528,19 @@ module Familia
     def membersraw
       redis.smembers(rediskey)
     end
-    
+
     def each &blk
       members.each &blk
     end
-    
+
     def each_with_index &blk
       members.each_with_index &blk
     end
-    
+
     def collect &blk
       members.collect &blk
     end
-    
+
     def select &blk
       members.select &blk
     end
@@ -548,43 +548,43 @@ module Familia
     def eachraw &blk
       membersraw.each &blk
     end
-    
+
     def eachraw_with_index &blk
       membersraw.each_with_index &blk
     end
-    
+
     def collectraw &blk
       membersraw.collect &blk
     end
-    
+
     def selectraw &blk
       membersraw.select &blk
     end
-    
+
     def member? v
       redis.sismember rediskey, to_redis(v)
     end
     alias_method :include?, :member?
-    
+
     def delete v
       redis.srem rediskey, to_redis(v)
     end
     alias_method :remove, :delete
     alias_method :rem, :delete
     alias_method :del, :delete
-    
+
     def intersection *setkeys
       # TODO
     end
-    
+
     def pop
       redis.spop rediskey
     end
-    
+
     def move dstkey, v
       redis.smove rediskey, dstkey, v
     end
-    
+
     def random
       from_redis randomraw
     end
@@ -592,11 +592,11 @@ module Familia
     def randomraw
       redis.srandmember(rediskey)
     end
-    
+
     ## Make the value stored at KEY identical to the given list
     #define_method :"#{name}_sync" do |*latest|
     #  latest = latest.flatten.compact
-    #  # Do nothing if we're given an empty Array. 
+    #  # Do nothing if we're given an empty Array.
     #  # Otherwise this would clear all current values
     #  if latest.empty?
     #    false
@@ -613,57 +613,57 @@ module Familia
     #    true
     #  end
     #end
-    
+
     Familia::RedisObject.register self, :set
   end
-  
+
   class SortedSet < RedisObject
-    
+
     def size
       redis.zcard rediskey
     end
     alias_method :length, :size
-    
+
     def empty?
       size == 0
     end
-    
+
     # NOTE: The argument order is the reverse of #add
     # e.g. obj.metrics[VALUE] = SCORE
     def []= v, score
       add score, v
     end
-    
+
     # NOTE: The argument order is the reverse of #[]=
     def add score, v
       ret = redis.zadd rediskey, score, to_redis(v)
       update_expiration
       ret
     end
-    
+
     def score v
       ret = redis.zscore rediskey, to_redis(v)
       ret.nil? ? nil : ret.to_f
     end
     alias_method :[], :score
-    
+
     def member? v
       !rank(v).nil?
     end
     alias_method :include?, :member?
-    
+
     # rank of member +v+ when ordered lowest to highest (starts at 0)
     def rank v
       ret = redis.zrank rediskey, to_redis(v)
       ret.nil? ? nil : ret.to_i
     end
-    
+
     # rank of member +v+ when ordered highest to lowest (starts at 0)
     def revrank v
       ret = redis.zrevrank rediskey, to_redis(v)
       ret.nil? ? nil : ret.to_i
     end
-    
+
     def members count=-1, opts={}
       count -= 1 if count > 0
       el = membersraw count, opts
@@ -676,7 +676,7 @@ module Familia
       count -= 1 if count > 0
       rangeraw 0, count, opts
     end
-    
+
     def revmembers count=-1, opts={}
       count -= 1 if count > 0
       el = revmembersraw count, opts
@@ -687,7 +687,7 @@ module Familia
       count -= 1 if count > 0
       revrangeraw 0, count, opts
     end
-    
+
     def each &blk
       members.each &blk
     end
@@ -695,15 +695,15 @@ module Familia
     def each_with_index &blk
       members.each_with_index &blk
     end
-    
+
     def collect &blk
       members.collect &blk
     end
-    
+
     def select &blk
       members.select &blk
     end
-    
+
     def eachraw &blk
       membersraw.each &blk
     end
@@ -711,50 +711,54 @@ module Familia
     def eachraw_with_index &blk
       membersraw.each_with_index &blk
     end
-    
+
     def collectraw &blk
       membersraw.collect &blk
     end
-    
+
     def selectraw &blk
       membersraw.select &blk
     end
-    
+
     def range sidx, eidx, opts={}
       echo :range, caller[0] if Familia.debug
       el = rangeraw(sidx, eidx, opts)
       multi_from_redis *el
     end
-    
+
     def rangeraw sidx, eidx, opts={}
-      opts[:with_scores] = true if opts[:withscores]
-      redis.zrange(rediskey, sidx, eidx, opts)
+      # NOTE: :withscores (no underscore) is the correct naming for the
+      # redis-4.x gem. We pass :withscores through explicitly b/c
+      # redis.zrange et al only accept that one optional argument.
+      # Passing `opts`` through leads to an ArgumentError:
+      #
+      #   sorted_sets.rb:374:in `zrevrange': wrong number of arguments (given 4, expected 3) (ArgumentError)
+      #
+      redis.zrange(rediskey, sidx, eidx, :withscores => opts[:withscores])
     end
-    
+
     def revrange sidx, eidx, opts={}
       echo :revrange, caller[0] if Familia.debug
       el = revrangeraw(sidx, eidx, opts)
       multi_from_redis *el
     end
-    
+
     def revrangeraw sidx, eidx, opts={}
-      opts[:with_scores] = true if opts[:withscores]
-      redis.zrevrange(rediskey, sidx, eidx, opts)
+      redis.zrevrange(rediskey, sidx, eidx, :withscores => opts[:withscores])
     end
-    
+
     # e.g. obj.metrics.rangebyscore (now-12.hours), now, :limit => [0, 10]
     def rangebyscore sscore, escore, opts={}
       echo :rangebyscore, caller[0] if Familia.debug
       el = rangebyscoreraw(sscore, escore, opts)
       multi_from_redis *el
     end
-    
+
     def rangebyscoreraw sscore, escore, opts={}
       echo :rangebyscoreraw, caller[0] if Familia.debug
-      opts[:with_scores] = true if opts[:withscores]
-      redis.zrangebyscore(rediskey, sscore, escore, opts)
+      redis.zrangebyscore(rediskey, sscore, escore, :withscores => opts[:withscores])
     end
-    
+
     def remrangebyrank srank, erank
       redis.zremrangebyrank rediskey, srank, erank
     end
@@ -762,7 +766,7 @@ module Familia
     def remrangebyscore sscore, escore
       redis.zremrangebyscore rediskey, sscore, escore
     end
-    
+
     def increment v, by=1
       redis.zincrby(rediskey, by, v).to_i
     end
@@ -774,14 +778,14 @@ module Familia
     end
     alias_method :decr, :decrement
     alias_method :decrby, :decrement
-    
+
     def delete v
       redis.zrem rediskey, to_redis(v)
     end
     alias_method :remove, :delete
     alias_method :rem, :delete
     alias_method :del, :delete
-      
+
     def at idx
       range(idx, idx).first
     end
@@ -795,21 +799,21 @@ module Familia
     def last
       at(-1)
     end
-    
+
     Familia::RedisObject.register self, :zset
   end
 
   class HashKey < RedisObject
-    
+
     def size
       redis.hlen rediskey
     end
     alias_method :length, :size
-    
+
     def empty?
       size == 0
     end
-    
+
     def []= n, v
       ret = redis.hset rediskey, n, to_redis(v)
       update_expiration
@@ -817,63 +821,63 @@ module Familia
     end
     alias_method :put, :[]=
     alias_method :store, :[]=
-    
+
     def [] n
       from_redis redis.hget(rediskey, n)
     end
     alias_method :get, :[]
-    
+
     def fetch n, default=nil
       ret = self[n]
-      if ret.nil? 
+      if ret.nil?
         raise IndexError.new("No such index for: #{n}") if default.nil?
         default
       else
         ret
       end
     end
-    
+
     def keys
       redis.hkeys rediskey
     end
-    
+
     def values
       el = redis.hvals(rediskey)
       multi_from_redis *el
     end
-    
+
     def all
       # TODO: from_redis
       redis.hgetall rediskey
     end
     alias_method :to_hash, :all
     alias_method :clone, :all
-    
+
     def has_key? n
       redis.hexists rediskey, n
     end
     alias_method :include?, :has_key?
     alias_method :member?, :has_key?
-    
+
     def delete n
       redis.hdel rediskey, n
     end
     alias_method :remove, :delete
     alias_method :rem, :delete
     alias_method :del, :delete
-    
+
     def increment n, by=1
       redis.hincrby(rediskey, n, by).to_i
     end
     alias_method :incr, :increment
     alias_method :incrby, :increment
-    
+
     def decrement n, by=1
       increment n, -by
     end
     alias_method :decr, :decrement
     alias_method :decrby, :decrement
-    
+
     def update h={}
       raise ArgumentError, "Argument to bulk_set must be a hash" unless Hash === h
       data = h.inject([]){ |ret,pair| ret << [pair[0], to_redis(pair[1])] }.flatten
@@ -882,29 +886,29 @@ module Familia
       ret
     end
     alias_method :merge!, :update
-    
+
     def values_at *names
       el = redis.hmget(rediskey, *names.flatten.compact)
       multi_from_redis *el
     end
-    
+
     Familia::RedisObject.register self, :hash
   end
-  
+
   class String < RedisObject
-    
+
     def init
     end
-    
+
     def size
       to_s.size
     end
     alias_method :length, :size
-    
+
     def empty?
       size == 0
     end
-    
+
     def value
       echo :value, caller[0..5] if Familia.debug
       redis.setnx rediskey, @opts[:default] if @opts[:default]
@@ -912,29 +916,29 @@ module Familia
     end
     alias_method :content, :value
     alias_method :get, :value
-    
+
     def to_s
       value.to_s  # value can return nil which to_s should not
     end
-    
+
     def to_i
       value.to_i
     end
-    
+
     def value= v
       ret = redis.set rediskey, to_redis(v)
       update_expiration
       ret
     end
     alias_method :replace, :value=
-    alias_method :set, :value=  
-    
+    alias_method :set, :value=
+
     def setnx v
       ret = redis.setnx rediskey, to_redis(v)
       update_expiration
       ret
     end
-    
+
     def increment
       ret = redis.incr rediskey
       update_expiration
@@ -962,7 +966,7 @@ module Familia
       ret
     end
     alias_method :decrby, :decrementby
-    
+
     def append v
       ret = redis.append rediskey, v
       update_expiration
@@ -989,19 +993,18 @@ module Familia
       update_expiration
       ret
     end
-    
+
     def getset v
       ret = redis.getset rediskey, v
       update_expiration
       ret
     end
-    
+
     def nil?
       value.nil?
     end
-    
+
     Familia::RedisObject.register self, :string
   end
-  
-end
 
+end