familia 2.0.0.pre6 → 2.0.0.pre7

data/lib/familia/features/relatable_objects.rb

@@ -1,125 +0,0 @@
-# apps/api/v2/models/features/relatable_object.rb
-
-module V2
-  module Features
-    class RelatableObjectError < Familia::Problem; end
-
-    # RelatableObject
-    #
-    # Provides the standard core object fields and methods.
-    #
-    module RelatableObject
-      def self.included(base)
-        base.class_sorted_set :relatable_objids
-        base.class_hashkey :owners
-
-        # NOTE: we do not automatically assign the objid field as the
-        # main identifier field. That's up to the implementing class.
-        base.field :objid
-        base.field :extid
-        base.field :api_version
-
-        base.extend(ClassMethods)
-
-        # prepend ensures our methods execute BEFORE field-generated accessors
-        # include would place them AFTER, but they'd never execute because
-        # attr_reader doesn't call super - it just returns the instance variable
-        #
-        # Method lookup chain:
-        #   prepend:  [InstanceMethods] → [Field Methods] → [Parent]
-        #   include:  [Field Methods] → [InstanceMethods] → [Parent]
-        #              (stops here, no super)    (never reached)
-        #
-        base.prepend(InstanceMethods)
-      end
-
-      module InstanceMethods
-        # We lazily generate the object ID and external ID when they are first
-        # accessed so that we can instantiate and load existing objects, without
-        # eagerly generating them, only to be overridden by the storage layer.
-        #
-        def init
-          super if defined?(super) # Only call if parent has init
-
-          @api_version ||= 'v2'
-        end
-
-        def objid
-          @objid ||= begin # lazy loader
-            generated_id = self.class.generate_objid
-            # Using the attr_writer method ensures any future Familia
-            # enhancements to the setter are properly invoked (as opposed
-            # to directly assigning @objid).
-            self.objid   = generated_id
-          end
-        end
-        alias relatable_objid objid
-
-        def extid
-          @extid ||= begin # lazy loader
-            generated_id = self.class.generate_extid
-            self.extid   = generated_id
-          end
-        end
-        alias external_identifier extid
-
-        # Check if the given customer is the owner of this domain
-        #
-        # @param cust [V2::Customer, String] The customer object or customer ID to check
-        # @return [Boolean] true if the customer is the owner, false otherwise
-        def owner?(related_object)
-          self.class.relatable?(related_object) do
-            # Check the hash (our objid => related_object's objid)
-            owner_objid = self.class.owners.get(objid).to_s
-            return false if owner_objid.empty?
-
-            owner_objid.eql?(related_object.objid)
-          end
-        end
-
-        def owned?
-          # We can only have an owner if we are relatable ourselves.
-          return false unless is_a?(RelatableObject)
-
-          # If our object identifier is present, we have an owner
-          self.class.owners.key?(objid)
-        end
-      end
-
-      module ClassMethods
-        def relatable?(obj, &)
-          is_relatable = obj.is_a?(RelatableObject)
-          err_klass = V2::Features::RelatableObjectError
-          raise err_klass, 'Not relatable object' unless is_relatable
-          raise err_klass, 'No self-ownership' if obj.class == self
-
-          block_given? ? yield : is_relatable
-        end
-
-        def find_by_objid(objid)
-          return nil if objid.to_s.empty?
-
-          if Familia.debug?
-            reference = caller(1..1).first
-            Familia.trace :FIND_BY_OBJID, Familia.dbclient(uri), objkey, reference
-          end
-
-          find_by_key objkey
-        end
-
-        def generate_objid
-          SecureRandom.uuid_v7
-        end
-
-        # Guaranteed length of 54
-        def generate_extid
-          format('ext_%s', Familia.generate_id)
-        end
-      end
-      extend ClassMethods
-
-      # Self-register the kids for martial arts classes
-      Familia::Base.add_feature self, :relatable_object
-    end
-  end
-end

data/try/features/relatable_objects_try.rb

