Merge remote-tracking branch 'tapir/master' into http4s-migrate-to-ember

Author: ivan-klass

.git-blame-ignore-revs

@@ -51,3 +51,9 @@ e003ec3b61e3bd582ae6a5200177fa6433099c09
 
 # Scala Steward: Reformat with scalafmt 3.8.3
 d743a8c6f793a5b30c8f14cfd57a367a4ffee4cd
+
+# Scala Steward: Reformat with scalafmt 3.8.4
+ee33c92f9d42ab5eda8377d409ea32e461dc169d
+
+# Scala Steward: Reformat with scalafmt 3.8.5
+4f7c0592e6d487bce3fa60ffabe366517667912c

.github/workflows/ci.yml

@@ -112,7 +112,7 @@ jobs:
         name: 'tests-results-${{ matrix.scala-version }}-${{ matrix.target-platform }}-${{ matrix.java }}'
         path: '**/test-reports/TEST*.xml'
     - name: Prepare release notes
-      uses: release-drafter/release-drafter@v5
+      uses: release-drafter/release-drafter@v6
       with:
         config-name: release-drafter.yml
       env:
@@ -189,7 +189,7 @@ jobs:
           COMMIT_MSG: ${{ github.event.head_commit.message }}
       - name: Publish release notes
         if: matrix.java == '11'
-        uses: release-drafter/release-drafter@v5
+        uses: release-drafter/release-drafter@v6
         with:
           config-name: release-drafter.yml
           publish: true
@@ -200,7 +200,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
 
-  # `automerge` label is attached iff there is exactly one file changed by steward and this file belongs to a
+  # `automerge` label is attached if there is exactly one file changed by steward and this file belongs to a
   # whitelist specified by `labeler.yml`
   label:
     name: Attach automerge label
@@ -216,16 +216,31 @@ jobs:
         env:
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
 
-  auto-merge:
-    name: Auto merge
-    # only for PRs by softwaremill-ci and dependabot
-    if: github.event.pull_request.user.login == 'softwaremill-ci' ||
-        github.event.pull_request.user.login == 'dependabot[bot]'
+  auto-merge-softwaremill-ci:
+    name: Auto merge softwaremill-ci
+    # only for PRs by softwaremill-ci
+    if: github.event.pull_request.user.login == 'softwaremill-ci'
     needs: [ ci, mima, label ]
     runs-on: ubuntu-24.04
     steps:
-      - id: automerge
-        name: automerge
+      - id: automerge-softwaremill-ci
+        name: automerge-softwaremill-ci
+        uses: "pascalgn/[email protected]"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+          MERGE_METHOD: "squash"
+
+  # separate `automerge` job for dependabot as it doesn't need label job
+  # labeling is done by dependabot itself
+  auto-merge-dependabot:
+    name: Auto merge dependabot
+    # only for PRs by dependabot
+    if: github.event.pull_request.user.login == 'dependabot[bot]'
+    needs: [ ci, mima ]
+    runs-on: ubuntu-24.04
+    steps:
+      - id: automerge-dependabot
+        name: automerge-dependabot
         uses: "pascalgn/[email protected]"
         env:
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.scalafmt.conf

@@ -1,11 +1,20 @@
-version = 3.8.3
+version = 3.8.5
 maxColumn = 140
