fix: update to latest kotlin-editor and don't delete complex statemen…

…ts in dependencies blocks.

gradle/libs.versions.toml

@@ -4,7 +4,7 @@ dagp = "1.30.0"
 java = "11"
 junit5 = "5.7.2"
 kotlin = "1.9.24"
-kotlinEditor = "0.8"
+kotlinEditor = "0.9"
 mavenPublish = "0.28.0"
 moshi = "1.14.0"
 retrofit = "2.9.0"

sort/src/main/kotlin/com/squareup/sort/kotlin/KotlinSorter.kt

@@ -4,9 +4,11 @@ import cash.grammar.kotlindsl.model.gradle.DependencyContainer
 import cash.grammar.kotlindsl.parse.Parser
 import cash.grammar.kotlindsl.utils.Blocks.isDependencies
 import cash.grammar.kotlindsl.utils.CollectingErrorListener
+import cash.grammar.kotlindsl.utils.Context.fullText
 import cash.grammar.kotlindsl.utils.DependencyExtractor
 import cash.grammar.kotlindsl.utils.Whitespace
 import com.squareup.cash.grammar.KotlinParser.NamedBlockContext
+import com.squareup.cash.grammar.KotlinParser.StatementContext
 import com.squareup.cash.grammar.KotlinParserBaseListener
 import com.squareup.parse.AlreadyOrderedException
 import com.squareup.parse.BuildScriptParseException
@@ -18,7 +20,6 @@ import org.antlr.v4.runtime.CharStream
 import org.antlr.v4.runtime.CommonTokenStream
 import org.antlr.v4.runtime.TokenStreamRewriter
 import java.nio.file.Path
