familia 0.7.0 → 0.7.1

data/CHANGES.txt

@@ -1,5 +1,24 @@
 FAMILIA, CHANGES
 
+
+#### 0.7.1 (2011-04-09) ###############################
+
+* FIXED: Explicitly convert boolean conf options to true or false. Redis client
+  treats "true" as false.
+* FIXED: Clone options for each RedisObject instance to prevent cross contamination.
+* CHANGE: Fix for Familia objects with custom suffixes
+* CHANGE: Familia::String methods that modify the key now automatically update_expiration.
+* CHANGE: Familia::Object.prefix replaces :: in class names with Familia.delim
+* CHANGE: Use Familia::Object#object_proxy instead of Familia::Object.string :object
+* ADDED: Familia.qnow, Familia::Object.qstamp, RedisObject#qstamp
+* ADDED: RedisObject option: quantize
+* ADDED: Familia::Object#savenx
+* ADDED: Can now include a Familia object in Familia::Object.index (it uses its index)
+* ADDED: Dependency multi_json
+* ADDED: Hash#to_json, Hash.from_json, Array#to_json, Array.from_json
+* ADDED: Familia::Object#update!
+
+
 #### 0.7.0 (2011-03-04) ###############################
 
 * CHANGE: Use RedisObject#multi_from_redis when possible (uses mget command)

data/README.rdoc

@@ -1,8 +1,23 @@
-# Familia - 0.6 BETA
+# Familia - 0.7 BETA
 
 **Organize and store ruby objects in Redis**
 
 
+## Basic Example
+
+    class Bone < Storable
+      include Familia
+      index [:token, :name]
+      field :token
+      field :name
+      list   :owners
+      set    :tags
+      zset   :metrics
+      hash   :props
+      string :value, :default => "GREAT!"
+    end
+    
+    
 ## More Information
 
 * [Codes](http://github.com/delano/familia)

data/Rakefile

@@ -29,9 +29,7 @@ begin
     gem.add_dependency("uri-redis",  ">= 0.4.2")
     gem.add_dependency("gibbler",    ">= 0.8.6")
     gem.add_dependency("storable",   ">= 0.8.6")
-    
-    #gem.add_development_dependency("rspec", ">= 1.2.9")
-    #gem.add_development_dependency("mocha", ">= 0.9.8")
+    gem.add_dependency("multi_json", ">= 0.0.5")
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION.yml

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

data/familia.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{familia}
-  s.version = "0.7.0"
+  s.version = "0.7.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Delano Mandelbaum"]
-  s.date = %q{2011-03-04}
+  s.date = %q{2011-04-11}
   s.description = %q{Organize and store ruby objects in Redis}
   s.email = %q{delano@solutious.com}
   s.extra_rdoc_files = [
@@ -55,17 +55,20 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<uri-redis>, [">= 0.4.2"])
       s.add_runtime_dependency(%q<gibbler>, [">= 0.8.6"])
       s.add_runtime_dependency(%q<storable>, [">= 0.8.6"])
+      s.add_runtime_dependency(%q<multi_json>, [">= 0.0.5"])
     else
       s.add_dependency(%q<redis>, [">= 2.1.0"])
       s.add_dependency(%q<uri-redis>, [">= 0.4.2"])
       s.add_dependency(%q<gibbler>, [">= 0.8.6"])
       s.add_dependency(%q<storable>, [">= 0.8.6"])
+      s.add_dependency(%q<multi_json>, [">= 0.0.5"])
     end
   else
     s.add_dependency(%q<redis>, [">= 2.1.0"])
     s.add_dependency(%q<uri-redis>, [">= 0.4.2"])
     s.add_dependency(%q<gibbler>, [">= 0.8.6"])
     s.add_dependency(%q<storable>, [">= 0.8.6"])
+    s.add_dependency(%q<multi_json>, [">= 0.0.5"])
   end
 end
 

data/lib/familia.rb

