RepoAuditor 0.4.1__tar.gz → 0.4.2__tar.gz

{repoauditor-0.4.1 → repoauditor-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: RepoAuditor
-Version: 0.4.1
+Version: 0.4.2
 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.4.1 → repoauditor-0.4.2}/src/RepoAuditor/Plugins/CommunityStandards/Impl/ExistsRequirementImpl.py

@@ -30,6 +30,7 @@ class ExistsRequirementImpl(Requirement):
         resolution: str,
         rationale: str,
         *,
+        enabled_by_default: bool = True,
         dynamic_arg_name: str = "unrequired",
         requires_explicit_include: bool = False,
     ) -> None:
@@ -41,7 +42,8 @@ class ExistsRequirementImpl(Requirement):
             possible_locations (Sequence[str]): List of potential paths in the repo to check if `filename` exists.
             resolution (str): Message on how to resolve the requirement in case of an error.
             rationale (str): Rationale message on why this requirement is needed.
-            dynamic_arg_name (str, optional): Name of the runtime argument (e.g. from command line) to this requirement.Defaults to "unrequired", which if enabled causes the requirement to be skipped.
+            enabled_by_default (bool): Flag which indicates if the required file should be present in the repository by default. Defaults to True.
+            dynamic_arg_name (str, optional): Name of the runtime argument (e.g. from command line) to this requirement. Defaults to "unrequired", which if enabled causes the requirement to check if file is not present.
             requires_explicit_include (bool, optional): Flag checking if this requirement needs to be explicitly included in the invocation. Defaults to False.
 
         """
@@ -56,8 +58,8 @@ class ExistsRequirementImpl(Requirement):
 
         self.dynamic_arg_name = dynamic_arg_name
         self.filename = filename
-
         self.possible_locations = possible_locations
+        self.enabled_by_default = enabled_by_default
 
     # ----------------------------------------------------------------------
     @override
@@ -68,7 +70,7 @@ class ExistsRequirementImpl(Requirement):
                 bool,
                 typer.Option(
                     False,
-                    help=f"Disable requirement that the file {self.filename} exists.",
+                    help=f"{'Disable' if self.enabled_by_default else 'Enable'} requirement that the file {self.filename} exists.{' Needs to be explicitly included.' if self.requires_explicit_include else ''}",
                 ),
             ),
         }
@@ -80,8 +82,14 @@ class ExistsRequirementImpl(Requirement):
         query_data: dict[str, Any],
         requirement_args: dict[str, Any],
     ) -> Requirement.EvaluateImplResult:
-        # Check if dynamic argument is `not unrequired`.
-        if not requirement_args.get(self.dynamic_arg_name, False):
+        # Flag to check if required file exists
+        check_exists: bool = self.enabled_by_default
+
+        # Check if the dynamic argument is provided, which toggles the check flag
+        if requirement_args.get(self.dynamic_arg_name, False):
+            check_exists = not check_exists
+
+        if check_exists:
             for location in self.possible_locations:
                 # Get full file path in temporary repo directory and check if it exists
                 # This checks both upper case and lower case variants
@@ -107,5 +115,5 @@ class ExistsRequirementImpl(Requirement):
                 provide_rationale=True,
             )
 
-        # Requirement flag not set so DoesNotApply
+        # Requirement not enabled, so DoesNotApply
         return Requirement.EvaluateImplResult(EvaluateResult.DoesNotApply, None)

{repoauditor-0.4.1 → repoauditor-0.4.2}/src/RepoAuditor/Plugins/ScientificSoftware/Requirements/Citation.py

@@ -37,7 +37,7 @@ class Citation(ExistsRequirementImpl):
                 "citations.bib",
                 "citation.md",
                 "citations.md",
-                # R packages are located in the `inst` directory
+                # Citations for R packages are located in the `inst` directory
                 "inst/CITATION",
             ],
             resolution=textwrap.dedent(
@@ -59,5 +59,4 @@ class Citation(ExistsRequirementImpl):
                 https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
                 """
             ),
-            dynamic_arg_name="unrequired",
         )

{repoauditor-0.4.1 → repoauditor-0.4.2}/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.4.1"
+__version__ = "0.4.2"

