Wyatt-FOSS/wyatt-packages
6
2
Fork 0
Code Issues 20 Pull Requests 4 Actions Packages Projects Releases Activity

refactor(wyatt_architecture): upgrade usecases to add NoParams

Browse Source
This commit is contained in:
hugo
2024-02-18 22:49:11 +01:00
parent 41382aad2f
commit 59bca9045e
31 changed files with 220 additions and 385 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/wyatt_architecture/lib/src/core/core.dart
+2
View File
@@ -15,3 +15,5 @@
// along with this program. If not, see <https://www.gnu.org/licenses/>.
export 'exceptions/exceptions.dart';
export 'extensions/object_extension.dart';
export 'mixins/observers.dart';
packages/wyatt_architecture/lib/src/core/exceptions/exceptions.dart
+1 -3
View File
@@ -14,8 +14,6 @@
// 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 'package:wyatt_type_utils/wyatt_type_utils.dart';
/// {@template app_exception}
/// [AppException] is a base class for all exceptions in the wyatt architecture.
/// {@endtemplate}
@@ -27,7 +25,7 @@ abstract class AppException implements Exception {
@override
String toString() {
if (message.isNotNullOrEmpty) {
if (message?.isNotEmpty ?? false) {
return '$runtimeType: $message';
} else {
return '$runtimeType: An exception occured';
packages/wyatt_architecture/lib/src/domain/data_sources/data_sources.dart → packages/wyatt_architecture/lib/src/core/extensions/object_extension.dart
+8 -4
View File
@@ -1,4 +1,4 @@
// Copyright (C) 2022 WYATT GROUP
// Copyright (C) 2024 WYATT GROUP
// Please see the AUTHORS file for details.
//
// This program is free software: you can redistribute it and/or modify
@@ -14,6 +14,10 @@
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
export 'base_data_source.dart';
export 'local/local.dart';
export 'remote/remote.dart';
import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart';
extension ObjectExtension on Object? {
AppException toException() => this is AppException
? this! as AppException
: ClientException(this?.toString());
}
packages/wyatt_architecture/lib/src/domain/usecases/observers.dart → packages/wyatt_architecture/lib/src/core/mixins/observers.dart
+15 -19
View File
@@ -1,4 +1,4 @@
// Copyright (C) 2022 WYATT GROUP
// Copyright (C) 2024 WYATT GROUP
// Please see the AUTHORS file for details.
//
// This program is free software: you can redistribute it and/or modify
@@ -16,30 +16,26 @@
import 'dart:async';
import 'package:wyatt_architecture/wyatt_architecture.dart';
import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart';
import 'package:wyatt_architecture/src/domain/usecase.dart';
/// Usecase observers
mixin Observer<Parameters, ReturnType> {
mixin Observer<I, O> {
/// Called before usecase is runned.
/// Useful to check the preconditions
FutureOr<void> onStart(Parameters? params) {}
/// Called when error occures during main scenario
/// Useful to run alternative scenario
FutureOr<void> onError(AppException? error) {}
FutureOr<void> onStart(I? params) {}
}
/// Specific observer for classic usecase
mixin AsyncObserver<ReturnType> {
/// Called when usecase is completed
FutureOr<void> onComplete(ReturnType? data) {}
/// Exception observer
mixin ExceptionObserver<O> {
/// Called on error
/// Useful to handle exceptions
FutureOr<void> onError(AppException e) {}
}
/// Specific observer for stream case usecase
mixin StreamObserver<ReturnType> {
/// Replaces the data event handler of this subscription.
void onDone() {}
/// Replaces the done event handler of this subscription.
void onData(ReturnType? data) {}
/// Completer observer
mixin CompleterObserver<O> {
/// Called after usecase is runned.
/// Useful to log the result
FutureOr<void> onComplete(Res<O>? result) {}
}
packages/wyatt_architecture/lib/src/domain/data_sources/base_data_source.dart → packages/wyatt_architecture/lib/src/data/base_data_source.dart
+1 -1
View File
@@ -1,4 +1,4 @@
// Copyright (C) 2022 WYATT GROUP
// Copyright (C) 2024 WYATT GROUP
// Please see the AUTHORS file for details.
//
// This program is free software: you can redistribute it and/or modify
packages/wyatt_architecture/lib/src/domain/repositories/base_repository.dart → packages/wyatt_architecture/lib/src/domain/base_repository.dart
View File
packages/wyatt_architecture/lib/src/domain/data_sources/local/base_local_data_source.dart
-26
View File
@@ -1,26 +0,0 @@
// 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 'package:wyatt_architecture/src/domain/data_sources/base_data_source.dart';
/// {@template base_local_data_source}
/// [BaseLocalDataSource] is a base class for all local data sources in the
/// wyatt architecture.
/// {@endtemplate}
abstract class BaseLocalDataSource extends BaseDataSource {
/// {@macro base_local_data_source}
const BaseLocalDataSource();
}
packages/wyatt_architecture/lib/src/domain/data_sources/local/local.dart
-17
View File
@@ -1,17 +0,0 @@
// 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/>.
export 'base_local_data_source.dart';
packages/wyatt_architecture/lib/src/domain/data_sources/remote/base_remote_data_source.dart
-26
View File
@@ -1,26 +0,0 @@
// 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 'package:wyatt_architecture/src/domain/data_sources/base_data_source.dart';
/// {@template base_remote_data_source}
/// [BaseRemoteDataSource] is a base class for all remote data sources in the
/// wyatt architecture.
/// {@endtemplate}
abstract class BaseRemoteDataSource extends BaseDataSource {
/// {@macro base_remote_data_source}
const BaseRemoteDataSource();
}
packages/wyatt_architecture/lib/src/domain/data_sources/remote/remote.dart
-17
View File
@@ -1,17 +0,0 @@
// 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/>.
export 'base_remote_data_source.dart';
packages/wyatt_architecture/lib/src/domain/domain.dart
+7 -8
View File
@@ -1,20 +1,19 @@
// Copyright (C) 2022 WYATT GROUP
// Copyright (C) 2024 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/>.
export 'data_sources/data_sources.dart';
export 'entities/entities.dart';
export 'repositories/repositories.dart';
export 'usecases/usecases.dart';
export 'base_repository.dart';
export 'entity.dart';
export 'usecase.dart';
packages/wyatt_architecture/lib/src/domain/entities/entities.dart
-17
View File
@@ -1,17 +0,0 @@
// 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/>.
export 'entity.dart';
packages/wyatt_architecture/lib/src/domain/entities/entity.dart → packages/wyatt_architecture/lib/src/domain/entity.dart
View File
packages/wyatt_architecture/lib/src/domain/repositories/repositories.dart
-17
View File
@@ -1,17 +0,0 @@
// 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/>.
export 'base_repository.dart';
packages/wyatt_architecture/lib/src/domain/usecase.dart
+153
View File
@@ -0,0 +1,153 @@
// 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:generic_usecase/generic_usecase.dart' as generic;
import 'package:wyatt_architecture/src/core/exceptions/exceptions.dart';
import 'package:wyatt_architecture/src/core/extensions/object_extension.dart';
import 'package:wyatt_architecture/src/core/mixins/observers.dart';
import 'package:wyatt_type_utils/wyatt_type_utils.dart';
typedef Res<T> = Result<T, AppException>;
typedef FutureOrResult<T> = FutureOr<Res<T>>;
typedef StreamResult<T> = Stream<Res<T>>;
/// A wrapper around [Result] to make it easier to use with AppException.
Future<Res<T>> unsafe<T>(FutureOr<T> Function() fn) =>
Result.tryCatchAsync<T, AppException, Object>(
() => Future.sync(fn),
(e) => e.toException(),
);
abstract class AsyncUseCase<I, O> extends generic.Usecase<I, Res<O>>
with Observer<I, O>, ExceptionObserver<O>, CompleterObserver<O> {
const AsyncUseCase() : super();
@override
FutureOr<generic.ConditionsResult> checkPreconditions(I? params) async {
try {
await onStart(params);
return generic.ConditionsResult(isValid: true);
} catch (e) {
return generic.ConditionsResult(isValid: false, message: e.toString());
}
}
@override
FutureOr<generic.ConditionsResult> checkPostconditions(Res<O>? result) async {
try {
await onComplete(result);
return generic.ConditionsResult(isValid: true);
} catch (e) {
return generic.ConditionsResult(isValid: false, message: e.toString());
}
}
@override
FutureOrResult<O> onException(Object e) async {
final exception = e.toException();
await onError(exception);
return Err(exception);
}
}
abstract class NoParamsAsyncUseCase<O> extends generic.NoParamsUsecase<Res<O>>
with ExceptionObserver<O>, CompleterObserver<O> {
const NoParamsAsyncUseCase() : super();
@override
FutureOr<generic.ConditionsResult> checkPostconditions(Res<O>? result) async {
try {
await onComplete(result);
return generic.ConditionsResult(isValid: true);
} catch (e) {
return generic.ConditionsResult(isValid: false, message: e.toString());
}
}
@override
FutureOrResult<O> onException(Object e) async {
final exception = e.toException();
await onError(exception);
return Err(exception);
}
}
abstract class StreamUseCase<I, O> extends generic.StreamUsecase<I, Res<O>>
with Observer<I, O>, ExceptionObserver<O> {
const StreamUseCase() : super();
@override
FutureOr<generic.ConditionsResult> checkPreconditions(I? params) async {
try {
await onStart(params);
return generic.ConditionsResult(isValid: true);
} catch (e) {
return generic.ConditionsResult(isValid: false, message: e.toString());
}
}
StreamSubscription<Res<O>> listen(
I params,
void Function(Res<O>)? onData, {
Function? onError,
void Function()? onDone,
bool? cancelOnError,
}) =>
super.call(params).listen(
onData,
onError: onError,
onDone: onDone,
cancelOnError: cancelOnError,
);
@override
FutureOrResult<O> onException(Object e) async {
final exception = e.toException();
await onError(exception);
return Err(exception);
}
}
abstract class NoParamsStreamUseCase<O>
extends generic.NoParamsStreamUsecase<Res<O>> with ExceptionObserver<O> {
const NoParamsStreamUseCase() : super();
StreamSubscription<Res<O>> listen(
void Function(Res<O>)? onData, {
Function? onError,
void Function()? onDone,
bool? cancelOnError,
}) =>
super.call().listen(
onData,
onError: onError,
onDone: onDone,
cancelOnError: cancelOnError,
);
@override
FutureOrResult<O> onException(Object e) async {
final exception = e.toException();
await onError(exception);
return Err(exception);
}
}
packages/wyatt_architecture/lib/src/domain/usecases/no_param.dart
-26
View File
@@ -1,26 +0,0 @@
// 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 'package:wyatt_architecture/src/domain/entities/entity.dart';
/// {@template no_param}
/// [NoParam] is a class that is used when a use case does not require any
/// parameters.
/// {@endtemplate}
class NoParam extends Entity {
/// {@macro no_param}
const NoParam();
}
packages/wyatt_architecture/lib/src/domain/usecases/usecase.dart
-100
View File
@@ -1,100 +0,0 @@
// 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 FutureOrResult<T> = FutureOr<Result<T, AppException>>;
typedef StreamResult<T> = Stream<Result<T, AppException>>;
/// {@template base_usecase}
/// Abstract class of any use case.
/// {@endtemplate}
abstract class BaseUseCase<Parameters, ReturnType> {
/// {@macro base_usecase}
const BaseUseCase();
/// Run use case scenarios
ReturnType call(Parameters parameters);
/// Private function to implement main scenario
/// of your usecase.
ReturnType execute(Parameters params);
}
/// {@template usecase}
/// Abstract class of a use case that deals specifically
/// with the response and its state.
/// {@endtemplate}
abstract class UseCase<Parameters, ReturnType>
extends BaseUseCase<Parameters?, FutureOrResult<ReturnType>>
with Observer<Parameters, ReturnType> {
/// {@macro usecase}
const UseCase();
FutureOr<void> _onSuccess(ReturnType data);
/// Supports the result of the main scenario and integrates
/// some alternative scenarios if necessary.
@override
FutureOrResult<ReturnType> call(Parameters? parameters) async {
try {
await onStart(parameters);
final response = await execute(parameters);
if (response.isErr) {
await onError(response.err);
} else if (response.isOk && response.ok != null) {
await _onSuccess(response.ok as ReturnType);
}
return response;
} catch (e) {
return Err(ClientException(e.toString()));
}
}
}
/// {@template async_usecase}
/// Abtstract classic usecase bases on futures
/// {@endtemplate}
abstract class AsyncUseCase<Parameters, ReturnType>
extends UseCase<Parameters?, ReturnType> with AsyncObserver<ReturnType> {
/// {@macro async_usecase}
const AsyncUseCase();
@override
FutureOr<void> _onSuccess(ReturnType data) => onComplete(data);
}
/// {@template stream_usecase}
/// Abstract specific usecase bases on streams
/// {@endtemplate}
abstract class StreamUseCase<Parameters, ReturnType>
extends UseCase<Parameters?, Stream<ReturnType>>
with StreamObserver<ReturnType> {
/// {@macro stream_usecase}
const StreamUseCase();
@override
FutureOr<void> _onSuccess(Stream<ReturnType> data) {
data.listen(
onData,
onDone: onDone,
);
}
}
packages/wyatt_architecture/lib/src/domain/usecases/usecases.dart
-19
View File
@@ -1,19 +0,0 @@
// 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/>.
export 'no_param.dart';
export 'observers.dart';
export 'usecase.dart';
packages/wyatt_architecture/lib/src/src.dart
+1
View File
@@ -15,4 +15,5 @@
// along with this program. If not, see <https://www.gnu.org/licenses/>.
export 'core/core.dart';
export 'data/base_data_source.dart';
export 'domain/domain.dart';