Merge pull request #561 from hughsimpson/scala_3

Author: kubukoz

.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        scala: [2.13.6, 2.12.14]
+        scala: [2.13.6, 2.12.14, 3.0.1]
         java: [[email protected]]
     runs-on: ${{ matrix.os }}
     steps:
@@ -133,6 +133,16 @@ jobs:
           tar xf targets.tar
           rm targets.tar
 
+      - name: Download target directories (3.0.1)
+        uses: actions/download-artifact@v2
+        with:
+          name: target-${{ matrix.os }}-3.0.1-${{ matrix.java }}
+
+      - name: Inflate target directories (3.0.1)
+        run: |
+          tar xf targets.tar
+          rm targets.tar
+
       - uses: olafurpg/setup-gpg@v3
 
       - run: sbt ++${{ matrix.scala }} ci-release

.scalafmt.conf

@@ -1,3 +1,8 @@
-align = more
+align.preset = "more"
 maxColumn = 120
-version = 2.3.2
+version = "3.0.2"
+fileOverride {
+  "glob:**/src/main/scala-3/**" {
+    runner.dialect = scala3
+  }
+}

build.sbt

@@ -1,8 +1,8 @@
 inThisBuild(
   List(
     organization := "com.github.cb372",
-    homepage := Some(url("https://github.com/cb372/scalacache")),
-    licenses := List("Apache-2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")),
+    homepage     := Some(url("https://github.com/cb372/scalacache")),
+    licenses     := List("Apache-2.0" -> url("http://www.apache.org/licenses/LICENSE-2.0")),
     developers := List(
       Developer(
         "cb372",
@@ -14,6 +14,8 @@ inThisBuild(
   )
 )
 
+val CatsEffectVersion = "3.2.7"
+
 scalafmtOnCompile in ThisBuild := true
 
 lazy val root: Project = Project(id = "scalacache", base = file("."))
@@ -36,13 +38,13 @@ lazy val core =
     .settings(
       moduleName := "scalacache-core",
       libraryDependencies ++= Seq(
-        "org.scala-lang" % "scala-reflect" % scalaVersion.value,
-        "org.slf4j"      % "slf4j-api"     % "1.7.30",
-        "org.typelevel"  %% "cats-effect"  % "3.0.2",
+        "org.slf4j"      % "slf4j-api"   % "1.7.30",
+        "org.typelevel" %% "cats-effect" % CatsEffectVersion,
         scalatest,
         scalacheck
-      ),
-      coverageMinimum := 60,
+      ) ++ (if (scalaVersion.value.startsWith("2.")) Seq("org.scala-lang" % "scala-reflect" % scalaVersion.value)
+            else Nil),
+      coverageMinimum       := 60,
       coverageFailOnMinimum := true
     )
 
@@ -67,31 +69,31 @@ lazy val redis = createModule("redis")
     libraryDependencies ++= Seq(
       "redis.clients" % "jedis" % "2.10.2"
     ),
-    coverageMinimum := 56,
+    coverageMinimum       := 56,
     coverageFailOnMinimum := true
   )
 
 lazy val caffeine = createModule("caffeine")
   .settings(
     libraryDependencies ++= Seq(
-      "com.github.ben-manes.caffeine" % "caffeine"             % "2.9.0",
-      "org.typelevel"                 %% "cats-effect-testkit" % "3.0.2" % Test,
-      "com.google.code.findbugs"      % "jsr305"               % "3.0.2" % Provided
+      "com.github.ben-manes.caffeine" % "caffeine"            % "2.9.0",
+      "org.typelevel"                %% "cats-effect-testkit" % CatsEffectVersion % Test,
+      "com.google.code.findbugs"      % "jsr305"              % "3.0.2"           % Provided
     ),
-    coverageMinimum := 80,
+    coverageMinimum       := 80,
     coverageFailOnMinimum := true
   )
 
 lazy val circe = createModule("circe")
   .settings(
     libraryDependencies ++= Seq(
-      "io.circe" %% "circe-core"    % "0.13.0",
-      "io.circe" %% "circe-parser"  % "0.13.0",
-      "io.circe" %% "circe-generic" % "0.13.0" % Test,
+      "io.circe" %% "circe-core"    % "0.14.1",
+      "io.circe" %% "circe-parser"  % "0.14.1",
+      "io.circe" %% "circe-generic" % "0.14.1" % Test,
       scalacheck,
       scalatestplus
     ),
-    coverageMinimum := 80,
+    coverageMinimum       := 80,
     coverageFailOnMinimum := true
   )
 
