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, 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. HtmlFileWriter
  6. OutputDir
  7. HtmlPrinter
  8. DefaultReporter
  9. DefaultStoring
  10. Statistics
  11. DefaultExecutionStrategy
  12. FragmentExecution
  13. DefaultSequence
  14. DefaultSelection
  15. WithDefaultStatisticsRepository
  16. WithStatisticsRepository
  17. Reporter
  18. Exporting
  19. Storing
  20. ExecutionStrategy
  21. Sequence
  22. Selection
  23. AnyRef
  24. 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, Seq[HtmlLine]]

    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

    Attributes
    protected
    Definition Classes
    HtmlFileWriter
  12. def createToc (htmlFiles: Tree[HtmlLinesFile])(implicit args: Arguments): TreeToc

    returns

    a global toc

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

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

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

    execute a Fragment.

    execute a Fragment.

    Definition Classes
    FragmentExecution
  19. def export (implicit args: Arguments): (ExecutingSpecification) ⇒ ExportType

    returns

    a function exporting an ExecutingSpecification

    Definition Classes
    HtmlExporting → Exporting
  20. 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
  21. 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
  22. 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
  23. 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
  24. def finalize (): Unit

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

    flush the content if necessary

    flush the content if necessary

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

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

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

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

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

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

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

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

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

    Attributes
    final
    Definition Classes
    AnyRef
  35. def output : HtmlReportOutput

    returns

    a new HtmlReportOutput object creating html elements

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

    print an object with no newline

    print an object with no newline

    Definition Classes
    Output
  37. def print (spec: ExecutedSpecification)(implicit args: Arguments): Stream[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
  38. def printHtml (output: ⇒ HtmlReportOutput, file: HtmlLinesFile, toc: NodeSeq): NodeSeq

    returns

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

    Definition Classes
    HtmlPrinter
  39. def printHtml (toc: TreeToc, output: ⇒ HtmlReportOutput): (HtmlLinesFile) ⇒ HtmlFile

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

    print stacktraces

    print stacktraces

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

    print an object with a newline

    print an object with a newline

    Definition Classes
    Output
  43. 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
  44. def report (spec: SpecificationStructure)(implicit arguments: Arguments): HtmlReporter.this.type

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

    returns

    the file path for the html output

    Definition Classes
    OutputDir
  46. lazy val repository : StatisticsRepository

    Attributes
    protected
    Definition Classes
    WithDefaultStatisticsRepository → WithStatisticsRepository
  47. 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
  48. 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
    DefaultSelection
  49. 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
  50. 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
  51. 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
  52. def sortByFile (specName: SpecName, parentLink: HtmlLink): (Seq[HtmlLine]) ⇒ Tree[HtmlLinesFile]

    Definition Classes
    HtmlPrinter
  53. def store (implicit args: Arguments): (ExecutingSpecification) ⇒ ExecutingSpecification

    returns

    a function storing ExecutedFragments

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

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

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

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  62. def writeFile : (HtmlFile) ⇒ Unit

    Attributes
    protected
    Definition Classes
    HtmlFileWriter
  63. def writeFiles : (Seq[HtmlFile]) ⇒ Unit

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