Module: Familia::Horreum::ClassMethods

Includes:
RelationsManagement, Settings
Defined in:
lib/familia/horreum/class_methods.rb

Overview

ClassMethods: Provides class-level functionality for Horreum

This module is extended into classes that include Familia::Horreum, providing methods for Redis operations and object management.

Key features:

  • Includes RelationsManagement for Redis-type field handling

  • Defines methods for managing fields, identifiers, and Redis keys

  • Provides utility methods for working with Redis objects

Instance Attribute Summary

Attributes included from Settings

#delim, #ttl

Instance Method Summary collapse

Methods included from RelationsManagement

#attach_class_redis_object_relation, #attach_instance_redis_object_relation, included

Methods included from Settings

#default_suffix

Instance Method Details

#all(suffix = nil) ⇒ Object 



210
211
212
213
214
 
# File 'lib/familia/horreum/class_methods.rb', line 210

def all(suffix = nil)
  suffix ||= self.suffix
  # objects that could not be parsed will be nil
  keys(suffix).filter_map { |k| find_by_key(k) }
end

#any?(filter = '*') ⇒ Boolean

Returns:

  • (Boolean) 


216
217
218
 
# File 'lib/familia/horreum/class_methods.rb', line 216

def any?(filter = '*')
  matching_keys_count(filter) > 0
end

#class_redis_types ⇒ Object 



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

def class_redis_types
  @class_redis_types ||= {}
  @class_redis_types
end

#class_redis_types?(name) ⇒ Boolean

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/familia/horreum/class_methods.rb', line 183

def class_redis_types?(name)
  class_redis_types.key? name.to_s.to_sym
end

#create(*args, **kwargs) ⇒ Object

Note:

The behavior of this method depends on the implementation of #new, #exists?, and #save in the class and its superclasses.

Creates and persists a new instance of the class.

This method serves as a factory method for creating and persisting new instances of the class. It combines object instantiation, existence checking, and persistence in a single operation.

The method is flexible in accepting both positional and keyword arguments:

  • Positional arguments (*args) are passed directly to the constructor.

  • Keyword arguments (**kwargs) are passed as a hash to the constructor.

After instantiation, the method checks if an object with the same identifier already exists. If it does, a Familia::Problem exception is raised to prevent overwriting existing data.

Finally, the method saves the new instance returns it.

Examples:

Creating an object with keyword arguments

User.create(name: "John", age: 30)

Creating an object with positional and keyword arguments (not recommended)

Product.create("SKU123", name: "Widget", price: 9.99)

Parameters:

  • *args (Array) —

    Variable number of positional arguments to be passed to the constructor.

  • **kwargs (Hash) —

    Keyword arguments to be passed to the constructor.

Returns:

  • (Object) —

    The newly created and persisted instance.

Raises:

  • (Familia::Problem) —

    If an instance with the same identifier already exists.

See Also:



274
275
276
277
278
279
280
 
# File 'lib/familia/horreum/class_methods.rb', line 274

def create *args, **kwargs
  fobj = new(*args, **kwargs)
  raise Familia::Problem, "#{self} already exists: #{fobj.rediskey}" if fobj.exists?

  fobj.save
  fobj
end

#db(v = nil) ⇒ Object 



200
201
202
203
 
# File 'lib/familia/horreum/class_methods.rb', line 200

def db(v = nil)
  @db = v unless v.nil?
  @db || parent&.db
end

#destroy!(identifier, suffix = nil) ⇒ Boolean

Destroys an object in Redis with the given identifier.

