Add basic scalatest matcher

Author: stringbean

build.sbt

@@ -1,9 +1,7 @@
 import PgpKeys.{publishLocalSigned, publishSigned}
 
 organization := "software.purpledragon.xml"
-version := "0.0.1-SNAPSHOT"
-
-scalaVersion := "2.11.8"
+version := "0.0.1"
 
 scalaVersion := "2.12.3"
 crossScalaVersions := Seq("2.11.11", "2.12.3")
@@ -19,6 +17,7 @@ lazy val xmlCompare = project
 
 lazy val xmlScalatest = project
   .in(file("xml-scalatest"))
+  .dependsOn(xmlCompare)
 
 lazy val root = project
   .in(file("."))

xml-compare/src/main/scala/software/purpledragon/xml/compare/XmlDiff.scala

@@ -2,14 +2,17 @@ package software.purpledragon.xml.compare
 
 sealed trait XmlDiff {
   def isEqual: Boolean
+  def message: String
 }
 
 object XmlEqual extends XmlDiff {
   override def isEqual: Boolean = true
-
   override def toString: String = "XmlEqual"
+  override def message: String = ""
 }
 
 case class XmlDiffers(reason: String, left: Any, right: Any) extends XmlDiff {
   override def isEqual: Boolean = false
+
+  override def message: String = s"$reason - $left != $right"
 }

xml-scalatest/src/main/scala/software/purpledragon/xml/scalatest/XmlMatchers.scala

@@ -16,12 +16,25 @@
 
 package software.purpledragon.xml.scalatest
 
-import org.scalatest.matchers.Matcher
+import org.scalatest.matchers.{MatchResult, Matcher}
+import software.purpledragon.xml.compare.XmlCompare
 
 import scala.xml.Node
 
 trait XmlMatchers {
-  def beXml(node: Node): Matcher[Node] = ???
+  def beXml(expected: Node): Matcher[Node] = new XmlMatcher(expected)
 
-  def beExactXml(node: Node): Matcher[Node] = ???
+//  def beExactXml(node: Node): Matcher[Node] = ???
+
+  class XmlMatcher(expected: Node) extends Matcher[Node] {
+    override def apply(actual: Node): MatchResult = {
+      val diff = XmlCompare.compare(expected, actual)
+
+      MatchResult(
+        diff.isEqual,
+        s"XML did not match - ${diff.message}",
+        "XML matched"
+      )
+    }
+  }
 }

xml-scalatest/src/test/scala/software/purpledragon/xml/scalatest/XmlMatchersSpec.scala

@@ -18,4 +18,29 @@ package software.purpledragon.xml.scalatest
 
 import org.scalatest.{FlatSpec, Matchers}
 
-class XmlMatchersSpec extends FlatSpec with Matchers with XmlMatchers {}
+class XmlMatchersSpec extends FlatSpec with Matchers with XmlMatchers {
+  "beXml" should "match identical XML" in {
+    val matcher = beXml(<test>text</test>)
+
+    val matchResult = matcher(<test>text</test>)
+    matchResult.matches shouldBe true
+  }
+
+  it should "match XML with different whitespace" in {
+    val matcher = beXml(<test>text</test>)
+
+    val matchResult = matcher(
+      <test>
+        text
+      </test>)
+    matchResult.matches shouldBe true
+  }
+
+  it should "not match different XML" in {
+    val matcher = beXml(<test>text</test>)
+
+    val matchResult = matcher(<test>different</test>)
+    matchResult.matches shouldBe false
+    matchResult.failureMessage shouldBe "XML did not match - different text - text != different"
+  }
+}