Module: Lutaml::Model::Serialize::EnumHandling

Included in:
ClassMethods
Defined in:
lib/lutaml/model/serialize/enum_handling.rb

Overview

Handles enum-related methods for Serialize::ClassMethods

Extracted from serialize.rb to improve code organization. Provides methods for adding enum getter/setter methods to model classes.

Instance Method Summary collapse

Instance Method Details

#add_enum_getter_if_not_defined(klass, enum_name, collection) ⇒ Object

Add enum getter method to model class

Parameters:

  • klass (Class) —

    The model class

  • enum_name (Symbol) —

    The enum attribute name

  • collection (Boolean) —

    Whether the enum is a collection



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

def add_enum_getter_if_not_defined(klass, enum_name, collection)
  Utils.add_method_if_not_defined(klass, enum_name) do
    i = instance_variable_get(:"@#{enum_name}") || []

    if !collection && i.is_a?(Array)
      i.first
    else
      i.uniq
    end
  end
end

#add_enum_methods_to_model(klass, enum_name, values, collection: false) ⇒ Object

Add enum methods to a model class

Parameters:

  • klass (Class) —

    The model class to add methods to

  • enum_name (Symbol) —

    The name of the enum attribute

  • values (Array) —

    The valid enum values

  • collection (Boolean) (defaults to: false) —

    Whether the enum is a collection



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/lutaml/model/serialize/enum_handling.rb', line 17

def add_enum_methods_to_model(klass, enum_name, values,
                              collection: false)
  add_enum_getter_if_not_defined(klass, enum_name, collection)
  add_enum_setter_if_not_defined(klass, enum_name, values, collection)

  return unless values.all?(::String)

  values.each do |value|
    Utils.add_method_if_not_defined(klass, "#{value}?") do
      curr_value = public_send(:"#{enum_name}")

      if collection
        curr_value.include?(value)
      else
        curr_value == value
      end
    end

    # Record value name so regular attribute definitions can
    # override these shorthand methods when an attribute shares
    # the same name as an enum value (e.g. attribute :char with
    # align values including "char").
    enum_shorthand_names = klass.instance_variable_get(:@__enum_shorthand_names__) || Set.new
    enum_shorthand_names << value.to_s
    klass.instance_variable_set(:@__enum_shorthand_names__,
                                enum_shorthand_names)

    Utils.add_method_if_not_defined(klass, value.to_s) do
      public_send(:"#{value}?")
    end

    Utils.add_method_if_not_defined(klass, "#{value}=") do |val|
      value_set_for(enum_name)
      enum_vals = public_send(:"#{enum_name}")

      enum_vals = if !!val
                    if collection
                      enum_vals << value
                    else
                      [value]
                    end
                  elsif collection
                    enum_vals.delete(value)
                    enum_vals
                  else
                    instance_variable_get(:"@#{enum_name}") - [value]
                  end

      instance_variable_set(:"@#{enum_name}", enum_vals)
    end

    Utils.add_method_if_not_defined(klass, "#{value}!") do
      public_send(:"#{value}=", true)
    end
  end
end

#add_enum_setter_if_not_defined(klass, enum_name, _values, collection) ⇒ Object

Add enum setter method to model class

Parameters:

  • klass (Class) —

    The model class

  • enum_name (Symbol) —

    The enum attribute name

  • _values (Array) —

    The valid enum values (unused)

  • collection (Boolean) —

    Whether the enum is a collection



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/lutaml/model/serialize/enum_handling.rb', line 97

def add_enum_setter_if_not_defined(klass, enum_name, _values,
                                   collection)
  Utils.add_method_if_not_defined(klass, "#{enum_name}=") do |value|
    value = [] if value.nil?
    value = [value] if !value.is_a?(Array)

    value_set_for(enum_name)

    if collection
      curr_value = public_send(:"#{enum_name}")

      instance_variable_set(:"@#{enum_name}", curr_value + value)
    else
      instance_variable_set(:"@#{enum_name}", value)
    end
  end
end

#enums ⇒ Hash

Get all enum attributes for this model

Returns:

  • (Hash) —

    Hash of enum attribute names to attributes



118
119
120
 
# File 'lib/lutaml/model/serialize/enum_handling.rb', line 118

def enums
  attributes.select { |_, attr| attr.enum? }
end