@@ -3,6 +3,7 @@ FAMILIA_LIB_HOME = File.expand_path File.dirname(__FILE__) unless defined?(FAMIL
 require 'uri/redis'
 require 'gibbler'
 require 'familia/core_ext'
+require 'multi_json'
 
 module Familia
   module VERSION
@@ -85,7 +86,9 @@ module Familia
       uri &&= URI.parse uri if String === uri
       uri ||= Familia.uri
       conf = uri.conf
-      conf[:thread_safe] = true unless conf.has_key?(:thread_safe)
+      conf[:thread_safe] = "true" unless conf.has_key?(:thread_safe)
+      conf[:thread_safe] = conf[:thread_safe].to_s == "true"
+      conf[:logging] = conf[:logging].to_s == "true"
       if conf.has_key?(:logging) && conf[:logging].to_s == "true"
         require 'logger'
         require 'log4r'
@@ -128,6 +131,16 @@ module Familia
       end
       @apiversion 
     end
+    def now n=Time.now
+      n.utc.to_i
+    end
+    # A quantized timestamp
+    # e.g. 12:32 -> 12:30
+    # 
+    def qnow quantum=10.minutes, now=Familia.now
+      rounded = now - (now % quantum)
+      Time.at(rounded).utc.to_i
+    end
   end
   
   class Problem < RuntimeError; end
@@ -148,11 +161,6 @@ module Familia
     obj.send :include, Gibbler::Complex
     obj.extend Familia::ClassMethods
     obj.class_zset :instances, :class => obj, :reference => true
-    # :object is a special redis object because its reserved
-    # for storing the marshaled instance data (e.g. to_json).
-    # When it isn't defined explicitly we define it here b/c
-    # it's assumed to exist in other places (see #save).
-    obj.string :object, :class => obj unless obj.redis_object? :object
     Familia.classes << obj
   end
   

data/lib/familia/core_ext.rb

@@ -7,6 +7,27 @@ class Symbol
   end
 end
 
+class Hash
+  unless method_defined?(:to_json)
+    def to_json
+      MultiJson.encode self
+    end
+    def self.from_json str
+      MultiJson.decode str
+    end
+  end
+end
+class Array
+  unless method_defined?(:to_json)
+    def to_json
+      MultiJson.encode self
+    end
+    def self.from_json str
+      MultiJson.decode str
+    end
+  end
+end
+
 # Assumes Time::Units and Numeric mixins are available. 
 class String
   def in_seconds

data/lib/familia/object.rb

@@ -52,18 +52,12 @@ module Familia
         names
       end
     end
-    
     def inherited(obj)
       obj.db = self.db
       obj.uri = self.uri
       obj.ttl = self.ttl
       obj.parent = self
       obj.class_zset :instances, :class => obj, :reference => true
-      # :object is a special redis object because its reserved
-      # for storing the marshaled instance data (e.g. to_json).
-      # When it isn't defined explicitly we define it here b/c
-      # it's assumed to exist in other places (see #save).
-      obj.string :object, :class => obj unless obj.redis_object? :object
       Familia.classes << obj
       super(obj)
     end
@@ -97,13 +91,20 @@ module Familia
       redis_objects[name]
     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
+    
     # Creates a class method called +name+ that
     # returns an instance of the RedisObject +klass+ 
     def install_class_redis_object name, klass, opts
       raise ArgumentError, "Name is blank" if name.to_s.empty?
       name = name.to_s.to_sym
-      opts ||= {}
-      opts[:parent] ||= self
+      opts = opts.nil? ? {} : opts.clone
+      opts[:parent] = self unless opts.has_key?(:parent)
       # TODO: investigate using metaclass.redis_objects
       class_redis_objects_order << name
       class_redis_objects[name] = OpenStruct.new
@@ -179,7 +180,7 @@ module Familia
       val
     end
     def prefix=(a) @prefix = a end
-    def prefix(a=nil) @prefix = a if a; @prefix || self.name.downcase.to_sym end
+    def prefix(a=nil) @prefix = a if a; @prefix || self.name.downcase.gsub('::', Familia.delim).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
@@ -327,14 +328,22 @@ module Familia
       # 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
-        opts ||= {}
-        opts[:parent] ||= self
+        opts = opts.nil? ? {} : opts.clone
+        opts[:parent] = self unless opts.has_key?(:parent)
         redis_object = klass.new name, opts
         redis_object.freeze
         self.instance_variable_set "@#{name}", redis_object
       end
     end
     
+    def qstamp quantum=nil, pattern=nil, now=Familia.now
+      self.class.qstamp ttl, pattern, now
+    end
+    
+    def from_redis 
+      self.class.from_redis self.index
+    end
+    
     def redis
       self.class.redis
     end
@@ -380,21 +389,43 @@ module Familia
       end
       self.class.rediskey self.index, suffix
     end
-    def save
+    def object_proxy
+      @object_proxy ||= Familia::String.new self.rediskey, :ttl => ttl, :class => self.class
+      @object_proxy
+    end
+    def save meth=:set
       #Familia.trace :SAVE, Familia.redis(self.class.uri), redisuri, caller.first if Familia.debug?
       preprocess if respond_to?(:preprocess)
       self.update_time if self.respond_to?(:update_time)
-      # TODO: Check here (run checkup)
-      ret = self.object.set self               # object is a name reserved by Familia
+      ret = object_proxy.send(meth, self)       # object is a name reserved by Familia
       unless ret.nil?
         now = Time.now.utc.to_i
         self.class.instances.add now, self     # use this set instead of Klass.keys
-        self.object.update_expiration self.ttl # does nothing unless if not specified
+        object_proxy.update_expiration        # does nothing unless if not specified
       end
-      true
+      ret == "OK" || ret == true || ret == 1
+    end
+    def savenx 
+      save :setnx
+    end
+    def update! hsh=nil
+      updated = false
+      hsh ||= {}
+      if hsh.empty?
+        raise Familia::Problem, "No #{self.class}#{to_hash} method" unless respond_to?(:to_hash)
+        ret = from_redis
+        hsh = ret.to_hash if ret
+      end
+      hsh.keys.each { |field| 
+        v = hsh[field.to_s] || hsh[field.to_s.to_sym]
+        next if v.nil?
+        self.send(:"#{field}=", v) 
+        updated = true
+      }
+      updated
     end
     def destroy!
-      ret = self.object.delete
+      ret = object_proxy.delete
       if Familia.debug?
         Familia.trace :DELETED, Familia.redis(self.class.uri), "#{rediskey}: #{ret}", caller.first if Familia.debug?
       end
@@ -410,7 +441,9 @@ module Familia
           unless self.respond_to? meth
             raise NoIndex, "No such method: `#{meth}' for #{self.class}"
           end
-          self.send(meth) 
+          ret = self.send(meth)
+          ret = ret.index if ret.kind_of?(Familia)
+          ret
         }
         parts.join Familia.delim
       when Symbol, String
