From 10142e9b0f90b1bc9f679222e86940835947b349 Mon Sep 17 00:00:00 2001 From: Steffen Date: Sat, 5 Jul 2025 11:15:23 +0200 Subject: [PATCH 1/3] feat: rename 'builder' parameter to 'onSuccess' in RequestCubitBuilder - Rename the 'builder' parameter to 'onSuccess' in RequestCubitBuilder class - Update constructor comment to reflect the change - Update field declaration comment - Update all usages in build method (RequestSuccessState and RequestRefreshState) - Update all example code to use the new parameter name - Update all test files to use the new parameter name - Update README documentation to reflect the change This change makes the parameter name more descriptive and aligns with the naming convention of other state handlers (onInitial, onLoading, onError). Resolves: #49 --- packages/leancode_cubit_utils/README.md | 4 ++-- .../example/lib/pages/request/request_page.dart | 2 +- .../lib/src/request/request_cubit_builder.dart | 10 +++++----- .../test/request_cubit_builder_test.dart | 10 +++++----- .../example/lib/pages/query/query_page.dart | 5 +++-- .../test/query_cubit_builder_test.dart | 8 ++++---- 6 files changed, 20 insertions(+), 19 deletions(-) diff --git a/packages/leancode_cubit_utils/README.md b/packages/leancode_cubit_utils/README.md index aea96ef..4879ed7 100644 --- a/packages/leancode_cubit_utils/README.md +++ b/packages/leancode_cubit_utils/README.md @@ -100,7 +100,7 @@ If you call `refresh()` on `ArgsRequestCubit` it will perform a request with the - `WidgetBuilder? onInitial` - use it to show a widget before invoking the request for the first time, - `WidgetBuilder? onLoading` - use it to show a loader widget while the request is being performed, - `WidgetBuilder? onError` - use it to show error widget when processing the request fails, -- `RequestWidgetBuilder builder` - use it to build a page when the data is successfully loaded. +- `RequestWidgetBuilder onSuccess` - use it to build a page when the data is successfully loaded. Other than builders, you also need to provide the cubit based on which the `RequestCubitBuilder` will be rebuilt. And you can also pass `onErrorCallback` which allows you to pass a callback to error widget builder. You may want to use it to implement retry button. @@ -122,7 +122,7 @@ RequestCubitBuilder( ), ), onErrorCallback: context.read().run, - builder: (context, data) { + onSuccess: (context, data) { return ListView.builder( itemCount: data.assignments.length, itemBuilder: (context, index) { diff --git a/packages/leancode_cubit_utils/example/lib/pages/request/request_page.dart b/packages/leancode_cubit_utils/example/lib/pages/request/request_page.dart index 6fba8cc..3b425e3 100644 --- a/packages/leancode_cubit_utils/example/lib/pages/request/request_page.dart +++ b/packages/leancode_cubit_utils/example/lib/pages/request/request_page.dart @@ -41,7 +41,7 @@ class RequestPage extends StatelessWidget { Center( child: RequestCubitBuilder( cubit: context.read(), - builder: (context, data) => + onSuccess: (context, data) => Text('${data.name} ${data.surname}'), ), ), diff --git a/packages/leancode_cubit_utils/lib/src/request/request_cubit_builder.dart b/packages/leancode_cubit_utils/lib/src/request/request_cubit_builder.dart index 0bb8db3..3461d26 100644 --- a/packages/leancode_cubit_utils/lib/src/request/request_cubit_builder.dart +++ b/packages/leancode_cubit_utils/lib/src/request/request_cubit_builder.dart @@ -19,11 +19,11 @@ typedef RequestErrorBuilder = Widget Function( /// A widget that builds itself based on the latest request state. class RequestCubitBuilder extends StatelessWidget { /// Creates a new [RequestCubitBuilder] with the given [cubit] and - /// [builder]. + /// [onSuccess]. const RequestCubitBuilder({ super.key, required this.cubit, - required this.builder, + required this.onSuccess, this.onInitial, this.onLoading, this.onEmpty, @@ -35,7 +35,7 @@ class RequestCubitBuilder extends StatelessWidget { final BaseRequestCubit cubit; /// The builder that creates a widget when data successfully loaded. - final RequestWidgetBuilder builder; + final RequestWidgetBuilder onSuccess; /// The builder that creates a widget when state is initial. final WidgetBuilder? onInitial; @@ -66,9 +66,9 @@ class RequestCubitBuilder extends StatelessWidget { config.onLoading(context), RequestLoadingState() => onLoading?.call(context) ?? config.onLoading(context), - RequestSuccessState(:final data) => builder(context, data), + RequestSuccessState(:final data) => onSuccess(context, data), RequestRefreshState(:final data) => data != null - ? builder(context, data) + ? onSuccess(context, data) : onLoading?.call(context) ?? config.onLoading(context), RequestEmptyState() => onEmpty?.call(context) ?? config.onEmpty?.call(context) ?? diff --git a/packages/leancode_cubit_utils/test/request_cubit_builder_test.dart b/packages/leancode_cubit_utils/test/request_cubit_builder_test.dart index 18ba623..d3e227d 100644 --- a/packages/leancode_cubit_utils/test/request_cubit_builder_test.dart +++ b/packages/leancode_cubit_utils/test/request_cubit_builder_test.dart @@ -61,7 +61,7 @@ void main() { TestPage( child: RequestCubitBuilder( cubit: queryCubit, - builder: (context, data) => Text(data), + onSuccess: (context, data) => Text(data), ), ), ); @@ -83,7 +83,7 @@ void main() { TestPage( child: RequestCubitBuilder( cubit: queryCubit, - builder: (context, data) => Text(data), + onSuccess: (context, data) => Text(data), ), ), ); @@ -106,7 +106,7 @@ void main() { cubit: queryCubit, onLoading: (context) => const Text('Custom loading...'), onError: (context, error, retry) => const Text('Custom error!'), - builder: (context, data) => Text(data), + onSuccess: (context, data) => Text(data), ), ), ); @@ -127,7 +127,7 @@ void main() { TestPage( child: RequestCubitBuilder( cubit: queryCubit, - builder: (context, data) => Text('Success, data: $data'), + onSuccess: (context, data) => Text('Success, data: $data'), ), ), ); @@ -145,7 +145,7 @@ void main() { TestPage( child: RequestCubitBuilder( cubit: queryCubit, - builder: (context, data) => Text('Success, data: $data'), + onSuccess: (context, data) => Text('Success, data: $data'), ), ), ); diff --git a/packages/leancode_cubit_utils_cqrs/example/lib/pages/query/query_page.dart b/packages/leancode_cubit_utils_cqrs/example/lib/pages/query/query_page.dart index 3a4e12b..967ce5d 100644 --- a/packages/leancode_cubit_utils_cqrs/example/lib/pages/query/query_page.dart +++ b/packages/leancode_cubit_utils_cqrs/example/lib/pages/query/query_page.dart @@ -48,7 +48,8 @@ class QueryHookPage extends HookWidget { Center( child: RequestCubitBuilder( cubit: userCubit, - builder: (context, data) => Text('${data.name} ${data.surname}'), + onSuccess: (context, data) => + Text('${data.name} ${data.surname}'), ), ), const SizedBox(height: 16), @@ -87,7 +88,7 @@ class QueryPage extends StatelessWidget { Center( child: RequestCubitBuilder( cubit: context.read(), - builder: (context, data) => + onSuccess: (context, data) => Text('${data.name} ${data.surname}'), ), ), diff --git a/packages/leancode_cubit_utils_cqrs/test/query_cubit_builder_test.dart b/packages/leancode_cubit_utils_cqrs/test/query_cubit_builder_test.dart index 31d9b1c..d823775 100644 --- a/packages/leancode_cubit_utils_cqrs/test/query_cubit_builder_test.dart +++ b/packages/leancode_cubit_utils_cqrs/test/query_cubit_builder_test.dart @@ -54,7 +54,7 @@ void main() { TestPage( child: RequestCubitBuilder( cubit: queryCubit, - builder: (context, data) => Text(data), + onSuccess: (context, data) => Text(data), ), ), ); @@ -77,7 +77,7 @@ void main() { cubit: queryCubit, onLoading: (context) => const Text('Custom loading...'), onError: (context, error, retry) => const Text('Custom error!'), - builder: (context, data) => Text(data), + onSuccess: (context, data) => Text(data), ), ), ); @@ -98,7 +98,7 @@ void main() { TestPage( child: RequestCubitBuilder( cubit: queryCubit, - builder: (context, data) => Text('Success, data: $data'), + onSuccess: (context, data) => Text('Success, data: $data'), ), ), ); @@ -116,7 +116,7 @@ void main() { TestPage( child: RequestCubitBuilder( cubit: queryCubit, - builder: (context, data) => Text('Success, data: $data'), + onSuccess: (context, data) => Text('Success, data: $data'), ), ), ); From 8f15e09520b78a93252dd93054722eb86b1717a7 Mon Sep 17 00:00:00 2001 From: Steffen Date: Sat, 5 Jul 2025 11:15:40 +0200 Subject: [PATCH 2/3] chore: bump version to 0.4.0 and update changelogs - Bump leancode_cubit_utils version from 0.3.2 to 0.4.0 - Bump leancode_cubit_utils_cqrs version from 0.3.1 to 0.4.0 - Update leancode_cubit_utils_cqrs dependency to ^0.4.0 - Add changelog entries documenting the breaking change This follows semantic versioning best practices where breaking changes in pre-1.0 software bump the minor version (0.x.y -> 0.x+1.0). --- packages/leancode_cubit_utils/CHANGELOG.md | 4 ++++ packages/leancode_cubit_utils/pubspec.yaml | 2 +- packages/leancode_cubit_utils_cqrs/CHANGELOG.md | 4 ++++ packages/leancode_cubit_utils_cqrs/pubspec.yaml | 4 ++-- 4 files changed, 11 insertions(+), 3 deletions(-) diff --git a/packages/leancode_cubit_utils/CHANGELOG.md b/packages/leancode_cubit_utils/CHANGELOG.md index 6302b2f..e3b0dc1 100644 --- a/packages/leancode_cubit_utils/CHANGELOG.md +++ b/packages/leancode_cubit_utils/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.4.0 + +* **BREAKING CHANGE**: Rename `builder` parameter to `onSuccess` in `RequestCubitBuilder` + ## 0.3.2 * Upgrade `bloc` to ^9.0.0 diff --git a/packages/leancode_cubit_utils/pubspec.yaml b/packages/leancode_cubit_utils/pubspec.yaml index 08b46ba..2d38fc9 100644 --- a/packages/leancode_cubit_utils/pubspec.yaml +++ b/packages/leancode_cubit_utils/pubspec.yaml @@ -1,6 +1,6 @@ name: leancode_cubit_utils description: A collection of cubits and widgets that facilitate the creation of repetitive pages, eliminating boilerplate. -version: 0.3.2 +version: 0.4.0 repository: https://github.com/leancodepl/leancode_cubit_utils environment: diff --git a/packages/leancode_cubit_utils_cqrs/CHANGELOG.md b/packages/leancode_cubit_utils_cqrs/CHANGELOG.md index 7498f5e..40c71db 100644 --- a/packages/leancode_cubit_utils_cqrs/CHANGELOG.md +++ b/packages/leancode_cubit_utils_cqrs/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.4.0 + +* Update `leancode_cubit_utils` dependency to `^0.4.0` (includes breaking change: `builder` parameter renamed to `onSuccess` in `RequestCubitBuilder`) + ## 0.3.1 * Upgrade `bloc` to ^9.0.0 diff --git a/packages/leancode_cubit_utils_cqrs/pubspec.yaml b/packages/leancode_cubit_utils_cqrs/pubspec.yaml index 1bf9393..912199a 100644 --- a/packages/leancode_cubit_utils_cqrs/pubspec.yaml +++ b/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.3.1 +version: 0.4.0 repository: https://github.com/leancodepl/leancode_cubit_utils environment: @@ -12,7 +12,7 @@ dependencies: flutter: sdk: flutter flutter_bloc: ^9.0.0 - leancode_cubit_utils: ^0.3.2 + leancode_cubit_utils: ^0.4.0 leancode_hooks: ^0.1.1 dev_dependencies: From 5f66e6b6511afe45cf145784cf870732e279c2b2 Mon Sep 17 00:00:00 2001 From: Steffen Date: Sat, 5 Jul 2025 11:46:59 +0200 Subject: [PATCH 3/3] chore: update example lock files to reflect 0.4.0 version --- .../leancode_cubit_utils/example/pubspec.lock | 18 ++-- .../example/pubspec.lock | 85 +++++++++---------- 2 files changed, 51 insertions(+), 52 deletions(-) diff --git a/packages/leancode_cubit_utils/example/pubspec.lock b/packages/leancode_cubit_utils/example/pubspec.lock index a632142..1a8130e 100644 --- a/packages/leancode_cubit_utils/example/pubspec.lock +++ b/packages/leancode_cubit_utils/example/pubspec.lock @@ -5,10 +5,10 @@ packages: dependency: "direct main" description: name: async - sha256: d2872f9c19731c2e5f10444b14686eb7cc85c76274bd6c16e1816bff9a3bab63 + sha256: "758e6d74e971c3e5aceb4110bfd6698efc7f501675bcfe0c775459a8140750eb" url: "https://pub.dev" source: hosted - version: "2.12.0" + version: "2.13.0" bloc: dependency: transitive description: @@ -69,10 +69,10 @@ packages: dependency: transitive description: name: fake_async - sha256: "6a95e56b2449df2273fd8c45a662d6947ce1ebb7aafe80e550a3f68297f3cacc" + sha256: "5368f224a74523e8d2e7399ea1638b37aecfca824a3cc4dfdf77bf1fa905ac44" url: "https://pub.dev" source: hosted - version: "1.3.2" + version: "1.3.3" faker: dependency: "direct main" description: @@ -135,10 +135,10 @@ packages: dependency: transitive description: name: leak_tracker - sha256: c35baad643ba394b40aac41080300150a4f08fd0fd6a10378f8f7c6bc161acec + sha256: "6bb818ecbdffe216e81182c2f0714a2e62b593f4a4f13098713ff1685dfb6ab0" url: "https://pub.dev" source: hosted - version: "10.0.8" + version: "10.0.9" leak_tracker_flutter_testing: dependency: transitive description: @@ -161,7 +161,7 @@ packages: path: ".." relative: true source: path - version: "0.3.2" + version: "0.4.0" leancode_hooks: dependency: "direct main" description: @@ -315,10 +315,10 @@ packages: dependency: transitive description: name: vm_service - sha256: "0968250880a6c5fe7edc067ed0a13d4bae1577fe2771dcf3010d52c4a9d3ca14" + sha256: ddfa8d30d89985b96407efce8acbdd124701f96741f2d981ca860662f1c0dc02 url: "https://pub.dev" source: hosted - version: "14.3.1" + version: "15.0.0" web: dependency: transitive description: diff --git a/packages/leancode_cubit_utils_cqrs/example/pubspec.lock b/packages/leancode_cubit_utils_cqrs/example/pubspec.lock index 106a7ca..3e56caf 100644 --- a/packages/leancode_cubit_utils_cqrs/example/pubspec.lock +++ b/packages/leancode_cubit_utils_cqrs/example/pubspec.lock @@ -5,10 +5,10 @@ packages: dependency: "direct main" description: name: async - sha256: "947bfcf187f74dbc5e146c9eb9c0f10c9f8b30743e341481c1e2ed3ecc18c20c" + sha256: "758e6d74e971c3e5aceb4110bfd6698efc7f501675bcfe0c775459a8140750eb" url: "https://pub.dev" source: hosted - version: "2.11.0" + version: "2.13.0" bloc: dependency: transitive description: @@ -21,34 +21,34 @@ packages: dependency: transitive description: name: boolean_selector - sha256: "6cfb5af12253eaf2b368f07bacc5a80d1301a071c73360d746b7f2e32d762c66" + sha256: "8aab1771e1243a5063b8b0ff68042d67334e3feab9e95b9490f9a6ebf73b42ea" url: "https://pub.dev" source: hosted - version: "2.1.1" + version: "2.1.2" characters: 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" collection: dependency: transitive description: name: collection - sha256: a1ace0a119f20aabc852d165077c036cd864315bd99b7eaa10a60100341941bf + sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76" url: "https://pub.dev" source: hosted - version: "1.19.0" + version: "1.19.1" cqrs: dependency: "direct main" description: @@ -77,10 +77,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" faker: dependency: "direct main" description: @@ -143,18 +143,18 @@ packages: dependency: transitive description: name: leak_tracker - sha256: "7bb2830ebd849694d1ec25bf1f44582d6ac531a57a365a803a6034ff751d2d06" + sha256: "6bb818ecbdffe216e81182c2f0714a2e62b593f4a4f13098713ff1685dfb6ab0" url: "https://pub.dev" source: hosted - version: "10.0.7" + version: "10.0.9" leak_tracker_flutter_testing: dependency: transitive description: name: leak_tracker_flutter_testing - sha256: "9491a714cca3667b60b5c420da8217e6de0d1ba7a5ec322fab01758f6998f379" + sha256: f8b613e7e6a13ec79cfdc0e97638fddb3ab848452eff057653abd3edba760573 url: "https://pub.dev" source: hosted - version: "3.0.8" + version: "3.0.9" leak_tracker_testing: dependency: transitive description: @@ -166,18 +166,17 @@ packages: leancode_cubit_utils: dependency: transitive description: - name: leancode_cubit_utils - sha256: f642d9aad5bce940eb9aae9c4eca830e96d1254e52fd7bf882ab5e98abc81c41 - url: "https://pub.dev" - source: hosted - version: "0.3.2" + path: "../../leancode_cubit_utils" + relative: true + source: path + version: "0.4.0" leancode_cubit_utils_cqrs: dependency: "direct main" description: path: ".." relative: true source: path - version: "0.3.0" + version: "0.4.0" leancode_hooks: dependency: "direct main" description: @@ -206,10 +205,10 @@ packages: 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: @@ -222,10 +221,10 @@ packages: dependency: transitive description: name: meta - sha256: bdb68674043280c3428e9ec998512fb681678676b3c54e773629ffe74419f8c7 + sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c url: "https://pub.dev" source: hosted - version: "1.15.0" + version: "1.16.0" mocktail: dependency: "direct main" description: @@ -246,10 +245,10 @@ 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: "direct main" description: @@ -267,50 +266,50 @@ packages: dependency: transitive description: name: source_span - sha256: "53e943d4206a5e30df338fd4c6e7a077e02254531b138a15aec3bd143c1a8b3c" + sha256: "254ee5351d6cb365c859e20ee823c3bb479bf4a293c22d17a9f1bf144ce86f7c" url: "https://pub.dev" source: hosted - version: "1.10.0" + version: "1.10.1" stack_trace: dependency: transitive description: name: stack_trace - sha256: "9f47fd3630d76be3ab26f0ee06d213679aa425996925ff3feffdec504931c377" + sha256: "8b27215b45d22309b5cddda1aa2b19bdfec9df0e765f2de506401c071d38d1b1" url: "https://pub.dev" source: hosted - version: "1.12.0" + 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: name: string_scanner - sha256: "688af5ed3402a4bde5b3a6c15fd768dbf2621a614950b17f04626c431ab3c4c3" + sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43" url: "https://pub.dev" source: hosted - version: "1.3.0" + version: "1.4.1" term_glyph: dependency: transitive description: name: term_glyph - sha256: a29248a84fbb7c79282b40b8c72a1209db169a2e0542bce341da992fe1bc7e84 + sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e" url: "https://pub.dev" source: hosted - version: "1.2.1" + version: "1.2.2" test_api: dependency: transitive description: name: test_api - sha256: "664d3a9a64782fcdeb83ce9c6b39e78fd2971d4e37827b9b06c3aa1edc5e760c" + sha256: fb31f383e2ee25fbbfe06b40fe21e1e458d14080e3c67e7ba0acfde4df4e0bbd url: "https://pub.dev" source: hosted - version: "0.7.3" + version: "0.7.4" typed_data: dependency: transitive description: @@ -331,10 +330,10 @@ packages: dependency: transitive description: name: vm_service - sha256: f6be3ed8bd01289b34d679c2b62226f63c0e69f9fd2e50a6b3c1c729a961041b + sha256: ddfa8d30d89985b96407efce8acbdd124701f96741f2d981ca860662f1c0dc02 url: "https://pub.dev" source: hosted - version: "14.3.0" + version: "15.0.0" sdks: - dart: ">=3.6.0 <4.0.0" + dart: ">=3.7.0-0 <4.0.0" flutter: ">=3.18.0-18.0.pre.54"