MarkdownReporter

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

   

   Definition Classes

   Statistics

7. implicit def SpecsStatisticsMonoid: Monoid[SpecsStatistics] { val zero: MarkdownReporter.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. def markdownExtension: String

    

    markdown and .md is the default output format

    markdown and .md is the default output format

    Definition Classes

    MarkdownExporting

45. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

46. final def notify(): Unit

    

    Definition Classes

    AnyRef

47. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

48. def output(implicit args: Arguments): HtmlReportOutput

    
    returns

    a new ReportOutput object creating markup elements

    Definition Classes

    MarkdownExporting → HtmlPrinter

49. def print(m: Any): Unit

    

    Definition Classes

    Output

50. 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

51. 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

52. def printStackTrace(t: Throwable): Unit

    

    Definition Classes

    Output

53. def printf(s: String, args: Any*): Unit

    

    Definition Classes

    ConsoleOutput → Output

54. def println(m: Any): Unit

    

    Definition Classes

    Output

55. 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

56. def report(spec: SpecificationStructure)(implicit arguments: Arguments): ExecutedSpecification

    

    Definition Classes

    Reporter

57. def reportPath(url: String): String

    
    returns

    the file path for the markdown output

    Definition Classes

    MarkdownExporting → OutputDir

58. lazy val repository: StatisticsRepository

    

    Attributes

    protected

    Definition Classes

    WithDefaultStatisticsRepository → WithStatisticsRepository

59. def select(implicit arguments: Arguments): (SpecificationStructure) ⇒ SpecificationStructure

    

    Definition Classes

    DefaultReporter → DefaultSelection → Selection

60. def select(fragments: Seq[Fragment])(implicit arguments: Arguments): Seq[Fragment]

    

    Definition Classes

    DefaultSelection

61. def sequence(implicit arguments: Arguments): (SpecificationStructure) ⇒ ExecutableSpecification

    

    Definition Classes

    DefaultReporter → DefaultSequence → Sequence

62. def sequence(specName: SpecName, fragments: Seq[Fragment])(implicit arguments: Arguments): Seq[FragmentSeq]

    

    Definition Classes

    DefaultSequence

63. def setStatsOnSpecEndFragments(implicit args: Arguments): ((ExecutedFragment, Stats)) ⇒ ExecutedFragment

    

    Definition Classes

    DefaultStoring

64. 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

65. def store(implicit arguments: Arguments): (ExecutingSpecification) ⇒ ExecutingSpecification

    

    Definition Classes

    DefaultReporter → DefaultStoring → Storing

66. def storeResults: ((SpecName, Seq[(SpecName, ExecutedResult)])) ⇒ repository.type

    

    Attributes

    protected

    Definition Classes

    DefaultStoring

67. def storeStats: ((ExecutedFragment, SpecName)) ⇒ ExecutedFragment

    

    Attributes

    protected

    Definition Classes

    DefaultStoring

68. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

69. def toString(): String

    

    Definition Classes

    AnyRef → Any

70. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

71. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

72. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

73. def writeFile: (HtmlFile) ⇒ Unit

    

    Attributes

    protected

    Definition Classes

    HtmlFileWriter

74. def writeFiles(implicit args: Arguments = Arguments()): (Seq[HtmlFile]) ⇒ Unit

    

    Definition Classes

    MarkdownExporting → HtmlFileWriter

75. 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

    MarkdownExporting → HtmlFileWriter