Class: Familia::FieldType

Inherits:
Object
  • Object
show all
Defined in:
lib/familia/field_type.rb

Overview

Base class for all field types in Familia

Field types encapsulate the behavior for different kinds of fields, including how their getter/setter methods are defined and how values are serialized/deserialized.

Examples:

Creating a custom field type

class TimestampFieldType < Familia::FieldType
  def define_setter(klass)
    field_name = @name
    klass.define_method :"#{@method_name}=" do |value|
      timestamp = value.is_a?(Time) ? value.to_i : value
      instance_variable_set(:"@#{field_name}", timestamp)
    end
  end

  def define_getter(klass)
    field_name = @name
    klass.define_method @method_name do
      timestamp = instance_variable_get(:"@#{field_name}")
      timestamp ? Time.at(timestamp) : nil
    end
  end
end

Direct Known Subclasses

EncryptedFieldType, TransientFieldType

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, as: name, fast_method: :"#{name}!", on_conflict: :raise, loggable: true, **options) ⇒ FieldType

Initialize a new field type

Parameters:

  • name (Symbol) —

    The field name

  • as (Symbol, String, false) (defaults to: name) —

    The method name (defaults to field name) If false, no accessor methods are created

  • fast_method (Symbol, String, false) (defaults to: :"#{name}!") —

    The fast method name (defaults to “##name!”). If false, no fast method is created

  • on_conflict (Symbol) (defaults to: :raise) —

    Conflict resolution strategy when method already exists (:raise, :skip, :warn, :overwrite)

  • loggable (Boolean) (defaults to: true) —

    Whether this field should be included in serialization and logging operations (default: true)

  • options (Hash) —

    Additional options for the field type



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/familia/field_type.rb', line 45

def initialize(name, as: name, fast_method: :"#{name}!", on_conflict: :raise, loggable: true, **options)
  @name = name.to_sym
  @method_name = as == false ? nil : as.to_sym
  @fast_method_name = fast_method == false ? nil : fast_method&.to_sym

  # Validate fast method name format
  if @fast_method_name && !@fast_method_name.to_s.end_with?('!')
    raise ArgumentError, "Fast method name must end with '!' (got: #{@fast_method_name})"
  end

  @on_conflict = on_conflict
  @loggable = loggable
  @options = options
end

Instance Attribute Details

#fast_method_name ⇒ Object (readonly)

Returns the value of attribute fast_method_name.



30
31
32
 
# File 'lib/familia/field_type.rb', line 30

def fast_method_name
  @fast_method_name
end

#loggable ⇒ Object (readonly)

Returns the value of attribute loggable.



30
31
32
 
# File 'lib/familia/field_type.rb', line 30

def loggable
  @loggable
end

#method_name ⇒ Object (readonly)

Returns the value of attribute method_name.



30
31
32
 
# File 'lib/familia/field_type.rb', line 30

def method_name
  @method_name
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



30
31
32
 
# File 'lib/familia/field_type.rb', line 30

def name
  @name
end

#on_conflict ⇒ Object (readonly)

Returns the value of attribute on_conflict.



30
31
32
 
# File 'lib/familia/field_type.rb', line 30

def on_conflict
  @on_conflict
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



30
31
32
 
# File 'lib/familia/field_type.rb', line 30

def options
  @options
end

Instance Method Details

#category ⇒ Symbol

The category for this field type (used for filtering)

Returns:

  • (Symbol) —

    the field category



181
182
183
 
# File 'lib/familia/field_type.rb', line 181

def category
  :field
end

#define_fast_writer(klass) ⇒ Object

Define the fast writer method on the target class

Fast methods provide direct database access for immediate persistence. Subclasses can override this to customize fast method behavior.

Parameters:

  • klass (Class) —

    The class to define the method on



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
 
# File 'lib/familia/field_type.rb', line 128

def define_fast_writer(klass)
  return unless @fast_method_name&.to_s&.end_with?('!')

  field_name = @name
  method_name = @method_name
  fast_method_name = @fast_method_name

  handle_method_conflict(klass, fast_method_name) do
    klass.define_method fast_method_name do |*args|
      raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0 or 1)" if args.size > 1

      val = args.first

      # If no value provided, return current stored value
      return hget(field_name) if val.nil?

      begin
        # Trace the operation if debugging is enabled
        Familia.trace :FAST_WRITER, dbclient, "#{field_name}: #{val.inspect}", caller(1..1) if Familia.debug?

        # Convert value for database storage
        prepared = serialize_value(val)
        Familia.ld "[FieldType#define_fast_writer] #{fast_method_name} val: #{val.class} prepared: #{prepared.class}"

        # Use the setter method to update instance variable
        send(:"#{method_name}=", val) if method_name

        # Persist to database immediately
        ret = hset(field_name, prepared)
        ret.zero? || ret.positive?
      rescue Familia::Problem => e
        raise "#{fast_method_name} method failed: #{e.message}", e.backtrace
      end
    end
  end