This method is part of Familia’s high-level object lifecycle management. While ‘delete!` operates directly on Redis keys, `destroy!` operates at the object level and is used for ORM-style operations. Use `destroy!` when removing complete objects from the system, and `delete!` when working directly with Redis keys.

Examples:

User.destroy!(123)  # Removes user:123:object from Redis

Parameters:

  • identifier (String, Integer) —

    The unique identifier for the object to destroy.

  • suffix (Symbol, nil) (defaults to: nil) —

    The suffix to use in the Redis key (default: class suffix).

Returns:

  • (Boolean) —

    true if the object was successfully destroyed, false otherwise.



418
419
420
421
422
423
424
425
426
427
 
# File 'lib/familia/horreum/class_methods.rb', line 418

def destroy!(identifier, suffix = nil)
  suffix ||= self.suffix
  return false if identifier.to_s.empty?

  objkey = rediskey identifier, suffix

  ret = redis.del objkey
  Familia.trace :DESTROY!, redis, "#{objkey} #{ret.inspect}", caller(1..1) if Familia.debug?
  ret.positive?
end

#dump_method ⇒ Object 



463
464
465
 
# File 'lib/familia/horreum/class_methods.rb', line 463

def dump_method
  @dump_method || :to_json # Familia.dump_method
end

#exists?(identifier, suffix = nil) ⇒ Boolean

Checks if an object with the given identifier exists in Redis.

This method constructs the full Redis key using the provided identifier and suffix, then checks if the key exists in Redis.

Examples:

User.exists?(123)  # Returns true if user:123:object exists in Redis

Parameters:

  • identifier (String, Integer) —

    The unique identifier for the object.

  • suffix (Symbol, nil) (defaults to: nil) —

    The suffix to use in the Redis key (default: class suffix).

Returns:

  • (Boolean) —

    true if the object exists, false otherwise.



392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/familia/horreum/class_methods.rb', line 392

def exists?(identifier, suffix = nil)
  suffix ||= self.suffix
  return false if identifier.to_s.empty?

  objkey = rediskey identifier, suffix

  ret = redis.exists objkey
  Familia.trace :EXISTS, redis, "#{objkey} #{ret.inspect}", caller(1..1) if Familia.debug?

  ret.positive? # differs from redis API but I think it's okay bc `exists?` is a predicate method.
end

#fast_attribute!(name = nil) ⇒ Object

Defines a fast attribute method with a bang (!) suffix for a given attribute name. Fast attribute methods are used to immediately read or write attribute values from/to Redis. Calling a fast attribute method has no effect on any of the object’s other attributes and does not trigger a call to update the object’s expiration time.

The dynamically defined method performs the following:

  • Acts as both a reader and a writer method.

  • When called without arguments, retrieves the current value from Redis.

  • When called with an argument, persists the value to Redis immediately.

  • Checks if the correct number of arguments is provided (zero or one).

  • Converts the provided value to a format suitable for Redis storage.

  • Uses the existing accessor method to set the attribute value when writing.

  • Persists the value to Redis immediately using the hset command when writing.

  • Includes custom error handling to raise an ArgumentError if the wrong number of arguments is given.

  • Raises a custom error message if an exception occurs during the execution of the method.

Parameters:

  • name (Symbol, String) (defaults to: nil) —

    the name of the attribute for which the fast method is defined.

Returns:

  • (Object) —

    the current value of the attribute when called without arguments.

Raises:

  • (ArgumentError) —

    if more than one argument is provided.

  • (RuntimeError) —

    if an exception occurs during the execution of the method.



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
 
# File 'lib/familia/horreum/class_methods.rb', line 107

def fast_attribute!(name = nil)
  # Fast attribute accessor method for the '#{name}' attribute.
  # This method provides immediate read and write access to the attribute
  # in Redis.
  #
  # When called without arguments, it retrieves the current value of the
  # attribute from Redis.
  # When called with an argument, it immediately persists the new value to
  # Redis.
  #
  # @overload #{name}!
  #   Retrieves the current value of the attribute from Redis.
  #   @return [Object] the current value of the attribute.
  #
  # @overload #{name}!(value)
  #   Sets and immediately persists the new value of the attribute to
  #   Redis.
  #   @param value [Object] the new value to set for the attribute.
  #   @return [Object] the newly set value.
  #
  # @raise [ArgumentError] if more than one argument is provided.
  # @raise [RuntimeError] if an exception occurs during the execution of
  #   the method.
  #
  # @note This method bypasses any object-level caching and interacts
  #   directly with Redis. It does not trigger updates to other attributes
  #   or the object's expiration time.
  #
  # @example
  #
  #      def #{name}!(*args)
  #        # Method implementation
  #      end
  #
  define_method :"#{name}!" do |*args|
    # Check if the correct number of arguments is provided (exactly one).
    raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 0 or 1)" if args.size > 1

    val = args.first

    # If no value is provided to this fast attribute method, make a call
    # to redis to return the current stored value of the hash field.
    return hget name if val.nil?

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

      # Convert the provided value to a format suitable for Redis storage.
      prepared = serialize_value(val)
      Familia.ld "[.fast_attribute!] #{name} val: #{val.class} prepared: #{prepared.class}"

      # Use the existing accessor method to set the attribute value.
      send :"#{name}=", val

      # Persist the value to Redis immediately using the hset command.
      hset name, prepared
    rescue Familia::Problem => e
      # Raise a custom error message if an exception occurs during the execution of the method.
      raise "#{name}! method failed: #{e.message}", e.backtrace
    end
  end
end

#field(name) ⇒ Object

Defines a field for the class and creates accessor methods.

This method defines a new field for the class, creating getter and setter instance methods similar to ‘attr_accessor`. It also generates a fast writer method for immediate persistence to Redis.

