familia 1.0.0.pre.rc7 → 1.2.0

data/try/29_redis_horreum_initialization_try.rb

@@ -0,0 +1,113 @@
+require_relative '../lib/familia'
+require_relative './test_helpers'
+
+Familia.debug = false
+
+## Existing positional argument initialization still works
+@customer1 = Customer.new 'tryouts-29@test.com', '', '', '', '', 'John Doe'
+[@customer1.custid, @customer1.name]
+#=> ["tryouts-29@test.com", "John Doe"]
+
+## Keyword argument initialization works (order independent)
+@customer2 = Customer.new(name: 'Jane Smith', custid: 'jane@test.com', email: 'jane@example.com')
+[@customer2.custid, @customer2.name, @customer2.email]
+#=> ["jane@test.com", "Jane Smith", "jane@example.com"]
+
+## Keyword arguments are order independent (different order, same result)
+@customer3 = Customer.new(email: 'bob@example.com', custid: 'bob@test.com', name: 'Bob Jones')
+[@customer3.custid, @customer3.name, @customer3.email]
+#=> ["bob@test.com", "Bob Jones", "bob@example.com"]
+
+## Legacy hash support (single hash argument)
+@customer4 = Customer.new({custid: 'legacy@test.com', name: 'Legacy User', role: 'admin'})
+[@customer4.custid, @customer4.name, @customer4.role]
+#=> ["legacy@test.com", "Legacy User", "admin"]
+
+## Empty initialization works
+@customer5 = Customer.new
+@customer5.class
+#=> Customer
+
+## Keyword args with save and retrieval
+@customer6 = Customer.new(custid: 'save-test@test.com', name: 'Save Test', email: 'save@example.com')
+@customer6.save
+#=> true
+
+## Saved customer can be retrieved with correct values
+@customer6.refresh!
+[@customer6.custid, @customer6.name, @customer6.email]
+#=> ["save-test@test.com", "Save Test", "save@example.com"]
+
+## Keyword initialization sets key field correctly
+@customer6.key
+#=> "save-test@test.com"
+
+## Mixed valid and nil values in keyword args (nil values stay nil)
+@customer7 = Customer.new(custid: 'mixed@test.com', name: 'Mixed Test', email: nil, role: 'user')
+[@customer7.custid, @customer7.name, @customer7.email, @customer7.role]
+#=> ["mixed@test.com", "Mixed Test", nil, "user"]
+
+## to_h works correctly with keyword-initialized objects
+@customer2.to_h[:name]
+#=> "Jane Smith"
+
+## to_a works correctly with keyword-initialized objects
+@customer2.to_a[5]  # name field should be at index 5
+#=> "Jane Smith"
+
+## Session has limited fields (only sessid defined)
+@session1 = Session.new('sess123')
+@session1.sessid
+#=> "sess123"
+
+## Session with keyword args works
+@session2 = Session.new(sessid: 'keyword-sess')
+@session2.sessid
+#=> "keyword-sess"
+
+## Session with legacy hash
+@session3 = Session.new({sessid: 'hash-sess'})
+@session3.sessid
+#=> "hash-sess"
+
+## CustomDomain with keyword initialization
+@domain1 = CustomDomain.new(display_domain: 'api.example.com', custid: 'domain-test@test.com')
+[@domain1.display_domain, @domain1.custid]
+#=> ["api.example.com", "domain-test@test.com"]
+
+## CustomDomain still works with positional args
+@domain2 = CustomDomain.new('web.example.com', 'positional@test.com')
+[@domain2.display_domain, @domain2.custid]
+#=> ["web.example.com", "positional@test.com"]
+
+## Keyword initialization can skip fields (they remain nil/empty)
+@partial = Customer.new(custid: 'partial@test.com', name: 'Partial User')
+[@partial.custid, @partial.name, @partial.email]
+#=> ["partial@test.com", "Partial User", nil]
+
+## Complex initialization with save/refresh cycle
+@complex = Customer.new(
+  custid: 'complex@test.com',
+  name: 'Complex User',
+  email: 'complex@example.com',
+  role: 'admin',
+  verified: true
+)
+@complex.save
+@complex.refresh!
+[@complex.custid, @complex.name, @complex.role, @complex.verified]
+#=> ["complex@test.com", "Complex User", "admin", "true"]
+
+## Clean up saved test objects
+[@customer6, @complex].map(&:delete!)
+#=> [true, true]
+
+## "Cleaning up" test objects that were never saved returns false.
+@customer1.save
+ret = [
+  @customer1, @customer2, @customer3, @customer4, @customer6, @customer7,
+  @session1, @session2, @session3,
+  @domain1, @domain2,
+  @partial, @complex
+].map(&:destroy!)
+#=> [true, false, false, false, false, false, false, false, false, false, false, false, false]

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!

