effectie v2.0.0-beta10

[kevin-lee]

effectie v2.0.0-beta10

2.0.0-beta10 - 2023-07-15

New Feature

• Add fromEffect(fa: => F[A]): F[A] to FxCtor and Fx (Add fromEffect(fa: => F[A]): F[A] to FxCtor and Fx #524)

  Fx[IO].fromEffect(IO(1)) // IO[Int]
  FxCtor[IO].fromEffect(IO(1)) // IO[Int]

• Add make[A](fa: => F[A])(release: A => F[Unit]): ReleasableResource[F, A] to ResourceMaker[F[*]] (Add make[A](fa: => F[A])(release: A => F[Unit]): ReleasableResource[F, A] to ResourceMaker[F[*]] #527)

  def make[A](fa: => F[A])(release: A => F[Unit]): ReleasableResource[F, A]

  • Try

    val resourceMaker = ResourceMaker.usingResourceMaker
    resourceMaker
      .make(Try(new SomeResource()))(a => Try(a.release())) // ReleasableResource[Try, SomeResource]
      .use { someResource =>
        // do something with someResource
        Try(result) // Try[ResultType]
      } // Try[ResultType]

  • Future

    val resourceMaker = ResourceMaker.futureResourceMaker
    resourceMaker
      .make(Future(new SomeResource()))(a => Future(a.release())) // ReleasableResource[Future, SomeResource]
      .use { someResource =>
        // do something with someResource
        Future.successful(result) // Future[ResultType]
      } // Future[ResultType]

  • Cats Effect 2

    val resourceMaker = Ce2ResourceMaker.withResource
    resourceMaker
      .make(IO(new SomeResource()))(a => IO(a.release())) // ReleasableResource[IO, SomeResource]
      .use { someResource =>
        // do something with someResource
        IO.pure(result) // IO[ResultType]
      } // IO[ResultType]

  • Cats Effect 3

    val resourceMaker = Ce3ResourceMaker.withResource
    resourceMaker
      .make(IO(new SomeResource()))(a => IO(a.release())) // ReleasableResource[IO, SomeResource]
      .use { someResource =>
        // do something with someResource
        IO.pure(result) // IO[ResultType]
      } // IO[ResultType]

• Add pure[A](a: A) and eval[A](fa: F[A]) to ResourceMaker (Add pure[A](a: A) and eval[A](fa: F[A]) to ResourceMaker #534)

  trait ResourceMaker[F[*]] {
    ...
  
    def pure[A](a: A): ReleasableResource[F, A]
  
    def eval[A](fa: F[A]): ReleasableResource[F, A]
  }

• Add ReleasableResource.pure (Add ReleasableResource.pure #542)

  ReleasableResource.pure(resource: A): ReleasableResource[F, A]

  So A doesn't have to be AutoCloseable as it's just a pure value.

• Add ReleasableResource.map and ReleasableResource.flatMap (Add ReleasableResource.map and ReleasableResource.flatMap #544)

  ReleasableResource.map(f: A => B)
  ReleasableResource.flatMap(f: A => ReleasableResource[F, B])

• Add Functor type-class for ReleasableResource (Add Functor type-class for ReleasableResource #548)

• Add Applicative type-class for ReleasableResource (Add Applicative type-class for ReleasableResource #550)

Changes

• Remove unnecessary re-evaluation of ResourceMaker (Remove unnecessary re-evaluation of ResourceMaker #529)

  The following ResourceMaker constructor method is just val now.

  effectie.resource.ResourceMaker.usingResourceMaker

• Rename withResource in Ce2ResourceMaker and Ce3ResourceMaker to maker (Rename withResource in Ce2ResourceMaker and Ce3ResourceMaker to maker #530)

• Move ResourceMaker and ReleasableResource to effectie-cats (Move ResourceMaker and ReleasableResource to effectie-cats #546)

  Having ReleasableResource in effectie-cats is required to have Functor and Monad type-classes.

[codecov]

Codecov Report

Merging #553 (6b0371f) into main (66b76f7) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #553   +/-   ##
=======================================
  Coverage   92.23%   92.23%           
=======================================
  Files          62       62           
  Lines         399      399           
  Branches       10       10           
=======================================
  Hits          368      368           
  Misses         31       31