Merge pull request #25 from rocketlawyer/feature/csvTargetLanguage

Add CSV target language

src/main/scala/com/typesafe/sbt/SbtLicenseReport.scala

@@ -20,6 +20,7 @@ object SbtLicenseReport extends AutoPlugin {
     def LicenseReportConfiguration = com.typesafe.sbt.license.LicenseReportConfiguration
     def Html = com.typesafe.sbt.license.Html
     def MarkDown = com.typesafe.sbt.license.MarkDown
+    def Csv = com.typesafe.sbt.license.Csv
 
     // Keys
     val updateLicenses = taskKey[LicenseReport]("Construct a report of used licenses in a project.")
@@ -59,11 +60,11 @@ object SbtLicenseReport extends AutoPlugin {
       // TODO - Maybe we need a general purpose reporting directory
       licenseReportDir := target.value / "license-reports",
       licenseReportStyleRules := None,
-      licenseReportTypes := Seq(MarkDown, Html),
+      licenseReportTypes := Seq(MarkDown, Html, Csv),
       licenseReportConfigurations := {
         val dir = licenseReportDir.value
         val styleRules = licenseReportStyleRules.value
-        // TODO - Configurable language (markdown/html) rather than both always
+        // TODO - Configurable language (markdown/html/csv) rather than all always
         val reportTypes = licenseReportTypes.value
         val notesLookup = licenseReportNotes.value.lift
         val config = LicenseReportConfiguration(licenseReportTitle.value, reportTypes, licenseReportMakeHeader.value, notesLookup, licenseFilter.value, dir, styleRules)

src/main/scala/com/typesafe/sbt/license/TargetLanguage.scala

@@ -13,8 +13,6 @@ sealed trait TargetLanguage {
   def blankLine(): String
   /** Creates something equivalent to an html <h1> tag. */
   def header1(msg: String): String
-  /** Creates something equivalent to an html <h4> tag. */
-  def header4(msg: String): String
   /** The syntax for the header of a table. */
   def tableHeader(firstColumn: String, secondColumn: String, thirdColumn: String, fourthColumn: String): String
   /** The syntax for a row of a table. */
@@ -32,7 +30,6 @@ case object MarkDown extends TargetLanguage {
   def createHyperLink(link: String, content: String): String =
     s"[$content]($link)"
   def blankLine(): String = "\n"
-  def header4(msg: String): String = s"#### $msg\n"
   def header1(msg: String): String = s"# $msg\n"
   def tableHeader(firstColumn: String, secondColumn: String, thirdColumn: String, fourthColumn: String): String =
     s"""
@@ -66,7 +63,6 @@ case object Html extends TargetLanguage {
     s"""<a href="$link">$content</a>"""
   def blankLine(): String = "<p>&nbsp;</p>"
   def header1(msg: String): String = s"<h1>$msg</h1>"
-  def header4(msg: String): String = s"<h4>$msg</h4>"
   def tableHeader(firstColumn: String, secondColumn: String, thirdColumn: String, fourthColumn: String): String =
     s"""<table border="0" cellspacing="0" cellpading="1">
       <thead><tr><th>$firstColumn</th><th>$secondColumn</th><th>$thirdColumn</th><th>$fourthColumn</th></tr></thead>
@@ -77,3 +73,20 @@ case object Html extends TargetLanguage {
 
   def htmlEncode(s: String) = org.apache.commons.lang3.StringEscapeUtils.escapeHtml4(s)
 }
+
+case object Csv extends TargetLanguage {
+  val ext = "csv"
+  def documentStart(title: String, reportStyleRules: Option[String]): String = ""
+  def documentEnd(): String = ""
+  def createHyperLink(link: String, content: String): String = {
+    if (link != null && !link.trim().isEmpty()) s"$content ($link)" else s"$content"
+  }
+  def blankLine(): String = ""
+  def header1(msg: String): String = ""
+  def tableHeader(firstColumn: String, secondColumn: String, thirdColumn: String, fourthColumn: String): String =
+    tableRow(firstColumn, secondColumn, thirdColumn, fourthColumn)
+  def tableRow(firstColumn: String, secondColumn: String, thirdColumn: String, fourthColumn: String): String =
+    s"""${csvEncode(firstColumn)},${csvEncode(secondColumn)},${csvEncode(thirdColumn)},${csvEncode(fourthColumn)}\n"""
+  def tableEnd: String = ""
+  def csvEncode(s: String): String = org.apache.commons.lang3.StringEscapeUtils.escapeCsv(s)
+}

src/sbt-test/dumpLicenseReport/custom-report/test

@@ -1,4 +1,5 @@
 > dumpLicenseReport
 $ exists target/license-reports/lreport.md
 > check
-$ exists target/license-reports/test-config.html
+$ exists target/license-reports/test-config.html
+-$ exists target/license-reports/lreport.csv

src/sbt-test/dumpLicenseReport/default-report/test

@@ -1,4 +1,5 @@
 > dumpLicenseReport
 $ exists target/license-reports/example-licenses.md
 $ exists target/license-reports/example-licenses.html
+$ exists target/license-reports/example-licenses.csv
 > check