familia 0.7.0 → 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e5c7b9afb9555b1223964ed3e93ac014df3c278e9c7467dfd26c5fced66e7298
+  data.tar.gz: 5ec4da06d0223bc8f27a2ba0689df6482dfbaf971028c3431bdc330cad332c13
+SHA512:
+  metadata.gz: 7341bb23aa95bba387ab28377563d63d80933e99f3e5034ba65643c4806d7e7d7fc98308e9fc7ec7358d7c9775129bf0f02b198abd57b2b99bb1b28df0530a46
+  data.tar.gz: d4bbd6719f096d7f58ea00b0ae7a7ba2f5da71365b21b818863fc122b8a3856607248a803367ca9c87adc25b8d85b935331ce1413da4f803254baacf68cbb464

data/.gitignore

@@ -0,0 +1,18 @@
+.DS_Store
+.bundle
+.byebug*
+.history
+.devcontainer
+.vscode
+*.env
+*.log
+*.md
+*.txt
+!LICENSE.txt
+.ruby-version
+appendonlydir
+etc/config
+log
+tmp
+vendor
+*.gem

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/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+ruby '>= 2.6.8'
+
+gem 'redis', '~> 4.8'
+gem 'uri-redis'
+gem 'gibbler'
+gem 'storable'
+gem 'multi_json'
+
+group :development, :test do
+  gem 'tryouts', '~> 2.2'
+end

data/Gemfile.lock

