familia 0.6.4 → 0.6.8

data/CHANGES.txt

@@ -1,5 +1,23 @@
 FAMILIA, CHANGES
 
+#### 0.6.8 (2011-01-08) ###############################
+
+* CHANGE: RedisObject#members calls compact to remove nils
+* ADDED: RedisObject#to_redis/from_redis print message for nils to STDERR
+* ADDED: RedisObjects#membersraw for List, Set, and SortedSet
+
+
+#### 0.6.7 (2011-01-02) ###############################
+
+* FIXED: RedisObject#ttl, grab from instance first. 
+
+#### 0.6.6 (2011-01-02) ###############################
+
+* FIXED: Classes that include Familia now use the suffix defined for that class.
+* FIXED: Familia::String#value= calls update_expiration 
+* CHANGE: RedisObject classes grab the ttl from @opts[:class]
+* ADDED: Familia.classes can return RedisObject.classes
+
 
 #### 0.6.4 (2010-12-31) ###############################
 

data/Rakefile

@@ -40,7 +40,7 @@ end
 
 
 Rake::RDocTask.new do |rdoc|
-  version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}.#{config[:BUILD]}"
+  version = "#{config[:MAJOR]}.#{config[:MINOR]}.#{config[:PATCH]}"
   rdoc.rdoc_dir = "doc"
   rdoc.title = "#{name} #{version}"
   rdoc.rdoc_files.include("README*")

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :MAJOR: 0
 :MINOR: 6
-:PATCH: 4
+:PATCH: 8

