familia 0.6.0 → 0.6.1

data/CHANGES.txt

@@ -1,5 +1,16 @@
 FAMILIA, CHANGES
 
+#### 0.6.1 (2010-12-18) ###############################
+
+* CHANGE: Default initialize method calls initialize_redis_objects before super
+* CHANGE: Familia::String: lazy-set default value
+* ADDED: Familia.index can accept an Array of field names
+* ADDED: Support for using redis objects directly
+* ADDED RedisObject.ttl, RedisObject.db
+* ADDED: Familia classes maintain a set of instances (by index) which is updated
+automatically anytime an instance is saved or destroyed. 
+
+
 #### 0.6.0 (2010-12-10) ###############################
 
 NOTE: Mucho refactoring. 0.6 syntax is not compatible with previous versions. 

data/VERSION.yml

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

data/familia.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{familia}
-  s.version = "0.6.0"
+  s.version = "0.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Delano Mandelbaum"]
-  s.date = %q{2010-12-17}
+  s.date = %q{2010-12-18}
   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

@@ -1,13 +1,12 @@
 require 'ostruct'
 
-module Familia::Object
+module Familia
   require 'familia/redisobject'
-
   
   # Auto-extended into a class that includes Familia
   module ClassMethods
     
-    RedisObject.klasses.each_pair do |kind, klass|
+    Familia::RedisObject.registration.each_pair do |kind, klass|
       # e.g. 
       #
       #      list(name, klass, opts)
@@ -51,11 +50,19 @@ module Familia::Object
     
     def inherited(obj)
       obj.db = self.db
+      obj.ttl = self.ttl
+      obj.uri = self.uri
+      obj.parent = self
+      obj.class_set :instances
       Familia.classes << obj
       super(obj)
     end
     def extended(obj)
       obj.db = self.db
+      obj.ttl = self.ttl
+      obj.uri = self.uri
+      obj.parent = self
+      obj.class_set :instances
       Familia.classes << obj
     end
     
@@ -81,6 +88,7 @@ module Familia::Object
       name = name.to_s.to_sym
       opts ||= {}
       opts[:suffix] ||= nil
+      opts[:parent] ||= self
       # TODO: investigate metaclass.redis_objects
       class_redis_objects[name] = OpenStruct.new
       class_redis_objects[name].name = name
@@ -92,7 +100,7 @@ module Familia::Object
       metaclass.send :define_method, "#{name}=" do |v|
         send(name).replace v
       end
-      redis_object = klass.new name, self, opts
+      redis_object = klass.new name, opts
       redis_object.freeze
       self.instance_variable_set("@#{name}", redis_object)
       class_redis_objects[name]
@@ -101,9 +109,14 @@ module Familia::Object
     def from_redisdump dump
       dump # todo
     end
-    def db(db=nil) 
-      @db = db if db; 
-      @db
+    attr_accessor :parent
+    def ttl v=nil
+      @ttl = v unless v.nil?
+      @ttl || (parent ? parent.ttl : nil)
+    end
+    def db v=nil
+      @db = v unless v.nil?
+      @db || (parent ? parent.db : nil)
     end
     def db=(db) @db = db end
     def host(host=nil) @host = host if host; @host end
@@ -120,7 +133,7 @@ module Familia::Object
       @uri = URI.parse Familia.uri.to_s
       @uri.db = @db if @db 
       Familia.connect @uri #unless Familia.connected?(@uri)
-      @uri
+      @uri || (parent ? parent.uri : Familia.uri)
     end
     def redis
       Familia.redis(self.uri)
@@ -154,10 +167,6 @@ module Familia::Object
       @index ||= Familia.index
       @index
     end
-    def ttl(sec=nil)
-      @ttl = sec.to_i unless sec.nil? 
-      @ttl
-    end
     def suffixes
       redis_objects.keys.uniq
     end
@@ -278,8 +287,8 @@ module Familia::Object
     # including Familia. In that case, the replacement
     # must call initialize_redis_objects.
     def initialize *args
-      super   # call Storable#initialize or equivalent
       initialize_redis_objects
+      super   # call Storable#initialize or equivalent
     end
     
     # This needs to be called in the initialize method of
@@ -303,7 +312,9 @@ module Familia::Object
       # See RedisObject.install_redis_object
       self.class.redis_objects.each_pair do |name, redis_object_definition|
         klass, opts = redis_object_definition.klass, redis_object_definition.opts
