Package

org.specs2

matcher

Permalink

package matcher

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. matcher
  2. ReturnsSyntax
  3. ExpectationsCreation
  4. MatchResultStackTrace
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. trait ActionMatchers extends ValueChecks

    Permalink

    Matchers for Action values

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

    Permalink

    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

    Permalink

    This matcher always matches any value of type T

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

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

    Permalink
  6. trait AnyBeHaveMatchers extends BeHaveMatchers

    Permalink

    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

    Permalink

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

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

    Permalink
  9. class BeEqualTo extends BeTypedEqualTo[Any]

    Permalink

    Equality Matcher

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

    Permalink

    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

    Permalink

    ValueCheck for an untyped expected value.

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

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

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

    Permalink
  14. class BeMatching extends Matcher[String]

    Permalink
    Attributes
    protected[org.specs2]
  15. class BeMatchingPattern extends BeMatching

    Permalink
    Attributes
    protected[org.specs2]
  16. class BeMatchingRegex extends BeMatching

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

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

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

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

    Permalink
  21. class BeTrueMatcher extends Matcher[Boolean]

    Permalink

    Matcher for a boolean value which must be true

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

    Permalink

    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

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

    Permalink

    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

    Permalink
  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

    Permalink
  27. trait ContentMatchers extends LinesContentMatchers with FilesContentMatchers

    Permalink

    The ContentMatchers trait provides matchers to make comparisons between files, sequences,...

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

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

    Permalink
  30. trait DataTables extends ExpectationsCreation

    Permalink

    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

  31. trait DependencyBaseMatchers extends LayersAnalysis

    Permalink
  32. trait DependencyBeHaveMatchers extends BeHaveMatchers

    Permalink
  33. trait DependencyMatchers extends DependencyBaseMatchers with DependencyBeHaveMatchers

    Permalink

    The dependency matchers trait provides a way to specify the dependencies that should be verified in your project and then to check that there's no unwanted dependency in the code.

    The dependency matchers trait provides a way to specify the dependencies that should be verified in your project and then to check that there's no unwanted dependency in the code.

    It does so by:

    • specifying the dependencies as "layers" where a package name declared in one layer can only be dependent on a package name declared in a lower layer
    • using the scala compiler BuildManager class to recompile the files and get dependency analysis data

    Usage:

    layers( "package1", layer("package2", "package3", "package4"), layer("package6", "package7") ) must beRespected

  34. trait DisjunctionMatchers extends AnyRef

    Permalink

    Matchers for the \/ datatype

  35. trait EitherMatchers extends EitherBaseMatchers with EitherBeHaveMatchers

    Permalink

    Matchers for the Either datatype

  36. class EqualIgnoringSpaceMatcher extends Matcher[Seq[Node]] with XmlMatcherKoMessage

    Permalink

    Matcher for equalIgnoreSpace comparison, ignoring the nodes order

  37. class EqualIgnoringSpaceMatcherOrdered extends Matcher[Seq[Node]] with XmlMatcherKoMessage

    Permalink

    Matcher for equalIgnoreSpace comparison, considering the node order

  38. trait EventuallyMatchers extends EventuallyResults

    Permalink

    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)

  39. trait ExceptionMatchers extends ExceptionBaseMatchers with ExceptionBeHaveMatchers

    Permalink

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

  40. class Expectable[+T] extends AnyRef

    Permalink

    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.

  41. trait Expectations extends ExpectationsCreation with TypedEqual with ExpectationsDescription

    Permalink

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

  42. trait ExpectationsCreation extends MatchResultStackTrace

    Permalink

    Base trait to create expectations

  43. trait ExpectationsDescription extends ExpectationsCreation

    Permalink
  44. case class ExpectedParsedResult[+T](t: T) extends Product with Serializable

    Permalink

    This class is only used as a transient holder for the expected parsed value, to overcome overloaded method issues

  45. case class FailTypecheckMatcher(expected: String) extends Matcher[Typechecked] with Product with Serializable

    Permalink
  46. case class FailureValidationCheckedMatcher[T](check: ValueCheck[T]) extends OptionLikeCheckedMatcher[[a]Validation[a, _], T, T] with Product with Serializable

    Permalink
  47. case class FailureValidationMatcher[T]() extends OptionLikeMatcher[[a]Validation[a, _], T, T] with Product with Serializable

    Permalink
  48. trait FileMatchers extends FileBaseMatchers with FileBeHaveMatchers

    Permalink

    The FileMatchers trait provides matchers which are applicable to files

  49. trait FilesContentMatchers extends FileMatchers with LinesContentMatchers with TraversableMatchers with ExpectationsCreation

    Permalink

    This trait provides matchers to check the presence of some expected files vs the actual ones and also ways to verify the contents of these files

  50. trait FutureMatchers extends FutureBaseMatchers

    Permalink

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

  51. trait FuturezMatchers extends FuturezBaseMatchers

    Permalink

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

  52. trait Hamcrest extends AnyRef

    Permalink

    This trait adds implicit conversions to be able to use [Hamcrest matchers](http://code.google.com/p/hamcrest) as specs2 matchers.

  53. trait JUnitExpectations extends ThrownExpectations

    Permalink

    This trait throws AssertionFailed errors when a match fails.

    This trait throws AssertionFailed errors when a match fails.

    It is involved when reusing Matchers with JUnit

  54. trait JUnitMustExpectations extends MustThrownExpectations with JUnitExpectations

    Permalink

    This trait can be imported to use MustMatchers in JUnit

  55. trait JUnitMustMatchers extends Matchers with JUnitMustExpectations

    Permalink

    These traits and objects can be used in JUnit

  56. trait JUnitShouldExpectations extends ShouldThrownExpectations with JUnitExpectations

    Permalink

    This trait can be imported to use ShouldMatchers in JUnit

  57. trait JUnitShouldMatchers extends Matchers with JUnitShouldExpectations

    Permalink
  58. case class JsonArray(list: List[Any]) extends JsonType with Product with Serializable

    Permalink
  59. case class JsonBoolean(b: Boolean) extends JsonType with Product with Serializable

    Permalink
  60. case class JsonMap(map: Map[String, Any]) extends JsonType with Product with Serializable

    Permalink
  61. trait JsonMatchers extends JsonBaseMatchers with JsonBaseBeHaveMatchers

    Permalink

    Matchers for Json expressions (entered as strings)

  62. case class JsonNumber(d: Double) extends JsonType with Product with Serializable

    Permalink
  63. trait JsonSelectors extends AnyRef

    Permalink

    Different ways of selecting elements in a Json object

  64. case class JsonString(s: String) extends JsonType with Product with Serializable

    Permalink
  65. sealed trait JsonType extends AnyRef

    Permalink

    abstract JSON types for specs2

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

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

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

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

    Permalink
  70. trait LinesContentMatchers extends LinesContentBaseMatchers with LinesContentBeHaveMatchers

    Permalink
  71. class MakeMatchers[C <: Context] extends AnyRef

    Permalink
  72. trait MapMatchers extends MapBaseMatchers with MapBeHaveMatchers

    Permalink

    Matchers for Maps

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

    Permalink
  74. class MatchFailureException[T] extends FailureException with MatchResultException[T]

    Permalink

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

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

    Permalink
  76. class MatchPendingException[T] extends PendingException with MatchResultException[T]

    Permalink

    this class allows to throw a pending result in an Exception

  77. trait MatchResult[+T] extends ResultLike

    Permalink

    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

  78. trait MatchResultCombinators extends MatchResultLogicalCombinators with ResultLogicalCombinators

    Permalink

    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

  79. trait MatchResultException[T] extends AnyRef

    Permalink
  80. trait MatchResultImplicits extends AnyRef

    Permalink

    Implicit conversions for MatchResults

  81. trait MatchResultLogicalCombinators extends Expectations

    Permalink
  82. trait MatchResultStackTrace extends AnyRef

    Permalink

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

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

    Permalink
  84. class MatchSkipException[T] extends SkipException with MatchResultException[T]

    Permalink

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

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

    Permalink

    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

  86. trait Matcher[-T] extends AnyRef

    Permalink

    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.
  87. trait MatcherMacros extends AnyRef

    Permalink

    Macro definitions to generate matchers for the members of a type T

  88. trait MatcherZipOperators extends ExpectationsCreation

    Permalink

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

  89. trait MatcherZipOperatorsCodeGeneration extends AnyRef

    Permalink

    Generation code for the MatcherZipOperators trait

  90. 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

    Permalink

    Trait aggregating the most common specs2 matchers

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

    Permalink
  92. trait MatchersCreation extends AnyRef

    Permalink
  93. trait MatchersImplicits extends MatchResultCombinators with MatcherZipOperators with MatchResultImplicits with ResultImplicits with MatchersCreation with SequenceMatchersCreation

    Permalink

    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

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

    Permalink

    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

  95. trait MustExpectations extends MustExpectations1 with ExpectationsDescription with TypedEqual

    Permalink

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

  96. trait MustMatchers extends Matchers with MustExpectations

    Permalink
  97. trait MustThrownExpectations extends MustExpectations with MustThrownExpectations1

    Permalink

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

  98. trait MustThrownExpectationsCreation extends ThrownExpectationsCreation with MustExpectationsCreation

    Permalink
  99. trait MustThrownMatchers extends Matchers with MustThrownExpectations

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

    Permalink
  101. class NeutralMatcher[T] extends Matcher[T]

    Permalink

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

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

    Permalink

    This matcher never matches any value of type T

  103. trait NoExpectationsDescription extends ExpectationsDescription

    Permalink
  104. trait NoMatchResultStackTrace extends MatchResultStackTrace

    Permalink

    this trait doesn't fill-in stack traces

  105. trait NoMatcherZipOperatorsImplicits extends MatcherZipOperators

    Permalink

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

  106. trait NoMatcherZipOperatorsImplicitsCodeGeneration extends AnyRef

    Permalink

    code generation for the NoMatcherZipOperatorsImplicits trait

  107. trait NoMustExpectations extends MustExpectations

    Permalink

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

  108. trait NoShouldExpectations extends ShouldExpectations

    Permalink

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

  109. trait NoThrownExpectations extends Expectations

    Permalink

    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

  110. trait NoTypedEqual extends TypedEqual

    Permalink

    This trait can be used to suppress the TypedEqual implicit

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

    Permalink
  112. class NotMatcher[T] extends Matcher[T]

    Permalink

    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.

  113. trait NumericMatchers extends NumericBaseMatchers with NumericBeHaveMatchers

    Permalink

    Matchers for Numerical values

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

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

    Permalink
  116. trait OptionMatchers extends OptionBaseMatchers with OptionBeHaveMatchers with ValueChecks

    Permalink

    Matchers for Options

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

    Permalink
  118. class OrNotMatch[T] extends MatchResult[T]

    Permalink
  119. class OrderingMatcher[T] extends Matcher[Seq[T]]

    Permalink
  120. trait ParserMatchers extends ParserBaseMatchers with ParserBeHaveMatchers

    Permalink

    Matchers for parser combinators

    Matchers for parser combinators

    When this trait is inherited the parsers variable needs to be defined.

    by @alexey_r

  121. case class PathFunction(node: Node, function: XPathFunctions.XPathFunction, attributes: List[String] = Nil, attributeValues: Map[String, String] = Map(), exactMatch: Boolean = false, textMessage: Option[String] = None, textMatcher: Matcher[String] = AlwaysMatcher[String]()) extends (Seq[Node]) ⇒ Seq[Node] with XPathFunctions with Product with Serializable

    Permalink

    The PathFunction object encapsulate a search for a node and/or attributes or attributeValues with an XPath function If node has some children, then they are searched using equality

  122. trait PathMatchers extends PathBaseMatchers with PathBeHaveMatchers

    Permalink

    The PathMatchers trait provides matchers which are applicable to strings representing paths

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

    Permalink

    class representing a numeric range

  124. trait ProcessMatchers extends ExpectationsCreation

    Permalink

    Matchers for Process[Task, T]

  125. trait ResultImplicits extends ExpectationsCreation

    Permalink
  126. trait ResultMatchers extends ResultBaseMatchers with ResultBeHaveMatchers

    Permalink

    Matchers for Results

  127. implicit class Returns[T] extends AnyRef

    Permalink
    Definition Classes
    ReturnsSyntax
  128. trait ReturnsSyntax extends ExpectationsCreation

    Permalink

    Those definitions help specifying the result messages for matchers

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

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

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

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

    Permalink
  133. trait ScalaInterpreterMatchers extends Expectations

    Permalink
  134. trait Scope extends AnyRef

    Permalink

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

  135. trait SequenceMatchersCreation extends ExpectationsCreation with ResultImplicits

    Permalink
  136. class ShouldExpectable[T] extends Expectable[T]

    Permalink

    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

  137. trait ShouldExpectations extends Expectations

    Permalink

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

  138. trait ShouldMatchers extends Matchers with ShouldExpectations

    Permalink
  139. trait ShouldThrownExpectations extends ThrownExpectations with ShouldExpectations

    Permalink

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

  140. trait ShouldThrownMatchers extends Matchers with ShouldThrownExpectations

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

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

    Permalink
  143. class SizedCheckedMatcher[T] extends Matcher[T]

    Permalink
  144. class SizedMatcher[T] extends Matcher[T]

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

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

    Permalink
  147. trait StandardMatchResults extends ExpectationsCreation

    Permalink

    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") }

  148. trait StoredExpectations extends Expectations

    Permalink

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

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

    Permalink
  150. trait StringMatchers extends StringBaseMatchers with StringBeHaveMatchers

    Permalink

    The StringMatchers trait provides matchers which are applicable to String objects

  151. case class SuccessValidationCheckedMatcher[T](check: ValueCheck[T]) extends OptionLikeCheckedMatcher[[a]Validation[_, a], T, T] with Product with Serializable

    Permalink
  152. case class SuccessValidationMatcher[T]() extends OptionLikeMatcher[[a]Validation[_, a], T, T] with Product with Serializable

    Permalink
  153. trait TaskMatchers extends AnyRef

    Permalink

    Matchers for scalaz.concurrent.Task

  154. class TerminationMatcher[-T] extends Matcher[T]

    Permalink
  155. trait TerminationMatchers extends TerminationBaseMatchers with TerminationNotMatchers

    Permalink

    This trait provides matchers to check if a block of code is terminating or not

  156. trait ThrownExpectations extends ThrownExpectationsCreation

    Permalink

    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 } }

  157. trait ThrownExpectationsCreation extends ExpectationsCreation with StandardResults with StandardMatchResults

    Permalink

    Lightweight ThrownExpectations trait with less implicit methods

  158. trait ThrownMessages extends AnyRef

    Permalink

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

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

    Permalink

    Matchers for traversables

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

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

    Permalink
  162. trait TryMatchers extends TryBaseMatchers with TryBeHaveMatchers

    Permalink

    Matchers for util.Try instances

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

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

    Permalink
  165. trait TypecheckBeHaveMatchers extends AnyRef

    Permalink
  166. class TypecheckMatcher extends Matcher[Typechecked]

    Permalink
  167. trait TypecheckMatchers extends TypecheckBeHaveMatchers

    Permalink

    Matchers for checking if a piece of code compiles or not

  168. trait TypedEqual extends AnyRef

    Permalink

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

  169. trait ValidationMatchers extends AnyRef

    Permalink

    Matchers for the Validation datatype

  170. trait ValueCheck[T] extends AnyRef

    Permalink

    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
  171. trait ValueChecks extends ValueChecksBase

    Permalink

    implicit conversions used to create ValueChecks

  172. trait ValueChecksBase extends ValueChecksLowImplicits

    Permalink
  173. trait ValueChecksLowImplicits extends AnyRef

    Permalink
  174. trait XPathFunctions extends AnyRef

    Permalink
  175. case class XmlMatcher(functions: Seq[PathFunction]) extends Matcher[Seq[Node]] with Product with Serializable

    Permalink

    The XmlMatcher class matches an xml Node, or a list of Nodes against a list of search functions, which can either search for:

    The XmlMatcher class matches an xml Node, or a list of Nodes against a list of search functions, which can either search for:

    • a given direct child, with its label and/or attributes and/or attributes names and values
    • a given child, direct or not (maybe deeply nested), with its label and/or attributes and/or attributes names and values

    XmlMatchers can be "chained" by using the \ or the \\ methods. In that case, the resulting matcher has a new search function which tries to match the result of the preceding function. For example

     must \\("c").\("d")
    
    will be ok. must \\("c").\("d")

  176. trait XmlMatcherKoMessage extends AnyRef

    Permalink
  177. trait XmlMatchers extends XmlBaseMatchers with XmlBeHaveMatchers

    Permalink

    The XmlMatchers trait provides matchers which are applicable to xml nodes

  178. trait ConcurrentExecutionContext extends AnyRef

    Permalink

    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]

  179. trait NoConcurrentExecutionContext extends ConcurrentExecutionContext

    Permalink

    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]

