Class: Familia::Horreum

Inherits:
Object
  • Object
show all
Includes:
Base, DatabaseCommands, Persistence, Serialization, Settings, Utils
Defined in:
lib/familia/horreum.rb,
lib/familia/horreum/utils.rb,
lib/familia/horreum/settings.rb,
lib/familia/horreum/connection.rb,
lib/familia/horreum/definition.rb,
lib/familia/horreum/management.rb,
lib/familia/horreum/persistence.rb,
lib/familia/horreum/serialization.rb,
lib/familia/horreum/related_fields.rb,
lib/familia/horreum/database_commands.rb

Overview

Familia::Horreum

This module is included in classes that include Familia, providing instance-level functionality for Database operations and object management.

Defined Under Namespace

Modules: Connection, DatabaseCommands, DefinitionMethods, ManagementMethods, Persistence, RelatedFieldsManagement, Serialization, Settings, Utils

Constant Summary collapse

ParentDefinition =

Each related field needs some details from the parent (Horreum model) in order to generate its dbkey. We use a parent proxy pattern to store only essential parent information instead of full object reference. We need only the model class and an optional unique identifier to generate the dbkey; when the identifier is nil, we treat this as a class-level relation (e.g. model_name:related_field_name); when the identifier is not nil, we treat this as an instance-level relation (model_name:identifier:related_field_name).

Data.define(:model_klass, :identifier) do
  # Factory method to create ParentDefinition from a parent instance
  def self.from_parent(parent_instance)
    case parent_instance
    when Class
      # Handle class-level relationships
      new(parent_instance, nil)
    else
      # Handle instance-level relationships
      identifier = parent_instance.respond_to?(:identifier) ? parent_instance.identifier : nil
      new(parent_instance.class, identifier)
    end
  end

  # Delegation methods for common operations needed by DataTypes
  def dbclient(uri = nil)
    model_klass.dbclient(uri)
  end

  def logical_database
    model_klass.logical_database
  end

  def dbkey(keystring = nil)
    if identifier
      # Instance-level relation: model_name:identifier:keystring
      model_klass.dbkey(identifier, keystring)
    else
      # Class-level relation: model_name:keystring
      model_klass.dbkey(keystring, nil)
    end
  end

  # Allow comparison with the original parent instance
  def ==(other)
    case other
    when ParentDefinition
      model_klass == other.model_klass && identifier == other.identifier
    when Class
      model_klass == other && identifier.nil?
    else
      # Compare with instance: check class and identifier match
      other.is_a?(model_klass) && other.respond_to?(:identifier) && identifier == other.identifier
    end
  end
  alias eql? ==
end

Class Attribute Summary collapse

Instance Attribute Summary collapse

Attributes included from Settings

#suffix

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils

#dbkey, #join

Methods included from Settings

#logical_database, #logical_database=, #opts, #prefix

Methods included from DatabaseCommands

#current_expiration, #data_type, #decr, #decrby, #delete!, #discard, #echo, #exists?, #expire, #field_count, #hget, #hgetall, #hkeys, #hmset, #hset, #hsetnx, #hstrlen, #hvals, #incr, #incrby, #incrbyfloat, #key?, #move, #remove_field, #unwatch, #watch

Methods included from Serialization

#deserialize_value, #serialize_value, #to_a, #to_h, #to_h_for_storage

Methods included from Persistence

#apply_fields, #batch_update, #clear_fields!, #commit_fields, #dbclient, #destroy!, #pipelined, #refresh, #refresh!, #save, #save_fields, #save_if_not_exists, #save_if_not_exists!, #transaction

Methods included from Base

add_feature, #as_json, #expired?, #expires?, find_feature, #to_json, #ttl, #update_expiration, #uuid

Constructor Details

#initialize(*args, **kwargs) ⇒ Horreum

Instance initialization This method sets up the object's state, including Valkey/Redis-related data.

Usage:

Session.new("abc123", "user456") # positional (brittle) Session.new(sessid: "abc123", custid: "user456") # hash (robust) Session.new({sessid: "abc123", custid: "user456"}) # legacy hash (robust)



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/familia/horreum.rb', line 189

