Improve http example

packages/leancode_cubit_utils/README.md

@@ -19,14 +19,46 @@ Implementation of cubits for handling [CQRS](https://pub.dev/packages/cqrs) quer
 
 ## Single Request Utils
 
+### `handleResult`
+
+`handleResult` is a client-specific method needed for handling the API response. It can be defined once and used repeatedly as a mixin.
+
+```dart
+mixin HandleResult<TOut>
+    on RequestCubit<http.Response, String, TOut, int> {
+  @override
+  // In this method we check the request's state
+  // and return the result on success or call handleError on failure.
+  Future<RequestState<TOut, int>> handleResult(
+    http.Response result,
+  ) async {
+    if (result.statusCode == 200) {
+      logger.info('Request success. Data: ${result.body}');
+      return RequestSuccessState(map(result.body));
+    } else {
+      logger.severe('Request error. Status code: ${result.statusCode}');
+      try {
+        return await handleError(RequestErrorState(error: result.statusCode));
+      } catch (e, s) {
+        logger.severe(
+          'Processing error failed. Exception: $e. Stack trace: $s',
+        );
+        return RequestErrorState(exception: e, stackTrace: s);
+      }
+    }
+  }
+}
+```
+
 ### `RequestCubit`
 
 `RequestCubit` is used to execute a single API request. Example implementation of RequestCubit looks like this:
 
 ```dart
 // RequestCubit has four generic arguments: TRes, TData, TOut and TError. TRes specifies what the request returns, TData specifies what is kept in TRes as response body, TOut determines which model we want to emit as data in the state, TError defines error's type.
 class ProjectDetailsCubit
-    extends RequestCubit<http.Response, String, ProjectDetailsDTO, int> {
+    extends RequestCubit<http.Response, String, ProjectDetailsDTO, int>
+    with HandleResult {
   ProjectDetailsCubit({
     required this.client,
     required this.id,
@@ -46,27 +78,6 @@ class ProjectDetailsCubit
   Future<http.Response> request() {
     return client.get(Uri.parse('base-url/$id'));
   }
-
-  @override
-  // In this method we check the request's state
-  // and return the result on success or call handleError on failure.
-  Future<RequestState<ProjectDetailsDTO, int>> handleResult(
-      http.Response result) async {
-    if (result.statusCode == 200) {
-      logger.info('Request success. Data: ${result.body}');
-      return RequestSuccessState(map(result.body));
-    } else {
-      logger.severe('Request error. Status code: ${result.statusCode}');
-      try {
-        return await handleError(RequestErrorState(error: result.statusCode));
-      } catch (e, s) {
-        logger.severe(
-          'Processing error failed. Exception: $e. Stack trace: $s',
-        );
-        return RequestErrorState(exception: e, stackTrace: s);
-      }
-    }
-  }
 }
 ```
 
@@ -262,36 +273,22 @@ In case you need a search functionality you may use the built in support in `Pag
 You can configure search debounce time and number of characters which needs to be inserted to start searching. In order to do it read about [Paginated Cubit Configuration](#paginated-cubit-configuration).
 
 ### Pre-request
+
 Pre-requests allow you to perform an operation before making a request for the first page. This could be, for example, fetching available filters.
 
-#### `PreRequest`
+#### `run`
 
-`PreRequest` is a class that serves as an implementation of a pre-request. To utilize it, create a class that extends `PreRequest`.
+`run` is a client-specific method that performs the pre-request and returns the new state. It can be defined once and used repeatedly as a mixin.
 
 ```dart
-class FiltersPreRequest
-    extends PreRequest<http.Response, String, Filters, User> {
-  FiltersPreRequest({required this.api});
-
-  final Api api;
-
-  @override
-  Future<http.Response> request(PaginatedState<Filters, User> state) {
-    return api.getFilters();
-  }
-
+mixin Run<TData, TItem>
+    on PreRequest<http.Response, String, TData, TItem> {
   @override
-  Filters map(
-    String res,
-    PaginatedState<Filters, User> state,
-  ) =>
-      Filters.fromJson(jsonDecode(res) as Map<String, dynamic>);
-
-  @override
-  Future<PaginatedState<Filters, User>> run(
-      PaginatedState<Filters, User> state) async {
+  Future<PaginatedState<TData, TItem>> run(
+      PaginatedState<TData, TItem> state) async {
     try {
       final result = await request(state);
+
       if (result.statusCode == 200) {
         return state.copyWith(
           data: map(result.body, state),
@@ -315,6 +312,31 @@ class FiltersPreRequest
 }
 ```
 
+#### `PreRequest`
+
+`PreRequest` is a class that serves as an implementation of a pre-request. To utilize it, create a class that extends `PreRequest`.
+
+```dart
+class FiltersPreRequest extends PreRequest<http.Response, String, Filters, User>
+    with Run {
+  FiltersPreRequest({required this.api});
+
+  final Api api;
+
+  @override
+  Future<http.Response> request(PaginatedState<Filters, User> state) {
+    return api.getFilters();
+  }
+
+  @override
+  Filters map(
+    String res,
+    PaginatedState<Filters, User> state,
+  ) =>
+      Filters.fromJson(jsonDecode(res) as Map<String, dynamic>);
+}
+```
+
 Then you need to create an instance of defined `FiltersPreRequest` in `PaginatedCubit` constructor.
 
 

packages/leancode_cubit_utils/example/lib/pages/common.dart

@@ -0,0 +1,59 @@
+import 'package:example/http/status_codes.dart';
+import 'package:http/http.dart' as http;
+import 'package:leancode_cubit_utils/leancode_cubit_utils.dart';
+
+/// [PreRequestRun] and [RequestHandleResult] can be used repeatedly
+/// in cubits handling http.
+
+mixin PreRequestRun<TData, TItem>
+    on PreRequest<http.Response, String, TData, TItem> {
+  @override
+  Future<PaginatedState<TData, TItem>> run(
+      PaginatedState<TData, TItem> state) async {
+    try {
+      final result = await request(state);
+
+      if (result.statusCode == StatusCode.ok.value) {
+        return state.copyWith(
+          data: map(result.body, state),
+          preRequestSuccess: true,
+        );
+      } else {
+        try {
+          return handleError(state.copyWithError(result.statusCode));
+        } catch (e) {
+          return state.copyWithError(e);
+        }
+      }
+    } catch (e) {
+      try {
+        return handleError(state.copyWithError(e));
+      } catch (e) {
+        return state.copyWithError(e);
+      }
+    }
+  }
+}
+
+mixin RequestHandleResult<TOut>
+    on RequestCubit<http.Response, String, TOut, int> {
+  @override
+  Future<RequestState<TOut, int>> handleResult(
+    http.Response result,
+  ) async {
+    if (result.statusCode == StatusCode.ok.value) {
+      logger.info('Request success. Data: ${result.body}');
+      return RequestSuccessState(map(result.body));
+    } else {
+      logger.severe('Request error. Status code: ${result.statusCode}');
+      try {
+        return await handleError(RequestErrorState(error: result.statusCode));
+      } catch (e, s) {
+        logger.severe(
+          'Processing error failed. Exception: $e. Stack trace: $s',
+        );
+        return RequestErrorState(exception: e, stackTrace: s);
+      }
+    }
+  }
+}

packages/leancode_cubit_utils/example/lib/pages/paginated/simple_paginated_cubit.dart

@@ -1,6 +1,7 @@
 import 'dart:convert';
 
 import 'package:example/http/status_codes.dart';
+import 'package:example/pages/common.dart';
 import 'package:http/http.dart' as http;
 import 'package:equatable/equatable.dart';
 import 'package:example/pages/paginated/api.dart';
@@ -37,7 +38,8 @@ class AdditionalData with EquatableMixin {
 }
 
 class FiltersPreRequest
-    extends PreRequest<http.Response, String, AdditionalData, User> {
+    extends PreRequest<http.Response, String, AdditionalData, User>
+    with PreRequestRun {
   FiltersPreRequest({
     required this.api,
   });
@@ -64,33 +66,6 @@ class FiltersPreRequest
           .toSet(),
     );
   }
-
-  @override
-  Future<PaginatedState<AdditionalData, User>> run(
-      PaginatedState<AdditionalData, User> state) async {
-    try {
-      final result = await request(state);
-
-      if (result.statusCode == StatusCode.ok.value) {
-        return state.copyWith(
-          data: map(result.body, state),
-          preRequestSuccess: true,
-        );
-      } else {
-        try {
-          return handleError(state.copyWithError(result.statusCode));
-        } catch (e) {
-          return state.copyWithError(e);
-        }
-      }
-    } catch (e) {
-      try {
-        return handleError(state.copyWithError(e));
-      } catch (e) {
-        return state.copyWithError(e);
-      }
-    }
-  }
 }
 
 class SimplePaginatedCubit

packages/leancode_cubit_utils/example/lib/pages/request/request_page.dart

@@ -1,14 +1,15 @@
 import 'dart:convert';
 
 import 'package:example/http/client.dart';
-import 'package:example/http/status_codes.dart';
+import 'package:example/pages/common.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_bloc/flutter_bloc.dart';
 import 'package:http/http.dart' as http;
 import 'package:leancode_cubit_utils/leancode_cubit_utils.dart';
 import 'package:leancode_hooks/leancode_hooks.dart';
 
-class UserRequestCubit extends RequestCubit<http.Response, String, User, int> {
+class UserRequestCubit extends RequestCubit<http.Response, String, User, int>
+    with RequestHandleResult {
   UserRequestCubit(
     this._request,
   ) : super('UserRequestCubit');
@@ -21,26 +22,6 @@ class UserRequestCubit extends RequestCubit<http.Response, String, User, int> {
   @override
   User map(String data) =>
       User.fromJson(jsonDecode(data) as Map<String, dynamic>);
-
-  @override
-  Future<RequestState<User, int>> handleResult(
-    http.Response result,
-  ) async {
-    if (result.statusCode == StatusCode.ok.value) {
-      logger.info('Request success. Data: ${result.body}');
-      return RequestSuccessState(map(result.body));
-    } else {
-      logger.severe('Request error. Status code: ${result.statusCode}');
-      try {
-        return await handleError(RequestErrorState(error: result.statusCode));
-      } catch (e, s) {
-        logger.severe(
-          'Processing error failed. Exception: $e. Stack trace: $s',
-        );
-        return RequestErrorState(exception: e, stackTrace: s);
-      }
-    }
-  }
 }
 
 class RequestHookScreen extends StatelessWidget {

packages/leancode_cubit_utils/example/pubspec.lock

@@ -249,7 +249,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.0.4"
+    version: "0.1.0"
   leancode_hooks:
     dependency: "direct main"
     description:

packages/leancode_cubit_utils_cqrs/example/pubspec.lock

@@ -257,7 +257,7 @@ packages:
       path: "../../leancode_cubit_utils"
       relative: true
     source: path
-    version: "0.0.4"
+    version: "0.1.0"
   leancode_cubit_utils_cqrs:
     dependency: "direct main"
     description:
@@ -559,5 +559,5 @@ packages:
     source: hosted
     version: "3.1.2"
 sdks:
-  dart: ">=3.4.0 <4.0.0"
+  dart: ">=3.3.0 <4.0.0"
   flutter: ">=3.18.0-18.0.pre.54"