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_blank ⇒ Object
readonly
Returns the value of attribute allow_blank.
-
#allow_nil ⇒ Object
readonly
Returns the value of attribute allow_nil.
-
#as ⇒ Object
readonly
Returns the value of attribute as.
-
#desc ⇒ Object
readonly
Returns the value of attribute desc.
-
#metadata ⇒ Object
readonly
Returns the value of attribute metadata.
-
#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.
-
#show ⇒ Object
readonly
Returns the value of attribute show.
-
#validations ⇒ Object
readonly
Returns the value of attribute validations.
-
#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 descriptions.
Instance Method Summary collapse
- #==(other) ⇒ Object
-
#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
- #from_concern? ⇒ Boolean
- #full_name ⇒ Object
-
#initialize(method_description, name, validator, desc_or_options = nil, options = {}, &block) ⇒ ParamDescription
constructor
A new instance of ParamDescription.
- #is_required? ⇒ Boolean
- #merge_with(other_param_desc) ⇒ Object
- #normalized_value(value) ⇒ Object
-
#parents_and_self ⇒ Object
returns an array of all the parents: starting with the root parent ending with itself.
- #preformat_text(text) ⇒ Object
- #process_value(value) ⇒ Object
- #to_json(lang = nil) ⇒ Object
- #to_s ⇒ Object
- #validate(value) ⇒ Object
Constructor Details
#initialize(method_description, name, validator, desc_or_options = nil, options = {}, &block) ⇒ ParamDescription
Returns a new instance of ParamDescription.
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/apipie/param_description.rb', line 37 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 = if @options[:param_group] @from_concern = @options[:param_group][:from_concern] end @method_description = method_description @name = concern_subst(name) @as = [:as] || @name @desc = preformat_text(@options[:desc]) @parent = @options[:parent] @metadata = @options[:meta] @required = is_required? @show = if @options.has_key? :show @options[:show] else true end @allow_nil = @options[:allow_nil] || false @allow_blank = @options[:allow_blank] || false action_awareness if validator @validator = Validator::BaseValidator.find(self, validator, @options, block) raise "Validator for #{validator} not found." unless @validator end @validations = Array([:validations]).map {|v| concern_subst(Apipie.markup_to_html(v)) } end |
Instance Attribute Details
#allow_blank ⇒ Object (readonly)
Returns the value of attribute allow_blank.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def allow_blank @allow_blank end |
#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 |
#as ⇒ Object (readonly)
Returns the value of attribute as.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def as @as 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 |
#metadata ⇒ Object (readonly)
Returns the value of attribute metadata.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def @metadata 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.
12 13 14 |
# File 'lib/apipie/param_description.rb', line 12 def parent @parent end |
#required ⇒ Object
Returns the value of attribute required.
12 13 14 |
# File 'lib/apipie/param_description.rb', line 12 def required @required end |
#show ⇒ Object (readonly)
Returns the value of attribute show.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def show @show end |
#validations ⇒ Object (readonly)
Returns the value of attribute validations.
11 12 13 |
# File 'lib/apipie/param_description.rb', line 11 def validations @validations 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
14 15 16 17 18 19 20 21 22 |
# File 'lib/apipie/param_description.rb', line 14 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 descriptions. 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
175 176 177 178 179 180 |
# File 'lib/apipie/param_description.rb', line 175 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
#==(other) ⇒ Object
28 29 30 31 32 33 34 35 |
# File 'lib/apipie/param_description.rb', line 28 def ==(other) return false unless self.class == other.class if method_description == other.method_description && @options == other. true else false end end |
#action_aware? ⇒ Boolean
action awareness is being inherited from ancestors (in terms of nested params)
184 185 186 187 188 189 190 191 192 |
# File 'lib/apipie/param_description.rb', line 184 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.
208 209 210 211 212 213 214 215 216 217 218 219 220 221 |
# File 'lib/apipie/param_description.rb', line 208 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
194 195 196 197 198 199 200 201 202 203 |
# File 'lib/apipie/param_description.rb', line 194 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
223 224 225 226 227 228 229 230 231 232 233 234 |
# File 'lib/apipie/param_description.rb', line 223 def concern_subst(string) return string if string.nil? or !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 |
#from_concern? ⇒ Boolean
84 85 86 |
# File 'lib/apipie/param_description.rb', line 84 def from_concern? method_description.from_concern? || @from_concern end |
#full_name ⇒ Object
118 119 120 121 122 |
# File 'lib/apipie/param_description.rb', line 118 def full_name name_parts = parents_and_self.map{|p| p.name if p.show}.compact return name.to_s if name_parts.blank? return ([name_parts.first] + name_parts[1..-1].map { |n| "[#{n}]" }).join("") end |
#is_required? ⇒ Boolean
240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/apipie/param_description.rb', line 240 def is_required? if @options.has_key?(:required) if (@options[:required] == true) || (@options[:required] == false) @options[:required] else Array(@options[:required]).include?(@method_description.method.to_sym) end else Apipie.configuration.required_by_default? end end |
#merge_with(other_param_desc) ⇒ Object
153 154 155 156 157 158 159 160 |
# File 'lib/apipie/param_description.rb', line 153 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 |
#normalized_value(value) ⇒ Object
88 89 90 91 92 93 94 95 96 |
# File 'lib/apipie/param_description.rb', line 88 def normalized_value(value) if value.is_a?(ActionController::Parameters) && !value.is_a?(Hash) value.to_unsafe_hash elsif value.is_a? Array value.map { |v| normalized_value (v) } else value end end |
#parents_and_self ⇒ Object
returns an array of all the parents: starting with the root parent ending with itself
126 127 128 129 130 131 132 133 |
# File 'lib/apipie/param_description.rb', line 126 def parents_and_self ret = [] if self.parent ret.concat(self.parent.parents_and_self) end ret << self ret end |
#preformat_text(text) ⇒ Object
236 237 238 |
# File 'lib/apipie/param_description.rb', line 236 def preformat_text(text) concern_subst(Apipie.markup_to_html(text || '')) end |
#process_value(value) ⇒ Object
109 110 111 112 113 114 115 116 |
# File 'lib/apipie/param_description.rb', line 109 def process_value(value) value = normalized_value(value) if @validator.respond_to?(:process_value) @validator.process_value(value) else value end end |
#to_json(lang = nil) ⇒ Object
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/apipie/param_description.rb', line 135 def to_json(lang = nil) hash = { :name => name.to_s, :full_name => full_name, :description => preformat_text(Apipie.app.translate(@options[:desc], lang)), :required => required, :allow_nil => allow_nil, :allow_blank => allow_blank, :validator => validator.to_s, :expected_type => validator.expected_type, :metadata => , :show => show, :validations => validations } if sub_params = validator.params_ordered hash[:params] = sub_params.map { |p| p.to_json(lang)} end hash end |
#to_s ⇒ Object
24 25 26 |
# File 'lib/apipie/param_description.rb', line 24 def to_s "ParamDescription: #{method_description.id}##{name}" end |
#validate(value) ⇒ Object
98 99 100 101 102 103 104 105 106 107 |
# File 'lib/apipie/param_description.rb', line 98 def validate(value) return true if @allow_nil && value.nil? return true if @allow_blank && value.blank? value = normalized_value(value) if (!@allow_nil && value.nil?) || !@validator.valid?(value) error = @validator.error error = ParamError.new(error) unless error.is_a? StandardError raise error end end |