Class: Grape::Validations::Validators::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, opts) ⇒ 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

  • opts (Hash) —

    additional validation options



17
18
19
20
21
22
23
24
 
# File 'lib/grape/validations/validators/base.rb', line 17

def initialize(attrs, options, required, scope, opts)
  @attrs = Array(attrs)
  @option = options
  @required = required
  @scope = scope
  @fail_fast = opts[:fail_fast]
  @allow_blank = opts[:allow_blank]
end

Instance Attribute Details

#attrs ⇒ Object (readonly)

Returns the value of attribute attrs.



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

def attrs
  @attrs
end

Class Method Details

.inherited(klass) ⇒ Object 



60
61
62
63
64
65
66
 
# File 'lib/grape/validations/validators/base.rb', line 60

def self.inherited(klass)
  super
  return if klass.name.blank?

  short_validator_name = klass.name.demodulize.underscore.delete_suffix('_validator')
  Validations.register_validator(short_validator_name, klass)
end

Instance Method Details

#fail_fast? ⇒ Boolean

Returns:

  • (Boolean) 


78
79
80
 
# File 'lib/grape/validations/validators/base.rb', line 78

def fail_fast?
  @fail_fast
end

#message(default_key = nil) ⇒ Object 



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

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) 


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

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:

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

This method returns an undefined value.

Validates a given request.

Parameters:

Raises:



31
32
33
34
35
 
# File 'lib/grape/validations/validators/base.rb', line 31

def validate(request)
  return unless @scope.should_validate?(request.params)

  validate!(request.params)
end

#validate!(params) ⇒ void

Note:

Override #validate if 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:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/grape/validations/validators/base.rb', line 42

def validate!(params)
  attributes = SingleAttributeIterator.new(self, @scope, params)
  # we collect errors inside array because
  # there may be more than one error per field
  array_errors = []

  attributes.each do |val, attr_name, empty_val|
    next if !@scope.required? && empty_val
    next unless @scope.meets_dependency?(val, params)

    validate_param!(attr_name, val) if @required || (val.respond_to?(:key?) && val.key?(attr_name))
  rescue Grape::Exceptions::Validation => e
    array_errors << e
  end

  raise Grape::Exceptions::ValidationArrayErrors.new(array_errors) if array_errors.any?
end