draftomen 0.3.0__py3-none-any.whl

draftomen/preferences.py

@@ -0,0 +1,289 @@
+"""Persisted user settings for Draftomen interfaces.
+Keep optional behavior and layout choices stable across app restarts.
+"""
+
+from __future__ import annotations
+
+import json
+import tempfile
+from dataclasses import asdict, dataclass
+from os import PathLike
+from pathlib import Path
+from typing import Literal, TypeAlias
+
+from draftomen.paths import app_data_dir
+
+PathInput: TypeAlias = str | PathLike[str]
+CardImagePreviewMode: TypeAlias = Literal["auto", "show", "hide"]
+
+TUI_PREFERENCES_FILE_NAME = "tui-preferences.json"
+TUI_PREFERENCES_SCHEMA_VERSION = 1
+CARD_IMAGE_PREVIEW_MODES = frozenset({"auto", "show", "hide"})
+
+
+@dataclass(frozen=True)
+class TuiVisibilityPreferences:
+    """User-controlled Textual behavior and optional interface elements.
+    Missing settings use safe defaults so existing files remain compatible.
+    """
+
+    secondary_columns: bool = True
+    build_details: bool = False
+    splash_enabled: bool = True
+    pool_metadata: bool = True
+    pool_color_distribution: bool = True
+    pool_mana_curve: bool = True
+    account_identifier: bool = True
+    draft_identifier: bool = True
+    mana_pips_and_sources: bool = True
+    attribution: bool = True
+    focused_card_details: bool = True
+    card_image_preview: CardImagePreviewMode = "auto"
+
+
+def tui_preferences_path(*, app_dir: PathInput | None = None) -> Path:
+    """Return the path used for persisted TUI visibility preferences.
+    The file lives directly in Draftomen's per-user application directory.
+    """
+
+    root = Path(app_data_dir() if app_dir is None else app_dir).expanduser()
+    return root / TUI_PREFERENCES_FILE_NAME
+
+
+def load_tui_preferences(
+    *,
+    app_dir: PathInput | None = None,
+) -> tuple[TuiVisibilityPreferences, str | None]:
+    """Load persisted visibility preferences, falling back safely to defaults.
+    A warning describes malformed or unsupported configuration without blocking startup.
+    """
+
+    try:
+        path = tui_preferences_path(app_dir=app_dir)
+        raw_text = path.read_text(encoding="utf-8")
+    except FileNotFoundError:
+        return TuiVisibilityPreferences(), None
+    except (OSError, UnicodeDecodeError) as error:
+        return TuiVisibilityPreferences(), f"Could not load TUI preferences: {error}"
+
+    try:
+        raw_data = json.loads(raw_text)
+    except json.JSONDecodeError as error:
+        return TuiVisibilityPreferences(), f"Could not load TUI preferences: {error}"
+
+    if not isinstance(raw_data, dict):
+        return (
+            TuiVisibilityPreferences(),
+            "Could not load TUI preferences: expected an object.",
+        )
+
+    version = raw_data.get("version")
+    if version != TUI_PREFERENCES_SCHEMA_VERSION:
+        return (
+            TuiVisibilityPreferences(),
+            "Could not load TUI preferences: unsupported settings version.",
+        )
+
+    visibility = raw_data.get("visibility")
+    if not isinstance(visibility, dict):
+        return (
+            TuiVisibilityPreferences(),
+            "Could not load TUI preferences: expected a visibility object.",
+        )
+
+    defaults = TuiVisibilityPreferences()
+    values = asdict(defaults)
+    invalid_fields: list[str] = []
+    for field_name, default_value in values.items():
+        value = visibility.get(field_name, default_value)
+        if field_name == "card_image_preview":
+            if not isinstance(value, str) or value not in CARD_IMAGE_PREVIEW_MODES:
+                invalid_fields.append(field_name)
+                continue
+        elif type(value) is not bool:
+            invalid_fields.append(field_name)
+            continue
+
+        values[field_name] = value
+
+    preferences = TuiVisibilityPreferences(**values)
+    if not invalid_fields:
+        return preferences, None
+
+    fields = ", ".join(invalid_fields)
+    return preferences, f"TUI preferences used defaults for invalid fields: {fields}."
+
+
+def save_tui_preferences(
+    *,
+    preferences: TuiVisibilityPreferences,
+    app_dir: PathInput | None = None,
+) -> str | None:
+    """Atomically save visibility preferences and return a non-fatal error message.
+    The active TUI can continue using preferences when persistence fails.
+    """
+
+    path = tui_preferences_path(app_dir=app_dir)
+    temporary_path: Path | None = None
+    try:
+        path.parent.mkdir(parents=True, exist_ok=True)
+        with tempfile.NamedTemporaryFile(
+            mode="w",
+            encoding="utf-8",
+            dir=path.parent,
+            delete=False,
+        ) as temporary_file:
+            json.dump(
+                {
+                    "version": TUI_PREFERENCES_SCHEMA_VERSION,
+                    "visibility": asdict(preferences),
+                },
+                temporary_file,
+                indent=2,
+                sort_keys=True,
+            )
+            temporary_file.write("\n")
+            temporary_path = Path(temporary_file.name)
+
+        temporary_path.replace(path)
+    except OSError as error:
+        return f"Could not save TUI preferences: {error}"
+    finally:
+        if temporary_path is not None:
+            try:
+                temporary_path.unlink()
+            except FileNotFoundError:
+                pass
+            except OSError:
+                pass
+
+    return None
+
+
+GUI_PREFERENCES_FILE_NAME = "gui-preferences.json"
+GUI_PREFERENCES_SCHEMA_VERSION = 1
+
+
+@dataclass(frozen=True)
+class GuiDisplayPreferences:
+    """User-controlled desktop display choices independent from the live session.
+    Functional draft choices remain owned by explicit live-session commands.
+    """
+
+    compact_density: bool = False
+    secondary_stats: bool = True
+    card_preview: bool = True
+    detailed_build_context: bool = True
+    system_text_scaling: bool = True
+    show_backtest: bool = False
+
+
+def gui_preferences_path(*, app_dir: PathInput | None = None) -> Path:
+    """Return the path used for persisted desktop display preferences.
+    The file lives directly in Draftomen's per-user application directory.
+    """
+
+    root = Path(app_data_dir() if app_dir is None else app_dir).expanduser()
+    return root / GUI_PREFERENCES_FILE_NAME
+
+
+def load_gui_preferences(
+    *,
+    app_dir: PathInput | None = None,
+) -> tuple[GuiDisplayPreferences, str | None]:
+    """Load desktop display preferences, falling back safely to defaults.
+    A warning describes malformed or unsupported configuration without blocking startup.
+    """
+
+    try:
+        path = gui_preferences_path(app_dir=app_dir)
+        raw_text = path.read_text(encoding="utf-8")
+    except FileNotFoundError:
+        return GuiDisplayPreferences(), None
+    except (OSError, UnicodeDecodeError) as error:
+        return GuiDisplayPreferences(), f"Could not load GUI preferences: {error}"
+
+    try:
+        raw_data = json.loads(raw_text)
+    except json.JSONDecodeError as error:
+        return GuiDisplayPreferences(), f"Could not load GUI preferences: {error}"
+
+    if not isinstance(raw_data, dict):
+        return GuiDisplayPreferences(), "Could not load GUI preferences: expected an object."
+    if raw_data.get("version") != GUI_PREFERENCES_SCHEMA_VERSION:
+        return (
+            GuiDisplayPreferences(),
+            "Could not load GUI preferences: unsupported settings version.",
+        )
+
+    display = raw_data.get("display")
+    if not isinstance(display, dict):
+        return (
+            GuiDisplayPreferences(),
+            "Could not load GUI preferences: expected a display object.",
+        )
+
+    defaults = GuiDisplayPreferences()
+    values = asdict(defaults)
+    invalid_fields: list[str] = []
+    for field_name, default_value in values.items():
+        value = display.get(field_name, default_value)
+        if type(value) is not bool:
+            invalid_fields.append(field_name)
+            continue
+        values[field_name] = value
+
+    preferences = GuiDisplayPreferences(**values)
+    if not invalid_fields:
+        return preferences, None
+    return (
+        preferences,
+        "GUI preferences used defaults for invalid fields: "
+        + ", ".join(invalid_fields)
+        + ".",
+    )
+
+
+def save_gui_preferences(
+    *,
+    preferences: GuiDisplayPreferences,
+    app_dir: PathInput | None = None,
+) -> str | None:
+    """Atomically save desktop display preferences and return a non-fatal error.
+    The active GUI can continue using a changed preference when persistence fails.
+    """
+
+    path = gui_preferences_path(app_dir=app_dir)
+    temporary_path: Path | None = None
+    try:
+        path.parent.mkdir(parents=True, exist_ok=True)
+        with tempfile.NamedTemporaryFile(
+            mode="w",
+            encoding="utf-8",
+            dir=path.parent,
+            delete=False,
+        ) as temporary_file:
+            json.dump(
+                {
+                    "version": GUI_PREFERENCES_SCHEMA_VERSION,
+                    "display": asdict(preferences),
+                },
+                temporary_file,
+                indent=2,
+                sort_keys=True,
+            )
+            temporary_file.write("\n")
+            temporary_path = Path(temporary_file.name)
+        temporary_path.replace(path)
+    except OSError as error:
+        return f"Could not save GUI preferences: {error}"
+    finally:
+        if temporary_path is not None:
+            try:
+                temporary_path.unlink()
+            except FileNotFoundError:
+                pass
+            except OSError:
+                pass
+
+    return None

