SpecificationCreation

Type Members

class BangExample extends AnyRef

Definition Classes
ExampleDsl
class BlockExample extends AnyRef

Definition Classes
ExampleDsl1
implicit class FragmentTaggedAs extends AnyRef

This implicit allows to add tags and sections _after_ the examples
This implicit allows to add tags and sections _after_ the examples

Definition Classes
TagDsl
implicit class FragmentsTaggedAs extends AnyRef

This implicit allows to add tags and sections _after_ the examples
This implicit allows to add tags and sections _after_ the examples

Definition Classes
TagDsl
implicit class HiddenFragment extends AnyRef

Definition Classes
FragmentsDsl
class MutableBangExample extends BangExample

Definition Classes
ExampleDsl
class MutableTitleOps extends TitleOps

Definition Classes
TitleDsl
class TitleOps extends AnyRef

Definition Classes
TitleDsl
class WarningForgottenOperator extends AnyRef

Definition Classes
BlockDsl
implicit class appendSpecStructureToFragment extends AnyRef

Definition Classes
SpecStructureDsl
implicit class appendSpecStructureToFragments extends AnyRef

Definition Classes
SpecStructureDslLowImplicits
implicit class appendSpecStructureToSpecHeader extends AnyRef

Definition Classes
SpecStructureDsl
implicit class appendSpecStructureToSpecStructure extends AnyRef

Definition Classes
SpecStructureDsl
implicit class appendSpecStructureToString extends AnyRef

Definition Classes
SpecStructureDsl
implicit class appendToArguments extends AnyRef

Definition Classes
SpecStructureDsl1
implicit class appendToFragment extends AnyRef

Definition Classes
FragmentsDsl
implicit class appendToFragments extends AnyRef

Definition Classes
FragmentsDsl
implicit class appendToString extends AnyRef

Definition Classes
FragmentsDsl
implicit class describe extends AnyRef

Definition Classes
BlockDsl
implicit class fragmentFormatting extends AnyRef

Definition Classes
TextDsl
implicit class fragmentsFormatting extends AnyRef

Definition Classes
TextDsl
implicit class linkFragment extends AnyRef

Definition Classes
ReferenceDsl
implicit class mutableLinkFragment extends linkFragment

Definition Classes
ReferenceDsl
implicit class mutableSeeFragment extends seeFragment

Definition Classes
ReferenceDsl
implicit class seeFragment extends AnyRef

Definition Classes
ReferenceDsl
implicit class specificationInStringContext extends AnyRef

Definition Classes
S2StringContextCreation
implicit class textFragment extends AnyRef

Definition Classes
TextDsl

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
implicit def ***If you see this message this means that you've forgotten an operator after the description string: you should write "example" >> result ***(s: String): WarningForgottenOperator

adding a conflicting implicit to warn the user when a >> was forgotten
adding a conflicting implicit to warn the user when a >> was forgotten

Definition Classes
BlockDsl
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def action(a: ⇒ Any): Fragment

Definition Classes
ActionDsl → ActionDsl
def addBacktab(n: Int): Fragment

Definition Classes
TextCreation
def addBacktab: Fragment

Definition Classes
TextCreation
def addBreak(n: Int): Fragment

Definition Classes
TextCreation
def addBreak: Fragment

Definition Classes
TextCreation
def addFragment(fragment: Fragment): Fragment

Definition Classes
MutableFragmentBuilder → FragmentBuilder
def addFragmentBlock(f: ⇒ Fragment): Fragment

Definition Classes
MutableFragmentBuilder → FragmentBuilder
def addFragments(fragments: Fragments): Fragments

Definition Classes
MutableFragmentBuilder → FragmentBuilder
def addFragmentsBlock(fs: ⇒ Fragments): Fragments

Definition Classes
MutableFragmentBuilder → FragmentBuilder
def addParagraph(s: String, n: Int = 2): Fragment

Definition Classes
TextCreation
def addTab(n: Int): Fragment

Definition Classes
TextCreation
def addTab: Fragment

Definition Classes
TextCreation
def addText(s: String): Fragment

Definition Classes
TextCreation
implicit def anyAsResultIsInterpolatedFragment(r: ⇒ Function0Result): InterpolatedFragment