data/familia.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{familia}
-  s.version = "0.6.4"
+  s.version = "0.6.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Delano Mandelbaum"]
-  s.date = %q{2010-12-31}
+  s.date = %q{2011-01-08}
   s.description = %q{Organize and store ruby objects in Redis}
   s.email = %q{delano@solutious.com}
   s.extra_rdoc_files = [

data/lib/familia/object.rb

@@ -103,7 +103,6 @@ module Familia
       raise ArgumentError, "Name is blank" if name.to_s.empty?
       name = name.to_s.to_sym
       opts ||= {}
-      opts[:suffix] ||= nil
       opts[:parent] ||= self
       # TODO: investigate using metaclass.redis_objects
       class_redis_objects_order << name
@@ -181,6 +180,9 @@ module Familia
     end
     def prefix=(a) @prefix = a end
     def prefix(a=nil) @prefix = a if a; @prefix || self.name.downcase.to_sym end
+    # TODO: grab db, ttl, uri from parent
+    #def parent=(a) @parent = a end
+    #def parent(a=nil) @parent = a if a; @parent end
     def index(i=nil, &blk) 
       @index = i || blk if i || !blk.nil?
       @index ||= Familia.index
@@ -274,8 +276,10 @@ module Familia
     def find suffix='*'
       list = Familia.redis(self.uri).keys(rediskey('*', suffix)) || []
     end
-    # idx can be a value or an Array of values used to create the index. 
-    def rediskey idx, suffix=nil
+    # idx can be a value or an Array of values used to create the index.
+    # We don't enforce a default suffix; that's left up to the instance.
+    # A nil +suffix+ will not be included in the key.
+    def rediskey idx, suffix=self.suffix
       raise RuntimeError, "No index for #{self}" if idx.to_s.empty?
       idx = Familia.join *idx if Array === idx
       idx &&= idx.to_s
@@ -362,7 +366,12 @@ module Familia
       end
       keynames
     end
-    def rediskey(suffix=nil)
+    # +suffix+ is the value to be used at the end of the redis key
+    # + ignored+ is literally ignored. It's around to maintain
+    # consistency with the class version of this method. 
+    # (RedisObject#rediskey may call against a class or instance).
+    def rediskey(suffix=nil, ignored=nil)
+      Familia.info "[#{self.class}] something was ignored" unless ignored.nil?
       raise Familia::NoIndex, self.class if index.to_s.empty?
       if suffix.nil?
         suffix = self.class.suffix.kind_of?(Proc) ? 

data/lib/familia/redisobject.rb

@@ -89,8 +89,8 @@ module Familia
       #Familia.ld [name, opts, caller[0]].inspect
       self.extend @opts[:extend] if Module === @opts[:extend]
       @db = @opts.delete(:db)
-      @ttl = @opts.delete(:ttl) 
       @parent = @opts.delete(:parent)
+      @ttl = @opts.delete(:ttl) 
       @redis ||= @opts.delete(:redis)
       init if respond_to? :init
     end
@@ -100,10 +100,6 @@ module Familia
       parent? ? parent.redis : Familia.redis(db)
     end
     
-    def ttl
-      @ttl || self.class.ttl
-    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
@@ -126,10 +122,21 @@ module Familia
       @db
     end
     
+    def ttl
+      @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 
     # object so it will include the proper index.
     def rediskey
-      parent? ? parent.rediskey(name) : [name].flatten.compact.join(Familia.delim)
+      parent? ? parent.rediskey(name, nil) : [name].flatten.compact.join(Familia.delim)
+    end
+    
+    def class?
+      !@opts[:class].to_s.empty? && @opts[:class].kind_of?(Familia)
     end
     
     def parent?
@@ -137,8 +144,8 @@ module Familia
     end
     
     def update_expiration(ttl=nil)
-      ttl ||= @opts[:ttl] || self.class.ttl
-      return unless ttl && ttl.to_i > 0
+      ttl ||= self.ttl
+      return if ttl.to_i.zero?  # nil will be zero
       Familia.ld "#{rediskey} to #{ttl}"
       expire ttl.to_i
     end
@@ -190,7 +197,7 @@ module Familia
     
     def to_redis v
       return v unless @opts[:class]
-      case @opts[:class]
+      ret = case @opts[:class]
       when String, Fixnum, Float, Gibbler::Digest
         v
       else
@@ -208,34 +215,43 @@ module Familia
           raise Familia::Problem, "No such method: #{v.class}.#{dump_method}"
         end
       end
+      if ret.nil?
+        Familia.info "[#{self.class}\#to_redis] nil returned for #{@opts[:class]}\##{name}" 
+      end
+      ret
     end
     
     def from_redis v
       return @opts[:default] if v.nil?
       return v unless @opts[:class]
-      case @opts[:class]
+      ret = case @opts[:class]
       when String
         v.to_s
       when Fixnum, Float
         @opts[:class].induced_from v
       else
-        if @opts[:reference] == true
-          @opts[:class].from_redis v
-        else
-          if @opts[:class].respond_to? load_method
-            @opts[:class].send load_method, v
+        begin
+          if @opts[:reference] == true
+            @opts[:class].from_redis v
           else
-            raise Familia::Problem, "No such method: #{@opts[:class]}##{load_method}"
+            if @opts[:class].respond_to? load_method
+              @opts[:class].send load_method, v
+            else
+              raise Familia::Problem, "No such method: #{@opts[:class]}##{load_method}"
+            end
           end
+        rescue => ex
+          Familia.info v
+          Familia.info "Parse error for #{rediskey} (#{load_method}): #{ex.message}"
+          Familia.info ex.backtrace
+          nil
         end
       end
-    rescue => ex
-      Familia.info v
-      Familia.info "Parse error for #{rediskey} (#{load_method}): #{ex.message}"
-      Familia.info ex.backtrace
-      nil
+      if ret.nil?
+        Familia.info "[#{self.class}\#from_redis] nil returned for #{@opts[:class]}\##{name}" 
+      end
+      ret
     end 
-    
   end
   
   
@@ -299,9 +315,11 @@ module Familia
     alias_method :del, :delete
     
     def range sidx=0, eidx=-1
-      redis.lrange(rediskey, sidx, eidx).collect do |v|
-        from_redis v
-      end
+      redis.lrange(rediskey, sidx, eidx).collect { |v| from_redis(v) }.compact
+    end
+
+    def rangeraw sidx=0, eidx=-1
+      redis.lrange(rediskey, sidx, eidx)
     end
     
     def members count=-1
@@ -311,6 +329,11 @@ module Familia
     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
@@ -323,6 +346,14 @@ module Familia
       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
@@ -330,6 +361,14 @@ module Familia
     def select &blk
       range.select &blk
     end
+
+    def collectraw &blk
+      rangeraw.collect &blk
+    end
+    
+    def selectraw &blk
+      rangeraw.select &blk
+    end
     
     def at idx
       from_redis redis.lindex(rediskey, idx)
@@ -389,12 +428,14 @@ module Familia
     end
     
     def members
-      redis.smembers(rediskey).collect do |v|
-        from_redis v
-      end
+      redis.smembers(rediskey).collect { |v| from_redis(v) }.compact
     end
     alias_method :all, :members
     alias_method :to_a, :members
+
+    def membersraw
+      redis.smembers(rediskey)
+    end
     
     def each &blk
       members.each &blk
@@ -411,6 +452,22 @@ module Familia
     def select &blk
       members.select &blk
     end
+
+    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)
@@ -420,6 +477,7 @@ module Familia
     def delete v
       redis.srem rediskey, to_redis(v)
     end
