data-sourcerer 0.3.0__tar.gz → 0.4.0__tar.gz

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: data-sourcerer
-Version: 0.3.0
+Version: 0.4.0
 Summary: Sourcerer is a terminal cloud storage navigator.
 Author-email: Bohdana Kuzmenko <bohdana.kuzmenko.dev@gmail.com>
 License: MIT
@@ -42,6 +42,8 @@ engineers to view and manage files across multiple cloud providers like
 
 > Your terminal. Your storages. Your control.
 
+[Demo page](https://the-impact-craft.github.io/sourcerer/)
+
 ---
 
 ## ✨ Features

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/README.md

@@ -6,6 +6,8 @@ engineers to view and manage files across multiple cloud providers like
 
 > Your terminal. Your storages. Your control.
 
+[Demo page](https://the-impact-craft.github.io/sourcerer/)
+
 ---
 
 ## ✨ Features

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 
 name = "data-sourcerer"
-version = "0.3.0"
+version = "0.4.0"
 description = "Sourcerer is a terminal cloud storage navigator."
 requires-python = ">=3.9"
 

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/sourcerer/__init__.py

@@ -12,4 +12,4 @@ The application is structured using a clean architecture approach with:
 - Presentation layer: User interface components
 """
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/sourcerer/domain/storage_provider/entities.py

@@ -63,7 +63,7 @@ class File(Struct):
 
     uuid: str
     key: str
-    size: str
+    size: int
     is_text: bool
     date_modified: datetime | None = None
 

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/sourcerer/infrastructure/storage_provider/services/azure.py

@@ -10,7 +10,6 @@ from collections.abc import Callable
 from pathlib import Path
 from typing import Any
 
-import humanize
 from azure.mgmt.storage import StorageManagementClient
 from azure.storage.blob import BlobServiceClient
 from platformdirs import user_downloads_dir
@@ -38,7 +37,6 @@ from sourcerer.infrastructure.utils import generate_uuid, is_text_file
 
 @storage_provider(StorageProvider.AzureStorage)
 class AzureStorageProviderService(BaseStorageProviderService):
-
     def __init__(self, credentials: Any):
         """
         Initialize the service with Azure credentials.
@@ -137,7 +135,7 @@ class AzureStorageProviderService(BaseStorageProviderService):
                         File(
                             generate_uuid(),
                             remaining_path,
-                            size=humanize.naturalsize(blob.size),
+                            size=blob.size,
                             date_modified=blob.last_modified,
                             is_text=is_text_file(blob.name),
                         )

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/sourcerer/infrastructure/storage_provider/services/gcp.py

@@ -9,7 +9,6 @@ from collections.abc import Callable
 from pathlib import Path
 from typing import Any
 
-import humanize
 from platformdirs import user_downloads_dir
 
 from sourcerer.domain.shared.entities import StorageProvider
@@ -136,7 +135,7 @@ class GCPStorageProviderService(BaseStorageProviderService):
                     File(
                         generate_uuid(),
                         blob.name[len(path) :],
-                        size=humanize.naturalsize(blob.size),
+                        size=blob.size,
                         date_modified=blob.updated.date(),
                         is_text=is_text_file(blob.name),
                     )

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/sourcerer/infrastructure/storage_provider/services/s3.py

@@ -10,7 +10,6 @@ from itertools import groupby
 from pathlib import Path
 from typing import Any
 
-import humanize
 from platformdirs import user_downloads_dir
 
 from sourcerer.domain.shared.entities import StorageProvider
@@ -173,7 +172,7 @@ class S3ProviderService(BaseStorageProviderService):
             File(
                 generate_uuid(),
                 i.get("Key").replace(path, ""),
-                humanize.naturalsize(i.get("Size")),
+                i.get("Size"),
                 is_text_file(i.get("Key")),
                 i.get("LastModified"),
             )

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/sourcerer/presentation/screens/file_system_finder/main.py

@@ -1,16 +1,13 @@
 from collections.abc import Callable
 from dataclasses import dataclass
 from pathlib import Path
-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
 from textual.css.query import NoMatches
 from textual.reactive import reactive
-from textual.screen import ModalScreen
 from textual.widgets import Static
 
 from sourcerer.infrastructure.file_system.services import FileSystemService
@@ -18,6 +15,7 @@ from sourcerer.presentation.di_container import DiContainer
 from sourcerer.presentation.screens.file_system_finder.widgets.file_system_navigator import (
     FileSystemNavigator,
 )
+from sourcerer.presentation.screens.shared.modal_screens import ExitBoundModalScreen
 from sourcerer.presentation.screens.shared.widgets.button import Button
 
 
@@ -27,14 +25,10 @@ class FileSystemSelectionValidationRule:
     error_message: str
 
 
-class FileSystemNavigationModal(ModalScreen):
+class FileSystemNavigationModal(ExitBoundModalScreen):
     CONTAINER_ID = "file_system_view_container"
     CSS_PATH = "styles.tcss"
 
-    BINDINGS: ClassVar[list[BindingType]] = [
-        Binding("escape", "app.pop_screen", "Pop screen"),
-    ]
-
     active_path: reactive[Path] = reactive(Path())
 
     def __init__(
@@ -126,7 +120,7 @@ class FileSystemNavigationModal(ModalScreen):
             event (Button.Click): The event containing the button that was clicked.
         """
         if event.action == "close":
-            self.on_close()
+            self.action_cancel_screen()
         else:
             self.on_apply()
 

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/sourcerer/presentation/screens/main/main.py

@@ -1,3 +1,4 @@
+import contextlib
 import time
 import traceback
 from concurrent.futures import ThreadPoolExecutor
@@ -9,6 +10,7 @@ from textual import on, work
 from textual.app import App, ComposeResult
 from textual.binding import Binding, BindingType
 from textual.containers import Horizontal
+from textual.css.query import NoMatches
 from textual.reactive import reactive
 from textual.widgets import Footer
 
@@ -102,6 +104,7 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
     BINDINGS: ClassVar[list[BindingType]] = [
         Binding("ctrl+r", "registrations", "Registrations list"),
         Binding("ctrl+s", "storages", "Storages list"),
+        Binding("ctrl+f", "find", show=False),
         Binding(
             KeyBindings.ARROW_LEFT.value, "focus_sidebar", "Focus sidebar", show=False
         ),
@@ -152,6 +155,13 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
         self.theme = "github-dark"
         self.init_storages_list()
 
+    def action_find(self):
+        """
+        Focus search input.
+        """
+        with contextlib.suppress(NoMatches):
+            self.query_one(f"#{self.storage_content.search_input_id}").focus()
+
     def action_focus_content(self):
         """
         Focuses the storage content container.
@@ -174,10 +184,23 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
         This method is typically used to allow users to add their
         cloud storage credentials, which will then be reflected in the storage
         """
-        self.app.push_screen(ProviderCredsListScreen(), callback=self.refresh_storages)
+        self.app.push_screen(
+            ProviderCredsListScreen(), callback=self.modal_screen_callback
+        )
 
     def action_storages(self):
-        self.app.push_screen(StoragesListScreen(), callback=self.refresh_storages)
+        self.app.push_screen(StoragesListScreen(), callback=self.modal_screen_callback)
+
+    def modal_screen_callback(self, requires_storage_refresh: bool | None = True):
+        """
+        Callback for modal screens to refresh the storage list if required.
+
+        This method is called when a modal screen is closed. If the
+        `requires_storage_refresh` flag is set to True, it refreshes the
+        storage list by calling the `refresh_storages` method.
+        """
+        if requires_storage_refresh:
+            self.refresh_storages()
 
     def refresh_storages(self, *args, **kwargs):
         """
@@ -187,6 +210,7 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
         configurations.
         """
         self.storage_list_sidebar.storages = {}
+        self.storage_list_sidebar.last_update_timestamp = time.time()
         self.init_storages_list()
 
     @work(thread=True)
@@ -384,6 +408,7 @@ class Sourcerer(App, ResizeContainersWatcherMixin):
             PreviewContentScreen(
                 storage_name=event.storage_name,
                 key=event.path,
+                file_size=event.size,
                 access_credentials_uuid=event.access_credentials_uuid,
             )
         )

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/sourcerer/presentation/screens/main/messages/preview_request.py

@@ -8,3 +8,4 @@ class PreviewRequest(Message):
     storage_name: str
     access_credentials_uuid: str
     path: str
+    size: int

{data_sourcerer-0.3.0 → data_sourcerer-0.4.0}/sourcerer/presentation/screens/main/widgets/storage_content.py

@@ -12,6 +12,7 @@ from dataclasses import dataclass
 from enum import Enum, auto
 from typing import ClassVar, Self
 
+import humanize
 from textual import events, on
 from textual.app import ComposeResult
 from textual.binding import Binding, BindingType
@@ -308,6 +309,7 @@ class FileItem(StorageContentItem):
         """Message sent when a file preview is selected."""
 
         name: str
+        size: int
 
     @dataclass
     class Unselect(Message):
@@ -333,7 +335,9 @@ class FileItem(StorageContentItem):
         yield FileMetaLabel(
             f"{FILE_ICON} {self.file.key}", classes="file_name", markup=False
         )
-        yield FileMetaLabel(f"{self.file.size}", classes="file_size", markup=False)
+        yield FileMetaLabel(
+            f"{humanize.naturalsize(self.file.size)}", classes="file_size", markup=False
+        )
         yield FileMetaLabel(
             str(self.file.date_modified), classes="file_date", markup=False
         )
@@ -360,7 +364,7 @@ class FileItem(StorageContentItem):
             preview_button = self.query_one(Button)
 
         if widget is preview_button:
-            self.post_message(self.Preview(self.file.key))
+            self.post_message(self.Preview(self.file.key, self.file.size))
             return
 
         checkbox = self.query_one(UnfocusableCheckbox)
@@ -561,6 +565,8 @@ class StorageContentContainer(Vertical):
     }
     """
 
+    search_input_id: ClassVar[str] = "search_input"
+
     def compose(self) -> ComposeResult:
         if not self.storage:
             return
@@ -584,7 +590,7 @@ class StorageContentContainer(Vertical):
             with Horizontal():
                 yield Label("Search:")
                 yield Input(
-                    id="search_input",
+                    id=self.search_input_id,
                     placeholder="input path prefix here...",
                     value=self.search_prefix,
                 )
@@ -663,6 +669,7 @@ class StorageContentContainer(Vertical):
                 self.storage,
                 self.access_credentials_uuid,
                 os.path.join(self.path, event.name) if self.path else event.name,
+                event.size,
             )
         )
 

data_sourcerer-0.4.0/sourcerer/presentation/screens/preview_content/main.py

@@ -0,0 +1,269 @@
+import contextlib
+import re
+from dataclasses import dataclass
+from pathlib import Path
+from typing import ClassVar
+
+import humanize
+from dependency_injector.wiring import Provide
+from rich.syntax import Syntax
+from textual import events, on
+from textual.app import ComposeResult
+from textual.binding import Binding, BindingType
+from textual.containers import Container, Horizontal
+from textual.css.query import NoMatches
+from textual.document._document import Selection
+from textual.message import Message
+from textual.reactive import reactive
+from textual.widgets import Input, Label, LoadingIndicator, Rule, TextArea
+
+from sourcerer.infrastructure.access_credentials.services import CredentialsService
+from sourcerer.infrastructure.storage_provider.exceptions import (
+    ReadStorageItemsError,
+)
+from sourcerer.presentation.di_container import DiContainer
+from sourcerer.presentation.screens.preview_content.text_area_style import (
+    SOURCERER_THEME_NAME,
+    sourcerer_text_area_theme,
+)
+from sourcerer.presentation.screens.shared.modal_screens import ExitBoundModalScreen
+from sourcerer.presentation.screens.shared.widgets.button import Button
+from sourcerer.presentation.utils import get_provider_service_by_access_uuid
+from sourcerer.settings import PREVIEW_LENGTH_LIMIT, PREVIEW_LIMIT_SIZE
+
+
+@dataclass
+class HighlightResult(Message):
+    line: int
+    start: int
+    end: int
+
+
+@dataclass
+class HideSearchBar(Message):
+    pass
+
+
+class ClickableLabel(Label):
+    @dataclass
+    class Click(Message):
+        name: str
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    def on_click(self, _: events.Click) -> None:
+        self.post_message(self.Click(name=self.name))  # type: ignore
+
+
+class Search(Container):
+    total = reactive(0, recompose=False)
+    current = reactive(0, recompose=False)
+    content = reactive("", recompose=False)
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.search_result_lines = []
+        self.search_value = ""
+
+    def compose(self) -> ComposeResult:
+        with Horizontal():
+            with Horizontal(id="left"):
+                yield Label("Search:")
+                yield Input(placeholder="...")
+
+            with Horizontal(id="right"):
+                yield ClickableLabel(
+                    "◀", id="previous", name="previous", classes="search-button"
+                )
+                yield Label(f"{self.current}/{self.total}", id="search-result")
+                yield ClickableLabel(
+                    "▶", id="next", name="next", classes="search-button"
+                )
+                yield ClickableLabel(
+                    "❌", id="hide", name="hide", classes="search-button"
+                )
+        yield Rule()
+
+    @on(Input.Submitted)
+    def on_input_submitted(self, event: Input.Submitted) -> None:
+        """Handle input submitted events."""
+        if not event.value or not self.content:
+            self.total = 0
+            self.current = 0
+            self.search_value = ""
+            self.search_result_lines = []
+            return
+        if event.value == self.search_value:
+            self._increment_current()
+            return
+
+        self.search_value = event.value
+        lines = self.content.split("\n")
+        search_pattern = event.value.lower()
+
+        self.search_result_lines = [
+            (line_n, index)
+            for line_n, line in enumerate(lines)
+            if search_pattern in line.lower()
+            for index in [
+                match.start()
+                for match in re.finditer(rf"(?i){re.escape(search_pattern)}", line)
+            ]
+        ]
+
+        if not self.search_result_lines:
+            self.notify("No matches found", severity="warning")
+            self.total, self.current = 0, 0
+            return
+
+        self.total = len(self.search_result_lines)
+        self.current = 1
+
+    @on(ClickableLabel.Click)
+    def on_click(self, event: ClickableLabel.Click) -> None:
+        if event.name == "next":
+            self._increment_current()
+        elif event.name == "previous":
+            self._decrement_current()
+        elif event.name == "hide":
+            self.post_message(HideSearchBar())
+
+    def _increment_current(self):
+        self.current = self.current + 1 if self.current < self.total else 1
+
+    def _decrement_current(self):
+        self.current = self.current - 1 if self.current > 1 else self.total
+
+    def watch_current(self):
+        with contextlib.suppress(NoMatches):
+            search_result = self.query_one("#search-result", Label)
+            search_result.update(f"{self.current}/{self.total}")
+        if not self.search_result_lines:
+            return
+        line, start = self.search_result_lines[self.current - 1]
+        self.post_message(
+            HighlightResult(line, start=start, end=start + len(self.search_value))
+        )
+
+
+class PreviewContentScreen(ExitBoundModalScreen):
+    CSS_PATH = "styles.tcss"
+
+    BINDINGS: ClassVar[list[BindingType]] = [
+        Binding("escape", "cancel", "Close the screen"),
+    ]
+
+    def __init__(
+        self,
+        storage_name,
+        key,
+        file_size,
+        access_credentials_uuid,
+        *args,
+        credentials_service: CredentialsService = Provide[
+            DiContainer.credentials_repository
+        ],
+        **kwargs,
+    ):
+        super().__init__(*args, **kwargs)
+
+        self.storage_name = storage_name
+        self.key = key
+        self.file_size = file_size
+        self.access_credentials_uuid = access_credentials_uuid
+        self.credentials_service = credentials_service
+        self.content = None
+
+    def compose(self) -> ComposeResult:
+        with Container(id="PreviewContentScreen"):
+            yield Search(id="search-bar")
+            yield LoadingIndicator(id="loading")
+            yield TextArea(read_only=True, show_line_numbers=True)
+            with Horizontal(id="controls"):
+                yield Button("Close", name="cancel")
+
+    def on_mount(self) -> None:
+        """Called when the DOM is ready."""
+        search = self.query_one(Search)
+        text_log = self.query_one(TextArea)
+        text_log.register_theme(sourcerer_text_area_theme)
+        text_log.theme = SOURCERER_THEME_NAME
+
+        provider_service = get_provider_service_by_access_uuid(
+            self.access_credentials_uuid, self.credentials_service
+        )
+        if not provider_service:
+            self.notify("Could not read file :(", severity="error")
+            return
+        try:
+            self.content = provider_service.read_storage_item(
+                self.storage_name, self.key
+            )
+            if self.file_size > PREVIEW_LIMIT_SIZE:
+                self.content = self.content[:PREVIEW_LENGTH_LIMIT]
+                self.notify(
+                    f"The file size {humanize.naturalsize(self.file_size)} "
+                    f"exceeds {humanize.naturalsize(PREVIEW_LIMIT_SIZE)} preview limit. "
+                    f"The content is truncated to {PREVIEW_LENGTH_LIMIT} characters.",
+                    severity="warning",
+                )
+            search.content = self.content
+        except ReadStorageItemsError:
+            self.notify("Could not read file :(", severity="error")
+            return
+        self.query_one("#loading").remove()
+        if self.content is None:
+            self.notify("Empty file", severity="warning")
+            return
+
+        extension = Path(self.key).suffix
+
+        lexer = (
+            "json"
+            if extension == ".tfstate"
+            else Syntax.guess_lexer(self.key, self.content)
+        )
+        if lexer in text_log.available_languages:
+            text_log.language = lexer
+        else:
+            text_log.language = "python"
+        text_log.blur()
+        text_log.load_text(self.content)
+
+    @on(Button.Click)
+    def on_button_click(self, event: Button.Click) -> None:
+        """Handle button click events."""
+        if event.action == "cancel":
+            self.action_cancel_screen()
+
+    @on(HideSearchBar)
+    def on_hide_search_bar(self, _: HideSearchBar) -> None:
+        """Handle hide search bar events."""
+        search_bar = self.query_one("#search-bar", Search)
+        search_bar.remove_class("-visible")
+        search_bar.query_one(Input).value = ""
+        search_bar.total = 0
+        search_bar.current = 0
+        search_bar.search_result_lines = []
+        search_bar.search_value = ""
+
+    @on(HighlightResult)
+    def on_highlight_result(self, event: HighlightResult) -> None:
+        """Handle highlight result events."""
+
+        text_area = self.query_one(TextArea)
+        text_area.selection = Selection(
+            start=(event.line, event.start), end=(event.line, event.end)
+        )
+
+    def action_find(self):
+        self.query_one("#search-bar").add_class("-visible")
+        self.query_one(Input).focus()
+
+    def action_cancel(self):
+        self.action_cancel_screen()
+
+    def on_key(self, event: events.Key) -> None:
+        if event.key in ("ctrl+f", "super+f"):
+            self.action_find()

data_sourcerer-0.4.0/sourcerer/presentation/screens/preview_content/styles.tcss

@@ -0,0 +1,62 @@
+
+Container {
+  height: auto;
+}
+
+
+PreviewContentScreen {
+  align: center middle;
+  content-align: center top;
+
+
+  & > #PreviewContentScreen {
+    padding: 1 2 0 2;
+    margin: 0 0;
+    width: 70%;
+    height: 40;
+    border: solid $secondary-background;
+    border-title-color: $primary-lighten-2;
+
+
+    #search-bar {
+      height: auto;
+      display: none;
+
+      &.-visible {
+        display: block;
+      }
+    }
+
+    Horizontal{
+      height: auto;
+
+      & > Static {
+        width: auto;
+      }
+
+      #left {
+        align: left middle;
+        width: 90%;
+      }
+      #right {
+          align: right middle;
+          width: 10%;
+      }
+    }
+
+    Input {
+      height: 1;
+      border: none;
+      background: transparent;
+      width: 78%;
+    }
+
+    TextArea {
+      background-tint: $background;
+
+      &:focus {
+        border: tall $border-blurred;
+      }
+    }
+  }
+}