Class: Grape::Validations::Validator

Inherits:
Object
  • Object
show all
Defined in:
lib/grape/validations.rb,
lib/grape/validations.rb

Overview

We define Validator::inherited here so SingleOptionValidator will not be considered a validator.

Defined Under Namespace

Classes: AttributesIterator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attrs, options, required, scope) ⇒ Validator

Returns a new instance of Validator.



11
12
13
14
15
16
17
18
19
 
# File 'lib/grape/validations.rb', line 11

def initialize(attrs, options, required, scope)
  @attrs = Array(attrs)
  @required = required
  @scope = scope

  if options.is_a?(Hash) && !options.empty?
    raise Grape::Exceptions.UnknownOptions.new(options.keys)
  end
end

Instance Attribute Details

#attrs ⇒ Object (readonly)

Returns the value of attribute attrs.



9
10
11
 
# File 'lib/grape/validations.rb', line 9

def attrs
  @attrs
end

Class Method Details

.inherited(klass) ⇒ Object 



73
74
75
76
 
# File 'lib/grape/validations.rb', line 73

def self.inherited(klass)
  short_name = convert_to_short_name(klass)
  Validations::register_validator(short_name, klass)
end

Instance Method Details

#validate!(params) ⇒ Object 



21
22
23
24
25
26
27
28
 
# File 'lib/grape/validations.rb', line 21

def validate!(params)
  attributes = AttributesIterator.new(self, @scope, params)
  attributes.each do |resource_params, attr_name|
    if @required || resource_params.has_key?(attr_name)
      validate_param!(attr_name, resource_params)
    end
  end
end