familia 1.0.0.pre.rc6 → 1.1.0.pre.rc1

data/lib/familia/{types → redistype/types}/string.rb

@@ -4,19 +4,21 @@ module Familia
   class String < RedisType
     def init; end
 
-    def size
+    # Returns the number of elements in the list
+    # @return [Integer] number of elements
+    def char_count
       to_s.size
     end
-    alias length size
+    alias size char_count
 
     def empty?
-      size.zero?
+      char_count.zero?
     end
 
     def value
       echo :value, caller(0..0) if Familia.debug
       redis.setnx rediskey, @opts[:default] if @opts[:default]
-      from_redis redis.get(rediskey)
+      deserialize_value redis.get(rediskey)
     end
     alias content value
     alias get value
@@ -30,7 +32,7 @@ module Familia
     end
 
     def value=(val)
-      ret = redis.set(rediskey, to_redis(val))
+      ret = redis.set(rediskey, serialize_value(val))
       update_expiration
       ret
     end
@@ -38,7 +40,7 @@ module Familia
     alias set value=
 
     def setnx(val)
-      ret = redis.setnx(rediskey, to_redis(val))
+      ret = redis.setnx(rediskey, serialize_value(val))
       update_expiration
       ret
     end

data/lib/familia/{types → redistype/types}/unsorted_set.rb

@@ -2,17 +2,20 @@
 
 module Familia
   class Set < RedisType
-    def size
+
+    # Returns the number of elements in the unsorted set
+    # @return [Integer] number of elements
+    def element_count
       redis.scard rediskey
     end
-    alias length size
+    alias size element_count
 
     def empty?
-      size.zero?
+      element_count.zero?
     end
 
     def add *values
-      values.flatten.compact.each { |v| redis.sadd? rediskey, to_redis(v) }
+      values.flatten.compact.each { |v| redis.sadd? rediskey, serialize_value(v) }
       update_expiration
       self
     end
@@ -24,7 +27,7 @@ module Familia
     def members
       echo :members, caller(1..1).first if Familia.debug
       elements = membersraw
-      multi_from_redis(*elements)
+      deserialize_values(*elements)
     end
     alias all members
     alias to_a members
@@ -66,16 +69,17 @@ module Familia
     end
 
     def member?(val)
-      redis.sismember rediskey, to_redis(val)
+      redis.sismember rediskey, serialize_value(val)
     end
     alias include? member?
 
-    def delete(val)
-      redis.srem rediskey, to_redis(val)
+    # Removes a member from the set
+    # @param value The value to remove from the set
+    # @return [Integer] The number of members that were removed (0 or 1)
+    def remove_element(value)
+      redis.srem rediskey, serialize_value(value)
     end
-    alias remove delete
-    alias rem delete
-    alias del delete
+    alias remove remove_element # deprecated
 
     def intersection *setkeys
       # TODO
@@ -90,7 +94,7 @@ module Familia
     end
 
     def random
-      from_redis randomraw
+      deserialize_value randomraw
     end
 
     def randomraw

data/lib/familia/redistype.rb

@@ -16,17 +16,19 @@ module Familia
     extend Familia::Features
 
     @registered_types = {}
-    @valid_options = %i[class parent ttl default db key redis]
+    @valid_options = %i[class parent ttl default db key redis suffix prefix]
     @db = nil
 
     feature :expiration
     feature :quantization
 
     class << self
-      attr_reader :registered_types, :valid_options
+      attr_reader :registered_types, :valid_options, :has_relations
       attr_accessor :parent
       attr_writer :db, :uri
+    end
 
+    module ClassMethods
       # To be called inside every class that inherits RedisType
       # +methname+ is the term used for the class and instance methods
       # that are created for the given +klass+ (e.g. set, list, etc)
@@ -58,7 +60,12 @@ module Familia
       def valid_keys_only(opts)
         opts.select { |k, _| RedisType.valid_options.include? k }
       end
+
+      def has_relations?
+        @has_relations ||= false
+      end
     end
+    extend ClassMethods
 
     attr_reader :keystring, :parent, :opts
     attr_writer :dump_method, :load_method
