gha-utils 4.18.0__tar.gz → 4.18.1__tar.gz

{gha_utils-4.18.0 → gha_utils-4.18.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gha-utils
-Version: 4.18.0
+Version: 4.18.1
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows

{gha_utils-4.18.0 → gha_utils-4.18.1}/gha_utils/__init__.py

@@ -17,4 +17,4 @@
 
 from __future__ import annotations
 
-__version__ = "4.18.0"
+__version__ = "4.18.1"

{gha_utils-4.18.0 → gha_utils-4.18.1}/gha_utils/cli.py

@@ -116,7 +116,7 @@ def gha_utils():
 )
 @option(
     "--format",
-    type=Choice(Dialects, case_sensitive=False),
+    type=Choice(Dialects, case_sensitive=False),  # type: ignore[arg-type]
     default=Dialects.github,
     help="Rendering format of the metadata.",
 )

{gha_utils-4.18.0 → gha_utils-4.18.1}/gha_utils/matrix.py

@@ -48,7 +48,7 @@ class Matrix:
     """
 
     def __init__(self, *args, **kwargs):
-        self.variations: dict = {}
+        self.variations: dict[str, tuple[str, ...]] = {}
 
         # Tuples are used to keep track of the insertion order and force immutability.
         self.include: tuple[dict[str, str], ...] = tuple()
@@ -66,9 +66,9 @@ class Matrix:
         """
         dict_copy = self.variations.copy()
         if not ignore_includes and self.include:
-            dict_copy["include"] = self.include
+            dict_copy["include"] = self.include  # type: ignore[assignment]
         if not ignore_excludes and self.exclude:
-            dict_copy["exclude"] = self.exclude
+            dict_copy["exclude"] = self.exclude  # type: ignore[assignment]
         return FrozenDict(dict_copy)
 
     def __repr__(self) -> str:

{gha_utils-4.18.0 → gha_utils-4.18.1}/gha_utils/metadata.py

@@ -156,6 +156,7 @@ import json
 import logging
 import os
 import re
+import sys
 import tomllib
 from collections.abc import Iterable
 from enum import StrEnum
@@ -166,11 +167,11 @@ from random import randint
 from re import escape
 from typing import Any, Final, cast
 
+import gitignore_parser
 from bumpversion.config import get_configuration  # type: ignore[import-untyped]
 from bumpversion.config.files import find_config_file  # type: ignore[import-untyped]
 from bumpversion.show import resolve_name  # type: ignore[import-untyped]
 from extra_platforms import is_github_ci
-from gitignore_parser import parse_gitignore
 from packaging.specifiers import SpecifierSet
 from packaging.version import Version
 from pydriller import Commit, Git, Repository  # type: ignore[import-untyped]
