specs2-form/org.specs2.specification/Forms

Forms

object Forms extends Forms
Companion:
class
trait Forms
trait FormDsl
trait FragmentsDsl
trait ActionDsl
trait TagDsl
trait ReferenceCreation
trait SpecStructureDsl
trait S2StringContext
trait S2StringContextCreation
trait FragmentsFactory
class Object
trait Matchable
class Any
Forms.type

Type members

Inherited classlikes

trait ToFragments[T]
Inherited from:
FragmentsDsl
trait ToSpecStructure[T1, T2]
Inherited from:
SpecStructureDsl
implicit class appendFragments[T1, T2](t1: T1)(using evidence$1: ToFragments[T1], evidence$2: ToFragments[T2])
Inherited from:
FragmentsDsl
implicit class appendSpecStructure[T1, T2](t1: T1)(using tss: ToSpecStructure[T1, T2])
Inherited from:
SpecStructureDsl
implicit class decorate[T <: DecoratedProperty[T]](d: T)
object given_Conversion_Effect_EffectCell extends Conversion[Effect[_], EffectCell]

a Effect can be added on a Form row as a EffectCell

a Effect can be added on a Form row as a EffectCell

Inherited from:
FormsBuilder (hidden)
object given_Conversion_Form_Result extends Conversion[Form, Result]

a Form can be implicitly executed if necessary

a Form can be implicitly executed if necessary

