chore: Remove more detekt issues (part 4) (#1794)

* chore: Remove Suppress annotation where it's unnecessary

* chore: Suppress MagicNumber detekt warnings

* chore: Suppress TooGenericExceptionThrown detekt warnings

* chore: Suppress TooGenericExceptionCaught detekt warnings

* chore: Suppress FunctionNaming detekt warnings

* chore: Suppress SwallowedException detekt warnings

* chore: Remove ForbiddenComment detekt issue

* chore: Increase detekt LongMethod threshold from 60 (default) to 90 and suppress remaining LongMethod warnings

* chore: Suppress UnnecessaryAbstractClass detekt warnings

* chore: Suppress NestedBlockDepth detekt warnings

* chore: Suppress ComplexMethod detekt warnings

* chore: Suppress MatchingDeclarationName detekt warning

* chore: Suppress VariableNaming detekt warnings

* chore: Fix detekt issues in PR build

-Rearrange imports in Publishing.kt
-Suppress FunctionNaming detekt warnings in Publishing.kt

* chore: Fix detekt issues in PR build

-Remove TopLevelPropertyNaming detekt issue in Accessors.kt by renaming _dockerCompose to dockerCompose

* chore: Remove path to formatting jar file

* chore: Fix detekt issues in PR build

Suppress MagicNumber warning in DBTestWithDockerCompose.kt

* chore: Suppress detekt warnings in exposed-core module

* chore: Suppress detekt warning in exposed-crypt module

* chore: Suppress detekt warning in exposed-dao module

* chore: Remove detekt issue in exposed-java-time module

* chore: Remove detekt issue in exposed-kotlin-datetime module

* chore: Remove detekt issues in exposed-spring-boot-starter module

* chore: Remove detekt issues in spring-transaction module

* chore: Remove detekt issues in samples module

deactivate ThrowsCount rule

buildSrc/src/main/kotlin/org/jetbrains/exposed/gradle/Accessors.kt

@@ -1,5 +1,3 @@
-@file:Suppress("FunctionName")
-
 package org.jetbrains.exposed.gradle
 
 import com.avast.gradle.dockercompose.ComposeExtension
@@ -8,5 +6,5 @@ import org.gradle.kotlin.dsl.getByName
 
 private inline fun <reified T : Any> Project.extByName(name: String): T = extensions.getByName<T>(name)
 
-val Project._dockerCompose
+val Project.dockerCompose
     get() = extByName<ComposeExtension>("dockerCompose")

buildSrc/src/main/kotlin/org/jetbrains/exposed/gradle/Publishing.kt

@@ -1,14 +1,12 @@
-@file:Suppress("UnstableApiUsage")
-
 package org.jetbrains.exposed.gradle
 
 import org.gradle.api.Project
+import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.api.provider.Property
 import org.gradle.api.publish.PublishingExtension
 import org.gradle.api.publish.maven.MavenPom
 import org.gradle.api.publish.maven.MavenPublication
 import org.gradle.plugins.signing.SigningExtension
-import org.gradle.api.plugins.JavaPluginExtension
 
 infix fun <T> Property<T>.by(value: T) {
     set(value)
@@ -55,10 +53,12 @@ fun MavenPublication.signPublicationIfKeyPresent(project: Project) {
     }
 }
 
+@Suppress("FunctionNaming")
 fun Project._publishing(configure: PublishingExtension.() -> Unit) {
     extensions.configure("publishing", configure)
 }
 
+@Suppress("FunctionNaming")
 fun Project._java(configure: JavaPluginExtension.() -> Unit) {
     extensions.configure("java", configure)
-}
+}

buildSrc/src/main/kotlin/org/jetbrains/exposed/gradle/tasks/DBTestWithDockerCompose.kt

@@ -2,7 +2,7 @@ package org.jetbrains.exposed.gradle.tasks
 
 import com.avast.gradle.dockercompose.ComposeSettings
 import org.gradle.api.tasks.Input
-import org.jetbrains.exposed.gradle._dockerCompose
+import org.jetbrains.exposed.gradle.dockerCompose
 import java.io.File
 import java.time.Duration
 import javax.inject.Inject
