RepoAuditor 0.2.41__tar.gz → 0.2.42__tar.gz

{repoauditor-0.2.41 → repoauditor-0.2.42}/.github/workflows/CICD.yml

@@ -26,7 +26,7 @@ jobs:
     with:
       # These values can be customized for your specific requirements.
       operating_system_json_string: "[ 'macos-latest', 'ubuntu-latest', 'windows-latest' ]"
-      python_version_json_string: "['3.13']" # Reduce the number of python versions supported so that we don't get rate limited by GitHub; was: "['3.13', '3.12', '3.11', '3.10']"
+      python_version_json_string: "['3.13', '3.12', '3.11', '3.10']"
       python_package_version: "3.13"
       coverage_badge_gist_id: "2f9d770d13e3a148424f374f74d41f4b"
       coverage_badge_gist_username: "davidbrownell"

{repoauditor-0.2.41 → repoauditor-0.2.42}/DEVELOPMENT.md

@@ -4,17 +4,17 @@
 | --- | --- | --- |
 | 1. Fork the repository | -- | https://github.com/gt-sse-center/RepoAuditor/fork |
 | 2. Create a PAT for your forked repository | -- | See [PAT setup instructions](README.md#personal-access-token-pat) |
-| 3. Sync the `test-GitHubCustomization` branch | see instructions below | In the web interface, select "New Branch", then choose `gt-sse-center/RepoAuditor` and `test-GitHubCustomization` as source, and enter `test-GitHubCustomization` as branch name. |
+| 3. Sync the `test-GitHubCommunityStandards` branch | see instructions below | In the web interface, select "New Branch", then choose `gt-sse-center/RepoAuditor` and `test-GitHubCommunityStandards` as source, and enter `test-GitHubCommunityStandards` as branch name. |
 | 4. Update your forked repository settings to match RepoAuditor's defaults | -- | 
 
 
-To sync the `test-GitHubCustomization` branch using the command line:
+To sync the `test-GitHubCommunityStandards` branch using the command line:
 ```bash
 git clone <REPOAUDITOR_FORK_URL>
 git remote add upstream https://github.com/gt-sse-center/RepoAuditor
 git fetch upstream
-git checkout -b test-GitHubCustomization upstream/test-GitHubCustomization
-git push origin test-GitHubCustomization
+git checkout -b test-GitHubCommunityStandards upstream/test-GitHubCommunityStandards
+git push origin test-GitHubCommunityStandards
 ```
 
 # Local Development

{repoauditor-0.2.41 → repoauditor-0.2.42}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.2.41
+Version: 0.2.42
 Summary: Add your description here
 Project-URL: Homepage, https://github.com/gt-sse-center/RepoAuditor
 Project-URL: Documentation, https://github.com/gt-sse-center/RepoAuditor

{repoauditor-0.2.41 → repoauditor-0.2.42}/pyproject.toml

@@ -39,7 +39,7 @@ repo_auditor = "RepoAuditor:EntryPoint.app"
 
 [project.entry-points.RepoAuditor]
 GitHubPlugin = "RepoAuditor.Plugins.GitHubPlugin"
-GitHubCustomizationPlugin = "RepoAuditor.Plugins.GitHubCustomizationPlugin"
+GitHubCommunityStandardsPlugin = "RepoAuditor.Plugins.GitHubCommunityStandardsPlugin"
 GitHubRulesetPlugin="RepoAuditor.Plugins.GitHubRulesetsPlugin"
 
 [build-system]

repoauditor-0.2.41/src/RepoAuditor/Plugins/GitHubCustomization/CustomizationQuery.py → repoauditor-0.2.42/src/RepoAuditor/Plugins/GitHubCommunityStandards/CommunityStandardsQuery.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the CustomizationQuery object."""
+"""Contains the CommunityStandardsQuery object."""
 
 from tempfile import TemporaryDirectory
 from typing import Any, Optional
@@ -12,20 +12,20 @@ from typing import Any, Optional
 from dbrownell_Common.Types import override  # type: ignore[import-untyped]
 from git import Repo
 
-from RepoAuditor.Plugins.GitHubCustomization.Requirements.CodeOwners import CodeOwners
-from RepoAuditor.Plugins.GitHubCustomization.Requirements.Contributing import Contributing
-from RepoAuditor.Plugins.GitHubCustomization.Requirements.IssueTemplates import IssueTemplates
-from RepoAuditor.Plugins.GitHubCustomization.Requirements.PullRequestTemplates import PullRequestTemplate
-from RepoAuditor.Plugins.GitHubCustomization.Requirements.SecurityPolicy import SecurityPolicy
+from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.CodeOwners import CodeOwners
+from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.Contributing import Contributing
+from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.IssueTemplates import IssueTemplates
+from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.PullRequestTemplates import PullRequestTemplate
+from RepoAuditor.Plugins.GitHubCommunityStandards.Requirements.SecurityPolicy import SecurityPolicy
 from RepoAuditor.Query import ExecutionStyle, Query
 
 
-class CustomizationQuery(Query):
-    """Query with requirements that check for GitHub customization files."""
+class CommunityStandardsQuery(Query):
+    """Query with requirements that check for GitHub CommunityStandards files."""
 
     def __init__(self) -> None:
         super().__init__(
-            "CustomizationQuery",
+            "CommunityStandardsQuery",
             ExecutionStyle.Parallel,
             [
                 CodeOwners(),

{repoauditor-0.2.41/src/RepoAuditor/Plugins/GitHubCustomization → repoauditor-0.2.42/src/RepoAuditor/Plugins/GitHubCommunityStandards}/Impl/ExistsRequirementImpl.py

@@ -56,7 +56,7 @@ class ExistsRequirementImpl(Requirement):
                 bool,
                 typer.Option(
                     False,
-                    help=f"Ensures that the customization file {self.github_file} exists.",
+                    help=f"Ensures that the file {self.github_file} exists.",
                 ),
             ),
         }

{repoauditor-0.2.41/src/RepoAuditor/Plugins/GitHubCustomization → repoauditor-0.2.42/src/RepoAuditor/Plugins/GitHubCommunityStandards}/Module.py

@@ -4,23 +4,23 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Contains the GitHubCustomizationModule object."""
+"""Contains the GitHubCommunityStandardsModule object."""
 
 from RepoAuditor.Module import ExecutionStyle
 from RepoAuditor.Plugins.GitHubBase.Module import GitHubBaseModule
-from RepoAuditor.Plugins.GitHubCustomization.CustomizationQuery import CustomizationQuery
+from RepoAuditor.Plugins.GitHubCommunityStandards.CommunityStandardsQuery import CommunityStandardsQuery
 
 
-class GitHubCustomizationModule(GitHubBaseModule):
-    """Module that validates GitHub repository customization files."""
+class GitHubCommunityStandardsModule(GitHubBaseModule):
+    """Module that validates GitHub repository files for Community Standards."""
 
     def __init__(self) -> None:
         super().__init__(
-            "GitHubCustomization",
-            "Validates GitHub repository customization files.",
+            "GitHubCommunityStandards",
+            "Validates GitHub repository files for Community Standards.",
             ExecutionStyle.Parallel,
             [
-                CustomizationQuery(),
+                CommunityStandardsQuery(),
             ],
             requires_explicit_include=True,
         )

{repoauditor-0.2.41/src/RepoAuditor/Plugins/GitHubCustomization → repoauditor-0.2.42/src/RepoAuditor/Plugins/GitHubCommunityStandards}/Requirements/CodeOwners.py

@@ -8,7 +8,7 @@
 
 import textwrap
 
-from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class CodeOwners(ExistsRequirementImpl):

{repoauditor-0.2.41/src/RepoAuditor/Plugins/GitHubCustomization → repoauditor-0.2.42/src/RepoAuditor/Plugins/GitHubCommunityStandards}/Requirements/Contributing.py

@@ -8,7 +8,7 @@
 
 import textwrap
 
-from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class Contributing(ExistsRequirementImpl):

{repoauditor-0.2.41/src/RepoAuditor/Plugins/GitHubCustomization → repoauditor-0.2.42/src/RepoAuditor/Plugins/GitHubCommunityStandards}/Requirements/IssueTemplates.py

@@ -6,7 +6,7 @@
 # -------------------------------------------------------------------------------
 """Contains the IssueTemplates requirement."""
 
-from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class IssueTemplates(ExistsRequirementImpl):

{repoauditor-0.2.41/src/RepoAuditor/Plugins/GitHubCustomization → repoauditor-0.2.42/src/RepoAuditor/Plugins/GitHubCommunityStandards}/Requirements/PullRequestTemplates.py

@@ -6,7 +6,7 @@
 # -------------------------------------------------------------------------------
 """Contains the PullRequestTemplate requirement."""
 
-from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class PullRequestTemplate(ExistsRequirementImpl):

{repoauditor-0.2.41/src/RepoAuditor/Plugins/GitHubCustomization → repoauditor-0.2.42/src/RepoAuditor/Plugins/GitHubCommunityStandards}/Requirements/SecurityPolicy.py

@@ -8,7 +8,7 @@
 
 import textwrap
 
-from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 
 
 class SecurityPolicy(ExistsRequirementImpl):

repoauditor-0.2.41/src/RepoAuditor/Plugins/GitHubCustomizationPlugin.py → repoauditor-0.2.42/src/RepoAuditor/Plugins/GitHubCommunityStandardsPlugin.py

@@ -10,11 +10,11 @@ import pluggy
 
 from RepoAuditor import APP_NAME
 from RepoAuditor.Module import Module
-from RepoAuditor.Plugins.GitHubCustomization.Module import GitHubCustomizationModule
+from RepoAuditor.Plugins.GitHubCommunityStandards.Module import GitHubCommunityStandardsModule
 
 
 # ----------------------------------------------------------------------
 @pluggy.HookimplMarker(APP_NAME)
 def GetModule() -> Module:
     """Return GitHub Customization Module."""
-    return GitHubCustomizationModule()
+    return GitHubCommunityStandardsModule()

{repoauditor-0.2.41 → repoauditor-0.2.42}/src/RepoAuditor/__init__.py

@@ -2,4 +2,4 @@ APP_NAME = "RepoAuditor"
 
 # Note that the default value below will be used until the value
 # here is explicitly updated by the Continuous Integration system.
-__version__ = "0.2.41"
+__version__ = "0.2.42"

{repoauditor-0.2.41 → repoauditor-0.2.42}/tests/ExecuteModules_UnitTest.py

@@ -322,8 +322,24 @@ class TestExecute:
 
         assert all_results == [[]]
 
-        assert cast(str, next(dm_and_content)) == textwrap.dedent(
-            """\
+        # Assuming major version is 3
+        if sys.version_info[1] < 11:
+            expected_content = textwrap.dedent(
+                """\
+            Heading...
+              Processing 1 module...
+                Processing 'MyModule' (1 of 1)...
+
+
+                DONE! (ReturnCode.DOESNOTAPPLY, <scrubbed duration>)
+              DONE! (ReturnCode.DOESNOTAPPLY, <scrubbed duration>)
+            DONE! (ReturnCode.DOESNOTAPPLY, <scrubbed duration>)
+            """,
+            )
+        else:
+            # From version 3.11 onwards, IntEnum.__str__ returns the int value.
+            expected_content = textwrap.dedent(
+                """\
             Heading...
               Processing 1 module...
                 Processing 'MyModule' (1 of 1)...
@@ -333,7 +349,9 @@ class TestExecute:
               DONE! (2, <scrubbed duration>)
             DONE! (2, <scrubbed duration>)
             """,
-        )
+            )
+
+        assert cast(str, next(dm_and_content)) == expected_content
 
 
 # ----------------------------------------------------------------------

repoauditor-0.2.41/tests/Plugins/GitHubCustomization/CutomizationQuery_UnitTest.py → repoauditor-0.2.42/tests/Plugins/GitHubCommunityStandards/CommunityStandardsQuery_UnitTest.py

@@ -4,12 +4,15 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Unit tests for CustomizationQuery.py"""
+"""Unit tests for CommunityStandardsQuery.py"""
 
 import pytest
 from git import Repo
 
-from RepoAuditor.Plugins.GitHubCustomization.CustomizationQuery import CustomizationQuery, TemporaryDirectory
+from RepoAuditor.Plugins.GitHubCommunityStandards.CommunityStandardsQuery import (
+    CommunityStandardsQuery,
+    TemporaryDirectory,
+)
 
 
 def mock_clone_from(github_url, repo_dirname, branch="main"):
@@ -32,7 +35,7 @@ def patch_temp_directory(monkeypatch):
     monkeypatch.delattr("tempfile.TemporaryDirectory")
 
 
-class TestCustomizationQuery:
+class TestCommunityStandardsQuery:
     def test_GetData(self, module_data, monkeypatch):
         """Test the GetData method."""
         monkeypatch.setattr(
@@ -46,14 +49,14 @@ class TestCustomizationQuery:
             mock_clone_from,
         )
 
-        query = CustomizationQuery()
+        query = CommunityStandardsQuery()
         query_data = query.GetData(module_data)
 
         assert query_data["repo_dir"].name == "test_temp_directory"
 
     def test_Cleanup(self, module_data):
         """Test the Cleanup method."""
-        query = CustomizationQuery()
+        query = CommunityStandardsQuery()
         module_data["repo_dir"] = MockTemporaryDirectory()
         result = query.Cleanup(module_data)
 

{repoauditor-0.2.41/tests/Plugins/GitHubCustomization → repoauditor-0.2.42/tests/Plugins/GitHubCommunityStandards}/ExistsRequirementImpl_UnitTest.py

@@ -9,7 +9,7 @@
 from pathlib import Path
 from tempfile import TemporaryDirectory
 
-from RepoAuditor.Plugins.GitHubCustomization.Impl.ExistsRequirementImpl import ExistsRequirementImpl
+from RepoAuditor.Plugins.GitHubCommunityStandards.Impl.ExistsRequirementImpl import ExistsRequirementImpl
 from RepoAuditor.Requirement import EvaluateResult
 
 

repoauditor-0.2.41/tests/Plugins/GitHubCustomization/GitHubCustomization_UnitTest.py → repoauditor-0.2.42/tests/Plugins/GitHubCommunityStandards/GitHubCommunityStandards_UnitTest.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""Unit tests for the GitHub Customization Plugin"""
+"""Unit tests for the GitHub Community Standards Plugin"""
 
 import sys
 from pathlib import Path
@@ -12,7 +12,7 @@ from pathlib import Path
 import pluggy
 
 from RepoAuditor import APP_NAME
-from RepoAuditor.Plugins.GitHubCustomizationPlugin import GetModule
+from RepoAuditor.Plugins.GitHubCommunityStandardsPlugin import GetModule
 
 
 # ----------------------------------------------------------------------
@@ -28,7 +28,7 @@ def test_get_module_returns_object():
     module = GetModule()
     assert module is not None
     assert hasattr(module, "name")
-    assert module.name == "GitHubCustomization"
+    assert module.name == "GitHubCommunityStandards"
 
 
 # ----------------------------------------------------------------------
@@ -55,7 +55,7 @@ def test_plugin_registration():
 
 
 # ----------------------------------------------------------------------
-class TestGitHubCustomizationModule:
+class TestGitHubCommunityStandardsModule:
     """Unit tests for the GitHubCustomizaton module."""
 
     def test_Construct(self):
@@ -63,11 +63,11 @@ class TestGitHubCustomizationModule:
         module = GetModule()
 
         assert module is not None
-        assert module.name == "GitHubCustomization"
+        assert module.name == "GitHubCommunityStandards"
         # Comment out checks that would fail with minimal implementation
         # assert module.execution_style.name == "Parallel"
         # assert len(module.queries) == 1
-        # assert isinstance(module.queries[0], CustomizationQuery)
+        # assert isinstance(module.queries[0], CommunityStandardsQuery)
         # assert module.requires_explicit_include is False
 
     def test_GetDynamicArgDefinitions(self):

repoauditor-0.2.41/tests/Plugins/GitHubCustomization_EndToEndTest.py → repoauditor-0.2.42/tests/Plugins/GitHubCommunityStandards_EndToEndTest.py

@@ -4,7 +4,7 @@
 # |  Distributed under the MIT License.
 # |
 # -------------------------------------------------------------------------------
-"""End-to-end tests for the GitHubCustomization plugin."""
+"""End-to-end tests for the GitHubCommunityStandards plugin."""
 
 from pathlib import Path
 
@@ -22,13 +22,13 @@ pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
 
 
 # ----------------------------------------------------------------------
-class TestCustomization:
-    """End-to-end tests for customization files in a GitHub repository."""
+class TestCommunityStandards:
+    """End-to-end tests for community standards files in a GitHub repository."""
 
     # ----------------------------------------------------------------------
     def test_CodeOwners(self, pat_args, snapshot):
         """Test if a CODEOWNERS file exists in the repository."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-CodeOwners-exists"])
