repo-review 0.10.4__tar.gz → 0.10.6__tar.gz

{repo_review-0.10.4 → repo_review-0.10.6}/.github/workflows/ci.yml

@@ -26,7 +26,7 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
-      - uses: pre-commit/action@v3.0.0
+      - uses: pre-commit/action@v3.0.1
         with:
           extra_args: --hook-stage manual --all-files
       - name: Run PyLint
@@ -53,8 +53,13 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
+      - name: Setup uv
+        uses: yezz123/setup-uv@v4
+        with:
+          uv-venv: ".venv"
+
       - name: Install package
-        run: python -m pip install .[test,cli]
+        run: uv pip install .[test,cli]
 
       - name: Test package
         run: python -m pytest -ra
@@ -80,7 +85,10 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: wntrblm/nox@2023.04.22
+      - name: Setup uv
+        uses: yezz123/setup-uv@v4
+
+      - uses: wntrblm/nox@2024.04.15
         with:
           python-versions: "3.11"
 
@@ -106,4 +114,4 @@ jobs:
       - name: Run repo-review action
         uses: ./
         with:
-          plugins: sp-repo-review==2023.12.21
+          plugins: sp-repo-review==2024.03.10

{repo_review-0.10.4 → repo_review-0.10.6}/.pre-commit-config.yaml

@@ -10,20 +10,20 @@ repos:
         additional_dependencies: [black==23.*]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.1.14"
+    rev: "v0.4.1"
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
       - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.1.0"
+    rev: "v4.0.0-alpha.8"
     hooks:
       - id: prettier
         types_or: [yaml, markdown, html, css, scss, javascript, json]
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v4.6.0
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
@@ -44,7 +44,7 @@ repos:
       - id: rst-inline-touching-normal
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.8.0
+    rev: v1.9.0
     hooks:
       - id: mypy
         files: (src|web|tests)
@@ -64,7 +64,7 @@ repos:
         args: ["-Lhist,absense", "-w"]
 
   - repo: https://github.com/shellcheck-py/shellcheck-py
-    rev: v0.9.0.6
+    rev: v0.10.0.1
     hooks:
       - id: shellcheck
 

