Module: Validate::ValidationMethods

Defined in:
lib/validate/validations.rb

Overview

Every validation method has four arguments:

obj:        the `to_hash` of the object to validate
field:      the field to validate
opts:       the options for the validation
validator:  a Validator object that can be used for children

Class Method Summary collapse

Class Method Details

.validates(obj, field, opts, validator) ⇒ Object

Validate a field by executing a block in the context of the field.

‘self` in the block is bound to the field’s value, or ‘nil`.

validates :type, with: -> { is_a?(String) && self =~ /^a/ }



19
20
21
 
# File 'lib/validate/validations.rb', line 19

def self.validates(obj, field, opts, validator)
  true == obj[field].instance_exec(&opts[:with])
end

.validates_array(obj, field, opts, validator) ⇒ Object

Validates each element in an Array with a set of validations.

Note: the children validations should look at the field ‘:self` to contain the value to be validated. ie. it validates element

# ensures :elements is an array of strings
validates_array :elements do
  validates_type_of :self, is: String
end



88
89
90
91
92
93
94
 
# File 'lib/validate/validations.rb', line 88

def self.validates_array(obj, field, opts, validator)
  return false unless obj[field].respond_to?(:to_a)
  array = obj[field].to_a
  array.map do |e|
    validator.validates?({self: e})
  end.reduce {|a,b| a && b }
end

.validates_child_hash(obj, field, opts, validator) ⇒ Object

Validates a Hash field with its own set of validations.

validates_child_hash :hash do
  validates_value_of :type, is: 'price'
  validates_numericality_of :amount
end



72
73
74
75
76
 
# File 'lib/validate/validations.rb', line 72

def self.validates_child_hash(obj, field, opts, validator)
  return false unless obj[field].respond_to?(:to_hash)
  hash = obj[field].to_hash
  validator.validates?(hash)
end

.validates_inclusion_of(obj, field, opts, validator) ⇒ Object

Validates that the value of the field appears in an array.

validates_inclusion_of :type, in: %w(paid free)



45
46
47
 
# File 'lib/validate/validations.rb', line 45

def self.validates_inclusion_of(obj, field, opts, validator)
  opts[:in].include?(obj[field])
end

.validates_numericality_of(obj, field, opts, validator) ⇒ Object

Validates that a field’s value is numeric.

validates_numericality_of :amount



53
54
55
 
# File 'lib/validate/validations.rb', line 53

def self.validates_numericality_of(obj, field, opts, validator)
  obj[field].is_a?(Numeric)
end

.validates_presence_of(obj, field, opts, validator) ⇒ Object

Validates that a field exists.

‘nil` is acceptable as a value for the field.

validates_presence_of :field



29
30
31
 
# File 'lib/validate/validations.rb', line 29

def self.validates_presence_of(obj, field, opts, validator)
  obj.include?(field)
end

.validates_regex(obj, field, opts, validator) ⇒ Object

Validates a field against a regular expression.

validates_regex :field, matches: /^hello/



100
101
102
103
 
# File 'lib/validate/validations.rb', line 100

def self.validates_regex(obj, field, opts, validator)
  return false unless obj[field].respond_to?(:=~)
  0 == (obj[field] =~ opts[:matches])
end

.validates_type_of(obj, field, opts, validator) ⇒ Object

Validates that a field exists and is an instance of a class or module.

validates_type_of :name, is: String



37
38
39
 
# File 'lib/validate/validations.rb', line 37

def self.validates_type_of(obj, field, opts, validator)
  obj.include?(field) && obj[field].is_a?(opts[:is])
end

.validates_value_of(obj, field, opts, validator) ⇒ Object

Validates the value, ensure equality.

validates_value_of :field, is: 'something'



61
62
63
 
# File 'lib/validate/validations.rb', line 61

def self.validates_value_of(obj, field, opts, validator)
  obj.include?(field) && obj[field] == opts[:is]
end