net.twisterrob.gradle.pmd.PmdTaskCreator.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of twister-quality-pmd Show documentation

PMD quality setup plugin for Gradle.

There is a newer version: 0.17

package net.twisterrob.gradle.pmd

import com.android.build.gradle.api.BaseVariant
import net.twisterrob.gradle.common.VariantTaskCreator
import org.gradle.api.Project
import java.io.File

class PmdTaskCreator(project: Project) : VariantTaskCreator(
	project,
	"pmd",
	"pmd",
	PmdTask::class.java,
	PmdExtension::class.java
) {

	override fun taskConfigurator() = object : VariantTaskCreator.DefaultTaskConfig() {

		override fun setupConfigLocations(task: PmdTask) {
			task.ruleSets = listOf() // default is java-basic
			val rootConfig = task.project.rootProject.file("config/pmd/pmd.xml")
			val subConfig = task.project.file("config/pmd/pmd.xml")
			val config: File? = listOf(subConfig, rootConfig).firstOrNull { it.exists() }
			if (config != null) {
				task.ruleSetFiles += task.project.files(config)
			} else if (task.ruleSetFiles.files.isEmpty()) {
				task.doFirst("Warn about missing configuration files.") {
					task.logger.warn(
						"""
						While auto-configuring ruleSetFiles for ${task}, there was no configuration found at:
							rootProject=${rootConfig}
							subProject=${subConfig}
							and there's no configuration location set in Gradle build files either.
						""".trimIndent()
					)
				}
			}

			// put configuration files on classpath of PMD so it's possible to reference own rulesets with relative path
			task.classpath = (task.classpath ?: task.project.files()) +
					task.project.files(task.ruleSetFiles.map { it.parentFile })
		}

		override fun setupSources(task: PmdTask, variants: Collection) {
			super.setupSources(task, variants)

			val buildPath = task.project.buildDir.toPath()
			val projectPath = task.project.projectDir.toPath()
			if (!buildPath.startsWith(projectPath)) {
				task.logger.warn(
					"""
					Cannot set up ${task} source folders,
						because the build directory ${buildPath}
						needs to be inside the project directory ${projectPath}.
					""".trimIndent().replace("""\r?\n\t*""".toRegex(), " ")
				)
				return
			}

			task.include(variants
				.flatMap { it.sourceSets }
				.flatMap { it.resDirectories }
				.map { dir ->
					// build relative path (e.g. src/main/res) and
					// append a trailing "/" for include to treat it as recursive
					projectPath.relativize(dir.toPath()).toString() + File.separator
				})

			task.include(variants
				.flatMap { it.sourceSets }
				.map { it.manifestFile }
				.map { file ->
					// build relative path (e.g. src/main/AndroidManifest.xml)
					projectPath.relativize(file.toPath()).toString()
				})
		}
	}
}