Minor tweaks (#1536)

* Tweak comments

* Revert "Update dependency com.pinterest.ktlint:ktlint-cli to v1.7.0 (#1516)"

This reverts commit e6afa8e

* Rearrange

* Tweak hasTransformedResource styles

* Tweak AppendingTransformer styles

* Cleanups

Author: Goooler

src/functionalTest/kotlin/com/github/jengelman/gradle/plugins/shadow/PublishingTest.kt

@@ -65,8 +65,7 @@ class PublishingTest : BasePluginTest() {
           archiveClassifier = ''
           archiveBaseName = 'maven-all'
         """.trimIndent(),
-      ) +
-        System.lineSeparator(),
+      ) + System.lineSeparator(),
     )
 
     publish()
@@ -555,11 +554,10 @@ class PublishingTest : BasePluginTest() {
       TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE.name to JavaVersion.current().majorVersion,
     )
 
-    val shadowVariantAttrs = commonVariantAttrs +
-      arrayOf(
-        Bundling.BUNDLING_ATTRIBUTE.name to Bundling.SHADOWED,
-        Usage.USAGE_ATTRIBUTE.name to Usage.JAVA_RUNTIME,
-      )
+    val shadowVariantAttrs = commonVariantAttrs + arrayOf(
+      Bundling.BUNDLING_ATTRIBUTE.name to Bundling.SHADOWED,
+      Usage.USAGE_ATTRIBUTE.name to Usage.JAVA_RUNTIME,
+    )
 
     fun MavenXpp3Reader.read(path: Path): Model = path.inputStream().use { read(it) }
 

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/GradleCompat.kt

@@ -22,10 +22,8 @@ import org.gradle.jvm.toolchain.JavaToolchainService
  * Return `runtimeClasspath` or `runtime` configuration.
  */
 internal inline val Project.runtimeConfiguration: Configuration
-  get() {
-    return configurations.findByName(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME)
-      ?: configurations.getByName("runtime")
-  }
+  get() = configurations.findByName(JavaPlugin.RUNTIME_CLASSPATH_CONFIGURATION_NAME)
+    ?: configurations.getByName("runtime")
 
 internal inline val Project.sourceSets: SourceSetContainer
   get() = extensions.getByType(SourceSetContainer::class.java)

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/internal/RelocatorRemapper.kt

@@ -49,6 +49,6 @@ internal class RelocatorRemapper(
   }
 
   fun mapPath(path: String): String {
-    return map(path.substring(0, path.indexOf('.')))
+    return map(path.substringBefore('.'))
   }
 }

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/relocation/SimpleRelocator.kt

@@ -212,7 +212,7 @@ public open class SimpleRelocator @JvmOverloads constructor(
         // Actually, class patterns should just use 'foo.bar.*' ending with a single asterisk, but some users
         // mistake them for path patterns like 'my/path/**', so let us be a bit more lenient here.
         if (filePattern.endsWith("/*") || filePattern.endsWith("/**")) {
-          val packagePattern = filePattern.substring(0, filePattern.lastIndexOf('/'))
+          val packagePattern = filePattern.take(filePattern.lastIndexOf('/'))
           add(packagePattern)
         }
       }

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/tasks/ShadowCopyAction.kt

@@ -87,9 +87,6 @@ public open class ShadowCopyAction(
     }
   }
 
-  /**
-   * Handles cases like [issue 53](https://github.com/GradleUp/shadow/issues/53).
-   */
   private fun addDirs(zos: ZipOutputStream) {
     @Suppress("UNCHECKED_CAST")
     val entries = zos::class.java.getDeclaredField("entries").apply { isAccessible = true }
@@ -173,8 +170,6 @@ public open class ShadowCopyAction(
     /**
      * Applies remapping to the given class with the specified relocation path. The remapped class is then written
      * to the zip file.
-     *
-     * See [issue 364](https://github.com/GradleUp/shadow/issues/364) and [issue 408](https://github.com/GradleUp/shadow/issues/408).
      */
     private fun FileCopyDetails.remapClass() = file.inputStream().use { inputStream ->
       // We don't pass the ClassReader here. This forces the ClassWriter to rebuild the constant pool.

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/AppendingTransformer.kt

@@ -19,14 +19,11 @@ import org.gradle.api.tasks.Optional
  * @author John Engelman
  */
 @CacheableTransformer
-@Suppress("ktlint:standard:backing-property-naming")
 public open class AppendingTransformer @Inject constructor(
   final override val objectFactory: ObjectFactory,
 ) : ResourceTransformer {
-  /**
-   * Defer initialization, see [issue 763](https://github.com/GradleUp/shadow/issues/763).
-   */
-  private var _data: ByteArrayOutputStream? = null
+  @Suppress("ktlint:standard:backing-property-naming")
+  private var _data: ByteArrayOutputStream? = null // It's nullable to allow lazy initialization to support CC.
   private inline val data get() = _data ?: ByteArrayOutputStream().also { _data = it }
 
   @get:Optional
@@ -41,23 +38,24 @@ public open class AppendingTransformer @Inject constructor(
   }
 
   override fun transform(context: TransformerContext) {
-    if (data.size() > 0) {
-      // Append the separator before the new content to ensure the separator is not at the end of the file.
-      data.write(separator.get().toByteArray())
+    data.let {
+      if (it.size() > 0) {
+        // Append the separator before the new content to ensure the separator is not at the end of the file.
+        it.write(separator.get().toByteArray())
+      }
+      context.inputStream.copyTo(it)
     }
-    context.inputStream.copyTo(data)
   }
 
-  override fun hasTransformedResource(): Boolean {
-    return data.size() > 0
-  }
+  override fun hasTransformedResource(): Boolean = data.size() > 0
 
   override fun modifyOutputStream(os: ZipOutputStream, preserveFileTimestamps: Boolean) {
     os.putNextEntry(zipEntry(resource.get(), preserveFileTimestamps))
-
-    // Closing a ByteArrayOutputStream has no effect, so we don't use a use block here.
-    data.toByteArray().inputStream().copyTo(os)
-    data.reset()
+    data.let {
+      // Closing a ByteArrayOutputStream has no effect, so we don't use a use block here.
+      it.toByteArray().inputStream().copyTo(os)
+      it.reset()
+    }
   }
 
   public companion object {

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/ComponentsXmlResourceTransformer.kt

@@ -25,6 +25,22 @@ import org.gradle.api.tasks.Internal
 public open class ComponentsXmlResourceTransformer : ResourceTransformer {
   private val components = mutableMapOf<String, Xpp3Dom>()
 
+  @get:Internal
+  internal val transformedResource: ByteArray
+    get() {
+      val os = ByteArrayOutputStream(1024 * 4)
+      XmlStreamWriter(os).use { writer ->
+        val dom = Xpp3Dom("component-set")
+        val componentDom = Xpp3Dom("components")
+        dom.addChild(componentDom)
+        for (component in components.values) {
+          componentDom.addChild(component)
+        }
+        Xpp3DomWriter.write(writer, dom)
+      }
+      return os.toByteArray()
+    }
+
   override fun canTransformResource(element: FileTreeElement): Boolean {
     return COMPONENTS_XML_PATH == element.path
   }
@@ -85,22 +101,6 @@ public open class ComponentsXmlResourceTransformer : ResourceTransformer {
 
   override fun hasTransformedResource(): Boolean = components.isNotEmpty()
 
-  @get:Internal
-  internal val transformedResource: ByteArray
-    get() {
-      val os = ByteArrayOutputStream(1024 * 4)
-      XmlStreamWriter(os).use { writer ->
-        val dom = Xpp3Dom("component-set")
-        val componentDom = Xpp3Dom("components")
-        dom.addChild(componentDom)
-        for (component in components.values) {
-          componentDom.addChild(component)
-        }
-        Xpp3DomWriter.write(writer, dom)
-      }
-      return os.toByteArray()
-    }
-
   public companion object {
     public const val COMPONENTS_XML_PATH: String = "META-INF/plexus/components.xml"
 

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/GroovyExtensionModuleTransformer.kt

@@ -46,6 +46,7 @@ public open class GroovyExtensionModuleTransformer : ResourceTransformer {
   override fun transform(context: TransformerContext) {
     val props = Properties()
     props.load(context.inputStream)
+    @Suppress("JavaMapForEach")
     props.forEach { key, value ->
       when (key as String) {
         KEY_MODULE_NAME -> handle(key, value as String) {

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/Log4j2PluginsCacheFileTransformer.kt

@@ -48,9 +48,7 @@ public open class Log4j2PluginsCacheFileTransformer : ResourceTransformer {
   /**
    * @return `true` if any dat file collected.
    */
-  override fun hasTransformedResource(): Boolean {
-    return tempFiles.isNotEmpty()
-  }
+  override fun hasTransformedResource(): Boolean = tempFiles.isNotEmpty()
 
   override fun modifyOutputStream(os: ZipOutputStream, preserveFileTimestamps: Boolean) {
     try {

src/main/kotlin/com/github/jengelman/gradle/plugins/shadow/transformers/PropertiesFileTransformer.kt

@@ -212,9 +212,7 @@ public open class PropertiesFileTransformer @Inject constructor(
     return mergeSeparator
   }
 
-  override fun hasTransformedResource(): Boolean {
-    return propertiesEntries.isNotEmpty()
-  }
+  override fun hasTransformedResource(): Boolean = propertiesEntries.isNotEmpty()
 
   override fun modifyOutputStream(os: ZipOutputStream, preserveFileTimestamps: Boolean) {
     // Cannot close the writer as the OutputStream needs to remain open.