@@ -420,7 +453,9 @@ module Familia
           unless self.respond_to? self.class.index
             raise NoIndex, "No such method: `#{self.class.index}' for #{self.class}"
           end
-          self.send( self.class.index)
+          ret = self.send(self.class.index)
+          ret = ret.index if ret.kind_of?(Familia)
+          ret
         end
       else
         raise Familia::NoIndex, self

data/lib/familia/redisobject.rb

@@ -81,8 +81,20 @@ module Familia
     # 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.
+    # Takes one of the following:
+    #   Boolean: include the default stamp (now % 10 minutes)
+    #   Integer: the number of seconds to quantize to (e.g. 1.hour)
+    #   Array: All arguments for qstamp (quantum, pattern, Time.now)
+    #
     # :default => the default value (String-only)
     #
+    # :dump_method => the instance method to call to serialize the
+    # object before sending it to Redis (default: Familia.dump_method).
+    #
+    # :load_method => the class method to call to deserialize the
+    # object after it's read from Redis (default: Familia.load_method).
+    #
     # :db => the redis database to use (ignored if :redis is used).
     #
     # :redis => an instance of Redis.
@@ -146,7 +158,26 @@ module Familia
     # returns a redis key based on the parent 
     # object so it will include the proper index.
     def rediskey
-      parent? ? parent.rediskey(name, nil) : [name].flatten.compact.join(Familia.delim)
+      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
+        k = parent.rediskey(name, nil)
+      else
+        k = [name].flatten.compact.join(Familia.delim)
+      end
+      if @opts[:quantize]
+        args = case @opts[:quantize]
+        when Numeric
+          [@opts[:quantize]]        # :quantize => 1.minute
+        when Array
+          @opts[:quantize]          # :quantize => [1.day, '%m%D']
+        else
+          []                        # :quantize => true
+        end
+        k = [k, qstamp(*args)].join(Familia.delim)
+      end
+      k
     end
     
     def class?
@@ -157,6 +188,13 @@ module Familia
       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
@@ -891,28 +929,44 @@ module Familia
     alias_method :replace, :value=
     alias_method :set, :value=  
     
+    def setnx v
+      ret = redis.setnx rediskey, to_redis(v)
+      update_expiration
+      ret
+    end
+    
     def increment
