Merge branch '74-normalize-activity-application-architecture' into 'master'

Resolve "Normalize Activity application architecture"

Closes #74

See merge request !70

fastlane/metadata/android/en-US/changelogs/66.txt

+Normalize Activity application architecture.

fastlane/metadata/android/fr-FR/changelogs/66.txt

+Harmonisation des applications en Activity.

lib/config/activity_page.dart → lib/common/config/activity_page.dart

 import 'package:flutter/material.dart';
 import 'package:ionicons/ionicons.dart';
 
-import 'package:scrobbles/ui/pages/discoveries.dart';
-import 'package:scrobbles/ui/pages/home.dart';
-import 'package:scrobbles/ui/pages/statistics.dart';
+import 'package:scrobbles/common/ui/pages/discoveries.dart';
+import 'package:scrobbles/common/ui/pages/home.dart';
+import 'package:scrobbles/common/ui/pages/statistics.dart';
 
 class ActivityPageItem {
+  final String code;
   final Icon icon;
   final Widget page;
-  final String code;
 
   const ActivityPageItem({
+    required this.code,
     required this.icon,
     required this.page,
-    required this.code,
   });
 }
 
 class ActivityPage {
+  static const bool displayBottomNavBar = false;
+
   static const indexHome = 0;
   static const pageHome = ActivityPageItem(
+    code: 'page_home',
     icon: Icon(Ionicons.home_outline),
     page: PageHome(),
-    code: 'page_home',
   );
 
   static const indexDiscoveries = 1;
   static const pageDiscoveries = ActivityPageItem(
+    code: 'page_discoveries',
     icon: Icon(Ionicons.star_outline),
     page: PageDiscoveries(),
-    code: 'page_discoveries',
   );
 
   static const indexStatistics = 2;
   static const pageStatistics = ActivityPageItem(
+    code: 'page_statistics',
     icon: Icon(Ionicons.bar_chart_outline),
     page: PageStatistics(),
-    code: 'page_statistics',
   );
 
   static Map<int, ActivityPageItem> items = {
@@ -45,17 +47,13 @@ class ActivityPage {
     indexStatistics: pageStatistics,
   };
 
+  static int defaultPageIndex = indexHome;
+
   static bool isIndexAllowed(int pageIndex) {
     return items.keys.contains(pageIndex);
   }
 
-  static ActivityPageItem getPageItem(int pageIndex) {
-    return items[pageIndex] ?? pageHome;
-  }
-
-  static Widget getPageWidget(int pageIndex) {
+  static Widget getWidget(int pageIndex) {
     return items[pageIndex]?.page ?? pageHome.page;
   }
-
-  static int itemsCount = ActivityPage.items.length;
 }

lib/config/screen.dart → lib/common/config/screen.dart

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:scrobbles/ui/screens/about.dart';
-import 'package:scrobbles/ui/screens/activity.dart';
-import 'package:scrobbles/ui/screens/settings.dart';
+import 'package:scrobbles/common/ui/screens/about.dart';
+import 'package:scrobbles/common/ui/screens/activity.dart';
+import 'package:scrobbles/common/ui/screens/settings.dart';
 
 class ScreenItem {
+  final String code;
   final Icon icon;
   final Widget screen;
-  final bool displayBottomNavBar;
 
   const ScreenItem({
+    required this.code,
     required this.icon,
     required this.screen,
-    required this.displayBottomNavBar,
   });
 }
 
 class Screen {
   static const indexActivity = 0;
   static const screenActivity = ScreenItem(
+    code: 'screen_activity',
     icon: Icon(UniconsLine.home),
     screen: ScreenActivity(),
-    displayBottomNavBar: true,
   );
 
   static const indexSettings = 1;
   static const screenSettings = ScreenItem(
+    code: 'screen_settings',
     icon: Icon(UniconsLine.setting),
     screen: ScreenSettings(),
-    displayBottomNavBar: false,
   );
 
   static const indexAbout = 2;
   static const screenAbout = ScreenItem(
+    code: 'screen_about',
     icon: Icon(UniconsLine.info_circle),
     screen: ScreenAbout(),
-    displayBottomNavBar: false,
   );
 
   static Map<int, ScreenItem> items = {
@@ -52,10 +52,4 @@ class Screen {
   static Widget getWidget(int screenIndex) {
     return items[screenIndex]?.screen ?? screenActivity.screen;
   }
-
-  static bool displayBottomNavBar(int screenIndex) {
-    return items[screenIndex]?.displayBottomNavBar ?? screenActivity.displayBottomNavBar;
-  }
-
-  static int itemsCount = Screen.items.length;
 }

lib/cubit/nav_cubit_pages.dart → lib/common/cubit/nav/nav_cubit_pages.dart

 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:scrobbles/config/activity_page.dart';
+import 'package:scrobbles/common/config/activity_page.dart';
 
 class NavCubitPage extends HydratedCubit<int> {
   NavCubitPage() : super(0);
@@ -13,8 +13,8 @@ class NavCubitPage extends HydratedCubit<int> {
     }
   }
 
-  void goToHomePage() {
-    emit(ActivityPage.indexHome);
+  void goToPageHome() {
+    updateIndex(ActivityPage.indexHome);
   }
 
   @override
@@ -24,6 +24,6 @@ class NavCubitPage extends HydratedCubit<int> {
 
   @override
   Map<String, dynamic>? toJson(int state) {
-    return <String, int>{'pageIndex': state};
+    return <String, int>{'index': state};
   }
 }

lib/cubit/nav_cubit_screens.dart → lib/common/cubit/nav/nav_cubit_screens.dart

 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:scrobbles/config/screen.dart';
+import 'package:scrobbles/common/config/screen.dart';
 
 class NavCubitScreen extends HydratedCubit<int> {
   NavCubitScreen() : super(0);
@@ -9,19 +9,19 @@ class NavCubitScreen extends HydratedCubit<int> {
     if (Screen.isIndexAllowed(index)) {
       emit(index);
     } else {
-      goToActivityPage();
+      goToScreenActivity();
     }
   }
 
-  void goToActivityPage() {
+  void goToScreenActivity() {
     emit(Screen.indexActivity);
   }
 
-  void goToSettingsPage() {
+  void goToScreenSettings() {
     emit(Screen.indexSettings);
   }
 
-  void goToAboutPage() {
+  void goToScreenAbout() {
     emit(Screen.indexAbout);
   }
 
@@ -32,6 +32,6 @@ class NavCubitScreen extends HydratedCubit<int> {
 
   @override
   Map<String, dynamic>? toJson(int state) {
-    return <String, int>{'screenIndex': state};
+    return <String, int>{'index': state};
   }
 }

lib/ui/nav/bottom_nav_bar.dart → lib/common/ui/nav/bottom_nav_bar.dart

@@ -2,13 +2,16 @@ import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 import 'package:flutter_swipe/flutter_swipe.dart';
 
-import 'package:scrobbles/config/activity_page.dart';
-import 'package:scrobbles/cubit/nav_cubit_pages.dart';
+import 'package:scrobbles/common/config/activity_page.dart';
+import 'package:scrobbles/common/cubit/nav/nav_cubit_pages.dart';
 
 class BottomNavBar extends StatelessWidget {
-  const BottomNavBar({super.key, required this.swipeController});
+  const BottomNavBar({
+    super.key,
+    this.swipeController,
+  });
 
-  final SwiperController swipeController;
+  final SwiperController? swipeController;
 
   @override
   Widget build(BuildContext context) {
@@ -20,23 +23,20 @@ class BottomNavBar extends StatelessWidget {
       shape: const ContinuousRectangleBorder(),
       child: BlocBuilder<NavCubitPage, int>(
         builder: (BuildContext context, int pageIndex) {
-          final List<ActivityPageItem> pageItems = [
-            ActivityPage.pageHome,
-            ActivityPage.pageDiscoveries,
-            ActivityPage.pageStatistics,
-          ];
-          final List<BottomNavigationBarItem> items = pageItems.map((ActivityPageItem item) {
-            return BottomNavigationBarItem(
+          final List<BottomNavigationBarItem> items = [];
+
+          ActivityPage.items.forEach((int pageIndex, ActivityPageItem item) {
+            items.add(BottomNavigationBarItem(
               icon: item.icon,
               label: tr(item.code),
-            );
-          }).toList();
+            ));
+          });
 
           return BottomNavigationBar(
             currentIndex: pageIndex,
             onTap: (int index) {
               BlocProvider.of<NavCubitPage>(context).updateIndex(index);
-              swipeController.move(index);
+              swipeController?.move(index);
             },
             type: BottomNavigationBarType.fixed,
             elevation: 0,

lib/ui/nav/global_app_bar.dart → lib/common/ui/nav/global_app_bar.dart

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:scrobbles/cubit/data_counts_by_day_cubit.dart';
-import 'package:scrobbles/cubit/data_counts_by_hour_cubit.dart';
-import 'package:scrobbles/cubit/data_discoveries_cubit.dart';
-import 'package:scrobbles/cubit/data_heatmap_cubit.dart';
-import 'package:scrobbles/cubit/data_new_artists_cubit.dart';
-import 'package:scrobbles/cubit/data_new_tracks_cubit.dart';
-import 'package:scrobbles/cubit/data_statistics_global_cubit.dart';
-import 'package:scrobbles/cubit/data_statistics_recent_cubit.dart';
-import 'package:scrobbles/cubit/data_timeline_cubit.dart';
-import 'package:scrobbles/cubit/data_top_artists_cubit.dart';
-import 'package:scrobbles/cubit/nav_cubit_pages.dart';
-import 'package:scrobbles/config/screen.dart';
-import 'package:scrobbles/cubit/nav_cubit_screens.dart';
+import 'package:scrobbles/common/config/screen.dart';
+import 'package:scrobbles/common/cubit/nav/nav_cubit_pages.dart';
+import 'package:scrobbles/common/cubit/nav/nav_cubit_screens.dart';
+
+import 'package:scrobbles/cubit/activity/data_counts_by_day_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_counts_by_hour_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_discoveries_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_heatmap_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_new_artists_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_new_tracks_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_statistics_global_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_statistics_recent_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_timeline_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_top_artists_cubit.dart';
 
 class GlobalAppBar extends StatelessWidget implements PreferredSizeWidget {
   const GlobalAppBar({super.key});
@@ -28,7 +29,7 @@ class GlobalAppBar extends StatelessWidget implements PreferredSizeWidget {
           // go to Settings page
           menuActions.add(IconButton(
             onPressed: () {
-              BlocProvider.of<NavCubitScreen>(context).goToSettingsPage();
+              BlocProvider.of<NavCubitScreen>(context).goToScreenSettings();
             },
             icon: Screen.screenSettings.icon,
           ));
@@ -36,7 +37,7 @@ class GlobalAppBar extends StatelessWidget implements PreferredSizeWidget {
           // go to About page
           menuActions.add(IconButton(
             onPressed: () {
-              BlocProvider.of<NavCubitScreen>(context).goToAboutPage();
+              BlocProvider.of<NavCubitScreen>(context).goToScreenAbout();
             },
             icon: Screen.screenAbout.icon,
           ));
@@ -61,8 +62,8 @@ class GlobalAppBar extends StatelessWidget implements PreferredSizeWidget {
           // back to Home page
           menuActions.add(IconButton(
             onPressed: () {
-              BlocProvider.of<NavCubitScreen>(context).goToActivityPage();
-              BlocProvider.of<NavCubitPage>(context).goToHomePage();
+              BlocProvider.of<NavCubitScreen>(context).goToScreenActivity();
+              BlocProvider.of<NavCubitPage>(context).goToPageHome();
             },
             icon: Screen.screenActivity.icon,
           ));

lib/ui/pages/discoveries.dart → lib/common/ui/pages/discoveries.dart

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:scrobbles/cubit/data_discoveries_cubit.dart';
-import 'package:scrobbles/cubit/data_new_artists_cubit.dart';
-import 'package:scrobbles/cubit/data_new_tracks_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_discoveries_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_new_artists_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_new_tracks_cubit.dart';
 import 'package:scrobbles/ui/widgets/cards/discoveries.dart';
 import 'package:scrobbles/ui/widgets/cards/new_artists.dart';
 import 'package:scrobbles/ui/widgets/cards/new_tracks.dart';

lib/ui/pages/home.dart → lib/common/ui/pages/home.dart

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:scrobbles/cubit/data_statistics_global_cubit.dart';
-import 'package:scrobbles/cubit/data_statistics_recent_cubit.dart';
-import 'package:scrobbles/cubit/data_timeline_cubit.dart';
-import 'package:scrobbles/cubit/data_top_artists_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_statistics_global_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_statistics_recent_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_timeline_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_top_artists_cubit.dart';
 import 'package:scrobbles/ui/widgets/cards/statistics_global.dart';
 import 'package:scrobbles/ui/widgets/cards/statistics_recent.dart';
 import 'package:scrobbles/ui/widgets/cards/timeline.dart';

lib/ui/pages/statistics.dart → lib/common/ui/pages/statistics.dart

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:scrobbles/cubit/data_counts_by_day_cubit.dart';
-import 'package:scrobbles/cubit/data_counts_by_hour_cubit.dart';
-import 'package:scrobbles/cubit/data_heatmap_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_counts_by_day_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_counts_by_hour_cubit.dart';
+import 'package:scrobbles/cubit/activity/data_heatmap_cubit.dart';
 import 'package:scrobbles/ui/widgets/cards/counts_by_day.dart';
 import 'package:scrobbles/ui/widgets/cards/counts_by_hour.dart';
 import 'package:scrobbles/ui/widgets/cards/heatmap.dart';

lib/ui/screens/about.dart → lib/common/ui/screens/about.dart

@@ -14,7 +14,7 @@ class ScreenAbout extends StatelessWidget {
         mainAxisSize: MainAxisSize.max,
         children: <Widget>[
           const SizedBox(height: 8),
-          AppTitle(text: tr('about_title')),
+          const AppTitle(text: 'about_title'),
           const Text('about_content').tr(),
           FutureBuilder<PackageInfo>(
             future: PackageInfo.fromPlatform(),

lib/ui/screens/activity.dart → lib/common/ui/screens/activity.dart

@@ -2,10 +2,10 @@ import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 import 'package:flutter_swipe/flutter_swipe.dart';
 
-import 'package:scrobbles/config/activity_page.dart';
-import 'package:scrobbles/config/screen.dart';
-import 'package:scrobbles/cubit/nav_cubit_pages.dart';
-import 'package:scrobbles/ui/nav/bottom_nav_bar.dart';
+import 'package:scrobbles/common/config/activity_page.dart';
+import 'package:scrobbles/common/config/screen.dart';
+import 'package:scrobbles/common/cubit/nav/nav_cubit_pages.dart';
+import 'package:scrobbles/common/ui/nav/bottom_nav_bar.dart';
 
 class ScreenActivity extends StatelessWidget {
   const ScreenActivity({super.key});
@@ -15,9 +15,9 @@ class ScreenActivity extends StatelessWidget {
     return BlocBuilder<NavCubitPage, int>(
       builder: (BuildContext context, int pageIndex) {
         return Swiper(
-          itemCount: Screen.itemsCount,
+          itemCount: Screen.items.length,
           itemBuilder: (BuildContext context, int pageIndex) {
-            return ActivityPage.getPageWidget(pageIndex);
+            return ActivityPage.getWidget(pageIndex);
           },
           pagination: SwiperPagination(
             margin: const EdgeInsets.all(0),

lib/ui/screens/settings.dart → lib/common/ui/screens/settings.dart

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:scrobbles/ui/settings/settings_form.dart';
+import 'package:scrobbles/common/ui/settings/settings_form.dart';
 
 class ScreenSettings extends StatelessWidget {
   const ScreenSettings({super.key});

lib/ui/settings/settings_form.dart → lib/common/ui/settings/settings_form.dart

@@ -2,7 +2,7 @@ import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
 import 'package:scrobbles/config/default_global_settings.dart';
-import 'package:scrobbles/cubit/settings_global_cubit.dart';
+import 'package:scrobbles/cubit/settings/settings_global_cubit.dart';
 
 class SettingsForm extends StatefulWidget {
   const SettingsForm({super.key});

lib/config/application_config.dart

+class ApplicationConfig {
+  static const String appTitle = 'Scrobbles';
+}

lib/config/default_activity_settings.dart

+import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
+
+class DefaultActivitySettings {
+  // available game parameters codes
+  static const String parameterCodeDashboardType = 'dashboardType';
+  static const List<String> availableParameters = [
+    parameterCodeDashboardType,
+  ];
+
+  // dashboard type: available values
+  static const String dashboardTypeDefault = 'default';
+  static const List<String> allowedDashboardTypeValues = [
+    dashboardTypeDefault,
+  ];
+  // dashboard type: default value
+  static const String defaultDashboardTypeValue = dashboardTypeDefault;
+
+  // available values from parameter code
+  static List<String> getAvailableValues(String parameterCode) {
+    switch (parameterCode) {
+      case parameterCodeDashboardType:
+        return DefaultActivitySettings.allowedDashboardTypeValues;
+    }
+
+    printlog('Did not find any available value for game parameter "$parameterCode".');
+    return [];
+  }
+}

lib/config/default_global_settings.dart

+import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
+
 class DefaultGlobalSettings {
+  // available global parameters codes
+  static const String parameterCodeSkin = 'skin';
+  static const List<String> availableParameters = [
+    parameterCodeSkin,
+  ];
+
+  // skin: available values
+  static const String skinValueDefault = 'default';
+  static const List<String> allowedSkinValues = [
+    skinValueDefault,
+  ];
+  // skin: default value
+  static const String defaultSkinValue = skinValueDefault;
+
+  // available values from parameter code
+  static List<String> getAvailableValues(String parameterCode) {
+    switch (parameterCode) {
+      case parameterCodeSkin:
+        return DefaultGlobalSettings.allowedSkinValues;
+    }
+
+    printlog('Did not find any available value for global parameter "$parameterCode".');
+    return [];
+  }
+
+  @Deprecated("Should be removed / normalized")
   static const List<int> allowedDaysCountValues = [
     7,
     14,
@@ -7,17 +35,26 @@ class DefaultGlobalSettings {
     60,
     90,
   ];
+
+  @Deprecated("Should be removed / normalized")
   static const List<int> allowedCountValues = [
     5,
     10,
     20,
   ];
 
+  @Deprecated("Should be removed / normalized")
   static const int defaultDiscoveriesDaysCount = 14;
+  @Deprecated("Should be removed / normalized")
   static const int defaultDistributionDaysCount = 21;
+  @Deprecated("Should be removed / normalized")
   static const int defaultStatisticsRecentDaysCount = 21;
+  @Deprecated("Should be removed / normalized")
   static const int defaultTimelineDaysCount = 14;
+  @Deprecated("Should be removed / normalized")
   static const int defaultTopArtistsDaysCount = 14;
+  @Deprecated("Should be removed / normalized")
   static const int defaultNewArtistsCount = 5;
+  @Deprecated("Should be removed / normalized")
   static const int defaultNewTracksCount = 5;
 }

lib/cubit/activity/activity_cubit.dart

+import 'package:flutter/material.dart';
+import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
+
+import 'package:scrobbles/models/activity/activity.dart';
+import 'package:scrobbles/models/settings/settings_activity.dart';
+import 'package:scrobbles/models/settings/settings_global.dart';
+
+part 'activity_state.dart';
+
+class ActivityCubit extends HydratedCubit<ActivityState> {
+  ActivityCubit()
+      : super(ActivityState(
+          currentActivity: Activity.createNull(),
+        ));
+
+  void updateState(Activity activity) {
+    emit(ActivityState(
+      currentActivity: activity,
+    ));
+  }
+
+  void refresh() {
+    final Activity activity = Activity(
+      // Settings
+      activitySettings: state.currentActivity.activitySettings,
+      globalSettings: state.currentActivity.globalSettings,
+      // State
+      isRunning: state.currentActivity.isRunning,
+    );
+
+    updateState(activity);
+  }
+
+  void startNewActivity({
+    required ActivitySettings activitySettings,
+    required GlobalSettings globalSettings,
+  }) {
+    final Activity newActivity = Activity.createNew(
+      // Settings
+      activitySettings: activitySettings,
+      globalSettings: globalSettings,
+    );
+
+    newActivity.dump();
+
+    updateState(newActivity);
+    refresh();
+  }
+
+  @override
+  ActivityState? fromJson(Map<String, dynamic> json) {
+    final Activity currentActivity = json['currentActivity'] as Activity;
+
+    return ActivityState(
+      currentActivity: currentActivity,
+    );
+  }
+
+  @override
+  Map<String, dynamic>? toJson(ActivityState state) {
+    return <String, dynamic>{
+      'currentActivity': state.currentActivity.toJson(),
+    };
+  }
+}

lib/cubit/activity/activity_state.dart

+part of 'activity_cubit.dart';
+
+@immutable
+class ActivityState extends Equatable {
+  const ActivityState({
+    required this.currentActivity,
+  });
+
+  final Activity currentActivity;
+
+  @override
+  List<dynamic> get props => <dynamic>[
+        currentActivity,
+      ];
+}