CppSpec::Expectation< A > Class Template Reference

Wraps the target of an expectation. More...

#include <expectation.hpp>

Inheritance diagram for CppSpec::Expectation< A >:

Public Member Functions
	Expectation (std::source_location location)
	Expectation (ItBase &it, std::source_location location)
	Create an Expectation using a value.
virtual A &	get_target () &=0
	Get the target of the expectation.
ItBase *	get_it () const
std::source_location	get_location () const
constexpr bool	positive () const
	Get whether the expectation is normal or negated.
constexpr bool	ignored () const
virtual Expectation &	not_ ()=0
virtual Expectation &	ignore ()=0
template<class M>
void	to (M matcher, std::string msg="")
void	to_be_false (std::string msg="")
	Match using the Matchers::Be matcher, testing for falsy-ness.
void	to_be_falsy (std::string msg="")
void	to_be_null (std::string msg="")
	Match using the Matchers::BeNullptr matcher.
void	to_be_true (std::string msg="")
	Match using the Matchers::Be matcher, testing for truthy-ness.
void	to_be_truthy (std::string msg="")
template<typename E>
void	to_be_between (E min, E max, Matchers::RangeMode mode=Matchers::RangeMode::inclusive, std::string msg="")
	Match using the Matchers::BeBetween matcher, with an explicit range mode.
template<typename E>
void	to_be_greater_than (E rhs, std::string msg="")
template<typename E>
void	to_be_less_than (E rhs, std::string msg="")
template<typename E>
Matchers::BeWithinHelper< A, E >	to_be_within (E expected, std::string msg="")
	Match using the Matchers::BeWithin matcher.
void	to_end_with (std::string ending, std::string msg="")
void	to_fail (std::string msg="")
void	to_fail_with (std::string failure_message, std::string msg="")
void	to_match (std::regex regex, std::string msg="")
void	to_match (std::string str, std::string msg="")
void	to_partially_match (std::regex regex, std::string msg="")
void	to_partially_match (std::string str, std::string msg="")
void	to_satisfy (std::function< bool(A)>, std::string msg="")
	Match using the Matchers::Satisfy matcher.
void	to_start_with (std::string start, std::string msg="")
template<typename U>
void	to_contain (std::initializer_list< U > expected, std::string msg="")
	Match using the Matchers::Include matcher, given an initializer list.
template<typename E>
void	to_contain (E expected, std::string msg="")
	Match using the Matchers::Include matcher.
template<typename U>
void	to_end_with (std::initializer_list< U > start, std::string msg="")
template<typename E>
void	to_equal (E expected, std::string msg="")
	Match using the Matchers::Equal matcher.
template<typename U>
void	to_start_with (std::initializer_list< U > start, std::string msg="")
void	to_have_value (std::string msg="")

Protected Attributes
bool	is_positive_ = true
bool	ignore_ = false

Detailed Description

template<class A>
class CppSpec::Expectation< A >

Wraps the target of an expectation.

expect(something)
expect([] -> auto { return something })
 
// used with a matcher
expect(actual).to_equal(target)
 
// used with `not` and a matcher
expect(actual).not_().to_equal(target)

Static typing forces us to either give the type of the expected result to the Matcher object, or chain in a builder-like fashion.

Constructor & Destructor Documentation

Expectation()

template<class A>

CppSpec::Expectation< A >::Expectation ( ItBase & it, std::source_location location )

inlineexplicit

Create an Expectation using a value.

Parameters

value

The target to test, an explicit value.

Returns

The constructed Expectation.

Member Function Documentation

get_target()

template<class A>

virtual A & CppSpec::Expectation< A >::get_target ( ) &

pure virtual

Get the target of the expectation.

Implemented in CppSpec::ExpectationFunc< F >, and CppSpec::ExpectationValue< A >.

to()

template<typename A>

template<class M>

void CppSpec::Expectation< A >::to	(	M	matcher,
		std::string	msg = "" )

Parameters

matcher
msg

Template Parameters

A
M

Returns

to_be_between()

template<typename A>

template<typename E>

void CppSpec::Expectation< A >::to_be_between	(	E	min,
		E	max,
		Matchers::RangeMode	mode = Matchers::RangeMode::inclusive,
		std::string	msg = "" )

Match using the Matchers::BeBetween matcher, with an explicit range mode.

Parameters

min
max
msg	Optional message to give on failure.

Returns

to_be_false()

template<typename A>

void CppSpec::Expectation< A >::to_be_false

(

std::string

msg = ""

)

Match using the Matchers::Be matcher, testing for falsy-ness.

Parameters

msg	Optional message to give on failure.

Template Parameters

A

Returns

to_be_falsy()

template<typename A>

void CppSpec::Expectation< A >::to_be_falsy

(

std::string

msg = ""

)

Parameters

msg

Returns

to_be_null()

template<typename A>

void CppSpec::Expectation< A >::to_be_null

(

std::string

msg = ""

)

Match using the Matchers::BeNullptr matcher.

Parameters

msg	Optional message to give on failure.

Returns

to_be_true()

template<typename A>

void CppSpec::Expectation< A >::to_be_true

(

std::string

msg = ""

)

Match using the Matchers::Be matcher, testing for truthy-ness.

Parameters

msg	Optional message to give on failure.

Returns

to_be_truthy()

template<typename A>

void CppSpec::Expectation< A >::to_be_truthy

(

std::string

msg = ""

)

Parameters

msg

Template Parameters

A

Returns

to_be_within()

template<typename A>

template<typename E>

Matchers::BeWithinHelper< A, E > CppSpec::Expectation< A >::to_be_within	(	E	expected,
		std::string	msg = "" )

Match using the Matchers::BeWithin matcher.

Parameters

expected
msg	Optional message to give on failure.

Returns

to_contain() [1/2]

template<typename A>

template<typename E>

void CppSpec::Expectation< A >::to_contain	(	E	expected,
		std::string	msg = "" )

Match using the Matchers::Include matcher.

Parameters

expected
msg	Optional message to give on failure.

Returns

to_contain() [2/2]

template<typename A>

template<typename U>

void CppSpec::Expectation< A >::to_contain	(	std::initializer_list< U >	expected,
		std::string	msg = "" )

Match using the Matchers::Include matcher, given an initializer list.

Parameters

expected
msg	Optional message to give on failure.

Returns

to_equal()

template<typename A>

template<typename E>

void CppSpec::Expectation< A >::to_equal	(	E	expected,
		std::string	msg = "" )

Match using the Matchers::Equal matcher.

Parameters

expected
msg	Optional message to give on failure.

Returns

to_satisfy()

template<typename A>

void CppSpec::Expectation< A >::to_satisfy	(	std::function< bool(A)>	test,
		std::string	msg = "" )

Match using the Matchers::Satisfy matcher.

Parameters

test	The function to use to test the output of the expectation expression.
msg	Optional message to give on failure.

Returns

Whether the expectation succeeds or fails.

---

The documentation for this class was generated from the following file:

• include/expectations/expectation.hpp