adt + formatters

Author: yurique

README.md

@@ -8,55 +8,73 @@ A library for diff-ing strings.
 "app.tulz" %%% "stringdiff" % "0.1.1" 
 ```
 
+### Usage
+
+#### Output with ANSI colors:
 
 ```scala
-import app.tulz.diff.StringDiff
+import app.tulz.diff._
 
 StringDiff("prefix common1 common2 inside1 common3 common4", "common1 common2 inside2 common3 suffix")
 // or 
-StringDiff.default("prefix common1 common2 inside1 common3 common4", "common1 common2 inside2 common3 suffix")
+StringDiff.withFormat("prefix common1 common2 inside1 common3 common4", "common1 common2 inside2 common3 suffix")(AnsiColorDiffFormat)
 ```
 
 ![screenshot 1](doc/images/screenshot1.png)
 
+#### Output without colors
+
 ```scala
-import app.tulz.diff.StringDiff
+import app.tulz.diff._
 
-StringDiff.xml("prefix common1 common2 inside1 common3 common4", "common1 common2 inside2 common3 suffix")
+StringDiff.text("prefix common1 common2 inside1 common3 common4", "common1 common2 inside2 common3 suffix")
+// or 
+StringDiff.withFormat("prefix common1 common2 inside1 common3 common4", "common1 common2 inside2 common3 suffix")(TextDiffFormat)
 ```
 
-```xml
-<diff><no-match><expected><empty/></expected><actual>prefix </actual></no-match><match>common1 common2 </match><no-match><expected>inside2</expected><actual>inside1</actual></no-match><match> common3 </match><no-match><expected>suffix</expected><actual>common4</actual></no-match></diff>
+```
+[prefix |∅]common1 common2 [inside1 |inside2 ]common3 [∅|suffix]
 ```
 
+#### Raw AST
 
 ```scala
+import app.tulz.diff.StringDiff
 
+StringDiff.raw("prefix common1 common2 inside1 common3 common4", "common1 common2 inside2 common3 suffix") // List[DiffBlock]
+```
 
-import scala.Console._
-
-val diff = new StringDiff(
-  beforeAll = "",
-  beforeNoMatch = "[",
-  beforeExpected = s"expected: ${YELLOW}",
-  afterExpected = RESET,
-  between = ", ",
-  beforeActual = s"actual: ${RED}",
-  afterActual = RESET,
-  empty = s"${MAGENTA}empty${RESET}",
-  afterNoMatch = "]",
-  beforeMatch = GREEN,
-  afterMatch = RESET,
-  afterAll = ""
+```scala
+List(
+  Extra(List("prefix", " ")), 
+  Match(List("common1", " ", "common2", " ")), 
+  Different(List("inside1", " "),List("inside2", " ")), 
+  Match(List("common3", " ")), 
+  Missing(List("suffix"))
 )
+```
 
-diff("prefix common1 common2 inside1 common3 common4", "common1 common2 inside2 common3 suffix")
+#### Custom format
 
-// custom
+```scala
+import app.tulz.diff.StringDiff
+import scala.Console._
+
+val customFormat: DiffFormat[String] = (diff: List[DiffBlock]) =>
+  diff.map {
+    case DiffBlock.Match(m)                    => m.mkString
+    case DiffBlock.Missing(expected)           => s"[missing: ${YELLOW}${expected.mkString}${RESET}]"
+    case DiffBlock.Extra(actual)               => s"[extra: ${RED}${actual.mkString}${RESET}]"
+    case DiffBlock.Different(actual, expected) => s"[expected: ${YELLOW}${expected.mkString}${RESET}, actual: ${RED}${actual.mkString}${RESET}]"
+  }.mkString
+
+StringDiff.withFormat("prefix common1 common2 inside1 common3 common4", "common1 common2 inside2 inside3 common3 suffix")(customFormat)
+StringDiff.withFormat("common1 common2 inside1 inside2 common3 common4 suffix", "prefix common1 common2 inside3 common3")(customFormat)
 ```
+
 ![screenshot 2](doc/images/screenshot2.png)
 
-### More examples
+### Examples
 
 ```
 token1 token2 token3

doc/images/screenshot2.png

@@ -0,0 +1,16 @@
+package app.tulz.diff
+
+import scala.Console._
+
+object AnsiColorDiffFormat extends DiffFormat[String] {
+
+  def apply(diff: List[DiffBlock]): String = {
+    s"${RESET}${diff.map {
+      case DiffBlock.Match(m)                    => s"${UNDERLINED}${m.mkString}${RESET}"
+      case DiffBlock.Missing(expected)           => s"[∅|${YELLOW}${UNDERLINED}${expected.mkString}${RESET}]"
+      case DiffBlock.Extra(actual)               => s"[${RED}${UNDERLINED}${actual.mkString}${RESET}|∅]"
+      case DiffBlock.Different(actual, expected) => s"[${RED}${UNDERLINED}${actual.mkString}${RESET}|${YELLOW}${UNDERLINED}${expected.mkString}${RESET}]"
+    }.mkString}"
+
+  }
+}

stringdiff/src/main/scala/app/tulz/diff/AnsiColorDiffFormat.scala

@@ -5,13 +5,16 @@ sealed trait DiffBlock extends Product with Serializable
 object DiffBlock {
 
   final case class Match(s: List[String]) extends DiffBlock
-  final case class NoMatch(
+
+  final case class Different(
     actual: List[String],
     expected: List[String]
   ) extends DiffBlock
+
   final case class Missing(
     expected: List[String]
   ) extends DiffBlock
+
   final case class Extra(
     actual: List[String]
   ) extends DiffBlock

stringdiff/src/main/scala/app/tulz/diff/DiffBlock.scala

@@ -0,0 +1,9 @@
+package app.tulz.diff
+
+trait DiffFormat[Out] extends (List[DiffBlock] => Out)
+
+object DiffFormat {
+
+  val ansi: DiffFormat[String] = AnsiColorDiffFormat
+
+}