Updated serializer to be streaming #89

Author: sksamuel

scalac-scoverage-plugin/src/main/scala/scoverage/Serializer.scala

@@ -3,77 +3,83 @@ package scoverage
 import java.io._
 
 import scala.io.Source
-import scala.xml.{XML, Utility, Node}
+import scala.xml.XML
 
 object Serializer {
 
-  /**
-   * Write out coverage data to the given data directory
-   */
+  // Write out coverage data to the given data directory, using the default coverage filename
   def serialize(coverage: Coverage, dataDir: String): Unit = serialize(coverage, coverageFile(dataDir))
-  def serialize(coverage: Coverage, file: File): Unit = IOUtils.writeToFile(file, serialize(coverage).toString)
 
-  def coverageFile(dataDir: File): File = coverageFile(dataDir.getAbsolutePath)
-  def coverageFile(dataDir: String): File = new File(dataDir, Constants.CoverageFileName)
+  // Write out coverage data to given file.
+  def serialize(coverage: Coverage, file: File): Unit = {
+    val writer = new BufferedWriter(new FileWriter(file))
+    serialize(coverage, writer)
+    writer.close()
+  }
 
-  def serialize(coverage: Coverage): Node = {
-    val lines = coverage.statements.map(stmt => {
-      <statement>
-        <source>
-          {stmt.source}
-        </source>
-        <package>
-          {stmt.location.packageName}
-        </package>
-        <class>
-          {stmt.location.className}
-        </class>
-        <classType>
-          {stmt.location.classType.toString}
-        </classType>
-        <topLevelClass>
-          {stmt.location.topLevelClass}
-        </topLevelClass>
-        <method>
-          {stmt.location.method}
-        </method>
-        <path>
-          {stmt.location.sourcePath}
-        </path>
-        <id>
-          {stmt.id.toString}
-        </id>
-        <start>
-          {stmt.start.toString}
-        </start>
-        <end>
-          {stmt.end.toString}
-        </end>
-        <line>
-          {stmt.line.toString}
-        </line>
-        <description>
-          {escape(stmt.desc)}
-        </description>
-        <symbolName>
-          {escape(stmt.symbolName)}
-        </symbolName>
-        <treeName>
-          {escape(stmt.treeName)}
-        </treeName>
-        <branch>
-          {stmt.branch.toString}
-        </branch>
-        <count>
-          {stmt.count.toString}
-        </count>
-      </statement>
-    })
-    Utility.trim(<statements>
-      {lines}
-    </statements>)
+  def serialize(coverage: Coverage, writer: Writer): Unit = {
+    def writeStatement(stmt: Statement, writer: Writer): Unit = {
+      writer.write {
+        <statement>
+          <source>
+            {stmt.source}
+          </source>
+          <package>
+            {stmt.location.packageName}
+          </package>
+          <class>
+            {stmt.location.className}
+          </class>
+          <classType>
+            {stmt.location.classType.toString}
+          </classType>
+          <topLevelClass>
+            {stmt.location.topLevelClass}
+          </topLevelClass>
+          <method>
+            {stmt.location.method}
+          </method>
+          <path>
+            {stmt.location.sourcePath}
+          </path>
+          <id>
+            {stmt.id.toString}
+          </id>
+          <start>
+            {stmt.start.toString}
+          </start>
+          <end>
+            {stmt.end.toString}
+          </end>
+          <line>
+            {stmt.line.toString}
+          </line>
+          <description>
+            {escape(stmt.desc)}
+          </description>
+          <symbolName>
+            {escape(stmt.symbolName)}
+          </symbolName>
+          <treeName>
+            {escape(stmt.treeName)}
+          </treeName>
+          <branch>
+            {stmt.branch.toString}
+          </branch>
+          <count>
+            {stmt.count.toString}
+          </count>
+        </statement>.toString + "\n"
+      }
+    }
+    writer.write("<statements>\n")
+    coverage.statements.foreach(stmt => writeStatement(stmt, writer))
+    writer.write("</statements>")
   }
 
+  def coverageFile(dataDir: File): File = coverageFile(dataDir.getAbsolutePath)
+  def coverageFile(dataDir: String): File = new File(dataDir, Constants.CoverageFileName)
+
   def deserialize(str: String): Coverage = {
     val xml = XML.loadString(str)
     val statements = xml \ "statement" map (node => {

scalac-scoverage-plugin/src/test/scala/scoverage/compiler.scala renamed to scalac-scoverage-plugin/src/test/scala/scoverage/ScoverageCompiler.scala

@@ -1,5 +1,7 @@
 package scoverage
 
+import java.io.StringWriter
+
 import org.scalatest.{OneInstancePerTest, FunSuite}
 import org.scalatest.mock.MockitoSugar
 
@@ -21,8 +23,9 @@ class SerializerTest extends FunSuite with MockitoSugar with OneInstancePerTest
         <source>mysource</source> <package>org.scoverage</package> <class>test</class> <classType>Trait</classType> <topLevelClass>test</topLevelClass> <method>mymethod</method> <path>mypath</path> <id>14</id> <start>100</start> <end>200</end> <line>4</line> <description>def test : String</description> <symbolName>test</symbolName> <treeName>DefDef</treeName> <branch>true</branch> <count>32</count>
       </statement>
     </statements>
-    val actual = Serializer.serialize(coverage)
-    assert(Utility.trim(expected) === Utility.trim(actual))
+    val writer = new StringWriter()
+    val actual = Serializer.serialize(coverage, writer)
+    assert(Utility.trim(expected) === Utility.trim(xml.XML.loadString(writer.toString)))
   }
 
   test("coverage should be deserializable from xml") {