fix: comply to lint rules

mcquenji · mcquenji · commit 087f402ca366 · 2026-02-04T21:48:12.000+01:00
diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -8,6 +8,9 @@ plugins:
         ignorable: true
       abstract_classes_should_set_log_group: true
       concrete_classes_should_set_log_tag: true
+      base_class:
+        ignorable: true
+        enabled: true
 analyzer:
   exclude:
     - "**/*.g.dart"
diff --git a/lib/src/domain/datasources/datasource.dart b/lib/src/domain/datasources/datasource.dart
@@ -1,4 +1,5 @@
 import 'package:get_it/get_it.dart' hide Disposable;
+import 'package:grumpy_annotations/grumpy_annotations.dart';
 import 'package:logging/logging.dart';
 import 'package:meta/meta.dart';
 import 'package:grumpy/grumpy.dart';
@@ -7,6 +8,7 @@ import 'package:grumpy/grumpy.dart';
 // ignore: datasources_must_extend_datasource
 /// A datasource is responsible for providing data from a specific source,
 /// such as a database, API, or local storage.
+@BaseClass(allowedLayers: {.domain, .infra})
 abstract class Datasource with LogMixin, Disposable, TelemetryMixin {
   /// A datasource is responsible for providing data from a specific source,
   /// such as a database, API, or local storage.
diff --git a/lib/src/domain/domain.dart b/lib/src/domain/domain.dart
@@ -1,3 +1,4 @@
 export 'models/models.dart';
 export 'datasources/datasources.dart';
 export 'services/services.dart';
+export 'errors/errors.dart';
diff --git a/lib/src/domain/errors/errors.dart b/lib/src/domain/errors/errors.dart
@@ -0,0 +1,2 @@
+export 'repo_state_error.dart';
+export 'no_repo_data_error.dart';
diff --git a/lib/src/domain/errors/no_repo_data_error.dart b/lib/src/domain/errors/no_repo_data_error.dart
@@ -0,0 +1,10 @@
+import 'package:grumpy/grumpy.dart';
+
+/// An error indicating that no data is available in a [RepoState].
+///
+/// Thrown when attempting to access data from a state that does not contain data.
+class NoRepoDataError extends RepoStateError {
+  /// Creates a [NoRepoDataError] for the given [state].
+  NoRepoDataError(RepoState state)
+    : super(state, 'No data available in RepoState. Current state: $state');
+}
diff --git a/lib/src/domain/errors/repo_state_error.dart b/lib/src/domain/errors/repo_state_error.dart
@@ -0,0 +1,14 @@
+import 'package:grumpy/grumpy.dart';
+import 'package:grumpy/src/domain/models/repo_state.dart';
+
+/// An error indicating an invalid state in a [RepoState].
+///
+/// Thrown when attempting to access data or error information
+/// that is not available in the current state.
+class RepoStateError extends StateError {
+  /// The [RepoState] that caused this error.
+  final RepoState state;
+
+  /// Creates a [RepoStateError] for the given [state] with an optional [message].
+  RepoStateError(this.state, super.message);
+}
diff --git a/lib/src/domain/models/leaf.dart b/lib/src/domain/models/leaf.dart
@@ -0,0 +1,27 @@
+import 'dart:async';
+
+import 'package:grumpy/grumpy.dart';
+
+// this is the base class for views.
+// ignore: views_must_extend_view, views_must_have_view_suffix
+/// The presentation of a route of type [T].
+abstract class Leaf<T> extends Model {
+  /// Creates a [Leaf].
+  const Leaf();
+
+  /// Builds a preview presentation of [T] while the route is being validated.
+  ///
+  /// This can be used to show a loading indicator or a placeholder while
+  /// a guard is being checked.
+  ///
+  /// Note: It is unsafe to perform navigation actions or to use
+  /// any module-dependent resources in this method, as the module
+  /// may not have been fully initialized yet when this method is called.
+  T preview(RouteContext ctx);
+
+  /// Builds the final presentation of [T] once the route has been validated.
+  FutureOr<T> content(RouteContext ctx);
+}
+
+// this is an extension of Route and not a view.
+// ignore: views_must_extend_view, views_must_have_view_suffix
diff --git a/lib/src/domain/models/leaf_route.dart b/lib/src/domain/models/leaf_route.dart
@@ -1,30 +1,5 @@
-import 'dart:async';
-
 import 'package:grumpy/grumpy.dart';
 
-// this is the base class for views.
-// ignore: views_must_extend_view, views_must_have_view_suffix
-/// The presentation of a route of type [T].
-abstract class Leaf<T> {
-  /// Creates a [Leaf].
-  const Leaf();
-
-  /// Builds a preview presentation of [T] while the route is being validated.
-  ///
-  /// This can be used to show a loading indicator or a placeholder while
-  /// a guard is being checked.
-  ///
-  /// Note: It is unsafe to perform navigation actions or to use
-  /// any module-dependent resources in this method, as the module
-  /// may not have been fully initialized yet when this method is called.
-  T preview(RouteContext ctx);
-
-  /// Builds the final presentation of [T] once the route has been validated.
-  FutureOr<T> content(RouteContext ctx);
-}
-
-// this is an extension of Route and not a view.
-// ignore: views_must_extend_view, views_must_have_view_suffix
 /// A route that directly renders a [Leaf] when matched.
 ///
 /// Use [LeafRoute] for leaf routes that don't require their own [Module]
diff --git a/lib/src/domain/models/model.dart b/lib/src/domain/models/model.dart
@@ -1,6 +1,9 @@
 // this is the base class.
 // ignore: models_must_extend_model
+import 'package:grumpy_annotations/grumpy_annotations.dart';
+
 /// Marker class for all models used in the grumpy.
+@BaseClass(allowedLayers: {.domain}, forceSuffix: false)
 abstract class Model {
   /// Marker class for all models used in the grumpy.
   const Model();
diff --git a/lib/src/domain/models/models.dart b/lib/src/domain/models/models.dart
@@ -5,3 +5,9 @@ export 'optimistic_policy.dart';
 export 'retry_policy.dart';
 export 'route.dart';
 export 'route_context.dart';
+export 'repo_loading_state.dart';
+export 'repo_data_state.dart';
+export 'repo_error_state.dart';
+export 'module_route.dart';
+export 'leaf_route.dart';
+export 'leaf.dart';
diff --git a/lib/src/domain/models/module_route.dart b/lib/src/domain/models/module_route.dart
@@ -0,0 +1,31 @@
+import 'package:grumpy/grumpy.dart';
+
+/// A route that activates a [Module] when matched.
+///
+/// Use [ModuleRoute] for feature- or domain-level entry points that should
+/// mount a dedicated [Module] (and its dependency graph) on navigation.
+class ModuleRoute<T, Config extends Object> extends Route<T, Config> {
+  /// The module that will be mounted when this route is activated.
+  final Module<T, Config> module;
+
+  /// The root [LeafRoute] of the module, if any.
+  ///
+  /// If not null, this [LeafRoute] will be used as the entry point
+  /// when navigating to this [ModuleRoute].
+  final LeafRoute<T, Config>? root;
+
+  /// Creates a [ModuleRoute] for the given [path] and [module].
+  ///
+  /// Optional [middleware] can be used to protect access to the module.
+  const ModuleRoute({
+    required super.path,
+    required this.module,
+    super.middleware,
+    this.root,
+  });
+
+  @override
+  String toString() {
+    return 'ModuleRoute(path: $path, module: $module, middleware: $middleware, root: $root)';
+  }
+}
diff --git a/lib/src/domain/models/repo_data_state.dart b/lib/src/domain/models/repo_data_state.dart
@@ -0,0 +1,24 @@
+import 'package:grumpy/grumpy.dart';
+
+/// Represents a data state in a [Repo] indicating successful data retrieval.
+class RepoDataState<T> extends RepoState<T> {
+  /// The data value contained in this state.
+  final T value;
+
+  /// Creates a [RepoDataState] with the given [value].
+  const RepoDataState(this.value);
+
+  @override
+  String toString() {
+    return 'RepoDataState(value: $value)';
+  }
+
+  @override
+  R when<R>({
+    required R Function(RepoDataState<T> data) data,
+    required R Function(RepoLoadingState<T> loading) loading,
+    required R Function(RepoErrorState<T> error) error,
+  }) {
+    return data(this);
+  }
+}
diff --git a/lib/src/domain/models/repo_error_state.dart b/lib/src/domain/models/repo_error_state.dart
@@ -0,0 +1,27 @@
+import 'package:grumpy/grumpy.dart';
+
+/// Represents an error state in a [Repo].
+class RepoErrorState<T> extends RepoState<T> {
+  /// The error object associated with this state.
+  final Object error;
+
+  /// The optional stack trace associated with this error.
+  final StackTrace? stackTrace;
+
+  /// Creates a [RepoErrorState] with the given [error] and optional [stackTrace].
+  const RepoErrorState(this.error, [this.stackTrace]);
+
+  @override
+  String toString() {
+    return 'RepoErrorState(error: $error, stackTrace: $stackTrace)';
+  }
+
+  @override
+  R when<R>({
+    required R Function(RepoDataState<T> data) data,
+    required R Function(RepoLoadingState<T> loading) loading,
+    required R Function(RepoErrorState<T> error) error,
+  }) {
+    return error(this);
+  }
+}
diff --git a/lib/src/domain/models/repo_loading_state.dart b/lib/src/domain/models/repo_loading_state.dart
@@ -0,0 +1,27 @@
+import 'package:grumpy/grumpy.dart';
+
+/// Represents a loading state in a [Repo] indicating that data is being fetched.
+class RepoLoadingState<T> extends RepoState<T> {
+  /// Creates a [RepoLoadingState].
+  const RepoLoadingState(this.timeStamp);
+
+  /// The timestamp when this loading state was created.
+  final DateTime timeStamp;
+
+  /// The duration since this loading state was created.
+  Duration get elapsed => DateTime.now().difference(timeStamp);
+
+  @override
+  String toString() {
+    return 'RepoLoadingState(timeStamp: $timeStamp)';
+  }
+
+  @override
+  R when<R>({
+    required R Function(RepoDataState<T> data) data,
+    required R Function(RepoLoadingState<T> loading) loading,
+    required R Function(RepoErrorState<T> error) error,
+  }) {
+    return loading(this);
+  }
+}
diff --git a/lib/src/domain/models/repo_state.dart b/lib/src/domain/models/repo_state.dart
@@ -76,103 +76,3 @@ abstract class RepoState<T> extends Model {
     required R Function(RepoErrorState<T> error) error,
   });
 }
