execute

Type Members

1. class AnyValueAsResult[T] extends AsResult[T]

   

   Type class to transform any value to a Result

2. trait AsResult[T] extends AnyRef

   

   Typeclass trait for anything that can be transformed to a Result

3. case class DecoratedResult[+T](decorator: T, result: Result) extends Result with Product with Serializable

   

   This result allows to embed additional data with a given result for further display

   This result allows to embed additional data with a given result for further display

   Is is used to provide a way to display properly the data tables in the HtmlExporter

4. case class DecoratedResultException(result: DecoratedResult[_]) extends Exception with Product with Serializable

   

   this class allows to throw a result that's decorated with additional information in an Exception

5. sealed trait Details extends AnyRef

   

   Trait to model detailed information for failures so that smart differences can be computed

6. case class Error(m: String, e: Exception) extends Result with ResultStackTrace with Product with Serializable

   

   This class represents an exception occurring during an execution.

7. case class ErrorException(f: Error) extends Exception with Product with Serializable

   

   this class allows to throw an Error result in an Exception

8. trait EventuallyResults extends AnyRef

   

   This trait adds the possibility to retry a given value, convertible to a result, until it succeeds.

   This trait adds the possibility to retry a given value, convertible to a result, until it succeeds.

   This was adapted from a contribution by @robey (http://robey.lag.net)

9. trait Executable extends AnyRef

   

   Trait for anything that can be executed to return a Result

10. case class Failure(m: String = "", e: String = "", stackTrace: List[StackTraceElement] = ..., details: Details = NoDetails) extends Result with ResultStackTrace with Product with Serializable

    

    This class represents the failure of an execution.

    This class represents the failure of an execution. It has a message and a stacktrace

11. case class FailureDetails(actual: String, expected: String) extends Details with Product with Serializable

    

12. case class FailureException(f: Failure) extends Exception with Product with Serializable

    

    this class allows to throw a failure result in an Exception

13. case class FailureMapDetails(actual: Map[Any, Any], expected: Map[Any, Any]) extends Details with Product with Serializable

    

14. case class FailureSeqDetails(actual: Seq[Any], expected: Seq[Any]) extends Details with Product with Serializable

    

15. case class FailureSetDetails(actual: Set[Any], expected: Set[Any]) extends Details with Product with Serializable

    

16. class Function0Result extends AnyRef

    

    This class is used to delay the execution of a result

17. trait Isolable extends AnyRef

    

    This trait models elements which can be executed in a brand new context with new local variables It is used to execute examples in a new specification when needed

18. trait NoPendingUntilFixed extends PendingUntilFixed

    

    use this trait to remove the pending until fixed implicit conversion

19. case class Pending(m: String = "") extends Result with Product with Serializable

    

    Pending result

    Pending result

    See also

    Result for description

20. case class PendingException(f: Pending) extends Exception with Product with Serializable

    

    this class allows to throw a pending result in an Exception

21. trait PendingUntilFixed extends AnyRef

    

    This function allows to mark the body of an example as pending until it is fixed.

    This function allows to mark the body of an example as pending until it is fixed.

    If the result becomes a success then it is reported as a Failure so that the user thinks of removing the marker

22. sealed abstract class Result extends AnyRef

    

    The result of an execution, either:

    The result of an execution, either:

    • a success: the execution is ok
    • a failure: an expectation is not met
    • an error: an exception occurred
    • a pending execution: the user has decided that execution must not be performed
    • a skipped execution: based on dynamic conditions (a database not available for instance) the execution is not performed

    A Result has:

    • a message describing the outcome
    • a message describing the expectation
    • possibly a number of expectations when it is the outcome of several checks (this is used for the reporting of ScalaCheck properties).

23. trait ResultExecution extends AnyRef

    

    This trait executes a Result and returns an appropriate value when a specs2 exception is thrown

24. trait ResultImplicits extends AnyRef

    

    This trait adds some implicits to easily fold sequences of results

25. trait ResultLike extends AnyRef

    

    This trait can be used for anything that can be converted to a Result.

    This trait can be used for anything that can be converted to a Result.

    It is used by the MatchResult class so it can be executed as any other kind of Result by the ResultExecution class without introducing a dependency between the execute and the matcher package

26. trait ResultStackTrace extends HasStackTrace

    

    The stacktrace for a Result

27. trait Results extends AnyRef

    

28. case class ScissorsCutter(cutMarker: String = scissorsMarker, cutMarkerFormat: String = scissorsMarkerFormat) extends (String) ⇒ String with Product with Serializable

    

    Implementation of a function to cut pieces of code by using some comments as markers

29. case class SkipException(f: Skipped) extends Exception with Product with Serializable

    

    this class allows to throw a skipped result in an Exception

30. case class Skipped(m: String = "", e: String = "") extends Result with Product with Serializable

    

    Skipped result

    Skipped result

    See also

    Result for description

31. case class Snippet[T](code: () ⇒ T, codeExpression: Option[String] = None, params: SnippetParams[T] = SnippetParams[T]()) extends Product with Serializable

    

    Captured snippet of code with: a value of type T, a string representing the expression, captured by a macro, some evaluation and display parameters

32. case class SnippetParams[T](trimExpression: (String) ⇒ String = trimApproximatedSnippet, cutter: (String) ⇒ String = ScissorsCutter(), asCode: (String, String) ⇒ String = markdownCode(offset = 0), prompt: (String) ⇒ String = greaterThanPrompt, evalCode: Boolean = false, verify: Option[(T) ⇒ Result] = None) extends Product with Serializable

    

    Evaluation and display parameters for a Snippet.

    Evaluation and display parameters for a Snippet.

    It is possible to change:

    • the function that's trimming the expression from newlines or accolades
    • the cutter function to remove part which must not be shown
    • the asCode function to render the resulting text
    • the prompt function to possibly display the evaluated result with a prompt
    • the eval boolean indicating if a snippet must be evaluated
    • the verify function checking the result

33. trait Snippets extends AnyRef

    

    Snippets of code can be extracted from interpolated specification strings.

    Snippets of code can be extracted from interpolated specification strings.

    When you want to specify that a piece of code must be included in the specification output, you can use the snippet method to execute a this code and use the text in the output. If you just want to output part of the code you need to delimit it with some comments // 8<------- (with as many dashes >= 2 as you want)

    Generally the value of a snippet will not be evaluated nor displayed but it is possible to show it using the eval method on a Snippet.

    It is also possible to check that the result value is correct by using the check method.

34. trait StandardResults extends AnyRef

    

    This trait provides standard results which can be used in Fragments bodies

35. case class Success(m: String = "", exp: String = "") extends Result with Product with Serializable

    

    This class represents the success of an execution