Merge pull request #69 from homebysix/1.13.0

1.13.0 merge to main

Author: homebysix

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-ast
       - id: check-byte-order-marker
@@ -17,6 +17,6 @@ repos:
       - id: trailing-whitespace
         args: [--markdown-linebreak-ext=md]
   - repo: https://github.com/python/black
-    rev: 22.12.0
+    rev: 23.11.0
     hooks:
       - id: black

CHANGELOG.md

@@ -14,6 +14,13 @@ All notable changes to this project will be documented in this file. This projec
 
 Nothing yet.
 
+## [1.13.0] - 2023-11-18
+
+### Changed
+
+- Now uses `packaging.version.Version` instead of `distutils.version.LooseVersion` for AutoPkg version comparisons. This may cause unexpected behavior if unusual versions are used in `MinimumVersion` keys.
+- Updated `yaml.safe_load()` to `YAML(typ='safe')`.
+
 ## [1.12.4] - 2023-02-26
 
 ### Added
@@ -304,7 +311,8 @@ Nothing yet.
 
 - Initial release
 
-[Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.12.4...HEAD
+[Unreleased]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.13.0...HEAD
+[1.13.0]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.12.4...v1.13.0
 [1.12.4]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.12.3...v1.12.4
 [1.12.3]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.12.2...v1.12.3
 [1.12.2]: https://github.com/homebysix/pre-commit-macadmin/compare/v1.12.1...v1.12.2

README.md

@@ -15,7 +15,7 @@ For any hook in this repo you wish to use, add the following to your pre-commit
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.12.4
+    rev: v1.13.0
     hooks:
     -   id: check-plists
     # -   id: ...
@@ -121,7 +121,7 @@ When combining arguments that take lists (for example: `--required-keys`, `--cat
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.12.4
+    rev: v1.13.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--']
@@ -131,7 +131,7 @@ But if you also use the `--categories` argument, you would move the trailing `--
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.12.4
+    rev: v1.13.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: ['--catalogs', 'testing', 'stable', '--categories', 'Design', 'Engineering', 'Web Browsers', '--']
@@ -143,7 +143,7 @@ If it looks better to your eye, feel free to use a multi-line list for long argu
 
 ```yaml
 -   repo: https://github.com/homebysix/pre-commit-macadmin
-    rev: v1.12.4
+    rev: v1.13.0
     hooks:
     -   id: check-munki-pkgsinfo
         args: [

pre_commit_hooks/check_autopkg_recipes.py

@@ -7,7 +7,7 @@
 import os
 import sys
 from contextlib import contextmanager
-from distutils.version import LooseVersion
+from packaging.version import Version
 
 from pre_commit_hooks.util import (
     load_autopkg_recipe,
@@ -179,17 +179,15 @@ def validate_minimumversion(process, min_vers, ignore_min_vers_before, filename)
     # Warn if using a MinimumVersion greater than or equal to 2
     # warn_on_vers = "2"
     # suggest_vers = "1.4.1"
-    # if LooseVersion(min_vers) >= LooseVersion(warn_on_vers):
+    # if Version(min_vers) >= Version(warn_on_vers):
     #     print(
     #         "{}: WARNING: Choosing MinimumVersion {} limits the potential "
     #         "audience for your AutoPkg recipe. Consider using MinimumVersion "
     #         "{} if your processors support it.".format(filename, min_vers, suggest_vers)
     #     )
 
     # Processors for which a minimum version of AutoPkg is required.
-    # Note: Because LooseVersion considers version 1.0 to be "less than" 1.0.0,
-    # specifying more trailing zeros than needed in the dict below may result
-    # in false positive errors for users of the check-autopkg-recipes hook.
+    # Note: packaging.version.Version considers this True: "1.0" == "1.0.0"
     proc_min_versions = {
         "AppPkgCreator": "1.0",
         "BrewCaskInfoProvider": "0.2.5",
@@ -230,10 +228,10 @@ def validate_minimumversion(process, min_vers, ignore_min_vers_before, filename)
     for proc in [
         x
         for x in proc_min_versions
-        if LooseVersion(proc_min_versions[x]) >= LooseVersion(ignore_min_vers_before)
+        if Version(proc_min_versions[x]) >= Version(ignore_min_vers_before)
     ]:
         if proc in [x.get("Processor") for x in process]:
-            if LooseVersion(min_vers) < LooseVersion(proc_min_versions[proc]):
+            if Version(min_vers) < Version(proc_min_versions[proc]):
                 print(
                     "{}: {} processor requires minimum AutoPkg "
                     "version {}".format(filename, proc, proc_min_versions[proc])
@@ -544,7 +542,6 @@ def main(argv=None):
 
     retval = 0
     for filename in args.filenames:
-
         recipe = load_autopkg_recipe(filename)
         if not recipe:
             retval = 1

pre_commit_hooks/util.py

@@ -6,7 +6,9 @@
 import sys
 from datetime import datetime
 
-from ruamel import yaml
+import ruamel.yaml
+
+yaml = ruamel.yaml.YAML(typ="safe")
 
 # Plist data types and their Python equivalents
 PLIST_TYPES = {
@@ -31,7 +33,7 @@ def load_autopkg_recipe(path):
         try:
             # try to read it as yaml
             with open(path, "rb") as f:
-                recipe = yaml.safe_load(f)
+                recipe = yaml.load(f)
         except Exception as err:
             print("{}: yaml parsing error: {}".format(path, err))
     elif path.endswith(".json"):

setup.py

@@ -7,11 +7,11 @@
     name="pre-commit-macadmin",
     description="Pre-commit hooks for Mac admins, client engineers, and IT consultants.",
     url="https://github.com/homebysix/pre-commit-macadmin",
-    version="1.12.4",
+    version="1.13.0",
     author="Elliot Jordan",
     author_email="elliot@elliotjordan.com",
     packages=["pre_commit_hooks"],
-    install_requires=["ruamel.yaml>=0.15"],
+    install_requires=["ruamel.yaml>=0.15", "packaging>=23.2"],
     entry_points={
         "console_scripts": [
             "check-autopkg-recipe-list = pre_commit_hooks.check_autopkg_recipe_list:main",