Merge branch 'dev' into dev-feat-timesheets

Author: clstaudt

app/app.py

@@ -52,13 +52,21 @@
 class TuttleApp:
     """The main application class"""
 
-    def __init__(self, page: Page) -> None:
+    def __init__(
+        self,
+        page: Page,
+        debug_mode: bool = False,
+    ):
+        """ """
+        self.debug_mode = debug_mode
         self.page = page
         self.page.title = "Tuttle"
         self.page.fonts = APP_FONTS
         self.page.theme = APP_THEME
         self.client_storage = ClientStorageImpl(page=self.page)
-        preferences = PreferencesIntent(self.client_storage)
+        preferences = PreferencesIntent(
+            client_storage=self.client_storage,
+        )
         preferences_result = preferences.get_preference_by_key(
             PreferencesStorageKeys.theme_mode_key
         )
@@ -241,21 +249,21 @@ def on_route_change(self, route):
 
     def create_model(self):
         logger.info("Creating database model")
-        sqlmodel.SQLModel.metadata.create_all(self.db_engine, checkfirst=True)
+        sqlmodel.SQLModel.metadata.create_all(
+            self.db_engine,
+            checkfirst=True,
+        )
 
     def ensure_database(self):
         """
         Ensure that the database exists and is up to date.
         """
         if not self.db_path.exists():
-            self.db_engine = sqlmodel.create_engine(
-                f"sqlite:///{self.db_path}", echo=True
-            )
-            self.create_model()
+            self.reset_database()
         else:
             logger.info("Database exists, skipping creation")
 
-    def clear_database(self):
+    def reset_database(self):
         """
         Delete the database and rebuild database model.
         """
@@ -264,7 +272,10 @@ def clear_database(self):
             self.db_path.unlink()
         except FileNotFoundError:
             logger.info("Database file not found, skipping delete")
-        self.db_engine = sqlmodel.create_engine(f"sqlite:///{self.db_path}", echo=True)
+        self.db_engine = sqlmodel.create_engine(
+            f"sqlite:///{self.db_path}",
+            echo=self.debug_mode,
+        )
         self.create_model()
 
     def store_demo_timetracking_dataframe(self, time_tracking_data: DataFrame):
@@ -276,7 +287,7 @@ def store_demo_timetracking_dataframe(self, time_tracking_data: DataFrame):
 
     def install_demo_data(self):
         """Install demo data into the database."""
-        self.clear_database()
+        self.reset_database()
         try:
             demo.install_demo_data(
                 n_projects=4,
@@ -300,9 +311,18 @@ def ensure_uploads_dir(self) -> Path:
             uploads_dir.mkdir(parents=True)
         return uploads_dir
 
+    def close(self):
+        """Closes the application."""
+        self.page.window_close()
+
     def build(self):
         self.page.go(self.page.route)
 
+    def reset_and_quit(self):
+        """Resets the application and quits."""
+        self.reset_database()
+        self.close()
+
 
 class TuttleRoutes:
     """Utility class for parsing of routes to destination views"""
@@ -373,7 +393,9 @@ def parse_route(self, pageRoute: str):
             )
         elif routePath.match(PREFERENCES_SCREEN_ROUTE):
             screen = PreferencesScreen(
-                params=self.tuttle_view_params, on_theme_changed=self.on_theme_changed
+                params=self.tuttle_view_params,
+                on_theme_changed_callback=self.on_theme_changed,
+                on_reset_app_callback=self.app.reset_and_quit,
             )
         elif routePath.match(PROJECT_EDITOR_SCREEN_ROUTE):
             screen = ProjectEditorScreen(params=self.tuttle_view_params)

app/auth/intent.py

@@ -1,14 +1,15 @@
 from typing import Type, Union, Optional
 
 from core.intent_result import IntentResult
+from core.abstractions import Intent
 
 from tuttle.model import User, Address
 
 from .data_source import UserDataSource
 
 
-class AuthIntent:
-    """Handles User C_R_U_D intents"""
+class AuthIntent(Intent):
+    """Handles User intents"""
 
     def __init__(self):
         self._data_source = UserDataSource()

app/clients/intent.py

@@ -2,13 +2,14 @@
 
 from contacts.intent import ContactsIntent
 from core.intent_result import IntentResult
+from core.abstractions import Intent
 
 from tuttle.model import Client, Contact
 
 from .data_source import ClientDataSource
 
 
-class ClientsIntent:
+class ClientsIntent(Intent):
     """Provides methods to retrieve, store and delete clients from datasources"""
 
     def __init__(self):

app/contacts/intent.py

@@ -1,6 +1,7 @@
 from typing import Mapping, Union
 
 from core.intent_result import IntentResult
+from core.abstractions import Intent
 
 from tuttle.model import Contact
 

app/contracts/intent.py

@@ -4,7 +4,7 @@
 
 from clients.intent import ClientsIntent
 from contacts.intent import ContactsIntent
-from core.abstractions import ClientStorage
+from core.abstractions import ClientStorage, Intent
 from core.intent_result import IntentResult
 from preferences.intent import PreferencesIntent
 from preferences.model import PreferencesStorageKeys

app/core/views.py

@@ -229,6 +229,24 @@ def get_secondary_btn(
     )
 
 
