Improve output of long dependency report

Author: stringbean

build.sbt

@@ -18,7 +18,8 @@ libraryDependencies ++= Seq(
 ).map(_ % circeVersion)
 
 libraryDependencies ++= Seq(
-  "org.scalatest" %% "scalatest" % "3.1.0" % Test
+  "software.purpledragon" %% "text-utils" % "1.2.0",
+  "org.scalatest"         %% "scalatest"  % "3.1.0" % Test
 )
 
 organizationName := "Michael Stringer"

src/main/resources/messages.properties

@@ -42,13 +42,4 @@ lock.status.full.dependencies.removed.multiple=\ \ {0} dependencies removed:\n{1
 
 lock.status.full.dependencies.changed.none=
 lock.status.full.dependencies.changed.singular=\ \ 1 dependency changed:\n{1}
-lock.status.full.dependencies.changed.multiple=\ \ {0} dependencies changed:\n{1}
-
-#com.example:artifact:1.0 (compile,test)
-lock.status.full.dependency=\ \ \ \ {0}:{1}:{2} ({3})
-#com.example:artifact:[1.0]->[2.0] (compile,test)
-lock.status.full.dependency.changed.version=\ \ \ \ {0}:{1}:[{2}]->[{3}] ({4})
-#com.example:artifact:1.0 (compile,test)->(compile)
-lock.status.full.dependency.changed.configs=\ \ \ \ {0}:{1}:{2} ({4})->({5})
-#com.example:artifact:[1.0]->[2.0] (compile,test)->(compile)
-lock.status.full.dependency.changed.all=\ \ \ \ {0}:{1}:[{2}]->[{3}] ({4})->({5})
+lock.status.full.dependencies.changed.multiple=\ \ {0} dependencies changed:\n{1}

src/main/scala/software/purpledragon/sbt/lock/model/LockFileStatus.scala

@@ -17,6 +17,7 @@
 package software.purpledragon.sbt.lock.model
 
 import software.purpledragon.sbt.lock.util.MessageUtil
+import software.purpledragon.text.TableFormatter
 
 import scala.collection.mutable
 
@@ -43,7 +44,8 @@ case object LockFileMatches extends LockFileStatus {
     LockFileDiffers(Nil, Nil, added, removed, changed)
   }
 
-  override val toShortReport: String = MessageUtil.formatMessage("lock.status.success")
+  override val toShortReport: String =
+    MessageUtil.formatMessage("lock.status.success")
   override val toLongReport: String = toShortReport
 }
 
@@ -108,16 +110,14 @@ final case class LockFileDiffers(
     }
 
     def dumpDependencies(dependencies: Seq[ResolvedDependency]): String = {
-      dependencies
-        .map({ dep =>
-          MessageUtil.formatMessage(
-            "lock.status.full.dependency",
-            dep.org,
-            dep.name,
-            dep.version,
-            dep.configurations.toSeq.sorted.mkString(","))
-        })
-        .mkString("\n")
+      val table =
+        new TableFormatter(None, prefix = "    ", stripTrailingNewline = true)
+
+      dependencies foreach { dep =>
+        table.addRow(s"${dep.org}:${dep.name}", s"(${dep.configurations.mkString(",")})", dep.version)
+      }
+
+      table.toString()
     }
 
     if (addedDependencies.nonEmpty) {
@@ -134,32 +134,30 @@ final case class LockFileDiffers(
         dumpDependencies(removedDependencies))
     }
 