{repoauditor-0.4.1 → repoauditor-0.4.2}/tests/EntryPoint_UnitTest.py

@@ -8,13 +8,12 @@
 
 import pytest
 import typer
-
 from dbrownell_Common.TestHelpers.StreamTestHelpers import InitializeStreamCapabilities
 from dbrownell_Common.TyperEx import TypeDefinitionItem  # type: ignore [import-untyped]
 from typer.testing import CliRunner
 
 from RepoAuditor import __version__
-from RepoAuditor.EntryPoint import app, TypeInfoToString
+from RepoAuditor.EntryPoint import TypeInfoToString, app
 
 from .Plugins.utilities import GetGithubUrl
 

{repoauditor-0.4.1 → repoauditor-0.4.2}/tests/ExecuteModules_UnitTest.py

@@ -9,23 +9,20 @@
 import sys
 import textwrap
 import time
-
 from typing import cast
 
 import pytest
-
-from dbrownell_Common.Types import override
 from dbrownell_Common.TestHelpers.StreamTestHelpers import (
     GenerateDoneManagerAndContent,
     InitializeStreamCapabilities,
 )
+from dbrownell_Common.Types import override
 
 from RepoAuditor.Display import *
 from RepoAuditor.ExecuteModules import *
 from RepoAuditor.Module import *
 from RepoAuditor.Requirement import *
 
-
 # ----------------------------------------------------------------------
 pytest.fixture(InitializeStreamCapabilities(), scope="session", autouse=True)
 

{repoauditor-0.4.1 → repoauditor-0.4.2}/tests/Plugins/ScientificSoftware_EndToEndTest.py

@@ -24,11 +24,11 @@ class TestScientificSoftware:
     """End-to-end tests for files in a GitHub repository which implements scientific software."""
 
     # ----------------------------------------------------------------------
-    def test_NoCitation(self, pat_args, snapshot):
+    def test_NoCitation(self, args, snapshot):
         """Test if no CITATION file exists in the repository."""
         result = CliRunner().invoke(
             app,
-            pat_args,
+            args,
         )
 
         assert result.exit_code == -1, result.output

{repoauditor-0.4.1 → repoauditor-0.4.2}/tests/Plugins/__snapshots__/GitHubEnterprise_EndToEndTest.ambr

@@ -23,7 +23,7 @@
   │                                                                                                                      │
   │ ╭─ [Error] AllowDeletions ─────────────────────────────────────────────────────────────────────────────────────────╮ │
   │ │                                                                                                                  │ │
-  │ │ Validates that 'Allow deletions' is set to False.                                                                │ │
+  │ │ Validates that 'Allow deletions' is set to True.                                                                 │ │
   │ │                                                                                                                  │ │
   │ │ ERROR: 'Allow deletions' must be set to 'True' (it is currently set to 'False').                                 │ │
   │ │                                                                                                                  │ │

{repoauditor-0.4.1 → repoauditor-0.4.2}/tests/Plugins/conftest.py

@@ -6,13 +6,13 @@
 # -------------------------------------------------------------------------------
 """Common test fixtures for Plugins."""
 
-from typing import Any
 from pathlib import Path
+from typing import Any
 
 import pytest
 
 # Fixtures included here so it is available for all tests
-from GitHubModule.fixtures import session_fixture, query_data_fixture  # noqa: F401
+from GitHubModule.fixtures import query_data_fixture, session_fixture  # noqa: F401
 from utilities import CheckPATFileExists, GetGithubUrl
 
 from RepoAuditor.Plugins.GitHubBase.Module import _GitHubSession

{repoauditor-0.4.1 → repoauditor-0.4.2}/tests/Query_UnitTest.py

@@ -9,7 +9,6 @@
 from unittest.mock import Mock
 
 import pytest
-
 from dbrownell_Common.Types import override
 
 from RepoAuditor.Query import *

{repoauditor-0.4.1 → repoauditor-0.4.2}/tests/Requirement_UnitTest.py

@@ -9,7 +9,6 @@
 from unittest.mock import Mock
 
 import pytest
-
 from dbrownell_Common.Types import override
 
 from RepoAuditor.Requirement import *