Class: Croesus::Validator::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/croesus/validators/base.rb

Overview

Author: Stefano Harding <[email protected]>

Copyright © 2014 Stefano Harding

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ Base

Returns a new instance of Base.



23
24
25
26
27
28
29
30
31
32
# File 'lib/croesus/validators/base.rb', line 23

def initialize(name)
  unless name.is_a?(String) && name.size > 0
    raise StandardError.new(
      'Validator must be initialized with a valid name '\
      '(string with length greater than zero).'
    )
  end

  self.name = name
end

Instance Attribute Details

#nameObject

Returns the value of attribute name.



21
22
23
# File 'lib/croesus/validators/base.rb', line 21

def name
  @name
end

Instance Method Details

#presence_error_messageObject



38
39
40
# File 'lib/croesus/validators/base.rb', line 38

def presence_error_message
  "#{self.name} required"
end

#should_validate?(name) ⇒ Boolean

Returns:



34
35
36
# File 'lib/croesus/validators/base.rb', line 34

def should_validate?(name)
  self.name == name
end

#validate(key, value, validations, errors) ⇒ Object

Raises:



42
43
44
45
46
# File 'lib/croesus/validators/base.rb', line 42

def validate(key, value, validations, errors)
  raise ValidationError.new(
    'Validate should not be called directly on Croesus::Validator::Base'
  )
end