Improve formatting of long dependency reports (#12)

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"

project/build.properties

@@ -1 +1 @@
-sbt.version=1.3.2
+sbt.version=1.3.8

src/main/resources/messages.properties

@@ -20,6 +20,11 @@ lock.status.dependencies.none=no dependencies
 lock.status.dependencies.singular=1 dependency
 lock.status.dependencies.multiple={0} dependencies
 
+# lockfile short status - artifacts ============================================
+lock.status.artifacts.changed.none=
+lock.status.artifacts.changed.singular=\ \ 1 dependency artifacts changed
+lock.status.artifacts.changed.multiple=\ \ {0} dependency artifacts changed
+
 # lockfile full status - configurations =======================================
 
 lock.status.full.configs.added.none=
@@ -44,11 +49,7 @@ 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})
+# lockfile full status - artifacts ============================================
+lock.status.full.artifacts.changed.none=
+lock.status.full.artifacts.changed.singular=\ \ 1 dependency artifacts changed
+lock.status.full.artifacts.changed.multiple=\ \ {0} dependency artifacts changed

src/main/scala/software/purpledragon/sbt/lock/DependencyUtils.scala

@@ -21,7 +21,7 @@ import java.time.Instant
 import sbt._
 import software.purpledragon.sbt.lock.model.{DependencyLockFile, DependencyRef, ResolvedArtifact, ResolvedDependency}
 
-import scala.collection.{immutable, mutable}
+import scala.collection.{immutable, mutable, SortedSet}
 
 object DependencyUtils {
   def resolve(updateReport: UpdateReport, configs: Seq[ConfigRef]): DependencyLockFile = {
@@ -76,7 +76,12 @@ object DependencyUtils {
         ResolvedArtifact(s"${artifact.name}$qualifier.${artifact.extension}", hash)
     }
 
-    ResolvedDependency(module.module.organization, module.module.name, module.module.revision, artifacts, Set.empty)
+    ResolvedDependency(
+      module.module.organization,
+      module.module.name,
+      module.module.revision,
+      artifacts.to[SortedSet],
+      SortedSet.empty)
   }
 
   private def hashFile(file: File): String = s"sha1:${Hash.toHex(Hash(file))}"

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

@@ -16,15 +16,17 @@
 
 package software.purpledragon.sbt.lock.model
 
+import scala.collection.SortedSet
+
 final case class ChangedDependency(
     org: String,
     name: String,
     oldVersion: String,
     newVersion: String,
-    oldArtifacts: Seq[ResolvedArtifact],
-    newArtifacts: Seq[ResolvedArtifact],
-    oldConfigurations: Set[String],
-    newConfigurations: Set[String]) {
+    oldArtifacts: SortedSet[ResolvedArtifact],
+    newArtifacts: SortedSet[ResolvedArtifact],
+    oldConfigurations: SortedSet[String],
+    newConfigurations: SortedSet[String]) {
 
   def versionChanged: Boolean = oldVersion != newVersion
   def configurationsChanged: Boolean = oldConfigurations != newConfigurations

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
 }
 
@@ -78,7 +80,9 @@ final case class LockFileDiffers(
       )
     }
 
-    if (addedDependencies.nonEmpty || removedDependencies.nonEmpty || changedDependencies.nonEmpty) {
+    val (otherChanged, artifactChanged) = separateArtifactChanges(changedDependencies)
+
+    if (addedDependencies.nonEmpty || removedDependencies.nonEmpty || otherChanged.nonEmpty) {
       errors += MessageUtil.formatMessage(
         "lock.status.dependencies.info",
         MessageUtil.formatPlural("lock.status.dependencies", addedDependencies.size),
@@ -87,6 +91,10 @@ final case class LockFileDiffers(
       )
     }
 
+    if (artifactChanged.nonEmpty) {
+      errors += MessageUtil.formatPlural("lock.status.artifacts.changed", artifactChanged.size)
+    }
+
     MessageUtil.formatMessage("lock.status.failed.short", errors.mkString("\n"))
   }
 
@@ -108,16 +116,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,31 +140,42 @@ 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 _ => "error"
-        }
-
-        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 ""
+        )
       }
 