-    if (changedDependencies.nonEmpty) {
-      val changeDetails = changedDependencies map { change =>
-        val key = (change.versionChanged, change.configurationsChanged) match {
-          case (true, true) => "lock.status.full.dependency.changed.all"
-          case (true, false) => "lock.status.full.dependency.changed.version"
-          case (false, true) => "lock.status.full.dependency.changed.configs"
-          case _ => "lock.status.full.dependency"
-        }
-
-        MessageUtil.formatMessage(
-          key,
-          change.org,
-          change.name,
+    def dumpChanges(changes: Seq[ChangedDependency]): String = {
+      val table =
+        new TableFormatter(None, prefix = "    ", stripTrailingNewline = true)
+
+      changes foreach { change =>
+        table.addRow(
+          s"${change.org}:${change.name}",
+          s"(${change.oldConfigurations.mkString(",")})",
+          if (change.configurationsChanged)
+            s"-> (${change.newConfigurations.mkString(",")})"
+          else "",
           change.oldVersion,
-          change.newVersion,
-          change.oldConfigurations.mkString(","),
-          change.newConfigurations.mkString(",")
+          if (change.versionChanged) s"-> ${change.newVersion}" else ""
         )
-
-      // TODO arts
       }
 
+      table.toString()
+    }
+
+    if (changedDependencies.nonEmpty) {
       errors += MessageUtil.formatPlural(
         "lock.status.full.dependencies.changed",
         changedDependencies.size,
-        changeDetails.mkString("\n"))
+        dumpChanges(changedDependencies))
     }
 
     MessageUtil.formatMessage("lock.status.failed.long", errors.mkString("\n"))

src/test/scala/software/purpledragon/sbt/lock/model/LockFileStatusSpec.scala

@@ -129,7 +129,7 @@ class LockFileStatusSpec extends AnyFlatSpec with Matchers {
     val expected =
       """Dependency lock check failed:
         |  1 dependency added:
-        |    com.example:artifact:1.0 (compile,test)""".stripMargin
+        |    com.example:artifact  (compile,test)  1.0""".stripMargin
 
     LockFileMatches.withDependencyChanges(Seq(testDependency()), Nil, Nil).toLongReport shouldBe expected
   }
@@ -138,8 +138,8 @@ class LockFileStatusSpec extends AnyFlatSpec with Matchers {
     val expected =
       """Dependency lock check failed:
         |  2 dependencies removed:
-        |    com.example:artifact:1.0 (compile,test)
-        |    com.example:artifact-2:1.0 (compile,test)""".stripMargin
+        |    com.example:artifact    (compile,test)  1.0
+        |    com.example:artifact-2  (compile,test)  1.0""".stripMargin
 
     LockFileMatches
       .withDependencyChanges(Nil, Seq(testDependency(), testDependency(name = "artifact-2")), Nil)
@@ -150,7 +150,7 @@ class LockFileStatusSpec extends AnyFlatSpec with Matchers {
     val expected =
       """Dependency lock check failed:
         |  1 dependency changed:
-        |    com.example:artifact:[1.0]->[2.0] (compile,test)""".stripMargin
+        |    com.example:artifact  (compile,test)    1.0  -> 2.0""".stripMargin
 
     LockFileMatches.withDependencyChanges(Nil, Nil, Seq(testChangedDependency())).toLongReport shouldBe expected
   }
@@ -159,7 +159,7 @@ class LockFileStatusSpec extends AnyFlatSpec with Matchers {
     val expected =
       """Dependency lock check failed:
         |  1 dependency changed:
-        |    com.example:artifact:1.0 (compile,test)->(compile)""".stripMargin
+        |    com.example:artifact  (compile,test)  -> (compile)  1.0""".stripMargin
 
     LockFileMatches
       .withDependencyChanges(
@@ -173,7 +173,7 @@ class LockFileStatusSpec extends AnyFlatSpec with Matchers {
     val expected =
       """Dependency lock check failed:
         |  1 dependency changed:
-        |    com.example:artifact:[1.0]->[2.0] (compile,test)->(compile)""".stripMargin
+        |    com.example:artifact  (compile,test)  -> (compile)  1.0  -> 2.0""".stripMargin
 
     LockFileMatches
       .withDependencyChanges(Nil, Nil, Seq(testChangedDependency(newConfigurations = SortedSet("compile"))))
@@ -186,14 +186,14 @@ class LockFileStatusSpec extends AnyFlatSpec with Matchers {
         |  1 config added: test1
         |  2 configs removed: test2,test3
         |  2 dependencies added:
-        |    com.example:artifact1:1.0 (compile)
-        |    com.example:artifact2:1.2 (test)
+        |    com.example:artifact1  (compile)  1.0
+        |    com.example:artifact2  (test)     1.2
         |  1 dependency removed:
-        |    com.example:artifact3:3.1.1 (runtime)
+        |    com.example:artifact3  (runtime)  3.1.1
         |  3 dependencies changed:
-        |    org.example:version:[1.0]->[2.0] (compile)
-        |    org.example:configs:1.0 (compile,test)->(compile)
-        |    org.example:both:[1.0]->[2.0] (compile)->(compile,test)""".stripMargin
+        |    org.example:version  (compile)                          1.0  -> 2.0
+        |    org.example:configs  (compile,test)  -> (compile)       1.0
+        |    org.example:both     (compile)       -> (compile,test)  1.0  -> 2.0""".stripMargin
 
     val actual = LockFileMatches
       .withConfigurationsChanged(Seq("test1"), Seq("test2", "test3"))