data/try/91_json_bug_try.rb

@@ -0,0 +1,86 @@
+# try/91_json_bug_try.rb
+
+require_relative '../lib/familia'
+require_relative './test_helpers'
+
+Familia.debug = false
+
+# Define a simple model with fields that should handle JSON data
+class JsonTest < Familia::Horreum
+  identifier :id
+  field :id
+  field :config      # This should be able to store Hash objects
+  field :tags        # This should be able to store Array objects
+  field :simple      # This should store simple strings as-is
+end
+
+# Create an instance with JSON data
+@test_obj = JsonTest.new
+@test_obj.id = "json_test_1"
+
+## Test 1: Store a Hash - should serialize to JSON automatically
+@test_obj.config = { theme: "dark", notifications: true, settings: { volume: 80 } }
+@test_obj.config.class
+#=> Hash
+
+## Test 2: Store an Array - should serialize to JSON automatically
+@test_obj.tags = ["ruby", "redis", "json", "familia"]
+@test_obj.tags.class
+#=> Array
+
+## Test 3: Store a simple string - should remain as string
+@test_obj.simple = "just a string"
+@test_obj.simple.class
+#=> String
+
+## Save the object - this should call serialize_value and use to_json
+@test_obj.save
+#=> true
+
+## Verify what's actually stored in Redis (raw)
+raw_data = @test_obj.hgetall
+p [:plop, @test_obj]
+puts "Raw Redis data:"
+raw_data
+#=> {"id"=>"json_test_1", "config"=>"{\"theme\":\"dark\",\"notifications\":true,\"settings\":{\"volume\":80}}", "tags"=>"[\"ruby\",\"redis\",\"json\",\"familia\"]", "simple"=>"just a string", "key"=>"json_test_1"}
+
+## BUG: After refresh, JSON data comes back as strings instead of parsed objects
+@test_obj.refresh!
+
+## Test 4: Hash should be deserialized back to Hash
+puts "Config after refresh:"
+puts @test_obj.config.inspect
+puts "Config class: "
+[@test_obj.config.class, @test_obj.config.inspect]
+#=> [Hash, "{:theme=>\"dark\", :notifications=>true, :settings=>{:volume=>80}}"]
+
+## Test 5: Array should be deserialized back to Array
+puts "Tags after refresh:"
+puts @test_obj.tags.inspect
+puts "Tags class: #{@test_obj.tags.class}"
+@test_obj.tags.inspect
+@test_obj.tags.class
+#=> ["ruby", "redis", "json", "familia"]
+#=> Array
+
+## Test 6: Simple string should remain a string (this works correctly)
+puts "Simple after refresh:"
+puts @test_obj.simple.inspect
+puts "Simple class: #{@test_obj.simple.class}"
+@test_obj.simple.inspect
+@test_obj.simple.class
+#=> "just a string"
+#=> String
+
+## Demonstrate the asymmetry:
+puts "\n=== ASYMMETRY DEMONSTRATION ==="
+puts "Before save: config is #{@test_obj.config.class}"
+@test_obj.config = { example: "data" }
+puts "After assignment: config is #{@test_obj.config.class}"
+@test_obj.save
+puts "After save: config is still #{@test_obj.config.class}"
+@test_obj.refresh!
+puts "After refresh: config is now #{@test_obj.config.class}!"
+
+## Clean up
+@test_obj.destroy!

