Prepare version 0.4.0

github-actions · github-actions · commit 21ec1f11adbc · 2025-02-10T10:24:44.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,76 +1,81 @@
 # Changelog
 
+## [0.4.0]
+
+- Released @ 2/2025 (UTC)
+- breaking: Update dependencies
+
 ## [0.3.4]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - chore: Update dependencies
 
 ## [0.3.3]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - chore: Update dependencies
 
 ## [0.3.2]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - chore: Update dependencies
 
 ## [0.3.1]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - chore: Update dependencies
 
 ## [0.3.0]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - breaking: Update dependencies and docs
 
 ## [0.2.2]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - chore: Update dependencies
 
 ## [0.2.1]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - chore: Update dependencies
 
 ## [0.2.0]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - breaking: Remove utils, depend on df_type package, rename mixins from previous release
 
 ## [0.1.6]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - fix: Fix another bug with mixins
 
 ## [0.1.5]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - fix: Fix bug with mixins
 
 ## [0.1.4]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - feat: Add CancelablesMixin, ClosablesMixin, DisposablesMixin and StoppablesMixin
 
 ## [0.1.3]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - refactor: Update FutureOrController's with an addAll method
 
 ## [0.1.2]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - refactor: Change FutureOrController's complete method to accept an optional onComplete callback
 
 ## [0.1.1]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - chore: Fix issues with async behaviour
 
 ## [0.1.0]
 
-- Released @ 11/2024 (UTC)
+- Released @ 2/2025 (UTC)
 - Initial commit
