0.9.0 (#395)

Author: lihaoyi

docs/Golden.png

@@ -93,13 +93,7 @@ trait AssertsCompanionVersionSpecific {
     }
   }
 
-  def assertProxy(c: Context)(expr: c.Expr[Boolean]): c.Expr[Unit] = {
-    import c.universe._
-    Tracer[Boolean](c)(q"utest.asserts.Asserts.assertImpl", expr)
-  }
-
-
-  def assertAllProxy(c: Context)(expr: c.Expr[Boolean]*): c.Expr[Unit] = {
+  def assertProxy(c: Context)(expr: c.Expr[Boolean]*): c.Expr[Unit] = {
     import c.universe._
     Tracer[Boolean](c)(q"utest.asserts.Asserts.assertImpl", expr:_*)
   }
@@ -133,17 +127,11 @@ trait AssertsVersionSpecific {
     */
   def assertCompileError(expr: String): CompileError = macro Asserts.assertCompileError
 
-  /**
-   * Checks that the expression is true; otherwise raises an
-   * exception with some debugging info
-   */
-  def assert(expr: Boolean): Unit = macro Asserts.assertProxy
-
   /**
     * Checks that one or more expressions are true; otherwise raises an
     * exception with some debugging info
     */
-  def assertAll(expr: Boolean*): Unit = macro Asserts.assertAllProxy
+  def assert(expr: Boolean*): Unit = macro Asserts.assertProxy
   /**
     * Checks that one or more expressions all become true within a certain
     * period of time. Polls at a regular interval to check this.

docs/PrettyPrint.png

@@ -31,8 +31,7 @@ object TestBuilder:
     val assertInliner = new TreeMap {
       override def transformTerm(term: Term)(owner: Symbol): Term = scala.util.Try(term.asExpr) match {
           case Success(expr) => expr match
-            case '{utest.assert(${_}) } => Inlined(None,Nil,term) //Inlined results in proper line number generation
-            case '{utest.assertAll(${_}*) } => Inlined(None,Nil,term) //Inlined results in proper line number generation
+            case '{utest.assert(${_}*) } => Inlined(None,Nil,term) //Inlined results in proper line number generation
             case _ => super.transformTerm(term)(owner)
           case _ => super.transformTerm(term)(owner)
       }

docs/Splash.png

@@ -15,14 +15,8 @@ import scala.collection.mutable
  * message for boolean expression assertion.
  */
 trait AssertsCompanionVersionSpecific {
-  def assertProxy(expr: Expr[Boolean])(using ctx: Quotes): Expr[Unit] = {
-    Tracer.single[Boolean](
-      '{ (esx: Seq[AssertEntry[Boolean]]) => utest.asserts.Asserts.assertImpl(esx: _*) },
-      expr
-    )
-  }
 
-  def assertAllProxy(exprs: Expr[Seq[Boolean]])(using ctx: Quotes): Expr[Unit] = {
+  def assertProxy(exprs: Expr[Seq[Boolean]])(using ctx: Quotes): Expr[Unit] = {
     Tracer[Boolean] ('{ (esx: Seq[AssertEntry[Boolean]]) => utest.asserts.Asserts.assertImpl(esx: _*) }, exprs)
   }
 
@@ -58,17 +52,12 @@ trait AssertsVersionSpecific {
     */
   transparent inline def assertCompileError(inline expr: String): CompileError = compileErrorImpl(typeCheckErrors(expr), expr)
 
-  /**
-   * Checks that the expression is true; otherwise raises an
-   * exception with some debugging info
-   */
-  inline def assert(inline expr: Boolean): Unit = ${Asserts.assertProxy('expr)}
 
   /**
     * Checks that one or more expressions are true; otherwise raises an
     * exception with some debugging info
     */
-  inline def assertAll(inline expr: Boolean*): Unit = ${Asserts.assertAllProxy('expr)}
+  inline def assert(inline expr: Boolean*): Unit = ${Asserts.assertProxy('expr)}
 
   /**
     * Checks that one or more expressions all become true within a certain

readme.md

@@ -6,7 +6,7 @@ import java.nio.file.{Files, Path}
 trait AssertsPlatformSpecific {
   private def throwAssertionError(path: String, goldenValue: Any, actualValue: Any): Unit = {
     throw new AssertionError(
-      s"Actual value does not match golden data in file $path\n" +
+      s"Actual value does not match golden data in file\n$path\n" +
         "Run tests with UTEST_UPDATE_GOLDEN_TESTS=1 to apply the following patch to update the golden value",
       Seq(
         TestValue.Equality(
@@ -15,19 +15,30 @@ trait AssertsPlatformSpecific {
         )
       )
     )
-
   }
+
+  /**
+   * Asserts that the `String` [[actualValue]] is equivalent to the contents of
+   * the file on disk at [[goldenFilePath]]. If `UTEST_UPDATE_GOLDEN_TESTS=1` is
+   * set during the test run, the golden file is updated to the latest contents of [[actualValue]]
+   */
   def assertGoldenFile(actualValue: String, goldenFilePath: Path)(implicit reporter: GoldenFix.Reporter): Unit = {
     val goldenFileContents = if (Files.exists(goldenFilePath)) Files.readString(goldenFilePath) else ""
     if (goldenFileContents != actualValue) {
       if (!sys.env.get("UTEST_UPDATE_GOLDEN_TESTS").exists(_.nonEmpty)) {
-        throwAssertionError(goldenFilePath.toString, goldenFileContents, actualValue)
+        throwAssertionError(goldenFilePath.toString, new GoldenFix.Literal(goldenFileContents), new GoldenFix.Literal(actualValue))
       } else {
         reporter.apply(GoldenFix(goldenFilePath, new GoldenFix.Literal(actualValue), 0, goldenFileContents.length))
       }
     }
   }
 
+  /**
+   * Asserts that the `String` [[actualValue]] is equivalent to the contents of
+   * the [[goldenLiteral]]. If `UTEST_UPDATE_GOLDEN_TESTS=1` is
+   * set during the test run, the source code of [[goldenLiteral]] is updated to the latest
+   * contents of [[actualValue]] pretty-printed using PPrint.
+   */
   def assertGoldenLiteral(actualValue: Any, goldenLiteral: GoldenFix.Span[Any])
                          (implicit reporter: GoldenFix.Reporter): Unit = {
     Predef.assert(