pull Finding apis out of :modulecheck-rules:api and into their ow…

build.gradle.kts

@@ -1,3 +1,20 @@
+/*
+ * Copyright (C) 2021-2022 Rick Busarow
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import modulecheck.gradle.moduleCheck
+
 /*
  * Copyright (C) 2021-2022 Rick Busarow
  * Licensed under the Apache License, Version 2.0 (the "License");

modulecheck-api/build.gradle.kts

@@ -33,11 +33,11 @@ dependencies {
   api(libs.rickBusarow.dispatch.core)
   api(libs.semVer)
 
+  api(project(path = ":modulecheck-finding:api"))
   api(project(path = ":modulecheck-parsing:android"))
   api(project(path = ":modulecheck-parsing:gradle"))
   api(project(path = ":modulecheck-parsing:source"))
   api(project(path = ":modulecheck-project:api"))
-  api(project(path = ":modulecheck-rule:api"))
   api(project(path = ":modulecheck-utils"))
 
   implementation(libs.agp)

modulecheck-api/src/main/kotlin/modulecheck/api/DepthFinding.kt

@@ -16,19 +16,19 @@
 package modulecheck.api
 
 import modulecheck.api.context.ProjectDepth
+import modulecheck.finding.Finding
+import modulecheck.finding.Finding.FindingResult
+import modulecheck.finding.Finding.Position
+import modulecheck.finding.FindingName
 import modulecheck.parsing.gradle.ProjectPath.StringProjectPath
 import modulecheck.parsing.gradle.SourceSetName
 import modulecheck.project.McProject
-import modulecheck.rule.RuleName
-import modulecheck.rule.finding.Finding
-import modulecheck.rule.finding.Finding.FindingResult
-import modulecheck.rule.finding.Finding.Position
 import modulecheck.utils.LazyDeferred
 import modulecheck.utils.lazyDeferred
 import java.io.File
 
 data class DepthFinding(
-  override val ruleName: RuleName,
+  override val findingName: FindingName,
   override val dependentProject: McProject,
   override val dependentPath: StringProjectPath,
   val depth: Int,
@@ -46,7 +46,7 @@ data class DepthFinding(
   override suspend fun toResult(fixed: Boolean): FindingResult {
     return FindingResult(
       dependentPath = dependentPath,
-      ruleName = ruleName,
+      findingName = findingName,
       sourceOrNull = null,
       configurationName = "",
       dependencyIdentifier = dependencyIdentifier,

modulecheck-api/src/main/kotlin/modulecheck/api/context/Depths.kt

@@ -16,11 +16,11 @@
 package modulecheck.api.context
 
 import modulecheck.api.DepthFinding
+import modulecheck.finding.FindingName
 import modulecheck.parsing.gradle.ProjectPath.StringProjectPath
 import modulecheck.parsing.gradle.SourceSetName
 import modulecheck.project.McProject
 import modulecheck.project.ProjectContext
-import modulecheck.rule.RuleName
 import modulecheck.utils.SafeCache
 
 data class Depths(
@@ -84,8 +84,8 @@ data class ProjectDepth(
 ) : Comparable<ProjectDepth> {
   private val treeCache = SafeCache<SourceSetName, Set<ProjectDepth>>()
 
-  fun toFinding(name: RuleName): DepthFinding = DepthFinding(
-    ruleName = name,
+  fun toFinding(name: FindingName): DepthFinding = DepthFinding(
+    findingName = name,
     dependentProject = dependentProject,
     dependentPath = dependentPath,
     depth = depth,

modulecheck-core/build.gradle.kts

@@ -34,6 +34,7 @@ dependencies {
 
   api(project(path = ":modulecheck-api"))
   api(project(path = ":modulecheck-config:api"))
+  api(project(path = ":modulecheck-finding:api"))
   api(project(path = ":modulecheck-parsing:gradle"))
   api(project(path = ":modulecheck-parsing:source"))
   api(project(path = ":modulecheck-project:api"))

modulecheck-core/src/main/kotlin/modulecheck/core/AbstractProjectDependencyFinding.kt

@@ -15,17 +15,17 @@
 
 package modulecheck.core
 
+import modulecheck.finding.DependencyFinding
+import modulecheck.finding.Finding
+import modulecheck.finding.Finding.FindingResult
+import modulecheck.finding.Finding.Position
+import modulecheck.finding.Fixable
+import modulecheck.finding.Problem
+import modulecheck.finding.ProjectDependencyFinding
+import modulecheck.finding.internal.positionOfStatement
+import modulecheck.finding.internal.statementOrNullIn
 import modulecheck.parsing.gradle.Declaration
 import modulecheck.parsing.gradle.ProjectPath.StringProjectPath
-import modulecheck.rule.finding.DependencyFinding
-import modulecheck.rule.finding.Finding
-import modulecheck.rule.finding.Finding.FindingResult
-import modulecheck.rule.finding.Finding.Position
-import modulecheck.rule.finding.Fixable
-import modulecheck.rule.finding.Problem
-import modulecheck.rule.finding.ProjectDependencyFinding
-import modulecheck.rule.finding.internal.positionOfStatement
-import modulecheck.rule.finding.internal.statementOrNullIn
 import modulecheck.utils.LazyDeferred
 import modulecheck.utils.lazyDeferred
 import java.io.File
@@ -57,7 +57,7 @@ abstract class AbstractProjectDependencyFinding :
   override suspend fun toResult(fixed: Boolean): FindingResult {
     return FindingResult(
       dependentPath = dependentPath,
-      ruleName = ruleName,
+      findingName = findingName,
       sourceOrNull = fromStringOrEmpty(),
       configurationName = configurationName.value,
       dependencyIdentifier = dependency.path.value,
@@ -74,15 +74,15 @@ abstract class AbstractProjectDependencyFinding :
     if (this === other) return true
     if (other !is AbstractProjectDependencyFinding) return false
 
-    if (ruleName != other.ruleName) return false
+    if (findingName != other.findingName) return false
     if (dependency != other.dependency) return false
     if (configurationName != other.configurationName) return false
 
     return true
   }
 
   override fun hashCode(): Int {
-    var result = ruleName.hashCode()
+    var result = findingName.hashCode()
     result = 31 * result + dependency.hashCode()
     result = 31 * result + configurationName.hashCode()
     return result

modulecheck-core/src/main/kotlin/modulecheck/core/InheritedDependencyFinding.kt

@@ -15,19 +15,19 @@
 
 package modulecheck.core
 
+import modulecheck.finding.AddsDependency
+import modulecheck.finding.Finding.Position
+import modulecheck.finding.FindingName
+import modulecheck.finding.internal.positionIn
+import modulecheck.finding.internal.statementOrNullIn
 import modulecheck.parsing.gradle.Declaration
 import modulecheck.project.ConfiguredProjectDependency
 import modulecheck.project.McProject
-import modulecheck.rule.RuleName
-import modulecheck.rule.finding.AddsDependency
-import modulecheck.rule.finding.Finding.Position
-import modulecheck.rule.finding.internal.positionIn
-import modulecheck.rule.finding.internal.statementOrNullIn
 import modulecheck.utils.LazyDeferred
 import modulecheck.utils.lazyDeferred
 
 data class InheritedDependencyFinding(
-  override val ruleName: RuleName,
+  override val findingName: FindingName,
   override val dependentProject: McProject,
   override val newDependency: ConfiguredProjectDependency,
   val source: ConfiguredProjectDependency

modulecheck-core/src/main/kotlin/modulecheck/core/MustBeApiFinding.kt

@@ -15,20 +15,20 @@
 
 package modulecheck.core
 
+import modulecheck.finding.AddsDependency
+import modulecheck.finding.FindingName
+import modulecheck.finding.ModifiesProjectDependency
+import modulecheck.finding.RemovesDependency
+import modulecheck.finding.internal.statementOrNullIn
 import modulecheck.parsing.gradle.ConfigurationName
 import modulecheck.parsing.gradle.Declaration
 import modulecheck.project.ConfiguredProjectDependency
 import modulecheck.project.McProject
-import modulecheck.rule.RuleName
-import modulecheck.rule.finding.AddsDependency
-import modulecheck.rule.finding.ModifiesProjectDependency
-import modulecheck.rule.finding.RemovesDependency
-import modulecheck.rule.finding.internal.statementOrNullIn
 import modulecheck.utils.LazyDeferred
 import modulecheck.utils.lazyDeferred
 
 data class MustBeApiFinding(
-  override val ruleName: RuleName,
+  override val findingName: FindingName,
   override val dependentProject: McProject,
   override val newDependency: ConfiguredProjectDependency,
   override val oldDependency: ConfiguredProjectDependency,

modulecheck-core/src/main/kotlin/modulecheck/core/OverShotDependencyFinding.kt

@@ -15,15 +15,15 @@
 
 package modulecheck.core
 
+import modulecheck.finding.AddsDependency
+import modulecheck.finding.Finding.Position
+import modulecheck.finding.FindingName
+import modulecheck.finding.internal.positionOfStatement
+import modulecheck.finding.internal.statementOrNullIn
 import modulecheck.parsing.gradle.ConfigurationName
 import modulecheck.parsing.gradle.Declaration
 import modulecheck.project.ConfiguredProjectDependency
 import modulecheck.project.McProject
-import modulecheck.rule.RuleName
-import modulecheck.rule.finding.AddsDependency
-import modulecheck.rule.finding.Finding.Position
-import modulecheck.rule.finding.internal.positionOfStatement
-import modulecheck.rule.finding.internal.statementOrNullIn
 import modulecheck.utils.LazyDeferred
 import modulecheck.utils.lazyDeferred
 
@@ -33,8 +33,8 @@ data class OverShotDependency(
   val oldDependency: ConfiguredProjectDependency,
   val configurationName: ConfigurationName
 ) {
-  fun toFinding(ruleName: RuleName): OverShotDependencyFinding = OverShotDependencyFinding(
-    ruleName = ruleName,
+  fun toFinding(findingName: FindingName): OverShotDependencyFinding = OverShotDependencyFinding(
+    findingName = findingName,
     dependentProject = dependentProject,
     newDependency = newDependency,
     oldDependency = oldDependency,
@@ -43,7 +43,7 @@ data class OverShotDependency(
 }
 
 data class OverShotDependencyFinding(
-  override val ruleName: RuleName,
+  override val findingName: FindingName,
   override val dependentProject: McProject,
   override val newDependency: ConfiguredProjectDependency,
   val oldDependency: ConfiguredProjectDependency,

modulecheck-core/src/main/kotlin/modulecheck/core/RedundantDependencyFinding.kt

@@ -15,21 +15,21 @@
 
 package modulecheck.core
 
+import modulecheck.finding.Deletable
+import modulecheck.finding.FindingName
+import modulecheck.finding.RemovesDependency
 import modulecheck.parsing.gradle.ConfigurationName
 import modulecheck.project.ConfiguredProjectDependency
 import modulecheck.project.McProject
-import modulecheck.rule.RuleName
-import modulecheck.rule.finding.Deletable
-import modulecheck.rule.finding.RemovesDependency
 
 data class RedundantDependency(
   val dependentProject: McProject,
   val dependency: ConfiguredProjectDependency,
   val configurationName: ConfigurationName,
   val from: List<ConfiguredProjectDependency>
 ) {
-  fun toFinding(ruleName: RuleName): RedundantDependencyFinding = RedundantDependencyFinding(
-    ruleName = ruleName,
+  fun toFinding(findingName: FindingName): RedundantDependencyFinding = RedundantDependencyFinding(
+    findingName = findingName,
     dependentProject = dependentProject,
     oldDependency = dependency,
     configurationName = configurationName,
@@ -38,7 +38,7 @@ data class RedundantDependency(
 }
 
 data class RedundantDependencyFinding(
-  override val ruleName: RuleName,
+  override val findingName: FindingName,
   override val dependentProject: McProject,
   override val oldDependency: ConfiguredProjectDependency,
   override val configurationName: ConfigurationName,

modulecheck-core/src/main/kotlin/modulecheck/core/UnusedDependency.kt

@@ -15,12 +15,12 @@
 
 package modulecheck.core
 
+import modulecheck.finding.Deletable
+import modulecheck.finding.FindingName
+import modulecheck.finding.RemovesDependency
 import modulecheck.parsing.gradle.ConfigurationName
 import modulecheck.project.ConfiguredProjectDependency
 import modulecheck.project.McProject
-import modulecheck.rule.RuleName
-import modulecheck.rule.finding.Deletable
-import modulecheck.rule.finding.RemovesDependency
 
 data class UnusedDependency(
   val dependentProject: McProject,
@@ -29,8 +29,8 @@ data class UnusedDependency(
   val configurationName: ConfigurationName
 ) {
 
-  fun toFinding(ruleName: RuleName): UnusedDependencyFinding = UnusedDependencyFinding(
-    ruleName = ruleName,
+  fun toFinding(findingName: FindingName): UnusedDependencyFinding = UnusedDependencyFinding(
+    findingName = findingName,
     dependentProject = dependentProject,
     oldDependency = dependency,
     dependencyIdentifier = dependencyIdentifier,
@@ -39,7 +39,7 @@ data class UnusedDependency(
 }
 
 data class UnusedDependencyFinding(
-  override val ruleName: RuleName,
+  override val findingName: FindingName,
   override val dependentProject: McProject,
   override val oldDependency: ConfiguredProjectDependency,
   override val dependencyIdentifier: String,

modulecheck-core/src/main/kotlin/modulecheck/core/UnusedPluginFinding.kt

@@ -15,18 +15,18 @@
 
 package modulecheck.core
 
+import modulecheck.finding.Deletable
+import modulecheck.finding.Finding
+import modulecheck.finding.Finding.Position
+import modulecheck.finding.FindingName
+import modulecheck.finding.Fixable
+import modulecheck.finding.Problem
+import modulecheck.finding.RemovesDependency.RemovalStrategy
+import modulecheck.finding.internal.removeDependencyWithComment
+import modulecheck.finding.internal.removeDependencyWithDelete
 import modulecheck.parsing.gradle.Declaration
 import modulecheck.parsing.gradle.ProjectPath.StringProjectPath
 import modulecheck.project.McProject
-import modulecheck.rule.RuleName
-import modulecheck.rule.finding.Deletable
-import modulecheck.rule.finding.Finding
-import modulecheck.rule.finding.Finding.Position
-import modulecheck.rule.finding.Fixable
-import modulecheck.rule.finding.Problem
-import modulecheck.rule.finding.RemovesDependency.RemovalStrategy
-import modulecheck.rule.finding.internal.removeDependencyWithComment
-import modulecheck.rule.finding.internal.removeDependencyWithDelete
 import modulecheck.utils.LazyDeferred
 import modulecheck.utils.lazyDeferred
 import java.io.File
@@ -35,7 +35,7 @@ data class UnusedPluginFinding(
   override val dependentProject: McProject,
   override val dependentPath: StringProjectPath,
   override val buildFile: File,
-  override val ruleName: RuleName,
+  override val findingName: FindingName,
   val pluginId: String,
   val alternatePluginId: String = "",
   val kotlinPluginFunction: String = ""

modulecheck-core/src/main/kotlin/modulecheck/core/anvil/AnvilFactoryParser.kt

@@ -18,12 +18,12 @@ package modulecheck.core.anvil
 import kotlinx.coroutines.flow.filterIsInstance
 import modulecheck.api.context.jvmFilesForSourceSetName
 import modulecheck.api.context.references
+import modulecheck.finding.FindingName
 import modulecheck.parsing.gradle.SourceSetName
 import modulecheck.parsing.source.JavaFile
 import modulecheck.parsing.source.KotlinFile
 import modulecheck.parsing.source.asExplicitKotlinReference
 import modulecheck.project.McProject
-import modulecheck.rule.RuleName
 import modulecheck.utils.any
 import modulecheck.utils.containsAny
 import net.swiftzer.semver.SemVer
@@ -41,7 +41,7 @@ object AnvilFactoryParser {
   private val minimumAnvilVersion = SemVer(2, 0, 11)
 
   @Suppress("ComplexMethod")
-  suspend fun parse(ruleName: RuleName, project: McProject): List<CouldUseAnvilFinding> {
+  suspend fun parse(findingName: FindingName, project: McProject): List<CouldUseAnvilFinding> {
     val anvil = project.anvilGradlePlugin ?: return emptyList()
 
     if (anvil.generateDaggerFactories) return emptyList()
@@ -78,7 +78,7 @@ object AnvilFactoryParser {
 
     return listOf(
       CouldUseAnvilFinding(
-        ruleName = ruleName,
+        findingName = findingName,
         dependentProject = project,
         buildFile = project.buildFile
       )