class AE::Assertion

The Assertion class is simply a subclass of Exception that is used by AE as the default error raised when an assertion fails.

"The reserve of modern assertions is sometimes pushed to extremes,
 in which the fear of being contradicted leads the writer to strip
 himself of almost all sense and meaning."
                           -- Sir Winston Churchill (1874 - 1965)

Public Class Methods

counts() click to toggle source

@deprecated

This will be removed in favor of `AE::Assertor.counts`.
# File lib/ae/assertion.rb, line 18
def self.counts
  AE::Assertor.counts
end
new(message=nil, options={}) click to toggle source

New assertion (failure).

@param message [String] the failure message @param options [Hash] options such as :backtrace

Calls superclass method
# File lib/ae/assertion.rb, line 27
def initialize(message=nil, options={})
  super(message)
  backtrace = options[:backtrace]
  set_backtrace(backtrace) if backtrace
  set_assertion(true)
end

Public Instance Methods

assertion?() click to toggle source

Technically any object that affirmatively responds to assertion? can be taken to be an Assertion. This makes it easier for various libraries to work together without having to depend upon a common Assertion base class.

# File lib/ae/assertion.rb, line 38
def assertion?
  true
end
to_s() click to toggle source

Parents error message prefixed with “(assertion)”.

@return [String] error message

Calls superclass method
# File lib/ae/assertion.rb, line 45
def to_s
  '(assertion) ' + super
end