Prepare version 0.4.1

github-actions · github-actions · commit 83abdb3d7e3c · 2025-02-15T01:14:35.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## [0.4.1]
+
+- Released @ 2/2025 (UTC)
+- chore: Update dependencies
+
 ## [0.4.0]
 
 - Released @ 2/2025 (UTC)
diff --git a/_tests/A_context_store_tests/main.dart b/_tests/A_context_store_tests/main.dart
@@ -39,14 +39,7 @@ class _AppState extends State<App> {
 
   @override
   Widget build(BuildContext context) {
-    const pages = [
-      Test1(),
-      Test2(),
-      Test3(),
-      Test4(),
-      Test5(),
-      Test6(),
-    ];
+    const pages = [Test1(), Test2(), Test3(), Test4(), Test5(), Test6()];
     return MaterialApp(
       home: Scaffold(
         body: Column(
diff --git a/_tests/A_context_store_tests/pages/test1.dart b/_tests/A_context_store_tests/pages/test1.dart
@@ -44,10 +44,7 @@ class Test1 extends StatelessWidget {
       height: double.infinity,
       child: Column(
         mainAxisAlignment: MainAxisAlignment.center,
-        children: [
-          const Text('Test4'),
-          Text(message),
-        ],
+        children: [const Text('Test4'), Text(message)],
       ),
     );
   }
diff --git a/_tests/A_context_store_tests/pages/test2.dart b/_tests/A_context_store_tests/pages/test2.dart
@@ -58,7 +58,7 @@ class _Test2State extends State<Test2> {
           FilledButton(
             onPressed: () => setState(() {}),
             child: const Text('Call setState'),
-          )
+          ),
         ],
       ),
     );
diff --git a/_tests/A_context_store_tests/pages/test3.dart b/_tests/A_context_store_tests/pages/test3.dart
@@ -61,7 +61,7 @@ class _Test3State extends State<Test3> {
           FilledButton(
             onPressed: () => setState(() {}),
             child: const Text('Call setState'),
-          )
+          ),
         ],
       ),
     );
diff --git a/_tests/A_context_store_tests/pages/test4.dart b/_tests/A_context_store_tests/pages/test4.dart
@@ -65,7 +65,7 @@ class _Test4State extends State<Test4> {
           FilledButton(
             onPressed: () => setState(() {}),
             child: const Text('Call setState'),
-          )
+          ),
         ],
       ),
     );
diff --git a/_tests/A_context_store_tests/pages/test6.dart b/_tests/A_context_store_tests/pages/test6.dart
@@ -69,7 +69,7 @@ class _Test6State extends State<Test6> {
           FilledButton(
             onPressed: () => setState(() {}),
             child: const Text('Call setState'),
-          )
+          ),
         ],
       ),
     );
diff --git a/_tests/B_will_dispose_mixin_tests/main.dart b/_tests/B_will_dispose_mixin_tests/main.dart
@@ -38,11 +38,7 @@ class _AppState extends State<App> {
 
   @override
   Widget build(BuildContext context) {
-    const pages = [
-      Test1(),
-      Test2(),
-      Test3(),
-    ];
+    const pages = [Test1(), Test2(), Test3()];
     return MaterialApp(
       home: Scaffold(
         body: Column(
diff --git a/_tests/B_will_dispose_mixin_tests/pages/test1.dart b/_tests/B_will_dispose_mixin_tests/pages/test1.dart
@@ -46,7 +46,8 @@ class _Test1State extends State<Test1> with DisposeMixin, WillDisposeMixin {
     super.dispose(); // ValueNotifer will be disposed of here.
     // Expecting error since we disposed of the ValueNotifier already:
     debugPrint(
-        '[Test1] Expecting error "A ValueNotifier<int> was used after being disposed."...');
+      '[Test1] Expecting error "A ValueNotifier<int> was used after being disposed."...',
+    );
     try {
       countValueNotifier.dispose();
     } catch (e) {
diff --git a/_tests/B_will_dispose_mixin_tests/pages/test2.dart b/_tests/B_will_dispose_mixin_tests/pages/test2.dart
@@ -68,7 +68,7 @@ class _Test2State extends State<Test2> with DisposeMixin, WillDisposeMixin {
           FilledButton(
             onPressed: () => setState(() {}),
             child: const Text('setState'),
-          )
+          ),
         ],
       ),
     );
diff --git a/_tests/B_will_dispose_mixin_tests/pages/test3.dart b/_tests/B_will_dispose_mixin_tests/pages/test3.dart
@@ -67,7 +67,7 @@ class _Test3State extends State<Test3> with DisposeMixin, WillDisposeMixin {
           FilledButton(
             onPressed: () => setState(() {}),
             child: const Text('setState'),
-          )
+          ),
         ],
       ),
     );
