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, ExamplesIsolation, Reporter, Exporting, Storing, ExecutionStrategy, Sequence, Selection, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  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. ExamplesIsolation
  21. Reporter
  22. Exporting
  23. Storing
  24. ExecutionStrategy
  25. Sequence
  26. Selection
  27. AnyRef
  28. Any
Visibility
  1. Public
  2. All

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 object HtmlReducer extends Reducer[ExecutedFragment, Seq[HtmlLine]]

  7. implicit def SpecStatsMonoid: Monoid[SpecStats]

    Definition Classes
    Statistics
  8. implicit def SpecsStatisticsMonoid: Monoid[SpecsStatistics]

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

    returns

    add a toc to each HtmlFile where relevant

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

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

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

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. 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
  14. 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
  15. def createHtmlLinesFiles(spec: ExecutedSpecification): 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
  16. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  18. 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
  19. 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
  20. 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
  21. def executeFragment(implicit arguments: Arguments): (Fragment) ⇒ ExecutedFragment

    execute a Fragment.

    execute a Fragment.

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

    returns

    a function exporting an ExecutingSpecification

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

    returns

    fragments according to their previous execution state

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

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  28. def flush(): Unit

    flush the content if necessary

    flush the content if necessary

    Definition Classes
    ConsoleOutput → Output
  29. def foldAll(fs: Seq[ExecutedFragment]): SpecsStatistics

    Definition Classes
    Statistics
  30. final def getClass(): java.lang.Class[_]

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

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

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

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

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

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

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

    Definition Classes
    AnyRef
  39. def output: HtmlReportOutput

    returns

    a new HtmlReportOutput object creating html elements

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

    print an object with no newline

    print an object with no newline

    Definition Classes
    Output
  41. 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
  42. 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
  43. def printStackTrace(t: Throwable): Unit

    print stacktraces

    print stacktraces

    Definition Classes
    Output
  44. 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
    ConsoleOutput → Output
  45. def println(m: Any): Unit

    print an object with a newline

    print an object with a newline

    Definition Classes
    Output
  46. def reduce(spec: ExecutedSpecification): 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
  47. 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
  48. def reportPath(url: String): String

    returns

    the file path for the html output

    Definition Classes
    OutputDir
  49. lazy val repository: StatisticsRepository

    Attributes
    protected
    Definition Classes
    WithDefaultStatisticsRepository → WithStatisticsRepository
  50. 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
  51. 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
  52. 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
  53. 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
  54. 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
  55. 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
  56. def store(implicit args: Arguments): (ExecutingSpecification) ⇒ ExecutingSpecification

    returns

    a function storing ExecutedFragments

    Definition Classes
    DefaultStoring → Storing
  57. def storeResults: ((SpecName, Seq[(SpecName, ExecutedResult)])) ⇒ HtmlReporter.this.repository.type

    store the results by spec name

    store the results by spec name

    Attributes
    protected
    Definition Classes
    DefaultStoring
  58. 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
  59. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  60. def tags(fragments: Seq[Fragment]): Seq[TaggingFragment]

    From a Seq of Fragments create a seq of corresponding tags for each fragment, considering that:

    From a Seq of Fragments create a seq of corresponding tags for each fragment, considering that:

    • a TaggedAs fragment is applicable to the the previous fragment
    • a Tag fragment is applicable to the the next fragment
    • a AsSection fragment is applicable to the the previous fragment to the next AsSection fragment with the same name
    • a Section fragment is applicable to the the next fragment to the next Section fragment with the same name
    Definition Classes
    TagSelection
  61. def toString(): String

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

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

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

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

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

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