specification

Type Members

1. case class AcceptanceCreationPath(path: Seq[Int]) extends CreationPath with Product with Serializable

2. case class Action(action: LazyParameter[Result] = lazyParameter(Success()), location: Location = new Location, isolable: Boolean = true, creationPath: Option[CreationPath] = None) extends Fragment with Executable with Isolable with Product with Serializable

   An Action is similar to a Step but can be executed concurrently with other examples.

3. trait After extends Context

   The After trait can be inherited by classes representing a context where an action must be executing after the main executable action

4. trait AfterContextExample[C <: After] extends ExamplesFactory

   For each created example use a given After context

5. trait AfterEach extends After with Apply

   apply an After context to each Example

6. trait AfterExample extends AfterContextExample[After]

   For each created example use a given after method

7. trait AllExpectations extends StoredExpectations with ExamplesFactory with SpecificationStructure with ArgumentsArgs

   This trait can be mixed-in a specification to allow examples to have all of their expectations being evaluated (unless the example body throws an exception of course).

8. trait Apply extends Context

   Apply a Context to a sequence of fragments containing examples.

9. trait Around extends Context

   The Around trait can be inherited by classes which will execute some code inside the around method provided by the context.

10. trait AroundContextExample[C <: Around] extends ExamplesFactory

    For each created example use a given Around context

11. trait AroundEach extends Around with Apply

    apply an Around context to each Example

12. trait AroundExample extends AroundContextExample[Around]

    For each created example use a given around method

13. trait AroundOutside[+T] extends Around with Outside[T]

    The AroundOutside trait can be inherited by classes which will execute some code inside a given context, with a function using that context and actions before and after if necessary.

14. trait BaseSpecification extends SpecificationStructure with FragmentsBuilder with SpecificationInclusion

    A Base specification contains the minimum elements for a Specification

15. trait Before extends Context

    The Before trait can be inherited by classes representing a context where an action must be executing before the main executable action

16. trait BeforeAfter extends Before with After

    The BeforeAfter trait allows to declare before and after actions to execute before and after an Example

17. trait BeforeAfterAround extends Before with After with Around

    The BeforeAfter trait allows to declare before, around and after actions

18. trait BeforeAfterAroundContextExample[C <: BeforeAfterAround] extends ExamplesFactory

    For each created example use a given BeforeAfterAround context

19. trait BeforeAfterAroundEach extends BeforeAfterAround with Apply

    apply a BeforeAfterAround context to each Example

20. trait BeforeAfterAroundExample extends BeforeAfterAroundContextExample[BeforeAfterAround]

    For each created example use a given before/after method

21. trait BeforeAfterContextExample[C <: BeforeAfter] extends ExamplesFactory

    For each created example use a given BeforeAfter context

22. trait BeforeAfterEach extends BeforeAfter with Apply

    apply a BeforeAfter context to each Example

23. trait BeforeAfterExample extends BeforeAfterContextExample[BeforeAfter]

    For each created example use a given before/after method

24. trait BeforeContextExample[C <: Before] extends ExamplesFactory

    For each created example use a given Before context

25. trait BeforeEach extends Before with Apply

    apply a Before context to each Example

26. trait BeforeExample extends BeforeContextExample[Before]

    For each created example use a given after method

27. trait Context extends Scope

    generic trait for Before, After, Around

28. trait Contexts extends AnyRef

    This trait is only used when we wish to write after actions in unit specifications like this

29. trait ContextsInjection extends Contexts

30. sealed trait CreationPath extends AnyRef

31. class DecoratedExampleFactory extends ExampleFactory

    Decorated creation where the body of the example can be surrounded with a given context if necessary

32. class DefaultExampleFactory extends ExampleFactory

    Default implementation for the example factory trait just creating an Example object

33. trait DefaultFragmentsFormatting extends FragmentsFormatting with TagsAssociation

34. case class Example extends Fragment with Executable with Isolable with Product with Serializable

    A Example is:

35. trait ExampleFactory extends AnyRef

    This trait defines methods for creating Examples.

36. trait ExamplesFactory extends AnyRef

37. case class ExamplesGroup(name: String = "") extends Product with Serializable

38. case class ExecutedBacktab(n: Int = 1, location: Location = new Location) extends ExecutedStandardFragment with Product with Serializable

39. case class ExecutedBr(location: Location = new Location) extends ExecutedStandardFragment with Product with Serializable

40. case class ExecutedEnd(location: Location = new Location) extends ExecutedStandardFragment with Product with Serializable

