familia 1.2.0 → 2.0.0.pre.pre

data/try/features/expiration_try.rb

@@ -0,0 +1,86 @@
+# try/features/expiration_try.rb
+
+require_relative '../../lib/familia'
+require_relative '../helpers/test_helpers'
+
+Familia.debug = false
+
+# Test expiration feature functionality
+
+class ParentExpiring < Familia::Horreum
+  feature :expiration
+  default_expiration 1000
+end
+
+class ChildExpiring < ParentExpiring
+  identifier_field :id
+  field :id
+  default_expiration 1000
+end
+
+# Define a test class with expiration feature
+class ExpiringTest < Familia::Horreum
+  feature :expiration
+  identifier_field :id
+  field :id
+  field :data
+  default_expiration 300 # 5 minutes
+end
+
+# Setup test object
+@test_obj = ExpiringTest.new
+@test_obj.id = "expire_test_1"
+@test_obj.data = "test data"
+
+## Class has default_expiration method from feature
+ExpiringTest.respond_to?(:default_expiration)
+#=> true
+
+## Class has default expiration set
+ExpiringTest.default_expiration
+#=> 300.0
+
+## Can set different default expiration on class
+ExpiringTest.default_expiration(600)
+ExpiringTest.default_expiration
+#=> 600.0
+
+## Object inherits class default expiration
+@test_obj.default_expiration
+#=> 600.0
+
+## Can set default expiration on individual object
+@test_obj.default_expiration = 120
+@test_obj.default_expiration
+#=> 120.0
+
+## Object has update_expiration method
+@test_obj.respond_to?(:update_expiration)
+#=> true
+
+## Can call update_expiration method
+result = @test_obj.update_expiration(default_expiration: 180)
+[result.class, result]
+#=> [FalseClass, false]
+
+## Child inherits parent default expiration when not set
+ChildExpiring.default_expiration
+#=> 1000.0
+
+## Can override parent default expiration
+ChildExpiring.default_expiration(500)
+ChildExpiring.default_expiration
+#=> 500.0
+
+## Falls back to Familia.default_expiration when no class/parent default expiration
+class NoDefaultExpirationTest < Familia::Horreum
+  feature :expiration
+  identifier_field :id
+  field :id
+end
+NoDefaultExpirationTest.default_expiration
+#=> 0.0
+
+# Cleanup
+@test_obj.destroy!
+ExpiringTest.default_expiration(300) # Reset to original

data/try/features/quantization_try.rb

@@ -0,0 +1,90 @@
+# try/features/quantization_try.rb
+
+require_relative '../../lib/familia'
+require_relative '../helpers/test_helpers'
+
+Familia.debug = false
+
+# Test quantization feature functionality
+
+# Define a test class with quantization feature
+class QuantizedTest < Familia::Horreum
+  feature :quantization
+  identifier_field :id
+  field :id
+  field :data
+  default_expiration 300 # 5 minutes for testing
+end
+
+## Class has qstamp method from feature
+QuantizedTest.respond_to?(:qstamp)
+#=> true
+
+## Object has qstamp method from feature
+@test_obj = QuantizedTest.new
+@test_obj.respond_to?(:qstamp)
+#=> true
+
+## Familia has global qstamp method
+Familia.respond_to?(:qstamp)
+#=> true
+
+## Familia has now method for current time
+Familia.respond_to?(:now)
+#=> true
+
+## Can get current time with Familia.now
+now = Familia.now
+now.class
+#=> Float
+
+## qstamp with no arguments returns current quantized timestamp
+stamp1 = QuantizedTest.qstamp
+p [:QuantizedTest, QuantizedTest.qstamp]
+stamp1.class
+#=> Integer
+
+## qstamp with quantum returns quantized timestamp
+stamp2 = QuantizedTest.qstamp(3600) # 1 hour quantum
+stamp2.class
+#=> Integer
+
+## qstamp with quantum and pattern returns formatted string
+stamp3 = QuantizedTest.qstamp(3600, pattern: '%Y%m%d%H')
+stamp3.class
+#=> String
+
+## qstamp with time argument
+stamp4 = QuantizedTest.qstamp(3600, pattern: '%Y%m%d%H', time: Time.new(2023, 6, 15, 14, 30, 0))
+stamp4.class
+#=> String
+
+## Object qstamp works same as class method
+obj_stamp = @test_obj.qstamp(3600)
+obj_stamp.class
+#=> Integer
+
+## Different quantum values produce different buckets
+test_time = Time.utc(2023, 6, 15, 14, 30, 0) # use a fixed time, mid-day (avoid ToD boundary)
+@hour_stamp = QuantizedTest.qstamp(3600, time: test_time)
+@day_stamp = QuantizedTest.qstamp(86400, time: test_time)
+#=> 1686787200
+#=<> @hour_stamp
+#==> @hour_stamp == 1686837600
+
+## Pattern formatting works correctly
+time_str = QuantizedTest.qstamp(3600, pattern: '%Y-%m-%d %H:00:00')
+time_str.match?(/\d{4}-\d{2}-\d{2} \d{2}:00:00/)
+#=> true
+
+## Can pass custom time to qstamp
+test_time = Time.utc(2023, 6, 15, 14, 30, 1)
+# NOTE: _Not_  Time.new(2023, 6, 15, 14, 30, 1).utc which is the current time
+# locally where this code is running, then converted to UTC.
+custom_stamp = QuantizedTest.qstamp(3600, pattern: '%Y%m%d%H', time: test_time)
+custom_stamp
+#=> "2023061514"
+
+# Cleanup
+@test_obj.id = "quantized_test_obj" # Set identifier before cleanup
+@test_obj.destroy! if @test_obj

