Class: Validatable::ValidationBase

Inherits:
Object
  • Object
show all
Includes:
Requireable, Understandable
Defined in:
lib/validatable/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.



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

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 = "#{klass.name}/#{self.class.name}/#{self.key || self.attribute}"
  raise_error_if_key_is_dup(klass)
end

Instance Attribute Details

#attribute ⇒ Object

Returns the value of attribute attribute.



44
45
46
 
# File 'lib/validatable/validations/validation_base.rb', line 44

def attribute
  @attribute
end

Class Method Details

.after_validate(&block) ⇒ Object 



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

def self.after_validate(&block)
  after_validations << block
end

.after_validations ⇒ Object 



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

def self.after_validations
  @after_validations ||= []
end

.all_after_validations ⇒ Object 



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

def self.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 



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

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

.default(hash) ⇒ Object 



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

def self.default(hash)
  defaults.merge! hash
end

.defaults ⇒ Object 



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

def self.defaults
  @defaults ||= {}
end

.option(*args) ⇒ Object 



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

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

.required_option(*args) ⇒ Object 



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

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

Instance Method Details

#i18n ⇒ Object 



75
76
77
 
# File 'lib/validatable/validations/validation_base.rb', line 75

def i18n
  @i18n
end

#i18n_prefix ⇒ Object 



79
80
81
 
# File 'lib/validatable/validations/validation_base.rb', line 79

def i18n_prefix
  "validatable"
end

#message(instance) ⇒ Object 



83
84
85
86
87
88
89
 
# File 'lib/validatable/validations/validation_base.rb', line 83

def message(instance)
  if Validatable.use_i18n?
    i18n
  else
    @message.respond_to?(:call) ? instance.instance_eval(&@message) : @message
  end
end

#raise_error_if_key_is_dup(klass) ⇒ Object

Raises:

  • (ArgumentError) 


59
60
61
62
 
# File 'lib/validatable/validations/validation_base.rb', line 59

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 



96
97
98
99
100
101
 
# File 'lib/validatable/validations/validation_base.rb', line 96

def run_after_validate(result, instance, attribute)
  self.class.all_after_validations.each do |block|
    block.call result, instance, attribute
  end
  instance.instance_eval_with_params result, attribute, &self.after_validate unless self.after_validate.nil?
end

#should_validate?(instance) ⇒ Boolean

Returns:

  • (Boolean) 


64
65
66
67
68
69
70
71
72
73
 
# File 'lib/validatable/validations/validation_base.rb', line 64

def should_validate?(instance)
  result = validate_this_time?(instance)
  case self.if
    when Proc
      result &&= instance.instance_eval(&self.if)
    when Symbol, String
      result &&= instance.instance_eval(self.if.to_s)
  end
  result
end

#validate_this_time?(instance) ⇒ Boolean

Returns:

  • (Boolean) 


91
92
93
94
 
# File 'lib/validatable/validations/validation_base.rb', line 91

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