Parameters:

  • name (Symbol, String) —

    the name of the field to define.



70
71
72
73
74
75
76
 
# File 'lib/familia/horreum/class_methods.rb', line 70

def field(name)
  fields << name
  attr_accessor name

  # Every field gets a fast attribute method for immediately persisting
  fast_attribute! name
end

#fields ⇒ Object

Returns the list of field names defined for the class in the order that they were defined. i.e. ‘field :a; field :b; fields => [:a, :b]`.



173
174
175
176
 
# File 'lib/familia/horreum/class_methods.rb', line 173

def fields
  @fields ||= []
  @fields
end

#find_by_id(identifier, suffix = nil) ⇒ Object? Also known as: find, load, from_identifier

Retrieves and instantiates an object from Redis using its identifier.

This method constructs the full Redis key using the provided identifier and suffix, then delegates to ‘find_by_key` for the actual retrieval and instantiation.

It’s a higher-level method that abstracts away the key construction, making it easier to retrieve objects when you only have their identifier.

Examples:

User.find_by_id(123)  # Equivalent to User.find_by_key("user:123:object")

Parameters:

  • identifier (String, Integer) —

    The unique identifier for the object.

  • suffix (Symbol) (defaults to: nil) —

    The suffix to use in the Redis key (default: :object).

Returns:

  • (Object, nil) —

    An instance of the class if found, nil otherwise.



366
367
368
369
370
371
372
373
374
375
 
# File 'lib/familia/horreum/class_methods.rb', line 366

def find_by_id(identifier, suffix = nil)
  suffix ||= self.suffix
  return nil if identifier.to_s.empty?

  objkey = rediskey(identifier, suffix)

  Familia.ld "[.find_by_id] #{self} from key #{objkey})"
  Familia.trace :FIND_BY_ID, Familia.redis(uri), objkey, caller(1..1).first if Familia.debug?
  find_by_key objkey
end

#find_by_key(objkey) ⇒ Object? Also known as: from_rediskey

Retrieves and instantiates an object from Redis using the full object key.

This method performs a two-step process to safely retrieve and instantiate objects:

  1. It first checks if the key exists in Redis. This is crucial because:

    • It provides a definitive answer about the object’s existence.

    • It prevents ambiguity that could arise from ‘hgetall` returning an empty hash for non-existent keys, which could lead to the creation of “empty” objects.

  2. If the key exists, it retrieves the object’s data and instantiates it.

This approach ensures that we only attempt to instantiate objects that actually exist in Redis, improving reliability and simplifying debugging.

Examples:

User.find_by_key("user:123")  # Returns a User instance if it exists,
nil otherwise

Parameters:

  • objkey (String) —

    The full Redis key for the object.

Returns:

  • (Object, nil) —

    An instance of the class if the key exists, nil otherwise.

Raises:

  • (ArgumentError) —

    If the provided key is empty.



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/familia/horreum/class_methods.rb', line 323

def find_by_key(objkey)
  raise ArgumentError, 'Empty key' if objkey.to_s.empty?

  # We use a lower-level method here b/c we're working with the
  # full key and not just the identifier.
  does_exist = redis.exists(objkey).positive?

  Familia.ld "[.find_by_key] #{self} from key #{objkey} (exists: #{does_exist})"
  Familia.trace :FROM_KEY, redis, objkey, caller(1..1) if Familia.debug?

  # This is the reason for calling exists first. We want to definitively
  # and without any ambiguity know if the object exists in Redis. If it
  # doesn't, we return nil. If it does, we proceed to load the object.
  # Otherwise, hgetall will return an empty hash, which will be passed to
  # the constructor, which will then be annoying to debug.
  return unless does_exist

  obj = redis.hgetall(objkey) # horreum objects are persisted as redis hashes
  Familia.trace :FROM_KEY2, redis, "#{objkey}: #{obj.inspect}", caller(1..1) if Familia.debug?

  new(**obj)
end

#find_keys(suffix = '*') ⇒ Array<String>

Finds all keys in Redis matching the given suffix pattern.

This method searches for all Redis keys that match the given suffix pattern. It uses the class’s rediskey method to construct the search pattern.

Examples:

User.find  # Returns all keys matching user:*:object
User.find('active')  # Returns all keys matching user:*:active

Parameters:

  • suffix (String) (defaults to: '*') —

    The suffix pattern to match (default: ‘*’).

Returns:

  • (Array<String>) —

    An array of matching Redis keys.



441
442
443
 
# File 'lib/familia/horreum/class_methods.rb', line 441

def find_keys(suffix = '*')
  redis.keys(rediskey('*', suffix)) || []
end

#has_relations? ⇒ Boolean

Returns:

  • (Boolean) 


196
197
198
 
# File 'lib/familia/horreum/class_methods.rb', line 196

def has_relations?
  @has_relations ||= false
end

#identifier(val = nil) ⇒ Object

Sets or retrieves the unique identifier for the class.

This method defines or returns the unique identifier used to generate the Redis key for the object. If a value is provided, it sets the identifier; otherwise, it returns the current identifier.

Parameters:

  • val (Object) (defaults to: nil) —

    the value to set as the identifier (optional).

Returns:

  • (Object) —

    the current identifier.



57
58
59
60
 
# File 'lib/familia/horreum/class_methods.rb', line 57

def identifier(val = nil)
  @identifier = val if val
  @identifier
end

#load_method ⇒ Object 



467
468
469
 
# File 'lib/familia/horreum/class_methods.rb', line 467

def load_method
  @load_method || :from_json # Familia.load_method
end

#matching_keys_count(filter = '*') ⇒ Integer Also known as: size

Returns the number of Redis keys matching the given filter pattern

Parameters:

  • filter (String) (defaults to: '*') —

    Redis key pattern to match (default: ‘*’)

Returns:

  • (Integer) —

    Number of matching keys



223
224
225
 
# File 'lib/familia/horreum/class_methods.rb', line 223

def matching_keys_count(filter = '*')
  redis.keys(rediskey(filter)).compact.size
end

#multiget(*ids) ⇒ Object 



282
283
284
285
 
# File 'lib/familia/horreum/class_methods.rb', line 282

def multiget(*ids)
  ids = rawmultiget(*ids)
  ids.filter_map { |json| from_json(json) }
end

#prefix(a = nil) ⇒ Object 



233
234
235
236
 
# File 'lib/familia/horreum/class_methods.rb', line 233

def prefix(a = nil)
  @prefix = a if a
  @prefix || name.downcase.gsub('::', Familia.delim).to_sym
end

#rawmultiget(*ids) ⇒ Object 



287
288
289
290
291
292
293
 
# File 'lib/familia/horreum/class_methods.rb', line 287

def rawmultiget(*ids)
  ids.collect! { |objid| rediskey(objid) }
  return [] if ids.compact.empty?

  Familia.trace :MULTIGET, redis, "#{ids.size}: #{ids}", caller(1..1) if Familia.debug?
  redis.mget(*ids)
end

#redis ⇒ Redis

Returns the Redis connection for the class.

This method retrieves the Redis connection instance for the class. If no connection is set, it initializes a new connection using the provided URI or database configuration.

Returns:

  • (Redis) —

    the Redis connection instance.



44
45
46
 
# File 'lib/familia/horreum/class_methods.rb', line 44

def redis
  @redis || Familia.redis(uri || db)
end

#redis_object?(name) ⇒ Boolean

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/familia/horreum/class_methods.rb', line 187

def redis_object?(name)
  redis_types.key? name.to_s.to_sym
end

#redis_types ⇒ Object 



191
192
193
194
 
# File 'lib/familia/horreum/class_methods.rb', line 191

def redis_types
  @redis_types ||= {}
  @redis_types
end

#rediskey(identifier, suffix = self.suffix) ⇒ Object

identifier can be a value or an Array of values used to create the index. We don’t enforce a default suffix; that’s left up to the instance. The suffix is used to differentiate between different types of objects.

suffix If a nil value is explicitly passed in, it won’t appear in the redis key that’s returned. If no suffix is passed in, the class’ suffix is used as the default (via the class method self.suffix). It’s an important distinction b/c passing in an explicitly nil is how RedisType objects at the class level are created without the global default ‘object’ suffix. See RedisType#rediskey “parent_class?” for more details.

Raises:



455
456
457
458
459
460
461
 
# File 'lib/familia/horreum/class_methods.rb', line 455

def rediskey(identifier, suffix = self.suffix)
  # Familia.ld "[.rediskey] #{identifier} for #{self} (suffix:#{suffix})"
  raise NoIdentifier, self if identifier.to_s.empty?

  identifier &&= identifier.to_s
  Familia.rediskey(prefix, identifier, suffix)
end

#suffix(a = nil, &blk) ⇒ Object 



228
229
230
231
 
# File 'lib/familia/horreum/class_methods.rb', line 228

def suffix(a = nil, &blk)
  @suffix = a || blk if a || !blk.nil?
  @suffix || Familia.default_suffix
end

#uri(v = nil) ⇒ Object 



205
206
207
208
 
# File 'lib/familia/horreum/class_methods.rb', line 205

def uri(v = nil)
  @uri = v unless v.nil?
  @uri || parent&.uri
end