refactor: Replace createState with registerState.

CarLeonDev · CarLeonDev · commit 558ea96b8885 · 2025-02-23T00:27:17.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,7 +13,7 @@
 - Add [`debugLabel`](https://pub.dev/documentation/reactter/8.0.0-dev.31/reactter/RtState/debugLabel.html) and [`debugInfo`](https://pub.dev/documentation/reactter/8.0.0-dev.31/reactter/RtState/debugInfo.html) to states and hooks to get info for debugging.
 - Add [`RtContextMixin`](https://pub.dev/documentation/reactter/8.0.0-dev.31/reactter/RtContextMixin-mixin.html) mixin to provide access to the `Rt` instance.
 - Add [`RtState`](https://pub.dev/documentation/reactter/8.0.0-dev.31/reactter/RtState-class.html) abstract class to implement the base logic of the state.
-- Add [`Rt.createState`](https://pub.dev/documentation/reactter/8.0.0-dev.31/reactter/RtInterface/createState.html) method to create a new state.
+- Add [`Rt.registerState`](https://pub.dev/documentation/reactter/8.0.0-dev.31/reactter/RtInterface/registerState.html) method to create a new state.
 - Add [`Rt.getRefAt`](https://pub.dev/documentation/reactter/8.0.0-dev.31/reactter/RtInterface/getRefAt.html) to get the reference of dependency created.
 - Add [`initHook`](https://pub.dev/documentation/reactter/8.0.0-dev.31/reactter/RtHook/initHook.html) method to `RtHook` to call when hook is created.
 - Add [`cancel`](https://pub.dev/documentation/reactter/8.0.0-dev.31/reactter/UseAsyncState/cancel.html) method to `UseAsyncState` to cancel current method.
diff --git a/packages/flutter_reactter/example/lib/examples/6_tree/states/tree_list.dart b/packages/flutter_reactter/example/lib/examples/6_tree/states/tree_list.dart
@@ -7,7 +7,7 @@ class TreeList extends LinkedList<TreeNode> with RtState {
   TreeList._();
 
   factory TreeList() {
-    return Rt.createState(() => TreeList._());
+    return Rt.registerState(() => TreeList._());
   }
 
   @override
diff --git a/packages/flutter_reactter/example/lib/examples/6_tree/states/tree_node.dart b/packages/flutter_reactter/example/lib/examples/6_tree/states/tree_node.dart
@@ -80,7 +80,7 @@ class TreeNode extends LinkedListEntry<TreeNode> with RtState {
   /// and keep it in memory until it is destroyed.
   factory TreeNode([TreeNode? parent]) {
     return Rt.singleton(
-      () => Rt.createState(() {
+      () => Rt.registerState(() {
         return TreeNode._(parent);
       }),
       id: _lastId.toString(),
diff --git a/packages/reactter/lib/src/core/state_management.dart b/packages/reactter/lib/src/core/state_management.dart
@@ -14,10 +14,10 @@ abstract class StateManagement<S extends IState> implements IContext {
 
   final LinkedHashMap<EventNotifier, Object?> _deferredEvents = LinkedHashMap();
 
-  /// Creates a new state by invoking the provided `buildState` function.
+  /// Register a new state by invoking the provided `buildState` function.
   ///
   /// The `buildState` function should return an instance of a class that extends [S].
-  /// The created state is automatically bound to the current binding zone using `BindingZone.autoBinding`.
+  /// The register state is automatically bound to the current binding zone using `BindingZone.autoBinding`.
   ///
   /// Example usage:
   /// ```dart
@@ -30,11 +30,11 @@ abstract class StateManagement<S extends IState> implements IContext {
   ///   }
   /// }
   ///
-  /// final state = Rt.createState<MyState>(() => MyState());
+  /// final state = Rt.registerState<MyState>(() => MyState());
   /// ```
   ///
-  /// Returns the created state.
-  T createState<T extends S>(T Function() buildState) {
+  /// Returns [T] state.
+  T registerState<T extends S>(T Function() buildState) {
     return BindingZone.autoBinding(buildState);
   }
 
diff --git a/packages/reactter/lib/src/framework/rt_state.dart b/packages/reactter/lib/src/framework/rt_state.dart
@@ -3,7 +3,7 @@ part of '../internals.dart';
 /// {@template reactter.rt_state}
 /// A base class for creating a state object in Reactter.
 ///
-/// The state object must be registered using the [Rt.createState] method or
+/// The state object must be registered using the [Rt.registerState] method or
 /// registered as a dependency using the dependency injection. e.g.
 ///
 /// ```dart
@@ -16,11 +16,11 @@ part of '../internals.dart';
 ///   }
 /// }
 ///
-/// final state = Rt.createState<MyState>(() => MyState());
+/// final state = Rt.registerState<MyState>(() => MyState());
 /// ```
 ///
 /// See also:
-/// - [Rt.createState], for creating a state object.
+/// - [Rt.registerState], for register a state object.
 ///
 /// {@endtemplate}
 abstract class RtState implements IState {
@@ -36,7 +36,7 @@ abstract class RtState implements IState {
       if (!isRegistering) {
         throw AssertionError(
           "The state must be create within the BindingZone.\n"
-          "You can use the 'Rt.createState' method or register as dependency "
+          "You can use the 'Rt.registerState' method or register as dependency "
           "using the dependency injection to ensure that the state is registered.",
         );
       }
diff --git a/packages/reactter/lib/src/signal/signal.dart b/packages/reactter/lib/src/signal/signal.dart
@@ -125,7 +125,7 @@ class Signal<T> with RtState {
         _debugLabel = debugLabel;
 
   factory Signal(T value, {String? debugLabel}) {
-    return Rt.createState(() => Signal._(value, debugLabel: debugLabel));
+    return Rt.registerState(() => Signal._(value, debugLabel: debugLabel));
   }
 
   /// Gets and/or sets to [value] like a function
diff --git a/packages/reactter/test/framework/rt_state_base_test.dart b/packages/reactter/test/framework/rt_state_base_test.dart
@@ -29,7 +29,7 @@ class StateTest with RtState {
   }
 
   factory StateTest() {
-    return Rt.createState(() => StateTest._());
+    return Rt.registerState(() => StateTest._());
   }
 
   @override
@@ -41,7 +41,7 @@ void main() {
     test('should create a state object within the BindingZone', () {
       expect(() => CountTest(), throwsA(isA<AssertionError>()));
 
-      final countState = Rt.createState(() => CountTest());
+      final countState = Rt.registerState(() => CountTest());
       expect(countState.debugLabel, 'CountTest');
 
       final state = StateTest();
@@ -62,15 +62,15 @@ void main() {
     });
 
     test('should update the state', () {
-      final countState = Rt.createState(() => CountTest());
+      final countState = Rt.registerState(() => CountTest());
       expect(countState.count, 0);
 
       countState.count = 1;
       expect(countState.count, 1);
     });
 
     test('should have debug info', () {
-      final countState = Rt.createState(() => CountTest());
+      final countState = Rt.registerState(() => CountTest());
       expect(countState.debugInfo, {"count": 0});
 
       countState.count = 1;
diff --git a/packages/reactter/test/logger_test.dart b/packages/reactter/test/logger_test.dart
@@ -6,7 +6,7 @@ class StateTest with RtState {
   StateTest._();
 
   factory StateTest() {
-    return Rt.createState(() => StateTest._());
+    return Rt.registerState(() => StateTest._());
   }
 
   @override
diff --git a/packages/reactter_devtools_extension/lib/src/bases/tree_list.dart b/packages/reactter_devtools_extension/lib/src/bases/tree_list.dart
@@ -3,13 +3,12 @@ import 'dart:collection';
 import 'package:flutter_reactter/reactter.dart';
 import 'package:reactter_devtools_extension/src/bases/tree_node.dart';
 
-base class TreeList<E extends TreeNode<E>> extends LinkedList<E>
-    with RtState {
+base class TreeList<E extends TreeNode<E>> extends LinkedList<E> with RtState {
   final uMaxDepth = UseState(0);
 
   TreeList._();
 
-  factory TreeList() => Rt.createState(() => TreeList<E>._());
+  factory TreeList() => Rt.registerState(() => TreeList<E>._());
 
   @override
   void add(E entry) => update(() => super.add(entry));
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/dart/closure_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/dart/closure_node.dart
@@ -16,7 +16,7 @@ final class ClosureNode extends AsyncNode {
   });
 
   factory ClosureNode({required String key, required InstanceRef instanceRef}) {
-    return Rt.createState(
+    return Rt.registerState(
       () => ClosureNode.$(
         key: key,
         instanceRef: instanceRef,
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/dart/iterable_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/dart/iterable_node.dart
@@ -18,7 +18,7 @@ final class IterableNode extends AsyncNode {
     required String key,
     required InstanceRef instanceRef,
   }) {
-    return Rt.createState(
+    return Rt.registerState(
       () => IterableNode.$(
         key: key,
         instanceRef: instanceRef,
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/dart/key_value_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/dart/key_value_node.dart
@@ -26,7 +26,7 @@ final class KeyValueNode extends Node {
     required String value,
     required String kind,
   }) {
-    return Rt.createState(
+    return Rt.registerState(
       () => KeyValueNode.$(key: key, value: value, kind: kind),
     );
   }
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/dart/map_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/dart/map_node.dart
@@ -15,7 +15,7 @@ final class MapNode extends AsyncNode {
   });
 
   factory MapNode({required String key, required InstanceRef instanceRef}) {
-    return Rt.createState(
+    return Rt.registerState(
       () => MapNode.$(key: key, instanceRef: instanceRef),
     );
   }
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/dart/plain_instance_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/dart/plain_instance_node.dart
@@ -20,7 +20,7 @@ base class PlainInstanceNode extends AsyncNode {
     required String key,
     required InstanceRef instanceRef,
   }) {
-    return Rt.createState(
+    return Rt.registerState(
       () => PlainInstanceNode._(
         key: key,
         instanceRef: instanceRef,
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/dart/record_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/dart/record_node.dart
@@ -15,7 +15,7 @@ final class RecordNode extends AsyncNode {
   });
 
   factory RecordNode({required String key, required InstanceRef instanceRef}) {
-    return Rt.createState(
+    return Rt.registerState(
       () => RecordNode.$(
         key: key,
         instanceRef: instanceRef,
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/dependency/dependency_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/dependency/dependency_node.dart
@@ -8,7 +8,7 @@ final class DependencyNode extends InstanceNode<DependencyInfo> {
   DependencyNode.$({required super.key}) : super.$();
 
   factory DependencyNode({required String key}) {
-    return Rt.createState(
+    return Rt.registerState(
       () => DependencyNode.$(key: key),
     );
   }
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/instance/instance_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/instance/instance_node.dart
@@ -11,7 +11,7 @@ base class InstanceNode<I extends InstanceInfo> extends Node<I> {
       : super(kind: InstanceKind.kPlainInstance);
 
   factory InstanceNode({required String key}) {
-    return Rt.createState(
+    return Rt.registerState(
       () => InstanceNode.$(key: key),
     );
   }
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/sentinel_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/sentinel_node.dart
@@ -6,7 +6,7 @@ final class SentinelNode extends Node<NodeInfo> {
   SentinelNode._({required super.key}) : super(kind: 'sentinel');
 
   factory SentinelNode({required String key}) {
-    return Rt.createState(
+    return Rt.registerState(
       () => SentinelNode._(key: key),
     );
   }
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/slot_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/slot_node.dart
@@ -6,7 +6,7 @@ final class SlotNode extends Node<NodeInfo> {
   SlotNode._({required super.key}) : super(kind: 'slot');
 
   factory SlotNode({required String key}) {
-    return Rt.createState(
+    return Rt.registerState(
       () => SlotNode._(key: key),
     );
   }
diff --git a/packages/reactter_devtools_extension/lib/src/nodes/state/state_node.dart b/packages/reactter_devtools_extension/lib/src/nodes/state/state_node.dart
@@ -11,7 +11,7 @@ final class StateNode extends InstanceNode<StateInfo> {
   StateNode.$({required super.key}) : super.$();
 
   factory StateNode({required String key}) {
-    return Rt.createState(
+    return Rt.registerState(
       () => StateNode.$(key: key),
     );
   }
diff --git a/packages/reactter_lint/README.md b/packages/reactter_lint/README.md
@@ -179,32 +179,32 @@ class MyState with RtState<MyState> {...}
 
 #### God
 
-Fix: Use `Rt.createState` method for creating the state under the Reactter context.
+Fix: Use `Rt.registerState` method for registering the state under the Reactter context.
 
 ```dart
 class MyState with RtState<MyState> {...}
 
-final myState = Rt.createState(() => MyState());
+final myState = Rt.registerState(() => MyState());
 ```
 
 ### rt_no_logic_in_create_state
 
-Don't put logic in `createState` method
+Don't put logic in `registerState` method
 
 #### Bad
 
-Cause: The `createState` method includes additional logic.
+Cause: The `registerState` method includes additional logic.
 
 ```dart
-> final myState = Rt.createState(() {
+> final myState = Rt.registerState(() {
 >   final inst = MyState();
 >   inst.foo();
 >   return inst;
 > });
 ```
 
 ```dart
-> final myState = Rt.createState(() {
+> final myState = Rt.registerState(() {
 >   if (flag) return MyState();
 >
 >   return OtherState();
@@ -213,17 +213,17 @@ Cause: The `createState` method includes additional logic.
 
 #### God
 
-Fix: Try moving the logic out of `createState` method.
+Fix: Try moving the logic out of `registerState` method.
 
 ```dart
-final myState = Rt.createState(() => MyState());
+final myState = Rt.registerState(() => MyState());
 myState.foo();
 ```
 
 ```dart
 final myState = flag 
-  ? Rt.createState(() => MyState())
-  : Rt.createState(() => OtherState());
+  ? Rt.registerState(() => MyState())
+  : Rt.registerState(() => OtherState());
 ```
 
 ### rt_state_late_convention
diff --git a/packages/reactter_lint/lib/reactter_lint.dart b/packages/reactter_lint/lib/reactter_lint.dart
@@ -19,7 +19,7 @@ class _ReactterLinter extends PluginBase {
       RtHookNameConvention(),
       RtInvalidHookPosition(),
       RtInvalidHookRegister(),
-      RtNoLogicInCreateState(),
+      RtNoLogicInRegisterState(),
       RtInvalidStateCreation(),
     ];
   }
diff --git a/packages/reactter_lint/lib/src/rules/rt_invalid_state_creation.dart b/packages/reactter_lint/lib/src/rules/rt_invalid_state_creation.dart
@@ -11,8 +11,9 @@ class RtInvalidStateCreation extends DartLintRule {
   static const _code = LintCode(
     name: "rt_invalid_state_creation",
     errorSeverity: ErrorSeverity.WARNING,
-    problemMessage: "The `{0}` state must be create under the Reactter context.",
-    correctionMessage: "Use `Rt.createState` method.",
+    problemMessage:
+        "The `{0}` state must be create under the Reactter context.",
+    correctionMessage: "Use `Rt.registerState` method.",
   );
 
   @override
@@ -37,12 +38,12 @@ class RtInvalidStateCreation extends DartLintRule {
       final methodInvocation = node.thisOrAncestorOfType<MethodInvocation>();
       final targetType = methodInvocation?.realTarget?.staticType;
       final methodName = methodInvocation?.methodName.staticElement;
-      final isCreateState = targetType != null &&
+      final isRegisterState = targetType != null &&
           methodName != null &&
           rtInterface.isAssignableFromType(targetType) &&
-          createStateType.isAssignableFrom(methodName);
+          registerStateType.isAssignableFrom(methodName);
 
-      if (methodInvocation == null || !isCreateState) return onInvalid(node);
+      if (methodInvocation == null || !isRegisterState) return onInvalid(node);
 
       final functionArg = methodInvocation.argumentList.arguments
           .whereType<FunctionExpression>()
@@ -64,7 +65,7 @@ class RtInvalidStateCreation extends DartLintRule {
     });
   }
 
-  bool isUsedCreateStateMethod(Set<AstNode> nodes, FunctionBody body) {
+  bool isUsedRegisterStateMethod(Set<AstNode> nodes, FunctionBody body) {
     final returnExpression = body.returnExpression;
     print(
         "RETURN EXPRESSION: $returnExpression, ${returnExpression.runtimeType}");
@@ -116,14 +117,14 @@ class _RtInvalidStateCreationFix extends DartFix {
         try {
           final changeBuilder = reporter.createChangeBuilder(
             message:
-                "Convert '${node.toString()}' to use `Rt.createState` method.",
+                "Convert '${node.toString()}' to use `Rt.registerState` method.",
             priority: 1,
           );
 
           changeBuilder.addDartFileEdit((builder) {
             builder.addSimpleReplacement(
               node.sourceRange,
-              "Rt.createState(() => ${node.toString()})",
+              "Rt.registerState(() => ${node.toString()})",
             );
           });
         } catch (e) {
diff --git a/packages/reactter_lint/lib/src/rules/rt_no_logic_in_create_state.dart b/packages/reactter_lint/lib/src/rules/rt_no_logic_in_create_state.dart
diff --git a/packages/reactter_lint/lib/src/types.dart b/packages/reactter_lint/lib/src/types.dart

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ class TreeList extends LinkedList<TreeNode> with RtState {`
`7`	`7`	`TreeList._();`
`8`	`8`
`9`	`9`	`factory TreeList() {`
`10`		`- return Rt.createState(() => TreeList._());`
	`10`	`+ return Rt.registerState(() => TreeList._());`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`@override`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ class Signal<T> with RtState {`
`125`	`125`	`_debugLabel = debugLabel;`
`126`	`126`
`127`	`127`	`factory Signal(T value, {String? debugLabel}) {`
`128`		`- return Rt.createState(() => Signal._(value, debugLabel: debugLabel));`
	`128`	`+ return Rt.registerState(() => Signal._(value, debugLabel: debugLabel));`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`/// Gets and/or sets to [value] like a function`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ class StateTest with RtState {`
`6`	`6`	`StateTest._();`
`7`	`7`
`8`	`8`	`factory StateTest() {`
`9`		`- return Rt.createState(() => StateTest._());`
	`9`	`+ return Rt.registerState(() => StateTest._());`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`@override`