-        redis_object = klass.new name, self, opts
+        opts ||= {}
+        opts[:parent] ||= self
+        redis_object = klass.new name, opts
         redis_object.freeze
         self.instance_variable_set "@#{name}", redis_object
       end
@@ -324,13 +335,6 @@ module Familia::Object
     def exists?
       Familia.redis(self.class.uri).exists rediskey
     end      
-    def destroy!
-      ret = Familia.redis(self.class.uri).del rediskey
-      if Familia.debug?
-        Familia.trace :DELETED, Familia.redis(self.class.uri), "#{rediskey}: #{ret}", caller.first
-      end
-      ret
-    end
     
     #def rediskeys
     #  self.class.redis_objects.each do |redis_object_definition|
@@ -347,7 +351,7 @@ module Familia::Object
       keynames
     end
     def rediskey(suffix=nil)
-      raise Familia::EmptyIndex, self.class if index.to_s.empty?
+      raise Familia::NoIndex, self.class if index.to_s.empty?
       if suffix.nil?
         suffix = self.class.suffix.kind_of?(Proc) ? 
                      self.class.suffix.call(self) : 
@@ -356,20 +360,47 @@ module Familia::Object
       self.class.rediskey self.index, suffix
     end
     def save
-      Familia.trace :SAVE, Familia.redis(self.class.uri), redisuri, caller.first
+      #Familia.trace :SAVE, Familia.redis(self.class.uri), redisuri, caller.first
       preprocess if respond_to?(:preprocess)
       self.update_time if self.respond_to?(:update_time)
-      ret = self.object.value = self
-      self.object.update_expiration self.ttl # does nothing unless if not specified
+      ret = self.object.set self               # object is a name reserved by Familia
+      unless ret.nil?
+        self.class.instances.add index         # use this set instead of Klass.keys
+        self.object.update_expiration self.ttl # does nothing unless if not specified
+      end
       true
     end
+    def destroy!
+      ret = self.object.delete
+      if Familia.debug?
+        Familia.trace :DELETED, Familia.redis(self.class.uri), "#{rediskey}: #{ret}", caller.first
+      end
+      self.class.instances.rem index if ret > 0
+      ret
+    end
     def index
-      if @index.nil?
-        self.class.index.kind_of?(Proc) ? 
-            self.class.index.call(self) : 
-            self.send(self.class.index)
+      case self.class.index
+      when Proc
+        self.class.index.call(self)
+      when Array
+        parts = self.class.index.collect { |meth| 
+          unless self.respond_to? meth
+            raise NoIndex, "No such method: `#{meth}' for #{self.class}"
+          end
+          self.send(meth) 
+        }
+        parts.join Familia.delim
+      when Symbol, String
+        if self.class.redis_object?(self.class.index.to_sym)
+          raise Familia::NoIndex, "Cannot use a RedisObject as an index"
+        else
+          unless self.respond_to? self.class.index
+            raise NoIndex, "No such method: `#{self.class.index}' for #{self.class}"
+          end
+          self.send self.class.index
+        end
       else
-        @index
+        raise Familia::NoIndex, self
       end
     end
     def index=(i)

data/lib/familia/redisobject.rb

@@ -1,32 +1,98 @@
 
-module Familia::Object
+module Familia
   
   class RedisObject
+    @registration = {}
+    @classes = []
     
-    @klasses = {}
+    # 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_reader :klasses
-      # To be called inside every class that inherits RedisObject
-      def register(kind, klass)
-        klasses[kind] = klass
+      attr_accessor :parent
+      attr_writer :ttl, :classes, :db, :uri
+      def ttl v=nil
+        @ttl = v unless v.nil?
+        @ttl || (parent ? parent.ttl : nil)
+      end
+      def db v=nil
+        @db = v unless v.nil?
+        @db || (parent ? parent.db : nil)
+      end
+      def uri v=nil
+        @uri = v unless v.nil?
+        @uri || (parent ? parent.uri : Familia.uri)
+      end
+      def inherited(obj)
+        obj.db = self.db
+        obj.ttl = self.ttl
+        obj.uri = self.uri
+        obj.parent = self
+        RedisObject.classes << obj
+        super(obj)
       end
     end
     
     attr_reader :name, :parent
