Class: Validatable::ValidationBase

Inherits:
Object
  • Object
show all
Includes:
Requireable, Understandable
Defined in:
lib/validations/validation_base.rb

Overview

:nodoc:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Requireable

included, #requires

Methods included from Understandable

included, #must_understand

Constructor Details

#initialize(klass, attribute, options = {}) ⇒ ValidationBase

Returns a new instance of ValidationBase.



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/validations/validation_base.rb', line 48

def initialize(klass, attribute, options={})
  must_understand options
  requires options
  self.class.all_understandings.each do |understanding|
    options[understanding] = self.class.all_defaults[understanding] unless options.has_key? understanding
    self.instance_variable_set("@#{understanding}", options[understanding])
  end
  self.attribute = attribute
  self.groups = [self.groups] unless self.groups.is_a?(Array)
  self.key = "#{self.class.name}:#{self.attribute}:#{self.key || "key"}" unless self.times.nil?
  raise_error_if_key_is_dup(klass) unless self.key.nil?
end

Instance Attribute Details

#attribute ⇒ Object

Returns the value of attribute attribute.



46
47
48
 
# File 'lib/validations/validation_base.rb', line 46

def attribute
  @attribute
end

Class Method Details

.after_validate(&block) ⇒ Object 



27
28
29
 
# File 'lib/validations/validation_base.rb', line 27

def after_validate(&block)
  after_validations << block
end

.after_validations ⇒ Object 



31
32
33
 
# File 'lib/validations/validation_base.rb', line 31

def after_validations
  @after_validations ||= []
end

.all_after_validations ⇒ Object 



35
36
37
38
 
# File 'lib/validations/validation_base.rb', line 35

def all_after_validations
  return after_validations + self.superclass.all_after_validations if self.superclass.respond_to? :all_after_validations
  after_validations
end

.all_defaults ⇒ Object 



22
23
24
25
 
# File 'lib/validations/validation_base.rb', line 22

def all_defaults
  return defaults.merge(self.superclass.all_defaults) if self.superclass.respond_to? :all_defaults
  defaults
end

.default(hash) ⇒ Object 



14
15
16
 
# File 'lib/validations/validation_base.rb', line 14

def default(hash)
  defaults.merge! hash
end

.defaults ⇒ Object 



18
19
20
 
# File 'lib/validations/validation_base.rb', line 18

def defaults
  @defaults ||= {}
end

.option(*args) ⇒ Object 



9
10
11
12
 
# File 'lib/validations/validation_base.rb', line 9

def option(*args)
  attr_accessor(*args)
  understands(*args)
end

.required_option(*args) ⇒ Object 



4
5
6
7
 
# File 'lib/validations/validation_base.rb', line 4

def required_option(*args)
  option(*args)
  requires(*args)
end

Instance Method Details

#message(instance) ⇒ Object 



72
73
74
 
# File 'lib/validations/validation_base.rb', line 72

def message(instance)
  @message.respond_to?(:call) ? instance.instance_eval(&@message) : @message
end

#raise_error_if_key_is_dup(klass) ⇒ Object

Raises:

  • (ArgumentError) 


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

def raise_error_if_key_is_dup(klass)
  message = "key #{self.key} must be unique, provide the :key option to specify a unique key"
  raise ArgumentError.new(message) if klass.validation_keys_include? self.key
end

#run_after_validate(result, instance, attribute) ⇒ Object 



81
82
83
84
85
 
# File 'lib/validations/validation_base.rb', line 81

def run_after_validate(result, instance, attribute)
  self.class.all_after_validations.each do |block|
    block.call result, instance, attribute
  end
end

#should_validate?(instance) ⇒ Boolean

Returns:

  • (Boolean) 


66
67
68
69
70
 
# File 'lib/validations/validation_base.rb', line 66

def should_validate?(instance)
  result = validate_this_time?(instance)
  result &&= instance.instance_eval(&self.if) unless self.if.nil?
  result
end

#validate_this_time?(instance) ⇒ Boolean

Returns:

  • (Boolean) 


76
77
78
79
 
# File 'lib/validations/validation_base.rb', line 76

def validate_this_time?(instance)
  return true if @times.nil?
  self.times > instance.times_validated(self.key)
end