feat: add setting to not display full filepath (#841)

* feat: add show file path option to settings menu (#4)

* feat: implement file path option for file attributes (#10)

* feat: implement file path option for file attributes

---------

Co-authored-by: Zarko Sesto <sesto@kth.se>

* feat: update ui after changing file path setting (#9)

* feat: implement file path options for main window (#11)

Co-authored-by: Zarko Sesto <sesto@kth.se>

* feat: add realtime feedback for setting changes (#13)

Co-authored-by: Zarko Sesto <sesto@kth.se>

style: formatted code changes with ruff  (#16)

* tests: Added tests to test file path display and settings menu

enhancement: formated using RUFF

test: addeded test to check title bar update

* fix: move check for file option to correct spot in open_library (#17)

* fix: change translate_with_setter to new method (#18)

* fix: update call to translator to be inline with upstream (#19)

* refactor: update some imports to reflect refactor on upstream (#20)

* refactor: update import paths to reflect recent reformat

* format: run ruff format

* translation: add translations for filepath setting

* refactor: store filepath options in integer enum

---------

Co-authored-by: RubenSocha <40490633+RubenSocha@users.noreply.github.com>
Co-authored-by: ErzaDuNord <102242407+ErzaDuNord@users.noreply.github.com>
Co-authored-by: Zarko Sesto <sesto@kth.se>
Co-authored-by: BitGatito <usmanbinmujeeb@gmail.com>

tests/qt/test_file_path_options.py

@@ -0,0 +1,130 @@
+import os
+import pathlib
+from unittest.mock import patch
+
+import pytest
+from PySide6.QtGui import (
+    QAction,
+)
+from PySide6.QtWidgets import QMenu, QMenuBar
+
+from tagstudio.core.enums import SettingItems, ShowFilepathOption
+from tagstudio.core.library.alchemy.library import LibraryStatus
+from tagstudio.qt.modals.settings_panel import SettingsPanel
+from tagstudio.qt.widgets.preview_panel import PreviewPanel
+
+
+# Tests to see if the file path setting is applied correctly
+@pytest.mark.parametrize(
+    "filepath_option",
+    [
+        ShowFilepathOption.SHOW_FULL_PATHS.value,
+        ShowFilepathOption.SHOW_RELATIVE_PATHS.value,
+        ShowFilepathOption.SHOW_FILENAMES_ONLY.value,
+    ],
+)
+def test_filepath_setting(qtbot, qt_driver, filepath_option):
+    settings_panel = SettingsPanel(qt_driver)
+    qtbot.addWidget(settings_panel)
+
+    # Mock the update_recent_lib_menu method
+    with patch.object(qt_driver, "update_recent_lib_menu", return_value=None):
+        # Set the file path option
+        settings_panel.filepath_combobox.setCurrentIndex(filepath_option)
+        settings_panel.apply_filepath_setting()
+
+        # Assert the setting is applied
+        assert qt_driver.settings.value(SettingItems.SHOW_FILEPATH) == filepath_option
+
+
+# Tests to see if the file paths are being displayed correctly
+@pytest.mark.parametrize(
+    "filepath_option, expected_path",
+    [
+        (
+            ShowFilepathOption.SHOW_FULL_PATHS,
+            lambda library: pathlib.Path(library.library_dir / "one/two/bar.md"),
+        ),
+        (ShowFilepathOption.SHOW_RELATIVE_PATHS, lambda library: pathlib.Path("one/two/bar.md")),
+        (ShowFilepathOption.SHOW_FILENAMES_ONLY, lambda library: pathlib.Path("bar.md")),
+    ],
+)
+def test_file_path_display(qt_driver, library, filepath_option, expected_path):
+    panel = PreviewPanel(library, qt_driver)
+
+    # Select 2
+    qt_driver.toggle_item_selection(2, append=False, bridge=False)
+    panel.update_widgets()
+
+    with patch.object(qt_driver.settings, "value", return_value=filepath_option):
+        # Apply the mock value
+        filename = library.get_entry(2).path
+        panel.file_attrs.update_stats(filepath=pathlib.Path(library.library_dir / filename))
+
+        # Generate the expected file string.
+        # This is copied directly from the file_attributes.py file
+        # can be imported as a function in the future
+        display_path = expected_path(library)
+        file_str: str = ""
+        separator: str = f"<a style='color: #777777'><b>{os.path.sep}</a>"  # Gray
+        for i, part in enumerate(display_path.parts):
+            part_ = part.strip(os.path.sep)
+            if i != len(display_path.parts) - 1:
+                file_str += f"{"\u200b".join(part_)}{separator}</b>"
+            else:
+                if file_str != "":
+                    file_str += "<br>"
+                file_str += f"<b>{"\u200b".join(part_)}</b>"
+
+        # Assert the file path is displayed correctly
+        assert panel.file_attrs.file_label.text() == file_str
+
+
+@pytest.mark.parametrize(
+    "filepath_option, expected_title",
+    [
+        (
+            ShowFilepathOption.SHOW_FULL_PATHS.value,
+            lambda path, base_title: f"{base_title} - Library '{path}'",
+        ),
+        (
+            ShowFilepathOption.SHOW_RELATIVE_PATHS.value,
+            lambda path, base_title: f"{base_title} - Library '{path.name}'",
+        ),
+        (
+            ShowFilepathOption.SHOW_FILENAMES_ONLY.value,
+            lambda path, base_title: f"{base_title} - Library '{path.name}'",
+        ),
+    ],
+)
+def test_title_update(qtbot, qt_driver, filepath_option, expected_title):
+    base_title = qt_driver.base_title
+    test_path = pathlib.Path("/dev/null")
+    open_status = LibraryStatus(
+        success=True,
+        library_path=test_path,
+        message="",
+        msg_description="",
+    )
+    # Set the file path option
+    qt_driver.settings.setValue(SettingItems.SHOW_FILEPATH, filepath_option)
+    menu_bar = QMenuBar()
+
+    qt_driver.open_recent_library_menu = QMenu(menu_bar)
+    qt_driver.manage_file_ext_action = QAction(menu_bar)
+    qt_driver.save_library_backup_action = QAction(menu_bar)
+    qt_driver.close_library_action = QAction(menu_bar)
+    qt_driver.refresh_dir_action = QAction(menu_bar)
+    qt_driver.tag_manager_action = QAction(menu_bar)
+    qt_driver.color_manager_action = QAction(menu_bar)
+    qt_driver.new_tag_action = QAction(menu_bar)
+    qt_driver.fix_dupe_files_action = QAction(menu_bar)
+    qt_driver.fix_unlinked_entries_action = QAction(menu_bar)
+    qt_driver.clear_thumb_cache_action = QAction(menu_bar)
+    qt_driver.folders_to_tags_action = QAction(menu_bar)
+
+    # Trigger the update
+    qt_driver.init_library(pathlib.Path(test_path), open_status)
+
+    # Assert the title is updated correctly
+    qt_driver.main_window.setWindowTitle.assert_called_with(expected_title(test_path, base_title))