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

Resolve "Normalize Activity application architecture"

Closes #26

See merge request !26

assets/translations/en.json

@@ -10,6 +10,7 @@
   "about_version": "Version: {version}",
 
   "page_home": "Home",
+  "page_player": "Player",
   "page_remote_control": "Control",
 
   "": ""

assets/translations/fr.json

@@ -10,6 +10,7 @@
   "about_version": "Version : {version}",
 
   "page_home": "Accueil",
+  "page_player": "Player",
   "page_remote_control": "Télécommande",
 
   "": ""

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

+Normalize Activity application architecture.

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

+Harmonisation des applications en Activity.

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

 import 'package:flutter/material.dart';
-import 'package:flutter/widgets.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:plotter/ui/pages/remote_control.dart';
-import 'package:plotter/ui/pages/home.dart';
+import 'package:plotter/common/ui/pages/home.dart';
+import 'package:plotter/common/ui/pages/player.dart';
+import 'package:plotter/common/ui/pages/remote_control.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 = true;
+
   static const indexHome = 0;
   static const pageHome = ActivityPageItem(
+    code: 'page_home',
     icon: Icon(UniconsLine.home),
     page: PageHome(),
-    code: 'page_home',
   );
 
-  static const indexRemoteControl = 1;
+  static const indexPlayer = 1;
+  static const pagePlayer = ActivityPageItem(
+    code: 'page_player',
+    icon: Icon(UniconsLine.star),
+    page: PagePlayer(),
+  );
+
+  static const indexRemoteControl = 2;
   static const pageRemoteControl = ActivityPageItem(
-    icon: Icon(UniconsLine.arrow),
-    page: PageRemoteControl(),
     code: 'page_remote_control',
+    icon: Icon(UniconsLine.star),
+    page: PageRemoteControl(),
   );
 
