added option to display branch coverage in new Scala report, converted Java to Scala, fixed ScalaDoc warning, misc small other cleanup

Author: Joachim Hofer

build.sbt

@@ -4,11 +4,11 @@ name := "jacoco4sbt"
 
 organization := "de.johoop"
 
-version := "2.1.1"
+version := "2.1.2-SNAPSHOT"
 
 resolvers += "Sonatype Release" at "https://oss.sonatype.org/content/repositories/releases"
 
-scalaVersion := "2.10.2"
+scalaVersion := "2.10.3"
 
 libraryDependencies ++= Seq(
   "org.jacoco" % "org.jacoco.core" % "0.6.3.201306030806" artifacts(Artifact("org.jacoco.core", "jar", "jar")),

publish.sbt

@@ -45,5 +45,9 @@ pomExtra := (
       <id>paddymahoney</id>
       <name>Patrick Mahoney</name>
     </developer>
+    <developer>
+      <id>retronym</id>
+      <name>Jason Zaugg</name>
+    </developer>
   </developers>
 )

readme.md

@@ -6,6 +6,9 @@ See the **[Wiki](https://bitbucket.org/jmhofer/jacoco4sbt/wiki/)** for details.
 
 ## Change Log
 
+* *2.1.2*
+    * Added a Scala-specific report format (contributed by Jason)
+
 * *2.1.1*
 
     * Updated for sbt 0.13.0 (final)
@@ -27,7 +30,11 @@ See the **[Wiki](https://bitbucket.org/jmhofer/jacoco4sbt/wiki/)** for details.
 
 ## Contributors
 
-Many thanks to [Andreas Flierl](https://bitbucket.org/asflierl), [Joost den Boer](https://bitbucket.org/diversit) and [Patrick Mahoney](https://bitbucket.org/paddymahoney) for their awesome contributions!
+Many thanks to
+[Andreas Flierl](https://bitbucket.org/asflierl),
+[Jason Zaugg](https://bitbucket.org/retronym),
+[Joost den Boer](https://bitbucket.org/diversit) and
+[Patrick Mahoney](https://bitbucket.org/paddymahoney) for their awesome contributions!
 
 ## License
 

src/main/scala/de/johoop/jacoco4sbt/FormattedReport.scala

@@ -12,22 +12,13 @@
 package de.johoop.jacoco4sbt
 
 import org.jacoco.report.FileMultiReportOutput
-import org.jacoco.report.IMultiReportOutput
 import org.jacoco.report.IReportVisitor
 import org.jacoco.report.xml.XMLFormatter
 import org.jacoco.report.html.HTMLFormatter
 import org.jacoco.report.csv.CSVFormatter
 import java.io.File
 import java.io.FileOutputStream
 
-object FormattedReport {
-  def apply(format: String, encoding: String) = format match {
-    case "html" => HTMLReport(encoding)
-    case "xml" => XMLReport(encoding)
-    case "csv" => CSVReport(encoding)
-  }
-}
-
 sealed abstract class FormattedReport {
   val encoding : String
   def visitor(directory: File) : IReportVisitor
@@ -41,9 +32,9 @@ case class HTMLReport(encoding: String = "utf-8") extends FormattedReport {
   }
 }
 
-case class ScalaHTMLReport(encoding: String = "utf-8") extends FormattedReport {
+case class ScalaHTMLReport(encoding: String = "utf-8", withBranchCoverage: Boolean = false) extends FormattedReport {
   def visitor(directory: File) = {
-    val formatter = new ScalaHtmlFormatter
+    val formatter = new ScalaHtmlFormatter(withBranchCoverage)
     formatter setOutputEncoding encoding
     formatter createVisitor new FileMultiReportOutput(new File(directory, "html"))
   }

src/main/scala/de/johoop/jacoco4sbt/Report.scala

@@ -13,8 +13,6 @@ package de.johoop.jacoco4sbt
 
 import org.jacoco.core.data._
 import org.jacoco.core.analysis._
-import org.jacoco.report._
-import html.HTMLFormatter
 
 import java.io.File
 import java.io.FileInputStream
@@ -54,7 +52,7 @@ class Report(executionDataFile: File, classDirectories: Seq[File],
     val coverageBuilder = new CoverageBuilder
     val analyzer = new FilteringAnalyzer(executionDataStore, coverageBuilder)
 
-    classDirectories foreach { analyzer analyzeAll _ }
+    classDirectories foreach (analyzer analyzeAll)
 
     coverageBuilder getBundle reportTitle
   }
@@ -64,7 +62,7 @@ class Report(executionDataFile: File, classDirectories: Seq[File],
 
     val visitor = reportFormat.visitor(reportDirectory)
 
-    visitor.visitInfo(sessionInfoStore.getInfos, executionDataStore.getContents);
+    visitor.visitInfo(sessionInfoStore.getInfos, executionDataStore.getContents)
     visitor.visitBundle(bundleCoverage, new DirectoriesSourceFileLocator(sourceDirectories, sourceEncoding, tabWidth)) 
 
     visitor.visitEnd()

src/main/scala/de/johoop/jacoco4sbt/ScalaHtmlFormatter.java

@@ -0,0 +1,47 @@
+package de.johoop.jacoco4sbt
+
+import org.jacoco.core.analysis.ICoverageNode
+import org.jacoco.report.html.HTMLFormatter
+import org.jacoco.report.internal.html.resources.Styles
+import org.jacoco.report.internal.html.table._
+import scala.Some
+
+/**
+  * Omits displaying instruction and branch coverage in the coverage tables,
+  * as Scala generates null checks which make these too noisy.
+  *
+  * TODO: Find a way to remove them from the annotated source code reports, too.
+  */
+class ScalaHtmlFormatter(withBranchCoverage: Boolean) extends HTMLFormatter {
+  private var table: Option[Table] = None
+
+  setLanguageNames(new ScalaLanguageNames)
+
+  override def getTable: Table = {
+    table getOrElse {
+      val newTable = createTable
+      table = Some(newTable)
+      newTable
+    }
+  }
+
+  private def createTable: Table = {
+    val t: Table = new Table
+    t.add("Element", null, new LabelColumn, false)
+    t.add("Missed Lines", Styles.BAR, new BarColumn(ICoverageNode.CounterEntity.LINE, getLocale), true)
+    t.add("Total Lines", Styles.CTR1, CounterColumn.newTotal(ICoverageNode.CounterEntity.LINE, getLocale), false)
+    if (withBranchCoverage) {
+      t.add("Missed Branches", Styles.BAR, new BarColumn(ICoverageNode.CounterEntity.BRANCH, getLocale), false)
+      t.add("Cov.", Styles.CTR2, new PercentageColumn(ICoverageNode.CounterEntity.BRANCH, getLocale), false)
+    }
+    addMissedTotalColumns(t, "Methods", ICoverageNode.CounterEntity.METHOD)
+    addMissedTotalColumns(t, "Classes", ICoverageNode.CounterEntity.CLASS)
+
+    t
+  }
+
+  private def addMissedTotalColumns(table: Table, label: String, entity: ICoverageNode.CounterEntity) {
+    table.add("Missed", Styles.CTR1, CounterColumn.newMissed(entity, getLocale), false)
+    table.add(label, Styles.CTR2, CounterColumn.newTotal(entity, getLocale), false)
+  }
+}

src/main/scala/de/johoop/jacoco4sbt/ScalaHtmlFormatter.scala

@@ -10,7 +10,7 @@ import scala.collection.JavaConverters._
   *  - classes contains static forwarders to methods in the companion object (for convenient Java interop)
   *  - methods in (boxed) value classes forward to the method body in the companion object
   *  - implicit classes creates a factory method beside the class.
-  *  - lazy vals have an accessor that forwards to $lzycompute, which is the method
+  *  - lazy vals have an accessor that forwards to `\$lzycompute`, which is the method
   *    with the interesting code.
   */
 object ScalaForwarderDetector {