transient class to hold an example description before creating a full Example
transient class to hold an example description before creating a full Example
This class creates Given or Then extractors from a regular expression and a function
at any point in time a regex sequence can be transformed as a sequence of Fragments
shorthand method to create an Arguments object
shorthand method to create an Arguments object
Arguments creation
Arguments creation
a Fragments object which can be chained with other fragments
implicit conversion to transform a Given[Y] to Given[X] when Y <: X
This implicit allows to use the "so" object:
This implicit allows to use the "so" object:
"given the name: ${eric}, then the age is ${18}" ! so { case (name: String, age: String) => age.toInt must_== 18 }
an Example description from a string, to create a full Example once the body is defined
add a tagging section with special tag names specifying the formatting options
add a tagging section with special tag names specifying the formatting options
add a tag with special tag names specifying the formatting options
add a tag with special tag names specifying the formatting options
a Fragments object from a single Fragment
reverse conversion from a Fragment containing a Fragments object to the Fragments object
reverse conversion from a Fragment containing a Fragments object to the Fragments object
factory method to create a Given or a Then element from a regex, using a regex denoting groups to extract
factory method to create a Given or a Then element from a regex, using a regex denoting groups to extract
transform a scope to a success to be able to create traits containing any variables and usable in any Examples
transform a scope to a success to be able to create traits containing any variables and usable in any Examples
create a link directly on a specification, with a given link
create a link directly on a specification, with a given link
create a link directly on a specification
create a link directly on a specification
factory method to create a Given or a Then element from a regex
factory method to create a Given or a Then element from a regex
based on the interpolated variables and the expressions captured with the macro, create the appropriate fragments
based on the interpolated variables and the expressions captured with the macro, create the appropriate fragments
if the Yrangepos scalac option is not set then we use an approximated method to find the expressions texts
typeclass to transform a Scope to a Result
typeclass to transform a Scope to a Result
create a AsSection fragment
create a AsSection fragment
create a see-only link directly on a specification, with a given link
create a see-only link directly on a specification, with a given link
create a html link without including the other specification fragments
create a html link without including the other specification fragments
create markdown links from string + spec identification
create markdown links from string + spec identification
this implicit allows to call some functions directly on a specification, like 'hide'
this implicit allows to call some functions directly on a specification, like 'hide'
Links to other specifications creation
Links to other specifications creation
org.specs2.UserGuide
create a TaggedAs fragment
create a TaggedAs fragment
create a Text Fragment from a string and allow it to be chained to other fragments
a Fragments object from a string
This method allows to add a title to the Specification.
This method allows to add a title to the Specification. It can be used as an operation on a String:
"spec title".title
a Fragments object from a string, with the given title
implicit conversion to transform a Then[Y] to Then[X] when Y <: X
implicit conversion to transform a When[P, Q] to When[R, S] when R <: P and S >: Q
This trait provides building blocks to create steps and examples from regular expression.
It is used to implement a Given-When-Then way of describing systems.
Fragments are created by adding a
Given
step to aText
:"name: ${user}" ^ givenName
This creates a PreStep object containing the current context (representing all the extracted values) and a list of Fragments containing:
Text("name: ${user}")
${}
Then, this PreStep object can be followed by another piece of Text to create a PreStepText object. This object merely stores the additional Text fragment so that values can be extracted from it when a
When
step is added:Eventually, when a
Then
step is added, a sequence of PostStep/PostStepText objects is created. Those objects use the current context and the results returned by theThen
objects to create Examples.The last PostStep object contains the list of all fragments created by the Given/When/Then sequence: