org.specs2.reporter

HtmlReporter

Related Doc: package reporter

trait HtmlReporter extends DefaultReporter with HtmlExporting with ConsoleOutput

Reports a Specification as an Html page

Linear Supertypes
ConsoleOutput, Output, HtmlExporting, HtmlFileWriter, OutputDir, HtmlPrinter, DefaultReporter, Executor, 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. Executor
  10. DefaultStoring
  11. Statistics
  12. DefaultExecutionStrategy
  13. FragmentExecution
  14. DefaultSequence
  15. DefaultSelection
  16. ExamplesSelection
  17. StatusSelection
  18. WithDefaultStatisticsRepository
  19. WithStatisticsRepository
  20. TagSelection
  21. TagsAssociation
  22. ExamplesIsolation
  23. Reporter
  24. Exporting
  25. Storing
  26. ExecutionStrategy
  27. Sequence
  28. Selection
  29. AnyRef
  30. 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

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

    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: HtmlReporter.this.SpecStats }

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

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

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

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

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

    returns

    add a toc to each HtmlFile where relevant

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

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

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

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

    Attributes
    protected
    Definition Classes
    ExamplesIsolation
  16. 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
  17. 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
  18. def delegate(arguments: Arguments): Option[Executor]

    Definition Classes
    Executor
  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

    Definition Classes
    DefaultReporter → DefaultExecutionStrategy → ExecutionStrategy
  22. def execute(f: Fragment)(implicit arguments: Arguments): Product with Serializable with ExecutedFragment

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

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

    Definition Classes
    FragmentExecution
  25. 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
  26. def executeFragment(implicit arguments: Arguments): Function[Fragment, ExecutedFragment]

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

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

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

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

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

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

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

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

    Definition Classes
    TagSelection
  35. def finalize(): Unit

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

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

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

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

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

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

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

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

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

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

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

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

    returns

    a new HtmlReportOutput object creating html elements

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

    Definition Classes
    Output
  49. 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
  50. 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
  51. def printStackTrace(t: Throwable): Unit

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

    Definition Classes
    ConsoleOutput → Output
  53. def println(m: Any): Unit

    Definition Classes
    Output
  54. 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
  55. def report(spec: SpecificationStructure)(implicit arguments: Arguments): ExecutedSpecification

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

    Definition Classes
    OutputDir
  57. lazy val repository: StatisticsRepository

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

    Definition Classes
    DefaultReporter → DefaultSelection → Selection
  59. def select(fragments: Seq[Fragment])(implicit arguments: Arguments): Seq[Fragment]

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

    Definition Classes
    DefaultReporter → DefaultSequence → Sequence
  61. def sequence(specName: SpecName, fragments: Seq[Fragment])(implicit arguments: Arguments): Seq[FragmentSeq]

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

    Definition Classes
    DefaultStoring
  63. 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
  64. def store(implicit arguments: Arguments): (ExecutingSpecification) ⇒ ExecutingSpecification

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

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

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

    Definition Classes
    AnyRef
  68. def toString(): String

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

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

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

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

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

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