+        result = CliRunner().invoke(app, pat_args + ["--GitHubCommunityStandards-CodeOwners-exists"])
 
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
@@ -39,9 +39,9 @@ class TestCustomization:
             app,
             pat_args
             + [
-                "--GitHubCustomization-CodeOwners-exists",
-                "--GitHubCustomization-branch",
-                "test-GitHubCustomization",
+                "--GitHubCommunityStandards-CodeOwners-exists",
+                "--GitHubCommunityStandards-branch",
+                "test-GitHubCommunityStandards",
             ],
         )
 
@@ -50,7 +50,7 @@ class TestCustomization:
 
     def test_Contributing(self, pat_args, snapshot):
         """Test if a CONTRIBUTING.md file exists in the repository."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-Contributing-exists"])
+        result = CliRunner().invoke(app, pat_args + ["--GitHubCommunityStandards-Contributing-exists"])
 
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
@@ -61,9 +61,9 @@ class TestCustomization:
             app,
             pat_args
             + [
-                "--GitHubCustomization-Contributing-exists",
-                "--GitHubCustomization-branch",
-                "test-GitHubCustomization",
+                "--GitHubCommunityStandards-Contributing-exists",
+                "--GitHubCommunityStandards-branch",
+                "test-GitHubCommunityStandards",
             ],
         )
 
@@ -72,7 +72,7 @@ class TestCustomization:
 
     def test_IssueTemplate(self, pat_args, snapshot):
         """Test if an Issue template file (e.g. ISSUE_TEMPLATE.md) exists in the repository."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-IssueTemplates-exists"])
+        result = CliRunner().invoke(app, pat_args + ["--GitHubCommunityStandards-IssueTemplates-exists"])
 
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
@@ -83,9 +83,9 @@ class TestCustomization:
             app,
             pat_args
             + [
-                "--GitHubCustomization-IssueTemplates-exists",
-                "--GitHubCustomization-branch",
-                "test-GitHubCustomization",
+                "--GitHubCommunityStandards-IssueTemplates-exists",
+                "--GitHubCommunityStandards-branch",
+                "test-GitHubCommunityStandards",
             ],
         )
 
@@ -94,7 +94,7 @@ class TestCustomization:
 
     def test_PullRequestTemplate(self, pat_args, snapshot):
         """Test if a Pull Request template file (e.g. PULL_REQUEST_TEMPLATE.md) exists in the repository."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-PullRequestTemplate-exists"])
+        result = CliRunner().invoke(app, pat_args + ["--GitHubCommunityStandards-PullRequestTemplate-exists"])
 
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
@@ -105,9 +105,9 @@ class TestCustomization:
             app,
             pat_args
             + [
-                "--GitHubCustomization-PullRequestTemplate-exists",
-                "--GitHubCustomization-branch",
-                "test-GitHubCustomization",
+                "--GitHubCommunityStandards-PullRequestTemplate-exists",
+                "--GitHubCommunityStandards-branch",
+                "test-GitHubCommunityStandards",
             ],
         )
 
@@ -116,7 +116,7 @@ class TestCustomization:
 
     def test_SecurityPolicy(self, pat_args, snapshot):
         """Test if a Security policy file (e.g. SECURITY.md) exists in the repository."""
-        result = CliRunner().invoke(app, pat_args + ["--GitHubCustomization-SecurityPolicy-exists"])
+        result = CliRunner().invoke(app, pat_args + ["--GitHubCommunityStandards-SecurityPolicy-exists"])
 
         assert result.exit_code == 0, result.output
         assert ScrubDurationGithuburlAndSpaces(result.stdout) == snapshot
@@ -127,9 +127,9 @@ class TestCustomization:
             app,
             pat_args
             + [
-                "--GitHubCustomization-SecurityPolicy-exists",
-                "--GitHubCustomization-branch",
-                "test-GitHubCustomization",
+                "--GitHubCommunityStandards-SecurityPolicy-exists",
+                "--GitHubCommunityStandards-branch",
+                "test-GitHubCommunityStandards",
             ],
         )
 
@@ -144,8 +144,8 @@ class TestCustomization:
 def args() -> list[str]:
     return [
         "--include",
-        "GitHubCustomization",
-        "--GitHubCustomization-url",
+        "GitHubCommunityStandards",
+        "--GitHubCommunityStandards-url",
         GetGithubUrl(),
     ]
 
@@ -159,4 +159,4 @@ def pat_args(args) -> list[str]:
     with _github_pat_filename.open() as f:
         pat_value = f.read().strip()
 
-    return args + ["--GitHubCustomization-pat", pat_value]
+    return args + ["--GitHubCommunityStandards-pat", pat_value]