fixed zio-mock documentation on mocking collaborators compose layers #7600

JoaquinIglesiasTurina · 2022-12-03T19:12:23Z

Updated zio-mock documentation as documented on this issue.

CLAassistant · 2022-12-03T19:12:28Z

All committers have signed the CLA.

vigoo · 2022-12-03T19:44:13Z

Thank you!

adamgfraser

Can we use mdoc here so we check that these code snippets compile as part of CI?

JoaquinIglesiasTurina · 2022-12-04T18:50:54Z

docs/ecosystem/officials/zio-mock.md

        Random
          .nextUUID
          .map(id => User(id.toString, s"name-$n"))
-          .provideLayer(Random.live)


Please check this gist when reviewing this change.
https://gist.github.com/JoaquinIglesiasTurina/10d16eed4ab774171525673f3087d8e8

adamgfraser · 2022-12-04T21:23:50Z

docs/ecosystem/officials/zio-mock.md

 object UserServiceLive {
  val layer: URLayer[EmailService with UserRepository, UserService] =
-    (UserServiceLive.apply _).toLayer[UserService]
+    ZLayer {


This can just be ZLayer.fromFunction.

adamgfraser · 2022-12-04T21:24:29Z

docs/ecosystem/officials/zio-mock.md

-        new EmailService {
-          override def send(to: String, body: String): IO[String, Unit] =
-            proxy(Send, to, body)
+    ZLayer.fromZIO(


ZLayer.apply and use of a for comprehension would be more idiomatic here.

adamgfraser · 2022-12-04T21:24:45Z

docs/ecosystem/officials/zio-mock.md

-        new UserRepository {
-          override def save(user: User): IO[String, Unit] =
-            proxy(Save, user)
+    ZLayer.fromZIO(


Same comment as above.

adamgfraser · 2022-12-04T21:27:12Z

docs/ecosystem/officials/zio-mock.md

 This expectation simulates a never-ending loop:

-```scala
+```scala mdoc/silent


adamgfraser

Great to add mdoc to all of these to make sure they compile. I think this could use one more pass to make sure all the examples are as idiomatic as possible and then will be good to go!

JoaquinIglesiasTurina · 2022-12-04T23:22:19Z

I've reviewed the ZLayer constructors and typos. Is there something else I should be mindful of?
Being new to ZIO and Scala, I cannot be proactive on making code idiomatic.
@adamgfraser, thank you for your review. I'm learning a lot.

adamgfraser · 2022-12-05T03:51:02Z

docs/ecosystem/officials/zio-mock.md

+    ZLayer {
+      for {
+         proxy <- ZIO.service[Proxy]
+      } yield (


Very minor but this will be slightly more readable if you delete the parentheses here and define new EmailService on the same line. } yield new EmailService {

adamgfraser · 2022-12-05T03:51:22Z

docs/ecosystem/officials/zio-mock.md

+      for {
+        proxy <- ZIO.service[Proxy]
+      } yield (
        new UserRepository {


Same comment as above.

adamgfraser · 2022-12-05T03:52:14Z

docs/ecosystem/officials/zio-mock.md

+    ZLayer(
+      for {
+        proxy <- ZIO.service[Proxy]
+      } yield { 


Can delete extra curly braces and move to same line.

adamgfraser · 2022-12-05T03:52:59Z

docs/ecosystem/officials/zio-mock.md

-```scala
+```scala mdoc:silent:nest
 import zio.test._
-import MockPolyService._


Could keep the import and just do PolyInput.of[String]. This would probably be slightly cleaner.

adamgfraser · 2022-12-05T03:57:33Z

docs/ecosystem/officials/zio-mock.md

-          def polyError[E: Tag](input: Int)             = proxy(PolyError.of[E], input)
-          def polyOutput[A: Tag](input: Int)            = proxy(PolyOutput.of[A], input)
-          def polyAll[I: Tag, E: Tag, A: Tag](input: I) = proxy(PolyAll.of[I, E, A], input)
+    ZLayer(


Curly braces instead of parentheses.

adamgfraser · 2022-12-05T03:58:01Z

docs/ecosystem/officials/zio-mock.md

-
-          override def exampleStream(a: Int): stream.Stream[Throwable, String] =
-            rts.unsafeRun(proxy(ExampleStream, a))
+    ZLayer.fromZIO(


ZLayer.apply here.

adamgfraser · 2022-12-05T03:58:16Z

docs/ecosystem/officials/zio-mock.md

-            rts.unsafeRun(proxy(ExampleStream, a))
+    ZLayer.fromZIO(
+      ZIO.serviceWithZIO[Proxy] { proxy =>
+        withRuntime[Proxy, ExampleService] { rts =>


runtime instead of rts.

adamgfraser · 2022-12-05T03:58:31Z

docs/ecosystem/officials/zio-mock.md

+                proxy(ExampleEffect, i)
+
+              override def exampleMethod(i: Int): String =
+                Unsafe.unsafe { implicit u =>


unsafe instead of u.

adamgfraser · 2022-12-05T03:59:28Z

docs/ecosystem/officials/zio-mock.md

+    ZLayer.fromZIO(
+      ZIO.serviceWithZIO[Proxy] { proxy =>
+        withRuntime[Proxy, ExampleService] { rts =>
+          ZIO.succeed(


Curly braces instead of parentheses for multiple line statement.

adamgfraser · 2022-12-05T03:59:55Z

docs/ecosystem/officials/zio-mock.md

+    ZLayer {
+      for {
+        proxy <- ZIO.service[Proxy]
+      } yield


Can bring up definition of AccountObserver a line.

adamgfraser · 2022-12-05T04:00:05Z

docs/ecosystem/officials/zio-mock.md

-        }
-      }.toLayer
-
+    ZLayer{


Missing space.

adamgfraser · 2022-12-05T04:00:19Z

docs/ecosystem/officials/zio-mock.md

+    ZLayer{
+      for {
+        proxy <- ZIO.service[mock.Proxy]
+      } yield


Delete extra line.

adamgfraser · 2022-12-05T04:01:29Z

@JoaquinIglesiasTurina Definitely! Thank you for your work on this! Left detailed comments.

adamgfraser

Congratulations on your first contribution to ZIO! 🎉

fixed zio-mock documentation on mocking collaborators compose layers

ebb5e56

adamgfraser suggested changes Dec 3, 2022

View reviewed changes

JoaquinIglesiasTurina added 6 commits December 4, 2022 13:29

missing proper layer constructor in compose method

2ef3832

The Problem mdoc'ed and compiling

341bb5c

add zio-mock to docs dependencies

8c527c5

testing services mdoc'ed and compiling

078e26c

Encoding Polymorphic Capabilities mdoc'ed and compiling

bd6cf06

all zio-mock.md properly mdoc'ed

ce1875b

JoaquinIglesiasTurina commented Dec 4, 2022

View reviewed changes

adamgfraser reviewed Dec 4, 2022

View reviewed changes

adamgfraser suggested changes Dec 4, 2022

View reviewed changes

JoaquinIglesiasTurina added 3 commits December 4, 2022 23:26

fixed typos

1528c7d

more idiomatic ZLayer constructors

ef7be69

more idiomatic ZLayer constructor

15a5b6c

adamgfraser reviewed Dec 5, 2022

View reviewed changes

docs/ecosystem/officials/zio-mock.md Outdated

}

}.toLayer

ZLayer{

Copy link

Contributor

adamgfraser Dec 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing space.

adamgfraser reviewed Dec 5, 2022

View reviewed changes

docs/ecosystem/officials/zio-mock.md Outdated

ZLayer{

for {

proxy <- ZIO.service[mock.Proxy]

} yield

Copy link

Contributor

adamgfraser Dec 5, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete extra line.

JoaquinIglesiasTurina added 2 commits December 6, 2022 12:09

idiomatic yielding and use of curly braces. Imported MockPolyService

98ef4f3

added missing new constructor.

0e9f9b0

adamgfraser approved these changes Dec 6, 2022

View reviewed changes

adamgfraser merged commit 2863644 into zio:series/2.x Dec 6, 2022

Uh oh!

fixed zio-mock documentation on mocking collaborators compose layers #7600

fixed zio-mock documentation on mocking collaborators compose layers #7600

Uh oh!

Conversation

JoaquinIglesiasTurina commented Dec 3, 2022

Uh oh!

CLAassistant commented Dec 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vigoo commented Dec 3, 2022

Uh oh!

adamgfraser left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamgfraser left a comment

Choose a reason for hiding this comment

Uh oh!

JoaquinIglesiasTurina commented Dec 4, 2022

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

adamgfraser commented Dec 5, 2022

Uh oh!

adamgfraser left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

CLAassistant commented Dec 3, 2022 •

edited

Loading