@@ -89,8 +96,11 @@ module Familia
     # :key => a hardcoded key to use instead of the deriving the from
     # the name and parent (e.g. a derived key: customer:custid:secret_counter).
     #
-    # Uses the redis connection of the parent or the value of
-    # opts[:redis] or Familia.redis (in that order).
+    # :suffix => the suffix to use for the key (e.g. 'scores' in customer:custid:scores).
+    # :prefix => the prefix to use for the key (e.g. 'customer' in customer:custid:scores).
+    #
+    # Connection precendence: uses the redis connection of the parent or the
+    # value of opts[:redis] or Familia.redis (in that order).
     def initialize(keystring, opts = {})
       #Familia.ld " [initializing] #{self.class} #{opts}"
       @keystring = keystring
@@ -210,9 +220,9 @@ module Familia
     include Serialization
   end
 
-  require_relative 'types/list'
-  require_relative 'types/unsorted_set'
-  require_relative 'types/sorted_set'
-  require_relative 'types/hashkey'
-  require_relative 'types/string'
+  require_relative 'redistype/types/list'
+  require_relative 'redistype/types/unsorted_set'
+  require_relative 'redistype/types/sorted_set'
+  require_relative 'redistype/types/hashkey'
+  require_relative 'redistype/types/string'
 end

data/lib/familia.rb

@@ -35,9 +35,13 @@ module Familia
   @members = []
 
   class << self
-    attr_accessor :debug
+    attr_writer :debug
     attr_reader :members
 
+    def debug
+      @debug ||= ENV['FAMILIA_DEBUG'].to_s.match?(/^(true|1)$/i)
+    end
+
     def included(member)
       raise Problem, "#{member} should subclass Familia::Horreum"
     end

data/try/10_familia_try.rb

@@ -21,7 +21,7 @@ Familia::Horreum::ClassMethods.public_method_defined? :list
 Familia::Horreum::ClassMethods.public_method_defined? :lists
 #=> true
 
-## A Familia object knows its redistype relativess
+## A Familia object knows its redistype relatives
 Bone.redis_types.is_a?(Hash) && Bone.redis_types.has_key?(:owners)
 #=> true
 

data/try/20_redis_type_try.rb

@@ -46,7 +46,7 @@ p [@limiter1.counter.parent.ttl, @limiter2.counter.parent.ttl]
 ##=> "v1:limiter:requests:counter:1302468600"
 
 ## Increment counter
-@limiter1.counter.clear
+@limiter1.counter.delete!
 @limiter1.counter.increment
 #=> 1
 

data/try/21_redis_type_zset_try.rb

@@ -65,4 +65,4 @@ require_relative './test_helpers'
 @a.metrics.members
 #=> ['metric2']
 
-@a.metrics.clear
+@a.metrics.delete!

data/try/22_redis_type_set_try.rb

@@ -31,4 +31,4 @@ ret.class
 #=> 3
 
 
-@a.tags.clear
+@a.tags.delete!

data/try/23_redis_type_list_try.rb

@@ -31,11 +31,11 @@ ret.class
 #=> ['value1','value2','value3']
 
 ## Familia::List#delete
-@a.owners.delete 'value3'
+@a.owners.remove 'value3'
 #=> 1
 
 ## Familia::List#size
 @a.owners.size
 #=> 2
 
-@a.owners.clear
+@a.owners.delete!

data/try/24_redis_type_string_try.rb

@@ -22,8 +22,8 @@ require_relative './test_helpers'
 #=> 'DECENT!'
 
 ## Familia::String#destroy!
-@a.value.clear
-#=> 1
+@a.value.delete!
+#=> true
 
 ## Familia::String.new
 @ret = Familia::String.new 'arbitrary:key'
@@ -63,4 +63,4 @@ require_relative './test_helpers'
 #=> '1050bytes'
 
 
-@ret.clear
+@ret.delete!

data/try/25_redis_type_hash_try.rb

@@ -50,4 +50,4 @@ require_relative './test_helpers'
 #=> ['1', '40', '3']
 
 
