feat(alert): add success alert type for the saving feature

Author: lucas-givord

geos-trame/geos_trame/app/components/alertHandler.py

@@ -5,6 +5,19 @@
 
 from trame.widgets import vuetify3
 
+from enum import Enum
+
+
+class AlertType( str, Enum ):
+    """Enum representing the type of VAlert.
+
+    For more information, see the uetify documentation:
+    https://vuetifyjs.com/en/api/VAlert/#props-type
+    """
+    SUCCESS = 'success'
+    WARNING = 'warning'
+    ERROR = 'error'
+
 
 class AlertHandler( vuetify3.VContainer ):
     """Vuetify component used to display an alert status.
@@ -26,8 +39,9 @@ def __init__( self ) -> None:
 
         self.state.alerts = []
 
-        self.server.controller.on_add_error.add_task( self.add_error )
+        self.server.controller.on_add_success.add_task( self.add_success )
         self.server.controller.on_add_warning.add_task( self.add_warning )
+        self.server.controller.on_add_error.add_task( self.add_error )
 
         self.generate_alert_ui()
 
@@ -75,7 +89,7 @@ def add_alert( self, type: str, title: str, message: str ) -> None:
         self.state.dirty( "alerts" )
         self.state.flush()
 
-        if type == "warning":
+        if type == AlertType.WARNING:
             asyncio.get_event_loop().call_later( self.__lifetime_of_alert, self.on_close, alert_id )
 
     async def add_warning( self, title: str, message: str ) -> None:
@@ -86,6 +100,10 @@ async def add_error( self, title: str, message: str ) -> None:
         """Add an alert of type 'error'."""
         self.add_alert( "error", title, message )
 
+    async def add_success( self, title: str, message: str ) -> None:
+        """Add an alert of type 'success'."""
+        self.add_alert( AlertType.SUCCESS, title, message )
+
     def on_close( self, alert_id: int ) -> None:
         """Remove in the state the alert associated to the given id."""
         self.state.alerts = list( filter( lambda i: i[ "id" ] != alert_id, self.state.alerts ) )

geos-trame/geos_trame/app/core.py

@@ -61,7 +61,7 @@ def __init__( self, server: Server, file_name: str ) -> None:
         self.ctrl.simput_reload_data = self.simput_widget.reload_data
 
         # Tree
-        self.tree = DeckTree( self.state.sm_id )
+        self.tree = DeckTree( self.state.sm_id, self.ctrl )
 
         # Viewers
         self.region_viewer = RegionViewer()

geos-trame/geos_trame/app/deck/tree.py

@@ -4,16 +4,18 @@
 import os
 from collections import defaultdict
 from typing import Any
-
 import dpath
 import funcy
 from pydantic import BaseModel
-from trame_simput import get_simput_manager
+
 from xsdata.formats.dataclass.parsers.config import ParserConfig
 from xsdata.formats.dataclass.serializers.config import SerializerConfig
 from xsdata.utils import text
 from xsdata_pydantic.bindings import DictDecoder, XmlContext, XmlSerializer
 
+from trame_server.controller import Controller
+from trame_simput import get_simput_manager
+
 from geos_trame.app.deck.file import DeckFile
 from geos_trame.app.geosTrameException import GeosTrameException
 from geos_trame.app.utils.file_utils import normalize_path, format_xml
@@ -23,7 +25,7 @@
 class DeckTree( object ):
     """A tree that represents a deck file along with all the available blocks and parameters."""
 
-    def __init__( self, sm_id: str | None = None, **kwargs: Any ) -> None:
+    def __init__( self, sm_id: str | None = None, ctrl: Controller = None, **kwargs: Any ) -> None:
         """Constructor."""
         super( DeckTree, self ).__init__( **kwargs )
 
@@ -33,6 +35,7 @@ def __init__( self, sm_id: str | None = None, **kwargs: Any ) -> None:
         self.root = None
         self.input_has_errors = False
         self._sm_id = sm_id
+        self._ctrl = ctrl
 
     def set_input_file( self, input_filename: str ) -> None:
         """Set a new input file.
@@ -172,6 +175,8 @@ def write_files( self ) -> None:
                 file.write( model_as_xml )
                 file.close()
 
+            self._ctrl.on_add_success( title="File saved", message=f"File {basename} has been saved." )
+
     @staticmethod
     def _append_include_file( model: Problem, included_file_path: str ) -> None:
         """Append an Included object which follows this structure according to the documentation.