fix: ProjectAdvice is totally Comparable.

Author: autonomousapps

src/main/kotlin/com/autonomousapps/model/ModuleAdvice.kt

@@ -9,7 +9,7 @@ import com.squareup.moshi.JsonClass
 import dev.zacsweers.moshix.sealed.annotations.TypeLabel
 
 @JsonClass(generateAdapter = false, generator = "sealed:type")
-sealed class ModuleAdvice {
+sealed class ModuleAdvice : Comparable<ModuleAdvice> {
 
   abstract val name: String
 
@@ -19,11 +19,26 @@ sealed class ModuleAdvice {
 
   internal abstract fun isActionable(): Boolean
 
+  override fun compareTo(other: ModuleAdvice): Int {
+    if (this === other) return 0
+
+    if (this is AndroidScore && other is AndroidScore) {
+      return compareBy(AndroidScore::hasAndroidAssets)
+        .thenBy(AndroidScore::hasAndroidRes)
+        .thenBy(AndroidScore::usesAndroidClasses)
+        .thenBy(AndroidScore::hasBuildConfig)
+        .thenBy(AndroidScore::hasAndroidDependencies)
+        .compare(this, other)
+    }
+
+    // Impossible until we had another kind of ModuleAdvice.
+    error("Expected to be comparing AndroidScores, was this=${javaClass.simpleName}, other=${other.javaClass.simpleName}")
+  }
+
   internal companion object {
     /** Returns `true` if [moduleAdvice] is effectively empty or unactionable. */
     fun isEmpty(moduleAdvice: Set<ModuleAdvice>) = moduleAdvice.none { it.isActionable() }
 
-
     /** Returns `true` if [moduleAdvice] is in any way actionable. */
     fun isNotEmpty(moduleAdvice: Set<ModuleAdvice>) = !isEmpty(moduleAdvice)
   }

src/main/kotlin/com/autonomousapps/model/ProjectAdvice.kt

@@ -2,6 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 package com.autonomousapps.model
 
+import com.autonomousapps.internal.utils.LexicographicIterableComparator
 import com.squareup.moshi.JsonClass
 
 /** Collection of all advice for a single project, across all variants. */
@@ -19,6 +20,13 @@ data class ProjectAdvice(
   fun isEmpty(): Boolean = dependencyAdvice.isEmpty() && pluginAdvice.isEmpty() && warning.isEmpty()
   fun isNotEmpty(): Boolean = !isEmpty()
 
-  // TODO(tsr): this compareTo function violates the Comparable contract by only considering one field.
-  override fun compareTo(other: ProjectAdvice): Int = projectPath.compareTo(other.projectPath)
+  override fun compareTo(other: ProjectAdvice): Int {
+    return compareBy(ProjectAdvice::projectPath)
+      .thenBy(LexicographicIterableComparator()) { it.dependencyAdvice }
+      .thenBy(LexicographicIterableComparator()) { it.pluginAdvice }
+      .thenBy(LexicographicIterableComparator()) { it.moduleAdvice }
+      .thenBy(ProjectAdvice::warning)
+      .thenBy(ProjectAdvice::shouldFail)
+      .compare(this, other)
+  }
 }

src/main/kotlin/com/autonomousapps/model/Warning.kt

@@ -1,16 +1,24 @@
 package com.autonomousapps.model
 
+import com.autonomousapps.internal.utils.LexicographicIterableComparator
 import com.squareup.moshi.JsonClass
 
 /** Warnings about the project for which the plugin cannot yet make universally actionable advice. */
 @JsonClass(generateAdapter = false)
-data class Warning(val duplicateClasses: Set<DuplicateClass>) {
+data class Warning(
+  val duplicateClasses: Set<DuplicateClass>,
+) : Comparable<Warning> {
 
   internal companion object {
     @JvmStatic
     fun empty() = Warning(emptySet())
   }
 
+  override fun compareTo(other: Warning): Int {
+    return LexicographicIterableComparator<DuplicateClass>()
+      .compare(duplicateClasses, other.duplicateClasses)
+  }
+
   fun isEmpty(): Boolean = duplicateClasses.isEmpty()
   fun isNotEmpty(): Boolean = !isEmpty()
 }