-@a.props.clear
+@a.props.delete!

data/try/26_redis_bool_try.rb

@@ -39,5 +39,5 @@ end
 #=> "true"
 
 ## Clear the hash key
-@hashkey.clear
-#=> 1
+@hashkey.delete!
+#=> true

data/try/27_redis_horreum_try.rb

@@ -36,8 +36,8 @@ Familia.debug = false
 #=> @identifier
 
 ## Remove the key
-@hashkey.clear
-#=> 1
+@hashkey.delete!
+#=> true
 
 ## Horreum objects can update and save their fields (1 of 2)
 @customer.name = 'John Doe'
@@ -47,12 +47,12 @@ Familia.debug = false
 @customer.save
 #=> true
 
-## Horreum object fields have a fast writer method (1 of 2)
+## Horreum object fields have a fast attribute method (1 of 2)
 Familia.trace :LOAD, @customer.redis, @customer.redisuri, caller if Familia.debug?
 @customer.name! 'Jane Doe'
 #=> 0
 
-## Horreum object fields have a fast writer method (2 of 2)
+## Horreum object fields have a fast attribute method (2 of 2)
 @customer.refresh!
 @customer.name
 #=> "Jane Doe"

data/try/30_familia_object_try.rb

@@ -36,8 +36,8 @@ Bone.suffix
 Customer.values.all.collect(&:custid)
 ##=> ['delano']
 
-## Familia.from_redis
-obj = Customer.from_identifier :delano
+## Can load an object from an identifier
+obj = Customer.find_by_id :delano
 [obj.class, obj.custid]
 #=> [Customer, 'delano']
 
@@ -68,9 +68,8 @@ Customer.customers.size
 #=> 3
 
 ## Familia class clear
-Customer.customers.clear
-#=> 1
-
+Customer.customers.delete!
+#=> true
 
 ## Familia class replace 1 of 4
 Customer.message.value = "msg1"
@@ -87,3 +86,7 @@ Customer.message = "msg2"
 ## Familia class replace 4 of 4
 Customer.message.value
 #=> "msg2"
+
+
+# Teardown
+Customer.values.delete!

data/try/40_customer_try.rb

@@ -18,7 +18,7 @@ require_relative './test_helpers'
 #=> true
 
 ## Customer can be retrieved by identifier
-retrieved_customer = Customer.from_identifier("test@example.com")
+retrieved_customer = Customer.find_by_id("test@example.com")
 retrieved_customer.custid
 #=> "test@example.com"
 
@@ -35,11 +35,11 @@ retrieved_customer.custid
 @customer.planid = "premium"
 @customer.save
 ident = @customer.identifier
-Customer.from_identifier(ident).planid
+Customer.find_by_id(ident).planid
 #=> "premium"
 
 ## Customer can increment secrets_created counter
-@customer.secrets_created.clear
+@customer.secrets_created.delete!
 @customer.secrets_created.increment
 @customer.secrets_created.value
 #=> '1'
@@ -74,7 +74,7 @@ Customer.instances.member?(@customer)
 #=> true
 
 ## Customer can be removed from class-level sorted set
-Customer.instances.delete(@customer)
+Customer.instances.remove(@customer)
 Customer.instances.member?(@customer)
 #=> false
 
@@ -90,7 +90,7 @@ Customer.instances.member?(@customer)
 
 ## Customer can be destroyed
 ret = @customer.destroy!
-cust = Customer.from_identifier("test@example.com")
+cust = Customer.find_by_id("test@example.com")
 exists = Customer.exists?("test@example.com")
 [ret, cust.nil?, exists]
 #=> [true, true, false]
@@ -137,4 +137,4 @@ Customer.instances.uri.to_s
 
 
 # Teardown
-Customer.instances.clear
+Customer.instances.delete!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: familia
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc6
+  version: 1.1.0.pre.rc1
 platform: ruby
 authors:
 - Delano Mandelbaum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -31,33 +31,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.0'
 - !ruby/object:Gem::Dependency