-    def initialize n, p, opts={}
-      @name, @parent = n, p
-      @opts = opts
+    attr_accessor :redis
+    
+    # +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:
+    #
+    # :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. 
+    # You can also call it explicitly via #update_expiration.
+    #
+    # :default => the default value (String-only)
+    #
+    # :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. 
+    #
+    # :db => the redis database to use (ignored if :redis is used).
+    #
+    # :redis => an instance of Redis.
+    #
+    # 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
+      @name = @name.join(Familia.delim) if Array === @name
+      @opts[:ttl] ||= self.class.ttl
+      @opts[:db] ||= self.class.db
+      @parent = @opts.delete(:parent)
+      @redis = parent.redis if parent?
+      @redis ||= @opts.delete(:redis) || Familia.redis(@opts[:db])
       init if respond_to? :init
     end
     
     # returns a redis key based on the parent 
     # object so it will include the proper index.
     def rediskey
-      parent.rediskey(name)
+      parent? ? parent.rediskey(name) : Familia.rediskey(name)
     end
     
-    def redis
-      parent.redis
+    def parent?
+      Class === parent || parent.kind_of?(Familia)
     end
     
     def update_expiration(ttl=nil)
@@ -39,27 +105,32 @@ module Familia::Object
     def move db
       redis.move rediskey, db
     end
-    
-    def destroy! 
-      clear
-      # TODO: delete redis objects for this instance
-    end
-    
+        
     # TODO: rename, renamenx
     
     def type 
       redis.type rediskey
     end
     
-    def clear 
+    def delete 
       redis.del rediskey
     end
-    alias_method :delete, :clear
+    alias_method :clear, :delete
+    alias_method :del, :delete
+    
+    #def destroy! 
+    #  clear
+    #  # TODO: delete redis objects for this instance
+    #end
     
     def exists?
       !size.zero?
     end
     
+    def ttl
+      redis.ttl rediskey
+    end
+    
     def expire sec
       redis.expire rediskey, sec.to_i
     end
@@ -187,7 +258,7 @@ module Familia::Object
     #  end
     #end
     
-    Familia::Object::RedisObject.register :list, self
+    Familia::RedisObject.register self, :list
   end
   
   class Set < RedisObject
@@ -197,6 +268,10 @@ module Familia::Object
     end
     alias_method :length, :size
     
+    def empty?
+      size == 0
+    end
+    
     def << v
       redis.sadd rediskey, to_redis(v)
       self
@@ -207,6 +282,7 @@ module Familia::Object
       # TODO: handle @opts[:marshal]
       redis.smembers rediskey
     end
+    alias_method :all, :members
     alias_method :to_a, :members
     
     def member? v
@@ -217,11 +293,25 @@ module Familia::Object
     def delete v
       redis.srem rediskey, to_redis(v)
     end
+    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
+      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
@@ -243,7 +333,7 @@ module Familia::Object
     #  end
     #end
     
-    Familia::Object::RedisObject.register :set, self
+    Familia::RedisObject.register self, :set
   end
   
   class SortedSet < RedisObject
@@ -351,7 +441,7 @@ module Familia::Object
       at(-1)
     end
     
-    Familia::Object::RedisObject.register :zset, self
+    Familia::RedisObject.register self, :zset
   end
 
   class HashKey < RedisObject
@@ -429,13 +519,12 @@ module Familia::Object
       redis.hmget rediskey, *names.flatten.compact
     end
     
-    Familia::Object::RedisObject.register :hash, self
+    Familia::RedisObject.register self, :hash
   end
   
   class String < RedisObject
     
     def init
-      redis.setnx rediskey, @opts[:default] if @opts[:default]
     end
     
     def size
@@ -444,6 +533,7 @@ module Familia::Object
     alias_method :length, :size
     
     def value
+      redis.setnx rediskey, @opts[:default] if @opts[:default]
       redis.get rediskey
     end
     alias_method :get, :value
@@ -452,24 +542,66 @@ module Familia::Object
       value.to_s  # value can return nil which to_s should not
     end
     
+    def to_i
+      value.to_i
+    end
+    
     def value= v
       redis.set rediskey, to_redis(v)
-      to_redis(v)
     end
     alias_method :replace, :value=
     alias_method :set, :value=  
     
