Class: Lutaml::Model::Attribute

Inherits:
Object
  • Object
show all
Defined in:
lib/lutaml/model/attribute.rb

Constant Summary collapse

ALLOWED_OPTIONS = 
i[
  raw
  default
  delegate
  collection
  values
  pattern
  transform
  choice
  sequence
  method_name
  polymorphic
  polymorphic_class
  initialize_empty
].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, type, options = {}) ⇒ Attribute

Returns a new instance of Attribute.



22
23
24
25
26
27
28
29
 
# File 'lib/lutaml/model/attribute.rb', line 22

def initialize(name, type, options = {})
  @name = name
  @options = options

  validate_presence!(type, options[:method_name])
  process_type!(type) if type
  process_options!
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name.



4
5
6
 
# File 'lib/lutaml/model/attribute.rb', line 4

def name
  @name
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



4
5
6
 
# File 'lib/lutaml/model/attribute.rb', line 4

def options
  @options
end

#type ⇒ Object (readonly)

Returns the value of attribute type.



4
5
6
 
# File 'lib/lutaml/model/attribute.rb', line 4

def type
  @type
end

Instance Method Details

#cast(value, format, options = {}) ⇒ Object 



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/lutaml/model/attribute.rb', line 276

def cast(value, format, options = {})
  value ||= [] if collection? && !value.nil?
  return value.map { |v| cast(v, format, options) } if value.is_a?(Array)

  return value if already_serialized?(type, value)

  klass = resolve_polymorphic_class(type, value, options)

  if can_serialize?(klass, value, format)
    klass.apply_mappings(value, format, options)
  elsif needs_conversion?(klass, value)
    klass.send(:"from_#{format}", value)
  else
    klass.cast(value)
  end
end

#cast_type!(type) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/lutaml/model/attribute.rb', line 55

def cast_type!(type)
  case type
  when Symbol
    begin
      Type.lookup(type)
    rescue UnknownTypeError
      raise ArgumentError, "Unknown Lutaml::Model::Type: #{type}"
    end
  when String
    begin
      Type.const_get(type)
    rescue NameError
      raise ArgumentError, "Unknown Lutaml::Model::Type: #{type}"
    end
  when Class
    type
  else
    raise ArgumentError, "Unknown Lutaml::Model::Type: #{type}"
  end
end

#cast_value(value) ⇒ Object 



76
77
78
79
80
 
# File 'lib/lutaml/model/attribute.rb', line 76

def cast_value(value)
  return type.cast(value) unless value.is_a?(Array)

  value.map { |v| type.cast(v) }
end

#collection? ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
 
# File 'lib/lutaml/model/attribute.rb', line 86

def collection?
  options[:collection] || false
end

#deep_dup ⇒ Object 



297
298
299
 
# File 'lib/lutaml/model/attribute.rb', line 297

def deep_dup
  self.class.new(name, type, Utils.deep_dup(options))
end

#default ⇒ Object 



102
103
104
 
# File 'lib/lutaml/model/attribute.rb', line 102

def default
  cast_value(default_value)
end

#default_set? ⇒ Boolean

Returns:

  • (Boolean) 


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

def default_set?
  !Utils.uninitialized?(default_value)
end

#default_value ⇒ Object 



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

def default_value
  if delegate
    type.attributes[to].default
  elsif options[:default].is_a?(Proc)
    options[:default].call
  elsif options.key?(:default)
    options[:default]
  else
    Lutaml::Model::UninitializedClass.instance
  end
end

#delegate ⇒ Object 



39
40
41
 
# File 'lib/lutaml/model/attribute.rb', line 39

def delegate
  @options[:delegate]
end

#derived? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/lutaml/model/attribute.rb', line 35

def derived?
  type.nil?
end

#enum? ⇒ Boolean

Returns:

  • (Boolean) 


98
99
100
 
# File 'lib/lutaml/model/attribute.rb', line 98

def enum?
  !enum_values.empty?
end

#enum_values ⇒ Object 



126
127
128
 
# File 'lib/lutaml/model/attribute.rb', line 126

def enum_values
  @options.key?(:values) ? @options[:values] : []
end

#initialize_empty? ⇒ Boolean

Returns:

  • (Boolean) 


51
52
53
 
# File 'lib/lutaml/model/attribute.rb', line 51

def initialize_empty?
  @options[:initialize_empty]
end

#method_name ⇒ Object 



47
48
49
 
# File 'lib/lutaml/model/attribute.rb', line 47

def method_name
  @options[:method_name]
end

#pattern ⇒ Object 



122
123
124
 
# File 'lib/lutaml/model/attribute.rb', line 122

def pattern
  options[:pattern]
end

#polymorphic? ⇒ Boolean

Returns:

  • (Boolean) 


31
32
33
 
# File 'lib/lutaml/model/attribute.rb', line 31

def polymorphic?
  @options[:polymorphic_class]
end

#raw? ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/lutaml/model/attribute.rb', line 94

def raw?
  @raw
end

#serializable? ⇒ Boolean

Returns:

  • (Boolean) 


293
294
295
 
# File 'lib/lutaml/model/attribute.rb', line 293

def serializable?
  type <= Serialize
end

#serialize(value, format, options = {}) ⇒ Object 



266
267
268
269
270
271
272
273
274
 
