Class: Raddocs::Parameters
- Inherits:
-
Object
- Object
- Raddocs::Parameters
- Defined in:
- lib/raddocs/models.rb
Overview
An example’s parameters, requires a class because the table can display unknown columns
Constant Summary collapse
- SPECIAL_KEYS =
["name", "description", "required", "scope"]
Instance Attribute Summary collapse
-
#extra_keys ⇒ Object
readonly
Returns the value of attribute extra_keys.
-
#params ⇒ Object
readonly
Returns the value of attribute params.
Instance Method Summary collapse
-
#initialize(params) ⇒ Parameters
constructor
Collection object for parameters to pull out unknown keys so they can be displayed on the example page.
-
#present? ⇒ Boolean
True if params contains elements.
Constructor Details
#initialize(params) ⇒ Parameters
Collection object for parameters to pull out unknown keys so they can be displayed on the example page.
107 108 109 110 |
# File 'lib/raddocs/models.rb', line 107 def initialize(params) @params = params.map { |param| Parameter.new(param) } @extra_keys = params.flat_map(&:keys).uniq - SPECIAL_KEYS end |
Instance Attribute Details
#extra_keys ⇒ Object (readonly)
Returns the value of attribute extra_keys.
91 92 93 |
# File 'lib/raddocs/models.rb', line 91 def extra_keys @extra_keys end |
#params ⇒ Object (readonly)
Returns the value of attribute params.
91 92 93 |
# File 'lib/raddocs/models.rb', line 91 def params @params end |
Instance Method Details
#present? ⇒ Boolean
Returns true if params contains elements.
113 114 115 |
# File 'lib/raddocs/models.rb', line 113 def present? @params.count > 0 end |