+    def increment
+      redis.incr rediskey
+    end
+    alias_method :incr, :increment
+
+    def incrementby int
+      redis.incrby rediskey, int.to_i
+    end
+    alias_method :incrby, :incrementby
+
+    def decrement
+      redis.decr rediskey
+    end
+    alias_method :decr, :decrement
+
+    def decrementby int
+      redis.decrby rediskey, int.to_i
+    end
+    alias_method :decrby, :decrementby
+    
+    def append v
+      redis.append rediskey, v
+    end
+    alias_method :<<, :append
+
+    def getbit offset
+      redis.getbit rediskey, offset
+    end
+
+    def setbit offset, v
+      redis.setbit rediskey, offset, v
+    end
+
+    def getrange spoint, epoint
+      redis.getrange rediskey, spoint, epoint
+    end
+
+    def setrange offset, v
+      redis.setrange rediskey, offset, v
+    end
+    
+    def getset v
+      redis.getset rediskey, v
+    end
+    
     def nil?
       value.nil?
     end
     
-    Familia::Object::RedisObject.register :string, self
-  end
-  
-  
-  class Counter < RedisObject
-    
-    #Familia::Object::RedisObject.register :counter, self
+    Familia::RedisObject.register self, :string
   end
   
 end

data/lib/familia/test_helpers.rb

@@ -2,11 +2,9 @@ require 'storable'
 
 class Bone < Storable
   include Familia
+  index [:token, :name]
   field :token
   field :name
-  def id
-    [token, name].join(':')
-  end
   list   :owners
   set    :tags
   zset   :metrics

data/lib/familia.rb

@@ -48,22 +48,6 @@ module Familia
       info "%s (%d:%s): %s" % [label, Thread.current.object_id, redis_client.object_id, ident] 
       info "  +-> %s" % [context].flatten[0..3].join("\n      ") if context
     end
-  end
-  
-  class Problem < RuntimeError; end
-  class EmptyIndex < Problem; end
-  class NonUniqueKey < Problem; end
-  class NotConnected < Problem
-    attr_reader :uri
-    def initialize uri
-      @uri = uri
-    end
-    def message
-      "No client for #{uri.serverid}"
-    end
-  end
-  
-  module ClassMethods
     def uri(db=nil)
       if db.nil?
         @uri
@@ -91,7 +75,11 @@ module Familia
       @conf
     end
     def redis(uri=nil)
-      uri &&= URI.parse uri if String === uri
+      if Integer === uri
+        uri = Familia.uri(uri)
+      else
+        uri &&= URI.parse uri if String === uri
+      end
       uri ||= Familia.uri
       connect(uri) unless @clients[uri.serverid] 
       #STDERR.puts "REDIS: #{uri} #{caller[0]}" if Familia.debug?
@@ -133,17 +121,30 @@ module Familia
     end
   end
   
+  class Problem < RuntimeError; end
+  class NoIndex < Problem; end
+  class NonUniqueKey < Problem; end
+  class NotConnected < Problem
+    attr_reader :uri
+    def initialize uri
+      @uri = uri
+    end
+    def message
+      "No client for #{uri.serverid}"
+    end
+  end
+  
   def self.included(obj)
-    obj.send :include, Familia::Object::InstanceMethods
+    obj.send :include, Familia::InstanceMethods
     obj.send :include, Gibbler::Complex
-    obj.extend Familia::Object::ClassMethods
+    obj.extend Familia::ClassMethods
+    obj.class_set :instances
     Familia.classes << obj
   end
   
   require 'familia/object'
   require 'familia/helpers'
 
-  extend Familia::ClassMethods
 end
 
 

data/try/10_familia_try.rb

@@ -2,20 +2,20 @@ require 'familia'
 require 'familia/test_helpers'
 
 ## Has all redis objects
-redis_objects = Familia::Object::RedisObject.klasses.keys
+redis_objects = Familia::RedisObject.registration.keys
 redis_objects.collect(&:to_s).sort
 #=> ["hash", "list", "set", "string", "zset"]
 
-## Familia::Object created class methods for redis object class
-Familia::Object::ClassMethods.public_method_defined? :list?
+## Familia created class methods for redis object class
+Familia::ClassMethods.public_method_defined? :list?
 #=> true
 