draftomen/qml/AboutDialog.qml

@@ -0,0 +1,156 @@
+import QtQuick 2.15
+import QtQuick.Controls 2.15
+import QtQuick.Layouts 1.15
+
+Dialog {
+    id: root
+
+    required property string applicationVersion
+    property var returnFocusItem: null
+    readonly property string projectWebsite: "https://www.draftomen.com"
+    readonly property string projectRepository: "https://github.com/andreagrandi/draftomen"
+
+    objectName: "aboutDialog"
+    parent: Overlay.overlay
+    modal: true
+    focus: true
+    title: "About Draft Omen"
+    width: Math.min(460, Math.max(300, parent ? parent.width - 32 : 460))
+    x: parent ? Math.max(16, Math.round((parent.width - width) / 2)) : 16
+    y: parent ? Math.max(16, Math.round((parent.height - height) / 2)) : 16
+    padding: 16
+
+    Overlay.modal: Rectangle {
+        color: "#99000000"
+    }
+
+    background: Rectangle {
+        color: Theme.surface
+        border.color: Theme.outline
+        border.width: 1
+        radius: Theme.radius
+    }
+
+    header: Rectangle {
+        implicitHeight: 52
+        color: Theme.surfaceHigh
+        border.color: Theme.outline
+        border.width: 1
+
+        Label {
+            anchors.fill: parent
+            anchors.leftMargin: 16
+            anchors.rightMargin: 16
+            text: root.title
+            color: Theme.text
+            font.pixelSize: Theme.textPixelSize(18)
+            font.bold: true
+            verticalAlignment: Text.AlignVCenter
+        }
+    }
+
+    onClosed: {
+        const opener = root.returnFocusItem
+        root.returnFocusItem = null
+        if (opener && opener.visible && opener.enabled)
+            opener.forceActiveFocus()
+    }
+
+    contentItem: ColumnLayout {
+        spacing: 12
+        implicitWidth: 360
+
+        Label {
+            objectName: "aboutDialogTitle"
+            Layout.fillWidth: true
+            text: "Draft Omen"
+            color: Theme.text
+            font.pixelSize: Theme.textPixelSize(24)
+            font.bold: true
+            horizontalAlignment: Text.AlignHCenter
+            Accessible.name: text
+        }
+
+        Image {
+            objectName: "aboutDialogLogo"
+            Layout.alignment: Qt.AlignHCenter
+            Layout.preferredWidth: 180
+            Layout.preferredHeight: 180
+            source: "../assets/draftomen_logo.png"
+            sourceSize.width: 360
+            sourceSize.height: 360
+            fillMode: Image.PreserveAspectFit
+            smooth: true
+            mipmap: true
+            Accessible.name: "Draft Omen logo"
+        }
+
+        Label {
+            objectName: "aboutDialogVersion"
+            Layout.fillWidth: true
+            text: "Version " + root.applicationVersion
+            color: Theme.text
+            horizontalAlignment: Text.AlignHCenter
+            Accessible.name: "Draft Omen version " + root.applicationVersion
+        }
+
+        Label {
+            objectName: "aboutDialogAuthor"
+            Layout.fillWidth: true
+            text: "Made with ❤️ by Andrea Grandi"
+            color: Theme.text
+            horizontalAlignment: Text.AlignHCenter
+            Accessible.name: text
+        }
+
+        Label {
+            objectName: "aboutDialogLicense"
+            Layout.fillWidth: true
+            text: "Draft Omen is licensed under the MIT License"
+            color: Theme.text
+            horizontalAlignment: Text.AlignHCenter
+            Accessible.name: text
+        }
+
+        DimensionalButton {
+            id: websiteButton
+            objectName: "aboutDialogWebsite"
+            Layout.alignment: Qt.AlignHCenter
+            text: "Project website"
+            implicitWidth: 140
+            Accessible.name: "Open Draft Omen project website"
+            Accessible.description: root.projectWebsite
+            onClicked: Qt.openUrlExternally(root.projectWebsite)
+        }
+
+        DimensionalButton {
+            objectName: "aboutDialogRepository"
+            Layout.alignment: Qt.AlignHCenter
+            text: "GitHub repository"
+            implicitWidth: 160
+            Accessible.name: "Open Draft Omen GitHub repository"
+            Accessible.description: root.projectRepository
+            onClicked: Qt.openUrlExternally(root.projectRepository)
+        }
+    }
+
+    footer: DialogButtonBox {
+        implicitHeight: 58
+        alignment: Qt.AlignRight
+        background: Rectangle {
+            color: Theme.surfaceHigh
+            border.color: Theme.outline
+            border.width: 1
+        }
+
+        DimensionalButton {
+            id: closeButton
+            objectName: "aboutDialogCloseButton"
+            text: "Close"
+            accented: false
+            implicitWidth: 96
+            Accessible.name: "Close About dialog"
+            onClicked: root.close()
+        }
+    }
+}

