net.twisterrob.gradle.quality.Violations.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twister-quality Show documentation
All quality plugins bundled in one.
The newest version!
@file:Suppress("detekt.LongParameterList") // Collection of "data" classes, they have a lot to hold.

package net.twisterrob.gradle.quality

import org.gradle.api.Project
import org.gradle.api.Task
import java.io.File

@Suppress("detekt.UseDataClass") // Don't want to define equals/hashCode/component methods as they all imply something.
class Violations(
	@JvmField val parser: String,
	@JvmField val module: String,
	@JvmField val variant: String,
	/**
	 * Parseable result.
	 */
	@JvmField val result: File,
	/**
	 * Human-consumable report.
	 */
	@JvmField val report: File,
	/**
	 * Report file missing, or error during read.
	 */
	@JvmField val violations: List?
) {

	override fun toString(): String {
		val violations = this.violations?.joinToString(prefix = "\n", separator = "\n") ?: "[]"
		return "${module}${if (module == ":") "" else ":"}${parser}@${variant} (${result}):$violations"
	}
}

@Suppress("detekt.UseDataClass") // Don't want to define equals/hashCode/component methods as they all imply something.
class Violation(
	val rule: String,
	val category: String?,
	val severity: Severity,
	val message: String,
	val specifics: Map = emptyMap(),
	val location: Location,
	val source: Source
) {

	@Suppress("detekt.MaxLineLength")
	override fun toString(): String =
		"Violation(rule='$rule', category=${category ?: "null"}, severity=$severity, message='$message', specifics=$specifics, location=$location, source=$source)"

	enum class Severity {
		INFO,
		WARNING,
		ERROR
	}

	class Location(
		val module: Project,
		val task: Task,
		val variant: String,
		val file: File,
		val startLine: Int,
		val endLine: Int,
		val column: Int
	) {

		@Suppress("detekt.MaxLineLength")
		override fun toString(): String =
			"Location(module=$module, task=$task, variant='$variant', file=$file, startLine=$startLine, endLine=$endLine, column=$column)"
	}

	class Source(
		val parser: String,
		val gatherer: String,
		val reporter: String,
		val source: String,
		val report: File,
		val humanReport: File?
	) {

		@Suppress("detekt.MaxLineLength")
		override fun toString(): String =
			"Source(parser='$parser', gatherer='$gatherer', reporter='$reporter', source='$source', report=$report, humanReport=${humanReport ?: "null"})"
	}
}