-  static Map<int, ActivityPageItem> items = {
+  static const Map<int, ActivityPageItem> items = {
     indexHome: pageHome,
+    indexPlayer: pagePlayer,
     indexRemoteControl: pageRemoteControl,
   };
 
+  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:plotter/ui/screens/about.dart';
-import 'package:plotter/ui/screens/activity.dart';
-import 'package:plotter/ui/screens/settings.dart';
+import 'package:plotter/common/ui/screens/about.dart';
+import 'package:plotter/common/ui/screens/activity.dart';
+import 'package:plotter/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:plotter/config/activity_page.dart';
+import 'package:plotter/common/config/activity_page.dart';
 
 class NavCubitPage extends HydratedCubit<int> {
   NavCubitPage() : super(0);
@@ -13,6 +13,10 @@ class NavCubitPage extends HydratedCubit<int> {
     }
   }
 
+  void goToPageHome() {
+    updateIndex(ActivityPage.indexHome);
+  }
+
   @override
   int fromJson(Map<String, dynamic> json) {
     return ActivityPage.indexHome;
@@ -20,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:plotter/config/screen.dart';
+import 'package:plotter/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

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:plotter/config/activity_page.dart';
-import 'package:plotter/cubit/nav_cubit_pages.dart';
+import 'package:plotter/common/config/activity_page.dart';
+import 'package:plotter/common/cubit/nav/nav_cubit_pages.dart';
 
 class BottomNavBar extends StatelessWidget {
   const BottomNavBar({super.key});
@@ -21,16 +21,14 @@ class BottomNavBar extends StatelessWidget {
         ),
       ),
       child: BlocBuilder<NavCubitPage, int>(builder: (BuildContext context, int state) {
-        final List<ActivityPageItem> pageItems = [
-          ActivityPage.pageHome,
-          ActivityPage.pageRemoteControl,
-        ];
-        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: state,

lib/common/ui/nav/global_app_bar.dart

+import 'package:flutter/material.dart';
+import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
+
+import 'package:plotter/common/config/screen.dart';
+import 'package:plotter/common/cubit/nav/nav_cubit_pages.dart';
+import 'package:plotter/common/cubit/nav/nav_cubit_screens.dart';
+
+import 'package:plotter/cubit/activity/activity_cubit.dart';
+import 'package:plotter/models/activity/activity.dart';
+
+class GlobalAppBar extends StatelessWidget implements PreferredSizeWidget {
+  const GlobalAppBar({super.key});
+
+  @override
+  Widget build(BuildContext context) {
+    return BlocBuilder<ActivityCubit, ActivityState>(
+      builder: (BuildContext context, ActivityState activityState) {
+        return BlocBuilder<NavCubitScreen, int>(
+          builder: (BuildContext context, int pageIndex) {
+            final Activity currentActivity = activityState.currentActivity;
+
+            final List<Widget> menuActions = [];
+
+            if (currentActivity.isRunning) {
+              menuActions.add(StyledButton(
+                color: Colors.red,
+                onPressed: () {},
+                onLongPress: () {
+                  BlocProvider.of<ActivityCubit>(context).quitActivity();
+                  BlocProvider.of<NavCubitPage>(context).goToPageHome();
+                },
+                child: const Image(
+                  image: AssetImage('assets/ui/button_back.png'),
+                  fit: BoxFit.fill,
+                ),
+              ));
+            } else {
+              if (pageIndex == Screen.indexActivity) {
+                // go to Settings page
+                menuActions.add(ElevatedButton(
+                  onPressed: () {
+                    BlocProvider.of<NavCubitScreen>(context).goToScreenSettings();
+                  },
+                  style: ElevatedButton.styleFrom(
+                    shape: const CircleBorder(),
+                  ),
+                  child: Screen.screenSettings.icon,
+                ));
+
+                // go to About page
+                menuActions.add(ElevatedButton(
+                  onPressed: () {
+                    BlocProvider.of<NavCubitScreen>(context).goToScreenAbout();
+                  },
+                  style: ElevatedButton.styleFrom(
+                    shape: const CircleBorder(),
+                  ),
+                  child: Screen.screenAbout.icon,
+                ));
+              } else {
+                // back to Home page
+                menuActions.add(ElevatedButton(
+                  onPressed: () {
+                    BlocProvider.of<NavCubitScreen>(context).goToScreenActivity();
+                  },
+                  style: ElevatedButton.styleFrom(
+                    shape: const CircleBorder(),
+                  ),
+                  child: Screen.screenActivity.icon,
+                ));
+              }
+            }
+
+            return AppBar(
+              title: const AppHeader(text: 'app_name'),
+              actions: menuActions,
+            );
+          },
+        );
+      },
+    );
+  }
+
+  @override
+  Size get preferredSize => const Size.fromHeight(50);
+}

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:plotter/cubit/activity_cubit.dart';
+import 'package:plotter/cubit/activity/activity_cubit.dart';
 import 'package:plotter/models/activity/activity.dart';
 
 class PageHome extends StatelessWidget {

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

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:plotter/cubit/activity_cubit.dart';
+import 'package:plotter/cubit/activity/activity_cubit.dart';
 import 'package:plotter/models/activity/activity.dart';
 
 class PagePlayer extends StatelessWidget {

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

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:plotter/cubit/activity_cubit.dart';
+import 'package:plotter/cubit/activity/activity_cubit.dart';
 import 'package:plotter/models/activity/activity.dart';
 import 'package:plotter/ui/widgets/keyboard.dart';
 import 'package:plotter/utils/api.dart';

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

 import 'package:flutter/material.dart';
 import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
 
-import 'package:plotter/config/activity_page.dart';
-import 'package:plotter/cubit/nav_cubit_pages.dart';
+import 'package:plotter/common/config/activity_page.dart';
+import 'package:plotter/common/cubit/nav/nav_cubit_pages.dart';
 
 class ScreenActivity extends StatelessWidget {
   const ScreenActivity({super.key});
@@ -11,7 +11,7 @@ class ScreenActivity extends StatelessWidget {
   Widget build(BuildContext context) {
     return BlocBuilder<NavCubitPage, int>(
       builder: (BuildContext context, int pageIndex) {
-        return ActivityPage.getPageWidget(pageIndex);
+        return ActivityPage.getWidget(pageIndex);
       },
     );
   }

lib/config/application_config.dart

+class ApplicationConfig {
+  static const String appTitle = 'Stepper plotter assistant';
+}

lib/config/default_activity_settings.dart

+import 'package:flutter_custom_toolbox/flutter_toolbox.dart';
+
+class DefaultActivitySettings {
+  // available game parameters codes
+  static const String parameterCodePlotterType = 'plotterType';
+  static const List<String> availableParameters = [
+    parameterCodePlotterType,
+  ];
+
+  // plotter type: available values
+  static const String plotterTypeNone = 'none';
+  static const String plotterTypeRadial = 'radial';
+  static const String plotterTypeAxial = 'axial';
+  static const List<String> allowedPlotterTypeValues = [
+    plotterTypeNone,
+    plotterTypeRadial,
+    plotterTypeAxial,
+  ];
+  // items count: default value
+  static const String defaultPlotterTypeValue = plotterTypeNone;
+
+  // available values from parameter code
+  static List<String> getAvailableValues(String parameterCode) {
+    switch (parameterCode) {
+      case parameterCodePlotterType:
+        return DefaultActivitySettings.allowedPlotterTypeValues;
+    }
+
+    printlog('Did not find any available value for game parameter "$parameterCode".');
+    return [];
+  }
+}