Class: Grape::Validations::Base
- Inherits:
-
Object
- Object
- Grape::Validations::Base
- Defined in:
- lib/grape/validations/validators/base.rb
Direct Known Subclasses
AllowBlankValidator, CoerceValidator, DefaultValidator, MultipleParamsBase, PresenceValidator, RegexpValidator, ValuesValidator
Instance Attribute Summary collapse
-
#attrs ⇒ Object
readonly
Returns the value of attribute attrs.
Class Method Summary collapse
Instance Method Summary collapse
-
#initialize(attrs, options, required, scope) ⇒ Base
constructor
Creates a new Validator from options specified by a
requires
oroptional
directive during parameter definition. - #message(default_key = nil) ⇒ Object
- #options_key?(key, options = nil) ⇒ Boolean
-
#validate(request) ⇒ void
Validates a given request.
-
#validate!(params) ⇒ void
Validates a given parameter hash.
Constructor Details
#initialize(attrs, options, required, scope) ⇒ Base
Creates a new Validator from options specified by a requires
or optional
directive during parameter definition.
13 14 15 16 17 18 |
# File 'lib/grape/validations/validators/base.rb', line 13 def initialize(attrs, , required, scope) @attrs = Array(attrs) @option = @required = required @scope = scope end |
Instance Attribute Details
#attrs ⇒ Object (readonly)
Returns the value of attribute attrs.
4 5 6 |
# File 'lib/grape/validations/validators/base.rb', line 4 def attrs @attrs end |
Class Method Details
.convert_to_short_name(klass) ⇒ Object
45 46 47 48 49 50 51 52 |
# File 'lib/grape/validations/validators/base.rb', line 45 def self.convert_to_short_name(klass) ret = klass.name.gsub(/::/, '/') .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2') .gsub(/([a-z\d])([A-Z])/, '\1_\2') .tr('-', '_') .downcase File.basename(ret, '_validator') end |
.inherited(klass) ⇒ Object
54 55 56 57 |
# File 'lib/grape/validations/validators/base.rb', line 54 def self.inherited(klass) short_name = convert_to_short_name(klass) Validations.register_validator(short_name, klass) end |
Instance Method Details
#message(default_key = nil) ⇒ Object
59 60 61 62 |
# File 'lib/grape/validations/validators/base.rb', line 59 def (default_key = nil) = instance_variable_get(:@option) (:message) ? [:message] : default_key end |
#options_key?(key, options = nil) ⇒ Boolean
64 65 66 67 |
# File 'lib/grape/validations/validators/base.rb', line 64 def (key, = nil) = instance_variable_get(:@option) if .nil? .respond_to?(:key?) && .key?(key) && ![key].nil? end |
#validate(request) ⇒ void
This method must be thread-safe.
Override #validate! unless you need to access the entire request.
This method returns an undefined value.
Validates a given request.
26 27 28 |
# File 'lib/grape/validations/validators/base.rb', line 26 def validate(request) validate!(request.params) end |
#validate!(params) ⇒ void
This method must be thread-safe.
Override #validate iff you need to access the entire request.
This method returns an undefined value.
Validates a given parameter hash.
36 37 38 39 40 41 42 43 |
# File 'lib/grape/validations/validators/base.rb', line 36 def validate!(params) attributes = AttributesIterator.new(self, @scope, params) attributes.each do |resource_params, attr_name| if @required || (resource_params.respond_to?(:key?) && resource_params.key?(attr_name)) validate_param!(attr_name, resource_params) end end end |