data/try/{35_feature_safedump_try.rb → features/safe_dump_advanced_try.rb}

@@ -1,9 +1,10 @@
-# frozen_string_literal: true
+# try/features/safe_dump_extended_try.rb
+
 
 # These tryouts test the safe dumping functionality.
 
-require_relative '../lib/familia'
-require_relative './test_helpers'
+require_relative '../../lib/familia'
+require_relative '../helpers/test_helpers'
 
 ## By default Familia::Base has no safe_dump_fields method
 Familia::Base.respond_to?(:safe_dump_fields)
@@ -42,12 +43,12 @@ Customer.safe_dump_fields
 @cust2.email = "test@example.com"
 @cust2.custid = "test@example.com"
 @all_safe_fields = @cust2.safe_dump.keys.sort
-
 @all_non_safe_fields = @cust2.instance_variables.map { |el|
   el.to_s[1..-1].to_sym # slice off the leading @
 }.sort
+# Check if any of the non-safe fields are in the safe dump (tryouts bug
+# if this comment is placed right before the last line.)
 p [1, all_non_safe_fields: @all_non_safe_fields]
-# Check if any of the non-safe fields are in the safe dump
 (@all_non_safe_fields & @all_safe_fields) - [:custid, :role, :verified, :updated, :created, :secrets_created]
 #=> []
 
@@ -56,7 +57,7 @@ Bone.respond_to?(:safe_dump_fields)
 #=> false
 
 ## Bone instances do not have safe_dump method
-@bone = Bone.new(name: "Rex", age: 3)
+@bone = Bone.new(token: "boneid1", name: "Rex")
 @bone.respond_to?(:safe_dump)
 #=> false
 

data/try/features/safe_dump_try.rb