@@ -1,220 +0,0 @@
-# try/features/relatable_objects_try.rb
-
-# Test RelatableObject feature functionality
-
-require_relative '../helpers/test_helpers'
-
-Familia.debug = false
-
-class RelatableTest < Familia::Horreum
-  feature :relatable_object
-  identifier_field :id
-  field :id
-  field :name
-end
-
-class RelatedTest < Familia::Horreum
-  feature :relatable_object
-  identifier_field :id
-  field :id
-  field :name
-end
-
-class NonRelatableTest < Familia::Horreum
-  identifier_field :id
-  field :id
-  field :name
-end
-
-# Setup test objects
-@relatable_obj = RelatableTest.new
-@relatable_obj.id = 'test_rel_1'
-@relatable_obj.name = 'Test Relatable 1'
-
-@related_obj = RelatedTest.new
-@related_obj.id = 'test_rel_2'
-@related_obj.name = 'Test Related 2'
-
-@non_relatable = NonRelatableTest.new
-@non_relatable.id = 'test_non_rel'
-@non_relatable.name = 'Non Relatable'
-
-## Class has RelatableObject methods mixed in
-RelatableTest.respond_to?(:relatable_objids)
-#=> true
-
-## Class has owners class method
-RelatableTest.respond_to?(:owners)
-#=> true
-
-## Class has relatable? method
-RelatableTest.respond_to?(:relatable?)
-#=> true
-
-## Class has generate_objid method
-RelatableTest.respond_to?(:generate_objid)
-#=> true
-
-## Class has generate_extid method
-RelatableTest.respond_to?(:generate_extid)
-#=> true
-
-## Class has find_by_objid method
-RelatableTest.respond_to?(:find_by_objid)
-#=> true
-
-## Object has objid method
-@relatable_obj.respond_to?(:objid)
-#=> true
-
-## Object has extid method
-@relatable_obj.respond_to?(:extid)
-#=> true
-
-## Object has api_version field
-@relatable_obj.respond_to?(:api_version)
-#=> true
-
-## Object has owner? method
-@relatable_obj.respond_to?(:owner?)
-#=> true
-
-## Object has owned? method
-@relatable_obj.respond_to?(:owned?)
-#=> true
-
-## Object has relatable_objid alias
-@relatable_obj.respond_to?(:relatable_objid)
-#=> true
-
-## Object has external_identifier alias
-@relatable_obj.respond_to?(:external_identifier)
-#=> true
-
-## objid is lazily generated on first access
-@relatable_obj.objid
-#=:> String
-
-## objid is a UUID v7 format
-objid = @relatable_obj.objid
-objid.match?(/^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i)
-#=> true
-
-## objid is cached after first generation
-objid1 = @relatable_obj.objid
-objid2 = @related_obj.objid
-[objid1, objid2]
-#=/=> _[0].eql?(_[1])
-
-## extid is lazily generated on first access
-@relatable_obj.extid
-#=:> String
-
-## extid starts with 'ext_' prefix (from our mock)
-@relatable_obj.extid.start_with?('ext_')
-#=> true
-
-## extid is cached after first generation
-extid1 = @relatable_obj.extid
-extid2 = @related_obj.extid
-[extid1, extid2]
-#=/=> _[0].eql?(_[1])
-
-## api_version defaults to 'v2'
-@relatable_obj.api_version
-#=> 'v2'
-
-## relatable_objid is alias for objid
-[@relatable_obj.relatable_objid, @relatable_obj.objid]
-#==> _[0].eql?(_[1])
-
-## external_identifier is alias for extid
-[@relatable_obj.external_identifier, @relatable_obj.extid]
-#==> _[0].eql?(_[1])
-
-## relatable? prevents self-ownership (same class)
-RelatableTest.relatable?(@relatable_obj)
-#=!> V2::Features::RelatableObjectError
-
-## relatable? returns true for different relatable classes
-RelatableTest.relatable?(@related_obj)
-#=> true
-
-## relatable? raises error for non-relatable objects
-RelatableTest.relatable?(@non_relatable)
-#=!> V2::Features::RelatableObjectError
-
-
-## relatable? with block executes block for relatable objects
-result = nil
-RelatableTest.relatable?(@related_obj) do
-  result = "executed"
-end
-result
-#=> "executed"
-
-## owned? returns false when no owner is set
-@relatable_obj.owned?
-#=> false
-
-## owner? returns false when objects are not related
-@relatable_obj.owner?(@related_obj)
-#=> false
-
-## generate_objid creates UUID v7
-generated_id = RelatableTest.generate_objid
-generated_id.match?(/^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i)
-#=> true
-
-## generate_extid creates external ID
-RelatableTest.generate_extid
-#==> _.start_with?('ext_')
-#==> _.size == 54
-
-## find_by_objid returns nil for empty objid
-result = RelatableTest.find_by_objid('')
-result.nil?
-#=> true
-
-## find_by_objid returns nil for nil objid
-result = RelatableTest.find_by_objid(nil)
-result.nil?
-#=> true
-
-## Class has relatable_objids sorted set
-objids_set = RelatableTest.relatable_objids
-objids_set.class.name
-#=> "Familia::SortedSet"
-
-## Class has owners hash key
-owners_hash = RelatableTest.owners
-owners_hash.class.name
-#=> "Familia::HashKey"
-
-## Objects can be persisted and retrieved
-@relatable_obj.save
-retrieved = RelatableTest.find(@relatable_obj.id)
-retrieved.id == @relatable_obj.id
-#=> true
-
-## API version is preserved when persisting
-retrieved = RelatableTest.find(@relatable_obj.id)
-retrieved.api_version
-#=> 'v2'
-
-## Objid is preserved when persisting
-original_objid = @relatable_obj.objid
-retrieved = RelatableTest.find(@relatable_obj.id)
-retrieved.objid == original_objid
-#=> true
-
-## Extid is preserved when persisting
-original_extid = @relatable_obj.extid
-retrieved = RelatableTest.find(@relatable_obj.id)
-retrieved.extid == original_extid
-#=> true
-
-# Cleanup
-@relatable_obj.destroy! if @relatable_obj
-@related_obj.destroy! if @related_obj
-@non_relatable.destroy! if @non_relatable