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.



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

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.



7
8
9
 
# File 'lib/grape/validations.rb', line 7

def attrs
  @attrs
end

Class Method Details

.convert_to_short_name(klass) ⇒ Object 



46
47
48
49
50
51
52
53
 
# File 'lib/grape/validations.rb', line 46

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 



68
69
70
71
 
# File 'lib/grape/validations.rb', line 68

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

Instance Method Details

#validate!(params) ⇒ Object 



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

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