familia 2.0.0.pre10 → 2.0.0.pre12

data/lib/familia/features/safe_dump.rb

@@ -1,12 +1,18 @@
 # lib/familia/features/safe_dump.rb
 
+# rubocop:disable ThreadSafety/ClassInstanceVariable
+#
+#   Class instance variables are used here for feature configuration
+#   (e.g., @dump_method, @load_method). These are set once and not mutated
+#   at runtime, so thread safety is not a concern for this feature.
+#
 module Familia::Features
   # SafeDump is a mixin that allows models to define a list of fields that are
   # safe to dump. This is useful for serializing objects to JSON or other
   # formats where you want to ensure that only certain fields are exposed.
   #
-  # To use SafeDump, include it in your model and define a list of fields that
-  # are safe to dump. The fields can be either symbols or hashes. If a field is
+  # To use SafeDump, include it in your model and use the DSL methods to define
+  # safe dump fields. The fields can be either symbols or hashes. If a field is
   # a symbol, the method with the same name will be called on the object to
   # retrieve the value. If the field is a hash, the key is the field name and
   # the value is a lambda that will be called with the object as an argument.
@@ -19,97 +25,85 @@ module Familia::Features
   #
   #   feature :safe_dump
   #
-  #   @safe_dump_fields = [
-  #     :objid,
-  #     :updated,
-  #     :created,
-  #     { :active => ->(obj) { obj.active? } }
-  #   ]
+  #   safe_dump_field :objid
+  #   safe_dump_field :updated
+  #   safe_dump_field :created
+  #   safe_dump_field :active, ->(obj) { obj.active? }
   #
-  # Internally, all fields are normalized to the hash syntax and stored in
-  # @safe_dump_field_map. `SafeDump.safe_dump_fields` returns only the list
-  # of symbols in the order they were defined. From the example above, it would
-  # return `[:objid, :updated, :created, :active]`.
-  #
-  # Standalone Usage:
-  #
-  # You can also use SafeDump by including it in your model and defining the
-  # safe dump fields using the class instance variable `@safe_dump_fields`.
-  #
-  # Example:
+  # Alternatively, you can define multiple fields at once:
   #
-  #   class MyModel
-  #     include Familia::Features::SafeDump
+  #   safe_dump_fields :objid, :updated, :created,
+  #                    { active: ->(obj) { obj.active? } }
   #
-  #     @safe_dump_fields = [
-  #       :id, :name, { active: ->(obj) { obj.active? } }
-  #     ]
-  #   end
+  # Internally, all fields are normalized to the hash syntax and stored in
+  # @safe_dump_field_map. `SafeDump.safe_dump_fields` returns only the list
+  # of symbols in the order they were defined.
   #
   module SafeDump
     @dump_method = :to_json
     @load_method = :from_json
 
-    @safe_dump_fields = []
-    @safe_dump_field_map = {}
-
     def self.included(base)
-      Familia.trace :LOADED, self, base, caller(1..1) if Familia.debug?
+      Familia.trace(:LOADED, self, base, caller(1..1)) if Familia.debug?
       base.extend ClassMethods
 
-      # Optionally define safe_dump_fields in the class to make
-      # sure we always have an array to work with.
-      base.instance_variable_set(:@safe_dump_fields, []) unless base.instance_variable_defined?(:@safe_dump_fields)
-
-      # Ditto for the field map
-      return if base.instance_variable_defined?(:@safe_dump_field_map)
-
+      # Initialize the safe dump field map
       base.instance_variable_set(:@safe_dump_field_map, {})
     end
 
+    # SafeDump::ClassMethods
+    #
+    # These methods become available on the model class
     module ClassMethods
-      def set_safe_dump_fields(*fields)
-        @safe_dump_fields = fields
+      # Define a single safe dump field
+      # @param field_name [Symbol] The name of the field
+      # @param callable [Proc, nil] Optional callable to transform the value
+      def safe_dump_field(field_name, callable = nil)
+        @safe_dump_field_map ||= {}
+
+        field_name = field_name.to_sym
+        field_value = callable || lambda { |obj|
+          if obj.respond_to?(:[]) && obj[field_name]
+            obj[field_name] # Familia::DataType classes
+          elsif obj.respond_to?(field_name)
+            obj.send(field_name) # Regular method calls
+          end
+        }
+
+        @safe_dump_field_map[field_name] = field_value
       end
 