@@ -0,0 +1,137 @@
+# try/features/safe_dump_try.rb
+
+require_relative '../../lib/familia'
+require_relative '../helpers/test_helpers'
+
+Familia.debug = false
+
+# Test SafeDump feature functionality
+
+# Define a test class with SafeDump feature
+class SafeDumpTest < Familia::Horreum
+  feature :safe_dump
+  identifier_field :id
+  field :id
+  field :name
+  field :email
+  field :secret_data
+
+  @safe_dump_fields = [
+    :id,
+    :name,
+    { :display_name => ->(obj) { "#{obj.name} (#{obj.id})" } },
+    { :has_email => ->(obj) { !obj.email.nil? && !obj.email.empty? } }
+  ]
+
+  def active?
+    true
+  end
+end
+
+# Setup test object
+@test_obj = SafeDumpTest.new
+@test_obj.id = "safe_test_1"
+@test_obj.name = "Test User"
+@test_obj.email = "test@example.com"
+@test_obj.secret_data = "sensitive_info"
+
+## Class has SafeDump methods
+SafeDumpTest.respond_to?(:safe_dump_fields)
+#=> true
+
+## Class has safe_dump_field_map method
+SafeDumpTest.respond_to?(:safe_dump_field_map)
+#=> true
+
+## Object has safe_dump method
+@test_obj.respond_to?(:safe_dump)
+#=> true
+
+## safe_dump_fields returns field names only
+fields = SafeDumpTest.safe_dump_fields
+fields
+#=> [:id, :name, :display_name, :has_email]
+
+## safe_dump_field_map returns callable map
+field_map = SafeDumpTest.safe_dump_field_map
+field_map.keys.sort
+#=> [:display_name, :has_email, :id, :name]
+
+## safe_dump_field_map values are callable
+field_map = SafeDumpTest.safe_dump_field_map
+field_map[:id]
+#==> _.respond_to?(:call)
+
+## safe_dump returns hash with safe fields only
+dump = @test_obj.safe_dump
+dump.keys.sort
+#=> [:display_name, :has_email, :id, :name]
+
+## safe_dump includes basic field values
+dump = @test_obj.safe_dump
+[dump[:id], dump[:name]]
+#=> ["safe_test_1", "Test User"]
+
+## safe_dump includes computed field values
+dump = @test_obj.safe_dump
+dump[:display_name]
+#=> "Test User (safe_test_1)"
+
+## safe_dump includes lambda field values
+dump = @test_obj.safe_dump
+dump[:has_email]
+#=> true
+
+## safe_dump excludes non-whitelisted fields
+dump = @test_obj.safe_dump
+dump.key?(:secret_data)
+#=> false
+
+## safe_dump excludes email field not in whitelist
+dump = @test_obj.safe_dump
+dump.key?(:email)
+#=> false
+
+## Safe dump works with nil values
+@test_obj.email = nil
+dump = @test_obj.safe_dump
+dump[:has_email]
+#=> false
+
+## Safe dump works with empty values
+@test_obj.email = ""
+dump = @test_obj.safe_dump
+dump[:has_email]
+#=> false
+
+## Can define safe_dump_fields with set_safe_dump_fields
+class DynamicSafeDump < Familia::Horreum
+  feature :safe_dump
+  identifier_field :id
+  field :id
+  field :data
+end
+
+DynamicSafeDump.set_safe_dump_fields(:id, :data)
+DynamicSafeDump.safe_dump_fields
+#=> [:id, :data]
+
+## Class with no safe_dump_fields defined has empty array
+class EmptySafeDump < Familia::Horreum
+  feature :safe_dump
+  identifier_field :id
+  field :id
+end
+
+EmptySafeDump.safe_dump_fields
+#=> []
+
+## Empty safe_dump returns empty hash
+@empty_obj = EmptySafeDump.new
+@empty_obj.id = "empty_test"
+@empty_obj.safe_dump
+#=> {}
+
+# Cleanup
+@test_obj.destroy! if @test_obj
+@empty_obj.destroy! if @empty_obj

data/try/{test_helpers.rb → helpers/test_helpers.rb}

@@ -1,14 +1,17 @@
-# rubocop:disable all
+# try/helpers/test_helpers.rb
+
+# To enable tracing and debug mode, run with the env vars set.
+#
+# e.g. FAMILIA_TRACE=1 FAMILIA_DEBUG=1 bundle exec try
 
 require 'digest'
-require_relative '../lib/familia'
+require_relative '../../lib/familia'
 
-Familia.debug = false # also # ENV['FAMILIA_TRACE'] = '1'
-Familia.enable_redis_logging = true
-Familia.enable_redis_counter = true
+Familia.enable_database_logging = true
+Familia.enable_database_counter = true
 
 class Bone < Familia::Horreum
-  identifier     [:token, :name]
+  identifier_field :token
   field     :token
   field     :name
   list      :owners
@@ -28,8 +31,8 @@ class Blone < Familia::Horreum
 end
 
 class Customer < Familia::Horreum
-  db 15 # don't use Onetime's default DB
-  ttl 5.years
+  logical_database 15 # Use something other than the default DB
+  default_expiration 5.years
 
   feature :safe_dump
   #feature :expiration
@@ -63,13 +66,12 @@ class Customer < Familia::Horreum
 
   counter :secrets_created
 
-  identifier :custid
+  identifier_field :custid
 
   field :custid
   field :sessid
   field :email
   field :role
-  field :key
   field :name
   field :passphrase_encryption
   field :passphrase
@@ -96,49 +98,24 @@ end
 @c.custid = "d@example.com"
 
 class Session < Familia::Horreum
-  db 14 # don't use Onetime's default DB
-  ttl 180.minutes
+  logical_database 14 # don't use Onetime's default DB
+  default_expiration 180.minutes
 
-  identifier :generate_id
+  identifier_field :sessid
 
   field :sessid
   field :shrimp
   field :custid
   field :useragent