diff --git a/_tests/A_context_store_tests/main.dart b/_tests/A_context_store_tests/main.dart
@@ -61,7 +61,8 @@ class _AppState extends State<App> {
             ),
             OutlinedButton(
               onPressed: () {
-                final nextPageIndex = ((pageController.page?.toInt() ?? 0) + 1) % pages.length;
+                final nextPageIndex =
+                    ((pageController.page?.toInt() ?? 0) + 1) % pages.length;
                 pageController.jumpToPage(nextPageIndex);
               },
               child: const Padding(
diff --git a/_tests/A_context_store_tests/test_animation.dart b/_tests/A_context_store_tests/test_animation.dart
@@ -26,7 +26,8 @@ class TestAnimation extends StatefulWidget {
   State<TestAnimation> createState() => _TestAnimationState();
 }
 
-class _TestAnimationState extends State<TestAnimation> with SingleTickerProviderStateMixin {
+class _TestAnimationState extends State<TestAnimation>
+    with SingleTickerProviderStateMixin {
   late AnimationController _controller;
   late Animation<double> _animation;
 
diff --git a/_tests/B_will_dispose_mixin_tests/main.dart b/_tests/B_will_dispose_mixin_tests/main.dart
@@ -56,7 +56,8 @@ class _AppState extends State<App> {
             ),
             OutlinedButton(
               onPressed: () {
-                final nextPageIndex = ((pageController.page?.toInt() ?? 0) + 1) % pages.length;
+                final nextPageIndex =
+                    ((pageController.page?.toInt() ?? 0) + 1) % pages.length;
                 pageController.jumpToPage(nextPageIndex);
               },
               child: const Padding(
diff --git a/_tests/B_will_dispose_mixin_tests/pages/test1.dart b/_tests/B_will_dispose_mixin_tests/pages/test1.dart
@@ -45,7 +45,8 @@ class _Test1State extends State<Test1> with DisposeMixin, WillDisposeMixin {
   void dispose() {
     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."...');
+    debugPrint(
+        '[Test1] Expecting error "A ValueNotifier<int> was used after being disposed."...');
     try {
       countValueNotifier.dispose();
     } catch (e) {
diff --git a/_tests/C_attachable_tests/main.dart b/_tests/C_attachable_tests/main.dart
@@ -61,7 +61,8 @@ class _AppState extends State<App> {
             ),
             OutlinedButton(
               onPressed: () {
-                final nextPageIndex = ((pageController.page?.toInt() ?? 0) + 1) % pages.length;
+                final nextPageIndex =
+                    ((pageController.page?.toInt() ?? 0) + 1) % pages.length;
                 pageController.jumpToPage(nextPageIndex);
               },
               child: const Padding(
diff --git a/_tests/C_attachable_tests/test_animation.dart b/_tests/C_attachable_tests/test_animation.dart
@@ -26,7 +26,8 @@ class TestAnimation extends StatefulWidget {
   State<TestAnimation> createState() => _TestAnimationState();
 }
 
-class _TestAnimationState extends State<TestAnimation> with SingleTickerProviderStateMixin {
+class _TestAnimationState extends State<TestAnimation>
+    with SingleTickerProviderStateMixin {
   late AnimationController _controller;
   late Animation<double> _animation;
 
diff --git a/lib/src/attachable_mixin/stateful_attachable_mixin.dart b/lib/src/attachable_mixin/stateful_attachable_mixin.dart
@@ -51,6 +51,7 @@ class _StatefulElement extends StatefulElement with AttachableElementMixin {
 
 /// A [StatefulWidget] with [StatefulAttachableMixin], equivalent to
 /// `StatefulWidget with StatefulAttachableMixin`.
-abstract class StatefulWidgetWithAttachable extends StatefulWidget with StatefulAttachableMixin {
+abstract class StatefulWidgetWithAttachable extends StatefulWidget
+    with StatefulAttachableMixin {
   const StatefulWidgetWithAttachable({super.key});
 }
diff --git a/lib/src/attachable_mixin/stateless_attachable_mixin.dart b/lib/src/attachable_mixin/stateless_attachable_mixin.dart
@@ -51,6 +51,7 @@ class _StatelessElement extends StatelessElement with AttachableElementMixin {
 
 /// A [StatelessWidget] with [StatelessAttachableMixin], equivalent to
 /// `StatelessWidget with StatelessAttachableMixin`.
-abstract class StatelessWidgetWithAttachable extends StatelessWidget with StatelessAttachableMixin {
+abstract class StatelessWidgetWithAttachable extends StatelessWidget
+    with StatelessAttachableMixin {
   const StatelessWidgetWithAttachable({super.key});
 }
diff --git a/lib/src/cleanup_state.dart b/lib/src/cleanup_state.dart
@@ -31,9 +31,11 @@ abstract class CleanupState<T extends StatefulWidget> extends _CleanupState<T>
   }
 }
 
-abstract class _CleanupState<T extends StatefulWidget> extends State<T> with _CleanupMixin {}
+abstract class _CleanupState<T extends StatefulWidget> extends State<T>
+    with _CleanupMixin {}
 
-mixin _CleanupMixin implements CancelMixin, CloseMixin, DisposeMixin, StopMixin {
+mixin _CleanupMixin
+    implements CancelMixin, CloseMixin, DisposeMixin, StopMixin {
   @override
   FutureOr<void> cancel() {}
 
diff --git a/lib/src/context_store.dart b/lib/src/context_store.dart
@@ -116,7 +116,8 @@ class ContextStore {
   //
 
   /// Creates a `ContextStore` instance associated with the provided [context].
-  static AssociatedContextStore of(BuildContext context) => AssociatedContextStore(context);
+  static AssociatedContextStore of(BuildContext context) =>
+      AssociatedContextStore(context);
 
   //
   //
@@ -302,5 +303,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 FutureOrController;
-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) {
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 FutureOrController;
-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) {
diff --git a/lib/src/will_mixins/will_dispose/will_dispose_mixin.dart b/lib/src/will_mixins/will_dispose/will_dispose_mixin.dart
@@ -13,7 +13,8 @@
 import 'dart:async' show FutureOr;
 
 import 'package:df_type/df_type.dart' show FutureOrController;
-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 [willDispose].
 mixin WillDisposeMixin on DisposeMixin {
   /// The list of resources marked for dispose via [willDispose].
-  Set<_ToDisposeResource<dynamic>> get toDisposeResources => Set.unmodifiable(_toDisposeResources);
+  Set<_ToDisposeResource<dynamic>> get toDisposeResources =>
+      Set.unmodifiable(_toDisposeResources);
 
   final Set<_ToDisposeResource<dynamic>> _toDisposeResources = {};
 
@@ -48,11 +50,14 @@ mixin WillDisposeMixin on DisposeMixin {
     _verifyDisposeMethod(resource);
     final disposable = (
       resource: resource as dynamic,
-      onBeforeDispose: onBeforeDispose != null ? (dynamic e) => onBeforeDispose(e as T) : null,
+      onBeforeDispose: onBeforeDispose != null
+          ? (dynamic e) => onBeforeDispose(e as T)
+          : null,
     );
 
     // Check for any duplicate resource.
-    final duplicate = _toDisposeResources.where((e) => e.resource == resource).firstOrNull;
+    final duplicate =
+        _toDisposeResources.where((e) => e.resource == resource).firstOrNull;
 
     if (duplicate != null) {
       if (kDebugMode) {
@@ -163,7 +168,8 @@ final class WillAlreadyDisposeDebugError<T> extends Error {
   WillAlreadyDisposeDebugError(this.resource);
 
   @override
-  String toString() => '[$WillAlreadyDisposeDebugError] willDispose has already '
+  String toString() =>
+      '[$WillAlreadyDisposeDebugError] willDispose has already '
       'been called on the resource ${resource.hashCode} and of type $T.';
 }
 
diff --git a/lib/src/will_mixins/will_stop/will_stop_mixin.dart b/lib/src/will_mixins/will_stop/will_stop_mixin.dart
@@ -13,7 +13,8 @@
 import 'dart:async' show FutureOr;
 
 import 'package:df_type/df_type.dart' show FutureOrController;
-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 [willStop].
 mixin WillStopMixin on StopMixin {
   /// The list of resources marked for stop via [willStop].
-  Set<_ToStopResource<dynamic>> get toStopResources => Set.unmodifiable(_toStopResources);
+  Set<_ToStopResource<dynamic>> get toStopResources =>
+      Set.unmodifiable(_toStopResources);
 
   final Set<_ToStopResource<dynamic>> _toStopResources = {};
 
@@ -48,11 +50,13 @@ mixin WillStopMixin on StopMixin {
     _verifyStopMethod(resource);
     final disposable = (
       resource: resource as dynamic,
-      onBeforeStop: onBeforeStop != null ? (dynamic e) => onBeforeStop(e as T) : null,
+      onBeforeStop:
+          onBeforeStop != null ? (dynamic e) => onBeforeStop(e as T) : null,
     );
 
     // Check for any duplicate resource.
-    final duplicate = _toStopResources.where((e) => e.resource == resource).firstOrNull;
+    final duplicate =
+        _toStopResources.where((e) => e.resource == resource).firstOrNull;
 
     if (duplicate != null) {
       if (kDebugMode) {

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,8 @@ class TestAnimation extends StatefulWidget {`
`26`	`26`	`State<TestAnimation> createState() => _TestAnimationState();`
`27`	`27`	`}`
`28`	`28`
`29`		`-class _TestAnimationState extends State<TestAnimation> with SingleTickerProviderStateMixin {`
	`29`	`+class _TestAnimationState extends State<TestAnimation>`
	`30`	`+ with SingleTickerProviderStateMixin {`
`30`	`31`	`late AnimationController _controller;`
`31`	`32`	`late Animation<double> _animation;`
`32`	`33`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ class _StatefulElement extends StatefulElement with AttachableElementMixin {`
`51`	`51`
`52`	`52`	`/// A [StatefulWidget] with [StatefulAttachableMixin], equivalent to`
`53`	`53`	/// `StatefulWidget with StatefulAttachableMixin`.
`54`		`-abstract class StatefulWidgetWithAttachable extends StatefulWidget with StatefulAttachableMixin {`
	`54`	`+abstract class StatefulWidgetWithAttachable extends StatefulWidget`
	`55`	`+ with StatefulAttachableMixin {`
`55`	`56`	`const StatefulWidgetWithAttachable({super.key});`
`56`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ class _StatelessElement extends StatelessElement with AttachableElementMixin {`
`51`	`51`
`52`	`52`	`/// A [StatelessWidget] with [StatelessAttachableMixin], equivalent to`
`53`	`53`	/// `StatelessWidget with StatelessAttachableMixin`.
`54`		`-abstract class StatelessWidgetWithAttachable extends StatelessWidget with StatelessAttachableMixin {`
	`54`	`+abstract class StatelessWidgetWithAttachable extends StatelessWidget`
	`55`	`+ with StatelessAttachableMixin {`
`55`	`56`	`const StatelessWidgetWithAttachable({super.key});`
`56`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,9 +31,11 @@ abstract class CleanupState<T extends StatefulWidget> extends _CleanupState<T>`
`31`	`31`	`}`
`32`	`32`	`}`
`33`	`33`
`34`		`-abstract class _CleanupState<T extends StatefulWidget> extends State<T> with _CleanupMixin {}`
	`34`	`+abstract class _CleanupState<T extends StatefulWidget> extends State<T>`
	`35`	`+ with _CleanupMixin {}`
`35`	`36`
`36`		`-mixin _CleanupMixin implements CancelMixin, CloseMixin, DisposeMixin, StopMixin {`
	`37`	`+mixin _CleanupMixin`
	`38`	`+ implements CancelMixin, CloseMixin, DisposeMixin, StopMixin {`
`37`	`39`	`@override`
`38`	`40`	`FutureOr<void> cancel() {}`
`39`	`41`