Module: SBOM::CycloneDX::Field

Defined in:
lib/sbom/cyclone_dx/field.rb

Overview

rubocop:disable Metrics/ModuleLength

Defined Under Namespace

Classes: Base, ConstBase, PropBase

Class Method Summary collapse

Class Method Details

.array(field_name:, items:, unique: false, required: false, json_name: nil, const: :undefined, default: :undefined) ⇒ Object

rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity



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
 
# File 'lib/sbom/cyclone_dx/field.rb', line 115

def array(field_name:, items:, unique: false, required: false, json_name: nil, const: :undefined, # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
          default: :undefined)
  validator = Validator::ArrayValidator.new(items: items, unique: unique, required: required)
  Field(
    field_name: field_name,
    type: :array,
    validator: validator,
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    raise TypeError, "Expected Array, got #{value.class}" unless value.is_a?(::Array) || value.nil?
    next value if value.nil?

    value.map do |item|
      next item if validator.raw_types.any? { |type| item.is_a?(type) } || item.nil?

      if item.is_a?(Hash)
        coerced_value = validator.raw_types.filter_map do |type|
          next nil unless type < SBOM::CycloneDX::Record::Base

          begin
            type.new(**item)
          rescue StandardError
            nil
          end
        end

        next coerced_value.first if coerced_value.any?
      end

      raise TypeError, "Expected one of #{items.to_json}, got #{value.class}"
    end
  end
end

.boolean(field_name:, json_name: nil, required: false, const: :undefined, default: :undefined) ⇒ Object

rubocop:disable Metrics/MethodLength



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/sbom/cyclone_dx/field.rb', line 151

def boolean(field_name:, json_name: nil, required: false, const: :undefined, default: :undefined) # rubocop:disable Metrics/MethodLength
  Field(
    field_name: field_name,
    type: :boolean,
    validator: SBOM::CycloneDX::Validator::BooleanValidator.new(required: required),
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    next value if value.is_a?(TrueClass) || value.is_a?(FalseClass) || value.nil?

    raise TypeError, "Expected Boolean, got #{value.class}"
  end
end

.date_time(field_name:, json_name: nil, required: false, const: :undefined, default: :undefined) ⇒ Object

rubocop:disable Metrics/MethodLength



166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/sbom/cyclone_dx/field.rb', line 166

def date_time(field_name:, json_name: nil, required: false, const: :undefined, default: :undefined) # rubocop:disable Metrics/MethodLength
  Field(
    field_name: field_name,
    type: :date_time,
    validator: SBOM::CycloneDX::Validator::DateTimeValidator.new(required: required),
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    next value if value.is_a?(::Time) || value.is_a?(::DateTime) || value.is_a?(::String) || value.nil?

    raise TypeError, "Expected Time, DateTime, or String, got #{value.class}"
  end
end

.email_address(field_name:, json_name: nil, required: false, const: :undefined, default: :undefined) ⇒ Object

rubocop:disable Metrics/MethodLength



181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/sbom/cyclone_dx/field.rb', line 181

def email_address(field_name:, json_name: nil, required: false, const: :undefined, default: :undefined) # rubocop:disable Metrics/MethodLength
  Field(
    field_name: field_name,
    type: :email_address,
    validator: SBOM::CycloneDX::Validator::EmailAddressValidator.new(required: required),
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    next value if value.is_a?(EmailAddress::Address) || value.is_a?(String) || value.nil?

    raise TypeError, "Expected EmailAddress::Address or String, got #{value.class}"
  end
end

.float(field_name:, minimum: nil, maximum: nil, required: false, const: :undefined, default: :undefined, json_name: nil) ⇒ Object

rubocop:disable Metrics/MethodLength



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/sbom/cyclone_dx/field.rb', line 196

def float(field_name:, minimum: nil, maximum: nil, required: false, const: :undefined, default: :undefined, # rubocop:disable Metrics/MethodLength
          json_name: nil)
  Field(
    field_name: field_name,
    type: :float,
    validator: SBOM::CycloneDX::Validator::FloatValidator.new(
      minimum: minimum,
      maximum: maximum,
      required: required
    ),
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    next value if value.is_a?(::Float) || value.nil?

    raise TypeError, "Expected Float, got #{value.class}"
  end
end

.integer(field_name:, minimum: nil, maximum: nil, required: false, const: :undefined, default: :undefined, json_name: nil) ⇒ Object

rubocop:disable Metrics/MethodLength



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/sbom/cyclone_dx/field.rb', line 216

def integer(field_name:, minimum: nil, maximum: nil, required: false, const: :undefined, default: :undefined, # rubocop:disable Metrics/MethodLength
            json_name: nil)
  Field(
    field_name: field_name,
    type: :integer,
    validator: SBOM::CycloneDX::Validator::IntegerValidator.new(
      minimum: minimum,
      maximum: maximum,
      required: required
    ),
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    next value if value.is_a?(::Integer) || value.nil?

    raise TypeError, "Expected Integer, got #{value.class}"
  end
end

.record(field_name:, klass:, json_name: nil, required: false, const: :undefined, default: :undefined) ⇒ Object

rubocop:disable Metrics/MethodLength



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/sbom/cyclone_dx/field.rb', line 236

def record(field_name:, klass:, json_name: nil, required: false, const: :undefined, default: :undefined) # rubocop:disable Metrics/MethodLength
  Field(
    field_name: field_name,
    type: klass,
    validator: SBOM::CycloneDX::Validator::RecordValidator.new(type: klass, required: required),
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    next value if value.is_a?(klass) || value.nil?
    next klass.new(**value) if value.is_a?(::Hash)

    raise TypeError, "Expected #{klass.name}, got #{value.class}"
  end
end

.string(field_name:, enum: nil, max_length: nil, min_length: nil, pattern: Pattern::DEFAULT, required: false, const: :undefined, default: :undefined, json_name: nil) ⇒ Object

rubocop:disable Metrics/MethodLength



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/sbom/cyclone_dx/field.rb', line 252

def string( # rubocop:disable Metrics/MethodLength
  field_name:,
  enum: nil,
  max_length: nil,
  min_length: nil,
  pattern: Pattern::DEFAULT,
  required: false,
  const: :undefined,
  default: :undefined,
  json_name: nil
)
  Field(
    field_name: field_name,
    type: :string,
    validator: SBOM::CycloneDX::Validator::StringValidator.new(
      enum: enum,
      max_length: max_length,
      min_length: min_length,
      pattern: pattern,
      required: required
    ),
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    next value if value.is_a?(::String) || value.nil?

    raise TypeError, "Expected String, got #{value.class}"
  end
end

.union(field_name:, of:, required: false, const: :undefined, default: :undefined, json_name: nil) ⇒ Object

rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/sbom/cyclone_dx/field.rb', line 283

def union(field_name:, of:, required: false, const: :undefined, default: :undefined, json_name: nil) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
  validator = SBOM::CycloneDX::Validator::UnionValidator.new(required: required, of: of)
  Field(
    field_name: field_name,
    type: :union,
    validator: validator,
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    next value if validator.raw_types.any? { |type| value.is_a?(type) } || value.nil?

    if value.is_a?(Hash)
      coerced_value = validator.raw_types.filter_map do |type|
        next nil unless type < SBOM::CycloneDX::Record::Base

        begin
          type.new(**value)
        rescue StandardError
          nil
        end
      end

      next coerced_value.first if coerced_value.any?
    end

    raise TypeError, "Expected one of #{of.map(&:to_s).join(", ")}, got #{value.class}"
  end
end

.uri(field_name:, json_name: nil, required: false, const: :undefined, default: :undefined) ⇒ Object

rubocop:disable Metrics/MethodLength



313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/sbom/cyclone_dx/field.rb', line 313

def uri(field_name:, json_name: nil, required: false, const: :undefined, default: :undefined) # rubocop:disable Metrics/MethodLength
  Field(
    field_name: field_name,
    type: :uri,
    validator: SBOM::CycloneDX::Validator::URIValidator.new(required: required),
    json_name: json_name,
    const: const,
    default: default
  ) do |value|
    next value if value.is_a?(::URI::Generic) || value.is_a?(::String) || value.nil?

    raise TypeError, "Expected URI or String, got #{value.class}"
  end
end