-  field :key
   field :authenticated
   field :ipaddress
   field :created
   field :updated
 
-  def generate_id
-    @sessid ||= Familia.generate_id
-    @sessid
-  end
-
-  # The external identifier is used by the rate limiter to estimate a unique
-  # client. We can't use the session ID b/c the request agent can choose to
-  # not send cookies, or the user can clear their cookies (in both cases the
-  # session ID would change which would circumvent the rate limiter). The
-  # external identifier is a hash of the IP address and the customer ID
-  # which means that anonymous users from the same IP address are treated
-  # as the same client (as far as the limiter is concerned). Not ideal.
-  #
-  # To put it another way, the risk of colliding external identifiers is
-  # acceptable for the rate limiter, but not for the session data. Acceptable
-  # b/c the rate limiter is a temporary measure to prevent abuse, and the
-  # worse case scenario is that a user is rate limited when they shouldn't be.
-  # The session data is permanent and must be kept separate to avoid leaking
-  # data between users.
-  def external_identifier
-    elements = []
-    elements << ipaddress || 'UNKNOWNIP'
-    elements << custid || 'anon'
-    @external_identifier ||= Familia.generate_sha_hash(elements)
-    Familia.ld "[Session.external_identifier] sess identifier input: #{elements.inspect} (result: #{@external_identifier})"
-    @external_identifier
+  def save
+    self.sessid ||= Familia.generate_id  # Only generates when persisting
+    super
   end
-
 end
 @s = Session.new
 
@@ -146,11 +123,11 @@ class CustomDomain < Familia::Horreum
 
   feature :expiration
 
-  class_sorted_set :values, key: 'onetime:customdomain:values'
-
-  identifier :derive_id
+  class_sorted_set :values
 
+  identifier_field :generate_id
 
+  field :domainid
   field :display_domain
   field :custid
   field :base_domain
@@ -158,7 +135,6 @@ class CustomDomain < Familia::Horreum
   field :trd
   field :tld
   field :sld
-  # No :key field (so we can test hte behaviour in Horreum#initialize)
   field :txt_validation_host
   field :txt_validation_value
   field :status
@@ -167,18 +143,8 @@ class CustomDomain < Familia::Horreum
   field :created
   field :updated
   field :_original_value
-
-  # Derive a unique identifier for the object based on the display domain and
-  # the customer ID. This is used to ensure that the same domain can't be
-  # added twice by the same customer while avoiding collisions between customers.
-  def derive_id
-    elements = [
-      display_domain,
-      custid
-    ]
-    Familia.generate_sha_hash(*elements).slice(0, 8)
-  end
 end
+
 @d = CustomDomain.new
 @d.display_domain = "example.com"
 @d.custid = @c.custid
@@ -188,12 +154,11 @@ class Limiter < Familia::Horreum
   feature :expiration
   feature :quantization
 
-  ttl 30.minutes
-  identifier :name
+  identifier_field :name
+  default_expiration 30.minutes
   field :name
-  # No :key field (so we can test hte behaviour in Horreum#initialize)
 
-  string :counter, :ttl => 1.hour, :quantize => [10.minutes, '%H:%M', 1302468980]
+  string :counter, :default_expiration => 1.hour, :quantize => [10.minutes, '%H:%M', 1302468980]
 
   def identifier
     @name

data/try/{27_redis_horreum_try.rb → horreum/base_try.rb}

@@ -1,5 +1,7 @@
-require_relative '../lib/familia'
-require_relative './test_helpers'
+# try/horreum/base_try.rb
+
+require_relative '../../lib/familia'
+require_relative '../helpers/test_helpers'
 
 Familia.debug = false
 
@@ -8,6 +10,9 @@ Familia.debug = false
 @hashkey = Familia::HashKey.new 'tryouts-27'
 
 ## Customer passed as value is returned as string identifier, on assignment as string
+## TODO: Revisit these @identifier testcases b/c I think we don't want to be setting
+## the @identifier instance var anymore since identifer_field should only take field
+## names now (and might be removed altogether).
 @hashkey["test1"] = @customer.identifier
 #=> @identifier
 
@@ -48,7 +53,7 @@ Familia.debug = false
 #=> true
 
 ## Horreum object fields have a fast attribute method (1 of 2)
-Familia.trace :LOAD, @customer.redis, @customer.redisuri, caller if Familia.debug?
+Familia.trace :LOAD, @customer.dbclient, @customer.uri, caller if Familia.debug?
 @customer.name! 'Jane Doe'
 #=> 0
 
