Merge branch 'Alpha-v9.5.3'

tests/fixtures/sample.svg

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<svg width="100%" height="100%" viewBox="0 0 739 739" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
-    <path d="M392.721,715.585C422.869,745.733 471.822,745.733 501.97,715.585C521.252,696.304 698.205,519.351 715.585,501.97C745.733,471.822 745.733,422.869 715.585,392.721C702.356,379.491 380.066,58.201 366.836,44.972C353.638,31.774 336.836,24.354 319.586,22.707C305.002,21.315 93.263,0.703 81.113,0.097C60.067,-0.954 38.675,6.558 22.616,22.616C7.307,37.926 -0.233,58.083 0.005,78.166C0.158,90.957 21.834,301.853 22.429,315.577C23.238,334.217 30.753,352.617 44.972,366.836C64.714,386.578 372.979,695.844 392.721,715.585ZM221.206,462.624C199.538,440.957 109.62,350.947 109.62,350.947C95.375,336.702 95.375,315.292 109.62,301.047L301.047,109.62C315.292,95.375 336.702,95.375 350.947,109.62C350.947,109.62 557.592,316.079 616.139,374.813C679.714,438.589 568.691,438.77 585.773,495.797C588.986,506.52 600.846,531.699 594.432,548.233C579.351,587.118 529.349,575.43 521.799,548.233C515.39,525.148 528.92,514.925 524.759,499.813C517.88,474.829 491.657,481.134 483.903,499.813C458.989,559.836 503.029,591.37 493.423,628.195C479.788,680.463 410.137,673.342 400.675,628.195C392.608,589.708 425.265,574.286 421.93,520.583C419.956,488.804 394.552,464.882 377.567,488.023C360.792,510.879 402.256,542.428 373.64,575.065C341.566,611.644 283.344,579.898 301.047,528.499C311.597,497.869 326.263,466.649 311.901,462.624C282.374,454.351 267.942,509.361 221.206,462.624ZM180.995,84.554C205.968,109.528 205.968,150.079 180.995,175.052C156.022,200.026 115.471,200.026 90.497,175.052C65.524,150.079 65.524,109.528 90.497,84.554C115.471,59.581 156.022,59.581 180.995,84.554Z"/>
-    <g transform="matrix(0.986683,0,0,0.986683,-136.081,-136.081)">
-        <path d="M733.962,560.164C740.987,553.139 740.987,541.733 733.962,534.708L482.173,282.92C475.148,275.895 463.742,275.895 456.717,282.92L431.261,308.376C424.237,315.4 424.237,326.807 431.261,333.831L683.05,585.62C690.075,592.645 701.481,592.645 708.506,585.62L733.962,560.164ZM439.639,559.207C446.664,552.182 446.664,540.776 439.639,533.751L335.491,429.602C328.466,422.578 317.059,422.578 310.035,429.602L284.579,455.058C277.554,462.083 277.554,473.489 284.579,480.514L388.728,584.663C395.752,591.688 407.159,591.688 414.184,584.663L439.639,559.207ZM584.306,556.624C591.331,549.599 591.331,538.192 584.306,531.168L409.115,355.977C402.091,348.953 390.684,348.953 383.66,355.977L358.204,381.433C351.179,388.458 351.179,399.864 358.204,406.889L533.394,582.079C540.419,589.104 551.825,589.104 558.85,582.079L584.306,556.624ZM298.425,246.543C311.081,259.198 311.081,279.747 298.425,292.402C285.77,305.058 265.221,305.058 252.566,292.402C239.911,279.747 239.911,259.198 252.566,246.543C265.221,233.888 285.77,233.888 298.425,246.543Z"/>
-    </g>
-</svg>

tests/macros/test_missing_files.py

@@ -3,7 +3,7 @@ from tempfile import TemporaryDirectory
 
 import pytest
 
-from tagstudio.core.library.alchemy.enums import FilterState
+from tagstudio.core.library.alchemy.enums import BrowsingState
 from tagstudio.core.library.alchemy.library import Library
 from tagstudio.core.utils.missing_files import MissingRegistry
 
@@ -28,5 +28,5 @@ def test_refresh_missing_files(library: Library):
     assert list(registry.fix_unlinked_entries()) == [0, 1]
 
     # `bar.md` should be relinked to new correct path
