Class: Grape::Validations::Base

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Creates a new Validator from options specified by a requires or optional directive during parameter definition.

Parameters:

  • attrs (Array) —

    names of attributes to which the Validator applies

  • options (Object) —

    implementation-dependent Validator options

  • required (Boolean) —

    attribute(s) are required or optional

  • scope (ParamsScope) —

    parent scope for this Validator



13
14
15
16
17
18
 
# File 'lib/grape/validations/validators/base.rb', line 13

def initialize(attrs, options, required, scope)
  @attrs = Array(attrs)
  @option = options
  @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 message(default_key = nil)
  options = instance_variable_get(:@option)
  options_key?(:message) ? options[:message] : default_key
end

#options_key?(key, options = nil) ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
67
 
# File 'lib/grape/validations/validators/base.rb', line 64

def options_key?(key, options = nil)
  options = instance_variable_get(:@option) if options.nil?
  options.respond_to?(:key?) && options.key?(key) && !options[key].nil?
end

#validate(request) ⇒ void

Note:

This method must be thread-safe.

Note:

Override #validate! unless you need to access the entire request.

This method returns an undefined value.

Validates a given request.

Parameters:

Raises:



26
27
28
 
# File 'lib/grape/validations/validators/base.rb', line 26

def validate(request)
  validate!(request.params)
end

#validate!(params) ⇒ void

Note:

This method must be thread-safe.

Note:

Override #validate iff you need to access the entire request.

This method returns an undefined value.

Validates a given parameter hash.

Parameters:

  • params (Hash) —

    parameters to validate

Raises:



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