-      redis.incr rediskey
+      ret = redis.incr rediskey
+      update_expiration
+      ret
     end
     alias_method :incr, :increment
 
     def incrementby int
-      redis.incrby rediskey, int.to_i
+      ret = redis.incrby rediskey, int.to_i
+      update_expiration
+      ret
     end
     alias_method :incrby, :incrementby
 
     def decrement
-      redis.decr rediskey
+      ret = redis.decr rediskey
+      update_expiration
+      ret
     end
     alias_method :decr, :decrement
 
     def decrementby int
-      redis.decrby rediskey, int.to_i
+      ret = redis.decrby rediskey, int.to_i
+      update_expiration
+      ret
     end
     alias_method :decrby, :decrementby
     
     def append v
-      redis.append rediskey, v
+      ret = redis.append rediskey, v
+      update_expiration
+      ret
     end
     alias_method :<<, :append
 
@@ -921,7 +975,9 @@ module Familia
     end
 
     def setbit offset, v
-      redis.setbit rediskey, offset, v
+      ret = redis.setbit rediskey, offset, v
+      update_expiration
+      ret
     end
 
     def getrange spoint, epoint
@@ -929,11 +985,15 @@ module Familia
     end
 
     def setrange offset, v
-      redis.setrange rediskey, offset, v
+      ret = redis.setrange rediskey, offset, v
+      update_expiration
+      ret
     end
     
     def getset v
-      redis.getset rediskey, v
+      ret = redis.getset rediskey, v
+      update_expiration
+      ret
     end
     
     def nil?

data/lib/familia/test_helpers.rb

@@ -32,3 +32,9 @@ class Customer < Storable
   class_string :message
 end
 
+class Limiter < Storable
+  include Familia
+  index :name
+  field :name
+  string :counter, :quantize => true, :ttl => 1.hour, :quantize => [10.minutes, '%H:%M', 1302468980]
+end

data/try/10_familia_try.rb

@@ -34,3 +34,20 @@ Bone.list? :owners
 definition = Bone.list :owners
 definition.klass
 #=> Familia::List
+
+## Familia.now
+Familia.now Time.parse('2011-04-10 20:56:20 UTC').utc
+#=> 1302468980
+
+## Familia.qnow
+Familia.qnow 10.minutes, 1302468980
+#=> 1302468600
+
+## Familia::Object.qstamp
+Limiter.qstamp 10.minutes, '%H:%M', 1302468980
+#=> '20:50'
+
+## Familia::Object#qstamp
+limiter = Limiter.new :request
+limiter.qstamp 10.minutes, '%H:%M', 1302468980
+##=> '20:50'

data/try/20_redis_object_try.rb

@@ -5,8 +5,8 @@ Familia.apiversion = 'v1'
 
 
 ## Redis Objects are unique per instance of a Familia class
-@a = Bone.new 'atoken'
-@b = Bone.new 'btoken'
+@a = Bone.new 'atoken', :name1
+@b = Bone.new 'atoken', :name2
 @a.owners.rediskey == @b.owners.rediskey
 #=> false
 
@@ -15,4 +15,31 @@ Familia.apiversion = 'v1'
 #=> true
 
 
+## Limiter#qstamp
+@limiter = Limiter.new :requests
+@limiter.counter.qstamp 10.minutes, '%H:%M', 1302468980
+#=> '20:50'
 
+## Redis Objects can be stored to quantized keys
+@limiter.counter.rediskey
+#=> "v1:limiter:requests:counter:20:50"
+
+## Increment counter
+@limiter.counter.clear
+@limiter.counter.increment
+#=> 1
+
+## Check ttl
+@limiter.counter.ttl
+#=> 3600
+
+## Check ttl for a different instance
+## (this exists to make sure options are cloned for each instance)
+@limiter2 = Limiter.new :requests
+@limiter2.counter.ttl
+#=> 3600
+
+## Check realttl
+sleep 1
+@limiter.counter.realttl
+#=> 3600-1

metadata

@@ -2,7 +2,7 @@
 name: familia
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors: 
 - Delano Mandelbaum
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-04 00:00:00 -05:00
+date: 2011-04-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,17 @@ dependencies:
         version: 0.8.6
   type: :runtime
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.5
+  type: :runtime
+  version_requirements: *id005
 description: Organize and store ruby objects in Redis
 email: delano@solutious.com
 executables: []