Class: Apipie::ParamDescription
- Inherits:
-
Object
- Object
- Apipie::ParamDescription
- Defined in:
- lib/apipie/param_description.rb
Overview
method parameter description
name - method name (show) desc - description required - boolean if required validator - Validator::BaseValidator subclass
Instance Attribute Summary collapse
-
#allow_nil ⇒ Object
readonly
Returns the value of attribute allow_nil.
-
#desc ⇒ Object
readonly
Returns the value of attribute desc.
-
#method_description ⇒ Object
readonly
Returns the value of attribute method_description.
-
#name ⇒ Object
readonly
Returns the value of attribute name.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
-
#parent ⇒ Object
Returns the value of attribute parent.
-
#required ⇒ Object
Returns the value of attribute required.
-
#validator ⇒ Object
readonly
Returns the value of attribute validator.
Class Method Summary collapse
- .from_dsl_data(method_description, args) ⇒ Object
-
.unify(params) ⇒ Object
merge param descripsiont.
Instance Method Summary collapse
-
#action_aware? ⇒ Boolean
action awareness is being inherited from ancestors (in terms of nested params).
-
#action_awareness ⇒ Object
makes modification that are based on the action that the param is defined for.
- #as_action ⇒ Object
- #concern_subst(string) ⇒ Object
- #full_name ⇒ Object
-
#initialize(method_description, name, validator, desc_or_options = nil, options = {}, &block) ⇒ ParamDescription
constructor
A new instance of ParamDescription.
- #merge_with(other_param_desc) ⇒ Object
-
#parents_and_self ⇒ Object
returns an array of all the parents: starting with the root parent ending with itself.
- #to_json ⇒ Object
- #validate(value) ⇒ Object
Constructor Details
#initialize(method_description, name, validator, desc_or_options = nil, options = {}, &block) ⇒ ParamDescription
Returns a new instance of ParamDescription.
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/apipie/param_description.rb', line 25 def initialize(method_description, name, validator, = nil, = {}, &block) if .is_a?(Hash) = .merge() elsif .is_a?(String) [:desc] = elsif !.nil? raise ArgumentError.new("param description: expected description or options as 3rd parameter") end .symbolize_keys! # we save options to know what was passed in DSL @options = @method_description = method_description @name = concern_subst(name) @desc = concern_subst(Apipie.markup_to_html(@options[:desc] || '')) @parent = @options[:parent] @required = if @options.has_key? :required @options[:required] else Apipie.configuration.required_by_default? end @allow_nil = @options[:allow_nil] || false action_awareness if validator @validator = Validator::BaseValidator.find(self, validator, @options, block) raise "Validator for #{validator} not found." unless @validator end end |
Instance Attribute Details
#allow_nil ⇒ Object (readonly)
Returns the value of attribute allow_nil.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def allow_nil @allow_nil end |
#desc ⇒ Object (readonly)
Returns the value of attribute desc.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def desc @desc end |
#method_description ⇒ Object (readonly)
Returns the value of attribute method_description.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def method_description @method_description end |
#name ⇒ Object (readonly)
Returns the value of attribute name.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def name @name end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def @options end |
#parent ⇒ Object
Returns the value of attribute parent.
13 14 15 |
# File 'lib/apipie/param_description.rb', line 13 def parent @parent end |
#required ⇒ Object
Returns the value of attribute required.
13 14 15 |
# File 'lib/apipie/param_description.rb', line 13 def required @required end |
#validator ⇒ Object (readonly)
Returns the value of attribute validator.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def validator @validator end |
Class Method Details
.from_dsl_data(method_description, args) ⇒ Object
15 16 17 18 19 20 21 22 23 |
# File 'lib/apipie/param_description.rb', line 15 def self.from_dsl_data(method_description, args) param_name, validator, , , block = args Apipie::ParamDescription.new(method_description, param_name, validator, , , &block) end |
.unify(params) ⇒ Object
merge param descripsiont. Allows defining hash params on more places (e.g. in param_groups). For example:
def_param_group :user do
param :user, Hash do
param :name, String
end
end
param_group :user
param :user, Hash do
param :password, String
end
132 133 134 135 136 137 |
# File 'lib/apipie/param_description.rb', line 132 def self.unify(params) ordering = params.map(&:name) params.group_by(&:name).map do |name, param_descs| param_descs.reduce(&:merge_with) end.sort_by { |param| ordering.index(param.name) } end |
Instance Method Details
#action_aware? ⇒ Boolean
action awareness is being inherited from ancestors (in terms of nested params)
141 142 143 144 145 146 147 148 149 |
# File 'lib/apipie/param_description.rb', line 141 def action_aware? if @options.has_key?(:action_aware) return @options[:action_aware] elsif @parent @parent.action_aware? else false end end |
#action_awareness ⇒ Object
makes modification that are based on the action that the param is defined for. Typical for required and allow_nil variations in crate/update actions.
165 166 167 168 169 170 171 172 173 174 175 176 177 178 |
# File 'lib/apipie/param_description.rb', line 165 def action_awareness if action_aware? if !@options.has_key?(:allow_nil) if @required @allow_nil = false else @allow_nil = true end end if as_action != "create" @required = false end end end |
#as_action ⇒ Object
151 152 153 154 155 156 157 158 159 160 |
# File 'lib/apipie/param_description.rb', line 151 def as_action if @options[:param_group] && @options[:param_group][:options] && @options[:param_group][:options][:as] @options[:param_group][:options][:as].to_s elsif @parent @parent.as_action else @method_description.method end end |
#concern_subst(string) ⇒ Object
180 181 182 183 184 185 186 187 188 189 190 191 |
# File 'lib/apipie/param_description.rb', line 180 def concern_subst(string) return string if string.nil? or !method_description.from_concern? original = string string = ":#{original}" if original.is_a? Symbol replaced = method_description.resource.controller._apipie_perform_concern_subst(string) return original if replaced == string return replaced.to_sym if original.is_a? Symbol return replaced end |
#full_name ⇒ Object
69 70 71 72 |
# File 'lib/apipie/param_description.rb', line 69 def full_name name_parts = parents_and_self.map(&:name) return ([name_parts.first] + name_parts[1..-1].map { |n| "[#{n}]" }).join("") end |
#merge_with(other_param_desc) ⇒ Object
110 111 112 113 114 115 116 117 |
# File 'lib/apipie/param_description.rb', line 110 def merge_with(other_param_desc) if self.validator && other_param_desc.validator self.validator.merge_with(other_param_desc.validator) else self.validator ||= other_param_desc.validator end self end |
#parents_and_self ⇒ Object
returns an array of all the parents: starting with the root parent ending with itself
76 77 78 79 80 81 82 83 |
# File 'lib/apipie/param_description.rb', line 76 def parents_and_self ret = [] if self.parent ret.concat(self.parent.parents_and_self) end ret << self ret end |
#to_json ⇒ Object
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/apipie/param_description.rb', line 85 def to_json if validator.is_a? Apipie::Validator::HashValidator { :name => name.to_s, :full_name => full_name, :description => desc, :required => required, :allow_nil => allow_nil, :validator => validator.to_s, :expected_type => validator.expected_type, :params => validator.hash_params_ordered.map(&:to_json) } else { :name => name.to_s, :full_name => full_name, :description => desc, :required => required, :allow_nil => allow_nil, :validator => validator.to_s, :expected_type => validator.expected_type } end end |
#validate(value) ⇒ Object
60 61 62 63 64 65 66 67 |
# File 'lib/apipie/param_description.rb', line 60 def validate(value) return true if @allow_nil && value.nil? unless @validator.valid?(value) error = @validator.error error = ParamError.new(error) unless error.is_a? StandardError raise error end end |