def initialize(*args, **kwargs)
  start_time = Familia.now_in_μs if Familia.debug?
  Familia.trace :INITIALIZE, nil, "Initializing #{self.class}" if Familia.debug?
  initialize_relatives

  # No longer auto-create a key field - the identifier method will
  # directly use the field specified by identifier_field

  # Detect if first argument is a hash (legacy support)
  if args.size == 1 && args.first.is_a?(Hash) && kwargs.empty?
    kwargs = args.first
    args = []
  end

  # Initialize object with arguments using one of four strategies:
  #
  # 1. **Identifier** (Recommended for lookups): A single argument is
  #     treated as the identifier. Robust and convenient for creating
  #     objects from an ID. e.g. `Customer.new("cust_123")`
  #
  # 2. **Keyword Arguments** (Recommended for creation): Order-independent
  #     field assignment
  #    e.g. Customer.new(name: "John", email: "john@example.com")
  #
  # 3. **Positional Arguments** (Legacy): Field assignment by definition order
  #    e.g. Customer.new("cust_123", "John", "john@example.com")
  #
  # 4. **No Arguments**: Object created with all fields as nil
  #
  if args.size == 1 && kwargs.empty?
    id_field = self.class.identifier_field
    send(:"#{id_field}=", args.first)
  elsif kwargs.any?
    initialize_with_keyword_args(**kwargs)
  elsif args.any?
    initialize_with_positional_args(*args)
  elsif Familia.debug?
    Familia.trace :INITIALIZE, nil, "#{self.class} initialized with no arguments"
    # Default values are intentionally NOT set here
  end

  # Implementing classes can define an init method to do any additional
  # initialization. Notice that this is called AFTER fields are set from
  # kwargs, so kwargs have been consumed and are no longer available.
  #
  # IMPORTANT: Use ||= in init to apply defaults without overriding:
  #   def init
  #     @email ||= email               # Preserves value already set
  #     @status ||= 'pending'          # Applies default if nil
  #   end
  #
  init

  # Structured lifecycle logging and instrumentation
  if Familia.debug? && start_time
    duration = Familia.now_in_μs - start_time
    Familia.debug "Horreum initialized",
      class: self.class.name,
      duration: duration,
      identifier: (identifier rescue nil)

    Familia::Instrumentation.notify_lifecycle(:initialize, self, duration: duration)
  end
end

Class Attribute Details

.dbclient=(value) ⇒ Object (writeonly)

TODO: Where are we calling dbclient= from now with connection pool?



88
89
90
 
# File 'lib/familia/horreum.rb', line 88

def dbclient=(value)
  @dbclient = value
end

.has_related_fields ⇒ Object (readonly)

Returns the value of attribute has_related_fields.



89
90
91
 
# File 'lib/familia/horreum.rb', line 89

def has_related_fields
  @has_related_fields
end

.parent ⇒ Object

Returns the value of attribute parent.



86
87
88
 
# File 'lib/familia/horreum.rb', line 86

def parent
  @parent
end

.valid_command_return_values ⇒ Object (readonly)

Returns the value of attribute valid_command_return_values.



33
34
35
 
# File 'lib/familia/horreum/persistence.rb', line 33

def valid_command_return_values
  @valid_command_return_values
end

Instance Attribute Details

#dbclient=(value) ⇒ Object (writeonly)

Sets the attribute dbclient

Parameters:

  • value —

    the value to set the attribute dbclient to.



178
179
180
 
# File 'lib/familia/horreum.rb', line 178

def dbclient=(value)
  @dbclient = value
end

Class Method Details

.inherited(member) ⇒ Object

Extends ClassMethods to subclasses and tracks Familia members



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/familia/horreum.rb', line 92

