Skip to content

intial set of scaladoc (only for syntax methods for now) #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arainko merged 1 commit into from
Oct 26, 2024
Merged

intial set of scaladoc (only for syntax methods for now) #216

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 87 additions & 0 deletions ducktape/src/main/scala/io/github/arainko/ducktape/syntax.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,107 @@ package io.github.arainko.ducktape
import io.github.arainko.ducktape.internal.{ FallibleTransformations, TotalTransformations }

extension [Source](source: Source) {

/**
* Transforms a Source into a Dest.
*
* {{{
* case class Person(name: String, age: Int)
* case class ReshuffledPerson(age: Int, name: String)
*
* val person: Person = ???
*
* person.to[ReshuffledPerson]
* }}}
*/
inline def to[Dest]: Dest = TotalTransformations.between[Source, Dest](source, "transformation")

/**
* Creates a transformation builder that can be used to configure transformations.
*
* {{{
* case class Person(name: String, age: Int)
* case class ReshuffledPerson(age: Int, name: String, missingField: Int)
*
* val person: Person = ???
*
* person.into[ReshuffledPerson].transform(Field.const(_.missingField, 1))
* }}}
* @see [[io.github.arainko.ducktape.Field]] and [[io.github.arainko.ducktape.Case]] for all available config options.
*/
def into[Dest]: AppliedBuilder[Source, Dest] = AppliedBuilder[Source, Dest](source)

/**
* Transforms a Source by expanding its fields into arguments of Func.
*
* {{{
* case class Person(name: String, age: Int)
* def prettyPrintPerson(age: Int, name: String): String = ???
*
* val person: Person = ???
*
* person.via(prettyPrintPerson)
* }}}
* @param function the function to expand (needs to be a method reference)
*/
transparent inline def via[Func](inline function: Func): Any =
TotalTransformations.viaInferred[Source, Func](source, function)

/**
* Creates a transformation builder for function transformations that can be used to configure these.
*
* {{{
* case class Person(name: String, age: Int)
* def prettyPrintPerson(age: Int, name: String, missingArg: Int): String = ???
*
* val person: Person = ???
*
* person.intoVia(prettyPrintPerson).transform(Field.const(_.missingField, 1))
* }}}
* @see [[io.github.arainko.ducktape.Field]] and [[io.github.arainko.ducktape.Case]] for all available config options.
*/
transparent inline def intoVia[Func](inline function: Func): Any =
AppliedViaBuilder.create(source, function)
}

extension [F[+x], Source](value: Source)(using F: Mode[F]) {

/**
* Fallibly transforms a Source into an F[Dest].
*
* {{{
* case class Positive private (value: Int)
* object Positive {
* given Transformer.Fallible[[a] =>> Either[String, a], Int, Positive] =
* int => Either.cond(int > 0, Positive(int), s"$int is not positive")
* }
* case class PositiveNumbers(one: Positive, two: Positive, three: Positive)
*
* Mode.FailFast.either[String].locally {
* (1, 2, 3).fallibleTo[PositiveNumbers]
* }
* }}}
*/
inline def fallibleTo[Dest]: F[Dest] = FallibleTransformations.between[F, Source, Dest](value, F, "transformation")

/**
* Fallibly transforms a Source by expanding and transforming its fields into arguments Func.
*
* {{{
* case class Positive private (value: Int)
* object Positive {
* given Transformer.Fallible[[a] =>> Either[String, a], Int, Positive] =
* int => Either.cond(int > 0, Positive(int), s"$int is not positive")
* }
*
* def calculateWithPositives(one: Positive, two: Positive, three: Positive) = ???
*
* Mode.FailFast.either[String].locally {
* (1, 2, 3).fallibleVia(calculateWithPositives)
* }
* }}}
* @param function the function to expand (needs to be a method reference)
*/
transparent inline def fallibleVia[Func](inline function: Func): F[Any] =
FallibleTransformations.viaInferred[F, Source, Func](value, function, F)
}