+      table.toString()
+    }
+
+    val (otherChanged, artifactChanged) = separateArtifactChanges(changedDependencies)
+
+    if (otherChanged.nonEmpty) {
       errors += MessageUtil.formatPlural(
         "lock.status.full.dependencies.changed",
-        changedDependencies.size,
-        changeDetails.mkString("\n"))
+        otherChanged.size,
+        dumpChanges(otherChanged))
+    }
+
+    if (artifactChanged.nonEmpty) {
+      errors += MessageUtil.formatPlural("lock.status.full.artifacts.changed", artifactChanged.size)
     }
 
     MessageUtil.formatMessage("lock.status.failed.long", errors.mkString("\n"))
   }
+
+  private def separateArtifactChanges(
+      changedDependencies: Seq[ChangedDependency]): (Seq[ChangedDependency], Seq[ChangedDependency]) = {
+    changedDependencies.partition(change => change.configurationsChanged || change.versionChanged)
+  }
 }

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

@@ -16,4 +16,10 @@
 
 package software.purpledragon.sbt.lock.model
 
-final case class ResolvedArtifact(name: String, hash: String)
+import scala.math.Ordered.orderingToOrdered
+
+final case class ResolvedArtifact(name: String, hash: String) extends Ordered[ResolvedArtifact] {
+  override def compare(that: ResolvedArtifact): Int = {
+    (name, hash) compare (that.name, that.hash)
+  }
+}

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

@@ -16,14 +16,15 @@
 
 package software.purpledragon.sbt.lock.model
 
+import scala.collection.SortedSet
 import scala.math.Ordered.orderingToOrdered
 
 final case class ResolvedDependency(
     org: String,
     name: String,
     version: String,
-    artifacts: Seq[ResolvedArtifact],
-    configurations: Set[String])
+    artifacts: SortedSet[ResolvedArtifact],
+    configurations: SortedSet[String])
     extends Ordered[ResolvedDependency] {
 
   override def compare(that: ResolvedDependency): Int = {

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

@@ -21,6 +21,8 @@ import java.time.Instant
 import org.scalatest.flatspec.AnyFlatSpec
 import org.scalatest.matchers.should.Matchers
 
+import scala.collection.SortedSet
+
 class DependencyLockFileSpec extends AnyFlatSpec with Matchers {
   private val EmptyLockFile = DependencyLockFile(1, Instant.now(), Nil, Nil)
   private val TestLockFile = DependencyLockFile(
@@ -32,9 +34,9 @@ class DependencyLockFileSpec extends AnyFlatSpec with Matchers {
         "com.example",
         "package-1",
         "1.0.0",
-        Seq(ResolvedArtifact("package-1.jar", "hash-1")),
-        Set("test-1")),
-      ResolvedDependency("com.example", "package-2", "1.2.0", Nil, Set("test-2"))
+        SortedSet(ResolvedArtifact("package-1.jar", "hash-1")),
+        SortedSet("test-1")),
+      ResolvedDependency("com.example", "package-2", "1.2.0", SortedSet.empty, SortedSet("test-2"))
     )
   )
 
@@ -80,8 +82,8 @@ class DependencyLockFileSpec extends AnyFlatSpec with Matchers {
       "com.example",
       "package-3",
       "3.0",
-      Seq(ResolvedArtifact("package-3.jar", "hash-3")),
-      Set("test-1"))
+      SortedSet(ResolvedArtifact("package-3.jar", "hash-3")),
+      SortedSet("test-1"))
 
     val left = TestLockFile
     val right = left.copy(dependencies = left.dependencies :+ newDependency)
@@ -103,8 +105,8 @@ class DependencyLockFileSpec extends AnyFlatSpec with Matchers {
         "com.example",
         "package-1",
         "2.0.0",
-        Seq(ResolvedArtifact("package-1.jar", "hash-1a")),
-        Set("test-1", "test-2"))
+        SortedSet(ResolvedArtifact("package-1.jar", "hash-1a")),
+        SortedSet("test-1", "test-2"))
     )
 
     left.findChanges(right) shouldBe LockFileDiffers(
@@ -118,10 +120,10 @@ class DependencyLockFileSpec extends AnyFlatSpec with Matchers {
           "package-1",
           "1.0.0",
           "2.0.0",
-          Seq(ResolvedArtifact("package-1.jar", "hash-1")),
-          Seq(ResolvedArtifact("package-1.jar", "hash-1a")),
-          Set("test-1"),
-          Set("test-1", "test-2")
+          SortedSet(ResolvedArtifact("package-1.jar", "hash-1")),
+          SortedSet(ResolvedArtifact("package-1.jar", "hash-1a")),
+          SortedSet("test-1"),
+          SortedSet("test-1", "test-2")
         ))
     )
   }