-  name: uri-redis
+  name: stringio
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 3.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 3.1.1
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: uri-redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :development
+        version: '1.3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '1.3'
 description: 'Familia: An ORM for Redis in Ruby.. Organize and store ruby objects
   in Redis'
 email: gems@solutious.com
@@ -96,14 +96,14 @@ files:
 - lib/familia/redistype.rb
 - lib/familia/redistype/commands.rb
 - lib/familia/redistype/serialization.rb
+- lib/familia/redistype/types/hashkey.rb
+- lib/familia/redistype/types/list.rb
+- lib/familia/redistype/types/sorted_set.rb
+- lib/familia/redistype/types/string.rb
+- lib/familia/redistype/types/unsorted_set.rb
 - lib/familia/refinements.rb
 - lib/familia/settings.rb
 - lib/familia/tools.rb
-- lib/familia/types/hashkey.rb
-- lib/familia/types/list.rb
-- lib/familia/types/sorted_set.rb
-- lib/familia/types/string.rb
-- lib/familia/types/unsorted_set.rb
 - lib/familia/utils.rb
 - lib/familia/version.rb
 - lib/redis_middleware.rb
@@ -142,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: An ORM for Redis in Ruby.

data/lib/familia/types/hashkey.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-module Familia
-  class HashKey < RedisType
-    def size
-      redis.hlen rediskey
-    end
-    alias length size
-
-    def empty?
-      size.zero?
-    end
-
-    # +return+ [Integer] Returns 1 if the field is new and added, 0 if the
-    #  field already existed and the value was updated.
-    def []=(field, val)
-      ret = redis.hset rediskey, field, to_redis(val)
-      update_expiration
-      ret
-    rescue TypeError => e
-      Familia.le "[hset]= #{e.message}"
-      Familia.ld "[hset]= #{rediskey} #{field}=#{val}" if Familia.debug
-      echo :hset, caller(1..1).first if Familia.debug # logs via echo to redis and back
-      klass = val.class
-      msg = "Cannot store #{field} => #{val.inspect} (#{klass}) in #{rediskey}"
-      raise e.class, msg
-    end
-    alias put []=
-    alias store []=
-
-    def [](field)
-      from_redis redis.hget(rediskey, field)
-    end
-    alias get []
-
-    def fetch(field, default = nil)
-      ret = self[field]
-      if ret.nil?
-        raise IndexError, "No such index for: #{field}" if default.nil?
-
-        default
-      else
-        ret
-      end
-    end
-
-    def keys
-      redis.hkeys rediskey
-    end
-
-    def values
-      elements = redis.hvals(rediskey)
-      multi_from_redis(*elements)
-    end
-
-    def hgetall
-      # TODO: Use from_redis. Also alias `all` is confusing with
-      # Onetime::Customer.all which returns all customers.
-      redis.hgetall rediskey
-    end
-    alias all hgetall
-
-    def key?(field)
-      redis.hexists rediskey, field
-    end
-    alias has_key? key?
-    alias include? key?
-    alias member? key?
-
-    def delete(field)
-      redis.hdel rediskey, field
-    end
-    alias remove delete
-    alias rem delete
-    alias del delete
-
-    def increment(field, by = 1)
-      redis.hincrby(rediskey, field, by).to_i
-    end
-    alias incr increment
-    alias incrby increment
-
-    def decrement(field, by = 1)
-      increment field, -by
-    end
-    alias decr decrement
-    alias decrby decrement
-
-    def update(hsh = {})
-      raise ArgumentError, 'Argument to bulk_set must be a hash' unless hsh.is_a?(Hash)
-
-      data = hsh.inject([]) { |ret, pair| ret << [pair[0], to_redis(pair[1])] }.flatten
-
-      ret = redis.hmset(rediskey, *data)
-      update_expiration
-      ret
-    end
-    alias merge! update
-
-    def values_at *fields
-      elements = redis.hmget(rediskey, *fields.flatten.compact)
-      multi_from_redis(*elements)
-    end
-
-    Familia::RedisType.register self, :hash # legacy, deprecated
-    Familia::RedisType.register self, :hashkey
-  end
-end