Add IO Monad #109

pakoito · 2017-06-11T21:23:27Z

This PR adds an implementation of IO based off Cats. It includes a Duration util for blocking operations.

codecov · 2017-06-11T21:46:35Z

Codecov Report

Merging #109 into master will decrease coverage by 2.05%.
The diff coverage is 36.55%.

@@             Coverage Diff              @@
##             master     #109      +/-   ##
============================================
- Coverage     54.82%   52.77%   -2.06%     
- Complexity      177      183       +6     
============================================
  Files            77       83       +6     
  Lines          1098     1243     +145     
  Branches        169      180      +11     
============================================
+ Hits            602      656      +54     
- Misses          433      521      +88     
- Partials         63       66       +3

Impacted Files	Coverage Δ	Complexity Δ
katz/src/main/kotlin/katz/instances/IdMonad.kt	`83.33% <ø> (ø)`	`0 <0> (ø)`	⬇️
katz/src/main/kotlin/katz/instances/IOMonoid.kt	`0% <0%> (ø)`	`0 <0> (?)`
katz/src/main/kotlin/katz/instances/IOSemigroup.kt	`0% <0%> (ø)`	`0 <0> (?)`
katz/src/main/kotlin/katz/instances/IOMonad.kt	`14.28% <14.28%> (ø)`	`0 <0> (?)`
katz/src/main/kotlin/katz/effects/Duration.kt	`27.77% <27.77%> (ø)`	`2 <2> (?)`
katz/src/main/kotlin/katz/effects/IO.kt	`40.9% <40.9%> (ø)`	`5 <5> (?)`
...atz/src/main/kotlin/katz/effects/internal/Utils.kt	`45.83% <45.83%> (ø)`	`0 <0> (?)`
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7f10e83...a4d2965. Read the comment docs.

pakoito · 2017-06-11T22:49:35Z

Missing: most tests

https://github.com/typelevel/cats-effect/blob/f975bc8a2e6589f0435b1314158998b65427cfa0/laws/shared/src/test/scala/cats/effect/IOTests.scala

https://github.com/typelevel/cats-effect/blob/master/laws/shared/src/test/scala/cats/effect/IOAsyncTests.scala

ffgiraldez

review IOMonad, IOMonoid and IOSemigrup to use IO<A> as parent generic type and returning type instead of HK<IO.F,A>

ffgiraldez · 2017-06-12T06:06:00Z

katz/src/main/kotlin/katz/instances/IOMonoid.kt