-      # `SafeDump.safe_dump_fields` returns only the list
-      # of symbols in the order they were defined.
-      def safe_dump_fields
-        @safe_dump_fields.map do |field|
-          field.is_a?(Symbol) ? field : field.keys.first
+      # Define multiple safe dump fields at once
+      # @param fields [Array] Mixed array of symbols and hashes
+      def safe_dump_fields(*fields)
+        # If no arguments, return field names (getter behavior)
+        return safe_dump_field_names if fields.empty?
+
+        # Otherwise, define fields (setter behavior)
+        fields.each do |field|
+          if field.is_a?(Symbol)
+            safe_dump_field(field)
+          elsif field.is_a?(Hash)
+            field.each do |name, callable|
+              safe_dump_field(name, callable)
+            end
+          end
         end
       end
 
-      # `SafeDump.safe_dump_field_map` returns the field map
-      # that is used to dump the fields. The keys are the
-      # field names and the values are callables that will
-      # expect to receive the instance object as an argument.
-      #
-      # The map is cached on the first call to this method.
-      #
+      # Returns an array of safe dump field names in the order they were defined
+      def safe_dump_field_names
+        (@safe_dump_field_map || {}).keys
+      end
+
+      # Returns the field map used for dumping
       def safe_dump_field_map
-        return @safe_dump_field_map if @safe_dump_field_map.any?
+        @safe_dump_field_map || {}
+      end
 
-        # Operate directly on the @safe_dump_fields array to
-        # build the map. This way we'll get the elements defined
-        # in the hash syntax (i.e. since the safe_dump_fields getter
-        # method returns only the symbols).
-        @safe_dump_field_map = @safe_dump_fields.each_with_object({}) do |el, map|
-          if el.is_a?(Symbol)
-            field_name = el
-            callable = lambda { |obj|
-              if obj.respond_to?(:[]) && obj[field_name]
-                obj[field_name] # Familia::DataType classes
-              elsif obj.respond_to?(field_name)
-                obj.send(field_name) # Onetime::Models::RedisHash classes via method_missing 😩
-              end
-            }
-          else
-            field_name = el.keys.first
-            callable = el.values.first
-          end
-          map[field_name] = callable
-        end
+      # Legacy method for setting safe dump fields (for backward compatibility)
+      def set_safe_dump_fields(*fields)
+        safe_dump_fields(*fields)
       end
     end
 
@@ -155,5 +149,5 @@ module Familia::Features
 
     Familia::Base.add_feature self, :safe_dump
   end
-  # end SafeDump
 end
+# rubocop:enable ThreadSafety/ClassInstanceVariable

data/lib/familia/features.rb

@@ -5,18 +5,108 @@ module Familia
 
   # Familia::Features
   #
+  # This module provides the feature system for Familia classes. Features are
+  # modular capabilities that can be mixed into classes with configurable options.
+  # Features provide a powerful way to:
+  #
+  # - **Add new methods**: Both class and instance methods can be added
+  # - **Override existing methods**: Extend or replace default behavior
+  # - **Add new fields**: Define additional data storage capabilities
+  # - **Manage complexity**: Large, complex model classes can use features to
+  #   organize functionality into focused, reusable modules
+  #
+  # ## Feature Options Storage
+  #
+  # Feature options are stored **per-class** using class-level instance variables.
+  # This means each Familia::Horreum subclass maintains its own isolated set of
+  # feature options. When you enable a feature with options in different models,
+  # each model stores its own separate configuration without interference.
+  #
+  # ## Project Organization with Autoloader
+  #
+  # For large projects, use {Familia::Features::Autoloader} to automatically load
+  # project-specific features from a dedicated directory structure. This helps
+  # organize complex models by separating features into individual files.
+  #
+  # @example Different models with different feature options
+  #   class UserModel < Familia::Horreum
+  #     feature :object_identifier, generator: :uuid_v4
+  #   end
+  #
+  #   class SessionModel < Familia::Horreum
+  #     feature :object_identifier, generator: :hex
+  #   end
+  #
+  #   UserModel.feature_options(:object_identifier)    #=> {generator: :uuid_v4}
+  #   SessionModel.feature_options(:object_identifier) #=> {generator: :hex}
+  #
+  # @example Using features for complexity management
+  #   class ComplexModel < Familia::Horreum
+  #     # Organize functionality using features
+  #     feature :expiration           # TTL management
+  #     feature :safe_dump           # API-safe serialization
+  #     feature :relationships       # CRUD operations for related objects
+  #     feature :custom_validation   # Project-specific validation logic
+  #     feature :audit_trail         # Change tracking
+  #   end
+  #
+  # @example Project-specific features with autoloader
+  #   # In your model file: app/models/customer.rb
+  #   class Customer < Familia::Horreum
+  #     module Features
+  #       include Familia::Features::Autoloader
+  #       # Automatically loads all .rb files from app/models/customer/features/
+  #     end
+  #   end
+  #
+  # @see Familia::Features::Autoloader For automatic feature loading
+  #
   module Features
     @features_enabled = nil
     attr_reader :features_enabled
 