-## Familia::Object created class methods for redis object class
-Familia::Object::ClassMethods.public_method_defined? :list
+## Familia created class methods for redis object class
+Familia::ClassMethods.public_method_defined? :list
 #=> true
 
-## Familia::Object created class methods for redis object class
-Familia::Object::ClassMethods.public_method_defined? :lists
+## Familia created class methods for redis object class
+Familia::ClassMethods.public_method_defined? :lists
 #=> true
 
 ## A Familia object knows its redis objects
@@ -33,4 +33,4 @@ Bone.list? :owners
 ## A Familia object can get a specific redis object def
 definition = Bone.list :owners
 definition.klass
-#=> Familia::Object::List
+#=> Familia::List

data/try/21_redis_object_zset_try.rb

@@ -3,7 +3,7 @@ require 'familia/test_helpers'
 
 @a = Bone.new 'atoken', 'akey'
 
-## Familia::Object::SortedSet#add
+## Familia::SortedSet#add
 @a.metrics.add 2, :metric2
 @a.metrics.add 4, :metric4
 @a.metrics.add 0, :metric0
@@ -11,56 +11,56 @@ require 'familia/test_helpers'
 @a.metrics.add 3, :metric3
 #=> true
 
-## Familia::Object::SortedSet#members
+## Familia::SortedSet#members
 @a.metrics.members
 #=> ['metric0', 'metric1', 'metric2', 'metric3', 'metric4']
 
-## Familia::Object::SortedSet#members
+## Familia::SortedSet#members
 @a.metrics.membersrev
 #=> ['metric4', 'metric3', 'metric2', 'metric1', 'metric0']
 
-## Familia::Object::SortedSet#rank
+## Familia::SortedSet#rank
 @a.metrics.rank 'metric1'
 #=> 1
 
-## Familia::Object::SortedSet#revrank
+## Familia::SortedSet#revrank
 @a.metrics.revrank 'metric1'
 #=> 3
 
-## Familia::Object::SortedSet#rangebyscore
+## Familia::SortedSet#rangebyscore
 @a.metrics.rangebyscore 1, 3
 #=> ['metric1', 'metric2', 'metric3']
 
-## Familia::Object::SortedSet#rangebyscore with a limit
+## Familia::SortedSet#rangebyscore with a limit
 @a.metrics.rangebyscore 1, 3, :limit => [0, 2]
 #=> ['metric1', 'metric2']
 
-## Familia::Object::SortedSet#increment
+## Familia::SortedSet#increment
 @a.metrics.increment 'metric4', 100
 #=> 104
 
-## Familia::Object::SortedSet#decrement
+## Familia::SortedSet#decrement
 @a.metrics.decrement 'metric4', 50
 #=> 54
 
-## Familia::Object::SortedSet#score
+## Familia::SortedSet#score
 @a.metrics.score 'metric4'
 #=> 54
 
-## Familia::Object::SortedSet#remrangebyscore
+## Familia::SortedSet#remrangebyscore
 @a.metrics.remrangebyscore 3, 100
 #=> 2
 
-## Familia::Object::SortedSet#members after remrangebyscore
+## Familia::SortedSet#members after remrangebyscore
 @a.metrics.members
 #=> ['metric0', 'metric1', 'metric2']
 
-## Familia::Object::SortedSet#remrangebyrank
+## Familia::SortedSet#remrangebyrank
 @a.metrics.remrangebyrank 0, 1
 #=> 2
 
-## Familia::Object::SortedSet#members after remrangebyrank
+## Familia::SortedSet#members after remrangebyrank
 @a.metrics.members
 #=> ['metric2']
 
-@a.metrics.destroy!
+@a.metrics.clear

data/try/22_redis_object_set_try.rb

@@ -4,31 +4,31 @@ require 'familia/test_helpers'
 
 @a = Bone.new 'atoken', 'akey'
 
-## Familia::Object::Set#add
+## Familia::Set#add
 ret = @a.tags.add :a
 ret.class
-#=> Familia::Object::Set
+#=> Familia::Set
 
-## Familia::Object::Set#<<
+## Familia::Set#<<
 ret = @a.tags << :a << :b << :c
 ret.class
-#=> Familia::Object::Set
+#=> Familia::Set
 
-## Familia::Object::Set#members
+## Familia::Set#members
 @a.tags.members.sort
 #=> ['a', 'b', 'c']
 