-    results = library.search_library(FilterState.from_path("bar.md", page_size=500))
+    results = library.search_library(BrowsingState.from_path("bar.md"), page_size=500)
     assert results[0].path == Path("bar.md")

tests/qt/test_file_path_options.py

@@ -79,11 +79,11 @@ def test_file_path_display(
     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>"
+            file_str += f"{'\u200b'.join(part_)}{separator}</b>"
         else:
             if file_str != "":
                 file_str += "<br>"
-            file_str += f"<b>{"\u200b".join(part_)}</b>"
+            file_str += f"<b>{'\u200b'.join(part_)}</b>"
 
     # Assert the file path is displayed correctly
     assert panel.file_attrs.file_label.text() == file_str
@@ -135,7 +135,7 @@ def test_title_update(
     qt_driver.folders_to_tags_action = QAction(menu_bar)
 
     # Trigger the update
-    qt_driver.init_library(library_dir, open_status)
+    qt_driver._init_library(library_dir, open_status)
 
     # Assert the title is updated correctly
     qt_driver.main_window.setWindowTitle.assert_called_with(expected_title(library_dir, base_title))

tests/qt/test_global_settings.py

@@ -5,7 +5,7 @@ from tagstudio.core.global_settings import GlobalSettings, Theme
 
 def test_read_settings(library_dir: Path):
     settings_path = library_dir / "settings.toml"
-    with open(settings_path, "a") as settings_file:
+    with open(settings_path, "w") as settings_file:
         settings_file.write("""
             language = "de"
             open_last_loaded_on_startup = true
@@ -14,6 +14,9 @@ def test_read_settings(library_dir: Path):
             page_size = 1337
             show_filepath = 0
             dark_mode = 2
+            date_format = "%x"
+            hour_format = true
+            zero_padding = true
         """)
 
     settings = GlobalSettings.read_settings(settings_path)
@@ -24,3 +27,6 @@ def test_read_settings(library_dir: Path):
     assert settings.page_size == 1337
     assert settings.show_filepath == 0
     assert settings.theme == Theme.SYSTEM
+    assert settings.date_format == "%x"
+    assert settings.hour_format
+    assert settings.zero_padding

tests/qt/test_qt_driver.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING
 
-from tagstudio.core.library.alchemy.enums import FilterState
+from tagstudio.core.library.alchemy.enums import BrowsingState
 from tagstudio.core.library.json.library import ItemType
 from tagstudio.qt.widgets.item_thumb import ItemThumb
 
@@ -66,7 +66,7 @@ if TYPE_CHECKING:
 #     assert qt_driver.selected == [0, 1, 2]
 
 
-def test_library_state_update(qt_driver: "QtDriver"):
+def test_browsing_state_update(qt_driver: "QtDriver"):
     # Given
     for entry in qt_driver.lib.get_entries(with_joins=True):
         thumb = ItemThumb(ItemType.ENTRY, qt_driver.lib, qt_driver, (100, 100))
@@ -74,27 +74,25 @@ def test_library_state_update(qt_driver: "QtDriver"):
         qt_driver.frame_content.append(entry)
 
     # no filter, both items are returned
-    qt_driver.filter_items()
+    qt_driver.update_browsing_state()
     assert len(qt_driver.frame_content) == 2
 
     # filter by tag
-    state = FilterState.from_tag_name("foo", page_size=10)
-    qt_driver.filter_items(state)
-    assert qt_driver.filter.page_size == 10
+    state = BrowsingState.from_tag_name("foo")
+    qt_driver.update_browsing_state(state)
     assert len(qt_driver.frame_content) == 1
     entry = qt_driver.lib.get_entry_full(qt_driver.frame_content[0])
     assert list(entry.tags)[0].name == "foo"
 
     # When state is not changed, previous one is still applied
-    qt_driver.filter_items()
-    assert qt_driver.filter.page_size == 10
+    qt_driver.update_browsing_state()
     assert len(qt_driver.frame_content) == 1
     entry = qt_driver.lib.get_entry_full(qt_driver.frame_content[0])
     assert list(entry.tags)[0].name == "foo"
 
     # When state property is changed, previous one is overwritten
-    state = FilterState.from_path("*bar.md", page_size=qt_driver.settings.page_size)
-    qt_driver.filter_items(state)
+    state = BrowsingState.from_path("*bar.md")
+    qt_driver.update_browsing_state(state)
     assert len(qt_driver.frame_content) == 1
     entry = qt_driver.lib.get_entry_full(qt_driver.frame_content[0])
     assert list(entry.tags)[0].name == "bar"

tests/qt/test_thumb_renderer.py

@@ -1,49 +0,0 @@
-# Copyright (C) 2024 Travis Abendshien (CyanVoxel).
-# Licensed under the GPL-3.0 License.
-# Created for TagStudio: https://github.com/CyanVoxel/TagStudio
-
-import io
-from functools import partial
-from pathlib import Path
-
-import pytest
-from PIL import Image
-from syrupy.extensions.image import PNGImageSnapshotExtension
-
-from tagstudio.qt.widgets.thumb_renderer import ThumbRenderer
-
-
-@pytest.mark.parametrize(
-    ["fixture_file", "thumbnailer"],
-    [
-        (
-            "sample.odt",
-            ThumbRenderer._open_doc_thumb,
-        ),
-        (
-            "sample.ods",
-            ThumbRenderer._open_doc_thumb,
-        ),
-        (
-            "sample.epub",
-            ThumbRenderer._epub_cover,
-        ),
-        (
-            "sample.pdf",
-            partial(ThumbRenderer._pdf_thumb, size=200),
-        ),
-        (
-            "sample.svg",
-            partial(ThumbRenderer._image_vector_thumb, size=200),
-        ),
-    ],
-)
-def test_preview_render(cwd, fixture_file, thumbnailer, snapshot):
-    file_path: Path = cwd / "fixtures" / fixture_file
-    img: Image.Image = thumbnailer(file_path)
-
-    img_bytes = io.BytesIO()
-    img.save(img_bytes, format="PNG")
-    img_bytes.seek(0)
-
-    assert img_bytes.read() == snapshot(extension_class=PNGImageSnapshotExtension)

tests/test_library.py

@@ -4,7 +4,7 @@ from tempfile import TemporaryDirectory
 import pytest
 
 from tagstudio.core.enums import DefaultEnum, LibraryPrefs
-from tagstudio.core.library.alchemy.enums import FilterState
+from tagstudio.core.library.alchemy.enums import BrowsingState
 from tagstudio.core.library.alchemy.fields import TextField, _FieldID
 from tagstudio.core.library.alchemy.library import Library
 from tagstudio.core.library.alchemy.models import Entry, Tag
@@ -123,7 +123,8 @@ def test_library_search(library: Library, generate_tag, entry_full):
     tag = list(entry_full.tags)[0]
 
     results = library.search_library(
-        FilterState.from_tag_name(tag.name, page_size=500),
+        BrowsingState.from_tag_name(tag.name),
+        page_size=500,
     )
 
     assert results.total_count == 1
@@ -152,7 +153,7 @@ def test_entries_count(library: Library):
     new_ids = library.add_entries(entries)
     assert len(new_ids) == 10
 
-    results = library.search_library(FilterState.show_all(page_size=5))
+    results = library.search_library(BrowsingState.show_all(), page_size=5)
 
     assert results.total_count == 12
     assert len(results) == 5
@@ -199,9 +200,7 @@ def test_search_filter_extensions(library: Library, is_exclude: bool):
     library.set_prefs(LibraryPrefs.EXTENSION_LIST, ["md"])
 
     # When
-    results = library.search_library(
-        FilterState.show_all(page_size=500),
-    )
+    results = library.search_library(BrowsingState.show_all(), page_size=500)
 
     # Then
     assert results.total_count == 1
@@ -221,7 +220,8 @@ def test_search_library_case_insensitive(library: Library):
 
     # When
     results = library.search_library(
-        FilterState.from_tag_name(tag.name.upper(), page_size=500),
+        BrowsingState.from_tag_name(tag.name.upper()),
+        page_size=500,
     )
 
     # Then
@@ -443,100 +443,102 @@ def test_library_prefs_multiple_identical_vals():
 
 
 def test_path_search_ilike(library: Library):
-    results = library.search_library(FilterState.from_path("bar.md", page_size=500))
+    results = library.search_library(BrowsingState.from_path("bar.md"), page_size=500)
     assert results.total_count == 1
     assert len(results.items) == 1
 
 
 def test_path_search_like(library: Library):
-    results = library.search_library(FilterState.from_path("BAR.MD", page_size=500))
+    results = library.search_library(BrowsingState.from_path("BAR.MD"), page_size=500)
     assert results.total_count == 0
     assert len(results.items) == 0
 
 
 def test_path_search_default_with_sep(library: Library):
-    results = library.search_library(FilterState.from_path("one/two", page_size=500))
+    results = library.search_library(BrowsingState.from_path("one/two"), page_size=500)
     assert results.total_count == 1
     assert len(results.items) == 1
 
 
 def test_path_search_glob_after(library: Library):
-    results = library.search_library(FilterState.from_path("foo*", page_size=500))
+    results = library.search_library(BrowsingState.from_path("foo*"), page_size=500)
     assert results.total_count == 1
     assert len(results.items) == 1
 
 
 def test_path_search_glob_in_front(library: Library):
-    results = library.search_library(FilterState.from_path("*bar.md", page_size=500))
+    results = library.search_library(BrowsingState.from_path("*bar.md"), page_size=500)
     assert results.total_count == 1
     assert len(results.items) == 1
 
 
 def test_path_search_glob_both_sides(library: Library):
-    results = library.search_library(FilterState.from_path("*one/two*", page_size=500))
+    results = library.search_library(BrowsingState.from_path("*one/two*"), page_size=500)
     assert results.total_count == 1
     assert len(results.items) == 1
 
 
+# TODO: deduplicate this code with pytest parametrisation or a for loop
 def test_path_search_ilike_glob_equality(library: Library):
-    results_ilike = library.search_library(FilterState.from_path("one/two", page_size=500))
-    results_glob = library.search_library(FilterState.from_path("*one/two*", page_size=500))
+    results_ilike = library.search_library(BrowsingState.from_path("one/two"), page_size=500)
+    results_glob = library.search_library(BrowsingState.from_path("*one/two*"), page_size=500)
     assert [e.id for e in results_ilike.items] == [e.id for e in results_glob.items]
     results_ilike, results_glob = None, None
 
-    results_ilike = library.search_library(FilterState.from_path("bar.md", page_size=500))
-    results_glob = library.search_library(FilterState.from_path("*bar.md*", page_size=500))
+    results_ilike = library.search_library(BrowsingState.from_path("bar.md"), page_size=500)
+    results_glob = library.search_library(BrowsingState.from_path("*bar.md*"), page_size=500)
     assert [e.id for e in results_ilike.items] == [e.id for e in results_glob.items]
     results_ilike, results_glob = None, None
 
-    results_ilike = library.search_library(FilterState.from_path("bar", page_size=500))
-    results_glob = library.search_library(FilterState.from_path("*bar*", page_size=500))
+    results_ilike = library.search_library(BrowsingState.from_path("bar"), page_size=500)
+    results_glob = library.search_library(BrowsingState.from_path("*bar*"), page_size=500)
     assert [e.id for e in results_ilike.items] == [e.id for e in results_glob.items]
     results_ilike, results_glob = None, None
 
-    results_ilike = library.search_library(FilterState.from_path("bar.md", page_size=500))
-    results_glob = library.search_library(FilterState.from_path("*bar.md*", page_size=500))
+    results_ilike = library.search_library(BrowsingState.from_path("bar.md"), page_size=500)
+    results_glob = library.search_library(BrowsingState.from_path("*bar.md*"), page_size=500)
     assert [e.id for e in results_ilike.items] == [e.id for e in results_glob.items]
     results_ilike, results_glob = None, None
 
 
+# TODO: isn't this the exact same as the one before?
 def test_path_search_like_glob_equality(library: Library):
-    results_ilike = library.search_library(FilterState.from_path("ONE/two", page_size=500))
-    results_glob = library.search_library(FilterState.from_path("*ONE/two*", page_size=500))
+    results_ilike = library.search_library(BrowsingState.from_path("ONE/two"), page_size=500)
+    results_glob = library.search_library(BrowsingState.from_path("*ONE/two*"), page_size=500)
     assert [e.id for e in results_ilike.items] == [e.id for e in results_glob.items]
     results_ilike, results_glob = None, None
 
-    results_ilike = library.search_library(FilterState.from_path("BAR.MD", page_size=500))
-    results_glob = library.search_library(FilterState.from_path("*BAR.MD*", page_size=500))
+    results_ilike = library.search_library(BrowsingState.from_path("BAR.MD"), page_size=500)
+    results_glob = library.search_library(BrowsingState.from_path("*BAR.MD*"), page_size=500)
     assert [e.id for e in results_ilike.items] == [e.id for e in results_glob.items]
     results_ilike, results_glob = None, None
 
-    results_ilike = library.search_library(FilterState.from_path("BAR.MD", page_size=500))
-    results_glob = library.search_library(FilterState.from_path("*bar.md*", page_size=500))
+    results_ilike = library.search_library(BrowsingState.from_path("BAR.MD"), page_size=500)
+    results_glob = library.search_library(BrowsingState.from_path("*bar.md*"), page_size=500)
     assert [e.id for e in results_ilike.items] != [e.id for e in results_glob.items]
     results_ilike, results_glob = None, None
 
-    results_ilike = library.search_library(FilterState.from_path("bar.md", page_size=500))
-    results_glob = library.search_library(FilterState.from_path("*BAR.MD*", page_size=500))
+    results_ilike = library.search_library(BrowsingState.from_path("bar.md"), page_size=500)
+    results_glob = library.search_library(BrowsingState.from_path("*BAR.MD*"), page_size=500)
     assert [e.id for e in results_ilike.items] != [e.id for e in results_glob.items]
     results_ilike, results_glob = None, None
 
 
 @pytest.mark.parametrize(["filetype", "num_of_filetype"], [("md", 1), ("txt", 1), ("png", 0)])
 def test_filetype_search(library: Library, filetype, num_of_filetype):
-    results = library.search_library(FilterState.from_filetype(filetype, page_size=500))
+    results = library.search_library(BrowsingState.from_filetype(filetype), page_size=500)
     assert len(results.items) == num_of_filetype
 
 
 @pytest.mark.parametrize(["filetype", "num_of_filetype"], [("png", 2), ("apng", 1), ("ng", 0)])
 def test_filetype_return_one_filetype(file_mediatypes_library: Library, filetype, num_of_filetype):
     results = file_mediatypes_library.search_library(
-        FilterState.from_filetype(filetype, page_size=500)
+        BrowsingState.from_filetype(filetype), page_size=500
     )
     assert len(results.items) == num_of_filetype
 
 
 @pytest.mark.parametrize(["mediatype", "num_of_mediatype"], [("plaintext", 2), ("image", 0)])
 def test_mediatype_search(library: Library, mediatype, num_of_mediatype):
-    results = library.search_library(FilterState.from_mediatype(mediatype, page_size=500))
+    results = library.search_library(BrowsingState.from_mediatype(mediatype), page_size=500)
     assert len(results.items) == num_of_mediatype

tests/test_search.py

@@ -1,12 +1,12 @@
 import pytest
 
-from tagstudio.core.library.alchemy.enums import FilterState
+from tagstudio.core.library.alchemy.enums import BrowsingState
 from tagstudio.core.library.alchemy.library import Library
 from tagstudio.core.query_lang.util import ParsingError
 
 
 def verify_count(lib: Library, query: str, count: int):
-    results = lib.search_library(FilterState.from_search_query(query, page_size=500))
+    results = lib.search_library(BrowsingState.from_search_query(query), page_size=500)
     assert results.total_count == count
     assert len(results.items) == count
 
@@ -136,4 +136,4 @@ def test_parent_tags(search_library: Library, query: str, count: int):
 )
 def test_syntax(search_library: Library, invalid_query: str):
     with pytest.raises(ParsingError) as e_info:  # noqa: F841
-        search_library.search_library(FilterState.from_search_query(invalid_query, page_size=500))
+        search_library.search_library(BrowsingState.from_search_query(invalid_query), page_size=500)