Class: Raddocs::ResponseFields

Inherits:
Object
  • Object
show all
Defined in:
lib/raddocs/models.rb

Overview

An example’s response fields, requires a class because the table can display unknown columns

Constant Summary collapse

SPECIAL_KEYS = 
["name", "description", "scope"]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(response_fields) ⇒ ResponseFields

Returns a new instance of ResponseFields.



157
158
159
160
161
 
# File 'lib/raddocs/models.rb', line 157

def initialize(response_fields)
  return unless response_fields # Might not be present
  @fields = response_fields.map { |field| ResponseField.new(field) }
  @extra_keys = response_fields.flat_map(&:keys).uniq - SPECIAL_KEYS
end

Instance Attribute Details

#extra_keys ⇒ Object (readonly)

Returns the value of attribute extra_keys.



153
154
155
 
# File 'lib/raddocs/models.rb', line 153

def extra_keys
  @extra_keys
end

#fields ⇒ Object (readonly)

Returns the value of attribute fields.



153
154
155
 
# File 'lib/raddocs/models.rb', line 153

def fields
  @fields
end

Instance Method Details

#present? ⇒ Boolean

Returns true if fields contains elements.

Returns:

  • (Boolean) —

    true if fields contains elements



164
165
166
 
# File 'lib/raddocs/models.rb', line 164

def present?
  @fields.count > 0
end