Merge pull request #37 from leancodepl/add-with-empty-cubits-and-hooks

Add cubits and hooks with empty

Author: pdenert

packages/leancode_cubit_utils_cqrs/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0
+
+* Add:
+    - `SimpleQueryWithEmptyCubit`
+    - `useQueryWithEmptyCubit`
+    - `SimpleArgsQueryWithEmptyCubit`
+    - `useArgsQueryWithEmptyCubit`
+
 ## 0.1.0
 
 * Extract cqrs support from the `leancode_cubit_utils` package.

packages/leancode_cubit_utils_cqrs/lib/src/request/query_cubit.dart

@@ -9,8 +9,13 @@ mixin QueryResultHandler<TRes, TOut>
     QueryResult<TRes> result,
   ) async {
     if (result case QuerySuccess(:final data)) {
+      final mappedData = map(data);
+      if (isEmpty(mappedData)) {
+        logger.warning('Query success but data is empty');
+        return RequestEmptyState();
+      }
       logger.info('Query success. Data: $data');
-      return RequestSuccessState(map(data));
+      return RequestSuccessState(mappedData);
     } else if (result case QueryFailure(:final error)) {
       logger.severe('Query error. Error: $error');
       try {

packages/leancode_cubit_utils_cqrs/lib/src/request/use_query_cubit.dart

@@ -30,6 +30,7 @@ SimpleQueryCubit<TOut> useQueryCubit<TOut>(
   RequestMode? requestMode,
   bool callOnCreate = true,
   List<Object?> keys = const [],
+  EmptyChecker<TOut>? isEmpty,
 }) {
   return useBloc(
     () {
@@ -47,6 +48,61 @@ SimpleQueryCubit<TOut> useQueryCubit<TOut>(
   );
 }
 
+/// Simplified implementation of [QueryCubit] created in order to be used by [useQueryCubit].
+/// Differ from [SimpleQueryCubit] because it uses a custom function to check if the data is empty.
+class SimpleQueryWithEmptyCubit<TOut> extends QueryCubit<TOut, TOut> {
+  /// Creates a new [SimpleQueryWithEmptyCubit].
+  SimpleQueryWithEmptyCubit(
+    super.loggerTag,
+    this._customRequest,
+    this._isEmpty, {
+    super.requestMode,
+  });
+
+  /// The request to be executed.
+  final Request<QueryResult<TOut>> _customRequest;
+
+  /// The function to check if the data is empty.
+  final EmptyChecker<TOut> _isEmpty;
+
+  @override
+  Future<QueryResult<TOut>> request() => _customRequest();
+
+  @override
+  TOut map(TOut data) => data;
+
+  @override
+  bool isEmpty(TOut data) => _isEmpty(data);
+}
+
+/// Provides a [QueryCubit] specialized for [QueryResult] that is automatically disposed without having
+/// to use BlocProvider and does not require any arguments. It is a wrapper of [useBloc] that creates a [SimpleQueryWithEmptyCubit].
+/// Differ from [useQueryCubit] because it uses a custom function to check if the data is empty.
+SimpleQueryWithEmptyCubit<TOut> useQueryWithEmptyCubit<TOut>(
+  Request<QueryResult<TOut>> request,
+  EmptyChecker<TOut> isEmpty, {
+  String loggerTag = 'SimpleQueryWithEmptyCubit',
+  RequestMode? requestMode,
+  bool callOnCreate = true,
+  List<Object?> keys = const [],
+}) {
+  return useBloc(
+    () {
+      final cubit = SimpleQueryWithEmptyCubit<TOut>(
+        loggerTag,
+        request,
+        isEmpty,
+        requestMode: requestMode,
+      );
+      if (callOnCreate) {
+        cubit.run();
+      }
+      return cubit;
+    },
+    keys,
+  );
+}
+
 /// Simplified implementation of [ArgsQueryCubit] created in order to be used by [useArgsQueryCubit].
 class SimpleArgsQueryCubit<TArgs, TOut>
     extends ArgsQueryCubit<TArgs, TOut, TOut> {
@@ -84,3 +140,53 @@ SimpleArgsQueryCubit<TArgs, TOut> useArgsQueryCubit<TArgs, TOut>(
     keys,
   );
 }
+
+/// Simplified implementation of [ArgsQueryCubit] created in order to be used by [useArgsQueryCubit].
+/// Differ from [SimpleArgsQueryCubit] because it uses a custom function to check if the data is empty.
+class SimpleArgsQueryWithEmptyCubit<TArgs, TOut>
+    extends ArgsQueryCubit<TArgs, TOut, TOut> {
+  /// Creates a new [SimpleArgsQueryWithEmptyCubit].
+  SimpleArgsQueryWithEmptyCubit(
+    super.loggerTag,
+    this._customRequest,
+    this._isEmpty, {
+    super.requestMode,
+  });
+
+  /// The request to be executed.
+  final ArgsRequest<TArgs, QueryResult<TOut>> _customRequest;
+
+  /// The function to check if the data is empty.
+  final EmptyChecker<TOut> _isEmpty;
+
+  @override
+  Future<QueryResult<TOut>> request(TArgs args) => _customRequest(args);
+
+  @override
+  TOut map(TOut data) => data;
+
+  @override
+  bool isEmpty(TOut data) => _isEmpty(data);
+}
+
+/// Provides a [ArgsQueryCubit] specialized for [QueryResult] that is automatically disposed without having
+/// to use BlocProvider and requires arguments. It is a wrapper of [useBloc] that creates a [SimpleArgsQueryWithEmptyCubit].
+/// Differ from [useArgsQueryCubit] because it uses a custom function to check if the data is empty.
+SimpleArgsQueryWithEmptyCubit<TArgs, TOut>
+    useArgsQueryWithEmptyCubit<TArgs, TOut>(
+  ArgsRequest<TArgs, QueryResult<TOut>> request,
+  EmptyChecker<TOut> isEmpty, {
+  String loggerTag = 'SimpleArgsQueryWithEmptyCubit',
+  RequestMode? requestMode,
+  List<Object?> keys = const [],
+}) {
+  return useBloc(
+    () => SimpleArgsQueryWithEmptyCubit<TArgs, TOut>(
+      loggerTag,
+      request,
+      isEmpty,
+      requestMode: requestMode,
+    ),
+    keys,
+  );
+}

packages/leancode_cubit_utils_cqrs/pubspec.yaml

@@ -1,6 +1,6 @@
 name: leancode_cubit_utils_cqrs
 description: An extension of leancode_cubit_utils that provides cqrs support.
-version: 0.1.0
+version: 0.2.0
 repository: https://github.com/leancodepl/leancode_cubit_utils
 
 environment:
@@ -12,7 +12,7 @@ dependencies:
   flutter:
     sdk: flutter
   flutter_bloc: ^8.0.0
-  leancode_cubit_utils: ^0.1.0
+  leancode_cubit_utils: ^0.2.0
   leancode_hooks: ^0.0.6
 
 dev_dependencies: