org.specs2.reporter

MarkdownReporter

Related Doc: package reporter

trait MarkdownReporter extends DefaultReporter with MarkdownExporting with ConsoleOutput

Reports a Specification as a markdown page

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MarkdownReporter
  2. ConsoleOutput
  3. Output
  4. MarkdownExporting
  5. HtmlExporting
  6. HtmlFileWriter
  7. OutputDir
  8. HtmlPrinter
  9. DefaultReporter
  10. Executor
  11. DefaultStoring
  12. Statistics
  13. DefaultExecutionStrategy
  14. FragmentExecution
  15. DefaultSequence
  16. DefaultSelection
  17. ExamplesSelection
  18. StatusSelection
  19. WithDefaultStatisticsRepository
  20. WithStatisticsRepository
  21. TagSelection
  22. TagsAssociation
  23. ExamplesIsolation
  24. Reporter
  25. Exporting
  26. Storing
  27. ExecutionStrategy
  28. Sequence
  29. Selection
  30. AnyRef
  31. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class SpecStats extends Product with Serializable

    The SpecsStats class just stores a list of stats, each one corresponding to a Fragment

    The SpecsStats class just stores a list of stats, each one corresponding to a Fragment

    Definition Classes
    Statistics
  2. case class SpecsStatistics extends Product with Serializable

    The SpecsStatistics class stores the result of a specification execution, with the a list of 'current' stats for each fragment execution and the total statistics for the whole specification

    The SpecsStatistics class stores the result of a specification execution, with the a list of 'current' stats for each fragment execution and the total statistics for the whole specification

    Definition Classes
    Statistics

