feat: support case insensitive scoop manifest data

Author: cuinixam

src/py_app_dev/core/scoop_wrapper.py

@@ -5,9 +5,10 @@
 from functools import cmp_to_key
 from pathlib import Path
 from tempfile import TemporaryDirectory
-from typing import Any
+from typing import Any, Optional
 
-from mashumaro import DataClassDictMixin
+from mashumaro import field_options
+from mashumaro.config import BaseConfig
 from mashumaro.mixins.json import DataClassJSONMixin
 
 from .exceptions import UserNotificationException
@@ -53,13 +54,63 @@ def to_int(s: Any) -> int:
     return 0
 
 
+class BaseConfigJSONMixin(DataClassJSONMixin):
+    class Config(BaseConfig):
+        omit_none = True
+        serialize_by_alias = True
+
+    def to_json_string(self) -> str:
+        return json.dumps(self.to_dict(), indent=2)
+
+    def to_json_file(self, file_path: Path) -> None:
+        file_path.write_text(self.to_json_string())
+
+
 @dataclass
-class ScoopFileElement(DataClassDictMixin):
+class ScoopFileElement(BaseConfigJSONMixin):
     """Represents an app or bucket entry in the scoopfile.json."""
 
-    name: str = field(metadata={"alias": "Name"})
-    source: str = field(metadata={"alias": "Source"})
-    version: str | None = field(default=None, metadata={"alias": "Version"})
+    _name_lc: Optional[str] = field(default=None, metadata=field_options(alias="name"))
+    _name_uc: Optional[str] = field(default=None, metadata=field_options(alias="Name"))
+    #: Source bucket
+    _source_lc: Optional[str] = field(default=None, metadata=field_options(alias="source"))
+    _source_uc: Optional[str] = field(default=None, metadata=field_options(alias="Source"))
+
+    _version_lc: Optional[str] = field(default=None, metadata=field_options(alias="version"))
+    _version_uc: Optional[str] = field(default=None, metadata=field_options(alias="Version"))
+
+    @property
+    def name(self) -> str:
+        if self._name_uc:
+            return self._name_uc
+        elif self._name_lc:
+            return self._name_lc
+        else:
+            raise UserNotificationException("ScoopApp must have a 'Name' or 'name' field defined.")
+
+    @property
+    def source(self) -> str:
+        if self._source_uc:
+            return self._source_uc
+        elif self._source_lc:
+            return self._source_lc
+        else:
+            raise UserNotificationException("ScoopApp must have a 'Source' or 'source' field defined.")
+
+    @property
+    def version(self) -> Optional[str]:
+        if self._version_uc:
+            return self._version_uc
+        elif self._version_lc:
+            return self._version_lc
+        else:
+            return None
+
+    def __post_init__(self) -> None:
+        if not self._name_lc and not self._name_uc:
+            raise UserNotificationException("Scoop element must have a 'Name' or 'name' field defined.")
+        if not self._source_lc and not self._source_uc:
+            raise UserNotificationException("Scoop element must have a 'Source' or 'source' field defined.")
 
     def __hash__(self) -> int:
         return hash(f"{self.name}-{self.source}-{self.version}")
@@ -75,7 +126,7 @@ def __eq__(self, other: object) -> bool:
 
 
 @dataclass
-class ScoopInstallConfigFile(DataClassJSONMixin):
+class ScoopInstallConfigFile(BaseConfigJSONMixin):
     """Represents the structure of the scoopfile.json."""
 
     buckets: list[ScoopFileElement]
@@ -94,10 +145,6 @@ def from_file(cls, scoop_file: Path) -> "ScoopInstallConfigFile":
         with open(scoop_file) as f:
             return cls.from_dict(json.load(f))
 
-    def to_file(self, scoop_file: Path) -> None:
-        with open(scoop_file, "w") as f:
-            json.dump(self.to_dict(), f, indent=4)
-
 
 @dataclass
 class InstalledScoopApp:
@@ -269,7 +316,7 @@ def do_install_missing(
         # Create a temporary scoopfile with the remaining apps to install and install them
         with TemporaryDirectory() as tmp_dir:
             tmp_scoop_file = Path(tmp_dir).joinpath("scoopfile.json")
-            ScoopInstallConfigFile(scoop_install_config.buckets, apps_to_install).to_file(tmp_scoop_file)
+            ScoopInstallConfigFile(scoop_install_config.buckets, apps_to_install).to_json_file(tmp_scoop_file)
             self.run_powershell_command(f"{self.scoop_script} import {tmp_scoop_file}")
         return apps_to_install
 

tests/test_scoop_wrapper.py

@@ -31,6 +31,29 @@ def create_scoop_wrapper(scoop_executable: Path | None) -> ScoopWrapper:
     return scoop_wrapper
 
 
+def test_scoop_data_case_insensitive() -> None:
+    scoop_content = {
+        "buckets": [{"Name": "my_bucket", "Source": "https://github.com/my/bucket"}],
+        "apps": [
+            {
+                "Name": "app1",
+                "Source": "my_bucket",
+                "Version": "1.0.0",
+            },
+            {
+                "name": "app2",
+                "source": "my_bucket",
+                "version": "2.0.0",
+            },
+        ],
+    }
+    content = ScoopInstallConfigFile.from_dict(scoop_content)
+    assert content.buckets[0].name == "my_bucket"
+    assert {app.name for app in content.apps} == {"app1", "app2"}
+    # Check serialization back to dict
+    assert json.loads(content.to_json_string()) == scoop_content
+
+
 def test_scoop_installed(tmp_path: Path) -> None:
     scoop_exec = tmp_path / "scoop" / "my_scoop.ps1"
     scoop_exec.parent.mkdir(parents=True)
@@ -203,7 +226,7 @@ def test_scoop_file_parsing(tmp_path: Path) -> None:
     "required_apps, installed_apps, expected_app_versions, expected_exception",
     [
         (
-            [ScoopFileElement(name="app1", source="test", version=None)],
+            [ScoopFileElement.from_dict({"name": "app1", "source": "test", "version": None})],
             [
                 InstalledScoopApp(
                     name="app1",
@@ -226,7 +249,7 @@ def test_scoop_file_parsing(tmp_path: Path) -> None:
             None,
         ),
         (
-            [ScoopFileElement(name="app2", source="test", version="1.0.0")],
+            [ScoopFileElement.from_dict({"name": "app2", "source": "test", "version": "1.0.0"})],
             [
                 InstalledScoopApp(
                     name="app2",
@@ -241,7 +264,7 @@ def test_scoop_file_parsing(tmp_path: Path) -> None:
             None,
         ),
         (
-            [ScoopFileElement(name="app3", source="test", version="1.0.0")],
+            [ScoopFileElement.from_dict({"name": "app3", "source": "test", "version": "1.0.0"})],
             [
                 InstalledScoopApp(
                     name="app3",
@@ -256,7 +279,7 @@ def test_scoop_file_parsing(tmp_path: Path) -> None:
             UserNotificationException,  # version mismatch
         ),
         (
-            [ScoopFileElement(name="app4", source="test", version=None)],
+            [ScoopFileElement.from_dict({"name": "app4", "source": "test", "version": None})],
             [
                 InstalledScoopApp(
                     name="app1",
@@ -289,10 +312,10 @@ def test_map_required_apps_to_installed_apps(
 def test_do_install_missing(scoop_dir: Path) -> None:
     # Create a mock for scoop_install_config
     scoop_install_config = ScoopInstallConfigFile(
-        buckets=[ScoopFileElement(name="bucket1", source="source1")],
+        buckets=[ScoopFileElement.from_dict({"name": "bucket1", "source": "source1"})],
         apps=[
-            ScoopFileElement(name="app1", source="source1"),
-            ScoopFileElement(name="app2", source="source2"),
+            ScoopFileElement.from_dict({"name": "app1", "source": "source1"}),
+            ScoopFileElement.from_dict({"name": "app2", "source": "source2"}),
         ],
     )
 
@@ -354,7 +377,7 @@ def create_installed_list(apps: list[tuple[str, str]]) -> list[InstalledScoopApp
 def create_required_list(
     apps: list[tuple[str, str, str | None]],
 ) -> list[ScoopFileElement]:
-    return [ScoopFileElement(name=name, source=src, version=ver) for name, src, ver in apps]
+    return [ScoopFileElement.from_dict({"name": name, "source": src, "version": ver}) for name, src, ver in apps]
 
 
 @pytest.mark.parametrize(