specs2-form/org.specs2.specification/Forms

Forms

trait Forms extends FormsBuilder with FormFragmentsFactory with DecoratedProperties with FormS2StringContext with FormDsl with PropSyntax

Allow a Form to be inserted among Fragments as a Text Fragment Allow a Form to be used as an example body and return a Result automatically

Companion
object
trait FormDsl
trait FragmentsDsl
trait AcceptanceDsl1
trait ActionDsl
trait TagDsl
trait ReferenceCreation
trait SpecStructureDsl
trait S2StringContext
trait S2StringContext1
trait S2StringContextCreation
trait FragmentsFactory
trait DecoratedProperties
trait FormsBuilder
class Object
trait Matchable
class Any
object Forms

Type members

Inherited classlikes

trait ToFragments[T]
Inherited from
FragmentsDsl
trait ToSpecStructure[T1, T2]
Inherited from
SpecStructureDsl
class appendFragments[T1, T2](t1: T1)(using evidence$1: ToFragments[T1], evidence$2: ToFragments[T2])
Inherited from
FragmentsDsl
class appendSpecStructure[T1, T2](t1: T1)(using tss: ToSpecStructure[T1, T2])
Inherited from
SpecStructureDsl
class decorate[T <: DecoratedProperty[T]](d: T)
Inherited from
DecoratedProperties

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
def effect[T](label: String, value: => T): Effect[T]
Returns

a new Effect with a label and a value

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

a new Field with a label and several values

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

a new Field with a label and a value

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

a new Field with no label and a value

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

a new Form with the given title

Inherited from
FormsBuilder
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
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
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
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
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
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
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
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
def prop[T](act: => T): Prop[T, T]
Returns

a new Prop with an actual value only

Inherited from
FormsBuilder
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
def tabs: Tabs
Returns

a new Tabs object

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

Inherited fields

final lazy val 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

Givens

Inherited givens

given appendFormToString[T]: ToSpecStructure[String, T]
Inherited from
FormDsl
given given_Conversion_Effect_EffectCell: 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
given given_Conversion_Field_FieldCell[T]: Conversion[Field[T], FieldCell]

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
given given_Conversion_Form_Result: Conversion[Form, Result]

a Form can be implicitly executed if necessary

a Form can be implicitly executed if necessary

Inherited from
FormsBuilder
given given_Conversion_Fragment_SpecStructure: Conversion[Fragment, SpecStructure]
Inherited from
SpecStructureDsl
given given_Conversion_Fragments_Interpolated: Conversion[Fragments, Interpolated]
Inherited from
S2StringContext
given given_Conversion_Prop_PropCell[T, S]: Conversion[Prop[T, S], PropCell]

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
given given_Conversion_Seq_Seq[T]: Conversion[Seq[T], Seq[Cell]]

any seq of object convertible to cells

any seq of object convertible to cells

Inherited from
FormsBuilder
given given_Conversion_SpecHeader_SpecStructure: Conversion[SpecHeader, SpecStructure]
Inherited from
SpecStructureDsl
given given_Conversion_SpecStructure_Fragments: Conversion[SpecStructure, Fragments]
Inherited from
SpecStructureDsl
given given_Conversion_SpecStructure_Interpolated: Conversion[SpecStructure, Interpolated]
Inherited from
S2StringContext
given given_Conversion_SpecificationRef_Interpolated: Conversion[SpecificationRef, Interpolated]
Inherited from
S2StringContext
given given_Conversion_SpecificationStructure_Interpolated: Conversion[SpecificationStructure, Interpolated]
Inherited from
S2StringContext
given given_Conversion_String_SpecStructure: Conversion[String, SpecStructure]
Inherited from
SpecStructureDsl
given given_Conversion_T_Interpolated[T]: Conversion[T, Interpolated]
Inherited from
FormS2StringContext
given given_ToFragments_Fragment: ToFragments[Fragment]
Inherited from
FragmentsDsl
given given_ToFragments_Fragments: ToFragments[Fragments]
Inherited from
FragmentsDsl
given given_ToFragments_Seq: ToFragments[Seq[Fragment]]
Inherited from
FragmentsDsl
given given_ToFragments_String: ToFragments[String]
Inherited from
FragmentsDsl
given given_ToFragments_T[T]: ToFragments[T]
Inherited from
FormDsl
given given_ToSpecStructure_Arguments_Arguments: ToSpecStructure[Arguments, Arguments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_Fragment: ToSpecStructure[Arguments, Fragment]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_Fragments: ToSpecStructure[Arguments, Fragments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_SpecHeader: ToSpecStructure[Arguments, SpecHeader]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_SpecStructure: ToSpecStructure[Arguments, SpecStructure]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_String: ToSpecStructure[Arguments, String]

APPENDING TO ARGUMENTS

APPENDING TO ARGUMENTS

Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_T[T <: SpecificationStructure]: ToSpecStructure[Arguments, T]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Fragment_Arguments: ToSpecStructure[Fragment, Arguments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Fragment_Fragment: ToSpecStructure[Fragment, Fragment]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Fragment_Fragments: ToSpecStructure[Fragment, Fragments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Fragment_SpecStructure: ToSpecStructure[Fragment, SpecStructure]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Fragment_String: ToSpecStructure[Fragment, String]

APPENDING TO A FRAGMENT

APPENDING TO A FRAGMENT

Inherited from
SpecStructureDsl
given given_ToSpecStructure_Fragment_T[T <: SpecificationStructure]: ToSpecStructure[Fragment, T]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Fragments_Fragment: ToSpecStructure[Fragments, Fragment]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Fragments_Fragments: ToSpecStructure[Fragments, Fragments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Fragments_String: ToSpecStructure[Fragments, String]

APPENDING TO FRAGMENTS

APPENDING TO FRAGMENTS

Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_Arguments: ToSpecStructure[SpecHeader, Arguments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_Fragment: ToSpecStructure[SpecHeader, Fragment]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_Fragments: ToSpecStructure[SpecHeader, Fragments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_Seq: ToSpecStructure[SpecHeader, Seq[Fragment]]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_SpecStructure: ToSpecStructure[SpecHeader, SpecStructure]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_String: ToSpecStructure[SpecHeader, String]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_T[T <: SpecificationStructure]: ToSpecStructure[SpecHeader, T]

APPENDING TO A SPEC HEADER

APPENDING TO A SPEC HEADER

Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_Arguments: ToSpecStructure[SpecStructure, Arguments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_Fragment: ToSpecStructure[SpecStructure, Fragment]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_Fragments: ToSpecStructure[SpecStructure, Fragments]

APPENDING TO A SPEC STRUCTURE

APPENDING TO A SPEC STRUCTURE

Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_Seq: ToSpecStructure[SpecStructure, Seq[Fragment]]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_SpecStructure: ToSpecStructure[SpecStructure, SpecStructure]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_String: ToSpecStructure[SpecStructure, String]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_T[T <: SpecificationStructure]: ToSpecStructure[SpecStructure, T]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_String_Fragment: ToSpecStructure[String, Fragment]

APPENDING TO A STRING

APPENDING TO A STRING

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

Extensions

Inherited extensions

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

check the actual value with a matcher

check the actual value with a matcher

Inherited from
PropSyntax
extension (p: Prop[T, T])
def checkWith[T, R](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: T1)
def ^[T1, T2](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
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
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
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
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
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