Module: Lutaml::Model::CollectionHandler

Included in:
Attribute
Defined in:
lib/lutaml/model/collection_handler.rb

Overview

Module for handling collection-related operations on attributes.

Provides methods for checking if an attribute is a collection, getting the collection class, building collections, and related operations.

Constant Summary collapse

KEYWORD_PARAM_KINDS =

Parameter kinds that carry a named keyword in Method#parameters.

%i[key keyreq].freeze

Instance Method Summary collapse

Instance Method Details

#build_collection(*args, register: nil) ⇒ Object

Build a new collection with the given values

Custom Collection classes resolve their item type through the register, so thread it through when one is supplied. Plain Array collections and register-less callers keep the prior construction path untouched.

Parameters:

  • args (Array) —

    Values to include in the collection

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

    Register for custom-collection type resolution

Returns:

  • (Object) —

    A new collection instance



61
62
63
64
65
66
67
68
 
# File 'lib/lutaml/model/collection_handler.rb', line 61

def build_collection(*args, register: nil)
  items = args.flatten
  unless register && initialize_accepts_register?
    return collection_class.new(items)
  end

  collection_class.new(items, lutaml_register: register)
end

#coerce_to_collection?(value) ⇒ Boolean

Whether a bare single value assigned to this attribute must be coerced into a one-element collection, so assignment produces the same shape as parsing. nil and the uninitialized sentinel pass through untouched to preserve absent-value semantics.

Parameters:

  • value (Object) —

    The value being assigned

Returns:

  • (Boolean) —

    true if the value should be wrapped



96
97
98
 
# File 'lib/lutaml/model/collection_handler.rb', line 96

def coerce_to_collection?(value)
  collection? && !value.nil? && !Utils.uninitialized?(value)
end

#collection ⇒ Object?

Get the collection options

Returns:

  • (Object, nil) —

    The collection option value



16
17
18
 
# File 'lib/lutaml/model/collection_handler.rb', line 16

def collection
  @options[:collection]
end

#collection? ⇒ Boolean

Check if this attribute is a collection Performance: Memoized to avoid repeated hash lookups

Returns:

  • (Boolean) —

    true if attribute is a collection



24
25
26
 
# File 'lib/lutaml/model/collection_handler.rb', line 24

def collection?
  @collection ||= collection || false
end

#collection_class ⇒ Class

Get the collection class to use for this attribute Performance: Memoized

Returns:

  • (Class) —

    The collection class (Array or custom collection class)



40
41
42
 
# File 'lib/lutaml/model/collection_handler.rb', line 40

def collection_class
  @collection_class ||= custom_collection? ? collection : Array
end

#collection_instance?(value) ⇒ Boolean

Check if value is an instance of the collection class

Parameters:

  • value (Object) —

    The value to check

Returns:

  • (Boolean) —

    true if value is a collection instance



48
49
50
 
# File 'lib/lutaml/model/collection_handler.rb', line 48

def collection_instance?(value)
  value.is_a?(collection_class)
end

#custom_collection? ⇒ Boolean

Check if this attribute uses a custom collection class Performance: Memoized

Returns:

  • (Boolean) —

    true if using a custom collection class



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/lutaml/model/collection_handler.rb', line 104

def custom_collection?
  return @custom_collection if defined?(@custom_collection)

  @custom_collection = if singular?
                         false
                       elsif collection == true
                         false
                       elsif collection.is_a?(Range)
                         false
                       else
                         collection <= Lutaml::Model::Collection
                       end
end

#initialize_accepts_register? ⇒ Boolean

Whether the collection class can be handed a register at construction.

A custom Collection subclass may override #initialize with the positional signature that predates the register, and passing the keyword to one of those raises ArgumentError. Such a subclass resolves its item types against the default register instead — there is no way to reach a constructor that does not accept one.

Returns:

  • (Boolean) —

    true if #initialize declares the register keyword



79
80
81
82
83
84
85
86
87
 
# File 'lib/lutaml/model/collection_handler.rb', line 79

def initialize_accepts_register?
  return @initialize_accepts_register if defined?(@initialize_accepts_register)

  @initialize_accepts_register = custom_collection? &&
    collection_class.instance_method(:initialize).parameters.any? do |kind, param|
      kind == :keyrest ||
        (KEYWORD_PARAM_KINDS.include?(kind) && param == :lutaml_register)
    end
end

#min_collection_zero? ⇒ Boolean

Check if the collection minimum is zero

Returns:

  • (Boolean) —

    true if collection min is zero



133
134
135
 
# File 'lib/lutaml/model/collection_handler.rb', line 133

def min_collection_zero?
  collection? && resolved_collection.min.zero?
end

#resolved_collection ⇒ Range?

Get the resolved collection range Performance: Memoized

Returns:

  • (Range, nil) —

    The collection range or nil if not a collection



122
123
124
125
126
127
128
 
# File 'lib/lutaml/model/collection_handler.rb', line 122

def resolved_collection
  @resolved_collection ||= begin
    return unless collection?

    collection.is_a?(Range) ? validated_range_object : 0..Float::INFINITY
  end
end

#singular? ⇒ Boolean

Check if this attribute is a singular (non-collection) value Performance: Memoized

Returns:

  • (Boolean) —

    true if attribute is not a collection



32
33
34
 
# File 'lib/lutaml/model/collection_handler.rb', line 32

def singular?
  @singular ||= !collection?
end