@@ -0,0 +1,14 @@
+package katz
+
+class IOMonoid<A>(val SM: Monoid<A>) : Monoid<HK<IO.F, A>> {


i think you could use IO<A> instead of HK definition here

ffgiraldez · 2017-06-12T06:06:14Z

katz/src/main/kotlin/katz/instances/IOMonoid.kt

+package katz
+
+class IOMonoid<A>(val SM: Monoid<A>) : Monoid<HK<IO.F, A>> {
+    override fun empty(): HK<IO.F, A> =


same here for returning type

ffgiraldez · 2017-06-12T06:08:38Z

katz/src/main/kotlin/katz/effects/IO.kt

+
+    fun <B> flatMap(f: (A) -> IO<B>): IO<B> =
+            flatMapTotal(
+                    AndThen { a: A ->


it's necessary specify the Type here?

JorgeCastilloPrz · 2017-06-12T10:05:00Z

katz/src/main/kotlin/katz/effects/Duration.kt

+
+    companion object {
+        // Actually limited to 9223372036854775807 days, so unless you are very patient, it is unlimited ;-)
+        val Infinite = Duration(amount = Long.MAX_VALUE, timeUnit = TimeUnit.DAYS)


Is the constants naming style capitalized?

raulraja

Looks great but we need to change those methods returning Option in the unsafe* runners.

raulraja · 2017-06-12T12:55:17Z

katz/src/main/kotlin/katz/effects/Duration.kt

@@ -0,0 +1,70 @@
+/**


We should have attribution in files like License or where they belong like we do in the typelevel cats case.

raulraja · 2017-06-12T12:57:32Z

katz/src/main/kotlin/katz/instances/IOSemigroup.kt

@@ -0,0 +1,11 @@
+package katz
+
+class IOSemigroup<A>(val SM: Semigroup<A>) : Semigroup<HK<IO.F, A>> {


should this use default params for the registered instance value if not provided at instantiation?

The companion object has invoke overloaded to provide a default value. n this case IO acts as a wrapper, and the SemiGroup depends mostly on the contents. We could have separate invokes for common types that are not globally registered like numbers and lists.

makes sense

raulraja · 2017-06-12T13:01:29Z

katz/src/main/kotlin/katz/effects/IO.kt

+                }
+            }
+
+    override fun unsafeRunTimedTotal(limit: Duration): Option<A> =


I think returning Option in any of the unsafe methods will be confusing to users. We should return the expected value and since those methods are already unsafe let any exceptions propagate if unfolding the Option returned a NoSuchElementException.

The reason why this return Option is that None represents executing code that returns null. Errors still throw. I don't believe we should stop null-capable execution so we have to choose between returning Option or A?

We've had a chat and decided on the API. unsafeRunTimedTotal returns Option, unsafeRun() returns A.

JorgeCastilloPrz · 2017-06-12T15:10:07Z

katz/src/main/kotlin/katz/effects/Duration.kt

+    }
+}
+
+val Long.days: Duration


interesting way to provide duration out from any numeric types.

It's copypasterino, check the license atop of the file :D

Ok heheheh. Didn't see it.

JorgeCastilloPrz · 2017-06-12T15:16:30Z

katz/src/main/kotlin/katz/effects/internal/AndThen.kt

+package katz.effects.internal
+
+/**
+ * Abandon all hope


Could you add some docs here about the purpose of this class ? I am trying to learn something here and that could be helpful :D

Done in the branch that adds AndThen!

# Conflicts: # reports/baseline.xml

# Conflicts: # kategory/src/main/kotlin/kategory/instances/IdMonad.kt

codecov-io · 2017-07-16T11:52:25Z

Codecov Report

❗ No coverage uploaded for pull request base (master@d1c8aa2). Click here to learn what that means.
The diff coverage is 50.33%.

@@           Coverage Diff            @@
##             master    #109   +/-   ##
========================================
  Coverage          ?   55.2%           
  Complexity        ?     212           
========================================
  Files             ?      86           
  Lines             ?    1317           
  Branches          ?     179           
========================================
  Hits              ?     727           
  Misses            ?     519           
  Partials          ?      71

Impacted Files	Coverage Δ	Complexity Δ
...gory/src/main/kotlin/kategory/instances/IdMonad.kt	`71.42% <ø> (ø)`	`0 <0> (?)`
.../src/main/kotlin/kategory/instances/StateTMonad.kt	`0% <0%> (ø)`	`0 <0> (?)`
.../src/main/kotlin/kategory/instances/IorTraverse.kt	`0% <0%> (ø)`	`0 <0> (?)`
...egory/src/main/kotlin/kategory/effects/Duration.kt	`27.77% <27.77%> (ø)`	`2 <2> (?)`
...src/main/kotlin/kategory/effects/internal/Utils.kt	`45.83% <45.83%> (ø)`	`0 <0> (?)`
kategory/src/main/kotlin/kategory/effects/IO.kt	`55.68% <55.68%> (ø)`	`7 <7> (?)`
...gory/src/main/kotlin/kategory/instances/IOMonad.kt	`57.14% <57.14%> (ø)`	`0 <0> (?)`
...ory/src/main/kotlin/kategory/instances/IOMonoid.kt	`75% <75%> (ø)`	`2 <2> (?)`
.../src/main/kotlin/kategory/instances/IOSemigroup.kt	`75% <75%> (ø)`	`1 <1> (?)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d1c8aa2...f302179. Read the comment docs.

…ng the api (#109)

Media resources should be managed from https://github.com/arrow-kt/arrow-media

Add IO implementation. Add Duration for blocking operations.

3bf359b

pakoito requested review from raulraja, ffgiraldez, JMPergar, jrgonzalezg and JorgeCastilloPrz June 11, 2017 21:23

pakoito added 2 commits June 11, 2017 22:38

Merge branch 'paco-andthentherewereeffects' into paco-ayo

4bcc67a

Fix detekt

6d58185

pakoito added the work in progress label Jun 11, 2017

pakoito added 2 commits June 11, 2017 23:50

Add monad instances. Add initial test suite.

b367986

Reuse IOSemiGroup in IOMonoid

a4d853a

ffgiraldez requested changes Jun 12, 2017

View reviewed changes

pakoito added 2 commits June 12, 2017 10:56

Merge branch 'paco-andthentherewereeffects' into paco-ayo

3ddf2e5

Fix type hinting for AndThen#error

703df14

JorgeCastilloPrz reviewed Jun 12, 2017

View reviewed changes

pakoito added 2 commits June 12, 2017 11:05

Fix type return. Remove unnecessary type hinting.

bf58172

Fix capitalization of constant

9a899be

pakoito mentioned this pull request Jun 12, 2017

Fix StackOverflow in monad instances #108

Closed

raulraja approved these changes Jun 12, 2017

View reviewed changes

JorgeCastilloPrz reviewed Jun 12, 2017

View reviewed changes

pakoito added 7 commits June 12, 2017 21:43

Merge branch 'paco-andthentherewereeffects' into paco-ayo

6e46e3c

# Conflicts: # reports/baseline.xml

Fix detekt

c6ed864

Fix license

0b66997

Fix IO unsafeRunSync API

835d6fe

Add null test

52fc415

Merge branch 'master' into paco-ayo

a4d2965

# Conflicts: # reports/baseline.xml

Merge remote-tracking branch 'origin/master' into paco-ayo

127ca66

# Conflicts: # kategory/src/main/kotlin/kategory/instances/IdMonad.kt

Move IO from katz to kategory

5b28f36

pakoito added 4 commits July 16, 2017 12:53

Fix small warning cleanup

e8cf790

Fix eval constructor

5bed9f1

Add tests for runAsync, unsafeRunAsync, monad laws, monad and binding

d2b3fdc

Add tests for monoid and semigroup

f302179

ffgiraldez approved these changes Jul 16, 2017

View reviewed changes

ffgiraldez merged commit 1f1b1cc into master Jul 16, 2017

ffgiraldez deleted the paco-ayo branch July 16, 2017 14:40

wiyarmir mentioned this pull request Jul 17, 2017

Release 0.3.4 #131

Merged

ambrusadrianz pushed a commit to ambrusadrianz/arrow that referenced this pull request Oct 22, 2019

avoid possible errors due to gens (arrow-kt#109)

8119dc8

rachelcarmena pushed a commit that referenced this pull request Feb 24, 2021

Remove binary-compatibility-validator because is automatically checki…

14f6e94

…ng the api (#109)

rachelcarmena added a commit that referenced this pull request Feb 24, 2021

Remove media template (#109)

6ddead3

Media resources should be managed from https://github.com/arrow-kt/arrow-media

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add IO Monad #109

Add IO Monad #109

pakoito commented Jun 11, 2017

codecov bot commented Jun 11, 2017 •

edited

Loading

pakoito commented Jun 11, 2017

ffgiraldez left a comment

ffgiraldez Jun 12, 2017

ffgiraldez Jun 12, 2017

ffgiraldez Jun 12, 2017

JorgeCastilloPrz Jun 12, 2017

pakoito Jun 12, 2017

raulraja left a comment

raulraja Jun 12, 2017

raulraja Jun 12, 2017

pakoito Jun 12, 2017

raulraja Jun 12, 2017

raulraja Jun 12, 2017

pakoito Jun 12, 2017

pakoito Jun 12, 2017

JorgeCastilloPrz Jun 12, 2017

pakoito Jun 12, 2017

JorgeCastilloPrz Jun 12, 2017

JorgeCastilloPrz Jun 12, 2017

pakoito Jun 12, 2017

codecov-io commented Jul 16, 2017 •

edited

Loading

		@@ -0,0 +1,14 @@
		package katz

		class IOMonoid<A>(val SM: Monoid<A>) : Monoid<HK<IO.F, A>> {

		@@ -0,0 +1,11 @@
		package katz

		class IOSemigroup<A>(val SM: Semigroup<A>) : Semigroup<HK<IO.F, A>> {

Add IO Monad #109

Add IO Monad #109

Conversation

pakoito commented Jun 11, 2017

codecov bot commented Jun 11, 2017 • edited Loading

Codecov Report

pakoito commented Jun 11, 2017

ffgiraldez 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raulraja 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

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Jul 16, 2017 • edited Loading

Codecov Report

codecov bot commented Jun 11, 2017 •

edited

Loading

codecov-io commented Jul 16, 2017 •

edited

Loading