-
Notifications
You must be signed in to change notification settings - Fork 6
/
covariant.scala
462 lines (399 loc) · 15.4 KB
/
covariant.scala
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
package com.thoughtworks.raii
import com.thoughtworks.raii.covariant.{Releasable, ResourceT, opacityTypes}
import scala.language.higherKinds
import scalaz.Tags.Parallel
import scalaz.{\/, _}
import scalaz.syntax.all._
private[raii] sealed abstract class CovariantResourceTInstances3 {
/** @group Type classes */
implicit def covariantResourceTApplicative[F[+ _]: Applicative]: Applicative[ResourceT[F, ?]] =
new CovariantResourceTApplicative[F] {
override private[raii] def typeClass = implicitly
}
}
private[raii] sealed abstract class CovariantResourceTInstances2 extends CovariantResourceTInstances3 {
/** @group Type classes */
implicit def covariantResourceTMonad[F[+ _]: Monad]: Monad[ResourceT[F, ?]] = new CovariantResourceTMonad[F] {
private[raii] override def typeClass = implicitly
}
}
private[raii] sealed abstract class CovariantResourceTInstances1 extends CovariantResourceTInstances2 {
/** @group Type classes */
implicit def covariantResourceTNondeterminism[F[+ _]](
implicit F0: Nondeterminism[F]): Nondeterminism[ResourceT[F, ?]] =
new CovariantResourceTNondeterminism[F] {
private[raii] override def typeClass = implicitly
}
}
private[raii] sealed abstract class CovariantResourceTInstances0 extends CovariantResourceTInstances1 {
/** @group Type classes */
implicit def covariantResourceTMonadError[F[+ _], S](implicit F0: MonadError[F, S]): MonadError[ResourceT[F, ?], S] =
new CovariantResourceTMonadError[F, S] {
private[raii] override def typeClass = implicitly
}
}
private[raii] trait CovariantResourceTPoint[F[+ _]] extends Applicative[ResourceT[F, ?]] {
private[raii] implicit def typeClass: Applicative[F]
override def point[A](a: => A): ResourceT[F, A] =
opacityTypes.apply(Applicative[F].point(Releasable.now(a)))
}
import com.thoughtworks.raii.covariant.opacityTypes.unwrap
private[raii] trait CovariantResourceTApplicative[F[+ _]]
extends Applicative[ResourceT[F, ?]]
with CovariantResourceTPoint[F] {
override def ap[A, B](fa: => ResourceT[F, A])(f: => ResourceT[F, (A) => B]): ResourceT[F, B] = {
opacityTypes.apply(
Applicative[F].apply2(unwrap(fa), unwrap(f)) { (releasableA, releasableF) =>
val releaseA = releasableA.release
new Releasable[F, B] {
override val value: B = releasableF.value(releasableA.value)
override val release: F[Unit] = {
Applicative[F].apply2(releaseA, releasableF.release) { (_: Unit, _: Unit) =>
()
}
}
}
}
)
}
}
private[raii] trait CovariantResourceTParallelApplicative[F[+ _]]
extends Applicative[Lambda[A => ResourceT[F, A] @@ Parallel]] {
private[raii] implicit def typeClass: Applicative[Lambda[A => F[A] @@ Parallel]]
override def map[A, B](pfa: ResourceT[F, A] @@ Parallel)(f: (A) => B): ResourceT[F, B] @@ Parallel = {
val Parallel(ResourceT(fa)) = pfa
val Parallel(fb) = typeClass.map(Parallel(fa)) { releasableA: Releasable[F, A] =>
val releasableB: Releasable[F, B] = new Releasable[F, B] {
override val value: B = f(releasableA.value)
override val release = releasableA.release
}
releasableB
}
Parallel(ResourceT(fb))
}
override def point[A](a: => A): ResourceT[F, A] @@ Parallel = {
Parallel({
val fa: F[Releasable[F, A]] = Parallel.unwrap[F[Releasable[F, A]]](
typeClass.point(
new Releasable[F, A] {
override val value: A = a
override val release: F[Unit] = Parallel.unwrap(typeClass.point(()))
}
))
opacityTypes.apply(fa)
}: ResourceT[F, A])
}
override def ap[A, B](fa: => ResourceT[F, A] @@ Parallel)(
f: => ResourceT[F, A => B] @@ Parallel): ResourceT[F, B] @@ Parallel = {
Parallel {
opacityTypes.apply(
Parallel.unwrap[F[Releasable[F, B]]](
typeClass.apply2(
Parallel(unwrap(Parallel.unwrap(fa))),
Parallel(unwrap(Parallel.unwrap(f)))
) { (resourceA, resourceF) =>
val valueB = resourceF.value(resourceA.value)
val releaseA = resourceA.release
val releaseF = resourceF.release
new Releasable[F, B] {
override val value: B = valueB
override val release: F[Unit] = {
Parallel.unwrap[F[Unit]](typeClass.apply2(Parallel(releaseA), Parallel(releaseF)) {
(_: Unit, _: Unit) =>
()
})
}
}
}
)
)
}
}
}
private[raii] trait CovariantResourceTMonad[F[+ _]]
extends CovariantResourceTApplicative[F]
with Monad[ResourceT[F, ?]] {
private[raii] implicit override def typeClass: Monad[F]
override def bind[A, B](fa: ResourceT[F, A])(f: (A) => ResourceT[F, B]): ResourceT[F, B] = {
opacityTypes.apply(
for {
releasableA <- unwrap(fa)
releasableB <- unwrap(f(releasableA.value))
} yield {
val b = releasableB.value
val releaseB = releasableB.release
val releaseA = releasableA.release
new Releasable[F, B] {
override def value: B = b
override val release: F[Unit] = {
releaseB >> releaseA
}
}
}
)
}
}
private[raii] trait CovariantResourceTMonadError[F[+ _], S]
extends MonadError[ResourceT[F, ?], S]
with CovariantResourceTPoint[F] {
import covariant.catchError
private[raii] implicit def typeClass: MonadError[F, S]
override def raiseError[A](e: S): ResourceT[F, A] =
opacityTypes.apply(typeClass.raiseError[Releasable[F, A]](e))
override def handleError[A](fa: ResourceT[F, A])(f: (S) => ResourceT[F, A]): ResourceT[F, A] = {
opacityTypes.apply(
unwrap(fa).handleError { s =>
unwrap(f(s))
}
)
}
override def bind[A, B](fa: ResourceT[F, A])(f: A => ResourceT[F, B]): ResourceT[F, B] = {
opacityTypes.apply(
catchError(unwrap(fa)).flatMap {
case \/-(releasableA) =>
catchError(unwrap(f(releasableA.value))).flatMap[Releasable[F, B]] {
case \/-(releasableB) =>
val wrappedReleasableB: Releasable[F, B] = new Releasable[F, B] {
override val value: B = releasableB.value
override val release: F[Unit] = {
catchError(releasableB.release).flatMap {
case \/-(()) =>
releasableA.release
case -\/(s) =>
releasableA.release.flatMap { _ =>
typeClass.raiseError[Unit](s)
}
}
}
}
wrappedReleasableB.point[F]
case -\/(s) =>
releasableA.release.flatMap { _ =>
typeClass.raiseError[Releasable[F, B]](s)
}
}
case either @ -\/(s) =>
typeClass.raiseError[Releasable[F, B]](s)
}
)
}
}
private[raii] trait CovariantResourceTNondeterminism[F[+ _]]
extends CovariantResourceTMonad[F]
with Nondeterminism[ResourceT[F, ?]] {
private[raii] implicit override def typeClass: Nondeterminism[F]
override def chooseAny[A](head: ResourceT[F, A],
tail: Seq[ResourceT[F, A]]): ResourceT[F, (A, Seq[ResourceT[F, A]])] = {
opacityTypes.apply(
typeClass.chooseAny(unwrap(head), tail.map(unwrap)).map {
case (fa, residuals) =>
new Releasable[F, (A, Seq[ResourceT[F, A]])] {
override val value: (A, Seq[ResourceT[F, A]]) =
(fa.value, residuals.map { residual: F[Releasable[F, A]] =>
opacityTypes.apply[F, A](residual)
})
override val release: F[Unit] = fa.release
}
}
)
}
}
/** The namespace that contains the covariant [[ResourceT]].
*
* Usage:
* {{{
* import com.thoughtworks.raii.covariant._
* }}}
*/
object covariant extends CovariantResourceTInstances0 {
/** The type-level [[http://en.cppreference.com/w/cpp/language/pimpl Pimpl]]
* in order to prevent the Scala compiler seeing the actual type of [[ResourceT]]
*
* @note For internal usage only.
*/
val opacityTypes: OpacityTypes = new OpacityTypes {
override type ResourceT[F[+ _], +A] = F[Releasable[F, A]]
override def apply[F[+ _], A](run: F[Releasable[F, A]]): ResourceT[F, A] = run
override def unwrap[F[+ _], A](resourceT: ResourceT[F, A]): F[Releasable[F, A]] =
resourceT
}
/** The data structure that provides automatic resource management.
*
* @example `ResourceT` can be used as a monad transformer for [[scalaz.Name]]
*
* {{{
* import scalaz.Name
* import com.thoughtworks.raii.covariant._
* type RAII[A] = ResourceT[Name, A]
* }}}
*
* Given a resource that creates temporary files
*
* {{{
* import java.io.File
* val resource: RAII[File] = ResourceT(Name(new Releasable[Name, File] {
* override val value: File = File.createTempFile("test", ".tmp");
* override val release: Name[Unit] = Name {
* val isDeleted = value.delete()
* }
* }))
* }}}
*
* when using temporary file created by `resouce` in a `for` / `yield` block,
* those temporary files should be available.
*
* {{{
* import scalaz.syntax.all._
* val usingResouce = for {
* tmpFile1 <- resource
* tmpFile2 <- resource
* } yield {
* tmpFile1 shouldNot be(tmpFile2)
* tmpFile1 should exist
* tmpFile2 should exist
* (tmpFile1, tmpFile2)
* }
* }}}
*
* and those files should have been deleted after the `for` / `yield` block.
*
* {{{
* val (tmpFile1, tmpFile2) = usingResouce.run.value
* tmpFile1 shouldNot exist
* tmpFile2 shouldNot exist
* }}}
*
* @note This `ResourceT` type is an opacity alias to `F[Releasable[F, A]]`.
* All type classes and helper functions for this `ResourceT` type are defined in the companion object [[ResourceT$ ResourceT]]
* @template
*/
type ResourceT[F[+ _], +A] = opacityTypes.ResourceT[F, A]
import opacityTypes._
/** A container of a [[value]] and a function to [[release]] the `value`.
* @tparam A the type of [[value]]
* @tparam F the monadic type of [[release]]
*/
trait Releasable[F[+ _], +A] {
def value: A
/** Releases [[value]] and all resource dependencies during creating [[value]].
*
* @note After [[release]], [[value]] should not be used if:
* - [[value]] is a scoped native resource,
* e.g. this [[Releasable]] is created from [[com.thoughtworks.raii.asynchronous.Do.scoped[Value<:AutoCloseable](value:=>Value)* scoped]],
* - or, [[value]] internally references some scoped native resources.
*/
def release: F[Unit]
}
private[raii] object Releasable {
@inline
def now[F[+ _]: Applicative, A](value0: A): Releasable[F, A] = {
new Releasable[F, A] {
override val value: A = value0
override val release: F[Unit] = Applicative[F].point(())
}
}
}
private[raii] trait OpacityTypes {
type ResourceT[F[+ _], +A]
private[raii] def apply[F[+ _], A](run: F[Releasable[F, A]]): ResourceT[F, A]
private[raii] def unwrap[F[+ _], A](resourceT: ResourceT[F, A]): F[Releasable[F, A]]
}
/** The companion object of [[ResourceT]] that contains converters and type classes.
*
* @note There are some implicit method that provides [[scalaz.Monad]]s as monad transformers of `F`.
* Those monads running will collect all resources,
* which will be open and release altogether when [[run]] is called.
*/
object ResourceT {
/** @group Converters */
def apply[F[+ _], A](run: F[Releasable[F, A]]): ResourceT[F, A] = opacityTypes.apply(run)
/** @group Converters */
def unapply[F[+ _], A](resourceT: ResourceT[F, A]): Some[F[Releasable[F, A]]] =
Some(unwrap(resourceT))
}
/** @group Type classes */
implicit def covariantResourceTParallelApplicative[F[+ _]](
implicit F0: Applicative[Lambda[A => F[A] @@ Parallel]]
): Applicative[Lambda[A => ResourceT[F, A] @@ Parallel]] = {
new CovariantResourceTParallelApplicative[F] {
override private[raii] implicit def typeClass = F0
}
}
private[raii] final def using[F[+ _], A, B](resourceT: ResourceT[F, A], f: A => F[B])(implicit monad: Bind[F]): F[B] = {
unwrap(resourceT).flatMap { fa =>
f(fa.value).flatMap { a: B =>
fa.release.map { _ =>
a
}
}
}
}
private[raii] final def foreach[F[+ _], A](resourceT: ResourceT[F, A], f: A => Unit)(implicit monad: Bind[F],
foldable: Foldable[F]): Unit = {
unwrap(resourceT)
.flatMap { fa =>
f(fa.value)
fa.release
}
.sequence_[Id.Id, Unit]
}
private[raii] def catchError[F[+ _]: MonadError[?[_], S], S, A](fa: F[A]): F[S \/ A] = {
fa.map(_.right[S]).handleError(_.left[A].point[F])
}
implicit final class CovariantResourceTOps[F[+ _], A](resourceT: ResourceT[F, A]) {
/** Returns a `F` that performs the following process:
*
* - Creating a [[Releasable]] for `A`
* - Closing the [[Releasable]]
* - Returning `A`
*/
def run(implicit monad: Bind[F]): F[A] = {
unwrap(resourceT).flatMap { resource: Releasable[F, A] =>
val value = resource.value
resource.release.map { _ =>
value
}
}
}
/** Returns a resource of `B` based on a resource of `A` and a function that creates `B`,
* for those `B` do not reference to `A` or `A` is a garbage collected object.
*
* @note `intransitiveMap` is to `map` in [[resourceTMonad]],
* except `intransitiveMap` will release `A` right after `B` is created.
*
* Don't use this method if you need to retain `A` until `B` is released.
*/
def intransitiveMap[B](f: A => B)(implicit monad: Monad[F]): ResourceT[F, B] = {
opacityTypes.apply(
unwrap(resourceT).flatMap { releasableA =>
val b = f(releasableA.value)
releasableA.release.map { _ =>
new Releasable[F, B] {
override val value: B = b
override val release: F[Unit] = {
().point[F]
}
}
}
}
)
}
/** Returns a resource of `B` based on a resource of `A` and a function that creates resource of `B`,
* for those `B` do not reference to `A` or `A` is a garbage collected object.
*
* @note `intransitiveFlatMap` is similar to `flatMap` in [[resourceTMonad]],
* except `intransitiveFlatMap` will release `A` right after `B` is created.
*
* Don't use this method if you need to retain `A` until `B` is released.
*/
def intransitiveFlatMap[B](f: A => ResourceT[F, B])(implicit bind: Bind[F]): ResourceT[F, B] = {
opacityTypes.apply(
for {
releasableA <- unwrap(resourceT)
releasableB <- unwrap(f(releasableA.value))
_ <- releasableA.release
} yield releasableB
)
}
}
}