Merge branch 'cheeseng-pretty-differ-3' into 3.1.x

Author: bvenners

project/GenScalacticJS.scala

@@ -82,8 +82,8 @@ object GenScalacticJS {
   def genScala(targetDir: File, version: String, scalaVersion: String): Seq[File] =
     copyDir("scalactic/src/main/scala/org/scalactic", "org/scalactic", targetDir, List.empty) ++
     copyDir("scalactic/src/main/scala/org/scalactic/exceptions", "org/scalactic/exceptions", targetDir, List.empty) ++
-    copyDir("scalactic/src/main/scala/org/scalactic/source", "org/scalactic/source", targetDir, List.empty) ++
-    copyDir("scalactic/src/main/scala/org/scalactic/anyvals", "org/scalactic/anyvals", targetDir, List.empty) ++ 
+    copyDir("scalactic/src/main/scala/org/scalactic/source", "org/scalactic/source", targetDir, List("ObjectMeta.scala")) ++
+    copyDir("scalactic/src/main/scala/org/scalactic/anyvals", "org/scalactic/anyvals", targetDir, List.empty) ++
     GenVersions.genScalacticVersions(new File(targetDir, "org/scalactic"), version, scalaVersion)
 
   def genMacroScala(targetDir: File, version: String, scalaVersion: String): Seq[File] =

scalactic-test/src/test/scala/org/scalactic/DifferSpec.scala

@@ -54,6 +54,20 @@ class PrettifierSpec extends FunSpec with Matchers {
       myLittlePretty(()) should be ("<(), the Unit value>")
       myLittlePretty(List("1", "2", "3")) should be ("List(\"1\", \"2\", \"3\")")
     }
+    it("should by default offer an apply method that takes two args that returns a PrettyPair whose left and right are prettified by the one-arg apply and hint is None.") {
+    
+      case class Yell(secret: String)
+      val myLittlePretty =
+        new Prettifier {
+          def apply(o: Any) =
+            o match {
+              case Yell(secret) => secret.toUpperCase + "!!!"
+              case _ => Prettifier.default(o)
+            }
+        }
+      val left = Yell("I like fruit loops")
+      myLittlePretty(left, Yell("I like raisin bran")) shouldBe PrettyPair("I LIKE FRUIT LOOPS!!!", "I LIKE RAISIN BRAN!!!", Some(Differ.simpleClassName(left) + "(secret: \"I like [fruit loops]\" -> \"I like [raisin bran]\")"))
+    }
   }
 
   describe("the basic Prettifier") {

scalactic-test/src/test/scala/org/scalactic/PrettifierSpec.scala

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2001-2016 Artima, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.scalactic.source
+
+import org.scalatest._
+
+class ObjectMetaSpec extends FunSpec with Matchers {
+
+  case class Person(name: String, age: Int) {
+    val otherField = "test other field"
+  }
+
+  describe("ObjectMeta") {
+
+    it("should extract case class attribute names correctly") {
+      ObjectMeta(Person("test", 33)).fieldNames should contain theSameElementsAs Set("name", "age", "otherField")
+    }
+
+    it("should extract dynamically field value correctly") {
+      val meta = ObjectMeta(Person("test", 33))
+      meta.value("name") shouldBe "test"
+      meta.value("age") shouldBe 33
+      meta.value("otherField") shouldBe "test other field"
+    }
+
+    it("should throw IllegalArgumentException when invalid attribute name is used to retrieve value") {
+      val meta = ObjectMeta(Person("test", 33))
+      val e = intercept[IllegalArgumentException] {
+        meta.value("invalid")
+      }
+      e.getMessage shouldBe "'invalid' is not attribute for this instance."
+    }
+  }
+}

scalactic-test/src/test/scala/org/scalactic/source/ObjectMetaSpec.scala

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2001-2016 Artima, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.scalactic.source
+
+trait ObjectMeta {
+
+  def fieldNames: scala.collection.immutable.IndexedSeq[String]
+
+  def hasField(name: String): Boolean = fieldNames.contains(name)
+
+  def value(name: String): Any
+
+  def typeName(name: String): String
+
+  def shortTypeName(name: String): String
+
+}
+
+object ObjectMeta {
+
+  def apply(v: Any): ObjectMeta = {
+
+    def filterDollarNumberAtTheEnd(value: String): String = {
+      val lastIdxOfDollar = value.lastIndexOf('$')
+      if (lastIdxOfDollar > 0) {
+        val afterDollar = value.substring(lastIdxOfDollar + 1)
+        try {
+          afterDollar.toInt
+          value.substring(0, lastIdxOfDollar)
+        }
+        catch {
+          case t: Throwable => value
+        }
+      }
+      else
+        value
+    }
+
+    val dict = v.asInstanceOf[scala.scalajs.js.Dictionary[Any]].flatMap { case (key, value) =>
+      val decodedKey =
+        scala.reflect.NameTransformer.decode(key).
+          replaceAllLiterally("$$und", "_").
+          replaceAllLiterally("$mcI", "").
+          replaceAllLiterally("$sp", "").
+          replaceAllLiterally("$f", "")
+
+      Some((filterDollarNumberAtTheEnd(decodedKey), value))
+    }
+
+    new ObjectMeta {
+
+      lazy val fieldNames = dict.keys.toVector.filter(_ != "$$outer")
+
+      def value(name: String): Any = {
+        dict.get(name) match {
+          case Some(value) => value
+          case None => throw new IllegalArgumentException("'" + name + "' is not attribute for this instance.")
+        }
+      }
+
+      def typeName(name: String): String = {
+        dict.get(name) match {
+          case Some(value) => value.getClass.getName
+          case None => throw new IllegalArgumentException("'" + name + "' is not attribute for this instance.")
+        }
+      }
+
+      def shortTypeName(name: String): String = {
+        dict.get(name) match {
+          case Some(value) => value.getClass.getSimpleName
+          case None => throw new IllegalArgumentException("'" + name + "' is not attribute for this instance.")
+        }
+      }
+    }
+  }
+
+}

scalactic.js/src/main/scala/org/scalactic/source/ObjectMeta.scala

@@ -34,6 +34,8 @@ trait Bool {
   private def makeString(raw: String, args: Array[Any]): String =
     Resources.formatString(raw, args.map(prettifier.apply))
 
+  lazy val analysis: scala.collection.immutable.IndexedSeq[String] = Vector.empty
+
   /**
    * Construct and return failure message, by applying arguments returned from <code>failureMessageArgs</code> to
    * raw message returned from <code>rawFailureMessage</code>
@@ -657,6 +659,23 @@ private[scalactic] class BinaryMacroBool(left: Any, operator: String, right: Any
   def this(left: Any, operator: String, right: Any, bool: Bool, prettifier: Prettifier) =
     this(left, operator, right, bool.value, prettifier)
 
+  private lazy val prettyPair: PrettyPair = {
+    val leftValue =
+      left match {
+        case aEqualizer: org.scalactic.TripleEqualsSupport#Equalizer[_] => aEqualizer.leftSide
+        case aEqualizer: org.scalactic.TripleEqualsSupport#CheckingEqualizer[_] => aEqualizer.leftSide
+        case _ => left
+      }
+    prettifier.apply(leftValue, right)
+  }
+
+  override lazy val analysis: scala.collection.immutable.IndexedSeq[String] = {
+    operator match {
+      case "==" | "===" => prettyPair.analysis.map(Vector(_)).getOrElse(Vector.empty)
+      case _ => Vector.empty
+    }
+  }
+
   /**
    * the <code>Boolean</code> value of this <code>Bool</code>.
    */