{repo_review-0.10.4 → repo_review-0.10.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: repo_review
-Version: 0.10.4
+Version: 0.10.6
 Summary: Framework that can run checks on repos
 Project-URL: Changelog, https://github.com/scientific-python/repo-review/releases
 Project-URL: Demo, https://scientific-python.github.io/repo-review
@@ -34,11 +34,18 @@ Requires-Dist: click>=8; extra == 'cli'
 Requires-Dist: rich-click; extra == 'cli'
 Requires-Dist: rich>=12.2; extra == 'cli'
 Provides-Extra: dev
-Requires-Dist: repo-review[cli,test]; extra == 'dev'
+Requires-Dist: click>=8; extra == 'dev'
+Requires-Dist: pytest>=7; extra == 'dev'
+Requires-Dist: rich-click; extra == 'dev'
+Requires-Dist: rich>=12.2; extra == 'dev'
+Requires-Dist: sp-repo-review>=2023.12.21; extra == 'dev'
+Requires-Dist: validate-pyproject>=0.14; extra == 'dev'
 Provides-Extra: docs
+Requires-Dist: click>=8; extra == 'docs'
 Requires-Dist: furo; extra == 'docs'
 Requires-Dist: myst-parser>=0.13; extra == 'docs'
-Requires-Dist: repo-review[cli]; extra == 'docs'
+Requires-Dist: rich-click; extra == 'docs'
+Requires-Dist: rich>=12.2; extra == 'docs'
 Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
 Requires-Dist: sphinx-copybutton; extra == 'docs'
 Requires-Dist: sphinx-github-changelog; extra == 'docs'
@@ -57,6 +64,7 @@ Description-Content-Type: text/markdown
 [![Documentation Status][docs-badge]][docs-link]
 
 [![PyPI version][pypi-version]][pypi-link]
+[![Conda-Forge][conda-badge]][conda-link]
 [![PyPI platforms][pypi-platforms]][pypi-link]
 
 <!-- SPHINX-START -->
@@ -212,6 +220,8 @@ This was developed for [Scikit-HEP][] before moving to Scientific-Python.
 [sp-repo-review]: https://pypi.org/project/sp-repo-review
 [validate-pyproject]: https://validate-pyproject.readthedocs.io
 [validate-pyproject-schema-store]: https://github.com/henryiii/validate-pyproject-schema-store
+[conda-badge]: https://img.shields.io/conda/vn/conda-forge/repo-review
+[conda-link]: https://github.com/conda-forge/repo-review-feedstock
 
 [intro-pre-commit]: https://repo-review.readthedocs.io/en/latest/intro.html#pre-commit
 [intro-github-actions]: https://repo-review.readthedocs.io/en/latest/intro.html#github-actions

{repo_review-0.10.4 → repo_review-0.10.6}/README.md

@@ -4,6 +4,7 @@
 [![Documentation Status][docs-badge]][docs-link]
 
 [![PyPI version][pypi-version]][pypi-link]
+[![Conda-Forge][conda-badge]][conda-link]
 [![PyPI platforms][pypi-platforms]][pypi-link]
 
 <!-- SPHINX-START -->
@@ -159,6 +160,8 @@ This was developed for [Scikit-HEP][] before moving to Scientific-Python.
 [sp-repo-review]: https://pypi.org/project/sp-repo-review
 [validate-pyproject]: https://validate-pyproject.readthedocs.io
 [validate-pyproject-schema-store]: https://github.com/henryiii/validate-pyproject-schema-store
+[conda-badge]: https://img.shields.io/conda/vn/conda-forge/repo-review
+[conda-link]: https://github.com/conda-forge/repo-review-feedstock
 
 [intro-pre-commit]: https://repo-review.readthedocs.io/en/latest/intro.html#pre-commit
 [intro-github-actions]: https://repo-review.readthedocs.io/en/latest/intro.html#github-actions

{repo_review-0.10.4 → repo_review-0.10.6}/docs/api/repo_review.rst

@@ -72,3 +72,11 @@ repo\_review.schema module
    :members:
    :undoc-members:
    :show-inheritance:
+
+repo\_review.testing module
+---------------------------
+
+.. automodule:: repo_review.testing
+   :members:
+   :undoc-members:
+   :show-inheritance:

{repo_review-0.10.4 → repo_review-0.10.6}/docs/fixtures.md

@@ -3,7 +3,7 @@
 Like pytest fixtures, fixtures in repo-review are requested by name. There are five built-in fixtures:
 
 - `root`: {class}`~importlib.resources.abc.Traversable` - The repository path. All checks or fixtures that depend on the root of the repository should use this.
-- `package`: `~importlib.resources.abc.Traversable` - The path to the package directory. This is the same as `root` unless `--package-dir` is passed.
+- `package`: {class}`~importlib.resources.abc.Traversable` - The path to the package directory. This is the same as `root` unless `--package-dir` is passed.
 - `name`: `str` - The name of the current check. (Special fixture only provided for checks, not collection functions.)
 - {func}`~repo_review.fixtures.pyproject`: `dict[str, Any]` - The `pyproject.toml` in the package if it exists, an empty dict otherwise.
 - {func}`~repo_review.fixtures.list_all`: `bool` - Returns `True`` if repo-review is just trying to collect all checks to list them.

{repo_review-0.10.4 → repo_review-0.10.6}/docs/index.html

@@ -65,8 +65,8 @@
           header={true}
           deps={[
             "repo-review~=0.10.0",
-            "sp-repo-review==2023.12.21",
-            "validate-pyproject-schema-store==2024.1.23",
+            "sp-repo-review==2024.03.10",
+            "validate-pyproject-schema-store==2024.04.20",
             "validate-pyproject[all]~=0.16.0",
           ]}
         />,

{repo_review-0.10.4 → repo_review-0.10.6}/docs/intro.md

@@ -31,10 +31,13 @@ pipx inject repo-review <plugin(s)>
 repo-review .
 ```
 
-Any other way you like installing things works too, including `pip install`.
+Any other way you like installing things works too, including `pip install` and `uv pip install`.
 Remember the `[cli]` extra if you are using the command line
 interface.
 
+A conda-forge package is also available. You can use `conda`, `mamba`, `micromamba`, or `pixi` to
+install from the conda-forge channel.
+
 Plugins are also encouraged to support pre-commit and GitHub Actions.
 
 ## Running checks

{repo_review-0.10.4 → repo_review-0.10.6}/docs/plugins.md

@@ -6,7 +6,7 @@ nicer display names. When writing a plugin, you should also do a few things
 when setting up the package. These suggestions assume you are using a
 standardized backend, such as `hatchling`, `flit-core`, `pdm-backend`, or
 `setuptools>=61`. If you are using some other build backend, please adjust
-accordingly.
+accordingly. Notably, Poetry calls `project.entry-points` "`tool.poetry.plugins`".
 
 ## Entry points
 
@@ -53,6 +53,22 @@ You have `processed.results` and `processed.families` from the return of
 {func}`~repo_review.processor.collect_all` to get `.fixtures`, `.checks`, and
 `.families`.
 
+### Unit testing
+
+You can also run unit tests with the {func}`~repo_review.testing.compute_check` helper. It is used like this:
+
+```python
+def test_has_tool_ruff_unit() -> None:
+    assert repo_review.testing.compute_check("RF001", ruff={}).result
+    assert not repo_review.testing.compute_check("RF001", ruff=None).result
+```
+
+It takes the check name and any fixtures as keyword arguments. It returns a
+{class}`~repo_review.checks.Check` instance, so you can see if the `.result` is
+`True`/`False`/`None`, or check any of the other properties.
+
+.. versionadded:: 0.10.5
+
 ## An existing package
 
 Since writing a plugin does not require depending on repo-review, you can also

{repo_review-0.10.4 → repo_review-0.10.6}/noxfile.py

@@ -8,6 +8,8 @@ import nox
 
 DIR = Path(__file__).parent.resolve()
 
+nox.needs_version = ">=2024.3.2"
+nox.options.default_venv_backend = "uv|virtualenv"
 nox.options.sessions = ["lint", "pylint", "tests"]
 
 

{repo_review-0.10.4 → repo_review-0.10.6}/src/repo_review/__init__.py

@@ -4,7 +4,6 @@ Copyright (c) 2022 Henry Schreiner. All rights reserved.
 Review repos with a set of checks defined by plugins.
 """
 
-
 from __future__ import annotations
 
 from ._version import version as __version__

{repo_review-0.10.4 → repo_review-0.10.6}/src/repo_review/__main__.py

@@ -41,7 +41,9 @@ def __dir__() -> list[str]:
     return __all__
 
 
-rich.traceback.install(suppress=[click, rich, orig_click], show_locals=True, width=None)
+rich.traceback.install(
+    suppress=[click, rich, orig_click], show_locals=False, width=None
+)
 
 Status = Literal["empty", "passed", "skips", "errors"]
 Formats = Literal["rich", "json", "html", "svg"]

{repo_review-0.10.4 → repo_review-0.10.6}/src/repo_review/_compat/importlib/resources/abc.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 import sys
 
 if sys.version_info < (3, 11):
+    # pylint: disable-next=deprecated-class
     from importlib.abc import Traversable
 else:
     from importlib.resources.abc import Traversable

{repo_review-0.10.4 → repo_review-0.10.6}/src/repo_review/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.10.4'
-__version_tuple__ = version_tuple = (0, 10, 4)
+__version__ = version = '0.10.6'
+__version_tuple__ = version_tuple = (0, 10, 6)

{repo_review-0.10.4 → repo_review-0.10.6}/src/repo_review/checks.py

@@ -120,3 +120,26 @@ def get_check_description(name: str, check: Check) -> str:
     .. versionadded:: 0.8
     """
     return (check.__doc__ or "").format(self=check, name=name)
+
+
+def process_result_bool(
+    result: str | bool | None, check: Check, name: str
+) -> str | None:
+    """
+    This converts a bool into a string given a check and name. If the result is a string
+    or None, it is returned as is.
+
+    :param result: The result to process.
+    :param check: The check instance.
+    :param name: The name of the check.
+    :return: The final string or None.
+
+    .. versionadded:: 0.11
+    """
+    if isinstance(result, bool):
+        return (
+            ""
+            if result
+            else (check.check.__doc__ or "Check failed").format(name=name, self=check)
+        )
+    return result

{repo_review-0.10.4 → repo_review-0.10.6}/src/repo_review/ghpath.py

@@ -76,12 +76,10 @@ class GHPath(Traversable):
         return (self.path or self.repo).split("/")[-1]
 
     @typing.overload  # type: ignore[override]
-    def open(self, mode: Literal["r"], encoding: str | None = ...) -> io.StringIO:
-        ...
+    def open(self, mode: Literal["r"], encoding: str | None = ...) -> io.StringIO: ...
 
     @typing.overload
-    def open(self, mode: Literal["rb"]) -> io.BytesIO:
-        ...
+    def open(self, mode: Literal["rb"]) -> io.BytesIO: ...
 
     def open(
         self, mode: Literal["r", "rb"] = "r", encoding: str | None = "utf-8"
@@ -164,12 +162,10 @@ class EmptyTraversable(Traversable):
         return self._fake_name
 
     @typing.overload  # type: ignore[override]
-    def open(self, mode: Literal["r"], encoding: str | None = ...) -> io.StringIO:
-        ...
+    def open(self, mode: Literal["r"], encoding: str | None = ...) -> io.StringIO: ...
 
     @typing.overload
-    def open(self, mode: Literal["rb"]) -> io.BytesIO:
-        ...
+    def open(self, mode: Literal["rb"]) -> io.BytesIO: ...
 
     def open(
         self, mode: Literal["r", "rb"] = "r", encoding: str | None = "utf-8"

{repo_review-0.10.4 → repo_review-0.10.6}/src/repo_review/processor.py

@@ -10,7 +10,13 @@ from typing import Any, TypeVar
 import markdown_it
 
 from ._compat.importlib.resources.abc import Traversable
-from .checks import Check, collect_checks, get_check_url, is_allowed
+from .checks import (
+    Check,
+    collect_checks,
+    get_check_url,
+    is_allowed,
+    process_result_bool,
+)
 from .families import Family, collect_families
 from .fixtures import apply_fixtures, collect_fixtures, compute_fixtures, pyproject
 from .ghpath import EmptyTraversable
@@ -108,8 +114,7 @@ class HasFamily(typing.Protocol):
     """
 
     @property
-    def family(self) -> str:
-        ...
+    def family(self) -> str: ...
 
 
 T = TypeVar("T", bound=HasFamily)
@@ -212,16 +217,7 @@ def process(
     for name in ts.static_order():
         if all(completed.get(n, "") == "" for n in graph[name]):
             result = apply_fixtures({"name": name, **fixtures}, tasks[name].check)
-            if isinstance(result, bool):
-                completed[name] = (
-                    ""
-                    if result
-                    else (tasks[name].check.__doc__ or "Check failed").format(
-                        name=name, self=tasks[name]
-                    )
-                )
-            else:
-                completed[name] = result
+            completed[name] = process_result_bool(result, tasks[name], name)
         else:
             completed[name] = None
 

repo_review-0.10.6/src/repo_review/testing.py

@@ -0,0 +1,70 @@
+"""
+Helpers for testing repo-review plugins.
+"""
+
+from __future__ import annotations
+
+import importlib.metadata
+import textwrap
+from typing import Any
+
+from ._compat import tomllib
+from .checks import Check, get_check_url, process_result_bool
+from .fixtures import apply_fixtures
+from .processor import Result
+
+__all__ = ["toml_loads", "compute_check"]
+
+
+def __dir__() -> list[str]:
+    return __all__
+
+
+def toml_loads(contents: str, /) -> Any:
+    """
+    A helper function to quickly load a TOML string for Python 3.10+.
+
+    :param contents: The TOML string to load.
+    :return: The loaded TOML.
+
+    .. versionadded:: 0.10.6
+    """
+    return tomllib.loads(contents)
+
+
+def compute_check(name: str, /, **fixtures: Any) -> Result:
+    """
+    A helper function to compute a check given fixtures, intended for testing.
+    Currently, all fixtures are required to be passed in as keyword arguments,
+    transitive fixtures are not supported.
+
+    :param name: The name of the check to compute.
+    :param fixtures: The fixtures to use when computing the check.
+    :return: The computed result.
+
+    .. versionadded:: 0.10.5
+    """
+
+    check_functions = (
+        ep.load() for ep in importlib.metadata.entry_points(group="repo_review.checks")
+    )
+    checks = {
+        k: v
+        for func in check_functions
+        for k, v in apply_fixtures(fixtures, func).items()
+    }
+    check: Check = checks[name]
+    completed_raw = apply_fixtures({"name": name, **fixtures}, check.check)
+    completed = process_result_bool(completed_raw, check, name)
+    result = None if completed is None else not completed
+    doc = check.__doc__ or ""
+    err_msg = completed or ""
+
+    return Result(
+        family=check.family,
+        name=name,
+        description=doc.format(self=check, name=name).strip(),
+        result=result,
+        err_msg=textwrap.dedent(err_msg),
+        url=get_check_url(name, check),
+    )

{repo_review-0.10.4 → repo_review-0.10.6}/tests/test_cmd.py

@@ -31,7 +31,7 @@ def test_cmd_pyproject():
 
 
 def test_cmd_dual():
-    subprocess.run(["repo-review", "../repo-review", "../repo-review"], check=True)
+    subprocess.run(["repo-review", "tests/..", "."], check=True)
 
 
 def test_cmd_html():

repo_review-0.10.6/tests/test_depends.py

@@ -0,0 +1,61 @@
+from pathlib import Path
+
+import pytest
+
+import repo_review.processor
+from repo_review._compat.importlib.resources.abc import Traversable
+
+
+class E100:
+    "Was passed correctly"
+
+    family = "example"
+
+    @staticmethod
+    def check(package: Traversable) -> bool:
+        """
+        Requires Path(".") to be passed
+        """
+
+        return package == Path()
+
+
+class E200:
+    "Always true"
+
+    family = "example"
+    requires = frozenset(["E100"])
+
+    @staticmethod
+    def check() -> bool:
+        """
+        Can't be false.
+        """
+
+        return True
+
+
+def test_ignore_filter_single(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setattr(
+        repo_review.processor,
+        "collect_checks",
+        lambda _: {"E100": E100, "E200": E200},
+    )
+    _, results = repo_review.processor.process(Path(), ignore={"E100"})
+
+    assert len(results) == 1
+    assert results[0].name == "E200"
+    assert results[0].result
+
+
+def test_select_filter_single(monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.setattr(
+        repo_review.processor,
+        "collect_checks",
+        lambda _: {"E100": E100, "E200": E200},
+    )
+    _, results = repo_review.processor.process(Path(), select={"E200"})
+
+    assert len(results) == 1
+    assert results[0].name == "E200"
+    assert results[0].result

{repo_review-0.10.4 → repo_review-0.10.6}/tests/test_package.py

@@ -6,6 +6,7 @@ from pathlib import Path
 import pytest
 
 import repo_review as m
+import repo_review.testing
 from repo_review.processor import process
 
 DIR = Path(__file__).parent.resolve()
@@ -43,3 +44,15 @@ def test_broken_validate_pyproject(tmp_path: Path) -> None:
     (result,) = (r for r in results.results if r.name == "VPP001")
     assert "must match pattern" in result.err_msg
     assert not result.result
+
+
+def test_testing_function():
+    pytest.importorskip("sp_repo_review")
+
+    assert repo_review.testing.compute_check("RF001", ruff={}).result
+    assert not repo_review.testing.compute_check("RF001", ruff=None).result
+
+
+def test_toml_function():
+    pyproject = repo_review.testing.toml_loads("one.two = 3")
+    assert pyproject == {"one": {"two": 3}}