data/try/92_symbolize_try.rb

@@ -0,0 +1,96 @@
+require_relative '../lib/familia'
+require_relative './test_helpers'
+
+Familia.debug = false
+
+# Test the updated deserialize_value method
+class SymbolizeTest < Familia::Horreum
+  identifier :id
+  field :id
+  field :config
+end
+
+@test_obj = SymbolizeTest.new
+@test_obj.id = "symbolize_test_1"
+
+## Test with a hash containing string keys
+@test_hash = { "name" => "John", "age" => 30, "nested" => { "theme" => "dark" } }
+@test_obj.config = @test_hash
+@test_obj.save
+
+## Original hash has string keys
+@test_hash.keys
+#=> ["name", "age", "nested"]
+
+## After save and refresh, default behavior uses symbol keys
+@test_obj.refresh!
+@test_obj.config.keys
+#=> [:name, :age, :nested]
+
+## Nested hash also has symbol keys
+@test_obj.config[:nested].keys
+#=> [:theme]
+
+## Get raw JSON from Redis
+@raw_json = @test_obj.hget('config')
+@raw_json.class
+#=> String
+
+## deserialize_value with default symbolize: true returns symbol keys
+@symbol_result = @test_obj.deserialize_value(@raw_json)
+@symbol_result.keys
+#=> [:name, :age, :nested]
+
+## Nested hash in symbol result also has symbol keys
+@symbol_result[:nested].keys
+#=> [:theme]
+
+## deserialize_value with symbolize: false returns string keys
+@string_result = @test_obj.deserialize_value(@raw_json, symbolize: false)
+@string_result.keys
+#=> ["name", "age", "nested"]
+
+## Nested hash in string result also has string keys
+@string_result["nested"].keys
+#=> ["theme"]
+
+## Values are preserved correctly in both cases
+@symbol_result[:name]
+#=> "John"
+
+@string_result["name"]
+#=> "John"
+
+## Arrays are handled correctly too
+@test_obj.config = [{ "item" => "value" }, "string", 123]
+@test_obj.save
+@array_json = @test_obj.hget('config')
+#=> "[{\"item\":\"value\"},\"string\",123]"
+
+## Array with symbolize: true converts hash keys to symbols
+@symbol_array = @test_obj.deserialize_value(@array_json)
+@symbol_array[0].keys
+#=> [:item]
+
+## Array with symbolize: false keeps hash keys as strings
+@string_array = @test_obj.deserialize_value(@array_json, symbolize: false)
+@string_array[0].keys
+#=> ["item"]
+
+## Non-hash/array values are returned as-is
+@test_obj.deserialize_value('"just a string"')
+#=> "\"just a string\""
+
+## Non-hash/array values are returned as-is
+@test_obj.deserialize_value('just a string')
+#=> "just a string"
+
+@test_obj.deserialize_value('42')
+#=> "42"
+
+## Invalid JSON returns original string
+@test_obj.deserialize_value('invalid json')
+#=> "invalid json"
+
+## Clean up
+@test_obj.destroy!

data/try/93_string_coercion_try.rb