+    # Enables a feature for the current class with optional configuration.
+    #
+    # Features are modular capabilities that can be mixed into Familia::Horreum
+    # classes. Each feature can be configured with options that are stored
+    # **per-class**, ensuring complete isolation between different models.
+    #
+    # @param feature_name [Symbol, String, nil] the name of the feature to enable.
+    #   If nil, returns the list of currently enabled features.
+    # @param options [Hash] configuration options for the feature. These are
+    #   stored per-class and do not interfere with other models' configurations.
+    # @return [Array, nil] the list of enabled features if feature_name is nil,
+    #   otherwise nil
+    #
+    # @example Enable feature without options
+    #   class User < Familia::Horreum
+    #     feature :expiration
+    #   end
+    #
+    # @example Enable feature with options (per-class storage)
+    #   class User < Familia::Horreum
+    #     feature :object_identifier, generator: :uuid_v4
+    #   end
+    #
+    #   class Session < Familia::Horreum
+    #     feature :object_identifier, generator: :hex  # Different options
+    #   end
+    #
+    #   # Each class maintains separate options:
+    #   User.feature_options(:object_identifier)    #=> {generator: :uuid_v4}
+    #   Session.feature_options(:object_identifier) #=> {generator: :hex}
+    #
+    # @raise [Familia::Problem] if the feature is not supported
+    #
     def feature(feature_name = nil, **options)
       @features_enabled ||= []
 
       return features_enabled if feature_name.nil?
 
-      # If there's a value provied check that it's a valid feature
+      # If there's a value provided check that it's a valid feature
       feature_name = feature_name.to_sym
-      unless Familia::Base.features_available.key?(feature_name)
+      feature_class = Familia::Base.find_feature(feature_name, self)
+      unless feature_class
         raise Familia::Problem, "Unsupported feature: #{feature_name}"
       end
 
@@ -46,10 +136,8 @@ module Familia
         add_feature_options(feature_name, **options)
       end
 
-      klass = Familia::Base.features_available[feature_name]
-
       # Extend the Familia::Base subclass (e.g. Customer) with the feature module
-      include klass
+      include feature_class
 
       # NOTE: Do we want to extend Familia::DataType here? That would make it
       # possible to call safe_dump on relations fields (e.g. list, zset, hashkey).

data/lib/familia/horreum/subclass/definition.rb

@@ -237,10 +237,36 @@ module Familia
         field_types[field_type.name] = field_type
       end
 
-      # Get feature options for a specific feature or all features
+      # Retrieves feature options for the current class.
       #
-      # @param feature_name [Symbol, nil] The feature name to get options for
-      # @return [Hash] The options hash for the feature, or empty hash if none
+      # Feature options are stored **per-class** in instance variables, ensuring
+      # complete isolation between different Familia::Horreum subclasses. Each
+      # class maintains its own @feature_options hash that does not interfere
+      # with other classes' configurations.
+      #
+      # @param feature_name [Symbol, String, nil] the name of the feature to get options for.
+      #   If nil, returns the entire feature options hash for this class.
+      # @return [Hash] the feature options hash, either for a specific feature or all features
+      #
+      # @example Getting options for a specific feature
+      #   class MyModel < Familia::Horreum
+      #     feature :object_identifier, generator: :uuid_v4
+      #   end
+      #
+      #   MyModel.feature_options(:object_identifier) #=> {generator: :uuid_v4}
+      #   MyModel.feature_options                     #=> {object_identifier: {generator: :uuid_v4}}
+      #
+      # @example Per-class isolation
+      #   class UserModel < Familia::Horreum
+      #     feature :object_identifier, generator: :uuid_v4
+      #   end
+      #
+      #   class SessionModel < Familia::Horreum
+      #     feature :object_identifier, generator: :hex
+      #   end
+      #
+      #   UserModel.feature_options(:object_identifier)    #=> {generator: :uuid_v4}
+      #   SessionModel.feature_options(:object_identifier) #=> {generator: :hex}
       #
       def feature_options(feature_name = nil)
         @feature_options ||= {}
@@ -255,10 +281,28 @@ module Familia
       # without worrying about initialization state. Similar to register_field_type
       # for field types.
       #
+      # Feature options are stored at the **class level** using instance variables,
+      # ensuring complete isolation between different Familia::Horreum subclasses.
+      # Each class maintains its own @feature_options hash.
+      #
       # @param feature_name [Symbol] The feature name
       # @param options [Hash] The options to add/merge
       # @return [Hash] The updated options for the feature
       #
