refactor: IndexTrackingViewModel

lib/src/view_models/base_view_models.dart

@@ -2,9 +2,9 @@ import 'dart:async';
 
 import 'package:flutter/foundation.dart';
 import 'package:stacked/src/mixins/listenable_service_mixin.dart';
+import 'package:stacked/src/mixins/reactive_service_mixin.dart';
 import 'package:stacked/src/view_models/helpers/data_state_helper.dart';
 
-import '../mixins/reactive_service_mixin.dart';
 import 'helpers/builders_helpers.dart';
 import 'helpers/busy_error_state_helper.dart';
 import 'helpers/message_state_helper.dart';

lib/src/view_models/helpers/index_tracking_state_helper.dart

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:stacked/src/router/router_service_interface.dart';
 
 mixin IndexTrackingStateHelper on ChangeNotifier {
   int _currentIndex = 0;
@@ -21,4 +22,37 @@ mixin IndexTrackingStateHelper on ChangeNotifier {
   }
 
   bool isIndexSelected(int index) => _currentIndex == index;
+
+  /// Sets current index using current Route on Web Platform.
+  ///
+  /// Allows to get the index from url during a browser refresh which means the
+  /// app starts from scracth.
+  void setCurrentWebPageIndex(RouterServiceInterface service) {
+    if (!service.topRoute.hasPendingChildren) return;
+
+    int? currentWebPageIndex;
+
+    try {
+      currentWebPageIndex = service.router.routes
+          .firstWhere(
+            (route) => route.name == service.topRoute.name,
+          )
+          .children
+          ?.routes
+          .skipWhile((route) => route.name.startsWith('#'))
+          .toList()
+          .indexWhere(
+            (route) =>
+                route.name == service.topRoute.pendingChildren.first.name,
+          );
+    } on StateError catch (_) {
+      /// The route does not meet the condition in the firstWhere call
+    } catch (_) {
+      /// Catch everything else
+    }
+
+    if (currentWebPageIndex == null || currentWebPageIndex == -1) return;
+
+    setIndex(currentWebPageIndex);
+  }
 }

lib/src/view_models/index_tracking_viewmodel.dart

@@ -1,64 +1,12 @@
-import 'package:stacked/src/mixins/listenable_service_mixin.dart';
-import 'package:stacked/src/router/router_service_interface.dart';
-import 'package:stacked/src/view_models/base_view_models.dart';
+// import 'package:stacked/src/mixins/listenable_service_mixin.dart';
+// import 'package:stacked/src/router/router_service_interface.dart';
+// import 'package:stacked/src/view_models/base_view_models.dart';
+import 'package:stacked/stacked.dart';
 
 /// You can use [BaseViewModel] or [ReactiveViewModel] with a [IndexTrackingStateHelper]
 /// to achive the same result incase you want to combine multiple functionalities
-class IndexTrackingViewModel extends ReactiveViewModel {
-  int _currentIndex = 0;
-  int get currentIndex => _currentIndex;
-
-  bool _reverse = false;
-
-  /// Indicates whether we're going forward or backward in terms of the index we're changing.
-  /// This is very helpful for the page transition directions.
-  bool get reverse => _reverse;
-
-  void setIndex(int value) {
-    if (value < _currentIndex) {
-      _reverse = true;
-    } else {
-      _reverse = false;
-    }
-    _currentIndex = value;
-    notifyListeners();
-  }
-
-  bool isIndexSelected(int index) => _currentIndex == index;
-
+abstract class IndexTrackingViewModel extends ReactiveViewModel
+    with IndexTrackingStateHelper {
   @override
   List<ListenableServiceMixin> get listenableServices => [];
-
-  /// Sets current index using current Route on Web Platform.
-  ///
-  /// Allows to get the index from url during a browser refresh which means the
-  /// app starts from scracth.
-  void setCurrentWebPageIndex(RouterServiceInterface service) {
-    if (!service.topRoute.hasPendingChildren) return;
-
-    int? currentWebPageIndex;
-
-    try {
-      currentWebPageIndex = service.router.routes
-          .firstWhere(
-            (route) => route.name == service.topRoute.name,
-          )
-          .children
-          ?.routes
-          .skipWhile((route) => route.name.startsWith('#'))
-          .toList()
-          .indexWhere(
-            (route) =>
-                route.name == service.topRoute.pendingChildren.first.name,
-          );
-    } on StateError catch (_) {
-      /// The route does not meet the condition in the firstWhere call
-    } catch (_) {
-      /// Catch everything else
-    }
-
-    if (currentWebPageIndex == null || currentWebPageIndex == -1) return;
-
-    setIndex(currentWebPageIndex);
-  }
 }

test/index_tracking_viewmodel_test.dart → test/index_tracking_state_helper_test.dart

@@ -210,7 +210,7 @@ void main() {
           testRouter: TestRouter(),
           testTopRoute: getBottomNavExampleRouteData(),
         );
-        final viewModel = IndexTrackingViewModel();
+        final viewModel = TestIndexTrackingViewModel();
         viewModel.setIndex(0);
 
         viewModel.setCurrentWebPageIndex(service);
@@ -223,7 +223,7 @@ void main() {
           testRouter: TestRouter(),
           testTopRoute: getBottomNavExampleRouteData(),
         );
-        final viewModel = IndexTrackingViewModel();
+        final viewModel = TestIndexTrackingViewModel();
         var called = 0;
         viewModel.addListener(() {
           called++;
@@ -251,7 +251,7 @@ void main() {
             ],
           ),
         );
-        final viewModel = IndexTrackingViewModel();
+        final viewModel = TestIndexTrackingViewModel();
         var called = 0;
         viewModel.addListener(() {
           called++;
@@ -280,7 +280,7 @@ void main() {
             ],
           ),
         );
-        final viewModel = IndexTrackingViewModel();
+        final viewModel = TestIndexTrackingViewModel();
         var called = 0;
         viewModel.addListener(() {
           called++;
@@ -308,7 +308,7 @@ void main() {
             pendingChildren: [historyRouteMatch],
           ),
         );
-        final viewModel = IndexTrackingViewModel();
+        final viewModel = TestIndexTrackingViewModel();
         var called = 0;
         viewModel.addListener(() {
           called++;
@@ -337,7 +337,7 @@ void main() {
             pendingChildren: [historyRouteMatch],
           ),
         );
-        final viewModel = IndexTrackingViewModel();
+        final viewModel = TestIndexTrackingViewModel();
         var called = 0;
         viewModel.addListener(() {
           called++;
@@ -366,7 +366,7 @@ void main() {
             pendingChildren: [favoriteRouteMatch],
           ),
         );
-        final viewModel = IndexTrackingViewModel();
+        final viewModel = TestIndexTrackingViewModel();
         viewModel.setIndex(2);
 
         viewModel.setCurrentWebPageIndex(service);
@@ -392,7 +392,7 @@ void main() {
             pendingChildren: [historyRouteMatch],
           ),
         );
-        final viewModel = IndexTrackingViewModel();
+        final viewModel = TestIndexTrackingViewModel();
         viewModel.setIndex(0);
 
         viewModel.setCurrentWebPageIndex(service);
@@ -418,7 +418,7 @@ void main() {
             pendingChildren: [profileRouteMatch],
           ),
         );
-        final viewModel = IndexTrackingViewModel();
+        final viewModel = TestIndexTrackingViewModel();
         viewModel.setIndex(0);
 
         viewModel.setCurrentWebPageIndex(service);