Class: Treequel::Model::Errors

Inherits:
Hash
  • Object
show all
Extended by:
Loggability
Includes:
HashUtilities
Defined in:
lib/treequel/model/errors.rb

Overview

Mixin that provides Treequel::Model characteristics to a mixin module.

The ideas and a large portion of the implementation of this class is borrowed from Sequel under the following license terms:

Copyright (c) 2007-2008 Sharon Rosner
Copyright (c) 2008-2010 Jeremy Evans

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Constant Summary collapse

ATTRIBUTE_CONJUNCTION =

The word to use between attributes in error messages

' and '

Instance Method Summary collapse

Methods included from HashUtilities

merge_recursively, normalize_attributes, stringify_keys, symbolify_keys

Constructor Details

#initialize(*args) ⇒ Errors

Set the initializer block to auto-create Array values.



49
50
51
52
 
# File 'lib/treequel/model/errors.rb', line 49

def initialize( *args )
	block = lambda {|h,k| h[k] = [] }
	super( *args, &block )
end

Instance Method Details

#add(subject, message) ⇒ Object

Adds an error for the given subject.



56
57
58
59
 
# File 'lib/treequel/model/errors.rb', line 56

def add( subject, message )
	self.log.error "%s: %s" % [ subject, message ]
	self[ subject ] << message
end

#count ⇒ Object

Get the number of errors that have been registered.



63
64
65
 
# File 'lib/treequel/model/errors.rb', line 63

def count
	return self.values.inject( 0 ) {|num, val| num + val.length }
end

#full_messages ⇒ Object

Get an Array of messages describing errors which have occurred.

errors.full_messages
# => ['cn is not valid',
#     'uid is not at least 2 letters']



73
74
75
76
77
78
79
 
# File 'lib/treequel/model/errors.rb', line 73

def full_messages
	return self.inject([]) do |full_messages, (attribute, messages)|
		subject = Array( attribute ).join( ATTRIBUTE_CONJUNCTION )
		messages.each {|part| full_messages << "#{subject} #{part}" }
		full_messages
	end
end