-
-/// Represents a data state in a [Repo] indicating successful data retrieval.
-class RepoDataState<T> extends RepoState<T> {
-  /// The data value contained in this state.
-  final T value;
-
-  /// Creates a [RepoDataState] with the given [value].
-  const RepoDataState(this.value);
-
-  @override
-  String toString() {
-    return 'RepoDataState(value: $value)';
-  }
-
-  @override
-  R when<R>({
-    required R Function(RepoDataState<T> data) data,
-    required R Function(RepoLoadingState<T> loading) loading,
-    required R Function(RepoErrorState<T> error) error,
-  }) {
-    return data(this);
-  }
-}
-
-/// Represents a loading state in a [Repo] indicating that data is being fetched.
-class RepoLoadingState<T> extends RepoState<T> {
-  /// Creates a [RepoLoadingState].
-  const RepoLoadingState(this.timeStamp);
-
-  /// The timestamp when this loading state was created.
-  final DateTime timeStamp;
-
-  /// The duration since this loading state was created.
-  Duration get elapsed => DateTime.now().difference(timeStamp);
-
-  @override
-  String toString() {
-    return 'RepoLoadingState(timeStamp: $timeStamp)';
-  }
-
-  @override
-  R when<R>({
-    required R Function(RepoDataState<T> data) data,
-    required R Function(RepoLoadingState<T> loading) loading,
-    required R Function(RepoErrorState<T> error) error,
-  }) {
-    return loading(this);
-  }
-}
-
-/// Represents an error state in a [Repo].
-class RepoErrorState<T> extends RepoState<T> {
-  /// The error object associated with this state.
-  final Object error;
-
-  /// The optional stack trace associated with this error.
-  final StackTrace? stackTrace;
-
-  /// Creates a [RepoErrorState] with the given [error] and optional [stackTrace].
-  const RepoErrorState(this.error, [this.stackTrace]);
-
-  @override
-  String toString() {
-    return 'RepoErrorState(error: $error, stackTrace: $stackTrace)';
-  }
-
-  @override
-  R when<R>({
-    required R Function(RepoDataState<T> data) data,
-    required R Function(RepoLoadingState<T> loading) loading,
-    required R Function(RepoErrorState<T> error) error,
-  }) {
-    return error(this);
-  }
-}
-
-// this is an error class.
-// ignore: models_must_extend_model
-/// An error indicating an invalid state in a [RepoState].
-///
-/// Thrown when attempting to access data or error information
-/// that is not available in the current state.
-class RepoStateError extends StateError {
-  /// The [RepoState] that caused this error.
-  final RepoState state;
-
-  /// Creates a [RepoStateError] for the given [state] with an optional [message].
-  RepoStateError(this.state, super.message);
-}
-
-// this is an error class.
-// ignore: models_must_extend_model
-/// An error indicating that no data is available in a [RepoState].
-///
-/// Thrown when attempting to access data from a state that does not contain data.
-class NoRepoDataError extends RepoStateError {
-  /// Creates a [NoRepoDataError] for the given [state].
-  NoRepoDataError(RepoState state)
-    : super(state, 'No data available in RepoState. Current state: $state');
-}
diff --git a/lib/src/domain/models/route.dart b/lib/src/domain/models/route.dart
@@ -46,33 +46,3 @@ class Route<T, Config extends Object> extends Model {
     return 'Route(path: $path, middleware: $middleware, children: $children)';
   }
 }