41. sealed trait ExecutedFragment extends AnyRef

    The Executed Fragments represent pieces of a Specification which have already been executed to provide a Result

42. case class ExecutedNoText(original: Fragment, timer: SimpleTimer = new SimpleTimer, location: Location = new Location) extends ExecutedFragment with Product with Serializable

    This executed Fragment is used when no text must be displayed (for the successful execution of an Action for example)

43. case class ExecutedResult(s: FormattedString, result: Result, timer: SimpleTimer, location: Location, statistics: Stats) extends ExecutedFragment with Product with Serializable

44. case class ExecutedSpecEnd(end: SpecEnd, location: Location = new Location, stats: Stats = Stats()) extends ExecutedFragment with Product with Serializable

45. case class ExecutedSpecStart(start: SpecStart, location: Location = new Location, stats: Stats = Stats().startTimer) extends ExecutedFragment with Product with Serializable

46. case class ExecutedSpecification(name: SpecName, fs: Seq[ExecutedFragment]) extends Product with Serializable

    A specification with a name and all of its fragments already executed

47. trait ExecutedStandardFragment extends ExecutedFragment

48. case class ExecutedTab(n: Int = 1, location: Location = new Location) extends ExecutedStandardFragment with Product with Serializable

49. case class ExecutedText(textFragment: Text, location: Location = new Location) extends ExecutedFragment with Product with Serializable

50. sealed trait ExecutingFragment extends AnyRef

    The Executing Fragment trait represent a Fragment being executed.

51. case class ExecutingSpecification(name: SpecName, arguments: Arguments, fs: Seq[ExecutingFragment], executor: ExecutorService) extends Product with Serializable

    a specification with a name and a sequence of fragments being executed

52. case class FinishedExecutingFragment(f: ExecutedFragment) extends ExecutingFragment with Product with Serializable

    embed an already executed Fragment

53. trait Fixture[T] extends AnyRef

    A Fixture can be implicitly passed to a set of examples taking a function as an input.

54. trait FixtureExample[T] extends AnyRef

    For each created example use a given after method

55. trait FormattedString extends AnyRef

56. case class Formatting(flow: Boolean = false, markdown: Boolean = true, verbatim: Boolean = true) extends Product with Serializable

    Formatting for Text fragments

57. trait FormattingFragments extends AnyRef

    Set of fragments which can be used for formatting

58. trait FormattingTags extends Tags

59. sealed trait Fragment extends AnyRef

    A Fragment is a piece of a specification.

60. trait FragmentExecution extends AnyRef

    This trait executes Fragments

61. case class Fragments(specTitle: Option[SpecName] = None, middle: Seq[Fragment] = Stream().toSeq, arguments: Arguments = Arguments(), linked: Linked = Linked()) extends Product with Serializable

    A Fragments object is a list of fragments with a SpecStart and a SpecEnd

62. trait FragmentsBuilder extends ExamplesFactory with ImplicitParameters with FormattingTags

    This trait provides function to create specification Fragments:

63. trait FragmentsFormatting extends AnyRef

    This trait post-process fragments.

64. class FragmentsFragment extends AnyRef

    Fragments can be chained with the ^ method

65. trait Grouped extends GroupsLike

    This trait can be used to standardize names for groups of examples in an acceptance specification.

66. trait Groups extends GroupsLike

    This trait can be used to standardize names for groups of examples in an acceptance specification.

67. trait GroupsLike extends AnyRef

68. abstract class HtmlLink extends AnyRef

    The HtmlLink class represents a link in a specification with an identifier (either a spec name, or a string) and link elements.

69. case class LazyExecutingFragment(f: () ⇒ ExecutedFragment, original: Fragment) extends ExecutingFragment with Product with Serializable

    embed an executing Fragment into a function to execute it on demand

70. case class Linked(link: Option[HtmlLink] = None, seeOnly: Boolean = false, hidden: Boolean = false) extends Product with Serializable

    encapsulation of the linking behaviour

71. case class MarkdownLink(name: String, url: String) extends Product with Serializable

    This class provides functionalities for manipulating Markdown links

72. case class MutableCreationPath(path: Seq[Int]) extends CreationPath with Product with Serializable

73. trait NoAutoExamples extends NoBooleanAutoExamples with NoResultAutoExamples with NoMatchResultAutoExamples with NoDataTableAutoExamples

    This trait ca be used to deactivate all automatic conversions to examples

74. trait NoBangExamples extends FragmentsBuilder

    This trait deactivates the implicit on Strings which is used to create examples with !

75. trait NoBooleanAutoExamples extends AutoExamples

    This trait can be used to deactivate the Boolean conversions to fragments and examples

76. trait NoContexts extends Contexts

    Use this trait to deactivate the Contexts implicits

77. trait NoDataTableAutoExamples extends AutoExamples

    This trait can be used to deactivate the DataTable conversions to fragments and examples

78. trait NoFragmentsBuilder extends FragmentsBuilder with NoToHtmlLinkFragments

    This trait can be used to deactivate implicits for building fragments

79. trait NoMatchResultAutoExamples extends AutoExamples

    This trait can be used to deactivate the MatchResult conversions to fragments and examples

80. trait NoResultAutoExamples extends AutoExamples

    This trait can be used to deactivate the Result conversions to fragments and examples

81. trait NoToHtmlLinkFragments extends FragmentsBuilder

    This trait can be used to deactivate implicits for ~ and ~/ operators on strings

82. trait Outside[+T] extends AnyRef

    The Outside trait can be inherited by classes which will execute some code inside the outside method provided by the context.

83. case class PromisedExecutingFragment(promised: Promise[ExecutedFragment], original: Fragment) extends ExecutingFragment with Product with Serializable

    embed an executed Fragment into a promise

84. class ResultsContext extends StoredResultsContext

    This class is used to evaluate a Context as a sequence of results by side-effects.

85. trait Scope extends matcher.Scope

    Marker trait that is used to create a new scope with variables and implicitly converted to a Success in a mutable Specification

86. case class SimpleFormattedString(t: String = "", formatting: Formatting = Formatting(), isEmpty: Boolean = false, isCode: Boolean = true) extends FormattedString with Product with Serializable

87. trait Snippets extends execute.Snippets

    Snippets of code can be extracted from interpolated specification strings.

88. case class SpecEnd(specName: SpecName, isSeeOnlyLink: Boolean = false, location: Location = new Location) extends Fragment with Product with Serializable

    End of a specification.

89. case class SpecHtmlLink(name: SpecName, beforeText: String = "", linkText: String = "", afterText: String = "", tip: String = "") extends HtmlLink with Product with Serializable

90. trait SpecIdentification extends AnyRef

    Identification information for a specification

91. sealed trait SpecName extends SpecIdentification

    Name declaration for a specification

92. trait SpecPart extends AnyRef

93. case class SpecStart(specName: SpecName, arguments: Arguments = Arguments(), linked: Linked = Linked(), location: Location = new Location) extends Fragment with Product with Serializable

    Start of a specification.

94. trait SpecificationInclusion extends AnyRef

    additional methods to include other specifications or Fragments

95. trait SpecificationNavigation extends AnyRef

    This trait models "what happens" before a fragment is created in terms of side-effects.

96. trait SpecificationStringContext extends AnyRef

    Allow to use fragments inside interpolated strings starting with s2 in order to build the specification content

97. trait SpecificationStructure extends DefaultFragmentsFormatting

    The structure of a Specification is simply defined as a sequence of fragments

98. case class Stats(examples: Int = 0, successes: Int = 0, expectations: Int = 0, failures: Int = 0, errors: Int = 0, pending: Int = 0, skipped: Int = 0, trend: Option[Stats] = None, timer: SimpleTimer = new SimpleTimer) extends Product with Serializable

    The Stats class store results for the number of: - successes - expectations - failures - errors - pending - skipped

99. case class Step(step: LazyParameter[Result], stopOnFail: Boolean = false, location: Location = new Location, isolable: Boolean = true) extends Fragment with Executable with Isolable with Product with Serializable

    An Step creates a fragment that will either return an Error Result if there is an exception or a Success.

100. trait StoredExpectationsContext extends StoredExpectations with StoredResultsContext

     This trait can be used when it is not desirable to use the AllExpectations trait, that is, when the specification examples must be executed concurrently and not isolated.

101. trait StoredResultsContext extends Context

     This trait is a context which will use the results provided by the class inheriting that trait.

102. trait Tables extends DataTables with NoBangExamples

103. trait Tags extends AnyRef

     The tags trait allows the creation of Tags fragments in a Specification

104. trait TagsAssociation extends AnyRef

105. case class Text(text: SimpleFormattedString, location: Location = new Location) extends Fragment with Product with Serializable

     Free text, describing the system to specify

106. case class UrlHtmlLink(url: String, beforeText: String = "", linkText: String = "", afterText: String = "", tip: String = "") extends HtmlLink with Product with Serializable