Value Members

  1. object ActionMatchers extends ActionMatchers

    Permalink
  2. object AnyMatchers extends AnyMatchers

    Permalink
  3. object BeMatching

    Permalink
  4. object ContentMatchers extends ContentMatchers

    Permalink
  5. object DataTable extends Serializable

    Permalink
  6. object DataTableRow extends Serializable

    Permalink
  7. object DisjunctionMatchers extends DisjunctionMatchers

    Permalink
  8. object EitherMatchers extends EitherMatchers

    Permalink
  9. object EventuallyMatchers extends EventuallyMatchers

    Permalink
  10. object ExceptionMatchers extends ExceptionMatchers

    Permalink
  11. object Expectable

    Permalink

    Factory methods for creating Expectables

  12. object Expectations extends Expectations

    Permalink
  13. object ExpectationsDescription extends ExpectationsDescription

    Permalink
  14. object ExpectedParsedResult extends Serializable

    Permalink
  15. object FileMatchers extends FileMatchers

    Permalink
  16. object FutureMatchers extends FutureMatchers

    Permalink
  17. object FuturezMatchers extends FuturezMatchers

    Permalink
  18. object Hamcrest extends Hamcrest

    Permalink
  19. object JUnitMustExpectations extends JUnitMustExpectations

    Permalink
  20. object JUnitMustMatchers extends JUnitMustMatchers with NoMatchResultStackTrace

    Permalink
  21. object JUnitShouldExpectations extends JUnitShouldExpectations

    Permalink
  22. object JUnitShouldMatchers extends JUnitShouldMatchers with NoMatchResultStackTrace

    Permalink
  23. object JsonNull extends JsonType with Product with Serializable

    Permalink
  24. object JsonType

    Permalink
  25. object LinesContentMatchers extends LinesContentMatchers

    Permalink
  26. object MapMatchers extends MapMatchers

    Permalink
  27. object MatchFailure extends Serializable

    Permalink
  28. object MatchFailureException extends Serializable

    Permalink
  29. object MatchPendingException extends Serializable

    Permalink
  30. object MatchResult

    Permalink

    Utility functions for MatchResult.

    Utility functions for MatchResult.

    A MatchResult is a Functor where the fmap function acts on the embedded Expectable value (which itself is a Functor)

  31. object MatchResultCombinators extends MatchResultCombinators

    Permalink
  32. object MatchResultImplicits extends MatchResultImplicits

    Permalink
  33. object MatchResultLogicalCombinators extends MatchResultLogicalCombinators

    Permalink
  34. object MatchSkipException extends Serializable

    Permalink
  35. object MatchSuccess extends Serializable

    Permalink
  36. object Matcher

    Permalink
  37. object MatcherMacros extends MatcherMacros

    Permalink

    Macros implementations

    Macros implementations

    The bulk of the implementation is credited to:

    - @travisbrown for his ["vampire methods"](http://meta.plasm.us/posts/2013/08/31/feeding-our-vampires/) - @retronym for his help on [range positions](https://groups.google.com/forum/#!topic/scala-internals/fmWKw5TDz98) - @xeno_by for his help on macros in general!

  38. object MatcherZipOperators extends MatcherZipOperators

    Permalink
  39. object Matchers extends Matchers

    Permalink
  40. object MatchersCreation extends MatchersCreation

    Permalink
  41. object MatchersImplicits extends MatchersImplicits

    Permalink
  42. object MustExpectable

    Permalink
  43. object MustExpectations extends MustExpectations

    Permalink
  44. object MustMatchers extends MustMatchers with NoMatchResultStackTrace

    Permalink
  45. object MustThrownExpectations extends MustThrownExpectations

    Permalink
  46. object MustThrownMatchers extends MustThrownMatchers with NoMatchResultStackTrace

    Permalink
  47. object NumericMatchers extends NumericMatchers

    Permalink
  48. object OptionMatchers extends OptionMatchers

    Permalink
  49. object PathMatchers extends PathMatchers

    Permalink
  50. object ResultImplicits extends ResultImplicits

    Permalink
  51. object ResultMatchers extends ResultMatchers

    Permalink
  52. object ReturnsSyntax extends ReturnsSyntax with Expectations

    Permalink
  53. object Scope

    Permalink
  54. object SequenceMatchersCreation extends SequenceMatchersCreation

    Permalink
  55. object ShouldExpectable

    Permalink
  56. object ShouldExpectations extends ShouldExpectations

    Permalink
  57. object ShouldMatchers extends ShouldMatchers with NoMatchResultStackTrace

    Permalink
  58. object ShouldThrownExpectations extends ShouldThrownExpectations

    Permalink
  59. object ShouldThrownMatchers extends ShouldThrownMatchers with NoMatchResultStackTrace

    Permalink
  60. object StandardMatchResults extends StandardMatchResults

    Permalink
  61. object StringMatchers extends StringMatchers

    Permalink
  62. object TaskMatchers extends TaskMatchers

    Permalink
  63. object TerminationMatchers extends TerminationMatchers

    Permalink
  64. object TraversableMatchers extends TraversableMatchers

    Permalink
  65. object TryMatchers extends TryMatchers

    Permalink
  66. object TypecheckMatchers extends TypecheckMatchers

    Permalink
  67. object TypedEqual extends ExpectationsCreation

    Permalink
  68. object ValidationMatchers extends ValidationMatchers

    Permalink
  69. object ValueCheck

    Permalink
  70. object ValueChecks extends ValueChecks

    Permalink
  71. object XmlMatchers extends XmlMatchers

    Permalink
  72. def checkFailure[T](m: MatchResult[T]): MatchResult[T]

    Permalink

    this method can be overridden to throw exceptions when checking the match result

    this method can be overridden to throw exceptions when checking the match result

    Attributes
    protected
    Definition Classes
    ExpectationsCreation
  73. def checkMatchResultFailure[T](m: MatchResult[T]): MatchResult[T]

    Permalink

    this method can be overridden to throw exceptions when checking the match result

    this method can be overridden to throw exceptions when checking the match result

    Attributes
    protected
    Definition Classes
    ExpectationsCreation
  74. def checkResultFailure(r: ⇒ Result): Result

    Permalink

    this method can be overridden to throw exceptions when checking the result

    this method can be overridden to throw exceptions when checking the result

    Attributes
    protected
    Definition Classes
    ExpectationsCreation
  75. def createExpectable[T](t: ⇒ T, alias: Option[(String) ⇒ String]): Expectable[T]

    Permalink

    returns

    an Expectable with a description function

    Definition Classes
    ExpectationsCreation
  76. def createExpectable[T](t: ⇒ T, alias: (String) ⇒ String): Expectable[T]

    Permalink

    returns

    an Expectable with a description function

    Definition Classes
    ExpectationsCreation
  77. def createExpectable[T](t: ⇒ T, alias: ⇒ String): Expectable[T]

    Permalink

    returns

    an Expectable with a description

    Definition Classes
    ExpectationsCreation
  78. def createExpectable[T](t: ⇒ T): Expectable[T]

    Permalink

    returns

    an Expectable

    Definition Classes
    ExpectationsCreation
  79. def createExpectableWithShowAs[T](t: ⇒ T, showAs: ⇒ String): Expectable[T]

    Permalink

    returns

    an Expectable with a function to show the element T

    Definition Classes
    ExpectationsCreation
  80. def mapMatchResult[T](m: MatchResult[T]): MatchResult[T]

    Permalink

    this method can be overridden to intercept a MatchResult and change its message before it is thrown

    this method can be overridden to intercept a MatchResult and change its message before it is thrown

    Attributes
    protected
    Definition Classes
    ExpectationsCreation
  81. def sandboxMatchResult[T](mr: ⇒ MatchResult[T]): MatchResult[T]

    Permalink

    returns

    the match result without any side-effects

    Attributes
    protected
    Definition Classes
    ExpectationsCreation
  82. def setStacktrace[T](m: MatchResult[T]): MatchResult[T]

    Permalink

    this method can be overridden to avoid filling-in a stacktrace indicating the location of the result

    this method can be overridden to avoid filling-in a stacktrace indicating the location of the result

    Attributes
    protected
    Definition Classes
    MatchResultStackTrace

Inherited from ReturnsSyntax

Inherited from ExpectationsCreation

Inherited from MatchResultStackTrace

Inherited from AnyRef

Inherited from Any

Ungrouped