def inherited(member)
  Familia.trace :HORREUM, nil, "Welcome #{member} to the family" if Familia.debug?

  # Class-level functionality extensions:
  member.extend(Familia::Horreum::DefinitionMethods)    # field(), identifier_field(), dbkey()
  member.extend(Familia::Horreum::ManagementMethods)    # create(), find(), destroy!()
  member.extend(Familia::Horreum::Connection)           # dbclient, connection management
  member.extend(Familia::Features) # feature() method for optional modules

  # Copy parent class configuration to child class
  # This implements conventional ORM inheritance behavior where child classes
  # automatically inherit all parent configuration without manual copying
  parent_class = member.superclass
  if parent_class.respond_to?(:identifier_field) && parent_class != Familia::Horreum
    # Copy essential configuration instance variables from parent
    if parent_class.identifier_field
      member.instance_variable_set(:@identifier_field, parent_class.identifier_field)
    end

    # Copy field system configuration
    member.instance_variable_set(:@fields, parent_class.fields.dup) if parent_class.fields&.any?

    if parent_class.respond_to?(:field_types) && parent_class.field_types&.any?
      # Copy field_types hash (FieldType instances are frozen/immutable and can be safely shared)
      copied_field_types = parent_class.field_types.dup
      member.instance_variable_set(:@field_types, copied_field_types)
      # Re-install field methods on the child class using proper method name detection
      parent_class.field_types.each_value do |field_type|
        # Collect all method names that field_type.install will create
        methods_to_check = [
          field_type.method_name,
          (field_type.method_name ? :"#{field_type.method_name}=" : nil),
          field_type.fast_method_name,
        ].compact

        # Only install if none of the methods already exist
        methods_exist = methods_to_check.any? do |method_name|
          member.method_defined?(method_name) || member.private_method_defined?(method_name)
        end

        field_type.install(member) unless methods_exist
      end
    end

    # Copy features configuration
    if parent_class.respond_to?(:features_enabled) && parent_class.features_enabled&.any?
      member.instance_variable_set(:@features_enabled, parent_class.features_enabled.dup)
    end

    # Copy other configuration using consistent instance variable access
    if (prefix = parent_class.instance_variable_get(:@prefix))
      member.instance_variable_set(:@prefix, prefix)
    end
    if (suffix = parent_class.instance_variable_get(:@suffix))
      member.instance_variable_set(:@suffix, suffix)
    end
    if (logical_db = parent_class.instance_variable_get(:@logical_database))
      member.instance_variable_set(:@logical_database, logical_db)
    end
    if (default_exp = parent_class.instance_variable_get(:@default_expiration))
      member.instance_variable_set(:@default_expiration, default_exp)
    end

    # Copy DataType relationships
    if parent_class.class_related_fields&.any?
      member.instance_variable_set(:@class_related_fields, parent_class.class_related_fields.dup)
    end
    if parent_class.related_fields&.any?
      member.instance_variable_set(:@related_fields, parent_class.related_fields.dup)
    end
    if parent_class.instance_variable_get(:@has_related_fields)
      member.instance_variable_set(:@has_related_fields,
                                   parent_class.instance_variable_get(:@has_related_fields))
    end
  end

  # Track all classes that inherit from Horreum
  Familia.members << member

  # Set up automatic instance tracking using built-in class_sorted_set
  member.class_sorted_set :instances

  super
end

Instance Method Details

#generate_id ⇒ Redis

Returns the Database connection for the instance using Chain of Responsibility pattern.

This method uses a chain of handlers to resolve connections in priority order:

  1. FiberTransactionHandler - Fiber:familia_transaction
  2. CachedConnectionHandler - Accesses self.dbclient
  3. CachedConnectionHandler - Accesses self.class.dbclient
  4. GlobalFallbackHandler - Familia.dbclient(uri || logical_database) (global fallback)

Returns:

  • (Redis) —

    the Database connection instance.



391
392
393
 
# File 'lib/familia/horreum.rb', line 391

def generate_id
  @objid ||= Familia.generate_id
end

#identifier ⇒ Object

Determines the unique identifier for the instance This method is used to generate dbkeys for the object Returns nil for unsaved objects (following standard ORM patterns)



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/familia/horreum.rb', line 361

def identifier
  definition = self.class.identifier_field
  return nil if definition.nil?

  # Call the identifier field or proc (validation already done at class definition time)
  unique_id = case definition
              when Symbol, String
                send(definition)
              when Proc
                definition.call(self)
  end

  # Return nil for unpopulated identifiers (like unsaved ActiveRecord objects)
  # Only raise errors when the identifier is actually needed for db operations
  return nil if unique_id.nil? || unique_id.to_s.empty?

  unique_id
end

#init ⇒ void

This method returns an undefined value.

Initialization method called at the end of initialize

Override this method to apply defaults, run validations, or setup callbacks. It's recommended to call super as other modules like features can also override init.

IMPORTANT: The init method receieves no arguments. By the time this runs, all arguments to initialize have already been consumed and used to set fields. Use the ||= operator to preserve values already set:

