From 500a6ae51d04b141f914e3ae6118443a5bfcf4ef Mon Sep 17 00:00:00 2001
From: AN12345 <malo.leon.1@ens.etsmtl.ca>
Date: Wed, 23 Nov 2022 16:42:25 -0500
Subject: [PATCH] feat(architecture): update usecase en add  &  sepcific case.
 (#38)

---
 .../lib/src/domain/usecases/usecase.dart      | 72 ++++++++++++++++---
 1 file changed, 64 insertions(+), 8 deletions(-)

diff --git a/packages/wyatt_architecture/lib/src/domain/usecases/usecase.dart b/packages/wyatt_architecture/lib/src/domain/usecases/usecase.dart
index 3e2a39f4..ee6a2c26 100644
--- a/packages/wyatt_architecture/lib/src/domain/usecases/usecase.dart
+++ b/packages/wyatt_architecture/lib/src/domain/usecases/usecase.dart
@@ -1,27 +1,83 @@
 // Copyright (C) 2022 WYATT GROUP
 // Please see the AUTHORS file for details.
-// 
+//
 // This program is free software: you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
 // the Free Software Foundation, either version 3 of the License, or
 // any later version.
-// 
+//
 // This program is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 // GNU General Public License for more details.
-// 
+//
 // You should have received a copy of the GNU General Public License
 // along with this program. If not, see <https://www.gnu.org/licenses/>.
 
+import 'dart:async';
+
 import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart';
+import 'package:wyatt_architecture/src/domain/usecases/observers.dart';
 import 'package:wyatt_type_utils/wyatt_type_utils.dart';
 
-typedef FutureResult<T> = Future<Result<T, AppException>>;
+typedef FutureOrResult<T> = FutureOr<Result<T, AppException>>;
 typedef StreamResult<T> = Stream<Result<T, AppException>>;
-typedef Res<T> = Result<T, AppException>;
 
-// ignore: one_member_abstracts
-abstract class UseCase<Parameters, ReturnType> {
-  FutureResult<ReturnType> call(Parameters params);
+/// Abstract class of a use case
+abstract class BaseUseCase<Parameters, ReturnType> {
+  /// Run use case scenarios
+  ReturnType execute(Parameters parameters);
+
+  /// Private function to implement main scenario
+  /// of your usecase.
+  ReturnType call(Parameters params);
+}
+
+/// Abstract class of a use case that deals specifically
+/// with the response and its state.
+abstract class UseCase<Parameters, ReturnType>
+    extends BaseUseCase<Parameters?, FutureOrResult<ReturnType>>
+    with Observer<Parameters, ReturnType> {
+  FutureOr<void> _onSuccess(ReturnType data);
+
+  /// Supports the result of the main scenario and integrates
+  /// some alternative scenarios if necessary.
+  @override
+  FutureOrResult<ReturnType> execute(Parameters? parameters) =>
+      Result.tryCatchAsync(
+        () async {
+          await onStart(parameters);
+          final response = await call(parameters);
+          if (response.isErr) {
+            await onError(response.err);
+          } else if (response.isOk && response.ok != null) {
+            await _onSuccess(response.ok as ReturnType);
+          }
+
+          return response.ok!;
+        },
+        (error) => ClientException(
+          error.toString(),
+        ),
+      );
+}
+
+/// Abtstract classic usecase.
+abstract class AsyncUseCase<Parameters, ReturnType>
+    extends UseCase<Parameters?, ReturnType> with AsyncObserver<ReturnType> {
+  @override
+  FutureOr<void> _onSuccess(ReturnType data) => onComplete(data);
+}
+
+/// Abstract specific usecase bases on streams
+abstract class StreamUseCase<Parameters, ReturnType>
+    extends UseCase<Parameters?, Stream<ReturnType>>
+    with StreamObserver<ReturnType> {
+  @override
+  FutureOr<void> _onSuccess(Stream<ReturnType> data) {
+    data.listen(
+      onData,
+      onDone: onDone,
+    );
+  }
 }