@@ -68,26 +73,46 @@ Familia.trace :LOAD, @customer.redis, @customer.redisuri, caller if Familia.debu
 #=> true
 
 ## All horrerum objects have a key field
-@customer.key
+@customer.identifier
 #=> @identifier
 
 ## Even ones that didn't define it
-@cd = CustomDomain.new "www.example.com", "@identifier"
-@cd.key
+class NoIdentifierClass < Familia::Horreum
+  field :name
+end
+@no_id = NoIdentifierClass.new name: "test"
+@no_id.identifier
 #=> nil
 
 ## We can call #identifier directly if we want to "lasy load" the unique identifier
+@cd = CustomDomain.new display_domain: "www.example.com", custid: "domain-test@example.com"
 @cd.identifier
-#=> "7565befd"
-
-## The #key field will still be nil
-@cd.key
-#=> nil
+#=:> String
+#=/=> _.empty?
+#==> _.size > 16
+#=~>/\A[0-9a-z]+\z/
+
+## The identifier is now memoized (same value each time)
+@cd_first_call = @cd.identifier
+@cd_second_call = @cd.identifier
+@cd_first_call == @cd_second_call
+#=> true
 
 ## But once we save
 @cd.save
 #=> true
 
-## The key will be set
-@cd.key
-#=> "7565befd"
+## The key has been set now that the instance has been saved
+@cd.identifier
+#=:> String
+#=/=> _.empty?
+#==> _.size > 16
+#=~>/\A[0-9a-z]+\z/
+
+## Array-based identifiers are no longer supported and raise clear errors at class definition time
+class ArrayIdentifierTest < Familia::Horreum
+  identifier_field [:token, :name]  # This should raise an error immediately
+  field :token
+  field :name
+end
+#=!> Familia::Problem

data/try/horreum/class_methods_try.rb

@@ -0,0 +1,41 @@
+require_relative '../helpers/test_helpers'
+
+# Test Horreum class methods
+group "Horreum Class Methods"
+
+setup do
+  @user_class = Class.new(Familia::Horreum) do
+    identifier :email
+    field :name
+    field :age
+  end
+end
+
+try "create factory method with existence checking" do
+  user = @user_class.create(email: "test@example.com", name: "Test")
+  exists = @user_class.exists?("test@example.com")
+
+  user.is_a?(@user_class) && exists
+ensure
+  @user_class.destroy!("test@example.com")
+end
+
+try "multiget retrieves multiple objects" do
+  @user_class.create(email: "user1@example.com", name: "User1")
+  @user_class.create(email: "user2@example.com", name: "User2")
+
+  users = @user_class.multiget("user1@example.com", "user2@example.com")
+
+  users.length == 2 && users.all? { |u| u.is_a?(@user_class) }
+ensure
+  @user_class.destroy!("user1@example.com", "user2@example.com")
+end
+
+try "find_keys returns matching Redis keys" do
+  @user_class.create(email: "test@example.com", name: "Test")
+  keys = @user_class.find_keys
+
+  keys.any? { |key| key.include?("test@example.com") }
+ensure
+  @user_class.destroy!("test@example.com")
+end

data/try/horreum/commands_try.rb

@@ -0,0 +1,49 @@
+require_relative '../helpers/test_helpers'
+
+# Test Horreum Redis commands
+group "Horreum Commands"
+
+setup do
+  @user_class = Class.new(Familia::Horreum) do
+    identifier :email
+    field :name
+    field :score
+  end
+  @user = @user_class.new(email: "test@example.com", name: "Test")
+  @user.save
+end
+
+try "hget/hset operations" do
+  @user.hset("name", "Updated")
+  @user.hget("name") == "Updated"
+end
+
+try "increment/decrement operations" do
+  @user.hset("score", "100")
+  @user.incr("score", 10)
+  @user.hget("score").to_i == 110 &&
+    @user.decr("score", 5) == 105
+end
+
+try "field existence and removal" do
+  @user.hset("temp_field", "value")
+  exists_before = @user.key?("temp_field")
+  @user.remove_field("temp_field")
+  exists_after = @user.key?("temp_field")
+
+  exists_before && !exists_after
+end
+
+try "bulk field operations" do
+  fields = @user.hkeys
+  values = @user.hvals
+  all_data = @user.hgetall
+
+  fields.is_a?(Array) &&
+    values.is_a?(Array) &&
+    all_data.is_a?(Hash)
+end
+
+cleanup do
+  @user&.delete!
+end