def init(email: nil, user_id: nil, **kwargs) @email ||= email # Preserves value from new() @user_id ||= user_id # Preserves value from new() @created_at ||= Familia.now # Applies default if not set

# Example of additional initialization logic
validate_email_format if @email
setup_callbacks

end



276
277
278
 
# File 'lib/familia/horreum.rb', line 276

def init
  # Default no-op - override in subclasses
end

#initialize_relatives ⇒ Object

Sets up related Database objects for the instance This method is crucial for establishing Valkey/Redis-based relationships

This needs to be called in the initialize method.



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/familia/horreum.rb', line 285

def initialize_relatives
  # Store initialization flag on singleton class to avoid polluting instance variables
  return if singleton_class.instance_variable_defined?(:"@relatives_initialized")
  # Generate instances of each DataType. These need to be
  # unique for each instance of this class so they can piggyback
  # on the specifc index of this instance.
  #
  # i.e.
  #     familia_object.dbkey              == v1:bone:INDEXVALUE:object
  #     familia_object.related_object.dbkey == v1:bone:INDEXVALUE:name
  #
  self.class.related_fields.each_pair do |name, data_type_definition|
    klass = data_type_definition.klass
    opts = data_type_definition.opts
    Familia.trace :INITIALIZE_RELATIVES, nil, "#{name} => #{klass} #{opts.keys}" if Familia.debug?

    # As a subclass of Familia::Horreum, we add ourselves as the parent
    # automatically. This is what determines the dbkey for DataType
    # instance and which database connection.
    #
    #   e.g. If the parent's dbkey is `customer:customer_id:object`
    #     then the dbkey for this DataType instance will be
    #     `customer:customer_id:name`.
    #
    # Store reference to the instance for lazy ParentDefinition creation
    opts[:parent] = self

    suffix_override = opts.fetch(:suffix, name)

    # Instantiate the DataType object and below we store it in
    # an instance variable.
    related_object = klass.new suffix_override, opts

    # Freezes the related_object, making it immutable.
    # This ensures the object's state remains consistent and prevents any modifications,
    # safeguarding its integrity and making it thread-safe.
    # Any attempts to change the object after this will raise a FrozenError.
    related_object.freeze

    # e.g. customer.name  #=> `#<Familia::HashKey:0x0000...>`
    instance_variable_set :"@#{name}", related_object
  end

  # Mark relatives as initialized on singleton class to avoid polluting instance variables
  singleton_class.instance_variable_set(:"@relatives_initialized", true)
end

#initialize_with_keyword_args_deserialize_value(**fields) ⇒ Object 



332
333
334
335
336
337
338
 
# File 'lib/familia/horreum.rb', line 332

def initialize_with_keyword_args_deserialize_value(**fields)
  # Deserialize Database string values back to their original types
  deserialized_fields = fields.each_with_object({}) do |(field_name, value), hsh|
    hsh[field_name] = deserialize_value(value, field_name: field_name)
  end
  initialize_with_keyword_args(**deserialized_fields)
end

#naive_refresh(**fields) ⇒ Array

A thin wrapper around the private initialize method that accepts a field hash and refreshes the existing object.

This method is part of horreum.rb rather than serialization.rb because it operates solely on the provided values and doesn't query Database or other external sources. That's why it's called "naive" refresh: it assumes the provided values are correct and updates the object accordingly.

Parameters:

  • fields (Hash) —

    A hash of field names and their new values to update the object with.

Returns:

  • (Array) —

    The list of field names that were updated.

See Also:



353
354
355
356
 
# File 'lib/familia/horreum.rb', line 353

def naive_refresh(**fields)
  Familia.debug "[naive_refresh] #{self.class} #{dbkey} #{fields.keys}"
  initialize_with_keyword_args_deserialize_value(**fields)
end

#to_s ⇒ Object

The principle is: If Familia objects have to_s, then they should work everywhere strings are expected, including as Database hash field names.



397
398
399
400
401
402
403
404
 
# File 'lib/familia/horreum.rb', line 397

def to_s
  # Enable polymorphic string usage for Familia objects
  # This allows passing Familia objects directly where strings are expected
  # without requiring explicit .identifier calls
  return super if identifier.to_s.empty?

  identifier.to_s
end