bugfixings

Author: tobixen

.pre-commit-config.yaml

@@ -9,13 +9,3 @@ repos:
     # Run the formatter.
     - id: ruff-format
 
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v6.0.0
-    hooks:
-      - id: trailing-whitespace
-      - id: end-of-file-fixer
-      - id: check-yaml
-      - id: check-toml
-      - id: check-ast
-      - id: mixed-line-ending
-        args: [--fix=lf]

README.md

@@ -22,6 +22,8 @@ In the early versions, the filter method will take the calendar contents one by
 
 ## License
 
-As for now I'm releasing this under the GNU Affero General Public License v.3.0.  If you find this too restrictive or if this causes license compatibility issues for you, please get in touch with me and I will consider to fix some dual licensing, like it's done with the python CalDAV library.
+As for now I'm releasing this under the GNU Affero General Public License v.3.0.  If you find this too restrictive or if this causes license compatibility issues for you, I will consider to fix some dual licensing, like it's done with the python CalDAV library.
 
-Any contributor has to accept that the code is released under AGPL v3.0 and at some point in the future may be dual-licensed under some more permissive license, like the EUPL v1.1.
+This also menas that any contributor has to accept that the code is released under AGPL v3.0 and at some point in the future may be dual-licensed under some more permissive license, like the EUPL v1.1.
+
+I don't have very strong opinions on licenses.  If you have any issues in one way or another, please reach out.

pyproject.toml

@@ -19,17 +19,11 @@ requires-python = ">=3.10,<4.0"
 dependencies = [
     "icalendar>=6.0.0",
 ]
-
-[tool.poetry]
 packages = [{include = "icalendar_searcher", from = "src"}]
 
 [tool.poetry-dynamic-versioning]
 enable = true
 
-[tool.poetry.dependencies]
-poetry-dynamic-versioning = { version = ">=1.0.0,<2.0.0", extras = ["plugin"] }
-icalendar = {}
-
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0", "poetry-dynamic-versioning>=1.0.0,<2.0.0"]
 build-backend = "poetry_dynamic_versioning.backend"

src/icalendar_searcher/__init__.py

@@ -1,17 +1,13 @@
-from dataclasses import dataclass
-from dataclasses import field
+from dataclasses import dataclass, field
 from datetime import datetime
-from typing import Any
-from typing import List
-from typing import TYPE_CHECKING
-from typing import Union
+from typing import TYPE_CHECKING, Any, Union
 
+from icalendar import Timezone
 from icalendar.prop import TypesFactory
 
 if TYPE_CHECKING:
-    from icalendar import Calendar
-    from icalendar import Component
     from caldav.calendarobjectresource import CalendarObjectResource
+    from icalendar import Calendar, Component
 
 types_factory = TypesFactory()
 
@@ -40,9 +36,9 @@ class Searcher:
     of them has to match)
 
     Properties (like SUMMARY, CATEGORIES, etc) are not meant to be
-    sent through the constructor, use the ``add_property_filter``
+    sent through the constructor, use the :func:`icalendar_searcher.Searcher.add_property_filter`
     method.  Same goes with sort keys, they can be added through the
-    ``add_sort_key`` method.
+    `func:icalendar_searcher.Searcher.add_sort_key` method.
 
     The ``todo``, ``event`` and ``journal`` parameters are booleans
     for filtering the component type.  If i.e. both todo and
@@ -118,9 +114,7 @@ class Searcher:
     _property_filters: dict = field(default_factory=dict)
     _property_operator: dict = field(default_factory=dict)
 
-    def add_property_filter(
-        self, key: str, value: Any, operator: str = "contains"
-    ) -> None:
+    def add_property_filter(self, key: str, value: Any, operator: str = "contains") -> None:
         """Adds a filter for some specific iCalendar property.
 
         Examples of valid iCalendar properties: SUMMARY,
@@ -182,8 +176,8 @@ def check_component(
         raise NotImplementedError()
 
     def filter(
-        self, components: List[Union["Calendar", "CalendarObjectResource"]]
-    ) -> List[Union["Calendar", "CalendarObjectResource"]]:
+        self, components: list[Union["Calendar", "CalendarObjectResource"]]
+    ) -> list[Union["Calendar", "CalendarObjectResource"]]:
         """
         Filters the components given according to the search
         criterias, and possibly expanding recurrences.
@@ -194,8 +188,8 @@ def filter(
         raise NotImplementedError()
 
     def sort(
-        self, components: List[Union["Calendar", "CalendarObjectResource"]]
-    ) -> List[Union["Calendar", "CalendarObjectResource"]]:
+        self, components: list[Union["Calendar", "CalendarObjectResource"]]
+    ) -> list[Union["Calendar", "CalendarObjectResource"]]:
         """
         Sorts the components given according to the sort
         keys.
@@ -209,4 +203,66 @@ def sort_key(self, component: Union["Calendar", "CalendarObjectResource"]) -> tu
         """
         Returns a sortable value from the component, based on the sort keys
         """
-        raise NotImplementedError()
+        ret = []
+        ## TODO: we disregard any complexity wrg of recurring events
+
+        icalendar_instance = component
+
+        not_tz_components = (
+            x for x in icalendar_instance.subcomponents if not isinstance(x, Timezone)
+        )
+        comp = next(not_tz_components)
+
+        defaults = {
+            ## TODO: all possible non-string sort attributes needs to be listed here, otherwise we will get type errors when comparing objects with the property defined vs undefined (or maybe we should make an "undefined" object that always will compare below any other type?  Perhaps there exists such an object already?)
+            "due": "2050-01-01",
+            "dtstart": "1970-01-01",
+            "priority": 0,
+            "status": {
+                "VTODO": "NEEDS-ACTION",
+                "VJOURNAL": "FINAL",
+                "VEVENT": "TENTATIVE",
+            }[comp.name],
+            "category": "",
+            ## Usage of strftime is a simple way to ensure there won't be
+            ## problems if comparing dates with timestamps
+            "isnt_overdue": not (
+                "due" in comp
+                and comp["due"].dt.strftime("%F%H%M%S") < datetime.now().strftime("%F%H%M%S")
+            ),
+            "hasnt_started": (
+                "dtstart" in comp
+                and comp["dtstart"].dt.strftime("%F%H%M%S") > datetime.now().strftime("%F%H%M%S")
+            ),
+        }
+        for sort_key, reverse in self._sort_keys:
+            val = comp.get(sort_key, None)
+            if val is None:
+                ret.append(defaults.get(sort_key.lower(), ""))
+                continue
+            if hasattr(val, "dt"):
+                val = val.dt
+            elif hasattr(val, "cats"):
+                val = ",".join(val.cats)
+            if hasattr(val, "strftime"):
+                val = val.strftime("%F%H%M%S")
+            if reverse:
+                if isinstance(val, str):
+                    val = val.encode()
+                    val = bytes(b ^ 0xFF for b in val)
+                else:
+                    val = -val
+            ret.append(val)
+
+        return ret
+
+    def _unrwap(self, component: Union["Calendar", "CalendarObjectResource"]) -> "Calendar":
+        """
+        To support the caldav library (and possibly other libraries where the
+        icalendar component is wrapped)
+        """
+        try:
+            component = component.icalendar_instance
+        except AttributeError:
+            pass
+        return component