@@ -349,10 +350,66 @@ MYPY_VERSION_MIN: Final = (3, 8)
 """
 
 
+# XXX Patch gitignore-parser to support Windows paths. Refs:
+# https://github.com/mherrmann/gitignore_parser/issues/60
+# https://github.com/mherrmann/gitignore_parser/pull/61
+# XXX In the future, replace this with wcmatch once it supports gitignore files:
+# https://github.com/facelessuser/wcmatch/issues/226
+
+
+_OriginalIgnoreRule = gitignore_parser.IgnoreRule
+
+
+class PatchedIgnoreRule(_OriginalIgnoreRule):  # type: ignore[misc,valid-type]
+    """Patch version of ``IgnoreRule`` to support Windows paths.
+
+    Taken from: https://github.com/mherrmann/gitignore_parser/pull/61/files
+    """
+
+    @staticmethod
+    def _count_trailing_symbol(symbol: str, text: str) -> int:
+        """Count the number of trailing characters in a string."""
+        count = 0
+        for char in reversed(str(text)):
+            if char == symbol:
+                count += 1
+            else:
+                break
+        return count
+
+    def match(self, abs_path: str | Path) -> bool:
+        matched = False
+        if self.base_path:
+            rel_path = (
+                gitignore_parser._normalize_path(abs_path)
+                .relative_to(self.base_path)
+                .as_posix()
+            )
+        else:
+            rel_path = gitignore_parser._normalize_path(abs_path).as_posix()
+        # Path() strips the trailing following symbols on windows, so we need to
+        # preserve it: ' ', '.'
+        if sys.platform.startswith("win"):
+            rel_path += " " * self._count_trailing_symbol(" ", abs_path)
+            rel_path += "." * self._count_trailing_symbol(".", abs_path)
+        # Path() strips the trailing slash, so we need to preserve it
+        # in case of directory-only negation
+        if self.negation and type(abs_path) is str and abs_path[-1] == "/":
+            rel_path += "/"
+        if rel_path.startswith("./"):
+            rel_path = rel_path[2:]
+        if re.search(self.regex, rel_path):
+            matched = True
+        return matched
+
+
+gitignore_parser.IgnoreRule = PatchedIgnoreRule
+
+
 class JSONMetadata(json.JSONEncoder):
     """Custom JSON encoder for metadata serialization."""
 
-    def default(self, o: Any) -> str:
+    def default(self, o: Any) -> Any:
         if isinstance(o, Matrix):
             return o.matrix()
 
@@ -592,11 +649,15 @@ class Metadata:
         events.
 
         .. seealso::
-
             - https://stackoverflow.com/a/67204539
             - https://stackoverflow.com/a/62953566
             - https://stackoverflow.com/a/61861763
 
+        .. seealso::
+            Pull request events on GitHub are a bit complex, see: `The Many SHAs of a
+            GitHub Pull Request
+            <https://www.kenmuse.com/blog/the-many-shas-of-a-github-pull-request/>`_.
+
         .. todo::
             Refactor so we can get rid of ``self.github_context``. Maybe there's enough
             metadata lying around in the environment variables that we can inspect the
@@ -657,11 +718,7 @@ class Metadata:
     @cached_property
     def new_commits_hash(self) -> tuple[str, ...] | None:
         """List all hashes of new commits."""
-        return (
-            cast(tuple[str, ...], self.new_commits_matrix["commit"])
-            if self.new_commits_matrix
-            else None
-        )
+        return self.new_commits_matrix["commit"] if self.new_commits_matrix else None
 
     @cached_property
     def release_commits(self) -> tuple[Commit, ...] | None:
@@ -695,7 +752,7 @@ class Metadata:
     def release_commits_hash(self) -> tuple[str, ...] | None:
         """List all hashes of release commits."""
         return (
-            cast(tuple[str, ...], self.release_commits_matrix["commit"])
+            self.release_commits_matrix["commit"]
             if self.release_commits_matrix
             else None
         )
@@ -737,7 +794,7 @@ class Metadata:
         gitignore = None
         if self.gitignore_exists:
             logging.debug(f"Load {GITIGNORE_PATH} to filter out ignored files.")
-            gitignore = parse_gitignore(GITIGNORE_PATH)
+            gitignore = gitignore_parser.parse_gitignore(GITIGNORE_PATH)
 
         for file_path in iglob(
             patterns,

{gha_utils-4.18.0 → gha_utils-4.18.1}/gha_utils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gha-utils
-Version: 4.18.0
+Version: 4.18.1
 Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
 Author-email: Kevin Deldycke <kevin@deldycke.com>
 Project-URL: Homepage, https://github.com/kdeldycke/workflows

{gha_utils-4.18.0 → gha_utils-4.18.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 # Docs: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/
 name = "gha-utils"
-version = "4.18.0"
+version = "4.18.1"
 # Python versions and their status: https://devguide.python.org/versions/
 requires-python = ">= 3.11"
 description = "⚙️ CLI helpers for GitHub Actions + reuseable workflows"
@@ -120,7 +120,7 @@ pretty = true
 
 [[tool.mypy.overrides]]
 ignore_missing_imports = true
-module = ["boltons.*"]
+module = ["boltons.*", "gitignore_parser.*"]
 
 [tool.pytest.ini_options]
 # https://docs.pytest.org/en/latest/customize.html#pyproject-toml
@@ -138,7 +138,7 @@ addopts = [
 xfail_strict = true
 
 [tool.bumpversion]
-current_version = "4.18.0"
+current_version = "4.18.1"
 allow_dirty = true
 ignore_missing_files = true
 

{gha_utils-4.18.0 → gha_utils-4.18.1}/tests/test_metadata.py

@@ -58,27 +58,31 @@ def regex(pattern: str) -> re.Pattern:
     return re.compile(pattern, re.DOTALL)
 
 
-def iter_checks(metadata: Any, expected: Any) -> None:
+def iter_checks(metadata: Any, expected: Any, context: Any) -> None:
     """Recursively iterate over expected content and check it matches in metadata."""
 
     if isinstance(expected, re.Pattern):
         assert isinstance(metadata, str)
-        assert re.fullmatch(expected, metadata) is not None
+        assert re.fullmatch(expected, metadata) is not None, (
+            f"{metadata!r} does not match {expected.pattern!r} in {context!r}"
+        )
 
     elif isinstance(expected, dict):
         assert isinstance(metadata, dict)
         assert set(metadata) == set(expected)
         for key, value in expected.items():
-            iter_checks(metadata[key], value)
+            iter_checks(metadata[key], value, metadata)
 
     elif isinstance(expected, list):
         assert isinstance(metadata, list)
         assert len(metadata) == len(expected)
         for item in expected:
-            iter_checks(metadata[expected.index(item)], item)
+            iter_checks(metadata[expected.index(item)], item, metadata)
 
     else:
-        assert metadata == expected
+        assert metadata == expected, (
+            f"{metadata!r} does not match {expected!r} in {context!r}"
+        )
         assert type(metadata) is type(expected)
 
 
@@ -203,7 +207,7 @@ expected = {
                 "cli_id": "gha-utils",
                 "module_id": "gha_utils.__main__",
                 "callable_id": "main",
-                "module_path": regex(r"gha_utils(/|\\\\)__main__\.py"),
+                "module_path": regex(r"gha_utils(/|\\)__main__\.py"),
             },
             {
                 "commit": regex(r"[a-z0-9]+"),
@@ -256,7 +260,7 @@ def test_metadata_json_format():
     metadata = Metadata().dump(Dialects.json)
     assert isinstance(metadata, str)
 
-    iter_checks(json.loads(metadata), expected)
+    iter_checks(json.loads(metadata), expected, metadata)
 
 
 def test_metadata_github_format():
@@ -326,4 +330,4 @@ def test_metadata_github_format():
             new_value = " ".join(f'"{i}"' for i in value)
         github_format_expected[key] = new_value
 
-    iter_checks(metadata, github_format_expected)
+    iter_checks(metadata, github_format_expected, raw_metadata)