CU-g52kvp - Fix Java API for typeclasses in Arrow Optics #2336
Conversation
…Static annotation and remove imports from deprecations
|
Task linked: CU-g52kvp Improve usage from Java |
…vmStatic annotation and remove imports from deprecations
…tatic annotation and remove imports from deprecations
…with JvmStatic annotation and remove imports from deprecations
…vmStatic annotation and remove imports from deprecations
… JvmStatic annotation and remove imports from deprecations
…tatic annotation and remove imports from deprecations
…vmStatic annotation and remove imports from deprecations
…h JvmStatic annotation and remove imports from deprecations
…mStatic annotation and remove imports from deprecations
| @@ -16,7 +16,7 @@ import arrow.typeclasses.Applicative | |||
| */ | |||
| @Deprecated( | |||
| "arrow.optics.extensions package is being deprecated, function is being moved to arrow.optics.traversal", | |||
| ReplaceWith("Either.traversal<L, R>()", "arrow.core.Either", "arrow.optics.traversal"), | |||
| ReplaceWith("Either.traversal<L, R>()", "arrow.core.Either"), | |||
There was a problem hiding this comment.
| ReplaceWith("Either.traversal<L, R>()", "arrow.core.Either"), | |
| ReplaceWith("Traversal.either<L, R>()", "arrow.optics.Traversal"), |
| @@ -30,7 +30,7 @@ fun <L, R> Either.Companion.traversal(): Traversal<Either<L, R>, R> = object : T | |||
| */ | |||
| @Deprecated( | |||
| "Each is being deprecated. Use Traversal directly instead.", | |||
| ReplaceWith("Either.traversal<L, R>()", "arrow.core.Either", "arrow.optics.traversal"), | |||
| ReplaceWith("Either.traversal<L, R>()", "arrow.core.Either"), | |||
There was a problem hiding this comment.
| ReplaceWith("Either.traversal<L, R>()", "arrow.core.Either"), | |
| ReplaceWith("Traversal.either<L, R>()", "arrow.optics.Traversal"), |
| @@ -28,7 +28,7 @@ internal val at_singleton: SetKAt<Any?> = object : SetKAt<Any?> {} | |||
| "arrow.optics.extensions package is being deprecated, and it will be removed in 0.13.", | |||
| ReplaceWith( | |||
| "this compose At.set<A>().at(i)", | |||
| "arrow.optics.set", "arrow.optics.typeclasses.At", "arrow.optics.compose" | |||
| "arrow.optics.typeclasses.At", "arrow.optics.compose" | |||
There was a problem hiding this comment.
There is no "arrow.optics.compose" import. This needs to be removed from all ReplaceWith, this was here already before this PR but let's clean it up here.
| /** | ||
| * [PIso] that defines the equality between [Either] and [Validated] | ||
| */ | ||
| fun <A1, A2, B1, B2> Either.Companion.toPValidated(): PIso<Either<A1, B1>, Either<A2, B2>, Validated<A1, B1>, Validated<A2, B2>> = PIso( |
There was a problem hiding this comment.
This cannot be removed since it was present in 0.11.0
There was a problem hiding this comment.
This should be deprecated in favor of Iso.pValidated()
| /** | ||
| * [Iso] that defines the equality between [Either] and [Validated] | ||
| */ | ||
| fun <A, B> Either.Companion.toValidated(): Iso<Either<A, B>, Validated<A, B>> = toPValidated() |
There was a problem hiding this comment.
This cannot be removed since it was present in 0.11.0
There was a problem hiding this comment.
This should be deprecated in favor of Iso.validated()
|
|
||
| /** | ||
| * [Iso] that defines the equality between a Unit value [Map] and a [Set] with its keys | ||
| */ | ||
| @Deprecated( | ||
| "MapK is being deprecated, use the function defined for Map instead.", | ||
| "MapK is being deprMapInstanceTest.ktecated, use the function defined for Map instead.", |
There was a problem hiding this comment.
| "MapK is being deprMapInstanceTest.ktecated, use the function defined for Map instead.", | |
| "MapK is being deprecated, use the function defined for Map instead.", |
| /** | ||
| * [PIso] that defines the equality between [Option] and the nullable platform type. | ||
| */ | ||
| fun <A, B> Option.Companion.toPNullable(): PIso<Option<A>, Option<B>, A?, B?> = PIso( |
There was a problem hiding this comment.
Cannot be removed, present in 0.11.0. Should be deprecated
| /** | ||
| * [PIso] that defines the isomorphic relationship between [Option] and the nullable platform type. | ||
| */ | ||
| fun <A> Option.Companion.toNullable(): Iso<Option<A>, A?> = toPNullable() |
There was a problem hiding this comment.
Cannot be removed, present in 0.11.0. Should be deprecated
| /** | ||
| * [PPrism] to focus into an [arrow.core.Some] | ||
| */ | ||
| fun <A, B> Option.Companion.PSome(): PPrism<Option<A>, Option<B>, A, B> = PPrism( |
There was a problem hiding this comment.
Cannot be removed, present in 0.11.0. Should be deprecated
| /** | ||
| * [Prism] to focus into an [arrow.core.Some] | ||
| */ | ||
| fun <A> Option.Companion.some(): Prism<Option<A>, A> = PSome() |
There was a problem hiding this comment.
Cannot be removed, present in 0.11.0. Should be deprecated
| /** | ||
| * [Prism] to focus into an [arrow.core.None] | ||
| */ | ||
| fun <A> Option.Companion.none(): Prism<Option<A>, Unit> = Prism( |
There was a problem hiding this comment.
Cannot be removed, present in 0.11.0. Should be deprecated
| /** | ||
| * [Iso] that defines the equality between and [arrow.core.Option] and [arrow.core.Either] | ||
| */ | ||
| fun <A, B> Option.Companion.toPEither(): PIso<Option<A>, Option<B>, Either<Unit, A>, Either<Unit, B>> = PIso( |
There was a problem hiding this comment.
Cannot be removed, present in 0.11.0. Should be deprecated
| /** | ||
| * [Iso] that defines the equality between and [arrow.core.Option] and [arrow.core.Either] | ||
| */ | ||
| fun <A> Option.Companion.toEither(): Iso<Option<A>, Either<Unit, A>> = toPEither() |
There was a problem hiding this comment.
Cannot be removed, present in 0.11.0. Should be deprecated
|
|
||
| /** | ||
| * [PLens] to focus into the first value of a [arrow.core.Tuple2] | ||
| */ |
There was a problem hiding this comment.
Nothing in this file can be removed since present in 0.11.0. All these methods need to be deprecated in favor of their @JvmStatic version on Lens Companion.
The ones for Tuple2 & Tuple3 don't have to be recreated on Lens.Companion since they're being deprecated. Deprecate these optics with the same message that is deprecating Tuple2 & Tuple3.
Instead only expose the Pair/Triple variant on Lens.Companion.
| /** | ||
| * [PIso] that defines equality between [Validated] and [Either] | ||
| */ | ||
| fun <A1, A2, B1, B2> Validated.Companion.toPEither(): PIso<Validated<A1, B1>, Validated<A2, B2>, Either<A1, B1>, Either<A2, B2>> = PIso( |
There was a problem hiding this comment.
These are present on 0.11.0 and cannot be removed. They need to be deprecated in favor of Iso.pEither() and Iso.either().
There was a problem hiding this comment.
Idem, should've been validatedToPEither and same for the deprecation
| cons() compose Tuple2.first() | ||
| cons() compose Lens.tuple2First() |
There was a problem hiding this comment.
This can stay as it is until 0.13.0
|
|
||
| /** | ||
| * Provides an [Optional] between [S] and its tail [S]. | ||
| */ | ||
| fun tailOption(): Optional<S, S> = | ||
| cons() compose Tuple2.second() |
There was a problem hiding this comment.
This can stay as it is until 0.13.0
| @@ -27,12 +33,12 @@ fun interface Snoc<S, A> { | |||
| /** | |||
| * Provides an [Optional] between [S] and its init [S]. | |||
| */ | |||
| fun initOption(): Optional<S, S> = snoc() compose Tuple2.first() | |||
| fun initOption(): Optional<S, S> = snoc() compose PLens.tuple2First() | |||
There was a problem hiding this comment.
This can stay as it is until 0.13.0
|
|
||
| /** | ||
| * Provides an [Optional] between [S] and its last element [A]. | ||
| */ | ||
| fun lastOption(): Optional<S, A> = snoc() compose Tuple2.second() | ||
| fun lastOption(): Optional<S, A> = snoc() compose PLens.tuple2Second() |
There was a problem hiding this comment.
This can stay as it is until 0.13.0
There was a problem hiding this comment.
thanks @nomisRev , I hope I addressed all the comments! 😄
| * [PIso] that defines the equality between [Either] and [Validated] | ||
| */ | ||
| @JvmStatic | ||
| fun <A1, A2, B1, B2> pValidated(): PIso<Either<A1, B1>, Either<A2, B2>, Validated<A1, B1>, Validated<A2, B2>> = |
There was a problem hiding this comment.
This should be named eitherToPValidated like listToPOptionNel.
| fun <A1, A2, B1, B2> pValidated(): PIso<Either<A1, B1>, Either<A2, B2>, Validated<A1, B1>, Validated<A2, B2>> = | |
| fun <A1, A2, B1, B2> eitherToPValidated(): PIso<Either<A1, B1>, Either<A2, B2>, Validated<A1, B1>, Validated<A2, B2>> = |
| * [Iso] that defines the equality between [Either] and [Validated] | ||
| */ | ||
| @JvmStatic | ||
| fun <A, B> validated(): Iso<Either<A, B>, Validated<A, B>> = |
There was a problem hiding this comment.
| fun <A, B> validated(): Iso<Either<A, B>, Validated<A, B>> = | |
| fun <A, B> eitherToValidated(): Iso<Either<A, B>, Validated<A, B>> = |
| * [PIso] that defines equality between [Validated] and [Either] | ||
| */ | ||
| @JvmStatic | ||
| fun <A1, A2, B1, B2> pEither(): PIso<Validated<A1, B1>, Validated<A2, B2>, Either<A1, B1>, Either<A2, B2>> = |
There was a problem hiding this comment.
| fun <A1, A2, B1, B2> pEither(): PIso<Validated<A1, B1>, Validated<A2, B2>, Either<A1, B1>, Either<A2, B2>> = | |
| fun <A1, A2, B1, B2> validatedToPEither(): PIso<Validated<A1, B1>, Validated<A2, B2>, Either<A1, B1>, Either<A2, B2>> = |
| * [Iso] that defines equality between [Validated] and [Either] | ||
| */ | ||
| @JvmStatic | ||
| fun <A, B> either(): Iso<Validated<A, B>, Either<A, B>> = |
There was a problem hiding this comment.
| fun <A, B> either(): Iso<Validated<A, B>, Either<A, B>> = | |
| fun <A, B> validatedToEither(): Iso<Validated<A, B>, Either<A, B>> = |
| */ | ||
| @JvmStatic | ||
| fun <A> tripleTraversal(): Traversal<Triple<A, A, A>, A> = | ||
| triplePTraversal() |
There was a problem hiding this comment.
traversal for Tuple4 -> Tuple10 is missing here.
| @Deprecated( | ||
| "Use the pValidated function exposed in the Iso' companion object", | ||
| ReplaceWith( | ||
| "Iso.pValidated()", |
There was a problem hiding this comment.
This should also be updated then to eitherToPValidated.
| "arrow.optics.Traversal" | ||
| ), | ||
| DeprecationLevel.WARNING | ||
| ) | ||
| fun <A> Tuple3.Companion.traversal(): Traversal<Tuple3<A, A, A>, A> = pTraversal() | ||
|
|
||
| /** |
There was a problem hiding this comment.
If pTraversal for Tuple4 -> Tuple5 is added to Traversal than all the other ones here have to be deprecated also.
There was a problem hiding this comment.
thanks @nomisRev for the review! applied the comments 👍
There was a problem hiding this comment.
Looks perfect @danimontoya. 1 small deprecation suggestion ;) Thanks for the great work!!! ❤️ 👏 👏
arrow-libs/optics/arrow-optics/src/main/kotlin/arrow/optics/std/either.kt
Outdated
Show resolved
Hide resolved
…d/either.kt Co-authored-by: Simon Vergauwen <nomisRev@users.noreply.github.com>
Fixes https://app.clickup.com/t/g52kvp
Move arrow.optics.std.* functions into each type class companion object with JvmStatic annotation and remove imports from deprecations: