Add ability to propose sbt version update

[exoego]

Closes #101.
Steward will propose update if they found sbt.version=X.Y.Z-SOMETHING.
It does not update SbtVersion that used for conditional build like below

sbtSeries.value match {
    case "0.13" => SbtVersion("0.13.17")
    case "1.0"  => defaultSbtVersion
    case _      => defaultSbtVersion
}

since such build requires cautious update.

I could not find how to perform system-test against actual repos...
How should I perform ?

[codecov]

Codecov Report

Merging #665 into master will increase coverage by 0.26%.
The diff coverage is 78.26%.

@@            Coverage Diff             @@
##           master     #665      +/-   ##
==========================================
+ Coverage   60.26%   60.52%   +0.26%     
==========================================
  Files          78       78              
  Lines        1042     1059      +17     
  Branches       21       20       -1     
==========================================
+ Hits          628      641      +13     
- Misses        414      418       +4

Impacted Files	Coverage Δ
.../main/scala/org/scalasteward/core/io/FileAlg.scala	88% <ø> (-0.47%)	⬇️
...ain/scala/org/scalasteward/core/edit/EditAlg.scala	92.85% <100%> (+1.19%)	⬆️
.../main/scala/org/scalasteward/core/io/package.scala	100% <100%> (ø)	⬆️
...la/org/scalasteward/core/sbt/data/SbtVersion.scala	100% <100%> (ø)	⬆️
.../main/scala/org/scalasteward/core/sbt/SbtAlg.scala	62.26% <70%> (+0.04%)	⬆️
...main/scala/org/scalasteward/core/sbt/package.scala	68.75% <71.42%> (+8.75%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e7d1971...94c1e18. Read the comment docs.

[fthomas]

Thanks @exoego for working on this. I think a few more things are needed for this feature:

1. isSourceFile needs to be updated to return true for project/build.properties files.
2. SbtAlg.getUpdatesForRepo needs to include Update.Single for sbt like you've used in the test (Update.Single("org.scala-sbt", "sbt", "1.2.7", Nel.of("1.2.8")). sbt-updates doesn't include updates for sbt, so we have to implement this ourself. In the first iteration of this feature I would propose to use sbt.defaultSbtVersion as latest for the 1.x series and add a new sbt.latestSbtVersion_0_13 for the 0.13.x series. The sbt version of a Repo can then be queried via sbt or by reading project/build.properties (which I'd prefer because it is faster.) With this information you can now create an Update.Single and include it in getUpdatesForRepo.

I'm not sure if we then need a new UpdateHeuristic. Maybe the heuristics we already have are good enough. And to test it I would run Scala Steward with a test repo.

[exoego]

Updated SbtAlg.getUpdatesForRepo and reverted UpdateHeuristic in 7676425

[fthomas]

I just tested your branch with one of my repos and it works: fthomas/properly#26
This is great!

I also pushed two minor fixes.

[fthomas]

I tried this on a few more repos:

• https://github.com/ChristopherDavenport/agitation/pull/29/files
• https://github.com/ChristopherDavenport/base.g8/pull/11/files
• https://github.com/ChristopherDavenport/scalaz-task-effect/pull/73/files

And they all look good.

The only one that also updated some unrelated version number was this:

• https://github.com/daandi/nice-url-encode-decode/pull/8/files

I'm not sure yet if we should restrict sbt updates to build.properties files.

[exoego]

It looks like UpdateHeuristic.original is used for sbt update.
Since UpdateHeuristic.strict requires groupId in the line, but build.properties dont' have groupId,
so UpdateHeuristicoriginal with a Regex like (?i)(.*)((sbt).*?)\Q1.2.8\E(.?) is used.
Such regex can matches addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.2.8") too.

I'm not sure yet if we should restrict sbt updates to build.properties files.

I think restriction is needed.
Where is a good place for such file restriction ?
It seems that FileAlg should not care about which UpdateHeuristic is used.
So I assume file restriction should be added to like Update classes like

// Update.Single
final case class Single(
      groupId: String,
      artifactId: String,
      currentVersion: String,
      newerVersions: Nel[String],
      configurations: Option[String] = None,
      fileReestrictions: Option[Regex]  = None
  ) extends Update {

// SbtAlg
Update.Single("org.scala-sbt", "sbt", currentVer, Nel.of(newVer),
    Some("build.properties".r))

// EditAlg
def applyUpdateTo[G[_]: Traverse](files: G[File], update: Update): F[Unit] = {
  val actions = UpdateHeuristic.all.map { heuristic =>
    logger.info(s"Trying heuristic '${heuristic.name}'") >>
       // RESTRICTION HERE 
      fileAlg.editFiles(files, heuristic.replaceF(update))
  }
  bindUntilTrue(actions).void
}

[fthomas]

The file restriction would be computed in EditAlg and then passed to FileAlg.findSourceFilesContaining instead of using the static isSourceFile.

This would restrict sbt updates to only edit project/build.properties files and nothing else. I'm trying to think of situations where the sbt version might be used somewhere else which we would then miss.

[exoego]

The file restriction would be computed in EditAlg and then passed to FileAlg.findSourceFilesContaining instead of using the static isSourceFile.

Added such dynamic Update-based file filter in 94c1e18

I'm trying to think of situations where the sbt version might be used somewhere else which we would then miss.

To use sbt version somewhere in build, I think users should use the sbt key sbtVersion instead of literal.
So I assume it is a trivial limitation if we apply sbt update only to build.properties in 1st iteration.

[fthomas]

LGTM! Thanks again, @exoego!

[kubukoz]

kubukoz/sup#84 it works, thanks for this update!