@@ -16,13 +16,15 @@ open class DBTestWithDockerCompose(dialect: String, @get:Input val port: Int, @g
     @Inject
     constructor(parameters: Parameters) : this(parameters.dialect, parameters.port, parameters.dockerComposeServiceName)
 
-    private val dockerCompose: ComposeSettings = project._dockerCompose.nested(dockerComposeServiceName).apply {
+    private val dockerCompose: ComposeSettings = project.dockerCompose.nested(dockerComposeServiceName).apply {
         environment.put("COMPOSE_CONVERT_WINDOWS_PATHS", true)
         useComposeFiles.add(
             File(project.rootProject.projectDir, "buildScripts/docker/docker-compose-$dockerComposeServiceName.yml").absolutePath
         )
         captureContainersOutput.set(true)
         removeVolumes.set(true)
+
+        @Suppress("MagicNumber")
         waitForHealthyStateTimeout.set(Duration.ofMinutes(60))
     }
 

detekt/detekt-config.yml

@@ -30,6 +30,8 @@ style:
     MagicNumber:
         ignoreNamedArgument: true
         ignoreRanges: true
+    ThrowsCount:
+        active: false
 
 complexity:
     LongParameterList:
@@ -43,6 +45,8 @@ complexity:
         thresholdInObjects: 26
     ComplexMethod:
         threshold: 26
+    LongMethod:
+        threshold: 90
 
 naming:
     ConstructorParameterNaming:

exposed-core/src/main/kotlin/org/jetbrains/exposed/dao/id/IdTable.kt

@@ -19,7 +19,6 @@ object EntityIDFunctionProvider {
             }
     }
 
-    @Suppress("UNCHECKED_CAST")
     fun <T : Comparable<T>> createEntityID(value: T, table: IdTable<T>) = factory.createEntityID(value, table)
 }
 

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/Alias.kt