@@ -102,19 +104,19 @@ lazy val tests = createModule("tests")
 lazy val docs = createModule("docs")
   .enablePlugins(MicrositesPlugin)
   .settings(
-    publishArtifact := false,
-    micrositeName := "ScalaCache",
-    micrositeAuthor := "Chris Birchall",
+    publishArtifact      := false,
+    micrositeName        := "ScalaCache",
+    micrositeAuthor      := "Chris Birchall",
     micrositeDescription := "A facade for the most popular cache implementations, with a simple, idiomatic Scala API.",
-    micrositeBaseUrl := "/scalacache",
+    micrositeBaseUrl     := "/scalacache",
     micrositeDocumentationUrl := "/scalacache/docs",
-    micrositeHomepage := "https://github.com/cb372/scalacache",
-    micrositeGithubOwner := "cb372",
-    micrositeGithubRepo := "scalacache",
-    micrositeGitterChannel := true,
-    micrositeTwitterCreator := "@cbirchall",
-    micrositeShareOnSocial := true,
-    mdocIn := (sourceDirectory in Compile).value / "mdoc"
+    micrositeHomepage         := "https://github.com/cb372/scalacache",
+    micrositeGithubOwner      := "cb372",
+    micrositeGithubRepo       := "scalacache",
+    micrositeGitterChannel    := true,
+    micrositeTwitterCreator   := "@cbirchall",
+    micrositeShareOnSocial    := true,
+    mdocIn                    := (sourceDirectory in Compile).value / "mdoc"
   )
   .dependsOn(
     core,
@@ -127,7 +129,7 @@ lazy val docs = createModule("docs")
 lazy val benchmarks = createModule("benchmarks")
   .enablePlugins(JmhPlugin)
   .settings(
-    publishArtifact := false,
+    publishArtifact        := false,
     fork in (Compile, run) := true,
     javaOptions in Jmh ++= Seq("-server", "-Xms2G", "-Xmx2G", "-XX:+UseG1GC", "-XX:-UseBiasedLocking"),
     javaOptions in (Test, run) ++= Seq(
@@ -143,11 +145,11 @@ lazy val benchmarks = createModule("benchmarks")
   )
   .dependsOn(caffeine)
 
-lazy val scalatest = "org.scalatest" %% "scalatest" % "3.2.8" % Test
+lazy val scalatest = "org.scalatest" %% "scalatest" % "3.2.9" % Test
 
 lazy val scalacheck = "org.scalacheck" %% "scalacheck" % "1.15.3" % Test
 
-lazy val scalatestplus = "org.scalatestplus" %% "scalacheck-1-15" % "3.2.5.0" % Test
+lazy val scalatestplus = "org.scalatestplus" %% "scalacheck-1-15" % "3.2.9.0" % Test
 
 lazy val commonSettings =
   mavenSettings ++
@@ -164,12 +166,13 @@ lazy val mavenSettings = Seq(
   }
 )
 
+val Scala30  = "3.0.1"
 val Scala213 = "2.13.6"
 val Scala212 = "2.12.14"
-val Jdk11 = "[email protected]"
+val Jdk11    = "[email protected]"
 
-ThisBuild / scalaVersion := Scala213
-ThisBuild / crossScalaVersions := Seq(Scala213, Scala212)
+ThisBuild / scalaVersion               := Scala213
+ThisBuild / crossScalaVersions         := Seq(Scala213, Scala212, Scala30)
 ThisBuild / githubWorkflowJavaVersions := Seq(Jdk11)
 ThisBuild / githubWorkflowBuild := Seq(
   WorkflowStep.Sbt(List("scalafmtCheckAll"), name = Some("Check Formatting")),
@@ -181,8 +184,9 @@ ThisBuild / githubWorkflowBuild := Seq(
 //sbt-ci-release settings
 ThisBuild / githubWorkflowTargetTags ++= Seq("v*")
 ThisBuild / githubWorkflowPublishTargetBranches := Seq(RefPredicate.StartsWith(Ref.Tag("v")))
-ThisBuild / githubWorkflowPublishPreamble := Seq(WorkflowStep.Use(UseRef.Public("olafurpg", "setup-gpg", "v3")))
-ThisBuild / githubWorkflowPublish := Seq(WorkflowStep.Sbt(List("ci-release")))
-ThisBuild / githubWorkflowEnv ++= List("PGP_PASSPHRASE", "PGP_SECRET", "SONATYPE_PASSWORD", "SONATYPE_USERNAME").map { envKey =>
-  envKey -> s"$${{ secrets.$envKey }}"
+ThisBuild / githubWorkflowPublishPreamble       := Seq(WorkflowStep.Use(UseRef.Public("olafurpg", "setup-gpg", "v3")))
+ThisBuild / githubWorkflowPublish               := Seq(WorkflowStep.Sbt(List("ci-release")))
+ThisBuild / githubWorkflowEnv ++= List("PGP_PASSPHRASE", "PGP_SECRET", "SONATYPE_PASSWORD", "SONATYPE_USERNAME").map {
+  envKey =>
+    envKey -> s"$${{ secrets.$envKey }}"
 }.toMap

modules/benchmarks/src/main/scala/scalacache/benchmark/CaffeineBenchmark.scala

@@ -15,7 +15,7 @@ import cats.effect.Clock
 @State(Scope.Thread)
 class CaffeineBenchmark {
 
-  implicit val clockSyncIO = Clock[SyncIO]
+  implicit val clockSyncIO: Clock[SyncIO] = Clock[SyncIO]
 
   val underlyingCache                       = Caffeine.newBuilder().build[String, Entry[String]]()
   implicit val cache: Cache[SyncIO, String] = CaffeineCache[SyncIO, String](underlyingCache)

modules/benchmarks/src/test/scala/scalacache/benchmark/ProfilingMemoize.scala

@@ -8,8 +8,7 @@ import scalacache.memoization._
 import cats.effect.SyncIO
 import cats.effect.Clock
 
-/**
-  * Just runs forever, endlessly calling memoize, so Java Flight Recorder can output sampling data.
+/** Just runs forever, endlessly calling memoize, so Java Flight Recorder can output sampling data.
   */
 object ProfilingMemoize extends App {
 

modules/caffeine/src/main/scala/scalacache/caffeine/CaffeineCache.scala

@@ -19,8 +19,8 @@ import cats.MonadError
  *
  * This cache implementation is synchronous.
  */
-class CaffeineCache[F[_]: Sync, V](val underlying: CCache[String, Entry[V]])(
-    implicit val config: CacheConfig,
+class CaffeineCache[F[_]: Sync, V](val underlying: CCache[String, Entry[V]])(implicit
+    val config: CacheConfig,
     clock: Clock[F]
 ) extends AbstractCache[F, V] {
   protected val F: Sync[F] = Sync[F]
@@ -29,9 +29,8 @@ class CaffeineCache[F[_]: Sync, V](val underlying: CCache[String, Entry[V]])(
 
   def doGet(key: String): F[Option[V]] = {
     F.delay {
-        Option(underlying.getIfPresent(key))
-      }
-      .flatMap(_.filterA(Entry.isExpired[F, V]))
+      Option(underlying.getIfPresent(key))
+    }.flatMap(_.filterA(Entry.isExpired[F, V]))
       .map(_.map(_.value))
       .flatTap { result =>
         logCacheHitOrMiss(key, result)
@@ -49,7 +48,7 @@ class CaffeineCache[F[_]: Sync, V](val underlying: CCache[String, Entry[V]])(
   override def doRemove(key: String): F[Unit] =
     F.delay(underlying.invalidate(key))
 
-  override def doRemoveAll(): F[Unit] =
+  override def doRemoveAll: F[Unit] =
     F.delay(underlying.invalidateAll())
 
   override def close: F[Unit] = {
@@ -64,16 +63,15 @@ class CaffeineCache[F[_]: Sync, V](val underlying: CCache[String, Entry[V]])(
 
 object CaffeineCache {
 
-  /**
-    * Create a new Caffeine cache.
+  /** Create a new Caffeine cache.
     */
   def apply[F[_]: Sync: Clock, V](implicit config: CacheConfig): F[CaffeineCache[F, V]] =
     Sync[F].delay(Caffeine.newBuilder().build[String, Entry[V]]()).map(apply(_))
 
-  /**
-    * Create a new cache utilizing the given underlying Caffeine cache.
+  /** Create a new cache utilizing the given underlying Caffeine cache.
     *
-    * @param underlying a Caffeine cache
+    * @param underlying
+    *   a Caffeine cache
     */
   def apply[F[_]: Sync: Clock, V](
       underlying: CCache[String, Entry[V]]

modules/circe/src/test/scala/scalacache/serialization/CirceCodecSpec.scala

@@ -16,7 +16,7 @@ class CirceCodecSpec extends AnyFlatSpec with Matchers with ScalaCheckDrivenProp
   import scalacache.serialization.circe._
 
   private def serdesCheck[A: Arbitrary](expectedJson: A => String)(implicit codec: Codec[A]): Unit = {
-    forAll(minSuccessful(10000)) { a: A =>
+    forAll(minSuccessful(10000)) { (a: A) =>
       val serialised = codec.encode(a)
       new String(serialised, "utf-8") shouldBe expectedJson(a)
       val deserialised = codec.decode(serialised)

modules/core/src/main/scala/scalacache/memoization/Macros.scala modules/core/src/main/scala-2/scalacache/memoization/Macros.scala

@@ -12,17 +12,23 @@ class Macros(val c: blackbox.Context) {
   def memoizeImpl[F[_], V: c.WeakTypeTag](
       ttl: c.Expr[Option[Duration]]
   )(f: c.Tree)(cache: c.Expr[Cache[F, V]], flags: c.Expr[Flags]): c.Tree = {
-    commonMacroImpl(cache, { keyName =>
-      q"""$cache.cachingForMemoize($keyName)($ttl)($f)($flags)"""
-    })
+    commonMacroImpl(
+      cache,
+      { keyName =>
+        q"""$cache.cachingForMemoize($keyName)($ttl)($f)($flags)"""
+      }
+    )
   }
 
   def memoizeFImpl[F[_], V: c.WeakTypeTag](
       ttl: c.Expr[Option[Duration]]
   )(f: c.Tree)(cache: c.Expr[Cache[F, V]], flags: c.Expr[Flags]): c.Tree = {
-    commonMacroImpl(cache, { keyName =>
-      q"""$cache.cachingForMemoizeF($keyName)($ttl)($f)($flags)"""
-    })
+    commonMacroImpl(
+      cache,
+      { keyName =>
+        q"""$cache.cachingForMemoizeF($keyName)($ttl)($f)($flags)"""
+      }
+    )
   }
 
   private def commonMacroImpl[F[_], V: c.WeakTypeTag](
@@ -45,7 +51,7 @@ class Macros(val c: blackbox.Context) {
 
     val keyName     = createKeyName()
     val cachingCall = keyNameToCachingCall(keyName)
-    val tree        = q"""
+    val tree = q"""
           val $keyName = $cache.config.memoization.toStringConverter.toString($classNameTree, $classParamssTree, $methodNameTree, $methodParamssTree)
           $cachingCall
         """
@@ -54,9 +60,7 @@ class Macros(val c: blackbox.Context) {
     tree
   }
 
-  /**
-    * Get the symbol of the method that encloses the macro,
-    * or abort the compilation if we can't find one.
+  /** Get the symbol of the method that encloses the macro, or abort the compilation if we can't find one.
     */
   private def getMethodSymbol(): c.Symbol = {
 
@@ -76,8 +80,7 @@ class Macros(val c: blackbox.Context) {
     getMethodSymbolRecursively(c.internal.enclosingOwner)
   }
 
-  /**
-    * Convert the given method symbol to a tree representing the method name.
+  /** Convert the given method symbol to a tree representing the method name.
     */
   private def getMethodName(methodSymbol: c.Symbol): c.Tree = {
     val methodName = methodSymbol.asMethod.name.toString
@@ -98,10 +101,10 @@ class Macros(val c: blackbox.Context) {
     getClassSymbolRecursively(c.internal.enclosingOwner)
   }
 
-  /**
-    * Convert the given class symbol to a tree representing the fully qualified class name.
+  /** Convert the given class symbol to a tree representing the fully qualified class name.
     *
-    * @param classSymbol should be either a ClassSymbol or a ModuleSymbol
+    * @param classSymbol
+    *   should be either a ClassSymbol or a ModuleSymbol
     */
   private def getFullClassName(classSymbol: c.Symbol): c.Tree = {
     val className = classSymbol.fullName
@@ -135,8 +138,7 @@ class Macros(val c: blackbox.Context) {
     listToTree(identss.map(is => listToTree(is)))
   }
 
-  /**
-    * Convert a List[Tree] to a Tree representing `Vector`
+  /** Convert a List[Tree] to a Tree representing `Vector`
     */
   private def listToTree(ts: List[c.Tree]): c.Tree = {
     q"_root_.scala.collection.immutable.Vector(..$ts)"