+    alias_method :remove, :delete
     alias_method :rem, :delete
     alias_method :del, :delete
     
@@ -514,11 +572,21 @@ module Familia
     end
     alias_method :to_a, :members
     alias_method :all, :members
+
+    def membersraw count=-1, opts={}
+      count -= 1 if count > 0
+      rangeraw 0, count, opts
+    end
     
     def revmembers count=-1, opts={}
       count -= 1 if count > 0
       revrange 0, count, opts
     end
+
+    def revmembersraw count=-1, opts={}
+      count -= 1 if count > 0
+      revrangeraw 0, count, opts
+    end
     
     def each &blk
       members.each &blk
@@ -536,26 +604,48 @@ module Familia
       members.select &blk
     end
     
+    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 range sidx, eidx, opts={}
-      opts[:with_scores] = true if opts[:withscores]
-      redis.zrange(rediskey, sidx, eidx, opts).collect do |v|
-        from_redis v
-      end
+      rangeraw(sidx, eidx, opts).collect { |v| from_redis(v) }.compact
     end
 
     def revrange sidx, eidx, opts={}
+      revrangeraw(sidx, eidx, opts).collect { |v| from_redis(v) }.compact
+    end
+
+    def rangeraw sidx, eidx, opts={}
       opts[:with_scores] = true if opts[:withscores]
-      redis.zrevrange(rediskey, sidx, eidx, opts).collect do |v|
-        from_redis v
-      end
+      redis.zrange(rediskey, sidx, eidx, opts)
+    end
+
+    def revrangeraw sidx, eidx, opts={}
+      opts[:with_scores] = true if opts[:withscores]
+      redis.zrevrange(rediskey, sidx, eidx, opts)
     end
     
     # e.g. obj.metrics.rangebyscore (now-12.hours), now, :limit => [0, 10]
     def rangebyscore sscore, escore, opts={}
+      rangebyscoreraw(sscore, escore, opts).collect { |v| from_redis( v) }.compact
+    end
+    
+    def rangebyscoreraw sscore, escore, opts={}
       opts[:with_scores] = true if opts[:withscores]
-      redis.zrangebyscore(rediskey, sscore, escore, opts).collect do |v|
-        from_redis v
-      end
+      redis.zrangebyscore(rediskey, sscore, escore, opts)
     end
     
     def remrangebyrank srank, erank
@@ -722,7 +812,9 @@ module Familia
     end
     
     def value= v
-      redis.set rediskey, to_redis(v)
+      ret = redis.set rediskey, to_redis(v)
+      update_expiration
+      ret
     end
     alias_method :replace, :value=
     alias_method :set, :value=  

data/lib/familia.rb

@@ -32,13 +32,16 @@ module Familia
   @dump_method = :to_json
   @load_method = :from_json
   class << self
-    attr_reader :classes, :clients, :uri
+    attr_reader :clients, :uri
     attr_accessor :debug, :secret, :delim, :dump_method, :load_method
     attr_writer :apiversion
     def debug?() @debug == true end
     def info *msg
       STDERR.puts *msg
     end
+    def classes with_redis_objects=false
+      with_redis_objects ? [@classes, RedisObject.classes].flatten : @classes
+    end
     def ld *msg
       info *msg if debug?
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: familia
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 6
-  - 4
-  version: 0.6.4
+  - 8
+  version: 0.6.8
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-31 00:00:00 -05:00
+date: 2011-01-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency