data-sourcerer 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

sourcerer/presentation/screens/main/main.py

@@ -1,26 +1,32 @@
 import contextlib
 import time
 import traceback
+from collections.abc import Iterable
 from concurrent.futures import ThreadPoolExecutor
 from pathlib import Path
 from typing import ClassVar
 
 from dependency_injector.wiring import Provide
 from textual import on, work
-from textual.app import App, ComposeResult
+from textual.app import App, ComposeResult, SystemCommand
 from textual.binding import Binding, BindingType
 from textual.containers import Horizontal
 from textual.css.query import NoMatches
 from textual.reactive import reactive
+from textual.screen import Screen
 from textual.widgets import Footer
 
+from sourcerer.domain.package_meta.services import BasePackageMetaService
+from sourcerer.domain.settings.entities import SettingsFields
 from sourcerer.domain.storage_provider.entities import Storage
 from sourcerer.infrastructure.access_credentials.services import CredentialsService
+from sourcerer.infrastructure.settings.services import SettingsService
 from sourcerer.infrastructure.storage_provider.exceptions import (
     ListStorageItemsError,
 )
 from sourcerer.infrastructure.utils import generate_uuid
 from sourcerer.presentation.di_container import DiContainer
+from sourcerer.presentation.screens.about.main import AboutScreen
 from sourcerer.presentation.screens.critical_error.main import CriticalErrorScreen
 from sourcerer.presentation.screens.file_system_finder.main import (
     FileSystemNavigationModal,
@@ -55,6 +61,7 @@ from sourcerer.presentation.screens.preview_content.main import PreviewContentSc
 from sourcerer.presentation.screens.provider_creds_list.main import (
     ProviderCredsListScreen,
 )
+from sourcerer.presentation.screens.settings.main import SettingsScreen
 from sourcerer.presentation.screens.storage_action_progress.main import (
     DeleteKey,
     DownloadKey,
@@ -103,8 +110,10 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
     CSS_PATH = "styles.tcss"
     BINDINGS: ClassVar[list[BindingType]] = [
         Binding("ctrl+r", "registrations", "Registrations list"),
-        Binding("ctrl+s", "storages", "Storages list"),
+        Binding("ctrl+l", "storages", "Storages list"),
         Binding("ctrl+f", "find", show=False),
+        Binding("ctrl+s", "settings", "Settings"),
+        Binding("ctrl+a", "about", "About"),
         Binding(
             KeyBindings.ARROW_LEFT.value, "focus_sidebar", "Focus sidebar", show=False
         ),
@@ -116,15 +125,24 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
 
     def __init__(
         self,
+        settings_service: SettingsService = Provide[DiContainer.settings_service],
         credentials_service: CredentialsService = Provide[
             DiContainer.credentials_service
         ],
+        package_meta_service: BasePackageMetaService = Provide[
+            DiContainer.package_meta_service
+        ],
         *args,
         **kwargs,
     ):
         super().__init__(*args, **kwargs)
+        self.settings_service = settings_service
         self.credentials_service = credentials_service
-        self.storage_list_sidebar = StorageListSidebar(id="storage_list_sidebar")
+        self.package_meta_service = package_meta_service
+        self.settings = self.settings_service.load_settings()
+        self.storage_list_sidebar = StorageListSidebar(
+            self.settings.group_by_access_credentials, id="storage_list_sidebar"
+        )
         self.storage_content = StorageContentContainer(id="storage_content_container")
         self.load_percentage = 0
         self.active_resizing_rule: ResizingRule | None = None
@@ -145,14 +163,49 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
     def _handle_exception(self, error: Exception) -> None:
         self.push_screen(CriticalErrorScreen(str(error), traceback.format_exc()))
 
+    def get_system_commands(self, screen: Screen) -> Iterable[SystemCommand]:
+        yield SystemCommand(
+            "Quit the application",
+            "Quit the application as soon as possible",
+            self.action_quit,
+        )
+
+        if screen.query("HelpPanel"):
+            yield SystemCommand(
+                "Hide keys and help panel",
+                "Hide the keys and widget help panel",
+                self.action_hide_help_panel,
+            )
+        else:
+            yield SystemCommand(
+                "Show keys and help panel",
+                "Show help for the focused widget and a summary of available keys",
+                self.action_show_help_panel,
+            )
+        yield SystemCommand(
+            "Save screenshot",
+            "Save an SVG 'screenshot' of the current screen",
+            self.deliver_screenshot,
+        )
+        yield SystemCommand("About", "About sourcerer", self.action_about)
+        yield SystemCommand("Settings", "Sourcerer settings", self.action_settings)
+
     def on_mount(self):
         """
         Initializes the application theme and storage list on mount.
         """
 
         self.register_theme(github_dark_theme)  # pyright: ignore [reportArgumentType]
-
-        self.theme = "github-dark"
+        if self.settings.theme in self._registered_themes:
+            self.theme = self.settings.theme
+
+        package_meta = self.package_meta_service.get_package_meta()
+        if package_meta.has_available_update:
+            self.notify(
+                f"Sourcerer {package_meta.version} "
+                f"is running while {package_meta.latest_version} is available",
+                severity="warning",
+            )
         self.init_storages_list()
 
     def action_find(self):
@@ -188,9 +241,39 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
             ProviderCredsListScreen(), callback=self.modal_screen_callback
         )
 
+    def action_settings(self):
+        """
+        Opens the settings screen.
+        This method is triggered by the key binding "ctrl+s" and allows the user
+        to modify application settings such as theme and grouping of storage items.
+        It retrieves the current settings from the settings service and pushes
+        the SettingsScreen to the application stack. A callback is set to handle
+        the settings changes when the screen is closed.
+        """
+        settings = self.settings_service.load_settings()
+        self.app.push_screen(SettingsScreen(settings), callback=self.settings_callback)
+
     def action_storages(self):
         self.app.push_screen(StoragesListScreen(), callback=self.modal_screen_callback)
 
+    def action_about(self):
+        self.push_screen(AboutScreen())
+
+    def settings_callback(self, settings: dict | None):
+        default_settings = self.settings_service.load_settings()
+        if settings is None:
+            self.app.theme = default_settings.theme
+            return
+        self.app.theme = settings[SettingsFields.theme]
+        if (theme := settings.get(SettingsFields.theme)) != default_settings.theme:
+            self.settings_service.set_setting(SettingsFields.theme, theme)  # type: ignore
+
+        if (
+            group_by := settings.get(SettingsFields.group_by_access_credentials)
+        ) != default_settings.group_by_access_credentials:
+            self.settings_service.set_setting(SettingsFields.group_by_access_credentials, group_by)  # type: ignore
+            self.storage_list_sidebar.groupby_access_credentials = group_by  # type: ignore
+
     def modal_screen_callback(self, requires_storage_refresh: bool | None = True):
         """
         Callback for modal screens to refresh the storage list if required.
@@ -587,7 +670,7 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
                 for storage in credentials.storages
                 if storage.name not in storage_names
             ]
-            self.storage_list_sidebar.storages[credentials.uuid] = (
+            self.storage_list_sidebar.storages[(credentials.uuid, credentials.name)] = (
                 storages + registered_storages
             )
             self.storage_list_sidebar.last_update_timestamp = time.time()

sourcerer/presentation/screens/main/styles.tcss

@@ -12,9 +12,18 @@ StorageContent {
   align-horizontal: center;
 
   & > Button {
+    color: $primary;
     border: solid $primary;
-    width: 10;
-    content-align-horizontal: center;
+    padding-top: 0;
+    width: 15;
+    text-align: center;
+
+    &:hover {
+        color: $text;
+    }
+    &:focus {
+        color: $text;
+    }
   }
 }
 
@@ -25,8 +34,8 @@ StorageContent {
   padding: 1 1 0 1;
 }
 
-Rule {
+ResizingRule {
   color: $background-lighten-3;
   padding: 0 0;
   margin: 0 0;
-}
+}

sourcerer/presentation/screens/main/widgets/storage_list_sidebar.py

@@ -32,12 +32,14 @@ from sourcerer.presentation.screens.shared.widgets.button import Button
 from sourcerer.presentation.screens.shared.widgets.spinner import Spinner
 from sourcerer.presentation.settings import KeyBindings
 
+"""Mapping of storage provider types to their display icons."""
 STORAGE_ICONS = {
     StorageProvider.S3: "🟠",
     StorageProvider.GoogleCloudStorage: "🔵",
     StorageProvider.AzureStorage: "⚪️",
 }
-"""Mapping of storage provider types to their display icons."""
+
+StorageData = namedtuple("Storage", ["access_credentials_uuid", "storage"])
 
 
 class StorageItem(Label):
@@ -140,7 +142,8 @@ class StorageListSidebar(Vertical):
     """
 
     is_loading: reactive[bool] = reactive(False, recompose=True)
-    storages: reactive[dict[str, list[Storage]]] = reactive({})
+    groupby_access_credentials: reactive[bool] = reactive(False, recompose=True)
+    storages: reactive[dict[tuple[str, str], list[Storage]]] = reactive({})
     last_update_timestamp: reactive[float] = reactive(  # ty: ignore[invalid-assignment]
         0.0, recompose=True
     )
@@ -151,12 +154,43 @@ class StorageListSidebar(Vertical):
         margin-right: 0;
         height: 100%;
         margin-bottom: 1;
-        #rule-left {
+        .rule-left {
             width: 1;
+            color: $background-lighten-3;
+        }
+
+        .storage-credentials-container {
+            margin-top: 1;
+
+            & > :first-of-type {
+                margin-top: 0;
+            }
         }
 
         ScrollVerticalContainerWithNoBindings{
             height: 95%;
+
+            & > Horizontal {
+              height: auto;
+
+              & > .storage-credentials-name {
+                    color: $secondary;
+                    padding: 0 1;
+                }
+
+              & > Rule {
+                    color: $background-lighten-3;
+              }
+
+              & > Rule.storage-credentials-rule-left {
+                    width: 1;
+                    color: $secondary;
+                }
+              & > Rule.storage-credentials-rule-right {
+                    color: $secondary;
+                }
+
+            }
         }
 
         Horizontal {
@@ -186,20 +220,18 @@ class StorageListSidebar(Vertical):
     }
     """
 
-    def compose(self) -> ComposeResult:
-        with Horizontal(id="header"):
-            if self.is_loading:
-                yield Spinner()
-            yield GradientWidget(
-                " SOURCERER" if self.is_loading else "🧙SOURCERER",
-                id="left-middle",
-                name="header_click",
-            )
+    def __init__(self, groupby_access_credentials, *args, **kwargs):
+        """Initialize the StorageListSidebar widget."""
+        super().__init__(*args, **kwargs)
+        self.groupby_access_credentials = groupby_access_credentials
 
-        StorageData = namedtuple("Storage", ["access_credentials_uuid", "storage"])
+    def render_ungrouped_storages(self) -> ComposeResult:
         storages = [
             StorageData(access_credentials_uuid, storage)
-            for access_credentials_uuid, storages in self.storages.items()
+            for (
+                access_credentials_uuid,
+                access_credentials_name,
+            ), storages in self.storages.items()
             for storage in storages
         ]
         storages = sorted(storages, key=lambda x: x.storage.storage)
@@ -207,20 +239,72 @@ class StorageListSidebar(Vertical):
             for letter, storages_group in groupby(
                 storages, key=lambda x: x.storage.storage[0]
             ):
-
                 yield Horizontal(
-                    Rule(id="rule-left"),
+                    Rule(classes="rule-left"),
                     Label(letter.upper(), classes="storage-letter"),
                     Rule(),
+                    classes="storage-letter-container",
                 )
-
                 for item in storages_group:
                     yield StorageItem(
-                        renderable=f'{STORAGE_ICONS.get(item.storage.provider, "")} {item.storage.storage}',
+                        renderable=f"{STORAGE_ICONS.get(item.storage.provider, '')} {item.storage.storage}",
                         storage_name=item.storage.storage,
                         access_credentials_uuid=item.access_credentials_uuid,
                     )
 
+    def render_grouped_by_access_credentials_storages(self) -> ComposeResult:
+        """Render storages grouped by access credentials."""
+        with ScrollVerticalContainerWithNoBindings():
+            for (
+                access_credentials_uuid,
+                access_credentials_name,
+            ), storages in self.storages.items():
+                storages = sorted(
+                    [
+                        StorageData(access_credentials_uuid, storage)
+                        for storage in storages
+                    ],
+                    key=lambda x: x.storage.storage,
+                )
+                yield Horizontal(
+                    Rule(classes="storage-credentials-rule-left"),
+                    Label(
+                        access_credentials_name.upper(),
+                        classes="storage-credentials-name",
+                    ),
+                    Rule(classes="storage-credentials-rule-right"),
+                    classes="storage-credentials-container",
+                )
+                for letter, storages_group in groupby(
+                    storages, key=lambda x: x.storage.storage[0]
+                ):
+                    yield Horizontal(
+                        Rule(classes="rule-left"),
+                        Label(letter.upper(), classes="storage-letter"),
+                        Rule(),
+                        classes="storage-letter-container",
+                    )
+                    for item in storages_group:
+                        yield StorageItem(
+                            renderable=f"{STORAGE_ICONS.get(item.storage.provider, '')} {item.storage.storage}",
+                            storage_name=item.storage.storage,
+                            access_credentials_uuid=item.access_credentials_uuid,
+                        )
+
+    def compose(self) -> ComposeResult:
+        with Horizontal(id="header"):
+            if self.is_loading:
+                yield Spinner()
+            yield GradientWidget(
+                " SOURCERER" if self.is_loading else "🧙SOURCERER",
+                id="left-middle",
+                name="header_click",
+            )
+        if self.groupby_access_credentials:
+            yield from self.render_grouped_by_access_credentials_storages()
+        else:
+            yield from self.render_ungrouped_storages()
+
     def focus(self, scroll_visible: bool = True) -> Self:
         try:
             content = self.query_one(StorageItem)

sourcerer/presentation/screens/provider_creds_list/main.py

@@ -1,9 +1,11 @@
 from dataclasses import dataclass
 from enum import Enum
+from typing import ClassVar
 
 from dependency_injector.wiring import Provide
 from textual import on
 from textual.app import ComposeResult
+from textual.binding import Binding, BindingType
 from textual.containers import Container, Horizontal, VerticalScroll
 from textual.message import Message
 from textual.reactive import reactive
@@ -112,6 +114,11 @@ class ProviderCredsListScreen(RefreshTriggerableModalScreen):
     PROVIDERS_NAME = "providers"
     AUTH_METHODS_NAME = "auth_methods"
 
+    BINDINGS: ClassVar[list[BindingType]] = [
+        *RefreshTriggerableModalScreen.BINDINGS,
+        Binding("ctrl+n", "add_credentials", "Add new credentials"),
+    ]
+
     credentials_list = reactive([], recompose=True)
 
     def __init__(
@@ -201,10 +208,7 @@ class ProviderCredsListScreen(RefreshTriggerableModalScreen):
         if event.action == ControlsEnum.CANCEL.name:
             self.action_cancel_screen()
         if event.action == "add_registration":
-            self.app.push_screen(
-                ProviderCredsRegistrationScreen(),
-                callback=self.create_provider_creds_registration,  # type: ignore
-            )
+            self.action_add_credentials()
 
     @on(ProviderCredentialsRow.ChangeActiveStatus)
     def on_change_active_status(self, event: ProviderCredentialsRow.ChangeActiveStatus):
@@ -231,3 +235,9 @@ class ProviderCredsListScreen(RefreshTriggerableModalScreen):
             _ (ReloadCredentialsRequest): The reload credentials request event.
         """
         self.refresh_credentials_list()
+
+    def action_add_credentials(self):
+        self.app.push_screen(
+            ProviderCredsRegistrationScreen(),
+            callback=self.create_provider_creds_registration,  # type: ignore
+        )

sourcerer/presentation/screens/provider_creds_list/styles.tcss

@@ -23,6 +23,14 @@ ProviderCredsListScreen {
 
       .add_registration_button {
         color: $success-darken-2;
+
+        &:hover {
+            color: $primary;
+        }
+        &:focus {
+            color: $primary;
+        }
+
       }
 
       margin-bottom: 1;
@@ -30,6 +38,7 @@ ProviderCredsListScreen {
 
     ProviderCredentialsRow.active {
       background: $primary-lighten-2;
+      color: $background-darken-3;
     }
 
     ProviderCredentialsRow, Horizontal {

sourcerer/presentation/screens/settings/main.py

@@ -0,0 +1,70 @@
+from textual import on
+from textual.app import ComposeResult
+from textual.containers import Container, Horizontal
+from textual.widgets import Checkbox, Rule, Select, Static
+
+from sourcerer.domain.settings.entities import Settings, SettingsFields
+from sourcerer.presentation.screens.shared.modal_screens import ExitBoundModalScreen
+from sourcerer.presentation.screens.shared.widgets.button import Button
+
+
+class SettingsScreen(ExitBoundModalScreen):
+    """Screen with a parameter."""
+
+    CSS_PATH = "styles.tcss"
+
+    def __init__(self, settings: Settings) -> None:
+        super().__init__()
+        self.settings = settings
+
+    def compose(self) -> ComposeResult:
+        with Container():
+            with Horizontal():
+                yield Static("Theme:")
+                yield Select(
+                    ((theme, theme) for theme in self.app._registered_themes),
+                    id="theme",
+                    value=self.settings.theme,
+                    allow_blank=False,
+                )
+
+            yield Rule()
+            with Horizontal():
+                yield Checkbox(
+                    "Group storage by access credentials",
+                    value=self.settings.group_by_access_credentials,
+                )
+
+            yield Rule()
+            with Horizontal(id="controls"):
+                yield Button("Save", name="save")
+                yield Button("Close", name="close")
+
+    @on(Button.Click)
+    def on_button_clicked(self, event: Button.Click) -> None:
+        """Handle button clicked events."""
+        if event.action == "close":
+            self.action_cancel_screen()
+        elif event.action == "save":
+            self.dismiss(
+                {
+                    SettingsFields.theme: self.query_one("Select#theme", Select).value,
+                    SettingsFields.group_by_access_credentials: self.query_one(
+                        Checkbox
+                    ).value,
+                }
+            )
+
+    def action_cancel_screen(self):
+        self.dismiss(
+            {
+                SettingsFields.theme: self.settings.theme,
+                SettingsFields.group_by_access_credentials: self.settings.group_by_access_credentials,
+            }
+        )
+
+    @on(Select.Changed)
+    def on_select_changed(self, event: Select.Changed) -> None:
+        """Handle select changed events."""
+        if event.select.id == "theme":
+            self.app.theme = event.value  # type: ignore[assignment]

sourcerer/presentation/screens/settings/styles.tcss

@@ -0,0 +1,44 @@
+SettingsScreen {
+  align: center middle;
+  content-align: center top;
+
+  & > Container {
+    padding: 1 2 0 2;
+    margin: 0 0;
+    width: 70%;
+    height: auto;
+    border: solid $border;
+
+    & > Static {
+      text-align: center;
+      text-wrap: wrap;
+    }
+
+    & > Horizontal {
+      align: center bottom;
+      height: auto;
+
+      & > Static {
+        width: 10%;
+        padding-top: 1;
+      }
+
+      & > Checkbox {
+        width: 100%;
+        border: none;
+        background: transparent;
+
+        &:focus {
+          background: transparent;
+
+          & > .toggle--label {
+            color: $text-secondary;
+            background: transparent;
+          }
+        }
+
+      }
+    }
+  }
+
+}

sourcerer/presentation/screens/shared/widgets/button.py

@@ -28,6 +28,7 @@ class Button(Label):
         }
     }
     """
+    can_focus = True
 
     @dataclass
     class Click(Message):
@@ -52,3 +53,13 @@ class Button(Label):
             _: An instance of events.Click representing the click event.
         """
         self.post_message(self.Click(self.name))  # type: ignore
+
+    def on_key(self, event: events.Key) -> None:
+        """
+        Handle key events to trigger click action when the button is focused and activated.
+
+        Args:
+            event (events.Key): The key event to handle.
+        """
+        if event.key == "enter":
+            self.post_message(self.Click(self.name))  # type: ignore

sourcerer/presentation/screens/shared/widgets/labeled_input.py

@@ -77,8 +77,6 @@ class LabeledInput(Container):
         """
         input_area = self.query_one(".form_input")
         text = (
-            input_area.document.text
-            if isinstance(input_area, TextArea)
-            else input_area.value  # type: ignore
+            input_area.document.text if isinstance(input_area, TextArea) else input_area.value  # type: ignore
         )
         return self.Value(name=self.key, value=text)

sourcerer/presentation/screens/storage_action_progress/main.py

@@ -369,7 +369,7 @@ class StorageActionProgressScreen(ModalScreen):
             key (str): The key/path of the file to delete
             uuid (str): Unique identifier for the file
             main_progress_bar (ProgressBar): The main progress bar to update
-        """ ""
+        """
         if not self.provider_service:
             self.notify(f"Failed to delete {key}", severity="error")
             main_progress_bar.advance(1)
@@ -418,7 +418,6 @@ class StorageActionProgressScreen(ModalScreen):
                 finally:
                     self.files_has_been_processed = True
             elif source_path.is_dir():
-
                 files_n = len([i for i in source_path.rglob("*") if i.is_file()])
                 progress_bar = self.query_one(f"#progress_bar_{key.uuid}", ProgressBar)
                 progress_bar.total = files_n

sourcerer/presentation/screens/storages_list/main.py

@@ -1,10 +1,12 @@
 import datetime
 import uuid
 from enum import Enum
+from typing import ClassVar
 
 from dependency_injector.wiring import Provide
 from textual import on
 from textual.app import ComposeResult
+from textual.binding import Binding, BindingType
 from textual.containers import Container, Horizontal, VerticalScroll
 from textual.reactive import reactive
 from textual.widgets import Label
@@ -82,6 +84,11 @@ class StoragesListScreen(RefreshTriggerableModalScreen):
     MAIN_CONTAINER_ID = "StoragesListScreen"
     SETTINGS_CONTAINER_ID = "settings"
 
+    BINDINGS: ClassVar[list[BindingType]] = [
+        *RefreshTriggerableModalScreen.BINDINGS,
+        Binding("ctrl+n", "add_storage", "Add new storage"),
+    ]
+
     storages_list = reactive([], recompose=True)
 
     def __init__(
@@ -104,6 +111,7 @@ class StoragesListScreen(RefreshTriggerableModalScreen):
                     "+Add new storage",
                     name=ControlsEnum.ADD_STORAGE.name,
                     classes="add_storage_button",
+                    id="add_storage_button",
                 ),
                 id="right-top",
             )
@@ -155,10 +163,7 @@ class StoragesListScreen(RefreshTriggerableModalScreen):
         if event.action == ControlsEnum.CANCEL.name:
             self.action_cancel_screen()
         if event.action == ControlsEnum.ADD_STORAGE.name:
-            self.app.push_screen(
-                StoragesRegistrationScreen(),
-                callback=self.create_storage_entry,  # type: ignore
-            )
+            self.action_add_storage()
 
     def create_storage_entry(self, storage: StorageEntry | None):
         """
@@ -182,3 +187,9 @@ class StoragesListScreen(RefreshTriggerableModalScreen):
             )
         )
         self.refresh_storages_list()
+
+    def action_add_storage(self):
+        self.app.push_screen(
+            StoragesRegistrationScreen(),
+            callback=self.create_storage_entry,  # type: ignore
+        )