-
-/// A route that activates a [Module] when matched.
-///
-/// Use [ModuleRoute] for feature- or domain-level entry points that should
-/// mount a dedicated [Module] (and its dependency graph) on navigation.
-class ModuleRoute<T, Config extends Object> extends Route<T, Config> {
-  /// The module that will be mounted when this route is activated.
-  final Module<T, Config> module;
-
-  /// The root [LeafRoute] of the module, if any.
-  ///
-  /// If not null, this [LeafRoute] will be used as the entry point
-  /// when navigating to this [ModuleRoute].
-  final LeafRoute<T, Config>? root;
-
-  /// Creates a [ModuleRoute] for the given [path] and [module].
-  ///
-  /// Optional [middleware] can be used to protect access to the module.
-  const ModuleRoute({
-    required super.path,
-    required this.module,
-    super.middleware,
-    this.root,
-  });
-
-  @override
-  String toString() {
-    return 'ModuleRoute(path: $path, module: $module, middleware: $middleware, root: $root)';
-  }
-}
diff --git a/lib/src/domain/services/routing_service.dart b/lib/src/domain/services/routing_service.dart
diff --git a/lib/src/domain/services/service.dart b/lib/src/domain/services/service.dart
diff --git a/lib/src/infra/services/routing_kit_routing_service.dart b/lib/src/infra/services/routing_kit_routing_service.dart
diff --git a/lib/src/infra/services/services.dart b/lib/src/infra/services/services.dart
diff --git a/lib/src/module.dart b/lib/src/module.dart
diff --git a/lib/src/presentation/views/views.dart b/lib/src/presentation/views/views.dart
diff --git a/pubspec.yaml b/pubspec.yaml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export 'repo_state_error.dart';`
	`2`	`+export 'no_repo_data_error.dart';`