+def get_danger_button(
+    on_click,
+    label: str,
+    width: int = 200,
+    icon: Optional[str] = None,
+    tooltip: Optional[str] = None,
+):
+    """An elevated button with danger styling"""
+    return ElevatedButton(
+        label,
+        width=width,
+        on_click=on_click,
+        icon=icon,
+        color=colors.DANGER_COLOR,
+        tooltip=tooltip,
+    )
+
+
 def get_profile_photo_img(pic_src: str = image_paths.default_avatar):
 
     return Image(

app/invoicing/intent.py

@@ -6,7 +6,7 @@
 from pathlib import Path
 
 from auth.data_source import UserDataSource
-from core.abstractions import ClientStorage
+from core.abstractions import ClientStorage, Intent
 from core.intent_result import IntentResult
 from loguru import logger
 from pandas import DataFrame
@@ -22,7 +22,7 @@
 from auth.intent import AuthIntent
 
 
-class InvoicingIntent:
+class InvoicingIntent(Intent):
     """Handles Invoicing C_R_U_D intents"""
 
     def __init__(self, client_storage: ClientStorage):

app/preferences/intent.py

@@ -1,12 +1,16 @@
-from core.abstractions import ClientStorage
+from loguru import logger
+
+from flet import Page
+
+from core.abstractions import ClientStorage, Intent
 from core.intent_result import IntentResult
 
 from .model import Preferences, PreferencesStorageKeys
 from typing import Optional
 
 
-class PreferencesIntent:
-    """Handles Preferences C_R_U_D intents
+class PreferencesIntent(Intent):
+    """Handles Preferences intents
 
     Intents handled (Methods)
     ---------------
@@ -24,8 +28,10 @@ class PreferencesIntent:
         storing a preference item given it's key and value
     """
 
-    def __init__(self, client_storage: ClientStorage):
-
+    def __init__(
+        self,
+        client_storage: ClientStorage,
+    ):
         self._client_storage = client_storage
 
     def get_preferences(self) -> IntentResult:
@@ -130,3 +136,40 @@ def get_preferred_theme(self) -> IntentResult[Optional[str]]:
             result.error_msg = "Failed to load your preferred theme"
             result.log_message_if_any()
         return result
+
+    def clear_preferences(self) -> IntentResult[None]:
+        """Clears all preferences"""
+        try:
+            self._client_storage.clear_preferences()
+            return IntentResult(was_intent_successful=True)
+        except Exception as ex:
+            logger.error(f"Failed to clear preferences: {ex.__class__.__name__}")
+            logger.exception(ex)
+            result = IntentResult(
+                was_intent_successful=False,
+                exception=ex,
+                error_msg=f"Failed to clear preferences: {ex.__class__.__name__}",
+            )
+            result.log_message_if_any()
+            return result
+
+    def reset_app(self) -> IntentResult:
+        """Resets the app to it's default state"""
+        try:
+            logger.info("Resetting the app to default state")
+            logger.info("Clearing all preferences")
+            self._client_storage.clear_preferences()
+            logger.info("Clearing all data")
+            self._page.window_close()
+
+            return IntentResult(
+                was_intent_successful=True,
+            )
+        except Exception as ex:
+            result = IntentResult(
+                was_intent_successful=False,
+                exception=ex,
+                error_msg="Failed to reset app",
+            )
+            result.log_message_if_any()
+            return result

app/preferences/view.py

@@ -1,4 +1,8 @@
-from typing import Optional
+from typing import Optional, Callable
+
+import sys
+
+from loguru import logger
 
 from flet import (
     Column,
@@ -23,6 +27,7 @@
     get_dropdown,
     get_std_txt_field,
     horizontal_progress,
+    lgSpace,
     mdSpace,
     smSpace,
     update_dropdown_items,
@@ -51,11 +56,13 @@ class PreferencesScreen(TuttleView, UserControl):
     def __init__(
         self,
         params: TuttleViewParams,
-        on_theme_changed,
+        on_theme_changed_callback: Callable,
+        on_reset_app_callback: Callable,
     ):
         super().__init__(params=params)
         self.intent = PreferencesIntent(client_storage=params.client_storage)
-        self.on_theme_changed_callback = on_theme_changed
+        self.on_theme_changed_callback = on_theme_changed_callback
+        self.on_reset_app_callback = on_reset_app_callback
         self.preferences: Optional[Preferences] = None
         self.currencies = []
 
@@ -111,6 +118,15 @@ def on_language_selected(self, e):
             return
         self.preferences.language = e.control.value
 
+    def on_reset_app(self, e):
+        logger.warning("Resetting the app to default state")
+        logger.warning("Clearning preferences")
+        result: IntentResult[None] = self.intent.clear_preferences()
+        assert result.was_intent_successful
+        logger.warning("Clearning database")
+        logger.warning("Quitting app after reset. Please restart.")
+        self.on_reset_app_callback()
+
     def get_tab_item(self, label, icon, content_controls):
         return Tab(
             tab_content=Column(
@@ -179,6 +195,15 @@ def build(self):
                 "English",
             ],
         )
+
+        # a reset button for the app with a warning sign, warning color and a confirmation dialog
+        self.reset_button = views.get_danger_button(
+            label="Reset App and Quit",
+            icon=icons.RESTART_ALT_OUTLINED,
+            on_click=self.on_reset_app,
+            tooltip="Warning: This will reset the app to default state and delete all data. You will have to restart the app.",
+        )
+
         self.tabs = Tabs(
             selected_index=0,
             animation_duration=300,
@@ -190,6 +215,8 @@ def build(self):
                     icons.SETTINGS_OUTLINED,
                     [
                         self.theme_control,
+                        lgSpace,
+                        self.reset_button,
                     ],
                 ),
                 self.get_tab_item(

app/projects/intent.py

@@ -5,13 +5,14 @@
 from clients.intent import ClientsIntent
 from contracts.intent import ContractsIntent
 from core.intent_result import IntentResult
+from core.abstractions import Intent
 
 from tuttle.model import Client, Contract, Project
 
 from .data_source import ProjectDataSource
 
 
-class ProjectsIntent:
+class ProjectsIntent(Intent):
     """Handles intents related to the projects data Ui"""
 
     def __init__(