@@ -75,7 +75,6 @@ class QueryAlias(val query: AbstractQuery<*>, val alias: String) : ColumnSet() {
         query.set.source.columns.find { it == original }?.clone() as? Column<T>
             ?: error("Column not found in original table")
 
-    @Suppress("UNCHECKED_CAST")
     operator fun <T : Any?> get(original: Expression<T>): Expression<T> {
         val aliases = query.set.fields.filterIsInstance<ExpressionAlias<T>>()
         return aliases.find { it == original }?.let {

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/Column.kt

@@ -81,6 +81,7 @@ class Column<T>(
     internal fun isOneColumnPK(): Boolean = this == table.primaryKey?.columns?.singleOrNull()
 
     /** Returns the SQL representation of this column. */
+    @Suppress("ComplexMethod")
     fun descriptionDdl(modify: Boolean = false): String = buildString {
         val tr = TransactionManager.current()
         val column = this@Column

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/SQLExpressionBuilder.kt

@@ -663,7 +663,7 @@ interface ISqlExpressionBuilder {
     } as QueryParameter<T>
 
     /** Returns the specified [value] as a literal of type [T]. */
-    @Suppress("UNCHECKED_CAST")
+    @Suppress("UNCHECKED_CAST", "ComplexMethod")
     fun <T, S : T?> ExpressionWithColumnType<S>.asLiteral(value: T): LiteralOp<T> = when (value) {
         is Boolean -> booleanLiteral(value)
         is Byte -> byteLiteral(value)

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/Table.kt

@@ -866,7 +866,6 @@ open class Table(name: String = "") : ColumnSet(), DdlAware {
      *
      * @see ReferenceOption
      */
-    @Suppress("UNCHECKED_CAST")
     @JvmName("optReferenceByIdColumn")
     fun <T : Comparable<T>, E : EntityID<T>> optReference(
         name: String,

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/statements/InsertStatement.kt

@@ -36,7 +36,7 @@ open class InsertStatement<Key : Any>(val table: Table, val isIgnore: Boolean =
 
     fun <T> getOrNull(column: Column<T>): T? = resultedValues?.firstOrNull()?.getOrNull(column)
 
-    @Suppress("NestedBlockDepth")
+    @Suppress("NestedBlockDepth", "ComplexMethod")
     private fun processResults(rs: ResultSet?, inserted: Int): List<ResultRow> {
         val autoGeneratedKeys = arrayListOf<MutableMap<Column<*>, Any?>>()
 
@@ -98,6 +98,7 @@ open class InsertStatement<Key : Any>(val table: Table, val isIgnore: Boolean =
         return autoGeneratedKeys.map { ResultRow.createAndFillValues(it as Map<Expression<*>, Any?>) }
     }
 
+    @Suppress("NestedBlockDepth")
     protected open fun valuesAndDefaults(values: Map<Column<*>, Any?> = this.values): Map<Column<*>, Any?> {
         val result = values.toMutableMap()
         targets.forEach { table ->

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/transactions/ThreadLocalTransactionManager.kt

@@ -207,7 +207,6 @@ fun <T> transaction(
         }
     }
 
-@Suppress("LongParameterList")
 fun <T> inTopLevelTransaction(
     transactionIsolation: Int,
     readOnly: Boolean = false,

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/transactions/TransactionApi.kt

@@ -161,6 +161,7 @@ internal inline fun TransactionInterface.closeLoggingException(log: (Exception)
     }
 }
 
+@Suppress("TooGenericExceptionThrown")
 val Database?.transactionManager: TransactionManager
     get() = TransactionManager.managerFor(this)
         ?: throw RuntimeException("database $this don't have any transaction manager")

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/vendors/Default.kt

@@ -82,6 +82,7 @@ abstract class DataTypeProvider {
     /** Binary type for storing [UUID]. */
     open fun uuidType(): String = "BINARY(16)"
 
+    @Suppress("MagicNumber")
     open fun uuidToDB(value: UUID): Any =
         ByteBuffer.allocate(16).putLong(value.mostSignificantBits).putLong(value.leastSignificantBits).array()
 
@@ -1042,6 +1043,7 @@ abstract class VendorDialect(
     protected val identifierManager
         get() = TransactionManager.current().db.identifierManager
 
+    @Suppress("UnnecessaryAbstractClass")
     abstract class DialectNameProvider(val dialectName: String)
 
     /* Cached values */

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/vendors/OracleDialect.kt

@@ -36,6 +36,7 @@ internal object OracleDataTypeProvider : DataTypeProvider() {
     override fun booleanFromStringToBoolean(value: String): Boolean = try {
         value.toLong() != 0L
     } catch (ex: NumberFormatException) {
+        @Suppress("SwallowedException")
         try {
             value.lowercase().toBooleanStrict()
         } catch (ex: IllegalArgumentException) {
@@ -322,6 +323,7 @@ open class OracleDialect : VendorDialect(dialectName, OracleDataTypeProvider, Or
 
     override fun createSchema(schema: Schema): String = buildString {
         if ((schema.quota == null) xor (schema.on == null)) {
+            @Suppress("UseRequire")
             throw IllegalArgumentException("You must either provide both <quota> and <on> options or non of them")
         }
 

exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/vendors/SQLServerDialect.kt

@@ -238,8 +238,7 @@ open class SQLServerDialect : VendorDialect(dialectName, SQLServerDataTypeProvid
         return columnDefault !in nonAcceptableDefaults
     }
 
-    // TODO: Fix changing default value on column as it requires to drop/create constraint
-    // https://stackoverflow.com/questions/15547210/modify-default-value-in-sql-server
+    // EXPOSED-85 Fix changing default value on column in SQL Server as it requires to drop/create constraint
     override fun modifyColumn(column: Column<*>, columnDiff: ColumnDiff): List<String> =
         super.modifyColumn(column, columnDiff).map { it.replace("MODIFY COLUMN", "ALTER COLUMN") }
 

exposed-crypt/src/main/kotlin/org/jetbrains/exposed/crypt/Algorithms.kt

@@ -10,6 +10,7 @@ import javax.crypto.spec.SecretKeySpec
 import kotlin.math.ceil
 
 object Algorithms {
+    @Suppress("MagicNumber")
     private fun base64EncodedLength(byteSize: Int): Int = ceil(byteSize.toDouble() / 3).toInt() * 4
     private fun paddingLen(len: Int, blockSize: Int): Int = if (len % blockSize == 0) 0 else blockSize - len % blockSize
     private val base64Decoder = Base64.getDecoder()
@@ -82,7 +83,7 @@ object Algorithms {
 
     private const val TRIPLE_DES_KEY_LENGTH = 24
     private const val TRIPLE_DES_BLOCK_LENGTH = 8
-    @Suppress("FunctionNaming")
+    @Suppress("FunctionNaming", "UseRequire")
     fun TRIPLE_DES(secretKey: CharSequence): Encryptor {
         if (secretKey.toString().toByteArray().size != TRIPLE_DES_KEY_LENGTH) {
             throw IllegalArgumentException("secretKey must have 24 bytes")

exposed-dao/src/main/kotlin/org/jetbrains/exposed/dao/Entity.kt

@@ -38,7 +38,10 @@ open class Entity<ID : Comparable<ID>>(val id: EntityID<ID>) {
         internal set
 
     val writeValues = LinkedHashMap<Column<Any?>, Any?>()
+
+    @Suppress("VariableNaming")
     var _readValues: ResultRow? = null
+
     val readValues: ResultRow
         get() = _readValues ?: run {
             val table = klass.table
@@ -178,7 +181,6 @@ open class Entity<ID : Comparable<ID>>(val id: EntityID<ID>) {
         return this.restoreValueFromParts(values)
     }
 
-    @Suppress("UNCHECKED_CAST")
     fun <T, R : Any> Column<T>.lookupInReadValues(found: (T?) -> R?, notFound: () -> R?): R? =
         if (_readValues?.hasValue(this) == true) {
             found(readValues[this])
@@ -261,6 +263,7 @@ open class Entity<ID : Comparable<ID>>(val id: EntityID<ID>) {
             if (batch == null) {
                 val table = klass.table
                 // Store values before update to prevent flush inside UpdateStatement
+                @Suppress("VariableNaming")
                 val _writeValues = writeValues.toMap()
                 storeWrittenValues()
                 // In case of batch all changes will be registered after all entities flushed

exposed-dao/src/main/kotlin/org/jetbrains/exposed/dao/EntityCache.kt

@@ -24,7 +24,6 @@ class EntityCache(private val transaction: Transaction) {
      * Amount of entities to keep in a cache per an Entity class.
      * On setting a new value all data stored in cache will be adjusted to a new size
      */
-    @Suppress("MemberVisibilityCanBePrivate")
     var maxEntitiesToStore = transaction.db.config.maxEntitiesToStoreInCachePerEntity
         set(value) {
             val diff = value - field

exposed-dao/src/main/kotlin/org/jetbrains/exposed/dao/EntityClass.kt

@@ -356,7 +356,6 @@ abstract class EntityClass<ID : Comparable<ID>, out T : Entity<ID>>(
 
     private fun Query.setForUpdateStatus(): Query = if (this@EntityClass is ImmutableEntityClass<*, *>) this.notForUpdate() else this
 
-    @Suppress("CAST_NEVER_SUCCEEDS")
     fun <SID> warmUpOptReferences(references: List<SID>, refColumn: Column<SID?>, forUpdate: Boolean? = null): List<T> =
         warmUpReferences(references, refColumn as Column<SID>, forUpdate)
 
@@ -419,6 +418,7 @@ abstract class EntityClass<ID : Comparable<ID>, out T : Entity<ID>>(
         else -> findQuery
     }.toList()
 
+    @Suppress("ComplexMethod")
     internal fun <SID : Comparable<SID>> warmUpLinkedReferences(
         references: List<EntityID<SID>>,
         sourceRefColumn: Column<EntityID<SID>>,

exposed-dao/src/main/kotlin/org/jetbrains/exposed/dao/EntityHook.kt

@@ -25,7 +25,6 @@ fun <ID : Comparable<ID>, T : Entity<ID>> EntityChange.toEntity(): T? = (entityC
 
 fun <ID : Comparable<ID>, T : Entity<ID>> EntityChange.toEntity(klass: EntityClass<ID, T>): T? {
     if (!entityClass.isAssignableTo(klass)) return null
-    @Suppress("UNCHECKED_CAST")
     return toEntity<ID, T>()
 }
 

exposed-dao/src/main/kotlin/org/jetbrains/exposed/dao/EntityLifecycleInterceptor.kt

@@ -27,6 +27,7 @@ class EntityLifecycleInterceptor : GlobalStatementInterceptor {
         return userData.filterValues { it is EntityCache }
     }
 
+    @Suppress("ComplexMethod")
     override fun beforeExecution(transaction: Transaction, context: StatementContext) {
         when (val statement = context.statement) {
             is Query -> transaction.flushEntities(statement)

exposed-dao/src/main/kotlin/org/jetbrains/exposed/dao/IntEntity.kt

@@ -3,8 +3,10 @@ package org.jetbrains.exposed.dao
 import org.jetbrains.exposed.dao.id.EntityID
 import org.jetbrains.exposed.dao.id.IdTable
 
+@Suppress("UnnecessaryAbstractClass")
 abstract class IntEntity(id: EntityID<Int>) : Entity<Int>(id)
 
+@Suppress("UnnecessaryAbstractClass")
 abstract class IntEntityClass<out E : IntEntity> constructor(
     table: IdTable<Int>,
     entityType: Class<E>? = null,

exposed-dao/src/main/kotlin/org/jetbrains/exposed/dao/LongEntity.kt

@@ -3,8 +3,10 @@ package org.jetbrains.exposed.dao
 import org.jetbrains.exposed.dao.id.EntityID
 import org.jetbrains.exposed.dao.id.IdTable
 
+@Suppress("UnnecessaryAbstractClass")
 abstract class LongEntity(id: EntityID<Long>) : Entity<Long>(id)
 
+@Suppress("UnnecessaryAbstractClass")
 abstract class LongEntityClass<out E : LongEntity>(
     table: IdTable<Long>,
     entityType: Class<E>? = null,

exposed-dao/src/main/kotlin/org/jetbrains/exposed/dao/References.kt

@@ -132,7 +132,7 @@ private fun <SRC : Entity<*>> filterRelationsForEntity(
     return validMembers.filter { it in relations } as Collection<KProperty1<SRC, Any?>>
 }
 
-@Suppress("UNCHECKED_CAST")
+@Suppress("UNCHECKED_CAST", "NestedBlockDepth", "ComplexMethod")
 private fun <ID : Comparable<ID>> List<Entity<ID>>.preloadRelations(
     vararg relations: KProperty1<out Entity<*>, Any?>,
     nodesVisited: MutableSet<EntityClass<*, *>> = mutableSetOf()

exposed-dao/src/main/kotlin/org/jetbrains/exposed/dao/UUIDEntity.kt

@@ -4,8 +4,10 @@ import org.jetbrains.exposed.dao.id.EntityID
 import org.jetbrains.exposed.dao.id.IdTable
 import java.util.*
 
+@Suppress("UnnecessaryAbstractClass")
 abstract class UUIDEntity(id: EntityID<UUID>) : Entity<UUID>(id)
 
+@Suppress("UnnecessaryAbstractClass")
 abstract class UUIDEntityClass<out E : UUIDEntity>(
     table: IdTable<UUID>,
     entityType: Class<E>? = null,

exposed-java-time/build.gradle.kts

@@ -20,14 +20,10 @@ dependencies {
     testImplementation(kotlin("test-junit"))
 }
 
-//tasks.withType<Detekt>().configureEach {
-//    // Target version of the generated JVM bytecode. It is used for type resolution.
-//    jvmTarget = "1.8"
-//}
-
 tasks.withType<Test>().configureEach {
-    if (JavaVersion.VERSION_1_8 > JavaVersion.current())
+    if (JavaVersion.VERSION_1_8 > JavaVersion.current()) {
         jvmArgs = listOf("-XX:MaxPermSize=256m")
+    }
     testLogging {
         events.addAll(listOf(TestLogEvent.PASSED, TestLogEvent.FAILED, TestLogEvent.SKIPPED))
         showStandardStreams = true

exposed-java-time/src/main/kotlin/org/jetbrains/exposed/sql/javatime/JavaDateColumnType.kt

@@ -49,8 +49,10 @@ internal fun dateTimeWithFractionFormat(fraction: Int): DateTimeFormatter {
     return DateTimeFormatter.ofPattern(newFormat).withLocale(Locale.ROOT).withZone(ZoneId.systemDefault())
 }
 
+@Suppress("MagicNumber")
 internal val LocalDate.millis get() = atStartOfDay(ZoneId.systemDefault()).toEpochSecond() * 1000
 
+@Suppress("MagicNumber")
 class JavaLocalDateColumnType : ColumnType(), IDateColumnType {
     override val hasTimePart: Boolean = false
 
@@ -94,6 +96,7 @@ class JavaLocalDateColumnType : ColumnType(), IDateColumnType {
     }
 }
 
+@Suppress("MagicNumber")
 class JavaLocalDateTimeColumnType : ColumnType(), IDateColumnType {
     override val hasTimePart: Boolean = true
     override fun sqlType(): String = currentDialect.dataTypeProvider.dateTimeType()

exposed-java-time/src/test/kotlin/org/jetbrains/exposed/MiscTableTest.kt

@@ -1,4 +1,4 @@
-@file:Suppress("MaximumLineLength")
+@file:Suppress("MaximumLineLength", "LongMethod")
 
 package org.jetbrains.exposed
 

exposed-jdbc/src/main/kotlin/org/jetbrains/exposed/sql/statements/jdbc/JdbcIdentifierManager.kt

@@ -13,7 +13,9 @@ internal class JdbcIdentifierManager(metadata: DatabaseMetaData) : IdentifierMan
     override val supportsMixedQuotedIdentifiers = metadata.supportsMixedCaseQuotedIdentifiers()
     private val _keywords = metadata.sqlKeywords.split(',')
     override fun dbKeywords(): List<String> = _keywords
-    override val extraNameCharacters = metadata.extraNameCharacters!!
+    override val extraNameCharacters = metadata.extraNameCharacters !!
+
+    @Suppress("MagicNumber")
     override val oracleVersion = when {
         metadata.databaseProductName != "Oracle" -> OracleVersion.NonOracle
         metadata.databaseMajorVersion <= 11 -> OracleVersion.Oracle11g