Class: ApiTester::ObjectField

Inherits:
Field
  • Object
show all
Defined in:
lib/api-tester/definition/fields/object_field.rb

Overview

Class for defining objects in a contract

Instance Attribute Summary collapse

Attributes inherited from Field

#is_seen, #name, #required

Instance Method Summary collapse

Methods inherited from Field

#display_class, #is_not_required, #is_required, #seen

Constructor Details

#initialize(name:, required: false) ⇒ ObjectField

Returns a new instance of ObjectField.



10
11
12
13
 
# File 'lib/api-tester/definition/fields/object_field.rb', line 10

def initialize(name:, required: false)
  super name: name, required: required
  self.fields = []
end

Instance Attribute Details

#fields ⇒ Object

Returns the value of attribute fields.



8
9
10
 
# File 'lib/api-tester/definition/fields/object_field.rb', line 8

def fields
  @fields
end

Instance Method Details

#default_value ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/api-tester/definition/fields/object_field.rb', line 24

def default_value
  obj = {}

  fields.each do |field|
    obj[field.name] = field.default_value
  end

  obj
end

#negative_boundary_values ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/api-tester/definition/fields/object_field.rb', line 34

def negative_boundary_values
  super +
    [
      'string',
      [],
      123,
      1,
      0,
      true,
      false
    ]
end

#subfields? ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/api-tester/definition/fields/object_field.rb', line 20

def subfields?
  true
end

#with_field(new_field) ⇒ Object 



15
16
17
18
 
# File 'lib/api-tester/definition/fields/object_field.rb', line 15

def with_field(new_field)
  fields << new_field
  self
end