# File 'lib/lutaml/model/attribute.rb', line 266

def serialize(value, format, options = {})
  value ||= [] if collection? && initialize_empty?
  return value if value.nil? || Utils.uninitialized?(value)
  return value if derived?
  return serialize_array(value, format, options) if value.is_a?(Array)
  return serialize_model(value, format, options) if type <= Serialize

  serialize_value(value, format)
end

#setter ⇒ Object 



82
83
84
 
# File 'lib/lutaml/model/attribute.rb', line 82

def setter
  :"#{@name}="
end

#singular? ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
 
# File 'lib/lutaml/model/attribute.rb', line 90

def singular?
  !collection?
end

#transform ⇒ Object 



43
44
45
 
# File 'lib/lutaml/model/attribute.rb', line 43

def transform
  @options[:transform] || {}
end

#transform_export_method ⇒ Object 



134
135
136
 
# File 'lib/lutaml/model/attribute.rb', line 134

def transform_export_method
  transform[:export]
end

#transform_import_method ⇒ Object 



130
131
132
 
# File 'lib/lutaml/model/attribute.rb', line 130

def transform_import_method
  transform[:import]
end

#valid_collection!(value, caller) ⇒ Object

Raises:



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/lutaml/model/attribute.rb', line 230

def valid_collection!(value, caller)
  raise Lutaml::Model::CollectionTrueMissingError.new(name, caller) if value.is_a?(Array) && !collection?

  return true unless collection?

  # Allow any value for unbounded collections
  return true if options[:collection] == true

  unless value.is_a?(Array)
    raise Lutaml::Model::CollectionCountOutOfRangeError.new(
      name,
      value,
      options[:collection],
    )
  end

  range = options[:collection]
  return true unless range.is_a?(Range)

  if range.end.nil?
    if value.size < range.begin
      raise Lutaml::Model::CollectionCountOutOfRangeError.new(
        name,
        value,
        range,
      )
    end
  elsif !range.cover?(value.size)
    raise Lutaml::Model::CollectionCountOutOfRangeError.new(
      name,
      value,
      range,
    )
  end
end

#valid_pattern!(value) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/lutaml/model/attribute.rb', line 156

def valid_pattern!(value)
  return true unless type == Lutaml::Model::Type::String
  return true unless pattern

  unless pattern.match?(value)
    raise Lutaml::Model::PatternNotMatchedError.new(name, pattern, value)
  end

  true
end

#valid_value!(value) ⇒ Object 



138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/lutaml/model/attribute.rb', line 138

def valid_value!(value)
  return true if value.nil? && singular?
  return true unless enum?
  return true if Utils.uninitialized?(value)

  unless valid_value?(value)
    raise Lutaml::Model::InvalidValueError.new(name, value, enum_values)
  end

  true
end

#valid_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
153
154
 
# File 'lib/lutaml/model/attribute.rb', line 150

def valid_value?(value)
  return true unless options[:values]

  options[:values].include?(value)
end

#validate_collection_range ⇒ Object 



200
201
202
203
204
205
206
207
208
209
 
# File 'lib/lutaml/model/attribute.rb', line 200

def validate_collection_range
  range = @options[:collection]
  return if range == true

  unless range.is_a?(Range)
    raise ArgumentError, "Invalid collection range: #{range}"
  end

  validate_range!(range)
end

#validate_polymorphic(value) ⇒ Object 



187
188
189
190
191
192
 
# File 'lib/lutaml/model/attribute.rb', line 187

def validate_polymorphic(value)
  return value.all? { |v| validate_polymorphic!(v) } if value.is_a?(Array)
  return true unless options[:polymorphic]

  valid_polymorphic_type?(value)
end

#validate_polymorphic!(value) ⇒ Object

Raises:



194
195
196
197
198
 
# File 'lib/lutaml/model/attribute.rb', line 194

def validate_polymorphic!(value)
  return true if validate_polymorphic(value)

  raise Lutaml::Model::PolymorphicError.new(value, options, type)
end

#validate_range!(range) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/lutaml/model/attribute.rb', line 211

def validate_range!(range)
  if range.begin.nil?
    raise ArgumentError,
          "Invalid collection range: #{range}. Begin must be specified."
  end

  if range.begin.negative?
    raise ArgumentError,
          "Invalid collection range: #{range}. " \
          "Begin must be non-negative."
  end

  if range.end && range.end < range.begin
    raise ArgumentError,
          "Invalid collection range: #{range}. " \
          "End must be greater than or equal to begin."
  end
end

#validate_value!(value) ⇒ Object

Check if the value to be assigned is valid for the attribute

Currently there are 2 validations

1. Value should be from the values list if they are defined
   e.g values: ["foo", "bar"] is set then any other value for this
       attribute will raise `Lutaml::Model::InvalidValueError`

2. Value count should be between the collection range if defined
   e.g if collection: 0..5 is set then the value greater then 5
       will raise `Lutaml::Model::CollectionCountOutOfRangeError`



177
178
179
180
181
182
183
184
185
 
# File 'lib/lutaml/model/attribute.rb', line 177

def validate_value!(value)
  # Use the default value if the value is nil
  value = default if value.nil?

  valid_value!(value) &&
    valid_collection!(value, self) &&
    valid_pattern!(value) &&
    validate_polymorphic!(value)
end