Definition Classes
S2StringContext
implicit def anyToArgProperty[T](t: ⇒ T): ArgProperty[T]

Definition Classes
ArgProperties
def args(ex: ArgProperty[String] = ArgProperty[String](), include: ArgProperty[String] = ArgProperty[String](), exclude: ArgProperty[String] = ArgProperty[String](), was: ArgProperty[String] = ArgProperty[String](), plan: ArgProperty[Boolean] = ArgProperty[Boolean](), skipAll: ArgProperty[Boolean] = ArgProperty[Boolean](), stopOnFail: ArgProperty[Boolean] = ArgProperty[Boolean](), stopOnSkip: ArgProperty[Boolean] = ArgProperty[Boolean](), sequential: ArgProperty[Boolean] = ArgProperty[Boolean](), asap: ArgProperty[Boolean] = ArgProperty[Boolean](), isolated: ArgProperty[Boolean] = ArgProperty[Boolean](), xonly: ArgProperty[Boolean] = ArgProperty[Boolean](), showOnly: ArgProperty[String] = ArgProperty[String](), color: ArgProperty[Boolean] = ArgProperty[Boolean]()): Arguments

shorthand method to create an Arguments object
shorthand method to create an Arguments object

Definition Classes
ArgumentsCreation → ArgumentsCreation
lazy val args: ArgumentsNamespaceMutable

