From bed477ad8660cd670e9ddd534f522eb4b6af17c5 Mon Sep 17 00:00:00 2001
From: SandroMaglione <lass.maglio@gmail.com>
Date: Sat, 30 Mar 2024 06:22:30 +0900
Subject: [PATCH] introduce `Scope`

---
 packages/fpdart/lib/src/effect.dart           | 28 ++++++++++++
 .../lib/src/extension/iterable_extension.dart |  4 ++
 packages/fpdart/lib/src/scope.dart            | 44 +++++++++++++++++++
 3 files changed, 76 insertions(+)
 create mode 100644 packages/fpdart/lib/src/scope.dart

diff --git a/packages/fpdart/lib/src/effect.dart b/packages/fpdart/lib/src/effect.dart
index afced12..cb23690 100644
--- a/packages/fpdart/lib/src/effect.dart
+++ b/packages/fpdart/lib/src/effect.dart
@@ -10,6 +10,7 @@ part 'context.dart';
 part 'deferred.dart';
 part 'either.dart';
 part 'option.dart';
+part 'scope.dart';
 
 typedef EffectGen<E, L> = ({
   FutureOr<A> Function<A>(IEffect<E, L, A>) async,
@@ -160,6 +161,10 @@ final class Effect<E, L, R> extends IEffect<E, L, R> {
         (_) => f().then(Right.new),
       );
 
+  /// {@category constructors}
+  factory Effect.lazy(Effect<E, L, R> Function() effect) =>
+      Effect.from((context) => effect().__unsafeRun(context));
+
   /// {@category constructors}
   factory Effect.fail(L value) => Effect.from((_) => Left(Failure(value)));
 
@@ -480,6 +485,15 @@ final class Effect<E, L, R> extends IEffect<E, L, R> {
   Effect<E, L, R> race(Effect<E, L, R> effect) =>
       Effect.raceAll([this, effect]);
 
+  /// {@category sequencing}
+  Effect<E, L, R> alwaysIgnore<C>(Effect<E, L, C> effect) => Effect.from(
+        (context) => race(context.signal.wait()).__unsafeRun(context).then(
+              (exit) => effect.__unsafeRun(context.withoutSignal).then(
+                    (_) => exit,
+                  ),
+            ),
+      );
+
   /// {@category sequencing}
   Effect<E, L, C> flatMap<C>(Effect<E, L, C> Function(R r) f) => Effect.from(
         (context) => _unsafeRun(context).then(
@@ -632,6 +646,20 @@ final class Effect<E, L, R> extends IEffect<E, L, R> {
 
   /// {@category interruption}
   Effect<E, Never, R> interrupt() => Effect.failCause(const Interrupted());
+
+  /// {@category scoping}
+  Effect<Scope<E>, L, R> get scopedEnv => Effect.from(
+        (context) => __unsafeRun(context.withEnv(context.env.env)),
+      );
+}
+
+extension EffectWithScope<E, L, R> on Effect<Scope<E>, L, R> {
+  Effect<E, L, R> get scoped => Effect.from((context) {
+        final scope = Scope.withEnv(context.env);
+        return alwaysIgnore(scope.closeScope()).__unsafeRun(
+          context.withEnv(scope),
+        );
+      });
 }
 
 extension ProvideNull<L, R> on Effect<Null, L, R> {
diff --git a/packages/fpdart/lib/src/extension/iterable_extension.dart b/packages/fpdart/lib/src/extension/iterable_extension.dart
index cf215e4..240ae25 100644
--- a/packages/fpdart/lib/src/extension/iterable_extension.dart
+++ b/packages/fpdart/lib/src/extension/iterable_extension.dart
@@ -411,6 +411,10 @@ extension FpdartOnIterableOfIterable<T> on Iterable<Iterable<T>> {
   Iterable<T> get flatten => expand(identity);
 }
 
+extension IterableEffect<E, L, R> on Iterable<Effect<E, L, R>> {
+  Effect<E, L, Iterable<R>> get all => Effect.all(this);
+}
+
 extension FpdartSequenceIterableOption<R> on Iterable<Option<R>> {
   Iterable<R> get getSomes => Option.getSomes(this);
 }
diff --git a/packages/fpdart/lib/src/scope.dart b/packages/fpdart/lib/src/scope.dart
new file mode 100644
index 0000000..bbf637c
--- /dev/null
+++ b/packages/fpdart/lib/src/scope.dart
@@ -0,0 +1,44 @@
+part of "effect.dart";
+
+mixin ScopeMixin {
+  bool get scopeClosable => false;
+
+  final scopeFinalizers = <Effect<Null, Never, Unit>>[];
+
+  Effect<E, L, Unit> addScopeFinalizer<E, L>(
+    Effect<Null, Never, Unit> finalizer,
+  ) =>
+      Effect.functionSucceed(() {
+        scopeFinalizers.add(finalizer);
+        return unit;
+      });
+
+  Effect<E, L, Unit> removeScopeFinalizer<L, E>(
+    Effect<Null, Never, Unit> finalizer,
+  ) =>
+      Effect.functionSucceed(() {
+        scopeFinalizers.remove(finalizer);
+        return unit;
+      });
+
+  Effect<E, L, Unit> closeScope<E, L>() => Effect.lazy(
+        () => scopeFinalizers.reversed.all.zipRight(Effect.functionSucceed(
+          () {
+            scopeFinalizers.clear();
+            return unit;
+          },
+        )).withEnv(),
+      );
+}
+
+class Scope<R> with ScopeMixin {
+  final bool _closable;
+  final R env;
+  Scope._(this.env, this._closable);
+
+  factory Scope.withEnv(R env, [bool closable = false]) =>
+      Scope._(env, closable);
+
+  @override
+  bool get scopeClosable => _closable;
+}