org.specs2.reporter

HtmlReporter

trait HtmlReporter extends DefaultReporter with HtmlExporting with ConsoleOutput

Reports a Specification as an Html page

Linear Supertypes
ConsoleOutput, Output, HtmlExporting, HtmlPrinter, OutputDir, DefaultReporter, DefaultStoring, Statistics, DefaultExecutionStrategy, FragmentExecution, DefaultSequence, DefaultSelection, WithDefaultStatisticsRepository, WithStatisticsRepository, 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. HtmlPrinter
  6. OutputDir
  7. DefaultReporter
  8. DefaultStoring
  9. Statistics
  10. DefaultExecutionStrategy
  11. FragmentExecution
  12. DefaultSequence
  13. DefaultSelection
  14. WithDefaultStatisticsRepository
  15. WithStatisticsRepository
  16. Reporter
  17. Exporting
  18. Storing
  19. ExecutionStrategy
  20. Sequence
  21. Selection
  22. AnyRef
  23. Any
Visibility
  1. Public
  2. All

Type Members

  1. type ExportType = Unit

    Definition Classes
    HtmlExporting → Exporting

Value Members

  1. def != (arg0: AnyRef): Boolean

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

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

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

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

    Attributes
    final
    Definition Classes
    Any
  6. object HtmlReducer extends Reducer[ExecutedFragment, List[Html]]

    Attributes
    implicit
  7. implicit def SpecStatsMonoid : Monoid[SpecStats]

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

    Attributes
    implicit
    Definition Classes
    Statistics
  9. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  10. def clone (): AnyRef

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

    copy css and images file to the output directory

    copy css and images file to the output directory

    Definition Classes
    HtmlPrinter
  12. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  13. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def execute (implicit arguments: Arguments): (Seq[FragmentSeq]) ⇒ List[ExecutedFragment]

    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
  15. 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
  16. 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
  17. def executeFragment (implicit arguments: Arguments): Function[Fragment, ExecutedFragment]

    execute a Fragment.

    execute a Fragment.

    Definition Classes
    FragmentExecution
  18. def export (s: SpecificationStructure)(implicit args: Arguments): (Seq[ExecutedFragment]) ⇒ Unit

    returns

    a function exporting ExecutedFragments

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

    returns

    filter fragments according to their previous execution state

    Definition Classes
    DefaultSelection
  22. 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
    DefaultSelection
  23. def finalize (): Unit

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

    flush the content if necessary

    flush the content if necessary

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

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

    Attributes
    final
    Definition Classes
    AnyRef → Any
  27. def hashCode (): Int

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

    Attributes
    protected
    Definition Classes
    DefaultSelection
  29. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  30. def isolateSteps (fragments: Seq[Fragment])(implicit arguments: Arguments): Seq[FragmentSeq]

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

    Attributes
    final
    Definition Classes
    AnyRef
  32. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  33. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  34. def print (m: Any): Unit

    print an object with no newline

    print an object with no newline

    Definition Classes
    Output
  35. def print (s: SpecificationStructure, fs: Seq[ExecutedFragment])(implicit args: Arguments): Unit

    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
  36. def printHtml (output: HtmlResultOutput, lines: HtmlLines, globalToc: NodeSeq)(implicit args: Arguments): HtmlResultOutput

    returns

    an HtmlResultOutput object containing all the html corresponding to the html lines to print

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

    print stacktraces

    print stacktraces

    Definition Classes
    Output
  38. 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
  39. def println (m: Any): Unit

    print an object with a newline

    print an object with a newline

    Definition Classes
    Output
  40. def reduce (specification: SpecName, fs: Seq[ExecutedFragment], parentLink: HtmlLink): Tree[HtmlLines]

    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
  41. def report (spec: SpecificationStructure)(implicit arguments: Arguments): HtmlReporter.this.type

    report Fragments by: * extracting arguments from the Fragments * selecting them * sequencing fragments in groups * executing fragments * exporting the results to the output format

    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
  42. def reportPath (url: String): String

    returns

    the file path for the html output

    Definition Classes
    OutputDir
  43. lazy val repository : StatisticsRepository

    Attributes
    protected
    Definition Classes
    WithDefaultStatisticsRepository → WithStatisticsRepository
  44. def select (fragments: Seq[Fragment])(implicit commandLineArgs: Arguments = Arguments()): Seq[Fragment]

    select function returning a filtered seq of Fragments

    select function returning a filtered seq of Fragments

    Definition Classes
    DefaultSelection
  45. def select (implicit arguments: Arguments): (Fragments) ⇒ Seq[Fragment]

    select function returning a filtered seq of Fragments

    select function returning a filtered seq of Fragments

    Definition Classes
    DefaultSelection
  46. def sequence (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
  47. def sequence (implicit arguments: Arguments): (Seq[Fragment]) ⇒ Seq[FragmentSeq]

    sequence function returning an ordered seq of seq of Fragments

    sequence function returning an ordered seq of seq of Fragments

    Definition Classes
    DefaultSequence
  48. 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
  49. def store (implicit args: Arguments): (Seq[ExecutedFragment]) ⇒ Seq[ExecutedFragment]

    returns

    a function storing ExecutedFragments

    Definition Classes
    DefaultStoring → Storing
  50. 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
  51. 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
  52. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  53. 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
    DefaultSelection
  54. def toString (): String

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

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from ConsoleOutput

Inherited from Output

Inherited from HtmlExporting

Inherited from HtmlPrinter

Inherited from OutputDir

Inherited from DefaultReporter

Inherited from DefaultStoring

Inherited from Statistics

Inherited from DefaultExecutionStrategy

Inherited from FragmentExecution

Inherited from DefaultSequence

Inherited from DefaultSelection

Inherited from WithDefaultStatisticsRepository

Inherited from WithStatisticsRepository

Inherited from Reporter

Inherited from Exporting

Inherited from Storing

Inherited from ExecutionStrategy

Inherited from Sequence

Inherited from Selection

Inherited from AnyRef

Inherited from Any