-## Familia::Object::Set#member? knows when a value exists
+## Familia::Set#member? knows when a value exists
 @a.tags.member? :a
 #=> true
 
-## Familia::Object::Set#member? knows when a value doesn't exist
+## Familia::Set#member? knows when a value doesn't exist
 @a.tags.member? :x
 #=> false
 
-## Familia::Object::Set#member? knows when a value doesn't exist
+## Familia::Set#member? knows when a value doesn't exist
 @a.tags.size
 #=> 3
 
 
-@a.tags.destroy!
+@a.tags.clear

data/try/23_redis_object_list_try.rb

@@ -4,38 +4,38 @@ require 'familia/test_helpers'
 
 @a = Bone.new 'atoken', 'akey'
 
-## Familia::Object::List#push
+## Familia::List#push
 ret = @a.owners.push :value1
 ret.class
-#=> Familia::Object::List
+#=> Familia::List
 
-## Familia::Object::List#<<
+## Familia::List#<<
 ret = @a.owners << :value2 << :value3 << :value4
 ret.class
-#=> Familia::Object::List
+#=> Familia::List
 
-## Familia::Object::List#pop
+## Familia::List#pop
 @a.owners.pop
 #=> 'value4'
 
-## Familia::Object::List#first
+## Familia::List#first
 @a.owners.first
 #=> 'value1'
 
-## Familia::Object::List#last
+## Familia::List#last
 @a.owners.last
 #=> 'value3'
 
-## Familia::Object::List#to_a
+## Familia::List#to_a
 @a.owners.to_a
 #=> ['value1','value2','value3']
 
-## Familia::Object::List#delete
+## Familia::List#delete
 @a.owners.delete 'value3'
 #=> 1
 
-## Familia::Object::List#size
+## Familia::List#size
 @a.owners.size
 #=> 2
 
-@a.owners.destroy!
+@a.owners.clear

data/try/24_redis_object_string_try.rb

@@ -1,19 +1,66 @@
 require 'familia'
 require 'familia/test_helpers'
 
+Familia.apiversion = 'v1'
 
-@a = Bone.new 'atoken', 'akey'
+@a = Bone.new 'atoken2', 'akey'
 
-## Familia::Object::String#value should give default value
+## Bone#rediskey
+@a.rediskey
+#=> 'v1:bone:atoken2:akey:object'
+
+## Familia::String#value should give default value
 @a.value.value
 #=> 'GREAT!'
 
-## Familia::Object::String#value=
+## Familia::String#value=
 @a.value.value = "DECENT!"
 #=> 'DECENT!'
 
-## Familia::Object::String#to_s
+## Familia::String#to_s
 @a.value.to_s
 #=> 'DECENT!'
 
-@a.value.destroy!
+## Familia::String#destroy!
+@a.value.clear
+#=> 1
+
+## Familia::String.new
+@ret = Familia::String.new 'arbitrary:key'
+@ret.rediskey
+#=> 'v1:arbitrary:key'
+
+## instance set
+@ret.value = '1000'
+#=> '1000'
+
+## instance get
+@ret.value
+#=> '1000'
+
+## Familia::String#increment
+@ret.increment 
+#=> 1001
+
+## Familia::String#incrementby
+@ret.incrementby 99
+#=> 1100
+
+## Familia::String#decrement
+@ret.decrement 
+#=> 1099
+
+## Familia::String#decrementby
+@ret.decrementby 49
+#=> 1050
+
+## Familia::String#append
+@ret.append 'bytes'
+#=> 9
+
+## Familia::String#value after append
+@ret.value
+#=> '1050bytes'
+
+
+@ret.clear

data/try/25_redis_object_hash_try.rb

@@ -3,51 +3,51 @@ require 'familia/test_helpers'
 
 @a = Bone.new 'atoken', 'akey'
 
-## Familia::Object::HashKey#has_key? knows when there's no key
+## Familia::HashKey#has_key? knows when there's no key
 @a.props.has_key? 'fieldA'
 #=> false
 
-## Familia::Object::HashKey#[]=
+## Familia::HashKey#[]=
 @a.props['fieldA'] = '1'
 @a.props['fieldB'] = '2'
 @a.props['fieldC'] = '3'
 #=> '3'
 