-runner.dialect = scala3
+runner.dialect = scala213
 fileOverride {
-  "glob:**/scala-2/**" {
-    runner.dialect = scala213
+  "glob:**/scala-3/**" {
+    runner.dialect = scala3
   }
-  "glob:**/enumeratum/**" {
-      runner.dialect = scala213
-    }
+  "glob:**/examples/**" {
+    runner.dialect = scala3
+  }
+  "glob:**/integrations/iron/**" {
+    runner.dialect = scala3
+  }
+  "glob:**/json/pickler/**" {
+    runner.dialect = scala3
+  }
+  "glob:**/server/netty-server/sync/**" {
+    runner.dialect = scala3
+  }  
 }

README.md

@@ -139,7 +139,7 @@ val booksListingRequest: Request[DecodeResult[Either[String, List[Book]]], Any]
 Add the following dependency:
 
 ```sbt
-"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.11.12"
+"com.softwaremill.sttp.tapir" %% "tapir-core" % "1.11.13"
 ```
 
 Then, import:

build.sbt

@@ -15,7 +15,7 @@ import scala.concurrent.duration.DurationInt
 import scala.sys.process.Process
 
 val scala2_12 = "2.12.20"
-val scala2_13 = "2.13.15"
+val scala2_13 = "2.13.16"
 val scala3 = "3.3.4"
 
 val scala2Versions = List(scala2_12, scala2_13)
@@ -425,7 +425,7 @@ lazy val core: ProjectMatrix = (projectMatrix in file("core"))
     libraryDependencies ++= {
       CrossVersion.partialVersion(scalaVersion.value) match {
         case Some((3, _)) =>
-          Seq("com.softwaremill.magnolia1_3" %%% "magnolia" % "1.3.8")
+          Seq("com.softwaremill.magnolia1_3" %%% "magnolia" % "1.3.9")
         case _ =>
           Seq(
             "com.softwaremill.magnolia1_2" %%% "magnolia" % "1.1.10",
@@ -2065,6 +2065,7 @@ lazy val examples: ProjectMatrix = (projectMatrix in file("examples"))
     libraryDependencies ++= Seq(
       "com.softwaremill.sttp.apispec" %% "asyncapi-circe-yaml" % Versions.sttpApispec,
       "com.softwaremill.sttp.client3" %% "core" % Versions.sttp,
+      "com.softwaremill.sttp.client3" %% "circe" % Versions.sttp,
       "com.softwaremill.sttp.client3" %% "pekko-http-backend" % Versions.sttp,
       "com.softwaremill.sttp.client3" %% "async-http-client-backend-fs2" % Versions.sttp,
       "com.softwaremill.sttp.client3" %% "async-http-client-backend-zio" % Versions.sttp,

core/src/main/scala-2/sttp/tapir/macros/CodecMacros.scala

@@ -7,7 +7,7 @@ import sttp.tapir.Codec
 trait CodecMacros {
 
   /** Creates a codec for an enumeration, where the validator is derived using [[sttp.tapir.Validator.derivedEnumeration]]. This requires
-    * that all subtypes of the sealed hierarchy `T` must be `object`s.
+    * that all subtypes of the sealed hierarchy `T` must be `object` s.
     *
     * This method cannot be implicit, as there's no way to constraint the type `T` to be a sealed trait / class enumeration, so that this
     * would be invoked only when necessary.

core/src/main/scala-2/sttp/tapir/macros/SchemaMacros.scala

@@ -11,7 +11,7 @@ trait SchemaMacros[T] {
   /** Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with `path`, using the given
     * `modification` function. To traverse collections, use `.each`.
     *
-    * Should only be used if the schema hasn't been created by `.map`ping another one. In such a case, the shape of the schema doesn't
+    * Should only be used if the schema hasn't been created by `.map` ping another one. In such a case, the shape of the schema doesn't
     * correspond to the type `T`, but to some lower-level representation of the type.
     *
     * If the shape of the schema doesn't correspond to the path, the schema remains unchanged.
@@ -60,7 +60,7 @@ trait SchemaCompanionMacros extends SchemaMagnoliaDerivation {
   def derived[T]: Schema[T] = macro Magnolia.gen[T]
 
   /** Creates a schema for an enumeration, where the validator is derived using [[sttp.tapir.Validator.derivedEnumeration]]. This requires
-    * that all subtypes of the sealed hierarchy `T` must be `object`s.
+    * that all subtypes of the sealed hierarchy `T` must be `object` s.
     *
     * This method cannot be implicit, as there's no way to constraint the type `T` to be a sealed trait / class enumeration, so that this
     * would be invoked only when necessary.

core/src/main/scala-2/sttp/tapir/macros/ValidatorMacros.scala

@@ -5,7 +5,7 @@ import sttp.tapir.internal.ValidatorEnumerationMacro
 
 trait ValidatorMacros {
 
-  /** Creates an enum validator where all subtypes of the sealed hierarchy `T` are `object`s. This enumeration will only be used for
+  /** Creates an enum validator where all subtypes of the sealed hierarchy `T` are `object` s. This enumeration will only be used for
     * documentation, as a value outside of the allowed values will not be decoded in the first place (the decoder has no other option than
     * to fail).
     */

core/src/main/scala-3-2.13+/sttp/tapir/CodecExtensions2.scala

@@ -4,10 +4,10 @@ import sttp.tapir.model.Delimited
 
 trait CodecExtensions2 {
 
-  /** Creates a codec which handles values delimited using `D`. The implicit `T`-codec is used for handling each individual value.
+  /** Creates a codec which handles values delimited using `D`. The implicit `T` -codec is used for handling each individual value.
     *
-    * Upon decoding, the string is split using the delimiter, and then decoded using the `T`-codec. Upon encoding, the values are first
-    * encoded using the `T`-codec, and then combined using the delimiter.
+    * Upon decoding, the string is split using the delimiter, and then decoded using the `T` -codec. Upon encoding, the values are first
+    * encoded using the `T` -codec, and then combined using the delimiter.
     *
     * The codec's schema has the `explode` attribute set to `false`.
     */

core/src/main/scala-3/sttp/tapir/macros/CodecMacros.scala

@@ -7,7 +7,7 @@ import sttp.tapir.internal.CodecValueClassMacro
 trait CodecMacros:
 
   /** Creates a codec for an enumeration, where the validator is derived using [[sttp.tapir.Validator.derivedEnumeration]]. This requires
-    * that all subtypes of the sealed hierarchy `T` must be `object`s.
+    * that all subtypes of the sealed hierarchy `T` must be `object` s.
     *
     * This method cannot be implicit, as there's no way to constraint the type `T` to be a sealed trait / class enumeration, so that this
     * would be invoked only when necessary.

core/src/main/scala-3/sttp/tapir/macros/SchemaMacros.scala

@@ -12,7 +12,7 @@ trait SchemaMacros[T] { this: Schema[T] =>
   /** Modifies nested schemas for case classes and case class families (sealed traits / enums), accessible with `path`, using the given
     * `modification` function. To traverse collections, use `.each`.
     *
-    * Should only be used if the schema hasn't been created by `.map`ping another one. In such a case, the shape of the schema doesn't
+    * Should only be used if the schema hasn't been created by `.map` ping another one. In such a case, the shape of the schema doesn't
     * correspond to the type `T`, but to some lower-level representation of the type.
     *
     * If the shape of the schema doesn't correspond to the path, the schema remains unchanged.
@@ -41,12 +41,15 @@ private[tapir] object SchemaMacros {
           .exists(modifyType.endsWith)
 
       tree match {
+
         /** Field access */
         case Select(deep, ident) =>
           toPath(deep, PathElement.TermPathElement(ident) :: acc)
+
         /** Method call with no arguments and using clause */
         case Apply(Apply(TypeApply(Ident(f), _), idents), _) if typeSupported(f) => {
           val newAcc = acc match {
+
             /** replace the term controlled by quicklens */
             case PathElement.TermPathElement(term, xargs @ _*) :: rest => PathElement.FunctorPathElement(f, term, xargs: _*) :: rest
             case elements => report.errorAndAbort(s"Invalid use of path elements [${elements.mkString(", ")}]. $ShapeInfo, got: ${tree}")
@@ -64,6 +67,7 @@ private[tapir] object SchemaMacros {
     }
 
     val pathElements = path.asTerm match {
+
       /** Single inlined path */
       case Inlined(_, _, Block(List(DefDef(_, _, _, Some(p))), _)) =>
         toPath(p, List.empty)
@@ -157,7 +161,7 @@ trait SchemaCompanionMacros extends SchemaMagnoliaDerivation {
   }
 
   /** Creates a schema for an enumeration, where the validator is derived using [[sttp.tapir.Validator.derivedEnumeration]]. This requires
-    * that this is an `enum`, where all cases are parameterless, or that all subtypes of the sealed hierarchy `T` are `object`s.
+    * that this is an `enum`, where all cases are parameterless, or that all subtypes of the sealed hierarchy `T` are `object` s.
     *
     * This method cannot be implicit, as there's no way to constraint the type `T` to be an enum / sealed trait or class enumeration, so
     * that this would be invoked only when necessary.

core/src/main/scala-3/sttp/tapir/macros/ValidatorMacros.scala

@@ -9,7 +9,7 @@ import scala.quoted.*
 trait ValidatorMacros {
 
   /** Creates an enum validator for an `enum` where all cases are parameterless, or where all subtypes of the sealed hierarchy `T` are
-    * `object`s. This enumeration will only be used for documentation, as a value outside of the allowed values will not be decoded in the
+    * `object` s. This enumeration will only be used for documentation, as a value outside of the allowed values will not be decoded in the
     * first place (the decoder has no other option than to fail).
     */
   inline def derivedEnumeration[T]: Validator.Enumeration[T] = ${ ValidatorMacros.derivedEnumerationImpl[T] }

core/src/main/scala-3/sttp/tapir/macros/union_derivation.scala

@@ -56,5 +56,4 @@ private[tapir] object UnionDerivation:
           report.errorAndAbort(s"${o.show} is not a subtype of ${bound.show}")
 
     transformTypes(tpe).distinct.map(_.asType match
-      case '[t] => '{ constValue[t] }
-    )
+      case '[t] => '{ constValue[t] })

core/src/main/scala/sttp/tapir/Codec.scala

@@ -145,7 +145,7 @@ trait Codec[L, H, +CF <: CodecFormat] { outer =>
   /** Adds a validator to the codec's schema.
     *
     * Note that validation is run on a fully decoded value. That is, during decoding, first the decoding functions are run, followed by
-    * validations. Hence any functions provided in subsequent `.map`s or `.mapDecode`s will be invoked before validation.
+    * validations. Hence any functions provided in subsequent `.map` s or `.mapDecode` s will be invoked before validation.
     *
     * @see
     *   [[mapValidate]]
@@ -155,23 +155,23 @@ trait Codec[L, H, +CF <: CodecFormat] { outer =>
   /** Adds a validator which validates the option's element, if it is present.
     *
     * Note that validation is run on a fully decoded value. That is, during decoding, first the decoding functions are run, followed by
-    * validations. Hence any functions provided in subsequent `.map`s or `.mapDecode`s will be invoked before validation.
+    * validations. Hence any functions provided in subsequent `.map` s or `.mapDecode` s will be invoked before validation.
     *
-    * Should only be used if the schema hasn't been created by `.map`ping another one, but directly from `Schema[U]`. Otherwise the shape of
-    * the schema doesn't correspond to the type `T`, but to some lower-level representation of the type. This might cause invalid results at
-    * run-time.
+    * Should only be used if the schema hasn't been created by `.map` ping another one, but directly from `Schema[U]`. Otherwise the shape
+    * of the schema doesn't correspond to the type `T`, but to some lower-level representation of the type. This might cause invalid results
+    * at run-time.
     */
   def validateOption[U](v: Validator[U])(implicit hIsOptionU: H =:= Option[U]): Codec[L, H, CF] =
     schema(_.modifyUnsafe[U](Schema.ModifyCollectionElements)(_.validate(v)))
 
   /** Adds a validator which validates each element in the collection.
     *
     * Note that validation is run on a fully decoded value. That is, during decoding, first the decoding functions are run, followed by
-    * validations. Hence any functions provided in subsequent `.map`s or `.mapDecode`s will be invoked before validation.
+    * validations. Hence any functions provided in subsequent `.map` s or `.mapDecode` s will be invoked before validation.
     *
-    * Should only be used if the schema hasn't been created by `.map`ping another one, but directly from `Schema[U]`. Otherwise the shape of
-    * the schema doesn't correspond to the type `T`, but to some lower-level representation of the type. This might cause invalid results at
-    * run-time.
+    * Should only be used if the schema hasn't been created by `.map` ping another one, but directly from `Schema[U]`. Otherwise the shape
+    * of the schema doesn't correspond to the type `T`, but to some lower-level representation of the type. This might cause invalid results
+    * at run-time.
     */
   def validateIterable[C[X] <: Iterable[X], U](v: Validator[U])(implicit hIsCU: H =:= C[U]): Codec[L, H, CF] =
     schema(_.modifyUnsafe[U](Schema.ModifyCollectionElements)(_.validate(v)))

core/src/main/scala/sttp/tapir/EndpointIO.scala

@@ -74,7 +74,7 @@ sealed trait EndpointTransput[T] extends EndpointTransputMacros[T] {
   /** Adds a validator.
     *
     * Note that validation is run on a fully decoded value. That is, during decoding, first the decoding functions are run, followed by
-    * validations. Hence any functions provided in subsequent `.map`s or `.mapDecode`s will be invoked before validation.
+    * validations. Hence any functions provided in subsequent `.map` s or `.mapDecode` s will be invoked before validation.
     *
     * @see
     *   [[mapValidate]]
@@ -103,7 +103,7 @@ object EndpointTransput {
 
     /** Adds a validator which validates the option's element, if it is present.
       *
-      * Should only be used if the schema hasn't been created by `.map`ping another one, but directly from `Schema[U]`. Otherwise the shape
+      * Should only be used if the schema hasn't been created by `.map` ping another one, but directly from `Schema[U]`. Otherwise the shape
       * of the schema doesn't correspond to the type `T`, but to some lower-level representation of the type. This might cause invalid
       * results at run-time.
       */
@@ -112,7 +112,7 @@ object EndpointTransput {
 
     /** Adds a validator which validates each element in the collection.
       *
-      * Should only be used if the schema hasn't been created by `.map`ping another one, but directly from `Schema[U]`. Otherwise the shape
+      * Should only be used if the schema hasn't been created by `.map` ping another one, but directly from `Schema[U]`. Otherwise the shape
       * of the schema doesn't correspond to the type `T`, but to some lower-level representation of the type. This might cause invalid
       * results at run-time.
       */

core/src/main/scala/sttp/tapir/Tapir.scala

@@ -363,7 +363,7 @@ trait Tapir extends TapirExtensions with TapirComputedInputs with TapirStaticCon
     oneOfVariantValueMatcher(code, output)(exactMatch(rest.toSet + firstExactValue))
 
   /** Create a one-of-variant which uses `output` if the provided value equals the singleton value. The `output` shouldn't map to any
-    * values, that is, it should be `Unit`-typed. The entire variant is, on the other hand, typed with the singleton's type `T`.
+    * values, that is, it should be `Unit` -typed. The entire variant is, on the other hand, typed with the singleton's type `T`.
     *
     * Should be used in [[oneOf]] output descriptions.
     *
@@ -374,7 +374,7 @@ trait Tapir extends TapirExtensions with TapirComputedInputs with TapirStaticCon
     oneOfVariantValueMatcher(output.and(emptyOutputAs(singletonValue)))({ case a: Any => a == singletonValue })
 
   /** Create a one-of-variant which uses `output` if the provided value equals the singleton value. The `output` shouldn't map to any
-    * values, that is, it should be `Unit`-typed. The entire variant is, on the other hand, typed with the singleton's type `T`.
+    * values, that is, it should be `Unit` -typed. The entire variant is, on the other hand, typed with the singleton's type `T`.
     *
     * Adds a fixed status-code output with the given value.
     *

core/src/main/scala/sttp/tapir/typelevel/ParamConcat.scala

@@ -2,7 +2,7 @@ package sttp.tapir.typelevel
 
 /** Concatenates two parameter lists into one. Each parameter list can be either a single type, or a tuple.
   *
-  * The arity of a type if `0` if it's `Unit`/`Nothing`, as these types act as a neutral element in the tuple-concatenation operation that
+  * The arity of a type if `0` if it's `Unit` /`Nothing`, as these types act as a neutral element in the tuple-concatenation operation that
   * takes place when combining inputs/outputs.
   *
   * The arity of a type is `1` if it's a "singular" type (as viewed at compile-time; at run-time, the value might in fact be a tuple).

docs/apispec-docs/src/main/scala/sttp/tapir/docs/apispec/schema/TSchemaToASchema.scala

@@ -112,9 +112,9 @@ private[docs] class TSchemaToASchema(
     // The primary motivation for using schema name as fallback title is to improve Swagger UX with
     // `oneOf` schemas in OpenAPI 3.1. See https://github.com/softwaremill/tapir/issues/3447 for details.
     def fallbackTitle = tschema.name.map(fallbackSchemaTitle)
-    
+
     val const = tschema.attribute(TSchema.EncodedDiscriminatorValue.Attribute).map(_.v).map(v => ExampleSingleValue(v))
-    
+
     oschema
       .copy(title = titleFromAttr.orElse(fallbackTitle))
       .copy(uniqueItems = tschema.attribute(UniqueItems.Attribute).map(_.uniqueItems))