Value Members

  1. final def !=(arg0: Any): Boolean

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

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. val ExecutedStatisticsReducer: Reducer[ExecutedFragment, SpecsStatistics]

    Definition Classes
    Statistics
  5. implicit lazy val HtmlReducer: Reducer[ExecutingFragment, Stream[HtmlLine]]

    Definition Classes
    HtmlPrinter
  6. implicit def SpecStatsMonoid: Monoid[SpecStats] { val zero: MarkdownReporter.this.SpecStats }

    Definition Classes
    Statistics
  7. object SpecsStatistics extends Product with Serializable

    Definition Classes
    Statistics
  8. implicit def SpecsStatisticsMonoid: Monoid[SpecsStatistics] { val zero: MarkdownReporter.this.SpecsStatistics }

    Definition Classes
    Statistics
  9. val StatisticsReducer: Reducer[ExecutingFragment, SpecsStatistics]

    Definition Classes
    Statistics
  10. val StatsReducer: Reducer[ExecutingFragment, SpecStats]

    Definition Classes
    Statistics
  11. val StatsReducer2: Reducer[ExecutingFragment, Stats]

    Definition Classes
    Statistics
  12. def addToc(implicit args: Arguments): (Tree[HtmlLinesFile]) ⇒ Seq[HtmlLinesFile]

    returns

    add a toc to each HtmlFile where relevant

    Definition Classes
    HtmlPrinter
  13. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  14. def checkUrls(args: Arguments, others: Seq[HtmlFile]): (HtmlFile) ⇒ HtmlFile

    Attributes
    protected
    Definition Classes
    HtmlFileWriter
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  16. def copyBody(name: SpecName, f: Fragment, body: ⇒ Result)(implicit arguments: Arguments): Result

    returns

    an Example which body comes from the execution of that example in a brand new instance of the Specification

    Attributes
    protected
    Definition Classes
    ExamplesIsolation
  17. def copyResources(): Unit

    copy css and images file to the output directory

    copy css and images file to the output directory

    Attributes
    protected
    Definition Classes
    HtmlFileWriter
  18. def createHtmlLinesFiles(spec: ExecutedSpecification)(implicit args: Arguments): Tree[HtmlLinesFile]

    map the executed fragments to HtmlLines and sort them by destination file, one file per specification

    map the executed fragments to HtmlLines and sort them by destination file, one file per specification

    returns

    a Tree of HtmlLinesFile where the root is the parent specification and children are the included specifications

    Definition Classes
    HtmlPrinter
  19. def delegate(arguments: Arguments): Option[Executor]

    Definition Classes
    Executor
  20. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  22. def execute(implicit arguments: Arguments): (ExecutableSpecification) ⇒ ExecutingSpecification

    execute sequences of Fragments.

    execute sequences of Fragments.

    If the stopOnFail argument is true, we check that the execution is ok before executing the next sequence.

    Definition Classes
    DefaultReporterDefaultExecutionStrategy → ExecutionStrategy
  23. def execute(f: Fragment)(implicit arguments: Arguments = Arguments()): Product with Serializable with ExecutedFragment

    execute a Fragment.

    execute a Fragment.

    A Form is executed separately by executing each row and cell, setting the results on each cell

    Definition Classes
    FragmentExecution
  24. def executeAsap(executing: ExecutingFragment): FinishedExecutingFragment

    Definition Classes
    DefaultExecutionStrategy
  25. def executeBody(body: ⇒ Result)(implicit arguments: Arguments): Result

    This method could be overriden to provide alternate behavior when executing an Example

    This method could be overriden to provide alternate behavior when executing an Example

    Definition Classes
    FragmentExecution
  26. def executeConcurrently(fs: FragmentSeq, barrier: ⇒ Any, args: Arguments)(implicit strategy: Strategy): Seq[Product with Serializable with ExecutingFragment { def map(function: org.specs2.specification.ExecutedFragment => org.specs2.specification.ExecutedFragment): Product with Serializable with org.specs2.specification.ExecutingFragment }]

    Definition Classes
    DefaultExecutionStrategy
  27. def executeFragment(implicit arguments: Arguments): Function[Fragment, ExecutedFragment]

    execute a Fragment.

    execute a Fragment.

    Definition Classes
    FragmentExecution
  28. def executeRandomly(fs: FragmentSeq, args: Arguments): Seq[FinishedExecutingFragment]

    Definition Classes
    DefaultExecutionStrategy
  29. def executeSequence(fs: FragmentSeq, barrier: ⇒ Any)(implicit args: Arguments, strategy: Strategy): Seq[ExecutingFragment]

    Definition Classes
    DefaultExecutionStrategy
  30. def executeSequentially(fs: FragmentSeq, args: Arguments): Seq[LazyExecutingFragment]

    Definition Classes
    DefaultExecutionStrategy
  31. def export(implicit arguments: Arguments): (ExecutingSpecification) ⇒ ExecutedSpecification

    returns

    a function exporting an ExecutingSpecification

    Definition Classes
    HtmlExporting → Exporting
  32. def filter(implicit commandLineArgs: Arguments): (Seq[(Fragment, Arguments, SpecName)]) ⇒ Seq[Fragment]

    returns

    filter fragments depending on the command line arguments and the current arguments in the specification

    Definition Classes
    DefaultSelection
  33. def filterExamples(implicit commandLineArgs: Arguments): (Seq[(Fragment, Arguments, SpecName)]) ⇒ Seq[Fragment]

    the filter method filters examples based on their description, keeping only the ones matching the ex attribute of the arguments object

    the filter method filters examples based on their description, keeping only the ones matching the ex attribute of the arguments object

    Attributes
    protected
    Definition Classes
    ExamplesSelection
  34. def filterPrevious(implicit commandLineArgs: Arguments): (Seq[(Fragment, Arguments, SpecName)]) ⇒ Seq[(Fragment, Arguments, SpecName)]

    returns

    fragments according to their previous execution state

    Definition Classes
    StatusSelection
  35. def filterTags(implicit commandLineArgs: Arguments): (Seq[(Fragment, Arguments, SpecName)]) ⇒ Seq[(Fragment, Arguments, SpecName)]

    returns

    filter fragments according to tags by collecting tags as applicable to each fragment and applying them

    Definition Classes
    TagSelection
  36. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def flush(): Unit

    flush the content if necessary

    flush the content if necessary

    Definition Classes
    ConsoleOutputOutput
  38. def foldAll(fs: Seq[ExecutingFragment]): SpecsStatistics

    Definition Classes
    Statistics
  39. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  40. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  41. def includePrevious(specName: SpecName, e: Example, args: Arguments): Boolean

    Attributes
    protected
    Definition Classes
    StatusSelection
  42. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  43. def isolateExamples(implicit arguments: Arguments): (Seq[(Fragment, Arguments, SpecName)]) ⇒ Seq[Fragment]

    This function "clones" the body of each example if the applicable arguments indicate that the specification should be isolated

    This function "clones" the body of each example if the applicable arguments indicate that the specification should be isolated

    Attributes
    protected
    Definition Classes
    ExamplesIsolation
  44. def isolateSteps(fragments: Seq[Fragment])(implicit arguments: Arguments): Seq[FragmentSeq]

    Attributes
    protected
    Definition Classes
    DefaultSequence
  45. def markdownExtension: String

    markdown and .md is the default output format

    markdown and .md is the default output format

    Definition Classes
    MarkdownExporting
  46. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  47. final def notify(): Unit

    Definition Classes
    AnyRef
  48. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  49. def output(implicit args: Arguments): HtmlReportOutput

    returns

    a new ReportOutput object creating markup elements

    Definition Classes
    MarkdownExportingHtmlPrinter
  50. def print(m: Any): Unit

    print an object with no newline

    print an object with no newline

    Definition Classes
    Output
  51. def print(spec: ExecutedSpecification)(implicit args: Arguments): Seq[HtmlFile]

    print a sequence of executed fragments for a given specification class into a html file the name of the html file is the full class name

    print a sequence of executed fragments for a given specification class into a html file the name of the html file is the full class name

    Definition Classes
    HtmlPrinter
  52. def printHtml(output: ⇒ HtmlReportOutput)(implicit args: Arguments): (HtmlLinesFile) ⇒ HtmlFile

    a function printing html lines to a file given:

    a function printing html lines to a file given:

    - the list of lines to print - an output object responsible for printing each HtmlLine as xhtml

    Definition Classes
    HtmlPrinter
  53. def printStackTrace(t: Throwable): Unit

    print stacktraces

    print stacktraces

    Definition Classes
    Output
  54. def printf(s: String, args: Any*): Unit

    print several objects according to a format string (see Console.printf)

    print several objects according to a format string (see Console.printf)

    Definition Classes
    ConsoleOutputOutput
  55. def println(m: Any): Unit

    print an object with a newline

    print an object with a newline

    Definition Classes
    Output
  56. def reduce(spec: ExecutedSpecification)(implicit args: Arguments): Seq[HtmlLine]

    Organize the fragments into blocks of html lines to print, grouping all the fragments found after a link into a single block that will be reported on a different html page

    Organize the fragments into blocks of html lines to print, grouping all the fragments found after a link into a single block that will be reported on a different html page

    This works by using a List of HtmlLines as a stack where the head of the list is the current block of lines

    returns

    the HtmlLines to print

    Definition Classes
    HtmlPrinter
  57. def report(spec: SpecificationStructure)(implicit arguments: Arguments): ExecutedSpecification

    report Fragments by:

    report Fragments by:

    • extracting arguments from the Fragments
    • selecting them
    • sequencing fragments in groups
    • executing fragments
    • exporting the results to the output format
    returns

    the reporter

    Definition Classes
    Reporter
  58. def reportPath(url: String): String

    returns

    the file path for the markdown output

    Definition Classes
    MarkdownExporting → OutputDir
  59. lazy val repository: StatisticsRepository

    Attributes
    protected
    Definition Classes
    WithDefaultStatisticsRepository → WithStatisticsRepository
  60. def select(implicit arguments: Arguments): (SpecificationStructure) ⇒ SpecificationStructure

    select function returning a filtered seq of Fragments

    select function returning a filtered seq of Fragments

    Definition Classes
    DefaultReporterDefaultSelectionSelection
  61. def select(fragments: Seq[Fragment])(implicit arguments: Arguments = Arguments()): Seq[Fragment]

    select function returning a filtered seq of Fragments

    select function returning a filtered seq of Fragments

    Definition Classes
    DefaultSelection
  62. def sequence(implicit arguments: Arguments): (SpecificationStructure) ⇒ ExecutableSpecification

    sequence function returning an ordered seq of seq of Fragments

    sequence function returning an ordered seq of seq of Fragments

    Definition Classes
    DefaultReporterDefaultSequenceSequence
  63. def sequence(specName: SpecName, fragments: Seq[Fragment])(implicit arguments: Arguments = Arguments()): Seq[FragmentSeq]

    the sequence method returns sequences of fragments which can be executed concurrently.

    the sequence method returns sequences of fragments which can be executed concurrently. Among the constraints to respect, any Step Fragment must be executed before any following Example Fragment, so that "first" and "last" actions are executed properly in a Specification

    If the arguments specify that the specification is sequential, then each fragment will be executed individually

    Definition Classes
    DefaultSequence
  64. def setStatsOnSpecEndFragments(implicit args: Arguments): ((ExecutedFragment, Stats)) ⇒ ExecutedFragment

    set the statistics on SpecEndFragments after they've been computed by the StatisticsReducer Those statistics are updated from previously executed statistics to calculate trends

    set the statistics on SpecEndFragments after they've been computed by the StatisticsReducer Those statistics are updated from previously executed statistics to calculate trends

    Definition Classes
    DefaultStoring
  65. def sortByFile(specName: SpecName, arguments: Arguments, parentLink: HtmlLink): (Seq[HtmlLine]) ⇒ Tree[HtmlLinesFile]

    Sort HtmlLines into a Tree of HtmlLinesFile object where the tree represents the tree of included specifications

    Sort HtmlLines into a Tree of HtmlLinesFile object where the tree represents the tree of included specifications

    The goal is to create a file per included specification and to use the Tree of files to create a table of contents for the root specification

    Definition Classes
    HtmlPrinter
  66. def store(implicit arguments: Arguments): (ExecutingSpecification) ⇒ ExecutingSpecification

    returns

    a function storing ExecutedFragments

    Definition Classes
    DefaultReporterDefaultStoringStoring
  67. def storeResults: ((SpecName, Seq[(SpecName, ExecutedResult)])) ⇒ repository.type

    store the results by spec name

    store the results by spec name

    Attributes
    protected
    Definition Classes
    DefaultStoring
  68. def storeStats: ((ExecutedFragment, SpecName)) ⇒ ExecutedFragment

    store the statistics: - for SpecEnd -> put the stats in the repository - for a SpecStart that's a link -> read the status of the previous execution

    store the statistics: - for SpecEnd -> put the stats in the repository - for a SpecStart that's a link -> read the status of the previous execution

    Attributes
    protected
    Definition Classes
    DefaultStoring
  69. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  70. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. def writeFile: (HtmlFile) ⇒ Unit

    Attributes
    protected
    Definition Classes
    HtmlFileWriter
  75. def writeFiles(implicit args: Arguments = Arguments()): (Seq[HtmlFile]) ⇒ Unit

    Definition Classes
    MarkdownExportingHtmlFileWriter
  76. def writeXml(xml: NodeSeq)(out: Writer): Unit

    write the xml output to a Writer

    write the xml output to a Writer

    Attributes
    protected
    Definition Classes
    MarkdownExportingHtmlFileWriter

Inherited from ConsoleOutput

Inherited from Output

Inherited from MarkdownExporting

Inherited from HtmlExporting

Inherited from HtmlFileWriter

Inherited from OutputDir

Inherited from HtmlPrinter

Inherited from DefaultReporter

Inherited from Executor

Inherited from DefaultStoring

Inherited from Statistics

Inherited from DefaultExecutionStrategy

Inherited from FragmentExecution

Inherited from DefaultSequence

Inherited from DefaultSelection

Inherited from ExamplesSelection

Inherited from StatusSelection

Inherited from WithDefaultStatisticsRepository

Inherited from WithStatisticsRepository

Inherited from TagSelection

Inherited from TagsAssociation

Inherited from ExamplesIsolation

Inherited from Reporter

Inherited from Exporting

Inherited from Storing

Inherited from ExecutionStrategy

Inherited from Sequence

Inherited from Selection

Inherited from AnyRef

Inherited from Any

Ungrouped