-## Familia::Object::HashKey#[]
+## Familia::HashKey#[]
 @a.props['fieldA']
 #=> '1'
 
-## Familia::Object::HashKey#has_key? knows when there's a key
+## Familia::HashKey#has_key? knows when there's a key
 @a.props.has_key? 'fieldA'
 #=> true
 
-## Familia::Object::HashKey#all 
+## Familia::HashKey#all 
 @a.props.all.class
 #=> Hash
 
-## Familia::Object::HashKey#size counts the number of keys
+## Familia::HashKey#size counts the number of keys
 @a.props.size
 #=> 3
 
-## Familia::Object::HashKey#remove
+## Familia::HashKey#remove
 @a.props.remove 'fieldB'
 #=> 1
 
-## Familia::Object::HashKey#values
+## Familia::HashKey#values
 @a.props.values.sort
 #=> ['1', '3']
 
-## Familia::Object::HashKey#increment
+## Familia::HashKey#increment
 @a.props.increment 'counter', 100
 #=> 100
 
-## Familia::Object::HashKey#decrement
+## Familia::HashKey#decrement
 @a.props.decrement 'counter', 60
 #=> 40
 
-## Familia::Object::HashKey#values_at
+## Familia::HashKey#values_at
 @a.props.values_at 'fieldA', 'counter', 'fieldC'
 #=> ['1', '40', '3']
 
 
-@a.props.destroy!
+@a.props.clear

data/try/30_familia_object_try.rb

@@ -4,72 +4,84 @@ Familia.apiversion = 'v1'
 
 @a = Bone.new 'atoken', 'akey'
 
-## Familia::Object.prefix
+## Familia.prefix
 Bone.prefix
 #=> :bone
 
-## Familia::Object#index
+## Familia#index
 @a.index
 #=> 'atoken:akey'
 
-## Familia::Object.suffix
+## Familia.suffix
 Bone.suffix
 #=> :object
 
-## Familia::Object#rediskey
+## Familia#rediskey
 @a.rediskey
 #=> 'v1:bone:atoken:akey:object'
 
-## Familia::Object#rediskey
+## Familia#rediskey
 @a.rediskey
 #=> 'v1:bone:atoken:akey:object'
 
-## Familia::Object#save
-obj = Customer.new :delano, "Delano Mandelbaum"
-obj.save
+## Familia#save
+@cust = Customer.new :delano, "Delano Mandelbaum"
+@cust.save
 #=> true
 
-## Familia::Object#save with an object that expires
-obj = Session.new 'sessionid', :delano
-obj.save
-#=> true
+## Customer.instances
+Customer.instances.all
+#=> ['delano']
 
-## Familia::Object.from_redis
+## Familia.from_redis
 obj = Customer.from_redis :delano
 obj.custid
 #=> :delano
 
-## Familia::Object.class_list
+## Customer.destroy
+@cust.destroy!
+#=> 1
+
+## Customer.instances
+Customer.instances.size
+#=> 0
+
+## Familia#save with an object that expires
+obj = Session.new 'sessionid', :delano
+obj.save
+#=> true
+
+## Familia.class_list
 Customer.customers.class
-#=> Familia::Object::List
+#=> Familia::List
 
-## Familia::Object class rediskey
+## Familia class rediskey
 Customer.customers.rediskey
 #=> 'v1:customer:customers'
 
-## Familia::Object.class_list
+## Familia.class_list
 Customer.customers << :delano << :tucker << :morton
 Customer.customers.size
 #=> 3
 
-## Familia::Object class clear
+## Familia class clear
 Customer.customers.clear
 #=> 1
 
 
-## Familia::Object class replace 1
+## Familia class replace 1
 Customer.message.value = "msg1"
 #=> "msg1"
 
-## Familia::Object class replace 2
+## Familia class replace 2
 Customer.message.value
 #=> "msg1"
 
-## Familia::Object class replace 3
+## Familia class replace 3
 Customer.message = "msg2"
 #=> "msg2"
 
-## Familia::Object class replace 4
+## Familia class replace 4
 Customer.message.value
 #=> "msg2"
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: familia
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: false
   segments: 
   - 0
   - 6
-  - 0
-  version: 0.6.0
+  - 1
+  version: 0.6.1
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-17 00:00:00 -05:00
+date: 2010-12-18 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency