matcher

Type Members

1. trait ActionMatchers extends ValueChecks

   

   Matchers for Action values

2. trait AdaptableMatcher[T] extends Matcher[T]

   

   Inherit this trait to provide a Matcher where both the actual and the expected values can be adapted with a function.

3. case class AlwaysMatcher[T]() extends Matcher[T] with Product with Serializable

   

   This matcher always matches any value of type T

4. class AndMatch[T] extends MatchResult[T]

   

5. class AndNotMatch[T] extends MatchResult[T]

   

6. trait AnyBeHaveMatchers extends BeHaveMatchers

   

   This trait allows to write expressions like

   This trait allows to write expressions like

   1 must be equalTo(1)

7. trait AnyMatchers extends AnyBaseMatchers with AnyBeHaveMatchers

   

   This trait provides matchers which are applicable to any type of value

8. class BeCloseTo[T] extends Matcher[T]

   

9. class BeEqualTo extends BeTypedEqualTo[Any]

   

   Equality Matcher

10. case class BeEqualTypedValueCheck[T](expected: T) extends ValueCheck[T] with Product with Serializable

    

    ValueCheck for a typed expected value.

    ValueCheck for a typed expected value. It uses the BeTypedEqualTo matcher

11. case class BeEqualValueCheck[T](expected: Any) extends ValueCheck[T] with Product with Serializable

    

    ValueCheck for an untyped expected value.

    ValueCheck for an untyped expected value. It uses the BeEqualTo matcher

12. class BeLessThan[T] extends Matcher[T]

    

13. class BeLessThanOrEqualTo[T] extends Matcher[T]

    

14. class BeMatching extends Matcher[String]

    

    Attributes

    protected[org.specs2]

15. class BeMatchingPattern extends BeMatching

    

    Attributes

    protected[org.specs2]

16. class BeMatchingRegex extends BeMatching

    

17. class BeNull[T] extends Matcher[T]

    

18. case class BeOneOf[T](t: Seq[T]) extends Matcher[T] with Product with Serializable

    

19. class BeSignificantlyCloseTo[T] extends Matcher[T]

    

20. class BeTheSameAs[T <: AnyRef] extends Matcher[T]

    

21. class BeTrueMatcher extends Matcher[Boolean]

    

    Matcher for a boolean value which must be true

22. class BeTypedEqualTo[T] extends AdaptableMatcher[T]

    

    Typed equality Matcher

23. case class BetweenMatcher[T](t1: T, t2: T, includeStart: Boolean = true, includeEnd: Boolean = true)(implicit evidence$49: (T) ⇒ Ordered[T]) extends Matcher[T] with Product with Serializable

    

24. case class CanHaveDelta[S](n: S)(implicit evidence$33: Numeric[S]) extends Product with Serializable

    

    transient class allowing the creation of a delta

25. case class ContainWithResult[T](check: ValueCheck[T], timesMin: Option[Times] = Some(1.times), timesMax: Option[Times] = None, checkAll: Boolean = true) extends Matcher[GenTraversableOnce[T]] with Product with Serializable

    

26. case class ContainWithResultSeq[T](checks: Seq[ValueCheck[T]], containsAtLeast: Boolean = true, containsAtMost: Boolean = false, eachCheck: Boolean = false, checkOrder: Boolean = false, negate: Boolean = false) extends Matcher[GenTraversableOnce[T]] with Product with Serializable

    

27. case class DataTable(titles: Seq[String], rows: Seq[DataTableRow]) extends Product with Serializable

    

28. case class DataTableRow(cells: Seq[String], result: Result) extends Product with Serializable

    

29. trait DataTables extends ExpectationsCreation

    

    This trait provides implicit definitions and types to create DataTables.

    This trait provides implicit definitions and types to create DataTables.

    A DataTable has a header defining column names and rows holding values. It is possible to apply a function taking the row values and returning a MatchResult.

    A TableHeader is defined by separating the column names with '|': "a" | "b" | "c"

    A DataRow is defined by separating the row values with '!': 1 ! 2 ! 3

    Note that the '!' method can conflict with the creation of Examples when the value is a string. In that case it is possible to use the '!!! method to disambiguate:

    "1" !! "2" ! "3"

    In that case the first column of the header can also be defined with '||' for pure symmetry reasons:

    "a" || "b" | "c" "1" !! "2" ! "3"

    See also

    org.specs2.matcher.DataTablesSpec for examples

30. trait DisjunctionMatchers extends AnyRef

    

    Matchers for the \/ datatype

31. trait EitherMatchers extends EitherBaseMatchers with EitherBeHaveMatchers

    

    Matchers for the Either datatype

32. trait EventuallyMatchers extends EventuallyResults

    

    This trait adds the possibility to retry a given matcher until it succeeds.

    This trait adds the possibility to retry a given matcher until it succeeds.

    This was contributed by @robey (http://robey.lag.net)

33. trait ExceptionMatchers extends ExceptionBaseMatchers with ExceptionBeHaveMatchers

    

    These matchers can be used to check if exceptions are thrown or not

34. class Expectable[+T] extends AnyRef

    

    The Expectable class models anything which can be checked by applying a Matcher

    The Expectable class models anything which can be checked by applying a Matcher

    It stores a value which is only evaluated when necessary and an optional additional description for that value.

    The Expectable object is responsible for creating its own description, based on the value toString method and and an additional description.

35. trait Expectations extends ExpectationsCreation with TypedEqual with ExpectationsDescription

    

    This trait provides implicit definitions to transform any value into an Expectable

36. trait ExpectationsCreation extends MatchResultStackTrace

    

    Base trait to create expectations

37. trait ExpectationsDescription extends ExpectationsCreation

    

38. trait FutureMatchers extends FutureBaseMatchers

    

    This trait is for transforming matchers of values to matchers of Futures

39. trait FuturezMatchers extends FuturezBaseMatchers

    

    This trait is for transforming matchers of values to matchers of scalaz.concurrent.Future

40. case class LeftCheckedMatcher[T](check: ValueCheck[T]) extends OptionLikeCheckedMatcher[[a]Either[a, _], T, T] with Product with Serializable

    

41. case class LeftDisjunctionCheckedMatcher[T](check: ValueCheck[T]) extends OptionLikeCheckedMatcher[[a]\/[a, _], T, T] with Product with Serializable

    

42. case class LeftDisjunctionMatcher[T]() extends OptionLikeMatcher[[a]\/[a, _], T, T] with Product with Serializable

    

43. case class LeftMatcher[T]() extends OptionLikeMatcher[[a]Either[a, _], T, T] with Product with Serializable

    

44. trait MapMatchers extends MapBaseMatchers with MapBeHaveMatchers

    

    Matchers for Maps

45. case class MatchFailure[T] extends MatchResult[T] with Product with Serializable

    

46. class MatchFailureException[T] extends FailureException with MatchResultException[T]

    

    this class allows to throw a match failure result in an Exception

47. case class MatchPending[T] extends MatchResult[T] with Product with Serializable

    

48. class MatchPendingException[T] extends PendingException with MatchResultException[T]

    

    this class allows to throw a pending result in an Exception

49. trait MatchResult[+T] extends ResultLike

    

    Result of a Match.

    Result of a Match.

    A MatchResult contains several information about a match on an expectable:

    - the expectable value, to allow the chaining of matches - a pair of messages ok message / ko message to allow the easy creation of the negation of a match

    A MatchResult can be transformed to a simple Result object to be the body of an Example.

    There are different kinds of MatchResults, some of them being only created to support English-like combination of Matchers:

    1 must be equalTo(1) and not be equalTo(2)

    In an Expectation like the one above, there is a left to right evaluation:

    1. be is a NeutralMatcher, returning a NeutralMatch doing nothing yet, just storing the expectable

    2. equalTo(1) is a real Matcher which is applied to the NeutralMatch MatchResult thanks to an implicit definition in the BeHaveAnyMatchers trait. This yields a MatchSuccess result

    3. not creates a NotMatcher and can be and-ed with the previous MatchSuccess to yield a AndMatch(MatchSuccess, NotMatch), with NotMatch being the result of applying the NotMatcher to the expectable. This AndMatch is evaluated to create a AndNotMatch(MatchSuccess, MatchSkip)

    Basically this is like forming an evaluation structure which will be resolved when the next 'real' matcher will arrive

    4. the AndNotMatch get nows it be method called with the equalTo Matcher. This results in equalTo being applied to the AndNotMatch, effectively doing: MatchSuccess and MatchSkip.apply(equalTo(2).not), which is MatchSuccess and expectable.applyMatcher(equalTo(2).not) which is MatchSuccess

    See also

    org.specs2.matcher.BeHaveMatchersSpec for examples

50. trait MatchResultCombinators extends MatchResultLogicalCombinators with ResultLogicalCombinators

    

    This trait provides logical operators to combine match results where potentially a MatchResult expression throws an Exception, either because it is an error or because it is a ThrownExpectation

51. trait MatchResultException[T] extends AnyRef

    

52. trait MatchResultImplicits extends AnyRef

    

    Implicit conversions for MatchResults

53. trait MatchResultLogicalCombinators extends Expectations

    

54. trait MatchResultStackTrace extends AnyRef

    

    this trait allows to fill-in stack traces on match results for precise location

55. case class MatchSkip[T] extends MatchResult[T] with Product with Serializable

    

56. class MatchSkipException[T] extends SkipException with MatchResultException[T]

    

    this class allows to throw a skipped match result in an Exception

57. case class MatchSuccess[T] extends MatchResult[T] with Product with Serializable

    

    The signature of this class constructor is unusual, with a useless implicit parameter.

    The signature of this class constructor is unusual, with a useless implicit parameter.

    This is actually here to avoid overloading conflicts with the apply method in the companion object

58. trait Matcher[-T] extends AnyRef

    

    The Matcher trait is the base trait for any Matcher.

    The Matcher trait is the base trait for any Matcher.

    This trait can be extended to provide an appropriate apply method that will check an expectable value a: Expectable[T].

    The result of a match is a MatchResult object (@see MatchResult).

    Matchers can be composed.

    Implementation notes:

    • the parameter to the apply method must be a by-name parameter. This allows some values to be evaluated only when necessary.
    • However in the implementation of the apply function, it must be taken care of not evaluating the parameter twice. Assigning it to a val is the solution to this issue.

59. trait MatcherZipOperators extends ExpectationsCreation

    

    This trait provides 'zip' operators to create matchers on tuples based on "zipped" matchers on fields

60. trait MatcherZipOperatorsCodeGeneration extends AnyRef

    

    Generation code for the MatcherZipOperators trait

61. trait Matchers extends AnyMatchers with BeHaveMatchers with TraversableMatchers with MapMatchers with StringMatchers with ExceptionMatchers with NumericMatchers with OptionMatchers with EitherMatchers with TryMatchers with EventuallyMatchers with FutureMatchers with FuturezMatchers with MatchersImplicits with ValueChecks with LanguageFeatures

    

    Trait aggregating the most common specs2 matchers

62. trait Matchers1 extends AnyBaseMatchers with TraversableBaseMatchers with StringBaseMatchers with ExceptionBaseMatchers with NumericBaseMatchers with OptionBaseMatchers with EitherBaseMatchers with TryBaseMatchers with EventuallyMatchers with FutureBaseMatchers with ValueChecksBase

    

63. trait MatchersCreation extends AnyRef

    

64. trait MatchersImplicits extends MatchResultCombinators with MatcherZipOperators with MatchResultImplicits with ResultImplicits with MatchersCreation with SequenceMatchersCreation

    

    This trait provides implicit definitions from MatchResults and Booleans to Results.

    This trait provides implicit definitions from MatchResults and Booleans to Results.

    It also allows to:

    - create matchers from functions - create matchers for seqs and sets from single matchers

65. class MustExpectable[T] extends Expectable[T]

    

    This kind of expectable can be followed by the verb must to apply a matcher:

    This kind of expectable can be followed by the verb must to apply a matcher:

    1 must beEqualTo(1)

    For convenience, several mustMatcher methods have also been defined as shortcuts to equivalent:

    a must matcher

66. trait MustExpectations extends MustExpectations1 with ExpectationsDescription with TypedEqual

    

    This trait provides implicit definitions to transform any value into a MustExpectable

67. trait MustMatchers extends Matchers with MustExpectations

    

68. trait MustThrownExpectations extends MustExpectations with MustThrownExpectations1

    

    This trait provides implicit definitions to transform any value into a MustExpectable, throwing exceptions when a match fails

69. trait MustThrownExpectationsCreation extends ThrownExpectationsCreation with MustExpectationsCreation

    

70. trait MustThrownMatchers extends Matchers with MustThrownExpectations

    

71. case class NeutralMatch[T] extends MatchResult[T] with Product with Serializable

    

72. class NeutralMatcher[T] extends Matcher[T]

    

    This special matcher always return a NeutralMatch MatchResult (an implicit Success)

73. case class NeverMatcher[T]() extends Matcher[T] with Product with Serializable

    

    This matcher never matches any value of type T

74. trait NoExpectationsDescription extends ExpectationsDescription

    

75. trait NoMatchResultStackTrace extends MatchResultStackTrace

    

    this trait doesn't fill-in stack traces

76. trait NoMatcherZipOperatorsImplicits extends MatcherZipOperators

    

    This trait can be mixed in to remove the implicit definitions for zipping matchers

77. trait NoMatcherZipOperatorsImplicitsCodeGeneration extends AnyRef

    

    code generation for the NoMatcherZipOperatorsImplicits trait

78. trait NoMustExpectations extends MustExpectations

    

    This trait can be used to remove aka and must methods on any value

79. trait NoShouldExpectations extends ShouldExpectations

    

    This trait can be used to remove aka and should methods on any value

80. trait NoThrownExpectations extends Expectations

    

    This trait can be used to cancel the effect of thrown expectations.

    This trait can be used to cancel the effect of thrown expectations.

    For example it can be mixed-in a mutable.Specification so that no exception is thrown on failure

81. trait NoTypedEqual extends TypedEqual

    

    This trait can be used to suppress the TypedEqual implicit

82. case class NotMatch[T] extends MatchResult[T] with Product with Serializable

    

83. class NotMatcher[T] extends Matcher[T]

    

    This special matcher always return a NotMatch MatchResult.

    This special matcher always return a NotMatch MatchResult. It will negate the next match applied to it.

84. trait NumericMatchers extends NumericBaseMatchers with NumericBeHaveMatchers

    

    Matchers for Numerical values

85. class OptionLikeCheckedMatcher[F[_], T, U] extends Matcher[F[T]]

    

86. class OptionLikeMatcher[F[_], T, U] extends Matcher[F[T]]

    

87. trait OptionMatchers extends OptionBaseMatchers with OptionBeHaveMatchers with ValueChecks

    

    Matchers for Options

88. class OrMatch[T] extends MatchResult[T]

    

89. class OrNotMatch[T] extends MatchResult[T]

    

90. class OrderingMatcher[T] extends Matcher[Seq[T]]

    

91. case class PlusOrMinus[S](n: S, delta: S) extends Product with Serializable

    

    class representing a numeric range

92. trait ResultImplicits extends ExpectationsCreation

    

93. trait ResultMatchers extends ResultBaseMatchers with ResultBeHaveMatchers

    

    Matchers for Results

94. implicit class Returns[T] extends AnyRef

    

    Definition Classes

    ReturnsSyntax

95. trait ReturnsSyntax extends ExpectationsCreation

    

    Those definitions help specifying the result messages for matchers

96. case class RightCheckedMatcher[T](check: ValueCheck[T]) extends OptionLikeCheckedMatcher[[a]Either[_, a], T, T] with Product with Serializable

    

97. case class RightDisjunctionCheckedMatcher[T](check: ValueCheck[T]) extends OptionLikeCheckedMatcher[[a]\/[_, a], T, T] with Product with Serializable

    

98. case class RightDisjunctionMatcher[T]() extends OptionLikeMatcher[[a]\/[_, a], T, T] with Product with Serializable

    

99. case class RightMatcher[T]() extends OptionLikeMatcher[[a]Either[_, a], T, T] with Product with Serializable

    

100. trait Scope extends AnyRef

     

     This trait represents any Scope that is used to enclose expectations which might be thrown

101. trait SequenceMatchersCreation extends ExpectationsCreation with ResultImplicits

     

102. class ShouldExpectable[T] extends Expectable[T]

     

     This kind of expectable can be followed by the verb should to apply a matcher:

     This kind of expectable can be followed by the verb should to apply a matcher:

     1 should beEqualTo(1)

     For convenience, several shouldMatcher methods have also been defined as shortcuts to equivalent:

     a should matcher

103. trait ShouldExpectations extends Expectations

     

     This trait provides implicit definitions to transform any value into a ShouldExpectable

104. trait ShouldMatchers extends Matchers with ShouldExpectations

     

105. trait ShouldThrownExpectations extends ThrownExpectations with ShouldExpectations

     

     This trait provides implicit definitions to transform any value into a ShouldExpectable, throwing exceptions when a match fails

106. trait ShouldThrownMatchers extends Matchers with ShouldThrownExpectations

     

107. case class SignificantFigures(number: Int) extends Product with Serializable

     

108. case class SignificantTarget[T](target: T, significantFigures: SignificantFigures)(implicit evidence$48: Numeric[T]) extends Product with Serializable

     

109. class SizedCheckedMatcher[T] extends Matcher[T]

     

110. class SizedMatcher[T] extends Matcher[T]

     

111. case class SomeCheckedMatcher[T](check: ValueCheck[T]) extends OptionLikeCheckedMatcher[Option, T, T] with Product with Serializable

     

112. case class SomeMatcher[T]() extends OptionLikeMatcher[Option, T, T] with Product with Serializable

     

113. trait StandardMatchResults extends ExpectationsCreation

     

     This trait can be used in conjonction with Pattern matchers:

     This trait can be used in conjonction with Pattern matchers:

     List(1, 2) must be like { case List(a, b) => ok } List(1, 2) must be like { case List(a, b) => ko("unexpected") }

114. trait StoredExpectations extends Expectations

     

     This trait evaluates expectations and stores them in a local variable for further usage

115. case class StringMatcher(m: AdaptableMatcher[Any]) extends Product with Serializable

     

116. trait StringMatchers extends StringBaseMatchers with StringBeHaveMatchers

     

     The StringMatchers trait provides matchers which are applicable to String objects

117. trait ThrownExpectations extends ThrownExpectationsCreation

     

     Thrown expectations will throw a FailureException if a match fails

     Thrown expectations will throw a FailureException if a match fails

     This trait can be extended to be used in another framework like ScalaTest:

     trait ScalaTestExpectations extends ThrownExpectations { override protected def checkFailure[T](m: =>MatchResult[T]) = { m match { case f @ MatchFailure(ok, ko, _, _, _) => throw new TestFailedException(f.message, f.exception, 0) case _ => () } m } }

118. trait ThrownExpectationsCreation extends ExpectationsCreation with StandardResults with StandardMatchResults

     

     Lightweight ThrownExpectations trait with less implicit methods

119. trait ThrownMessages extends AnyRef

     

     This trait can be used to integrate failures and skip messages into specs2

120. trait TraversableMatchers extends TraversableBaseMatchers with TraversableBeHaveMatchers with LazyParameters with TraversableBaseMatchersLowImplicits with ImplicitParameters with NumberOfTimes

     

     Matchers for traversables

121. case class TryFailureCheckedMatcher[T](check: ValueCheck[Throwable]) extends OptionLikeCheckedMatcher[Try, T, Throwable] with Product with Serializable

     

122. case class TryFailureMatcher[T]() extends OptionLikeMatcher[Try, T, Throwable] with Product with Serializable

     

123. trait TryMatchers extends TryBaseMatchers with TryBeHaveMatchers

     

     Matchers for util.Try instances

124. case class TrySuccessCheckedMatcher[T](check: ValueCheck[T]) extends OptionLikeCheckedMatcher[Try, T, T] with Product with Serializable

     

125. case class TrySuccessMatcher[T]() extends OptionLikeMatcher[Try, T, T] with Product with Serializable

     

126. trait TypedEqual extends AnyRef

     

     This trait adds some implicits to create expectations with the === sign

127. trait ValueCheck[T] extends AnyRef

     

     Common interface for checks of a value of type T:

     Common interface for checks of a value of type T:

     • a expected single value of type T
     • a Matcher[T]
     • a function returning a type R having an AsResult instance

128. trait ValueChecks extends ValueChecksBase

     

     implicit conversions used to create ValueChecks

129. trait ValueChecksBase extends ValueChecksLowImplicits

     

130. trait ValueChecksLowImplicits extends AnyRef

     

131. trait ConcurrentExecutionContext extends AnyRef

     

     Specification of the execution context to be used for executing futures This can be overridden to pass in your own execution context

     Specification of the execution context to be used for executing futures This can be overridden to pass in your own execution context

     Annotations

     @deprecated

     Deprecated

     (Since version 3.0) The execution context needs to be user-defined but you can reuse specs2 execution context by defining an example as a function ExecutionContext => AsResult[T]

132. trait NoConcurrentExecutionContext extends ConcurrentExecutionContext

     

     stack this trait to remove the implicit execution context used to evaluate features

     stack this trait to remove the implicit execution context used to evaluate features

     Annotations

     @deprecated

     Deprecated

     (Since version 3.0) The execution context needs to be user-defined but you can reuse specs2 execution context by defining an example as a function ExecutionContext => AsResult[T]