Replacement Heuristic (#132)

* Change replacement heuristic

* Expanded heuristic testes

* Fixes after lint

* Fixes after buildifier github action failed

* Fixes after buildifier github action failed

* Fixes after review

* Changes after lint

* Added test cases for same version of two libraries

Author: mikkoziel

bazel/src/main/kotlin/org/virtuslab/bazelsteward/bazel/BazelVersionFileSearch.kt

@@ -10,6 +10,6 @@ class BazelVersionFileSearch(config: Config) {
   private val fileNames = setOf(".bazelversion", ".bazeliskrc")
 
   val bazelVersionFiles: List<BazelFileSearch.BazelFile> by lazy {
-    config.path.listDirectoryEntries().filter { fileNames.contains(it.name) }.map { BazelFileSearch.BazelFile(it) }
+    config.path.listDirectoryEntries().filter { fileNames.contains(it.name) }.map { BazelFileSearch.createBazelFile(it) }
   }
 }

core/src/main/kotlin/org/virtuslab/bazelsteward/core/common/BazelFileSearch.kt

@@ -5,8 +5,13 @@ import java.nio.file.Path
 import kotlin.io.path.readText
 
 class BazelFileSearch(config: Config) {
-  data class BazelFile(val path: Path) {
+  interface BazelFile {
+    val path: Path
     val content: String
+  }
+
+  private data class LazyBazelFile(override val path: Path) : BazelFile {
+    override val content: String
       get() = path.readText()
   }
 
@@ -22,5 +27,9 @@ class BazelFileSearch(config: Config) {
       .toList()
   }
 
-  val buildDefinitions: List<BazelFile> by lazy { buildPaths.map { BazelFile(it) } }
+  val buildDefinitions: List<BazelFile> by lazy { buildPaths.map { createBazelFile(it) } }
+
+  companion object {
+    fun createBazelFile(path: Path): BazelFile = LazyBazelFile(path)
+  }
 }

core/src/main/kotlin/org/virtuslab/bazelsteward/core/common/FileUpdateSearch.kt

@@ -4,6 +4,8 @@ import org.virtuslab.bazelsteward.core.GitBranch
 import org.virtuslab.bazelsteward.core.library.Library
 import org.virtuslab.bazelsteward.core.library.LibraryId
 import org.virtuslab.bazelsteward.core.library.Version
+import org.virtuslab.bazelsteward.core.replacement.VersionOnlyHeuristic
+import org.virtuslab.bazelsteward.core.replacement.WholeLibraryHeuristic
 import java.nio.file.Path
 
 class FileUpdateSearch {
@@ -26,15 +28,14 @@ class FileUpdateSearch {
     files: List<BazelFileSearch.BazelFile>,
     updateSuggestion: UpdateLogic.UpdateSuggestion<Lib>
   ): FileChangeSuggestion? {
-    val markers = updateSuggestion.currentLibrary.id.associatedStrings()
-    val currentVersion = updateSuggestion.currentLibrary.version.value
-    val regex =
-      (markers + currentVersion).map { """(${Regex.escape(it)})""" }.reduce { acc, s -> "$acc.*$s" }.let { Regex(it) }
-    val matchResult = files.firstNotNullOfOrNull { regex.find(it.content)?.to(it.path) } ?: return null
-    val versionGroup = matchResult.first.groups[3] ?: return null
-    return FileChangeSuggestion(
-      updateSuggestion.currentLibrary, updateSuggestion.suggestedVersion, matchResult.second, versionGroup.range.first
+    val allHeuristics = listOf(
+      WholeLibraryHeuristic(),
+      VersionOnlyHeuristic(),
     )
+    for (heuristic in allHeuristics) {
+      heuristic.apply(files, updateSuggestion)?.let { return it }
+    }
+    return null
   }
 
   fun <Lib : LibraryId> searchBazelVersionFiles(

core/src/main/kotlin/org/virtuslab/bazelsteward/core/replacement/Heuristic.kt

@@ -0,0 +1,14 @@
+package org.virtuslab.bazelsteward.core.replacement
+
+import org.virtuslab.bazelsteward.core.common.BazelFileSearch
+import org.virtuslab.bazelsteward.core.common.FileUpdateSearch
+import org.virtuslab.bazelsteward.core.common.UpdateLogic
+import org.virtuslab.bazelsteward.core.library.LibraryId
+
+interface Heuristic {
+  val name: String
+  fun <Lib : LibraryId> apply(
+    files: List<BazelFileSearch.BazelFile>,
+    updateSuggestion: UpdateLogic.UpdateSuggestion<Lib>
+  ): FileUpdateSearch.FileChangeSuggestion?
+}

core/src/main/kotlin/org/virtuslab/bazelsteward/core/replacement/VersionOnlyHeuristic.kt

@@ -0,0 +1,24 @@
+package org.virtuslab.bazelsteward.core.replacement
+
+import org.virtuslab.bazelsteward.core.common.BazelFileSearch
+import org.virtuslab.bazelsteward.core.common.FileUpdateSearch
+import org.virtuslab.bazelsteward.core.common.UpdateLogic
+import org.virtuslab.bazelsteward.core.library.LibraryId
+
+class VersionOnlyHeuristic : Heuristic {
+  override val name: String = "version-only"
+
+  override fun <Lib : LibraryId> apply(
+    files: List<BazelFileSearch.BazelFile>,
+    updateSuggestion: UpdateLogic.UpdateSuggestion<Lib>
+  ): FileUpdateSearch.FileChangeSuggestion? {
+    val currentVersion = updateSuggestion.currentLibrary.version.value
+    val regex = Regex(Regex.escape(currentVersion))
+    val matchResult = files.firstNotNullOfOrNull { regex.find(it.content)?.to(it.path) } ?: return null
+    matchResult.first.next()?.let { return null }
+    val versionGroup = matchResult.first.groups[0] ?: return null
+    return FileUpdateSearch.FileChangeSuggestion(
+      updateSuggestion.currentLibrary, updateSuggestion.suggestedVersion, matchResult.second, versionGroup.range.first
+    )
+  }
+}

core/src/main/kotlin/org/virtuslab/bazelsteward/core/replacement/WholeLibraryHeuristic.kt

@@ -0,0 +1,25 @@
+package org.virtuslab.bazelsteward.core.replacement
+
+import org.virtuslab.bazelsteward.core.common.BazelFileSearch
+import org.virtuslab.bazelsteward.core.common.FileUpdateSearch
+import org.virtuslab.bazelsteward.core.common.UpdateLogic
+import org.virtuslab.bazelsteward.core.library.LibraryId
+
+class WholeLibraryHeuristic : Heuristic {
+  override val name: String = "whole-library"
+
+  override fun <Lib : LibraryId> apply(
+    files: List<BazelFileSearch.BazelFile>,
+    updateSuggestion: UpdateLogic.UpdateSuggestion<Lib>
+  ): FileUpdateSearch.FileChangeSuggestion? {
+    val markers = updateSuggestion.currentLibrary.id.associatedStrings()
+    val currentVersion = updateSuggestion.currentLibrary.version.value
+    val regex =
+      (markers + currentVersion).map { """(${Regex.escape(it)})""" }.reduce { acc, s -> "$acc.*$s" }.let { Regex(it) }
+    val matchResult = files.firstNotNullOfOrNull { regex.find(it.content)?.to(it.path) } ?: return null
+    val versionGroup = matchResult.first.groups[3] ?: return null
+    return FileUpdateSearch.FileChangeSuggestion(
+      updateSuggestion.currentLibrary, updateSuggestion.suggestedVersion, matchResult.second, versionGroup.range.first
+    )
+  }
+}