diff --git a/example/example.dart b/example/example.dart
@@ -38,10 +38,7 @@ class _CounterState extends CleanupState<Counter> {
   late final _secondsRemaining = willDispose(ValueNotifier<int>(60));
   late final _tickCounter = willDispose(ValueNotifier<int>(0));
   late final _timer = willCancel(
-    Timer.periodic(
-      const Duration(seconds: 1),
-      _onTick,
-    ),
+    Timer.periodic(const Duration(seconds: 1), _onTick),
   );
 
   void _onTick(Timer timer) {
@@ -72,10 +69,7 @@ class _CounterState extends CleanupState<Counter> {
         ValueListenableBuilder<int>(
           valueListenable: _tickCounter,
           builder: (context, value, child) {
-            return Text(
-              'Ticks: $value',
-              style: const TextStyle(fontSize: 24),
-            );
+            return Text('Ticks: $value', style: const TextStyle(fontSize: 24));
           },
         ),
       ],
@@ -107,10 +101,7 @@ class ChatBox extends StatelessWidget {
 
     return Row(
       children: [
-        TextField(
-          controller: textEditingController,
-          focusNode: focusNode,
-        ),
+        TextField(controller: textEditingController, focusNode: focusNode),
         ElevatedButton(
           onPressed: () {
             final text = textEditingController.text;
diff --git a/lib/src/attachable_mixin/_attachable_element_mixin.dart b/lib/src/attachable_mixin/_attachable_element_mixin.dart
@@ -113,7 +113,4 @@ mixin AttachableElementMixin on ComponentElement {
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
-typedef _CallbackRecord = ({
-  dynamic buildId,
-  VoidCallback callback,
-});
+typedef _CallbackRecord = ({dynamic buildId, VoidCallback callback});
diff --git a/lib/src/context_store.dart b/lib/src/context_store.dart
@@ -49,11 +49,7 @@ class AssociatedContextStore {
   ///
   /// Optionally, an [onDetach] callback can be provided, which is called when
   /// the data is detached from the store.
-  T attach<T>(
-    T data, {
-    required dynamic key,
-    void Function(T data)? onDetach,
-  }) {
+  T attach<T>(T data, {required dynamic key, void Function(T data)? onDetach}) {
     return ContextStore.instance.attach(
       context,
       data,
@@ -69,13 +65,8 @@ class AssociatedContextStore {
   /// decides whether to provide a key or set it as `null`.
   ///
   /// Returns the data if it exists, otherwise `null`.
-  T? retrieve<T>({
-    required dynamic key,
-  }) {
-    return ContextStore.instance.retrieve<T>(
-      context,
-      key: key,
-    );
+  T? retrieve<T>({required dynamic key}) {
+    return ContextStore.instance.retrieve<T>(context, key: key);
   }
 
   /// Detaches and removes data of type [T] associated with [context].
@@ -85,13 +76,8 @@ class AssociatedContextStore {
   /// decides whether to provide a key or set it as `null`.
   ///
   /// Returns the removed data if or `null` if it didn't exist.
-  ContextStoreData<T>? detach<T>({
-    required dynamic key,
-  }) {
-    return ContextStore.instance.detach<T>(
-      context,
-      key: key,
-    );
+  ContextStoreData<T>? detach<T>({required dynamic key}) {
+    return ContextStore.instance.detach<T>(context, key: key);
   }
 }
 
@@ -156,12 +142,8 @@ class ContextStore {
       _log(
         'Attached context data associated with context hash ${context.hashCode} and key hash ${keyOrType.hashCode}',
       );
-      _log(
-        'Context data map length: ${contextDataMap.length}',
-      );
-      _log(
-        'Store map length: ${_store.length}',
-      );
+      _log('Context data map length: ${contextDataMap.length}');
+      _log('Store map length: ${_store.length}');
 
       // Schedule a context check if it's not already being checked.
       if (!didContextMapExist) {
@@ -176,10 +158,7 @@ class ContextStore {
   //
   //
 
-  T? retrieve<T>(
-    BuildContext context, {
-    required dynamic key,
-  }) {
+  T? retrieve<T>(BuildContext context, {required dynamic key}) {
     final keyOrType = key ?? T;
     return _store[context]?[keyOrType]?.data as T?;
   }
@@ -203,10 +182,7 @@ class ContextStore {
   //
   //
 
-  ContextStoreData<T>? detach<T>(
-    BuildContext context, {
-    required dynamic key,
-  }) {
+  ContextStoreData<T>? detach<T>(BuildContext context, {required dynamic key}) {
     return _detach<T>(context, key: key);
   }
 
@@ -237,12 +213,8 @@ class ContextStore {
     _log(
       'Detached context data associated with context hash ${context.hashCode} and key hash ${keyOrType.hashCode}',
     );
-    _log(
-      'Context data map length: ${contextDataMap!.length}',
-    );
-    _log(
-      'Store map length: ${_store.length}',
-    );
+    _log('Context data map length: ${contextDataMap!.length}');
+    _log('Store map length: ${_store.length}');
 
     // Return the data that was removed.
     return storeData;
@@ -303,6 +275,6 @@ class ContextStore {
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
 typedef ContextStoreData<T> = ({T data, void Function(T data)? onDetach});
-typedef ContextStoreMap<T>
-    = HashMap<BuildContext, HashMap<dynamic, ContextStoreData<T>>>;
+typedef ContextStoreMap<T> =
+    HashMap<BuildContext, HashMap<dynamic, ContextStoreData<T>>>;
 typedef ContextMap<T> = HashMap<dynamic, ContextStoreData<T>>;
diff --git a/lib/src/will_mixins/will_cancel/will_cancel_mixin.dart b/lib/src/will_mixins/will_cancel/will_cancel_mixin.dart
@@ -13,7 +13,8 @@
 import 'dart:async' show FutureOr;
 
 import 'package:df_type/df_type.dart' show SequentialController;
-import 'package:flutter/foundation.dart' show kDebugMode, mustCallSuper, nonVirtual;
+import 'package:flutter/foundation.dart'
+    show kDebugMode, mustCallSuper, nonVirtual;
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
@@ -26,7 +27,8 @@ import 'package:flutter/foundation.dart' show kDebugMode, mustCallSuper, nonVirt
 /// invoked on each resource wrapped with [willCancel].
 mixin WillCancelMixin on CancelMixin {
   /// The list of resources marked for cancel via [willCancel].
-  Set<_ToCancelResource<dynamic>> get toCancelResources => Set.unmodifiable(_toCancelResources);
+  Set<_ToCancelResource<dynamic>> get toCancelResources =>
+      Set.unmodifiable(_toCancelResources);
 
   final Set<_ToCancelResource<dynamic>> _toCancelResources = {};
 
@@ -48,11 +50,13 @@ mixin WillCancelMixin on CancelMixin {
     _verifyCancelMethod(resource);
     final disposable = (
       resource: resource as dynamic,
-      onBeforeCancel: onBeforeCancel != null ? (dynamic e) => onBeforeCancel(e as T) : null,
+      onBeforeCancel:
+          onBeforeCancel != null ? (dynamic e) => onBeforeCancel(e as T) : null,
     );
 
     // Check for any duplicate resource.
-    final duplicate = _toCancelResources.where((e) => e.resource == resource).firstOrNull;
+    final duplicate =
+        _toCancelResources.where((e) => e.resource == resource).firstOrNull;
 
     if (duplicate != null) {
       if (kDebugMode) {
@@ -163,7 +167,8 @@ final class WillAlreadyCancelDebugError<T> extends Error {
   WillAlreadyCancelDebugError(this.resource);
 
   @override
-  String toString() => '[$WillAlreadyCancelDebugError] willCancel has already '
+  String toString() =>
+      '[$WillAlreadyCancelDebugError] willCancel has already '
       'been called on the resource ${resource.hashCode} and of type $T.';
 }
 
@@ -177,10 +182,8 @@ mixin CancelMixin {
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
-typedef _ToCancelResource<T> = ({
-  T resource,
-  _OnBeforeCallback<T>? onBeforeCancel,
-});
+typedef _ToCancelResource<T> =
+    ({T resource, _OnBeforeCallback<T>? onBeforeCancel});
 
 typedef _FutureOrCallback<T> = FutureOr<void> Function();
 typedef _OnBeforeCallback<T> = FutureOr<void> Function(T resource);
diff --git a/lib/src/will_mixins/will_cancel/will_cancel_on_build_context_x.dart b/lib/src/will_mixins/will_cancel/will_cancel_on_build_context_x.dart
@@ -49,7 +49,8 @@ extension WillCancelOnBuildContextX on BuildContext {
       );
     } else {
       if (kDebugMode) {
-        final consideration = {
+        final consideration =
+            {
               StatelessWidget: StatelessAttachableMixin,
               StatefulWidget: StatefulAttachableMixin,
             }[widget.runtimeType] ??
diff --git a/lib/src/will_mixins/will_close/will_close_mixin.dart b/lib/src/will_mixins/will_close/will_close_mixin.dart
@@ -13,7 +13,8 @@
 import 'dart:async' show FutureOr;
 
 import 'package:df_type/df_type.dart' show SequentialController;
-import 'package:flutter/foundation.dart' show kDebugMode, mustCallSuper, nonVirtual;
+import 'package:flutter/foundation.dart'
+    show kDebugMode, mustCallSuper, nonVirtual;
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
@@ -26,7 +27,8 @@ import 'package:flutter/foundation.dart' show kDebugMode, mustCallSuper, nonVirt
 /// invoked on each resource wrapped with [willClose].
 mixin WillCloseMixin on CloseMixin {
   /// The list of resources marked for close via [willClose].
-  Set<_ToCloseResource<dynamic>> get toCloseResources => Set.unmodifiable(_toCloseResources);
+  Set<_ToCloseResource<dynamic>> get toCloseResources =>
+      Set.unmodifiable(_toCloseResources);
 
   final Set<_ToCloseResource<dynamic>> _toCloseResources = {};
 
@@ -48,11 +50,13 @@ mixin WillCloseMixin on CloseMixin {
     _verifyCloseMethod(resource);
     final disposable = (
       resource: resource as dynamic,
-      onBeforeClose: onBeforeClose != null ? (dynamic e) => onBeforeClose(e as T) : null,
+      onBeforeClose:
+          onBeforeClose != null ? (dynamic e) => onBeforeClose(e as T) : null,
     );
 
     // Check for any duplicate resource.
-    final duplicate = _toCloseResources.where((e) => e.resource == resource).firstOrNull;
+    final duplicate =
+        _toCloseResources.where((e) => e.resource == resource).firstOrNull;
 
     if (duplicate != null) {
       if (kDebugMode) {
@@ -163,7 +167,8 @@ final class WillAlreadyCloseDebugError<T> extends Error {
   WillAlreadyCloseDebugError(this.resource);
 
   @override
-  String toString() => '[$WillAlreadyCloseDebugError] willClose has already '
+  String toString() =>
+      '[$WillAlreadyCloseDebugError] willClose has already '
       'been called on the resource ${resource.hashCode} and of type $T.';
 }
 
@@ -177,10 +182,8 @@ mixin CloseMixin {
 
 // ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
 
-typedef _ToCloseResource<T> = ({
-  T resource,
-  _OnBeforeCallback<T>? onBeforeClose,
-});
+typedef _ToCloseResource<T> =
+    ({T resource, _OnBeforeCallback<T>? onBeforeClose});
 
 typedef _FutureOrCallback<T> = FutureOr<void> Function();
 typedef _OnBeforeCallback<T> = FutureOr<void> Function(T resource);
diff --git a/lib/src/will_mixins/will_close/will_close_on_build_context_x.dart b/lib/src/will_mixins/will_close/will_close_on_build_context_x.dart
diff --git a/lib/src/will_mixins/will_dispose/will_dispose_mixin.dart b/lib/src/will_mixins/will_dispose/will_dispose_mixin.dart
diff --git a/lib/src/will_mixins/will_dispose/will_dispose_on_build_context_x.dart b/lib/src/will_mixins/will_dispose/will_dispose_on_build_context_x.dart
diff --git a/lib/src/will_mixins/will_stop/will_stop_mixin.dart b/lib/src/will_mixins/will_stop/will_stop_mixin.dart
diff --git a/lib/src/will_mixins/will_stop/will_stop_on_build_context_x.dart b/lib/src/will_mixins/will_stop/will_stop_on_build_context_x.dart
