org.specs2.reporter

HtmlReporter

trait HtmlReporter extends DefaultReporter with HtmlExporting with ConsoleOutput

Reports a Specification as an Html page

Linear Supertypes
ConsoleOutput, Output, HtmlExporting, HtmlFileWriter, OutputDir, HtmlPrinter, DefaultReporter, DefaultStoring, Statistics, DefaultExecutionStrategy, FragmentExecution, DefaultSequence, DefaultSelection, ExamplesSelection, StatusSelection, WithDefaultStatisticsRepository, WithStatisticsRepository, TagSelection, TagsAssociation, ExamplesIsolation, Reporter, Exporting, Storing, ExecutionStrategy, Sequence, Selection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. HtmlReporter
  2. ConsoleOutput
  3. Output
  4. HtmlExporting
  5. HtmlFileWriter
  6. OutputDir
  7. HtmlPrinter
  8. DefaultReporter
  9. DefaultStoring
  10. Statistics
  11. DefaultExecutionStrategy
  12. FragmentExecution
  13. DefaultSequence
  14. DefaultSelection
  15. ExamplesSelection
  16. StatusSelection
  17. WithDefaultStatisticsRepository
  18. WithStatisticsRepository
  19. TagSelection
  20. TagsAssociation
  21. ExamplesIsolation
  22. Reporter
  23. Exporting
  24. Storing
  25. ExecutionStrategy
  26. Sequence
  27. Selection
  28. AnyRef
  29. 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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

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

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

    Definition Classes
    Any
  6. implicit lazy val HtmlReducer: Reducer[ExecutedFragment, Stream[HtmlLine]]

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

    Definition Classes
    Statistics
  8. object SpecsStatistics extends Product with Serializable

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

    Definition Classes
    Statistics
  10. val StatisticsReducer: Reducer[ExecutedFragment, SpecsStatistics]

    Definition Classes
    Statistics
  11. val StatsReducer: Reducer[ExecutedFragment, SpecStats]

    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. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  21. 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
    DefaultExecutionStrategy → ExecutionStrategy
  22. 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
  23. 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
  24. def executeFragment(implicit arguments: Arguments): (Fragment) ⇒ ExecutedFragment

    execute a Fragment.

    execute a Fragment.

    Definition Classes
    FragmentExecution
  25. def export(implicit arguments: Arguments): (ExecutingSpecification) ⇒ ExecutedSpecification

    returns

    a function exporting an ExecutingSpecification

    Definition Classes
    HtmlExporting → Exporting
  26. 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
  27. 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
  28. def filterPrevious(implicit commandLineArgs: Arguments): (Seq[(Fragment, Arguments, SpecName)]) ⇒ Seq[(Fragment, Arguments, SpecName)]

    returns

    fragments according to their previous execution state

    Definition Classes
    StatusSelection
  29. 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
  30. def finalize(): Unit

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

    flush the content if necessary

    flush the content if necessary

    Definition Classes
    ConsoleOutputOutput
  32. def foldAll(fs: Seq[ExecutedFragment]): SpecsStatistics

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

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

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

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

    Definition Classes
    Any
  37. 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
  38. def isolateSteps(fragments: Seq[Fragment])(implicit arguments: Arguments): Seq[FragmentSeq]

    Attributes
    protected
    Definition Classes
    DefaultSequence
  39. final def ne(arg0: AnyRef): Boolean

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

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

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

    returns

    a new HtmlReportOutput object creating html elements

    Definition Classes
    HtmlPrinter
  43. def print(m: Any): Unit

    print an object with no newline

    print an object with no newline

    Definition Classes
    Output
  44. 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
  45. def printHtml(output: ⇒ HtmlReportOutput): (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
  46. def printStackTrace(t: Throwable): Unit

    print stacktraces

    print stacktraces

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

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

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

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

    print an object with a newline

    print an object with a newline

    Definition Classes
    Output
  49. 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
  50. 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
  51. def reportPath(url: String): String

    returns

    the file path for the html output

    Definition Classes
    OutputDir
  52. lazy val repository: StatisticsRepository

    Attributes
    protected
    Definition Classes
    WithDefaultStatisticsRepository → WithStatisticsRepository
  53. 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
  54. 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
    DefaultSelectionSelection
  55. 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
  56. 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
    DefaultSequence
  57. 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
  58. 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
  59. def store(implicit args: Arguments): (ExecutingSpecification) ⇒ ExecutingSpecification

    returns

    a function storing ExecutedFragments

    Definition Classes
    DefaultStoring → Storing
  60. 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
  61. 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
  62. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  63. def toString(): String

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

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

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

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

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

    Definition Classes
    HtmlFileWriter
  69. 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
    HtmlFileWriter

Inherited from ConsoleOutput

Inherited from Output

Inherited from HtmlExporting

Inherited from HtmlFileWriter

Inherited from OutputDir

Inherited from HtmlPrinter

Inherited from DefaultReporter

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