Docs For Class SimpleExpectation

Description

Assertion that can display failure information.

Also includes various helper methods.

abstract:

Direct descendents

Class	Description
CssSelectorExpectation	CssSelectorExpectation
AnythingExpectation	A wildcard expectation always matches.
FailedExpectation	An expectation that never matches.
TrueExpectation	An expectation that passes on boolean true.
FalseExpectation	An expectation that passes on boolean false.
EqualExpectation	Test for equality.
WithinMarginExpectation	Test for being within a range.
PatternExpectation	Test for a pattern using Perl regex rules.
IsAExpectation	Tests either type or class name if it's an object.
MethodExistsExpectation	Tests for existance of a method in an object
ExceptionExpectation	Tests exceptions either by type or the exact exception. This could be improved to accept a pattern expectation to test the error message, but that will have to come later.
FieldExpectation	Test for an HTML widget value match.
HttpHeaderExpectation	Test for a specific HTTP header within a header block.
TextExpectation	Test for a text substring.
ParametersExpectation	Parameter comparison assertion.
CallCountExpectation	Confirms that the number of calls on a method is as expected.
MinimumCallCountExpectation	Confirms that the number of calls on a method is as expected.
MaximumCallCountExpectation	Confirms that the number of calls on a method is as expected.

Variable Summary

mixed $dumper

Method Summary

static boolean isExpectation (mixed $expectation)

SimpleExpectation __construct ([string $message = '%s'])

SimpleDumper getDumper ()

string overlayMessage (mixed $compare, SimpleDumper $dumper)

boolean test (mixed $compare)

string testMessage (mixed $compare)

Variables

mixed $dumper = false (line 24)

access: protected

Methods

static isExpectation (line 93)

Test to see if a value is an expectation object.

A useful utility method.

return: True if descended from this class.
access: public

boolean isExpectation (mixed $expectation)

mixed $expectation: Hopefully an Expectation class.

Constructor __construct (line 32)

Creates a dumper for displaying values and sets the test message.

SimpleExpectation __construct ([string $message = '%s'])

string $message: Customised message on failure.

Redefined in descendants as:

CssSelectorExpectation::__construct() : Sets the dom tree and the css selector to compare against
EqualExpectation::__construct() : Sets the value to compare against.
NotEqualExpectation::__construct() : Sets the value to compare against.
IdenticalExpectation::__construct() : Sets the value to compare against.
NotIdenticalExpectation::__construct() : Sets the value to compare against.
MemberExpectation::__construct() : Sets the value to compare against.
WithinMarginExpectation::__construct() : Sets the value to compare against and the fuzziness of the match. Used for comparing floating point values.
OutsideMarginExpectation::__construct() : Sets the value to compare against and the fuzziness of the match. Used for comparing floating point values.
PatternExpectation::__construct() : Sets the value to compare against.
NoPatternExpectation::__construct() : Sets the reject pattern
IsAExpectation::__construct() : Sets the type to compare with.
NotAExpectation::__construct() : Sets the type to compare with.
MethodExistsExpectation::__construct() : Sets the value to compare against.
ExceptionExpectation::__construct() : Sets up the conditions to test against.
FieldExpectation::__construct() : Sets the field value to compare against.
HttpHeaderExpectation::__construct() : Sets the field and value to compare against.
NoHttpHeaderExpectation::__construct() : Sets the field and value to compare against.
TextExpectation::__construct() : Sets the value to compare against.
NoTextExpectation::__construct() : Sets the reject pattern
ParametersExpectation::__construct() : Sets the expected parameter list.
CallCountExpectation::__construct() : Stashes the method and expected count for later reporting.
MinimumCallCountExpectation::__construct() : Stashes the method and expected count for later reporting.
MaximumCallCountExpectation::__construct() : Stashes the method and expected count for later reporting.

getDumper (line 76)

Accessor for the dumper.

return: Current value dumper.
access: protected

SimpleDumper getDumper ()

overlayMessage (line 66)

Overlays the generated message onto the stored user message. An additional message can be interjected.

return: Description of success or failure.
access: public

string overlayMessage (mixed $compare, SimpleDumper $dumper)

mixed $compare: Comparison value.
SimpleDumper $dumper: For formatting the results.

test (line 43)

Tests the expectation. True if correct.

return: True if correct.
abstract:
access: public

boolean test (mixed $compare)

mixed $compare: Comparison value.

Redefined in descendants as:

CssSelectorExpectation::test() : Tests the expectation. True if it matches the held value.
AnythingExpectation::test() : Tests the expectation. Always true.
FailedExpectation::test() : Tests the expectation. Always false.
TrueExpectation::test() : Tests the expectation.
FalseExpectation::test() : Tests the expectation.
EqualExpectation::test() : Tests the expectation. True if it matches the held value.
NotEqualExpectation::test() : Tests the expectation. True if it differs from the held value.
IdenticalExpectation::test() : Tests the expectation. True if it exactly matches the held value.
NotIdenticalExpectation::test() : Tests the expectation. True if it differs from the held value.
MemberExpectation::test() : Tests the expectation. True if the property value is identical.
WithinMarginExpectation::test() : Tests the expectation. True if it matches the held value.
OutsideMarginExpectation::test() : Tests the expectation. True if it matches the held value.
PatternExpectation::test() : Tests the expectation. True if the Perl regex matches the comparison value.
NoPatternExpectation::test() : Tests the expectation. False if the Perl regex matches the comparison value.
IsAExpectation::test() : Tests the expectation. True if the type or class matches the string value.
NotAExpectation::test() : Tests the expectation. False if the type or class matches the string value.
MethodExistsExpectation::test() : Tests the expectation. True if the method exists in the test object.
ExceptionExpectation::test() : Carry out the test.
FieldExpectation::test() : Tests the expectation. True if it matches a string value or an array value in any order.
HttpHeaderExpectation::test() : Tests the expectation. True if it matches a string value or an array value in any order.
NoHttpHeaderExpectation::test() : Tests that the unwanted header is not found.
TextExpectation::test() : Tests the expectation. True if the text contains the substring.
NoTextExpectation::test() : Tests the expectation. False if the substring appears in the text.
ParametersExpectation::test() : Tests the assertion. True if correct.
CallCountExpectation::test() : Tests the assertion. True if correct.
MinimumCallCountExpectation::test() : Tests the assertion. True if correct.
MaximumCallCountExpectation::test() : Tests the assertion. True if correct.

testMessage (line 54)

Returns a human readable test message.

return: Description of success or failure.
abstract:
access: public

string testMessage (mixed $compare)

mixed $compare: Comparison value.

Redefined in descendants as:

CssSelectorExpectation::testMessage() : Returns a human readable test message.
AnythingExpectation::testMessage() : Returns a human readable test message.
FailedExpectation::testMessage() : Returns a human readable test message.
TrueExpectation::testMessage() : Returns a human readable test message.
FalseExpectation::testMessage() : Returns a human readable test message.
EqualExpectation::testMessage() : Returns a human readable test message.
NotEqualExpectation::testMessage() : Returns a human readable test message.
IdenticalExpectation::testMessage() : Returns a human readable test message.
NotIdenticalExpectation::testMessage() : Returns a human readable test message.
MemberExpectation::testMessage() : Returns a human readable test message.
WithinMarginExpectation::testMessage() : Returns a human readable test message.
OutsideMarginExpectation::testMessage() : Returns a human readable test message.
PatternExpectation::testMessage() : Returns a human readable test message.
NoPatternExpectation::testMessage() : Returns a human readable test message.
IsAExpectation::testMessage() : Returns a human readable test message.
NotAExpectation::testMessage() : Returns a human readable test message.
MethodExistsExpectation::testMessage() : Returns a human readable test message.
ExceptionExpectation::testMessage() : Create the message to display describing the test.
FieldExpectation::testMessage() : Returns a human readable test message.
HttpHeaderExpectation::testMessage() : Returns a human readable test message.
NoHttpHeaderExpectation::testMessage() : Returns a human readable test message.
TextExpectation::testMessage() : Returns a human readable test message.
NoTextExpectation::testMessage() : Returns a human readable test message.
ParametersExpectation::testMessage() : Returns a human readable test message.
CallCountExpectation::testMessage() : Reports the comparison.
MinimumCallCountExpectation::testMessage() : Reports the comparison.
MaximumCallCountExpectation::testMessage() : Reports the comparison.