class Grape::Validations::Base

Attributes

attrs[R]

Public Class Methods

convert_to_short_name(klass) click to toggle source
# 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) click to toggle source
# 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
new(attrs, options, required, scope) click to toggle source

Creates a new Validator from options specified by a requires or optional directive during parameter definition. @param attrs [Array] names of attributes to which the Validator applies @param options [Object] implementation-dependent Validator options @param required [Boolean] attribute(s) are required or optional @param scope [ParamsScope] parent scope for this Validator

# 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

Public Instance Methods

message(default_key = nil) click to toggle source
# 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) click to toggle source
# 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) click to toggle source

Validates a given request. @note This method must be thread-safe. @note Override validate! unless you need to access the entire request. @param request [Grape::Request] the request currently being handled @raise [Grape::Exceptions::Validation] if validation failed @return [void]

# File lib/grape/validations/validators/base.rb, line 26
def validate(request)
  validate!(request.params)
end
validate!(params) click to toggle source

Validates a given parameter hash. @note This method must be thread-safe. @note Override validate iff you need to access the entire request. @param params [Hash] parameters to validate @raise [Grape::Exceptions::Validation] if validation failed @return [void]

# 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