V4 🚀 (#549)

This PR contains all the changes planned for the v4 release.

It's basically a full rewrite, but see
`modules/docs/src/main/mdoc/docs/migration.md` for a summary of the
user-facing changes. Other changes not mentioned on that page include:
* rewriting the codebase using Scala 3 syntax, getting rid of package
objects, updating the syntactic sugar to use Scala 3 extension methods,
switching to Scala 3 enums, etc
* rewriting all the ScalaTest suites in MUnit

Once this is merged, I will tag a `v4.0.0-RC1`. If we don't get any
show-stopping feedback, I plan to release `v4.0.0` on Wednesday ~8th~
15th Jan.

---------

Co-authored-by: Cristian Cantarero Dávila <[email protected]>
Co-authored-by: Cristian Cantarero <[email protected]>
Co-authored-by: Alejandro <[email protected]>
Co-authored-by: alejandrobudy <[email protected]>

Author: 4 people

.github/workflows/ci.yml

@@ -14,6 +14,7 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
           cache: 'sbt'
+      - uses: sbt/setup-sbt@v1
       - name: Test
         run: sbt -J-Xms4G -J-Xmx4G +test
   bincompat:
@@ -25,6 +26,7 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
           cache: 'sbt'
+      - uses: sbt/setup-sbt@v1
       - name: Check binary compatibility
         run: sbt -J-Xms4G -J-Xmx4G +mimaReportBinaryIssues
   docs:
@@ -36,6 +38,7 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
           cache: 'sbt'
+      - uses: sbt/setup-sbt@v1
       - name: Compile documentation
         run: sbt -J-Xms4G -J-Xmx4G docs/mdoc
   format:
@@ -47,5 +50,6 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
           cache: 'sbt'
+      - uses: sbt/setup-sbt@v1
       - name: Check formatting
         run: sbt -J-Xms4G -J-Xmx4G scalafmtCheckAll scalafmtSbtCheck

.github/workflows/release.yml

@@ -15,6 +15,7 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
           cache: 'sbt'
+      - uses: sbt/setup-sbt@v1
       - name: Publish
         run: sbt +test ci-release
         env:
@@ -33,6 +34,7 @@ jobs:
           distribution: 'temurin'
           java-version: '17'
           cache: 'sbt'
+      - uses: sbt/setup-sbt@v1
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.6

.gitignore

@@ -5,4 +5,7 @@ target
 .idea
 *.ipr
 *.iws
-.bsp
+.bsp
+.metals
+project/metals.sbt
+project/project/

.scalafmt.conf

@@ -1,5 +1,14 @@
 version = 3.6.1
-runner.dialect = scala213
+runner.dialect = scala3
 
 align.preset = more
-maxColumn = 80
+maxColumn = 110
+
+rewrite {
+  scala3 {
+    convertToNewSyntax = true
+    removeOptionalBraces = true
+    insertEndMarkerMinLines = 30
+    removeEndMarkerMaxLines = 29
+  }
+}

build.sbt

@@ -1,15 +1,12 @@
 import sbtcrossproject.CrossPlugin.autoImport.crossProject
-import _root_.org.typelevel.sbt.tpolecat.TpolecatPlugin.autoImport._
 import _root_.org.typelevel.scalacoptions.ScalacOptions
 
-lazy val scalaVersion212 = "2.12.19"
-lazy val scalaVersion213 = "2.13.13"
-lazy val scalaVersion3   = "3.3.3"
-lazy val scalaVersions   = List(scalaVersion212, scalaVersion213, scalaVersion3)
+lazy val scalaVersion3 = "3.3.4"
+lazy val scalaVersions = List(scalaVersion3)
 
 inThisBuild(
   Seq(
-    scalaVersion := scalaVersion213,
+    scalaVersion := scalaVersion3,
     organization := "com.github.cb372",
     licenses := Seq(
       "Apache License, Version 2.0" -> url(
@@ -29,75 +26,53 @@ inThisBuild(
         name = "Luka Jacobowitz",
         email = "[email protected]",
         url = url("https://github.com/LukaJCB")
+      ),
+      Developer(
+        id = "AlejandroBudy",
+        name = "Alejandro Torres",
+        email = "[email protected]",
+        url = url("https://github.com/AlejandroBudy")
+      ),
+      Developer(
+        id = "ccantarero91",
+        name = "Cristian Cantarero Dávila",
+        email = "[email protected]",
+        url = url("https://github.com/ccantarero91")
       )
     ),
     mimaPreviousArtifacts := Set.empty,
-    scalafmtOnCompile     := true
+    scalafmtOnCompile     := false
   )
 )
 
-val catsVersion          = "2.10.0"
-val catsEffectVersion    = "3.5.4"
-val catsMtlVersion       = "1.4.0"
-val scalatestVersion     = "3.2.18"
-val scalaTestPlusVersion = "3.2.18.0"
-val scalacheckVersion    = "1.17.0"
-val disciplineVersion    = "2.2.0"
+val catsVersion             = "2.12.0"
+val catsEffectVersion       = "3.5.7"
+val catsMtlVersion          = "1.5.0"
+val munitVersion            = "1.0.0"
+val munitCatsEffectVersion  = "2.0.0"
+val disciplineVersion       = "2.0.0"
+val scalacheckEffectVersion = "1.0.4"
 
 val core = crossProject(JVMPlatform, JSPlatform)
   .in(file("modules/core"))
   .settings(
     name               := "cats-retry",
     crossScalaVersions := scalaVersions,
     libraryDependencies ++= Seq(
-      "org.typelevel"     %%% "cats-core"       % catsVersion,
-      "org.typelevel"     %%% "cats-effect"     % catsEffectVersion,
-      "org.scalatest"     %%% "scalatest"       % scalatestVersion     % Test,
-      "org.scalacheck"    %%% "scalacheck"      % scalacheckVersion    % Test,
-      "org.typelevel"     %%% "cats-laws"       % catsVersion          % Test,
-      "org.scalatestplus" %%% "scalacheck-1-17" % scalaTestPlusVersion % Test,
-      "org.typelevel" %%% "discipline-scalatest" % disciplineVersion % Test
-    ),
-    mimaPreviousArtifacts := Set(
-      "com.github.cb372" %%% "cats-retry" % "3.1.0"
+      "org.typelevel" %%% "cats-core"         % catsVersion,
+      "org.typelevel" %%% "cats-effect"       % catsEffectVersion,
+      "org.scalameta" %%% "munit-scalacheck"  % munitVersion            % Test,
+      "org.typelevel" %%% "munit-cats-effect" % munitCatsEffectVersion  % Test,
+      "org.typelevel" %%% "scalacheck-effect" % scalacheckEffectVersion % Test,
+      "org.typelevel" %%% "cats-laws"         % catsVersion             % Test,
+      "org.typelevel" %%% "discipline-munit"  % disciplineVersion       % Test
     ),
-    tpolecatExcludeOptions += ScalacOptions.lintPackageObjectClasses,
+    mimaPreviousArtifacts := Set.empty,
     Test / tpolecatExcludeOptions += ScalacOptions.warnNonUnitStatement
   )
-  .jsSettings(
-    // work around https://github.com/typelevel/sbt-tpolecat/issues/102
-    tpolecatScalacOptions +=
-      ScalacOptions.other("-scalajs", sv => sv.major == 3L)
-  )
 val coreJVM = core.jvm
 val coreJS  = core.js
 
-val alleycatsRetry = crossProject(JVMPlatform, JSPlatform)
-  .in(file("modules/alleycats"))
-  .jvmConfigure(_.dependsOn(coreJVM))
-  .jsConfigure(_.dependsOn(coreJS))
-  .settings(
-    name               := "alleycats-retry",
-    crossScalaVersions := scalaVersions,
-    libraryDependencies ++= Seq(
-      "org.scalatest"     %%% "scalatest"       % scalatestVersion     % Test,
-      "org.scalacheck"    %%% "scalacheck"      % scalacheckVersion    % Test,
-      "org.typelevel"     %%% "cats-laws"       % catsVersion          % Test,
-      "org.scalatestplus" %%% "scalacheck-1-17" % scalaTestPlusVersion % Test,
-      "org.typelevel" %%% "discipline-scalatest" % disciplineVersion % Test
-    ),
-    mimaPreviousArtifacts := Set(
-      "com.github.cb372" %%% "alleycats-retry" % "3.1.0"
-    ),
-    Test / tpolecatExcludeOptions += ScalacOptions.warnNonUnitStatement
-  )
-  .jsSettings(
-    tpolecatScalacOptions += ScalacOptions
-      .other("-scalajs", sv => sv.major == 3L)
-  )
-val alleycatsJVM = alleycatsRetry.jvm
-val alleycatsJS  = alleycatsRetry.js
-
 val mtlRetry = crossProject(JVMPlatform, JSPlatform)
   .in(file("modules/mtl"))
   .jvmConfigure(_.dependsOn(coreJVM))
@@ -106,30 +81,23 @@ val mtlRetry = crossProject(JVMPlatform, JSPlatform)
     name               := "cats-retry-mtl",
     crossScalaVersions := scalaVersions,
     libraryDependencies ++= Seq(
-      "org.typelevel" %%% "cats-mtl"  % catsMtlVersion,
-      "org.scalatest" %%% "scalatest" % scalatestVersion % Test
-    ),
-    mimaPreviousArtifacts := Set(
-      "com.github.cb372" %%% "cats-retry-mtl" % "3.1.0"
+      "org.typelevel" %%% "cats-mtl"          % catsMtlVersion,
+      "org.typelevel" %%% "munit-cats-effect" % munitCatsEffectVersion % Test,
+      "org.scalameta" %%% "munit-scalacheck"  % munitVersion           % Test
     ),
-    tpolecatExcludeOptions += ScalacOptions.lintPackageObjectClasses,
+    mimaPreviousArtifacts := Set.empty,
     Test / tpolecatExcludeOptions += ScalacOptions.warnNonUnitStatement
   )
-  .jsSettings(
-    // work around https://github.com/typelevel/sbt-tpolecat/issues/102
-    tpolecatScalacOptions +=
-      ScalacOptions.other("-scalajs", sv => sv.major == 3L)
-  )
 val mtlJVM = mtlRetry.jvm
 val mtlJS  = mtlRetry.js
 
 val docs = project
   .in(file("modules/docs"))
-  .dependsOn(coreJVM, alleycatsJVM, mtlJVM)
+  .dependsOn(coreJVM, mtlJVM)
   .enablePlugins(MicrositesPlugin, BuildInfoPlugin)
   .settings(
-    addCompilerPlugin(
-      "org.typelevel" %% "kind-projector" % "0.13.3" cross CrossVersion.full
+    libraryDependencies ++= Seq(
+      "software.amazon.awssdk" % "dynamodb" % "2.29.43"
     ),
     tpolecatExcludeOptions ++= ScalacOptions.warnUnusedOptions,
     tpolecatExcludeOptions += ScalacOptions.warnNonUnitStatement,
@@ -158,8 +126,6 @@ val root = project
   .aggregate(
     coreJVM,
     coreJS,
-    alleycatsJVM,
-    alleycatsJS,
     mtlJVM,
     mtlJS,
     docs

modules/alleycats/jvm/src/main/scala/retry/alleycats/instances.scala

@@ -1,24 +1,17 @@
 package retry
 
-object Fibonacci {
-  def fibonacci(n: Int): Long = {
-    if (n > 0)
-      fib(n)._1
-    else
-      0
-  }
+object Fibonacci:
+  def fibonacci(n: Int): Long =
+    if n > 0 then fib(n)._1
+    else 0
 
   // "Fast doubling" Fibonacci algorithm.
   // See e.g. http://funloop.org/post/2017-04-14-computing-fibonacci-numbers.html for explanation.
-  private def fib(n: Int): (Long, Long) = n match {
+  private def fib(n: Int): (Long, Long) = n match
     case 0 => (0, 1)
     case m =>
       val (a, b) = fib(m / 2)
       val c      = a * (b * 2 - a)
       val d      = a * a + b * b
-      if (n % 2 == 0)
-        (c, d)
-      else
-        (d, c + d)
-  }
-}
+      if n % 2 == 0 then (c, d)
+      else (d, c + d)