@@ -0,0 +1,36 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    attic (1.0.0)
+      rake (~> 13.0.6)
+    drydock (0.6.9)
+    gibbler (1.0.0)
+      attic (~> 1.0)
+      rake (~> 13.0)
+    multi_json (1.15.0)
+    rake (13.0.6)
+    redis (4.8.1)
+    storable (0.10.0)
+    sysinfo (0.10.0)
+      drydock (< 1.0)
+      storable (~> 0.10)
+    tryouts (2.2.0)
+      sysinfo (~> 0.10)
+    uri-redis (0.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  gibbler
+  multi_json
+  redis (~> 4.8)
+  storable
+  tryouts (~> 2.2)
+  uri-redis
+
+RUBY VERSION
+   ruby 2.6.8p205
+
+BUNDLED WITH
+   2.4.12

data/README.md

@@ -0,0 +1,24 @@
+# Familia - 0.9 (2024-04-04)
+
+**Organize and store ruby objects in Redis**
+
+
+## Basic Example
+
+```ruby
+    class Flower < 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](https://github.com/delano/familia)

data/VERSION.yml

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

data/familia.gemspec

@@ -1,71 +1,23 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
 Gem::Specification.new do |s|
-  s.name = %q{familia}
-  s.version = "0.7.0"
+  s.name        = "familia"
+  s.version     = "0.9.0"
+  s.summary     = "Organize and store ruby objects in Redis"
+  s.description = "Familia: #{s.summary}"
+  s.authors     = ["Delano Mandelbaum"]
+  s.email       = "delano@solutious.com"
+  s.homepage    = "https://github.com/delano/familia"
+  s.license     = "MIT"
 
-  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.description = %q{Organize and store ruby objects in Redis}
-  s.email = %q{delano@solutious.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-     "README.rdoc"
-  ]
-  s.files = [
-    "CHANGES.txt",
-     "LICENSE.txt",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION.yml",
-     "familia.gemspec",
-     "lib/familia.rb",
-     "lib/familia/core_ext.rb",
-     "lib/familia/helpers.rb",
-     "lib/familia/object.rb",
-     "lib/familia/redisobject.rb",
-     "lib/familia/test_helpers.rb",
-     "lib/familia/tools.rb",
-     "try/00_familia.rb",
-     "try/10_familia_try.rb",
-     "try/20_redis_object_try.rb",
-     "try/21_redis_object_zset_try.rb",
-     "try/22_redis_object_set_try.rb",
-     "try/23_redis_object_list_try.rb",
-     "try/24_redis_object_string_try.rb",
-     "try/25_redis_object_hash_try.rb",
-     "try/30_familia_object_try.rb"
-  ]
-  s.homepage = %q{http://github.com/delano/familia}
-  s.rdoc_options = ["--charset=UTF-8"]
+  s.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{familia}
-  s.rubygems_version = %q{1.5.2}
-  s.summary = %q{Organize and store ruby objects in Redis}
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.required_ruby_version = Gem::Requirement.new(">= 2.6.8")
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<redis>, [">= 2.1.0"])
-      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"])
-    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"])
-    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"])
-  end
+  s.add_dependency "redis", "~> 4.8.0"
+  s.add_dependency "uri-redis", "~> 0.4", ">= 0.4.2"
+  s.add_dependency "gibbler", "~> 1.0.0"
+  s.add_dependency "storable", "~> 0.10.0"
+  s.add_dependency "multi_json", "~> 0.0", ">= 0.0.5"
 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

@@ -2,12 +2,12 @@ require 'ostruct'
 
 module Familia
   require 'familia/redisobject'
-  
+
   # Auto-extended into a class that includes Familia
   module ClassMethods
-    
+
     Familia::RedisObject.registration.each_pair do |kind, klass|
-      # e.g. 
+      # e.g.
       #
       #      list(name, klass, opts)
       #      list?(name)
@@ -22,12 +22,12 @@ module Familia
         obj = redis_objects[name.to_s.to_sym]
         !obj.nil? && klass == obj.klass
       end
-      define_method :"#{kind}s" do 
+      define_method :"#{kind}s" do
         names = redis_objects_order.select { |name| send(:"#{kind}?", name) }
         names.collect! { |name| redis_objects[name] }
         names
       end
-      # e.g. 
+      # e.g.
       #
       #      class_list(name, klass, opts)
       #      class_list?(name)
@@ -41,29 +41,23 @@ module Familia
         obj = class_redis_objects[name.to_s.to_sym]
         !obj.nil? && klass == obj.klass
       end
-      define_method :"class_#{kind}s" do 
+      define_method :"class_#{kind}s" do
         names = class_redis_objects_order.select { |name| ret = send(:"class_#{kind}?", name) }
         # TODO: This returns instances of the RedisObject class which
         # also contain the options. This is different from the instance
-        # RedisObjects defined above which returns the OpenStruct of name, klass, and opts. 
+        # RedisObjects defined above which returns the OpenStruct of name, klass, and opts.
         #names.collect! { |name| self.send name }
         # OR NOT:
         names.collect! { |name| class_redis_objects[name] }
         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
@@ -75,9 +69,9 @@ module Familia
       obj.class_zset :instances, :class => obj, :reference => true
       Familia.classes << obj
     end
-    
+
     # Creates an instance method called +name+ that
-    # returns an instance of the RedisObject +klass+ 
+    # returns an instance of the RedisObject +klass+
     def install_redis_object name, klass, opts
       raise ArgumentError, "Name is blank" if name.to_s.empty?
       name = name.to_s.to_sym
@@ -96,27 +90,34 @@ module Familia
       end
       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+ 
+    # 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
-      # TODO: investigate using metaclass.redis_objects
+      opts = opts.nil? ? {} : opts.clone
+      opts[:parent] = self unless opts.has_key?(:parent)
+      # TODO: investigate using attic.redis_objects
       class_redis_objects_order << name
       class_redis_objects[name] = OpenStruct.new
       class_redis_objects[name].name = name
       class_redis_objects[name].klass = klass
-      class_redis_objects[name].opts = opts 
+      class_redis_objects[name].opts = opts
       # An accessor method created in the metclass will
-      # access the instance variables for this class. 
-      metaclass.send :attr_reader, name
-      metaclass.send :define_method, "#{name}=" do |v|
+      # access the instance variables for this class.
+      attic.send :attr_reader, name
+      attic.send :define_method, "#{name}=" do |v|
         send(name).replace v
       end
-      metaclass.send :define_method, "#{name}?" do
+      attic.send :define_method, "#{name}?" do
         !send(name).empty?
       end
       redis_object = klass.new name, opts
@@ -124,7 +125,7 @@ module Familia
       self.instance_variable_set("@#{name}", redis_object)
       class_redis_objects[name]
     end
-    
+
     def from_redisdump dump
       dump # todo
     end
@@ -145,9 +146,9 @@ module Familia
     def port=(port) @port = port end
     def uri=(uri)
       uri = URI.parse uri if String === uri
-      @uri = uri 
+      @uri = uri
     end
-    def uri(uri=nil) 
+    def uri(uri=nil)
       self.uri = uri if !uri.to_s.empty?
       @uri ||= (parent ? parent.uri : Familia.uri)
       @uri.db = @db if @db && @uri.db.to_s != @db.to_s
@@ -165,7 +166,7 @@ module Familia
     end
     def all(suffix=:object)
       # objects that could not be parsed will be nil
-      keys(suffix).collect { |k| from_key(k) }.compact 
+      keys(suffix).collect { |k| from_key(k) }.compact
     end
     def any?(filter='*')
       size(filter) > 0
@@ -173,17 +174,17 @@ module Familia
     def size(filter='*')
       self.redis.keys(rediskey(filter)).compact.size
     end
-    def suffix(a=nil, &blk) 
+    def suffix(a=nil, &blk)
       @suffix = a || blk if a || !blk.nil?
       val = @suffix || Familia.default_suffix
       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
-    def index(i=nil, &blk) 
+    def index(i=nil, &blk)
       @index = i || blk if i || !blk.nil?
       @index ||= Familia.index
       @index
@@ -229,9 +230,9 @@ module Familia
       Familia.trace :MULTIGET, self.redis, "#{ids.size}: #{ids}", caller if Familia.debug?
       ids = self.redis.mget *ids
     end
-    
+
     # Returns an instance based on +idx+ otherwise it
-    # creates and saves a new instance base on +idx+. 
+    # creates and saves a new instance base on +idx+.
     # See from_index
     def load_or_create idx
       return from_redis(idx) if exists?(idx)
@@ -239,17 +240,17 @@ module Familia
       obj.save
       obj
     end
-    # Note +idx+ needs to be an appropriate index for 
+    # Note +idx+ needs to be an appropriate index for
     # the given class. If the index is multi-value it
     # must be passed as an Array in the proper order.
     # Does not call save.
     def from_index idx
-      obj = new 
+      obj = new
       obj.index = idx
       obj
     end
     def from_key objkey
-      raise ArgumentError, "Empty key" if objkey.to_s.empty?    
+      raise ArgumentError, "Empty key" if objkey.to_s.empty?
       Familia.trace :LOAD, Familia.redis(self.uri), objkey, caller if Familia.debug?
       obj = Familia::String.new objkey, :class => self
       obj.value
@@ -292,18 +293,18 @@ module Familia
       case list.size
       when 0
         nil
-      when 1 
+      when 1
         matches = list.first.match(/\A#{Familia.rediskey(prefix)}\:(.+?)\:#{suffix}/) || []
         matches[1]
       else
-        raise Familia::NonUniqueKey, "Short key returned more than 1 match" 
+        raise Familia::NonUniqueKey, "Short key returned more than 1 match"
       end
     end
   end
 
-  
+
   module InstanceMethods
-    
+
     # A default initialize method. This will be replaced
     # if a class defines its own initialize method after
     # including Familia. In that case, the replacement
@@ -312,33 +313,41 @@ module Familia
       initialize_redis_objects
       init *args if respond_to? :init
     end
-    
+
     # This needs to be called in the initialize method of
-    # any class that includes Familia. 
+    # any class that includes Familia.
     def initialize_redis_objects
       # Generate instances of each RedisObject. These need to be
       # unique for each instance of this class so they can refer
       # to the index of this specific instance.
       #
-      # i.e. 
+      # i.e.
       #     familia_object.rediskey              == v1:bone:INDEXVALUE:object
       #     familia_object.redis_object.rediskey == v1:bone:INDEXVALUE:name
       #
       # 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
-    
+
     def redisinfo
       info = {
         :uri  => self.class.uri,
@@ -350,51 +359,73 @@ module Familia
     end
     def exists?
       Familia.redis(self.class.uri).exists rediskey
-    end      
-    
+    end
+
     #def rediskeys
     #  self.class.redis_objects.each do |redis_object_definition|
-    #    
+    #
     #  end
     #end
-    
+
     def allkeys
       # TODO: Use redis_objects instead
       keynames = []
-      self.class.suffixes.each do |sfx| 
+      self.class.suffixes.each do |sfx|
         keynames << rediskey(sfx)
       end
       keynames
     end
     # +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. 
+    # 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) ? 
-                     self.class.suffix.call(self) : 
+        suffix = self.class.suffix.kind_of?(Proc) ?
+                     self.class.suffix.call(self) :
                      self.class.suffix
       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
+      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
-      true
+      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
@@ -406,11 +437,13 @@ module Familia
       when Proc
         self.class.index.call(self)
       when Array
-        parts = self.class.index.collect { |meth| 
+        parts = self.class.index.collect { |meth|
           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
@@ -434,11 +469,11 @@ module Familia
         unless Array === v && v.size == self.class.index.size
           raise ArgumentError, "Index mismatch (#{v.size} for #{self.class.index.size})"
         end
-        parts = self.class.index.each_with_index { |meth,idx| 
+        parts = self.class.index.each_with_index { |meth,idx|
           unless self.respond_to? "#{meth}="
             raise NoIndex, "No such method: `#{meth}=' for #{self.class}"
           end
-          self.send("#{meth}=", v[idx]) 
+          self.send("#{meth}=", v[idx])
         }
       when Symbol, String
         if self.class.redis_object?(self.class.index.to_sym)
@@ -452,7 +487,7 @@ module Familia
       else
         raise Familia::NoIndex, self
       end
-      
+
     end
     def expire(ttl=nil)
       ttl ||= self.class.ttl
@@ -491,8 +526,8 @@ module Familia
           len += 1
         end
       end
-      @id.shorten(len) 
+      @id.shorten(len)
     end
   end
-  
-end
+
+end