draftomen/qml/AppBar.qml

@@ -0,0 +1,120 @@
+pragma ComponentBehavior: Bound
+
+import QtQuick 2.15
+import QtQuick.Controls 2.15
+import QtQuick.Layouts 1.15
+
+Rectangle {
+    id: root
+
+    required property var sessionState
+    required property var provider
+    required property bool narrow
+    signal settingsRequested()
+
+    color: Theme.surfaceLow
+    implicitHeight: 68
+
+    RowLayout {
+        anchors.fill: parent
+        anchors.leftMargin: 20
+        anchors.rightMargin: 20
+        spacing: 16
+
+        Label {
+            objectName: "appBarBrandTitle"
+            visible: root.narrow
+            text: "DRAFTOMEN"
+            color: Theme.primary
+            font.pixelSize: Theme.textPixelSize(18)
+            font.bold: true
+            font.letterSpacing: 1.2
+        }
+
+        Rectangle {
+            visible: root.narrow
+            Layout.preferredWidth: 1
+            Layout.preferredHeight: 34
+            color: Theme.outline
+        }
+
+        ColumnLayout {
+            Layout.fillWidth: true
+            Layout.minimumWidth: 0
+            spacing: 2
+
+            Label {
+                text: root.sessionState.status ? root.sessionState.status.message : "Starting Draft Omen."
+                color: Theme.text
+                elide: Text.ElideRight
+                Layout.fillWidth: true
+            }
+
+            Label {
+                text: root.sessionState.draft
+                    ? root.sessionState.draft.set_code + " · " + root.sessionState.draft.event_name
+                    : "No active draft"
+                color: Theme.textMuted
+                font.pixelSize: Theme.textPixelSize(11)
+                Layout.fillWidth: true
+                elide: Text.ElideRight
+            }
+        }
+
+        DimensionalComboBox {
+            id: accountSelector
+            objectName: "accountSelector"
+            Layout.preferredWidth: 180
+            visible: root.sessionState.accounts
+                && root.sessionState.accounts.length > 0
+            model: root.sessionState.accounts || []
+            textRole: "screen_name"
+            valueRole: "account_id"
+            currentIndex: {
+                const activeAccount = root.sessionState.active_account
+                if (!activeAccount)
+                    return -1
+                for (let index = 0; index < model.length; index++) {
+                    if (model[index].account_id === activeAccount.account_id)
+                        return index
+                }
+                return -1
+            }
+            displayText: root.sessionState.active_account
+                ? root.sessionState.active_account.screen_name
+                    || root.sessionState.active_account.account_id
+                : "Choose Arena account"
+            Accessible.name: "Arena account"
+            Accessible.description: "Choose the Arena account whose live draft is shown."
+            onActivated: root.provider.chooseAccount(currentValue)
+        }
+
+        DimensionalComboBox {
+            id: scenarioSelector
+            visible: root.provider && root.provider.mockMode
+            Layout.preferredWidth: 126
+            model: root.provider ? root.provider.scenarios : []
+            currentIndex: root.provider
+                ? Math.max(0, root.provider.scenarios.indexOf(root.provider.scenario))
+                : -1
+            Accessible.name: "Representative state"
+            Accessible.description: "Choose deterministic visual-development data."
+            onActivated: root.provider.selectScenario(currentText)
+        }
+        DimensionalButton {
+            objectName: "settingsButton"
+            text: "Settings"
+            Accessible.name: "Open settings"
+            Accessible.description: "Open draft guidance, display, and accessibility settings."
+            onClicked: root.settingsRequested()
+        }
+    }
+
+    Rectangle {
+        anchors.bottom: parent.bottom
+        width: parent.width
+        height: 1
+        color: Theme.outline
+    }
+}
+