end

#define_getter(klass) ⇒ Object

Define the getter method on the target class

Subclasses can override this to customize getter behavior. The default implementation creates a simple attr_reader equivalent.

Parameters:

  • klass (Class) —

    The class to define the method on



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/familia/field_type.rb', line 92

def define_getter(klass)
  field_name = @name
  method_name = @method_name

  handle_method_conflict(klass, method_name) do
    klass.define_method method_name do
      instance_variable_get(:"@#{field_name}")
    end
  end
end

#define_setter(klass) ⇒ Object

Define the setter method on the target class

Subclasses can override this to customize setter behavior. The default implementation creates a simple attr_writer equivalent.

Parameters:

  • klass (Class) —

    The class to define the method on



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/familia/field_type.rb', line 110

def define_setter(klass)
  field_name = @name
  method_name = @method_name

  handle_method_conflict(klass, :"#{method_name}=") do
    klass.define_method :"#{method_name}=" do |value|
      instance_variable_set(:"@#{field_name}", value)
    end
  end
end

#deserialize(value, _record = nil) ⇒ Object

Deserialize a value from database storage

Subclasses can override this to customize deserialization. The default implementation passes values through unchanged.

Parameters:

  • value (Object) —

    The value to deserialize

  • record (Object) —

    The record instance (for context)

Returns:

  • (Object) —

    The deserialized value



207
208
209
 
# File 'lib/familia/field_type.rb', line 207

def deserialize(value, _record = nil)
  value
end

#generated_methods ⇒ Array<Symbol>

Returns all method names generated for this field (used for conflict detection)

Returns:

  • (Array<Symbol>) —

    Array of method names this field type generates



215
216
217
 
# File 'lib/familia/field_type.rb', line 215

def generated_methods
  [@method_name, @fast_method_name].compact
end

#inspect ⇒ String Also known as: to_s

Enhanced inspection output for debugging

Returns:

  • (String) —

    Human-readable representation



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/familia/field_type.rb', line 223

def inspect
  attributes = [
    "name=#{@name}",
    "method_name=#{@method_name}",
    "fast_method_name=#{@fast_method_name}",
    "on_conflict=#{@on_conflict}",
    "category=#{category}"
  ]
  "#<#{self.class.name} #{attributes.join(' ')}>"
end

#install(klass) ⇒ Object

Install this field type on a class

This method defines all necessary methods on the target class and registers the field type for later reference.

Parameters:

  • klass (Class) —

    The class to install this field type on



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/familia/field_type.rb', line 67

def install(klass)
  if @method_name
    # For skip strategy, check for any method conflicts first
    if @on_conflict == :skip
      has_getter_conflict = klass.method_defined?(@method_name) || klass.private_method_defined?(@method_name)
      has_setter_conflict = klass.method_defined?(:"#{@method_name}=") || klass.private_method_defined?(:"#{@method_name}=")

      # If either getter or setter conflicts, skip the whole field
      return if has_getter_conflict || has_setter_conflict
    end

    define_getter(klass)
    define_setter(klass)
  end

  define_fast_writer(klass) if @fast_method_name
end

#persistent? ⇒ Boolean

Whether this field should be persisted to the database

Returns:

  • (Boolean) —

    true if field should be persisted



169
170
171
 
# File 'lib/familia/field_type.rb', line 169

def persistent?
  true
end

#serialize(value, _record = nil) ⇒ Object

Serialize a value for database storage

Subclasses can override this to customize serialization. The default implementation passes values through unchanged.

Parameters:

  • value (Object) —

    The value to serialize

  • record (Object) —

    The record instance (for context)

Returns:

  • (Object) —

    The serialized value



194
195
196
 
# File 'lib/familia/field_type.rb', line 194

def serialize(value, _record = nil)
  value
end

#transient? ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
 
# File 'lib/familia/field_type.rb', line 173

def transient?
  !persistent?
end