Class: ApiTester::Field

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

Overview

Base class for field definitions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, required: false, has_key: true, default: 'string') ⇒ Field

Returns a new instance of Field.



8
9
10
11
12
13
14
 
# File 'lib/api-tester/definition/fields/field.rb', line 8

def initialize(name:, required: false, has_key: true, default: 'string')
  self.name = name
  self.default = default
  self.required = required
  self.is_seen = 0
  self.has_key = has_key
end

Instance Attribute Details

#default ⇒ Object

Returns the value of attribute default.



6
7
8
 
# File 'lib/api-tester/definition/fields/field.rb', line 6

def default
  @default
end

#has_key ⇒ Object

Returns the value of attribute has_key.



6
7
8
 
# File 'lib/api-tester/definition/fields/field.rb', line 6

def has_key
  @has_key
end

#is_seen ⇒ Object

Returns the value of attribute is_seen.



6
7
8
 
# File 'lib/api-tester/definition/fields/field.rb', line 6

def is_seen
  @is_seen
end

#name ⇒ Object

Returns the value of attribute name.



6
7
8
 
# File 'lib/api-tester/definition/fields/field.rb', line 6

def name
  @name
end

#required ⇒ Object

Returns the value of attribute required.



6
7
8
 
# File 'lib/api-tester/definition/fields/field.rb', line 6

def required
  @required
end

Instance Method Details

#display_class ⇒ Object 



52
53
54
 
# File 'lib/api-tester/definition/fields/field.rb', line 52

def display_class
  self.class
end

#fields ⇒ Object 



34
35
36
 
# File 'lib/api-tester/definition/fields/field.rb', line 34

def fields
  []
end

#good_cases ⇒ Object 



44
45
46
 
# File 'lib/api-tester/definition/fields/field.rb', line 44

def good_cases
  []
end

#is_not_required ⇒ Object 



25
26
27
28
 
# File 'lib/api-tester/definition/fields/field.rb', line 25

def is_not_required
  self.required = false
  self
end

#is_required ⇒ Object 



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

def is_required
  self.required = true
  self
end

#negative_boundary_values ⇒ Object 



38
39
40
41
42
 
# File 'lib/api-tester/definition/fields/field.rb', line 38

def negative_boundary_values
  cases = []
  cases << nil if required
  cases
end

#seen ⇒ Object 



48
49
50
 
# File 'lib/api-tester/definition/fields/field.rb', line 48

def seen
  self.is_seen += 1
end

#subfields? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/api-tester/definition/fields/field.rb', line 30

def subfields?
  false
end

#type ⇒ Object 



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

def type
  'field'
end