Definition Classes
ArgumentsCreation → ArgumentsCreation
implicit def argumentsFunctionIsInterpolatedFragment[R](f: (Arguments) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

Definition Classes
S2StringContext
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit def asResultIsInterpolatedFragment[R](r: ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

Definition Classes
S2StringContext1
implicit def bangExample(d: String): BangExample

Definition Classes
ExampleDsl → ExampleDsl
implicit def blockExample(d: String): BlockExample

Definition Classes
ExampleDsl1
def br: Fragment

Definition Classes
FormattingFragments → FormattingFragments
def bt(n: Int): Fragment

Definition Classes
FormattingFragments → FormattingFragments
def bt: Fragment

Definition Classes
FormattingFragments → FormattingFragments
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def colors(c: Colors): Arguments

shortcut to set new Colors
shortcut to set new Colors

Definition Classes
ArgumentsShortcuts
implicit def commandLineAsResultIsInterpolatedFragment[R](r: ⇒ R)(implicit arg0: CommandLineAsResult[R]): InterpolatedFragment

Definition Classes
S2StringContextImplicitsControl
implicit def commandLineFunctionIsInterpolatedFragment[R](f: (CommandLine) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

Definition Classes
S2StringContext
def createExample[T](expression: String, code: ⇒ T, asResult: AsResult[T]): Fragments

Definition Classes
AutoExamples → AutoExamples
def createExecutionInterpolatedFragment(execution: Execution): InterpolatedFragment

Definition Classes
S2StringContextCreation
implicit def descriptionToFragmentsIsInterpolatedFragment(fragments: (String) ⇒ Fragments): InterpolatedFragment

Definition Classes
S2StringContext
def diffs(show: Boolean = true, separators: String = "[]", triggerSize: Int = 20, diffRatio: Int = 30, shortenSize: Int = 5, full: Boolean = false, seqTriggerSize: Int = 0, seqMaxSize: Int = 1000000): Arguments

shortcut to display the differences with some specific parameters
shortcut to display the differences with some specific parameters

Definition Classes
ArgumentsShortcuts
implicit macro def eg[T](code: ⇒ T)(implicit arg0: AsResult[T]): Fragments

Definition Classes
AutoExamples
def end: Fragment

Definition Classes
FormattingFragments → FormattingFragments
implicit def envFunctionIsInterpolatedFragment[R](f: (Env) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

Definition Classes
S2StringContext
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def exclude(tags: String): Arguments

shortcut to exclude some tagged fragments
shortcut to exclude some tagged fragments

Definition Classes
ArgumentsShortcuts
def excludeAlsoTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to add exclude trace patterns
shortcut to add exclude trace patterns

Definition Classes
ArgumentsShortcuts
def excludeTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to create a stackTrace filter to exclude only some elements
shortcut to create a stackTrace filter to exclude only some elements

Definition Classes
ArgumentsShortcuts
implicit def executionContextFunctionIsInterpolatedFragment[R](f: (ExecutionContext) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

Definition Classes
S2StringContext
implicit def executionIsInterpolatedFragment(execution: Execution): InterpolatedFragment

Definition Classes
S2StringContext
implicit def executorServiceFunctionIsInterpolatedFragment[R](f: (ExecutorService) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

Definition Classes
S2StringContext
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
implicit def fragmentAsSpecStructure(f: Fragment): SpecStructure

Definition Classes
SpecStructureDsl
def fragmentFactory: FragmentFactory

Attributes
protected
Definition Classes
FragmentsFactory
implicit def fragmentIsInterpolatedFragment(f: ⇒ Fragment): InterpolatedFragment

Definition Classes
S2StringContext1
implicit def fragmentToFragments(f: Fragment): Fragments

Definition Classes
FragmentsDsl
implicit def fragmentsAsSpecStructure(fs: ⇒ Fragments): SpecStructure

Definition Classes
SpecStructureDsl1
def fragmentsBlock(fragments: Seq[Fragment], offset: Int = 2): 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

Definition Classes
FragmentsDsl
implicit def fragmentsIsInterpolatedFragment(fragments: Fragments): InterpolatedFragment

Definition Classes
S2StringContext
def fullStackTrace: Arguments

shortcut to filter nothing
shortcut to filter nothing

Definition Classes
ArgumentsShortcuts
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def include(tags: String): Arguments

shortcut to include only some tagged fragments
shortcut to include only some tagged fragments

Definition Classes
ArgumentsShortcuts
def includeAlsoTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to add include trace patterns
shortcut to add include trace patterns

Definition Classes
ArgumentsShortcuts
def includeTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to create a stackTrace filter to include only some elements
shortcut to create a stackTrace filter to include only some elements

Definition Classes
ArgumentsShortcuts
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isolated: Arguments

returns
arguments for a specification where examples must be executed in their own specification

Definition Classes
ArgumentsShortcuts
def link(s: ⇒ SpecificationStructure): Fragment

Definition Classes
ReferenceDsl → ReferenceCreation
def link(s: SpecStructure): Fragment

Definition Classes
ReferenceDsl → ReferenceCreation
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def nocolor: Arguments

shortcut to avoid colored output
shortcut to avoid colored output

Definition Classes
ArgumentsShortcuts
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def only(examples: String): Arguments

shortcut to execute and print only some examples
shortcut to execute and print only some examples

Definition Classes
ArgumentsShortcuts
def p: Fragments

Definition Classes
FormattingFragments → FormattingFragments
def plan: Arguments

shortcut to show only the text without any execution
shortcut to show only the text without any execution

Definition Classes
ArgumentsShortcuts
implicit def resultAsSpecStructure[R](r: ⇒ R)(implicit arg0: AsResult[R]): SpecStructure

Definition Classes
SpecStructureDslLowImplicits
def s2(content: String, Yrangepos: Boolean, texts: Seq[String], textsStartPositions: Seq[String], textsEndPositions: Seq[String], variables: Seq[InterpolatedFragment], rangeExpressions: Seq[String]): Fragments

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

Definition Classes
S2StringContextCreation
def section(tag: NamedTag): Fragment

Definition Classes
TagDsl → TagDsl
def section(names: String*): Fragment

Definition Classes
TagDsl → TagDsl
def see(s: ⇒ SpecificationStructure): Fragment

Definition Classes
ReferenceDsl → ReferenceCreation
def see(s: SpecStructure): Fragment

Definition Classes
ReferenceDsl → ReferenceCreation
def sequential: Arguments

returns
arguments for a specification where examples must be executed sequentially

Definition Classes
ArgumentsShortcuts
def setArguments(a: Arguments): Arguments

Definition Classes
MutableArgumentsBuilder
def setTitle(t: String): SpecHeader

Definition Classes
MutableHeaderBuilder
def showOnly(s: String): Arguments

shortcut to print only some statuses
shortcut to print only some statuses

Definition Classes
ArgumentsShortcuts
def skipAll: Arguments

shortcut to skip all examples
shortcut to skip all examples

Definition Classes
ArgumentsShortcuts
def skipAllIf(condition: ⇒ Boolean): Arguments

shortcut to skip all examples when a condition is true.
shortcut to skip all examples when a condition is true. if the condition throws an exception, its stacktrace is *not* printed and all the examples are skipped

Definition Classes
ArgumentsShortcuts
def skipAllUnless(condition: ⇒ Boolean): Arguments

shortcut to skip all examples when a condition is false.
shortcut to skip all examples when a condition is false.

Definition Classes
ArgumentsShortcuts
implicit def specHeaderAsStructure(header: SpecHeader): SpecStructure

Definition Classes
SpecStructureDsl
implicit def specStructureAsFragments(spec: SpecStructure): Fragments

Definition Classes
SpecStructureDsl
implicit def specStructureIsInterpolatedFragment(s: SpecStructure): InterpolatedFragment

Definition Classes
S2StringContext
def specificationFragments: (Env) ⇒ Fragments

Definition Classes
MutableFragmentBuilder
implicit def specificationRefIsInterpolatedFragment(ref: SpecificationRef): InterpolatedFragment

Definition Classes
S2StringContext
def specificationStructure: (Env) ⇒ SpecStructure

Definition Classes
MutableFragmentBuilder
implicit def specificationStructureIsInterpolatedFragment(s: SpecificationStructure): InterpolatedFragment

Definition Classes
S2StringContext
implicit def statsRepositoryFunctionIsInterpolatedFragment[R](f: (StatisticsRepository) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

Definition Classes
S2StringContext
def step(a: ⇒ Any, global: Boolean): Fragment

Definition Classes
ActionDsl → ActionDsl
def step(a: ⇒ Any): Fragment

Definition Classes
ActionDsl → ActionDsl
def stopOnFail: Arguments

shortcut to stop after the first failure or error
shortcut to stop after the first failure or error

Definition Classes
ArgumentsShortcuts
def stopOnSkip: Arguments

shortcut to stop after the first skipped result
shortcut to stop after the first skipped result

Definition Classes
ArgumentsShortcuts
def stopWhen(f: (Result) ⇒ Boolean): Fragment

Definition Classes
ActionDsl
def stopWhen(r: Result): Fragment

Definition Classes
ActionDsl
def stopWhenFail(when: ⇒ Boolean): Fragment

Definition Classes
ActionDsl
def stopWhenFail: Fragment

Definition Classes
ActionDsl
def stopWhenSkipped(when: ⇒ Boolean): Fragment

Definition Classes
ActionDsl
def stopWhenSkipped: Fragment

Definition Classes
ActionDsl
implicit def stringAsSpecStructure(s: String): SpecStructure

Definition Classes
SpecStructureDsl
implicit def stringFunctionIsInterpolatedFragment[R](f: (String) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

Definition Classes
S2StringContext
implicit def stringIsInterpolatedFragment(s: ⇒ String): InterpolatedFragment

Definition Classes
S2StringContext
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def t(n: Int): Fragment

Definition Classes
FormattingFragments → FormattingFragments
def t: Fragment

Definition Classes
FormattingFragments → FormattingFragments
def tag(tag: NamedTag): Fragment

Definition Classes
TagDsl → TagDsl
def tag(names: String*): Fragment

Definition Classes
TagDsl → TagDsl
implicit def title(s: String): MutableTitleOps

Definition Classes
TitleDsl → TitleDsl
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def was(s: String): Arguments

shortcut to include only examples with some previous statuses
shortcut to include only examples with some previous statuses

Definition Classes
ArgumentsShortcuts
def xonly: Arguments

shortcut to print only failures and errors
shortcut to print only failures and errors

Definition Classes
ArgumentsShortcuts

Related Doc: package mutable

trait SpecificationCreation extends create.SpecificationCreation with FormattingFragments with AutoExamples with MutableDsl with ArgumentsShortcuts with ArgumentsDsl

Type Members

class BangExample extends AnyRef

class BlockExample extends AnyRef

implicit class FragmentTaggedAs extends AnyRef

implicit class FragmentsTaggedAs extends AnyRef

implicit class HiddenFragment extends AnyRef

class MutableBangExample extends BangExample

class MutableTitleOps extends TitleOps

class TitleOps extends AnyRef

class WarningForgottenOperator extends AnyRef

implicit class appendSpecStructureToFragment extends AnyRef

implicit class appendSpecStructureToFragments extends AnyRef

implicit class appendSpecStructureToSpecHeader extends AnyRef

implicit class appendSpecStructureToSpecStructure extends AnyRef

implicit class appendSpecStructureToString extends AnyRef

implicit class appendToArguments extends AnyRef

implicit class appendToFragment extends AnyRef

implicit class appendToFragments extends AnyRef

implicit class appendToString extends AnyRef

implicit class describe extends AnyRef

implicit class fragmentFormatting extends AnyRef

implicit class fragmentsFormatting extends AnyRef

implicit class linkFragment extends AnyRef

implicit class mutableLinkFragment extends linkFragment

implicit class mutableSeeFragment extends seeFragment

implicit class seeFragment extends AnyRef

implicit class specificationInStringContext extends AnyRef

implicit class textFragment extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

implicit def ***If you see this message this means that you've forgotten an operator after the description string: you should write "example" >> result ***(s: String): WarningForgottenOperator

final def ==(arg0: Any): Boolean

def action(a: ⇒ Any): Fragment

def addBacktab(n: Int): Fragment

def addBacktab: Fragment

def addBreak(n: Int): Fragment

def addBreak: Fragment

def addFragment(fragment: Fragment): Fragment

def addFragmentBlock(f: ⇒ Fragment): Fragment

def addFragments(fragments: Fragments): Fragments

def addFragmentsBlock(fs: ⇒ Fragments): Fragments

def addParagraph(s: String, n: Int = 2): Fragment

def addTab(n: Int): Fragment

def addTab: Fragment

def addText(s: String): Fragment

implicit def anyAsResultIsInterpolatedFragment(r: ⇒ Function0Result): InterpolatedFragment

implicit def anyToArgProperty[T](t: ⇒ T): ArgProperty[T]

lazy val args: ArgumentsNamespaceMutable

implicit def argumentsFunctionIsInterpolatedFragment[R](f: (Arguments) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

final def asInstanceOf[T0]: T0

implicit def asResultIsInterpolatedFragment[R](r: ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

implicit def bangExample(d: String): BangExample

implicit def blockExample(d: String): BlockExample

def br: Fragment

def bt(n: Int): Fragment

def bt: Fragment

def clone(): AnyRef

def colors(c: Colors): Arguments

implicit def commandLineAsResultIsInterpolatedFragment[R](r: ⇒ R)(implicit arg0: CommandLineAsResult[R]): InterpolatedFragment

implicit def commandLineFunctionIsInterpolatedFragment[R](f: (CommandLine) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

def createExample[T](expression: String, code: ⇒ T, asResult: AsResult[T]): Fragments

def createExecutionInterpolatedFragment(execution: Execution): InterpolatedFragment

implicit def descriptionToFragmentsIsInterpolatedFragment(fragments: (String) ⇒ Fragments): InterpolatedFragment

def diffs(show: Boolean = true, separators: String = "[]", triggerSize: Int = 20, diffRatio: Int = 30, shortenSize: Int = 5, full: Boolean = false, seqTriggerSize: Int = 0, seqMaxSize: Int = 1000000): Arguments

implicit macro def eg[T](code: ⇒ T)(implicit arg0: AsResult[T]): Fragments

def end: Fragment

implicit def envFunctionIsInterpolatedFragment[R](f: (Env) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exclude(tags: String): Arguments

def excludeAlsoTrace(patterns: String*): IncludeExcludeStackTraceFilter

def excludeTrace(patterns: String*): IncludeExcludeStackTraceFilter

implicit def executionContextFunctionIsInterpolatedFragment[R](f: (ExecutionContext) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

implicit def executionIsInterpolatedFragment(execution: Execution): InterpolatedFragment

implicit def executorServiceFunctionIsInterpolatedFragment[R](f: (ExecutorService) ⇒ R)(implicit arg0: AsResult[R]): InterpolatedFragment

def finalize(): Unit

implicit def If you see this message this means that you've forgotten an operator after the description string: you should write "example" >> result (s: String): WarningForgottenOperator