Class: Grape::Validations::Validators::LengthValidator

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

Instance Attribute Summary

Attributes inherited from Base

#attrs

Instance Method Summary collapse

Methods inherited from Base

#fail_fast?, inherited, #message, #options_key?, #validate, #validate!

Constructor Details

#initialize(attrs, options, required, scope, **opts) ⇒ LengthValidator

Returns a new instance of LengthValidator.

Raises:

  • (ArgumentError) 


7
8
9
10
11
12
13
14
15
16
 
# File 'lib/grape/validations/validators/length_validator.rb', line 7

def initialize(attrs, options, required, scope, **opts)
  @min = options[:min]
  @max = options[:max]

  super

  raise ArgumentError, 'min must be an integer greater than or equal to zero' if !@min.nil? && (!@min.is_a?(Integer) || @min.negative?)
  raise ArgumentError, 'max must be an integer greater than or equal to zero' if !@max.nil? && (!@max.is_a?(Integer) || @max.negative?)
  raise ArgumentError, "min #{@min} cannot be greater than max #{@max}" if !@min.nil? && !@max.nil? && @min > @max
end

Instance Method Details

#build_message ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/grape/validations/validators/length_validator.rb', line 28

def build_message
  if options_key?(:message)
    @option[:message]
  elsif @min && @max
    format I18n.t(:length, scope: 'grape.errors.messages'), min: @min, max: @max
  elsif @min
    format I18n.t(:length_min, scope: 'grape.errors.messages'), min: @min
  else
    format I18n.t(:length_max, scope: 'grape.errors.messages'), max: @max
  end
end

#validate_param!(attr_name, params) ⇒ Object

Raises:

  • (ArgumentError) 


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

def validate_param!(attr_name, params)
  param = params[attr_name]

  raise ArgumentError, "parameter #{param} does not support #length" unless param.respond_to?(:length)

  return unless (!@min.nil? && param.length < @min) || (!@max.nil? && param.length > @max)

  raise Grape::Exceptions::Validation.new(params: [@scope.full_name(attr_name)], message: build_message)
end