gitpane 1.0.0__py3-none-any.whl

gitpane/ui/welcome/invalid_repository_prompt.py

@@ -0,0 +1,114 @@
+"""Offer to remove from the recent repositories a repository whose folder no longer exists, like Git Extensions does."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from PySide6.QtCore import Qt, Signal
+from PySide6.QtWidgets import QCommandLinkButton, QDialog, QHBoxLayout, QLabel, QPushButton, QStyle, QVBoxLayout
+
+from gitpane.config import SCREEN_MARGIN, SPACING_MD, SPACING_XS
+from gitpane.ui.widget.dialog_layout import (
+    MESSAGE_BOX_BODY_MARGINS,
+    MESSAGE_BOX_BUTTON_BAND,
+    MESSAGE_BOX_BUTTON_SIZE,
+    MESSAGE_BOX_ICON_SIDE,
+    MESSAGE_BOX_ICON_TO_TEXT_SPACE,
+    BandButtonSizing,
+    install_banded_layout,
+)
+
+if TYPE_CHECKING:
+    from PySide6.QtCore import SignalInstance
+    from PySide6.QtWidgets import QWidget
+
+INVALID_REPOSITORY_TITLE = "Open"
+INVALID_REPOSITORY_HEADING = "The selected item is not a valid git repository."
+REMOVE_SELECTED_LABEL = "Remove the selected invalid repository"
+REMOVE_ALL_LABEL = "Remove all {count} invalid repositories"
+# The heading wraps at a message-box width instead of stretching the prompt; the path gets at least that width and
+# widens the prompt when longer, since a path usually has no space to wrap at and would otherwise be cut off.
+INVALID_REPOSITORY_TEXT_WIDTH = 460
+# Removing "all" only means something when another entry is invalid besides the selected one.
+SINGLE_INVALID_COUNT = 1
+
+
+class InvalidRepositoryPrompt(QDialog):
+    """Offer to remove the chosen entry from the recent history, and every invalid entry when there are several.
+
+    Cancel, Escape and the title-bar close do nothing else. Only the history can change afterwards: no folder is ever
+    touched, whatever the choice.
+    """
+
+    remove_selected_requested = Signal()
+    remove_all_requested = Signal()
+
+    def __init__(self, repository_dir: str, invalid_count: int, parent: QWidget | None = None) -> None:
+        """Build the prompt for one missing repository, with the Remove all choice only when several entries are invalid."""
+        super().__init__(parent)
+        self.answered = False
+        self.setWindowTitle(INVALID_REPOSITORY_TITLE)
+        self.setWindowFlags(Qt.WindowType.Dialog | Qt.WindowType.CustomizeWindowHint | Qt.WindowType.WindowTitleHint | Qt.WindowType.WindowCloseButtonHint)
+        layout = QVBoxLayout()
+        layout.setSpacing(0)
+        message_row = QHBoxLayout()
+        message_row.setSpacing(MESSAGE_BOX_ICON_TO_TEXT_SPACE)
+        # Git Extensions shows this prompt with the error icon.
+        icon_label = QLabel()
+        icon_label.setPixmap(self.style().standardIcon(QStyle.StandardPixmap.SP_MessageBoxCritical).pixmap(MESSAGE_BOX_ICON_SIDE, MESSAGE_BOX_ICON_SIDE))
+        icon_label.setFixedSize(MESSAGE_BOX_ICON_SIDE, MESSAGE_BOX_ICON_SIDE)
+        message_row.addWidget(icon_label, 0, Qt.AlignmentFlag.AlignTop)
+        text_column = QVBoxLayout()
+        text_column.setSpacing(SPACING_XS)
+        self.heading_label = self._message_label(INVALID_REPOSITORY_HEADING)
+        self.heading_label.setWordWrap(True)
+        self.heading_label.setFixedWidth(INVALID_REPOSITORY_TEXT_WIDTH)
+        self.path_label = self._message_label(repository_dir)
+        self.path_label.setMinimumWidth(INVALID_REPOSITORY_TEXT_WIDTH)
+        text_column.addWidget(self.heading_label)
+        text_column.addWidget(self.path_label)
+        text_column.addSpacing(SPACING_MD)
+        # The Git Extensions task dialog offers both removals as command links stacked under its text.
+        self.remove_selected_button = QCommandLinkButton(REMOVE_SELECTED_LABEL)
+        self.remove_all_button = QCommandLinkButton(REMOVE_ALL_LABEL.format(count=invalid_count))
+        for command_button in (self.remove_selected_button, self.remove_all_button):
+            command_button.setAutoDefault(False)
+            text_column.addWidget(command_button)
+        self.remove_all_button.setVisible(invalid_count > SINGLE_INVALID_COUNT)
+        message_row.addLayout(text_column, 1)
+        layout.addLayout(message_row)
+        self.cancel_button = QPushButton("Cancel")
+        self.cancel_button.setMinimumSize(MESSAGE_BOX_BUTTON_SIZE)
+        self.cancel_button.setAutoDefault(False)
+        install_banded_layout(self, layout, [self.cancel_button], MESSAGE_BOX_BUTTON_BAND, MESSAGE_BOX_BODY_MARGINS, button_sizing=BandButtonSizing.WINDOW)
+        # The safe answer is the default one: removing an entry always takes a deliberate click.
+        self.cancel_button.setDefault(True)
+        self.remove_selected_button.clicked.connect(lambda: self._answer(self.remove_selected_requested))
+        self.remove_all_button.clicked.connect(lambda: self._answer(self.remove_all_requested))
+        self.cancel_button.clicked.connect(self.reject)
+        self._fit_path_width()
+
+    def _fit_path_width(self) -> None:
+        """Give the path its whole text width as a minimum, within the usable screen width, so it is never cut.
+
+        Qt opens a window at most two thirds of the screen wide from its preferred size. A long path in a larger font
+        (Ubuntu's 11 pt on a 1920 px screen) goes past that, so the minimum makes the prompt as wide as the path needs.
+        """
+        text_width = self.path_label.sizeHint().width()
+        beside_path_width = self.sizeHint().width() - text_width
+        usable_width = self.screen().availableGeometry().width() - 2 * SCREEN_MARGIN - beside_path_width
+        self.path_label.setMinimumWidth(max(INVALID_REPOSITORY_TEXT_WIDTH, min(text_width, usable_width)))
+
+    def _message_label(self, text: str) -> QLabel:
+        """Show text exactly as written, never as markup, and selectable so a path can be copied."""
+        label = QLabel(text)
+        label.setTextFormat(Qt.TextFormat.PlainText)
+        label.setTextInteractionFlags(Qt.TextInteractionFlag.TextSelectableByMouse | Qt.TextInteractionFlag.TextSelectableByKeyboard)
+        return label
+
+    def _answer(self, signal: SignalInstance) -> None:
+        """Emit the chosen removal at most once, then close the prompt."""
+        if not self.answered:
+            self.answered = True
+            signal.emit()
+        self.accept()