Inherited from:
FormsBuilder (hidden)
object given_Conversion_Fragment_SpecStructure extends Conversion[Fragment, SpecStructure]
Inherited from:
SpecStructureDsl
object given_Conversion_Fragments_Interpolated extends Conversion[Fragments, Interpolated]
Inherited from:
S2StringContext
object given_Conversion_SpecHeader_SpecStructure extends Conversion[SpecHeader, SpecStructure]
Inherited from:
SpecStructureDsl
object given_Conversion_SpecStructure_Fragments extends Conversion[SpecStructure, Fragments]
Inherited from:
SpecStructureDsl
object given_Conversion_SpecStructure_Interpolated extends Conversion[SpecStructure, Interpolated]
Inherited from:
S2StringContext
object given_Conversion_SpecificationRef_Interpolated extends Conversion[SpecificationRef, Interpolated]
Inherited from:
S2StringContext
object given_Conversion_SpecificationStructure_Interpolated extends Conversion[SpecificationStructure, Interpolated]
Inherited from:
S2StringContext
object given_Conversion_String_SpecStructure extends Conversion[String, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToFragments_Fragment extends ToFragments[Fragment]
Inherited from:
FragmentsDsl
object given_ToFragments_Fragments extends ToFragments[Fragments]
Inherited from:
FragmentsDsl
object given_ToFragments_Seq extends ToFragments[Seq[Fragment]]
Inherited from:
FragmentsDsl
object given_ToFragments_String extends ToFragments[String]
Inherited from:
FragmentsDsl
object given_ToSpecStructure_Arguments_Arguments extends ToSpecStructure[Arguments, Arguments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_Fragment extends ToSpecStructure[Arguments, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_Fragments extends ToSpecStructure[Arguments, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_SpecHeader extends ToSpecStructure[Arguments, SpecHeader]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_SpecStructure extends ToSpecStructure[Arguments, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_String extends ToSpecStructure[Arguments, String]

APPENDING TO ARGUMENTS

APPENDING TO ARGUMENTS

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_Arguments extends ToSpecStructure[Fragment, Arguments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_Fragment extends ToSpecStructure[Fragment, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_Fragments extends ToSpecStructure[Fragment, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_SpecStructure extends ToSpecStructure[Fragment, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_String extends ToSpecStructure[Fragment, String]

APPENDING TO A FRAGMENT

APPENDING TO A FRAGMENT

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragments_Fragment extends ToSpecStructure[Fragments, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragments_Fragments extends ToSpecStructure[Fragments, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragments_String extends ToSpecStructure[Fragments, String]

APPENDING TO FRAGMENTS

APPENDING TO FRAGMENTS

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_Arguments extends ToSpecStructure[SpecHeader, Arguments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_Fragment extends ToSpecStructure[SpecHeader, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_Fragments extends ToSpecStructure[SpecHeader, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_Seq extends ToSpecStructure[SpecHeader, Seq[Fragment]]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_SpecStructure extends ToSpecStructure[SpecHeader, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_String extends ToSpecStructure[SpecHeader, String]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_Arguments extends ToSpecStructure[SpecStructure, Arguments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_Fragment extends ToSpecStructure[SpecStructure, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_Fragments extends ToSpecStructure[SpecStructure, Fragments]

APPENDING TO A SPEC STRUCTURE

APPENDING TO A SPEC STRUCTURE

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_Seq extends ToSpecStructure[SpecStructure, Seq[Fragment]]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_SpecStructure extends ToSpecStructure[SpecStructure, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_String extends ToSpecStructure[SpecStructure, String]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_String_Fragment extends ToSpecStructure[String, Fragment]

APPENDING TO A STRING

APPENDING TO A STRING

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_String_Fragments extends ToSpecStructure[String, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_String_SpecStructure extends ToSpecStructure[String, SpecStructure]
Inherited from:
SpecStructureDsl

Value members

Inherited methods

def action[T](a: => T)(using evidence$3: AsExecution[T]): Fragment
Inherited from:
ActionDsl
def action[T](label: String, a: => T): Prop[T, T]
Returns:

a new Prop with a label, which has the same actual and expected value to test the result of an action

Inherited from:
FormsBuilder (hidden)
def effect[T](label: String, value: => T): Effect[T]
Returns:

a new Effect with a label and a value

Inherited from:
FormsBuilder (hidden)
def field(label: String, value1: Field[_], values: Field[_]*): Field[String]
Returns:

a new Field with a label and several values

Inherited from:
FormsBuilder (hidden)
def field[T](label: String, value: => T): Field[T]
Returns:

a new Field with a label and a value

Inherited from:
FormsBuilder (hidden)
def field[T](value: => T): Field[T]
Returns:

a new Field with no label and a value

Inherited from:
FormsBuilder (hidden)
def form(title: String): Form
Returns:

a new Form with the given title

Inherited from:
FormsBuilder (hidden)
protected def fragmentFactory: FragmentFactory
Inherited from:
FragmentsFactory
def fragmentsBlock(fragments: Seq[Fragment], offset: Int): Fragments

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

Inherited from:
FragmentsDsl
def lazify(c: => Cell): LazyCell

a cell can be added lazily to a row. It will only be evaluated when necessary

a cell can be added lazily to a row. It will only be evaluated when necessary

Inherited from:
FormsBuilder (hidden)
def postProcessS2Fragments(fs: Fragments): Fragments

this function is exposed so that it can be overridden with side-effects when using s2 strings in mutable specs

this function is exposed so that it can be overridden with side-effects when using s2 strings in mutable specs

Inherited from:
S2StringContextCreation
def prop[T, S](label: String, actual: => T, expected: => S, c: Matcher[T]): Prop[T, S]
Returns:

a new Prop with a label, an actual value and a matcher to apply to the actual value

Inherited from:
FormsBuilder (hidden)
def prop[T](actual: => T, c: Matcher[T]): Prop[T, T]
Returns:

a new Prop with no label, an actual value and a matcher to apply to the actual value

Inherited from:
FormsBuilder (hidden)
def prop[T](label: String, actual: => T, c: Matcher[T]): Prop[T, T]
Returns:

a new Prop with a label, an actual value and a matcher to apply to the actual value

Inherited from:
FormsBuilder (hidden)
def prop[T, S](label: String, actual: => T, c: S => Matcher[T]): Prop[T, S]
Returns:

a new Prop with a label, an actual value and a matcher to apply to values

Inherited from:
FormsBuilder (hidden)
def prop[T, S, R](label: String, actual: => T, c: (T, S) => R)(using evidence$2: AsResult[R]): Prop[T, S]
Returns:

a new Prop with a label, an actual value and a constraint to apply to values

Inherited from:
FormsBuilder (hidden)
def prop[T, S](label: String, actual: => T, exp: => S): Prop[T, S]
Returns:

a new Prop with a label, an actual value and expected value

Inherited from:
FormsBuilder (hidden)
def prop[T](label: String, actual: => T): Prop[T, T]
Returns:

a new Prop with a label and an actual value only

Inherited from:
FormsBuilder (hidden)
def prop[T](act: => T): Prop[T, T]
Returns:

a new Prop with an actual value only

Inherited from:
FormsBuilder (hidden)
def section(tag: NamedTag): Fragment
Inherited from:
TagDsl
def section(names: String*): Fragment
Inherited from:
TagDsl
def see(s: => SpecificationStructure): Fragment
Inherited from:
ReferenceCreation
def see(s: SpecStructure): Fragment
Inherited from:
ReferenceCreation
def step[T](a: => T, global: Boolean)(using evidence$2: AsExecution[T]): Fragment
Inherited from:
ActionDsl
def step[T](a: => T)(using evidence$1: AsExecution[T]): Fragment
Inherited from:
ActionDsl
def tab(label: String, form: Form): Tabs
Returns:

a new Tabs object with a first tab

Inherited from:
FormsBuilder (hidden)
def tabs: Tabs
Returns:

a new Tabs object

Inherited from:
FormsBuilder (hidden)
def tag(tag: NamedTag): Fragment
Inherited from:
TagDsl
def tag(names: String*): Fragment
Inherited from:
TagDsl

Givens

Inherited givens

given appendFormToString[T](using evidence$3: HasForm[T]): appendFormToString[T]
Inherited from:
FormDsl
given given_Conversion_Effect_EffectCell: given_Conversion_Effect_EffectCell.type

a Effect can be added on a Form row as a EffectCell

a Effect can be added on a Form row as a EffectCell

Inherited from:
FormsBuilder (hidden)
given given_Conversion_Field_FieldCell[T]: given_Conversion_Field_FieldCell[T]

a Field can be added on a Form row as a FieldCell

a Field can be added on a Form row as a FieldCell

Inherited from:
FormsBuilder (hidden)
given given_Conversion_Form_Result: given_Conversion_Form_Result.type

a Form can be implicitly executed if necessary

a Form can be implicitly executed if necessary

Inherited from:
FormsBuilder (hidden)
given given_Conversion_Prop_PropCell[T, S]: given_Conversion_Prop_PropCell[T, S]

a Prop can be added on a Form row as a PropCell

a Prop can be added on a Form row as a PropCell

Inherited from:
FormsBuilder (hidden)
given given_Conversion_Seq_Seq[T](using evidence$1: ToCell[T]): given_Conversion_Seq_Seq[T]

any seq of object convertible to cells

any seq of object convertible to cells

Inherited from:
FormsBuilder (hidden)
given given_Conversion_T_Interpolated[T](using evidence$1: HasForm[T]): given_Conversion_T_Interpolated[T]
Inherited from:
FormS2StringContext
given given_FragmentFactory: FragmentFactory

The FragmentFactory has to be passed as an implicit in order to be inlined in macros

The FragmentFactory has to be passed as an implicit in order to be inlined in macros

Inherited from:
S2StringContextCreation
given given_ToFragments_Fragment: given_ToFragments_Fragment.type
Inherited from:
FragmentsDsl
given given_ToFragments_Fragments: given_ToFragments_Fragments.type
Inherited from:
FragmentsDsl
given given_ToFragments_Seq: given_ToFragments_Seq.type
Inherited from:
FragmentsDsl
given given_ToFragments_String: given_ToFragments_String.type
Inherited from:
FragmentsDsl
given given_ToFragments_T[T](using evidence$1: HasForm[T]): given_ToFragments_T[T]
Inherited from:
FormDsl
given given_ToSpecStructure_Arguments_String: given_ToSpecStructure_Arguments_String.type

APPENDING TO ARGUMENTS

APPENDING TO ARGUMENTS

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Arguments_T[T <: SpecificationStructure]: given_ToSpecStructure_Arguments_T[T]
Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Fragment_String: given_ToSpecStructure_Fragment_String.type

APPENDING TO A FRAGMENT

APPENDING TO A FRAGMENT

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Fragment_T[T <: SpecificationStructure]: given_ToSpecStructure_Fragment_T[T]
Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Fragments_String: given_ToSpecStructure_Fragments_String.type

APPENDING TO FRAGMENTS

APPENDING TO FRAGMENTS

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_T[T <: SpecificationStructure]: given_ToSpecStructure_SpecHeader_T[T]

APPENDING TO A SPEC HEADER

APPENDING TO A SPEC HEADER

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_Fragments: given_ToSpecStructure_SpecStructure_Fragments.type

APPENDING TO A SPEC STRUCTURE

APPENDING TO A SPEC STRUCTURE

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_T[T <: SpecificationStructure]: given_ToSpecStructure_SpecStructure_T[T]
Inherited from:
SpecStructureDsl
given given_ToSpecStructure_String_Fragment: given_ToSpecStructure_String_Fragment.type

APPENDING TO A STRING

APPENDING TO A STRING

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_String_T[T <: SpecificationStructure]: given_ToSpecStructure_String_T[T]
Inherited from:
SpecStructureDsl
given given_ToSpecStructure_T_T2[T, T2](using evidence$2: HasForm[T], x$1: ToSpecStructure[T2, Fragment]): given_ToSpecStructure_T_T2[T, T2]
Inherited from:
FormDsl

Extensions

Inherited extensions

extension (fragment: Fragment)
def hide: Fragment
Inherited from:
FragmentsDsl
extension (fragment: Fragment)
def mute: Fragment
Inherited from:
FragmentsDsl
extension [T](p: Prop[T, T])
infix def must(m: Matcher[T]): Prop[T, T]

check the actual value with a matcher

check the actual value with a matcher

Inherited from:
PropSyntax
extension [T, R](p: Prop[T, T])
def checkWith(f: T => R)(using evidence$2: AsResult[R]): Prop[T, T]

check the actual value with a function

check the actual value with a function

Inherited from:
PropSyntax
extension (sc: StringContext)
inline def s2(using factory: FragmentFactory)(inline variables: Interpolated*): Fragments

String interpolation for specs2 fragments

String interpolation for specs2 fragments

Inherited from:
S2StringContextCreation
extension [T1, T2](t1: T1)
def ^(t2: => T2)(using tss: ToSpecStructure[T1, T2]): SpecStructure
Inherited from:
SpecStructureDsl

Implicits

Inherited implicits

implicit def anyIsField[T](t: => T): Field[T]

anything can be added on a Form row as a Field

anything can be added on a Form row as a Field

Inherited from:
FormsBuilderLowPriorityImplicits
implicit def anyIsFieldCell(t: => Any): FieldCell

anything can be added on a Form row as a TextCell

anything can be added on a Form row as a TextCell

Inherited from:
FormsBuilderLowPriorityImplicits
final implicit def appendFragments[T1, T2](t1: T1)(using evidence$1: ToFragments[T1], evidence$2: ToFragments[T2]): appendFragments[T1, T2]
Inherited from:
FragmentsDsl
final implicit def appendSpecStructure[T1, T2](t1: T1)(using tss: ToSpecStructure[T1, T2]): appendSpecStructure[T1, T2]
Inherited from:
SpecStructureDsl
implicit inline def asExecutionIsInterpolated[R](inline r: => R)(using evidence$1: AsExecution[R], inline factory: FragmentFactory): Interpolated

create an example based on an execution

create an example based on an execution

Inherited from:
S2StringContext
implicit inline def asResultIsInterpolated[R](inline r: => R)(using evidence$3: AsResult[R]): Interpolated
Inherited from:
S2StringContext1 (hidden)
final implicit def decorate[T <: DecoratedProperty[LazyRef(...)]](d: T): decorate[T]
Inherited from:
DecoratedProperties (hidden)
implicit def formIsCell(t: => Form): FormCell

a Form can be added on a Form row as a FormCell

a Form can be added on a Form row as a FormCell

Inherited from:
FormsBuilderLowPriorityImplicits
implicit def formIsInterpolated(f: => Form): Interpolated
Inherited from:
FormS2StringContext
implicit inline def fragmentIsInterpolated(inline f: => Fragment): Interpolated
Inherited from:
S2StringContext1 (hidden)
implicit def fragmentsAsSpecStructure(fs: => Fragments): SpecStructure
Inherited from:
SpecStructureDsl
implicit def resultAsSpecStructure[R](r: => R)(using evidence$1: AsResult[R]): SpecStructure
Inherited from:
SpecStructureDsl
implicit inline def stepParserIsInterpolatedFragment[R](f: StepParser[R])(using evidence$4: AsResult[R]): Interpolated
Inherited from:
S2StringContext1 (hidden)
implicit def stringIsInterpolated(s: => String): Interpolated
Inherited from:
S2StringContext
implicit inline def stringResultIsInterpolated[R](inline f: String => R)(using evidence$2: AsResult[R]): Interpolated
Inherited from:
S2StringContext1 (hidden)
implicit def xmlIsACell(xml: => NodeSeq): XmlCell

any xml can be injected as a cell

any xml can be injected as a cell

Inherited from:
FormsBuilderLowPriorityImplicits