+      # @note This method only sets defaults for options that don't already exist,
+      #   using the ||= operator to prevent overwrites.
+      #
+      # @example Per-class storage behavior
+      #   class ModelA < Familia::Horreum
+      #     # This stores options in ModelA's @feature_options
+      #     add_feature_options(:my_feature, key: 'value_a')
+      #   end
+      #
+      #   class ModelB < Familia::Horreum
+      #     # This stores options in ModelB's @feature_options (separate from ModelA)
+      #     add_feature_options(:my_feature, key: 'value_b')
+      #   end
+      #
       def add_feature_options(feature_name, **options)
   @feature_options ||= {}
   @feature_options[feature_name.to_sym] ||= {}

data/lib/familia/secure_identifier.rb

@@ -2,13 +2,14 @@
 
 require 'securerandom'
 
+# Provides a suite of tools for generating and manipulating cryptographically
+# secure identifiers in various formats and lengths.
 module Familia
   module SecureIdentifier
-
     # Generates a 256-bit cryptographically secure hexadecimal identifier.
     #
     # @return [String] A 64-character hex string representing 256 bits of entropy.
-    # @security Provides ~10^77 possible values, far exceeding UUID4's 128 bits.
+    # @security Provides ~10^77 possible values, far exceeding UUIDv4's 128 bits.
     def generate_hex_id
       SecureRandom.hex(32)
     end
@@ -26,13 +27,6 @@ module Familia
     #
     # @param base [Integer] The base for encoding the output string (2-36, default: 36).
     # @return [String] A secure identifier.
-    #
-    # @example Generate a 256-bit ID in base-36 (default)
-    #   generate_id # => "25nkfebno45yy36z47ffxef2a7vpg4qk06ylgxzwgpnz4q3os4"
-    #
-    # @example Generate a 256-bit ID in base-16 (hexadecimal)
-    #   generate_id(16) # => "568bdb582bc5042bf435d3f126cf71593981067463709c880c91df1ad9777a34"
-    #
     def generate_id(base = 36)
       target_length = SecureIdentifier.min_length_for_bits(256, base)
       generate_hex_id.to_i(16).to_s(base).rjust(target_length, '0')
@@ -43,87 +37,69 @@ module Familia
     #
     # @param base [Integer] The base for encoding the output string (2-36, default: 36).
     # @return [String] A secure short identifier.
-    #
-    # @example Generate a 64-bit short ID in base-36 (default)
-    #   generate_trace_id # => "lh7uap704unf"
-    #
-    # @example Generate a 64-bit short ID in base-16 (hexadecimal)
-    #   generate_trace_id(16) # => "94cf9f8cfb0eb692"
-    #
     def generate_trace_id(base = 36)
       target_length = SecureIdentifier.min_length_for_bits(64, base)
       generate_hex_trace_id.to_i(16).to_s(base).rjust(target_length, '0')
     end
 
-    # Truncates a 256-bit hexadecimal ID to 64 bits and encodes it in a given base.
-    # These short, deterministic IDs are useful for secure logging. By inputting the
-    # full hexadecimal string, you can generate a consistent short ID that allows
-    # tracking an entity through logs without exposing the entity's full identifier..
+    # Creates a deterministic 64-bit trace identifier from a longer hex ID.
     #
-    # @param hex_id [String] A 64-character hexadecimal string (representing 256 bits).
-    # @param base [Integer] The base for encoding the output string (2-36, default: 36).
-    # @return [String] A 64-bit identifier, encoded in the specified base.
+    # This is a convenience method for `truncate_hex(hex_id, bits: 64)`.
+    # Useful for creating short, consistent IDs for logging and tracing.
+    #
+    # @param (see #truncate_hex)
+    # @return (see #truncate_hex)
     def shorten_to_trace_id(hex_id, base: 36)
-      target_length = SecureIdentifier.min_length_for_bits(64, base)
-      truncated = hex_id.to_i(16) >> (256 - 64) # Always 64 bits
-      truncated.to_s(base).rjust(target_length, '0')
+      truncate_hex(hex_id, bits: 64, base: base)
     end
 
-    # Truncates a 256-bit hexadecimal ID to 128 bits and encodes it in a given base.
-    # This function takes the most significant bits from the hex string to maintain
-    # randomness while creating a shorter, deterministic identifier that's safe for
-    # outdoor use.
-    #
-    # @param hex_id [String] A 64-character hexadecimal string (representing 256 bits).
-    # @param base [Integer] The base for encoding the output string (2-36, default: 36).
-    # @return [String] A 128-bit identifier, encoded in the specified base.
-    #
-    # @example Create a shorter external ID from a full 256-bit internal ID
-    #   hex_id = generate_hex_id
-    #   external_id = shorten_to_external_id(hex_id)
-    #
-    # @note This is useful for creating shorter, public-facing IDs from secure internal ones.
-    # @security Truncation preserves the cryptographic properties of the most significant bits.
-    def shorten_to_external_id(hex_id, base: 36)
-      target_length = SecureIdentifier.min_length_for_bits(128, base)
-      truncated = hex_id.to_i(16) >> (256 - 128) # Always 128 bits
-      truncated.to_s(base).rjust(target_length, '0')
-    end
+    # Deterministically truncates a hexadecimal ID to a specified bit length.
+    #
+    # This function preserves the most significant bits of the input `hex_id` to
+    # create a shorter, yet still random-looking, identifier.
+    #
+    # @param hex_id [String] The input hexadecimal string.
+    # @param bits [Integer] The desired output bit length (e.g., 128, 64). Defaults to 128.
+    # @param base [Integer] The numeric base for the output string (2-36). Defaults to 36.
+    # @return [String] A new, shorter identifier in the specified base.
+    # @raise [ArgumentError] if `hex_id` is not a valid hex string, or if `input_bits`
+    #   is less than the desired output `bits`.
+    def truncate_hex(hex_id, bits: 128, base: 36)
+      target_length = SecureIdentifier.min_length_for_bits(bits, base)
+      input_bits = hex_id.length * 4
 
-    # Calculate minimum string length to represent N bits in given base
-    #
-    # When generating random IDs, we need to know how many characters are required
-    # to represent a certain amount of entropy. This ensures consistent ID lengths.
-    #
-    # Formula: ceil(bits * log(2) / log(base))
-    #
-    # @example Common usage with SecureRandom
-    #   SecureRandom.hex(32)  # 32 bytes = 256 bits = 64 hex chars
-    #   SecureRandom.hex(16)  # 16 bytes = 128 bits = 32 hex chars
-    #
-    # @example Using the method
-    #   min_length_for_bits(256, 16)  # => 64 (hex)
-    #   min_length_for_bits(256, 36)  # => 50 (base36)
-    #   min_length_for_bits(128, 10)  # => 39 (decimal)
+      unless hex_id.match?(/\A[0-9a-fA-F]+\z/)
+        raise ArgumentError, "Invalid hexadecimal string: #{hex_id}"
+      end
 
-    # Fast lookup for hex (base 16) - our most common case
-    # Avoids calculation overhead for 99% of ID generation
-    HEX_LENGTHS = {
-      256 => 64,  # SHA-256 equivalent entropy
-      128 => 32,  # UUID equivalent entropy
-      64  => 16,  # Compact ID
-    }.freeze
+      if input_bits < bits
+        raise ArgumentError, "Input bits (#{input_bits}) cannot be less than desired output bits (#{bits})."
+      end
 
-    # Get minimum character length needed to encode `bits` of entropy in `base`
+      # Truncate by right-shifting to keep the most significant bits
+      truncated_int = hex_id.to_i(16) >> (input_bits - bits)
+      truncated_int.to_s(base).rjust(target_length, '0')
+    end
+
+    # Calculates the minimum string length required to represent a given number of
+    # bits in a specific numeric base.
+    #
+    # @private
     #
-    # @param bits [Integer] Number of bits of entropy needed
-    # @param base [Integer] Numeric base (2-36)
-    # @return [Integer] Minimum string length required
+    # @param bits [Integer] The number of bits of entropy.
+    # @param base [Integer] The numeric base (2-36).
+    # @return [Integer] The minimum string length required.
     def self.min_length_for_bits(bits, base)
-      return HEX_LENGTHS[bits] if base == 16 && HEX_LENGTHS.key?(bits)
+      # Fast lookup for hex (base 16) - our most common case
+      hex_lengths = {
+        256 => 64,  # SHA-256 equivalent entropy
+        128 => 32,  # UUID equivalent entropy
+        64  => 16,  # Compact ID
+      }.freeze
+      return hex_lengths[bits] if base == 16 && hex_lengths.key?(bits)
 
-      @length_cache ||= {}
-      @length_cache[[bits, base]] ||= (bits * Math.log(2) / Math.log(base)).ceil
+      @min_length_for_bits_cache ||= {}
+      @min_length_for_bits_cache[[bits, base]] ||= (bits * Math.log(2) / Math.log(base)).ceil
     end
   end
 end