diff --git a/.gitignore b/.gitignore index 892468e..bd19dc2 100644 --- a/.gitignore +++ b/.gitignore @@ -10,3 +10,5 @@ ios/Flutter/Generated.xcconfig ios/Runner/GeneratedPluginRegistrant.* .vscode/ example/coverage/ +example/ios/Flutter/flutter_export_environment.sh +example/ios/Flutter/ephemeral/ diff --git a/CHANGELOG.md b/CHANGELOG.md index b2ed7ea..ec6aef0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [6.2.0] - Thursday, January 29th, 2026 +- Added FutureUseCase/CompletableFutureUseCase for single-shot use cases +- Added Observer.fromCallbacks shortcut for stream and future use cases +- Updated example app and tests to cover FutureUseCase +- Updated dependencies + ## [6.1.0] - Tuesday, October 28th, 2025 - Introduced CLI functionality diff --git a/README.md b/README.md index f765784..c67880c 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Add this to your package's pubspec.yaml file: ```yaml dependencies: - flutter_clean_architecture: ^6.1.0 + flutter_clean_architecture: ^6.2.0 ``` @@ -433,9 +433,6 @@ class LoginPresenter extends clean.Presenter { /// The [Observer] used to observe the `Stream` of the [LoginUseCase] class _LoginUseCaseObserver extends clean.Observer{ - // The above presenter - // This is not optimal, but it is a workaround due to dart limitations. Dart does - // not support inner classes or anonymous classes. final LoginPresenter loginPresenter; _LoginUseCaseObserver(this.loginPresenter); @@ -460,6 +457,19 @@ class _LoginUseCaseObserver extends clean.Observer{ } } +``` +##### Observer shortcuts +Use `Observer.fromCallbacks(...)` to avoid creating an `Observer` class while keeping the same `execute(...)` flow. + +```dart +loginUseCase.execute( + clean.Observer.fromCallbacks( + onNext: (_) => loginOnNext?.call(), + onComplete: () => loginOnComplete?.call(), + onError: (e) => loginOnError?.call(e), + ), + LoginUseCaseParams(email, password), +); ``` #### UseCase ```dart @@ -502,6 +512,34 @@ class LoginUseCaseParams { LoginUseCaseParams(this.email, this.password); } ``` +#### FutureUseCase +For single-shot requests that do not need streams (e.g. login, logout), use `FutureUseCase` +or `CompletableFutureUseCase`. The execution flow and `Observer` callbacks stay the same. + +```dart +import 'package:flutter_clean_architecture/flutter_clean_architecture.dart'; + +class LoginUseCase extends CompletableFutureUseCase { + final AuthenticationRepository _authenticationRepository; + + LoginUseCase(this._authenticationRepository); + + @override + Future buildUseCaseFuture(LoginUseCaseParams? params) async { + await _authenticationRepository.authenticate( + email: params!.email, + password: params.password, + ); + logger.finest('LoginUseCase successful.'); + } +} + +class LoginUseCaseParams { + final String email; + final String password; + LoginUseCaseParams(this.email, this.password); +} +``` ##### Background UseCase A usecase can be made to run on a separate isolate using the `BackgroundUseCase` class. Implementing this kind of usecase is a little different than a regular usecase due to the constraints of an isolate. diff --git a/example/ios/Flutter/flutter_export_environment.sh b/example/ios/Flutter/flutter_export_environment.sh deleted file mode 100755 index a2df82a..0000000 --- a/example/ios/Flutter/flutter_export_environment.sh +++ /dev/null @@ -1,13 +0,0 @@ -#!/bin/sh -# This is a generated file; do not edit or check into version control. -export "FLUTTER_ROOT=/Users/arrrrny/fvm/versions/3.22.2" -export "FLUTTER_APPLICATION_PATH=/Users/arrrrny/Developer/flutter_clean_architecture/example" -export "COCOAPODS_PARALLEL_CODE_SIGN=true" -export "FLUTTER_TARGET=lib/main.dart" -export "FLUTTER_BUILD_DIR=build" -export "FLUTTER_BUILD_NAME=1.0.0" -export "FLUTTER_BUILD_NUMBER=1" -export "DART_OBFUSCATION=false" -export "TRACK_WIDGET_CREATION=true" -export "TREE_SHAKE_ICONS=false" -export "PACKAGE_CONFIG=.dart_tool/package_config.json" diff --git a/example/lib/src/app/pages/home/home_controller.dart b/example/lib/src/app/pages/home/home_controller.dart index 1a38dfb..44bec32 100644 --- a/example/lib/src/app/pages/home/home_controller.dart +++ b/example/lib/src/app/pages/home/home_controller.dart @@ -1,5 +1,6 @@ import './home_presenter.dart'; import '../../../domain/entities/user.dart'; +import '../../../domain/repositories/users_repository.dart'; import 'package:flutter/material.dart'; import 'package:flutter_clean_architecture/flutter_clean_architecture.dart'; @@ -10,7 +11,7 @@ class HomeController extends Controller { User? get user => _user; // data used by the View final HomePresenter homePresenter; // Presenter should always be initialized this way - HomeController(usersRepo) + HomeController(UsersRepository usersRepo) : _counter = 0, homePresenter = HomePresenter(usersRepo), super(); @@ -35,10 +36,29 @@ class HomeController extends Controller { _user = null; refreshUI(); // Refreshes the UI manually }; + + homePresenter.getUserFutureOnNext = (User user) { + logger.log(logger.level, user.toString()); + _user = user; + refreshUI(); // Refreshes the UI manually + }; + homePresenter.getUserFutureOnComplete = () { + logger.log(logger.level, 'User retrieved (FutureUseCase)'); + }; + homePresenter.getUserFutureOnError = (e) { + logger.log(logger.level, 'Could not retrieve user (FutureUseCase).'); + ScaffoldMessenger.of(getContext()) + .showSnackBar(SnackBar(content: Text(e.message))); + _user = null; + refreshUI(); // Refreshes the UI manually + }; } void getUser() => homePresenter.getUser('test-uid'); void getUserwithError() => homePresenter.getUser('test-uid231243'); + void getUserFuture() => homePresenter.getUserFuture('test-uid'); + void getUserFutureWithError() => + homePresenter.getUserFuture('test-uid231243'); void buttonPressed() { _counter++; diff --git a/example/lib/src/app/pages/home/home_presenter.dart b/example/lib/src/app/pages/home/home_presenter.dart index 380c297..8efec98 100644 --- a/example/lib/src/app/pages/home/home_presenter.dart +++ b/example/lib/src/app/pages/home/home_presenter.dart @@ -1,4 +1,6 @@ +import '../../../domain/usecases/get_user_future_usecase.dart'; import '../../../domain/usecases/get_user_usecase.dart'; +import '../../../domain/repositories/users_repository.dart'; import 'package:flutter_clean_architecture/flutter_clean_architecture.dart' as clean; @@ -6,9 +8,15 @@ class HomePresenter extends clean.Presenter { Function? getUserOnNext; Function? getUserOnComplete; Function? getUserOnError; + Function? getUserFutureOnNext; + Function? getUserFutureOnComplete; + Function? getUserFutureOnError; final GetUserUseCase getUserUseCase; - HomePresenter(usersRepo) : getUserUseCase = GetUserUseCase(usersRepo); + final GetUserFutureUseCase getUserFutureUseCase; + HomePresenter(UsersRepository usersRepo) + : getUserUseCase = GetUserUseCase(usersRepo), + getUserFutureUseCase = GetUserFutureUseCase(usersRepo); void getUser(String uid) { // execute getUseruserCase @@ -16,12 +24,23 @@ class HomePresenter extends clean.Presenter { _GetUserUseCaseObserver(this), GetUserUseCaseParams(uid)); } + void getUserFuture(String uid) { + getUserFutureUseCase.execute( + clean.Observer.fromCallbacks( + onNext: (response) => getUserFutureOnNext?.call(response?.user), + onComplete: () => getUserFutureOnComplete?.call(), + onError: (e) => getUserFutureOnError?.call(e), + ), + GetUserFutureUseCaseParams(uid)); + } + @override void dispose() { getUserUseCase.dispose(); } } +// alternative way to implement Observer class _GetUserUseCaseObserver extends clean.Observer { final HomePresenter presenter; _GetUserUseCaseObserver(this.presenter); @@ -31,8 +50,8 @@ class _GetUserUseCaseObserver extends clean.Observer { } @override - void onError(e) { - presenter.getUserOnError?.call(e); + void onError(Object error) { + presenter.getUserOnError?.call(error); } @override diff --git a/example/lib/src/app/pages/home/home_view.dart b/example/lib/src/app/pages/home/home_view.dart index ad44a80..881bce4 100644 --- a/example/lib/src/app/pages/home/home_view.dart +++ b/example/lib/src/app/pages/home/home_view.dart @@ -4,7 +4,7 @@ import 'package:flutter_clean_architecture/flutter_clean_architecture.dart'; import '../../../data/repositories/data_users_repository.dart'; class HomePage extends CleanView { - const HomePage({Key? key, this.title = ""}) : super(key: key); + const HomePage({super.key, this.title = ""}); final String title; @@ -70,6 +70,28 @@ class HomePageState extends CleanViewState { ); }, ), + ControlledWidgetBuilder( + builder: (context, controller) { + return ElevatedButton( + onPressed: controller.getUserFuture, + child: const Text( + 'Get User (FutureUseCase)', + style: TextStyle(color: Colors.white), + ), + ); + }, + ), + ControlledWidgetBuilder( + builder: (context, controller) { + return ElevatedButton( + onPressed: controller.getUserFutureWithError, + child: const Text( + 'Get User Error (FutureUseCase)', + style: TextStyle(color: Colors.white), + ), + ); + }, + ), ], ), ), diff --git a/example/lib/src/domain/usecases/get_user_future_usecase.dart b/example/lib/src/domain/usecases/get_user_future_usecase.dart new file mode 100644 index 0000000..88f10ed --- /dev/null +++ b/example/lib/src/domain/usecases/get_user_future_usecase.dart @@ -0,0 +1,30 @@ +import '../entities/user.dart'; +import '../repositories/users_repository.dart'; +import 'package:flutter_clean_architecture/flutter_clean_architecture.dart'; + +class GetUserFutureUseCase extends FutureUseCase { + final UsersRepository usersRepository; + GetUserFutureUseCase(this.usersRepository); + + @override + Future buildUseCaseFuture( + GetUserFutureUseCaseParams? params) async { + // get user + final user = await usersRepository.getUser(params!.uid); + logger.finest('GetUserFutureUseCase successful.'); + return GetUserFutureUseCaseResponse(user); + } +} + +/// Wrapping params inside an object makes it easier to change later +class GetUserFutureUseCaseParams { + final String uid; + GetUserFutureUseCaseParams(this.uid); +} + +/// Wrapping response inside an object makes it easier to change later +class GetUserFutureUseCaseResponse { + final User user; + GetUserFutureUseCaseResponse(this.user); +} diff --git a/example/pubspec.lock b/example/pubspec.lock index b4ca951..0614eeb 100644 --- a/example/pubspec.lock +++ b/example/pubspec.lock @@ -21,10 +21,10 @@ packages: dependency: transitive description: name: args - sha256: "7cf60b9f0cc88203c5a190b4cd62a99feea42759a7fa695010eb5de1c0b2252a" + sha256: d0481093c50b1da8910eb0bb301626d4d8eb7284aa739614d2b394ee09e3ea04 url: "https://pub.dev" source: hosted - version: "2.5.0" + version: "2.7.0" async: dependency: transitive description: @@ -69,18 +69,18 @@ packages: dependency: transitive description: name: characters - sha256: "04a925763edad70e8443c99234dc3328f442e811f1d8fd1a72f1c8ad0f69a605" + sha256: f71061c654a3380576a52b451dd5532377954cf9dbd272a78fc8479606670803 url: "https://pub.dev" source: hosted - version: "1.3.0" + version: "1.4.0" clock: dependency: transitive description: name: clock - sha256: cb6d7f03e1de671e34607e909a7213e31d7752be4fb66a86d29fe1eb14bfb5cf + sha256: fddb70d9b5277016c77a80201021d40a2247104d9f4aa7bab7157b7e3f05b84b url: "https://pub.dev" source: hosted - version: "1.1.1" + version: "1.1.2" code_builder: dependency: transitive description: @@ -93,10 +93,10 @@ packages: dependency: transitive description: name: collection - sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a + sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76" url: "https://pub.dev" source: hosted - version: "1.18.0" + version: "1.19.1" convert: dependency: transitive description: @@ -133,10 +133,10 @@ packages: dependency: transitive description: name: fake_async - sha256: "511392330127add0b769b75a987850d136345d9227c6b94c96a04cf4a391bf78" + sha256: "5368f224a74523e8d2e7399ea1638b37aecfca824a3cc4dfdf77bf1fa905ac44" url: "https://pub.dev" source: hosted - version: "1.3.1" + version: "1.3.3" file: dependency: transitive description: @@ -164,15 +164,15 @@ packages: path: ".." relative: true source: path - version: "6.0.0" + version: "6.2.0" flutter_lints: dependency: "direct dev" description: name: flutter_lints - sha256: a25a15ebbdfc33ab1cd26c63a6ee519df92338a9c10f122adda92938253bef04 + sha256: "9e8c3858111da373efc5aa341de011d9bd23e2c5c5e0c62bccf32438e192d7b1" url: "https://pub.dev" source: hosted - version: "2.0.3" + version: "3.0.2" flutter_test: dependency: "direct dev" description: flutter @@ -190,66 +190,66 @@ packages: dependency: transitive description: name: leak_tracker - sha256: "7f0df31977cb2c0b88585095d168e689669a2cc9b97c309665e3386f3e9d341a" + sha256: "33e2e26bdd85a0112ec15400c8cbffea70d0f9c3407491f672a2fad47915e2de" url: "https://pub.dev" source: hosted - version: "10.0.4" + version: "11.0.2" leak_tracker_flutter_testing: dependency: transitive description: name: leak_tracker_flutter_testing - sha256: "06e98f569d004c1315b991ded39924b21af84cf14cc94791b8aea337d25b57f8" + sha256: "1dbc140bb5a23c75ea9c4811222756104fbcd1a27173f0c34ca01e16bea473c1" url: "https://pub.dev" source: hosted - version: "3.0.3" + version: "3.0.10" leak_tracker_testing: dependency: transitive description: name: leak_tracker_testing - sha256: "6ba465d5d76e67ddf503e1161d1f4a6bc42306f9d66ca1e8f079a47290fb06d3" + sha256: "8d5a2d49f4a66b49744b23b018848400d23e54caf9463f4eb20df3eb8acb2eb1" url: "https://pub.dev" source: hosted - version: "3.0.1" + version: "3.0.2" lints: dependency: transitive description: name: lints - sha256: "0a217c6c989d21039f1498c3ed9f3ed71b354e69873f13a8dfc3c9fe76f1b452" + sha256: cbf8d4b858bb0134ef3ef87841abdf8d63bfc255c266b7bf6b39daa1085c4290 url: "https://pub.dev" source: hosted - version: "2.1.1" + version: "3.0.0" logging: dependency: transitive description: name: logging - sha256: "623a88c9594aa774443aa3eb2d41807a48486b5613e67599fb4c41c0ad47c340" + sha256: c8245ada5f1717ed44271ed1c26b8ce85ca3228fd2ffdb75468ab01979309d61 url: "https://pub.dev" source: hosted - version: "1.2.0" + version: "1.3.0" matcher: dependency: transitive description: name: matcher - sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb + sha256: dc58c723c3c24bf8d3e2d3ad3f2f9d7bd9cf43ec6feaa64181775e60190153f2 url: "https://pub.dev" source: hosted - version: "0.12.16+1" + version: "0.12.17" material_color_utilities: dependency: transitive description: name: material_color_utilities - sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a" + sha256: f7142bb1154231d7ea5f96bc7bde4bda2a0945d2806bb11670e30b850d56bdec url: "https://pub.dev" source: hosted - version: "0.8.0" + version: "0.11.1" meta: dependency: transitive description: name: meta - sha256: "7687075e408b093f36e6bbf6c91878cc0d4cd10f409506f7bc996f68220b9136" + sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c url: "https://pub.dev" source: hosted - version: "1.12.0" + version: "1.16.0" mockito: dependency: "direct main" description: @@ -278,18 +278,18 @@ packages: dependency: transitive description: name: path - sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af" + sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5" url: "https://pub.dev" source: hosted - version: "1.9.0" + version: "1.9.1" provider: dependency: transitive description: name: provider - sha256: c8a055ee5ce3fd98d6fc872478b03823ffdb448699c6ebdbbc71d59b596fd48c + sha256: "4e82183fa20e5ca25703ead7e05de9e4cceed1fbd1eadc1ac3cb6f565a09f272" url: "https://pub.dev" source: hosted - version: "6.1.2" + version: "6.1.5+1" pub_semver: dependency: transitive description: @@ -302,23 +302,23 @@ packages: dependency: transitive description: name: responsive_builder - sha256: f01bc341c73b6db7bd6319e22d2c160f28f924399ae46e6699ecc8160ba2765c + sha256: "64a5ef3fbe3628e4588a0c2391c3186300e76f58621d8135cc77aac816255a3e" url: "https://pub.dev" source: hosted - version: "0.4.3" + version: "0.7.1" rxdart: dependency: transitive description: name: rxdart - sha256: "0c7c0cedd93788d996e33041ffecda924cc54389199cde4e6a34b440f50044cb" + sha256: "5c3004a4a8dbb94bd4bf5412a4def4acdaa12e12f269737a5751369e12d1a962" url: "https://pub.dev" source: hosted - version: "0.27.7" + version: "0.28.0" sky_engine: dependency: transitive description: flutter source: sdk - version: "0.0.99" + version: "0.0.0" source_gen: dependency: transitive description: @@ -339,18 +339,18 @@ packages: dependency: transitive description: name: stack_trace - sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b" + sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1" url: "https://pub.dev" source: hosted - version: "1.11.1" + version: "1.12.1" stream_channel: dependency: transitive description: name: stream_channel - sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7 + sha256: "969e04c80b8bcdf826f8f16579c7b14d780458bd97f56d107d3950fdbeef059d" url: "https://pub.dev" source: hosted - version: "2.1.2" + version: "2.1.4" string_scanner: dependency: transitive description: @@ -371,10 +371,10 @@ packages: dependency: transitive description: name: test_api - sha256: "9955ae474176f7ac8ee4e989dadfb411a58c30415bcfb648fa04b2b8a03afa7f" + sha256: "522f00f556e73044315fa4585ec3270f1808a4b186c936e612cab0b565ff1e00" url: "https://pub.dev" source: hosted - version: "0.7.0" + version: "0.7.6" typed_data: dependency: transitive description: @@ -387,10 +387,10 @@ packages: dependency: transitive description: name: vector_math - sha256: "80b3257d1492ce4d091729e3a67a60407d227c27241d6927be0130c98e741803" + sha256: d530bd74fea330e6e364cda7a85019c434070188383e1cd8d9777ee586914c5b url: "https://pub.dev" source: hosted - version: "2.1.4" + version: "2.2.0" vm_service: dependency: transitive description: @@ -416,5 +416,5 @@ packages: source: hosted version: "3.1.2" sdks: - dart: ">=3.3.0 <4.0.0" + dart: ">=3.8.0-0 <4.0.0" flutter: ">=3.18.0-18.0.pre.54" diff --git a/example/pubspec.yaml b/example/pubspec.yaml index 96f20fc..7b132f8 100644 --- a/example/pubspec.yaml +++ b/example/pubspec.yaml @@ -31,7 +31,7 @@ dependencies: dev_dependencies: flutter_test: sdk: flutter - flutter_lints: ^2.0.1 + flutter_lints: ^3.0.1 # For information on the generic Dart part of this file, see the # following page: https://www.dartlang.org/tools/pub/pubspec diff --git a/example/test/src/app/pages/home/home_view_test.dart b/example/test/src/app/pages/home/home_view_test.dart index 0a65b35..44223b3 100644 --- a/example/test/src/app/pages/home/home_view_test.dart +++ b/example/test/src/app/pages/home/home_view_test.dart @@ -30,7 +30,7 @@ void main() { }); testWidgets( - 'Given Get User Button when click then display John Smith, 18 text', + 'Given Get User Error Button when click then display No element text', (tester) async { await tester.pumpWidget(const MaterialApp( home: HomePage(key: Key('homePage'), title: 'Flutter Demo Home Page'), @@ -42,6 +42,34 @@ void main() { expect(counterFinder, findsOneWidget); }); + testWidgets( + 'Given Get User (FutureUseCase) Button when click then display John Smith, 18 text', + (tester) async { + await tester.pumpWidget(const MaterialApp( + home: HomePage(key: Key('homePage'), title: 'Flutter Demo Home Page'), + )); + expect(find.byKey(const Key('homePage')), findsOneWidget); + await tester + .tap(find.widgetWithText(ElevatedButton, 'Get User (FutureUseCase)')); + await tester.pump(); + var counterFinder = find.text('John Smith, 18'); + expect(counterFinder, findsOneWidget); + }); + + testWidgets( + 'Given Get User Error (FutureUseCase) Button when click then display No element text', + (tester) async { + await tester.pumpWidget(const MaterialApp( + home: HomePage(key: Key('homePage'), title: 'Flutter Demo Home Page'), + )); + expect(find.byKey(const Key('homePage')), findsOneWidget); + await tester.tap( + find.widgetWithText(ElevatedButton, 'Get User Error (FutureUseCase)')); + await tester.pump(); + var counterFinder = find.text('No element'); + expect(counterFinder, findsOneWidget); + }); + testWidgets('Trigger Reassemble', (tester) async { await tester.pumpWidget(const MaterialApp( home: HomePage(key: Key('homePage'), title: 'Flutter Demo Home Page'), diff --git a/example/test/src/app/widgets/button_test.dart b/example/test/src/app/widgets/button_test.dart index d50145d..138213a 100644 --- a/example/test/src/app/widgets/button_test.dart +++ b/example/test/src/app/widgets/button_test.dart @@ -27,9 +27,7 @@ void main() { } class TestPage extends clean.CleanView { - const TestPage({ - Key? key, - }) : super(key: key); + const TestPage({super.key}); @override TestPageState createState() => TestPageState(); diff --git a/example/test/src/domain/usecases/get_user_usecase_test.dart b/example/test/src/domain/usecases/get_user_usecase_test.dart index c0ea503..fa53393 100644 --- a/example/test/src/domain/usecases/get_user_usecase_test.dart +++ b/example/test/src/domain/usecases/get_user_usecase_test.dart @@ -1,4 +1,5 @@ import 'package:example/src/domain/usecases/get_user_usecase.dart'; +import 'package:example/src/domain/usecases/get_user_future_usecase.dart'; import 'package:flutter_test/flutter_test.dart'; import 'package:mockito/mockito.dart'; import 'package:example/src/domain/repositories/users_repository.dart'; @@ -42,6 +43,32 @@ void main() { } expect(observer.status['result'], 'failed'); }); + + test( + 'Given getUserFutureUseCase when Parameters user UUID does exist return successfull', + () async { + GetUserFutureUseCase getUserFutureUseCase; + _FutureObserver observer; + getUserFutureUseCase = GetUserFutureUseCase(MockGetUser()); + observer = _FutureObserver(); + await getUserFutureUseCase.execute( + observer, GetUserFutureUseCaseParams('1000-2000-5600')); + expect(observer.status['result'], 'success'); + expect(observer.status['done'], true); + }); + + test( + 'Given getUserFutureUseCase when Parameters user UUID does not exist return failed', + () async { + GetUserFutureUseCase getUserFutureUseCase; + _FutureObserver observer; + getUserFutureUseCase = GetUserFutureUseCase(MockGetUser()); + observer = _FutureObserver(); + await getUserFutureUseCase.execute( + observer, GetUserFutureUseCaseParams('22222')); + expect(observer.status['result'], 'failed'); + expect(observer.status['done'], false); + }); } class _Observer implements Observer { @@ -63,6 +90,25 @@ class _Observer implements Observer { } } +class _FutureObserver implements Observer { + final status = {'result': '', 'done': false}; + @override + void onNext(response) { + expect(GetUserFutureUseCaseResponse, response.runtimeType); + status['result'] = 'success'; + } + + @override + void onComplete() { + status['done'] = true; + } + + @override + void onError(e) { + status['result'] = 'failed'; + } +} + class MockGetUser extends Mock implements UsersRepository { List users = []; diff --git a/lib/flutter_clean_architecture.dart b/lib/flutter_clean_architecture.dart index 13d4257..4479ed6 100644 --- a/lib/flutter_clean_architecture.dart +++ b/lib/flutter_clean_architecture.dart @@ -1,5 +1,3 @@ -library flutter_clean_architecture; - import 'package:flutter/material.dart'; import 'package:flutter_clean_architecture/src/controller.dart'; import 'package:logging/logging.dart'; diff --git a/lib/src/cli.dart b/lib/src/cli.dart index 3dbbfb5..d7215ef 100644 --- a/lib/src/cli.dart +++ b/lib/src/cli.dart @@ -1,24 +1,17 @@ -/// Flutter Clean Architecture CLI Tool -/// -/// This file contains the command-line interface for the Flutter Clean Architecture package. -/// It provides developers with a convenient way to scaffold Clean Architecture components -/// in their Flutter projects, following Uncle Bob's Clean Architecture principles. -/// -/// The CLI supports two main operations: -/// 1. Creating the default Clean Architecture folder structure -/// 2. Generating individual pages with their associated Controller, Presenter, and View files -/// -/// ## Usage Examples: -/// ```bash -/// # Create default architecture folders -/// flutter pub run flutter_clean_architecture:cli create -/// -/// # Create a specific page -/// flutter pub run flutter_clean_architecture:cli create --page user_profile -/// -/// # Show help -/// flutter pub run flutter_clean_architecture:cli --help -/// ``` +// Flutter Clean Architecture CLI Tool +// +// This file contains the command-line interface for the Flutter Clean Architecture package. +// It provides developers with a convenient way to scaffold Clean Architecture components +// in their Flutter projects, following Uncle Bob's Clean Architecture principles. +// +// The CLI supports two main operations: +// 1. Creating the default Clean Architecture folder structure +// 2. Generating individual pages with their associated Controller, Presenter, and View files +// +// Usage examples: +// - flutter pub run flutter_clean_architecture:cli create +// - flutter pub run flutter_clean_architecture:cli create --page user_profile +// - flutter pub run flutter_clean_architecture:cli --help import 'dart:io'; diff --git a/lib/src/observer.dart b/lib/src/observer.dart index f2ccf6a..1afafb6 100644 --- a/lib/src/observer.dart +++ b/lib/src/observer.dart @@ -66,7 +66,44 @@ /// } /// ``` abstract class Observer { + Observer(); + + factory Observer.fromCallbacks({ + void Function(T? response)? onNext, + void Function()? onComplete, + void Function(Object error)? onError, + }) = _CallbackObserver; + void onNext(T? response); void onComplete(); - void onError(e); + void onError(Object error); +} + +class _CallbackObserver implements Observer { + final void Function(T? response)? _onNext; + final void Function()? _onComplete; + final void Function(Object error)? _onError; + + _CallbackObserver({ + void Function(T? response)? onNext, + void Function()? onComplete, + void Function(Object error)? onError, + }) : _onNext = onNext, + _onComplete = onComplete, + _onError = onError; + + @override + void onNext(T? response) { + _onNext?.call(response); + } + + @override + void onComplete() { + _onComplete?.call(); + } + + @override + void onError(Object error) { + _onError?.call(error); + } } diff --git a/lib/src/usecase.dart b/lib/src/usecase.dart index 47fc65d..0b37160 100644 --- a/lib/src/usecase.dart +++ b/lib/src/usecase.dart @@ -165,3 +165,36 @@ abstract class CompletableUseCase extends UseCase { @override Future> buildUseCaseStream(Params? params); } + +/// A streamlined [UseCase] for single-shot requests that don't need streams. +/// It executes a single [Future] and maps the result to [Observer] callbacks. +abstract class FutureUseCase { + late Logger _logger; + Logger get logger => _logger; + + FutureUseCase() { + _logger = Logger(runtimeType.toString()); + } + + /// Builds the [Future] to be awaited. [Params] is required by the [UseCase] + /// to retrieve the appropriate data from the repository. + Future buildUseCaseFuture(Params? params); + + /// Executes a single-shot use case and triggers [Observer] callbacks. + Future execute(Observer observer, [Params? params]) async { + try { + final result = await buildUseCaseFuture(params); + observer.onNext(result); + observer.onComplete(); + } catch (e) { + observer.onError(e); + } + } +} + +/// A streamlined [UseCase] that performs a task without returning a value. +abstract class CompletableFutureUseCase + extends FutureUseCase { + @override + Future buildUseCaseFuture(Params? params); +} diff --git a/lib/src/view.dart b/lib/src/view.dart index 91e86ac..991b969 100644 --- a/lib/src/view.dart +++ b/lib/src/view.dart @@ -56,9 +56,9 @@ typedef ViewBuilder = Widget Function(BuildContext context); /// ``` /// /// You can optionally set globally new default values for breakpoints. To do so, just check on [FlutterCleanArchitecture.setDefaultViewBreakpoints] -abstract class ResponsiveViewState extends CleanViewState { - ResponsiveViewState(Con controller) : super(controller); +abstract class ResponsiveViewState extends CleanViewState { + ResponsiveViewState(super.controller); /// To be implemented by the developer which will build on [Watch ViewPort]. /// The default breakpoint value is less than [300] @@ -126,8 +126,8 @@ abstract class ResponsiveViewState - extends State { +abstract class CleanViewState extends State { final GlobalKey> globalKey = GlobalKey>(); final Con _controller; @@ -137,7 +137,7 @@ abstract class CleanViewState /// Implement the [Widget] you want to be displayed on [CleanView] Widget get view; - CleanViewState(this._controller) { + CleanViewState(Con controller) : _controller = controller { _controller.initController(globalKey); WidgetsBinding?.instance // ignore: invalid_null_aware_operator .addObserver(_controller); // ignore:unnecessary_non_null_assertion diff --git a/pubspec.lock b/pubspec.lock index 8b70954..21b2387 100644 --- a/pubspec.lock +++ b/pubspec.lock @@ -66,10 +66,10 @@ packages: dependency: "direct dev" description: name: flutter_lints - sha256: a25a15ebbdfc33ab1cd26c63a6ee519df92338a9c10f122adda92938253bef04 + sha256: "9e8c3858111da373efc5aa341de011d9bd23e2c5c5e0c62bccf32438e192d7b1" url: "https://pub.dev" source: hosted - version: "2.0.3" + version: "3.0.2" flutter_test: dependency: "direct dev" description: flutter @@ -103,18 +103,18 @@ packages: dependency: transitive description: name: lints - sha256: "0a217c6c989d21039f1498c3ed9f3ed71b354e69873f13a8dfc3c9fe76f1b452" + sha256: cbf8d4b858bb0134ef3ef87841abdf8d63bfc255c266b7bf6b39daa1085c4290 url: "https://pub.dev" source: hosted - version: "2.1.1" + version: "3.0.0" logging: dependency: "direct main" description: name: logging - sha256: "623a88c9594aa774443aa3eb2d41807a48486b5613e67599fb4c41c0ad47c340" + sha256: c8245ada5f1717ed44271ed1c26b8ce85ca3228fd2ffdb75468ab01979309d61 url: "https://pub.dev" source: hosted - version: "1.2.0" + version: "1.3.0" matcher: dependency: transitive description: @@ -159,18 +159,18 @@ packages: dependency: "direct main" description: name: provider - sha256: c8a055ee5ce3fd98d6fc872478b03823ffdb448699c6ebdbbc71d59b596fd48c + sha256: "4e82183fa20e5ca25703ead7e05de9e4cceed1fbd1eadc1ac3cb6f565a09f272" url: "https://pub.dev" source: hosted - version: "6.1.2" + version: "6.1.5+1" responsive_builder: dependency: "direct main" description: name: responsive_builder - sha256: f01bc341c73b6db7bd6319e22d2c160f28f924399ae46e6699ecc8160ba2765c + sha256: "64a5ef3fbe3628e4588a0c2391c3186300e76f58621d8135cc77aac816255a3e" url: "https://pub.dev" source: hosted - version: "0.4.3" + version: "0.7.1" rxdart: dependency: "direct main" description: diff --git a/pubspec.yaml b/pubspec.yaml index 0d1a9ee..ca35639 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: flutter_clean_architecture description: A Flutter package that implements the Clean Architecture by Uncle Bob in Flutter. It provides Views, Controllers, Presenters, Observers, and UseCases. -version: 6.1.0 +version: 6.2.0 homepage: https://github.com/ShadyBoukhary/flutter_clean_architecture environment: @@ -10,13 +10,13 @@ dependencies: flutter: sdk: flutter args: ^2.7.0 - logging: ^1.0.0 - meta: ^1.3.0 - provider: ^6.1.2 - responsive_builder: ^0.4.1 + logging: ^1.3.0 + meta: ^1.12.0 + provider: ^6.1.5+1 + responsive_builder: ^0.7.1 rxdart: ^0.28.0 dev_dependencies: flutter_test: sdk: flutter - flutter_lints: ^2.0.1 + flutter_lints: ^3.0.1 diff --git a/test/usecase_test.dart b/test/usecase_test.dart index 185a206..09bd23a 100644 --- a/test/usecase_test.dart +++ b/test/usecase_test.dart @@ -33,6 +33,22 @@ void main() { expect(observer.error, false); }); }); + + test('FutureUseCase onNext and onDone.', () async { + var observer = FutureUseCaseObserver(); + await SuccessFutureUseCase().execute(observer); + expect(observer.value, 42); + expect(observer.done, true); + expect(observer.error, false); + }); + + test('FutureUseCase .onError.', () async { + var observer = FutureUseCaseObserver(); + await ErrorFutureUseCase().execute(observer); + expect(observer.value, null); + expect(observer.done, false); + expect(observer.error, true); + }); }); } @@ -70,3 +86,38 @@ class CounterUseCaseObserver extends Observer { expect(number, this.number); } } + +class SuccessFutureUseCase extends FutureUseCase { + @override + Future buildUseCaseFuture(void params) async { + return 42; + } +} + +class ErrorFutureUseCase extends FutureUseCase { + @override + Future buildUseCaseFuture(void params) async { + throw Error(); + } +} + +class FutureUseCaseObserver extends Observer { + int? value; + bool done = false; + bool error = false; + + @override + void onComplete() { + done = true; + } + + @override + void onError(e) { + error = true; + } + + @override + void onNext(int? response) { + value = response; + } +}