-import kotlin.io.path.absolutePathString
 
 public class KotlinSorter private constructor(
   private val input: CharStream,
@@ -36,10 +37,7 @@ public class KotlinSorter private constructor(
   )
 
   private val dependencyComparator = DependencyComparator()
-  private val mutableDependencies = MutableDependencies(
-    mutableMapOf(),
-    mutableListOf()
-  )
+  private val mutableDependencies = MutableDependencies()
   private val ordering = Ordering()
 
   private var level = 0
@@ -99,7 +97,8 @@ public class KotlinSorter private constructor(
 
   private fun collectDependencies(container: DependencyContainer) {
     val declarations = container.getDependencyDeclarations().map { KotlinDependencyDeclaration(it) }
-    mutableDependencies.nonDeclarations += container.getNonDeclarations()
+    mutableDependencies.expressions += container.getExpressions()
+    mutableDependencies.statements += container.getStatements()
 
     ordering.collectDependencies(declarations)
 
@@ -119,10 +118,26 @@ public class KotlinSorter private constructor(
 
     appendLine("dependencies {")
 
-    // not-easily-modelable elements
-    mutableDependencies.nonDeclarations.forEach {
+    /*
+     * not-easily-modelable elements
+     */
+
+    // An example of a statement, in this context, is an if-expression or property expression (declaration)
+    mutableDependencies.statements.forEach { stmt ->
+      append(indent.repeat(level))
+      appendLine(stmt.fullText(input)!!)
+
+      didWrite = true
+    }
+
+    if (didWrite && mutableDependencies.expressions.isNotEmpty()) {
+      appendLine()
+    }
+
+    // An example of an expression, in this context, is a function call like `add("extraImplementation", "foo")`
+    mutableDependencies.expressions.forEach { expr ->
       append(indent.repeat(level))
-      appendLine(it)
+      appendLine(expr)
 
       didWrite = true
     }
@@ -131,8 +146,9 @@ public class KotlinSorter private constructor(
       appendLine()
     }
 
-    // declarations
-    mutableDependencies.declarations().sortedWith(KotlinConfigurationComparator)
+    // straightforward declarations
+    mutableDependencies.declarations()
+      .sortedWith(KotlinConfigurationComparator)
       .forEachIndexed { i, entry ->
         if (i != 0) appendLine()
 
@@ -185,15 +201,17 @@ public class KotlinSorter private constructor(
 }
 
 private class MutableDependencies(
-  val dependenciesByConfiguration: MutableMap<String, MutableList<KotlinDependencyDeclaration>>,
-  val nonDeclarations: MutableList<String>,
+  val dependenciesByConfiguration: MutableMap<String, MutableList<KotlinDependencyDeclaration>> = mutableMapOf(),
+  val expressions: MutableList<String> = mutableListOf(),
+  val statements: MutableList<StatementContext> = mutableListOf(),
 ) {
 
   fun declarations() = dependenciesByConfiguration.entries
 
   fun clear() {
     dependenciesByConfiguration.clear()
-    nonDeclarations.clear()
+    expressions.clear()
+    statements.clear()
   }
 }
 

sort/src/test/groovy/com/squareup/sort/GroovySorterSpec.groovy

@@ -3,6 +3,8 @@ package com.squareup.sort
 import com.squareup.parse.AlreadyOrderedException
 import com.squareup.parse.BuildScriptParseException
 import com.squareup.sort.groovy.GroovySorter
+import com.squareup.sort.kotlin.KotlinSorter
+import spock.lang.PendingFeature
 import spock.lang.Specification
 import spock.lang.TempDir
 
@@ -180,6 +182,46 @@ final class GroovySorterSpec extends Specification {
     )
   }
 
+  // GroovySorter may never support complex syntax in a dependencies block
+  @PendingFeature
+  def "doesn't remove complex statements when sorting"() {
+    given:
+    def buildScript = dir.resolve('build.gradle.kts')
+    Files.writeString(buildScript,
+      '''\
+        dependencies {
+          implementation(libs.c)
+          api(libs.d)
+          testImplementation("g:e:1")
+
+          if (org.apache.tools.ant.taskdefs.condition.Os.isArch("aarch64")) {
+            // Multi-line comment about why we're
+            // doing this.
+            testImplementation("io.github.ganadist.sqlite4java:libsqlite4java-osx-aarch64:1.0.392")
+          }
+        }'''.stripIndent()
+    )
+    def sorter = KotlinSorter.of(buildScript)
+
+    expect:
+    assertThat(sorter.rewritten()).isEqualTo(
+      '''\
+        dependencies {
+          api(libs.d)
+
+          implementation(libs.c)
+
+          testImplementation("g:e:1")
+
+          if (org.apache.tools.ant.taskdefs.condition.Os.isArch("aarch64")) {
+            // Multi-line comment about why we're
+            // doing this.
+            testImplementation("io.github.ganadist.sqlite4java:libsqlite4java-osx-aarch64:1.0.392")
+          }
+        }'''.stripIndent()
+    )
+  }
+
   def "can sort build script with four-space tabs"() {
     given:
     def buildScript = dir.resolve('build.gradle')

sort/src/test/groovy/com/squareup/sort/KotlinSorterSpec.groovy

@@ -214,6 +214,52 @@ class KotlinSorterSpec extends Specification {
     )
   }
 
+  def "doesn't remove complex statements when sorting"() {
+    given:
+    def buildScript = dir.resolve('build.gradle.kts')
+    Files.writeString(buildScript,
+      '''\
+        dependencies {
+          val complex = "a:complex:$expression"
+
+          implementation(complex)
+          api(libs.d)
+          testImplementation("g:e:1")
+
+          add("extraImplementation", libs.a)
+
+          if (org.apache.tools.ant.taskdefs.condition.Os.isArch("aarch64")) {
+            // Multi-line comment about why we're
+            // doing this.
+            testImplementation("io.github.ganadist.sqlite4java:libsqlite4java-osx-aarch64:1.0.392")
+          }
+        }'''.stripIndent()
+    )
+    def sorter = KotlinSorter.of(buildScript)
+
+    expect:
+    assertThat(sorter.rewritten()).isEqualTo(
+      '''\
+        dependencies {
+          val complex = "a:complex:$expression"
+
+          if (org.apache.tools.ant.taskdefs.condition.Os.isArch("aarch64")) {
+            // Multi-line comment about why we're
+            // doing this.
+            testImplementation("io.github.ganadist.sqlite4java:libsqlite4java-osx-aarch64:1.0.392")
+          }
+
+          add("extraImplementation", libs.a)
+
+          api(libs.d)
+
+          implementation(complex)
+
+          testImplementation("g:e:1")
+        }'''.stripIndent()
+    )
+  }
+
   def "can sort build script with four-space tabs"() {
     given:
     def buildScript = dir.resolve('build.gradle.kts')