@@ -0,0 +1,154 @@
+# try/93_string_coercion_try.rb
+
+require_relative '../lib/familia'
+require_relative './test_helpers'
+
+Familia.debug = false
+
+# Error handling: object without proper identifier setup
+class ::BadIdentifierTest < Familia::Horreum
+  # No identifier method defined - should cause issues
+end
+
+@bad_obj = ::BadIdentifierTest.new
+
+# Test polymorphic string usage for Familia objects
+@customer_id = 'customer-string-coercion-test'
+@customer = Customer.new(@customer_id)
+@customer.name = 'John Doe'
+@customer.planid = 'premium'
+@customer.save
+
+@session_id = 'session-string-coercion-test'
+@session = Session.new(@session_id)
+@session.custid = @customer_id
+@session.useragent = 'Test Browser'
+@session.save
+
+## Complex identifier test with array-based identifier
+@bone = Bone.new
+@bone.token = 'test_token'
+@bone.name = 'test_name'
+
+
+## Basic to_s functionality returns identifier
+@customer.to_s
+#=> @customer_id
+
+## String interpolation works seamlessly
+"Customer: #{@customer}"
+#=> "Customer: #{@customer_id}"
+
+## Explicit identifier call returns same value
+@customer.to_s == @customer.identifier
+#=> true
+
+## Session to_s works with generated identifier
+@session.to_s
+#=> @session_id
+
+## Method accepting string parameter works with Familia object
+def lookup_by_id(id_string)
+  id_string.to_s.upcase
+end
+
+lookup_by_id(@customer)
+#=> @customer_id.upcase
+
+## Hash key assignment using Familia object (implicit string conversion)
+@data = {}
+@data[@customer] = 'customer_data'
+@data[@customer]
+#=> 'customer_data'
+
+## Array operations work with mixed types
+@mixed_array = [@customer_id, @customer, @session]
+@mixed_array.map(&:to_s)
+#=> [@customer_id, @customer_id, @session_id]
+
+## String comparison works
+@customer.to_s == @customer_id
+#=> true
+
+## Join operations work seamlessly
+[@customer, 'separator', @session].join(':')
+#=> "#{@customer_id}:separator:#{@session_id}"
+
+## Case statement works with string matching
+def classify_id(obj)
+  case obj.to_s
+  when /customer/
+    'customer_type'
+  when /session/
+    'session_type'
+  else
+    'unknown_type'
+  end
+end
+
+classify_id(@customer)
+#=> 'customer_type'
+
+classify_id(@session)
+#=> 'session_type'
+
+## Polymorphic method accepting both strings and Familia objects
+def process_identifier(id_or_object)
+  # Can handle both string IDs and Familia objects uniformly
+  processed_id = id_or_object.to_s
+  "processed:#{processed_id}"
+end
+
+process_identifier(@customer_id)
+#=> "processed:#{@customer_id}"
+
+process_identifier(@customer)
+#=> "processed:#{@customer_id}"
+
+## Redis storage using object as string key
+@metadata = Familia::HashKey.new 'metadata'
+@metadata[@customer] = 'customer_metadata'
+@metadata[@customer.to_s] # Same key access
+#=> 'customer_metadata'
+
+## Cleanup after test
+@metadata.delete!
+#=> true
+
+@customer.delete!
+#=> true
+
+@session.delete!
+#=> true
+
+## to_s handles identifier errors gracefully
+@bad_obj.to_s.include?('BadIdentifierTest')
+#=> true
+
+## Array-based identifier works with to_s
+@bone.to_s
+#=> 'test_token:test_name'
+
+## String operations on complex identifier
+@bone.to_s.split(':')
+#=> ['test_token', 'test_name']
+
+## Cleanup a key that does not exist
+@bone.delete!
+#=> false
+
+## Cleanup a key that exists
+@bone.save
+@bone.delete!
+#=> true
+
+## Performance consideration: to_s caching behavior
+@customer2 = Customer.new('performance-test')
+@first_call = @customer2.to_s
+@second_call = @customer2.to_s
+@first_call == @second_call
+#=> true
+
+## Delete customer2
+[@customer2.exists?, @customer2.delete!]
+#=> [false, false]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: familia
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.rc7
+  version: 1.2.0
 platform: ruby
 authors:
 - Delano Mandelbaum
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2025-05-29 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
@@ -117,10 +117,15 @@ files:
 - try/25_redis_type_hash_try.rb
 - try/26_redis_bool_try.rb
 - try/27_redis_horreum_try.rb
+- try/28_redis_horreum_serialization_try.rb
+- try/29_redis_horreum_initialization_try.rb
 - try/30_familia_object_try.rb
 - try/35_feature_safedump_try.rb
 - try/40_customer_try.rb
 - try/41_customer_safedump_try.rb
+- try/91_json_bug_try.rb
+- try/92_symbolize_try.rb
+- try/93_string_coercion_try.rb
 - try/test_helpers.rb
 homepage: https://github.com/delano/familia
 licenses:
@@ -142,7 +147,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.