Bracket example to doc #962

tampler · 2019-06-04T15:03:36Z

No description provided.

Added a full working example for newcomers

iravid · 2019-06-04T18:49:59Z

docs/datatypes/io.md

@@ -161,3 +161,27 @@ val action: Task[String] = Task.effectTotal(i += 1) *> Task.fail(new Throwable("
 val cleanupAction: UIO[Unit] = UIO.effectTotal(i -= 1)
 val composite = action.ensuring(cleanupAction)
 ```
+### A full working example on using brackets
+```scala


When using the scala lang directive, the snippet does not get typechecked, so we can't maintain its correctness over time.

If you switch this to scala mdoc:silent as the other snippets above, it'll be typechecked.

NeQuissimus

What @iravid said :)

tampler · 2019-06-05T20:33:50Z

Yeah, thank you, @iravid . I'll make a fix soon

tampler

Updated my directive as you advised. Thank you

iravid · 2019-06-15T17:33:40Z

docs/datatypes/io.md

+      val string = Task.effect(new FileInputStream(file)).bracket(closeStream)(convertBytes).orDie
+
+      // Print effect
+      rt.unsafeRun(string)


Please refactor the example to not use rt.unsafeRun, as that is not something we encourage.

In fact, since the example is using App, you don't need to instantiate a runtime at all.

iravid · 2019-06-15T17:34:58Z

docs/datatypes/io.md

+    mybracket.orDie.map(_ => 0)
+
+  def closeStream(is: FileInputStream) =
+    UIO.effectTotal(is.close())


This can just be UIO(is.close())

iravid · 2019-06-15T17:35:10Z

docs/datatypes/io.md

+
+  // run my bracket
+  def run(args: List[String]) =
+    mybracket.orDie.map(_ => 0)


Suggested change

mybracket.orDie.map(_ => 0)

mybracket.orDie.const(0)

tampler · 2019-06-15T18:25:17Z

All Fixed. Pls review again

iravid · 2019-06-15T18:45:58Z

docs/datatypes/io.md

      // Print effect
-      rt.unsafeRun(string)
-
+      unsafeRun(string)


We don't encourage using unsafeRun directly, and it's not needed here as the App will run the effect for you.

e.g.

for { file <- Task(new File("/tmp/hello")) string <- Task(new FileInputStream(file)).bracket(closeStream)(convertBytes) } yield string

iravid · 2019-06-15T18:47:58Z

docs/datatypes/io.md


  def convertBytes(is: FileInputStream) =
-    Task.effect(println(new String(is.readAllBytes(), StandardCharsets.UTF_8)))
+    Task.effect(println(new String(is.readAllBytes(), StandardCharsets.UTF_8))) // Java 11+


We don't build yet on Java 11, so this probably won't typecheck.

Fixed

This may be an issue. I run my code for Java 11 seamlessly. The very same code fails to compile is.readAllBytes() on Java8. What to do? I don't know how to refactor readAllBytes

iravid · 2019-06-15T18:48:22Z

docs/datatypes/io.md

  // run my bracket
  def run(args: List[String]) =
-    mybracket.orDie.map(_ => 0)
+    mybracket.orDie.const(-1) // return -1 on fail


The -1 would be returned on the success cases, so you want to return 0 here.

jdegoes · 2019-06-20T14:12:16Z

docs/datatypes/io.md

+    UIO(is.close())
+
+  def convertBytes(is: FileInputStream) =
+    Task.effect(println(new String(is.readAllBytes(), StandardCharsets.UTF_8))) // Java 11+, since is.realAllBytes() won't compile on Java8


Since this won't work on Java 8, I'd suggest writing a helper, a private method inside convertBytes:

def readAll(fis: FileInputStream, len: Long): Array[Byte] = { val content = Array.ofDim(len) fis.read(content) content }

You can get the length of the file using new File(path).size or something similar (can't remember it off the top of my head).

tampler · 2019-06-22T15:32:19Z

Added a helper method from @jdegoes. Now works fine on both Java8 and Java 11. Tested with ZIO 1.0.0-RC8-12

jdegoes · 2019-06-23T16:43:44Z

@tampler Did you push your changes? This looks the same as before...

tampler · 2019-06-23T17:57:34Z

Yeah, now pushed. Thanks for your feedback

jdegoes · 2019-07-09T01:24:02Z

@tampler This looks ready to merge to me!

I noticed that mdoc is still failing.

tampler · 2019-07-09T10:01:30Z

@jdegoes Yes, it fails on exit. That's what I get every time I launch a ZIO App. It says the following:

Exception: sbt.TrapExitSecurityException thrown from the UncaughtExceptionHandler in thread "run-main-0"

I don't know what is the reason of such behav. The code works okay, but returns an exception on each run. Any ideas?

jdegoes · 2019-07-09T18:23:26Z

@tampler Here is the error that I see:

info: Compiling 48 files to /home/circleci/project/zio-docs/target/mdoc
error: /home/circleci/project/docs/datatypes/io.md:167:1: illegal start of definition
package hello
^^^^^^^

jdegoes · 2019-07-09T18:23:44Z

I am not sure if you can put package in an mdoc?

tampler · 2019-07-10T08:42:07Z

Removed package from code

jdegoes · 2019-07-10T17:33:11Z

@tampler Thanks for this full example! I'd love to get other full examples in for each major feature.

tampler and others added 7 commits June 3, 2019 16:42

Added Clover to resources

d677dbb

Fixed issue 951

7c23857

Merge branch 'master' of https://github.com/zio/zio

a0f6de6

Flow merge

4688ac4

Brackets

ff3b119

Added a full working example for newcomers

Merge branch 'master' of github.com:Clover-Group/zio

4d7a65d

Sync with upstream

47c68f8

iravid reviewed Jun 4, 2019

View reviewed changes

NeQuissimus suggested changes Jun 5, 2019

View reviewed changes

tampler added 2 commits June 6, 2019 18:31

Merge branch 'master' of https://github.com/zio/zio

e863b3f

Switched to formatting, that supports typechecking

15bea65

tampler commented Jun 6, 2019

View reviewed changes

NeQuissimus force-pushed the master branch 2 times, most recently from 898f033 to 3cf511d Compare June 9, 2019 19:36

iravid reviewed Jun 15, 2019

View reviewed changes

tampler added 2 commits June 15, 2019 20:51

Merge branch 'master' of https://github.com/zio/zio

04c3509

Refactored bracket example. Removed Runtime

faa8a95

iravid reviewed Jun 15, 2019

View reviewed changes

Removed unsafeRun. Changed exit const to 0. Refactored mybracket logic

efdddf2

jdegoes reviewed Jun 20, 2019

View reviewed changes

Merge branch 'master' of https://github.com/zio/zio

81608c9

Merge branch 'master' of https://github.com/zio/zio

48cfb83

Updated bracket example to compile on both Java8 and Java11

5e30c44

tampler added 2 commits June 26, 2019 16:40

Merge branch 'master' of https://github.com/zio/zio

a380113

Merge branch 'master' of https://github.com/zio/zio

607f93f

Merge branch 'master' of https://github.com/zio/zio

e7cc57a

tampler added 2 commits July 10, 2019 11:40

Merge branch 'master' of https://github.com/zio/zio

82ba259

Updated bracket example in IO doc. Removed package from code

632930f

jdegoes approved these changes Jul 10, 2019

View reviewed changes

jdegoes merged commit 6180669 into zio:master Jul 10, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bracket example to doc #962

Bracket example to doc #962

tampler commented Jun 4, 2019

iravid Jun 4, 2019

NeQuissimus left a comment •

edited

tampler commented Jun 5, 2019

tampler left a comment

iravid Jun 15, 2019

iravid Jun 15, 2019

iravid Jun 15, 2019

tampler commented Jun 15, 2019

iravid Jun 15, 2019

iravid Jun 15, 2019

iravid Jun 15, 2019

tampler Jun 15, 2019

iravid Jun 15, 2019

jdegoes Jun 20, 2019

tampler commented Jun 22, 2019

jdegoes commented Jun 23, 2019

tampler commented Jun 23, 2019

jdegoes commented Jul 9, 2019

tampler commented Jul 9, 2019

jdegoes commented Jul 9, 2019

jdegoes commented Jul 9, 2019

tampler commented Jul 10, 2019

jdegoes commented Jul 10, 2019

Bracket example to doc #962

Bracket example to doc #962

Conversation

tampler commented Jun 4, 2019

Choose a reason for hiding this comment

NeQuissimus left a comment • edited

Choose a reason for hiding this comment

tampler commented Jun 5, 2019

tampler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tampler commented Jun 15, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tampler commented Jun 22, 2019

jdegoes commented Jun 23, 2019

tampler commented Jun 23, 2019

jdegoes commented Jul 9, 2019

tampler commented Jul 9, 2019

jdegoes commented Jul 9, 2019

jdegoes commented Jul 9, 2019

tampler commented Jul 10, 2019

jdegoes commented Jul 10, 2019

NeQuissimus left a comment •

edited