Comply with B ruff rules (#372)

* Comply with `B` ruff rules

* Refactor away shallow badge adding and removal functions
Add test for non-markdown README case.

* Add test for show sonarqube config case with no key

* Add test for readme interface adding badges

* Add test for indentation error hint in bitbucket CI yaml

Author: nathanjmcdougall

pyproject.toml

@@ -86,6 +86,7 @@ line-length = 88
 
 lint.select = [
   "A",
+  "B",
   "C4",
   "D",
   "E4",

src/usethis/_core/badge.py

@@ -33,14 +33,6 @@ def equivalent_to(self, other: Self) -> bool:
         return self.name == other.name
 
 
-RUFF_BADGE = Badge(
-    markdown="[![Ruff](<https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json>)](<https://github.com/astral-sh/ruff>)"
-)
-PRE_COMMIT_BADGE = Badge(
-    markdown="[![pre-commit](<https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit>)](<https://github.com/pre-commit/pre-commit>)"
-)
-
-
 def get_pypi_badge() -> Badge:
     try:
         name = get_name()
@@ -56,36 +48,24 @@ def get_pypi_badge() -> Badge:
     )
 
 
-def get_badge_order() -> list[Badge]:
-    return [
-        get_pypi_badge(),
-        RUFF_BADGE,
-        PRE_COMMIT_BADGE,
-    ]
-
-
-def add_pypi_badge():
-    add_badge(get_pypi_badge())
-
-
-def add_ruff_badge():
-    add_badge(RUFF_BADGE)
-
-
-def add_pre_commit_badge():
-    add_badge(PRE_COMMIT_BADGE)
-
-
-def remove_pypi_badge():
-    remove_badge(get_pypi_badge())
+def get_ruff_badge() -> Badge:
+    return Badge(
+        markdown="[![Ruff](<https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json>)](<https://github.com/astral-sh/ruff>)"
+    )
 
 
-def remove_ruff_badge():
-    remove_badge(RUFF_BADGE)
+def get_pre_commit_badge() -> Badge:
+    return Badge(
+        markdown="[![pre-commit](<https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit>)](<https://github.com/pre-commit/pre-commit>)"
+    )
 
 
-def remove_pre_commit_badge():
-    remove_badge(PRE_COMMIT_BADGE)
+def get_badge_order() -> list[Badge]:
+    return [
+        get_pypi_badge(),
+        get_ruff_badge(),
+        get_pre_commit_badge(),
+    ]
 
 
 def add_badge(badge: Badge) -> None:
@@ -95,7 +75,7 @@ def add_badge(badge: Badge) -> None:
         path = _get_markdown_readme_path()
     except FileNotFoundError as err:
         err_print(err)
-        raise typer.Exit(code=1)
+        raise typer.Exit(code=1) from None
 
     prerequisites: list[Badge] = []
     for _b in get_badge_order():

src/usethis/_core/show.py

@@ -23,4 +23,4 @@ def show_sonarqube_config() -> None:
         print(get_sonar_project_properties())
     except UsethisError as err:
         err_print(err)
-        raise typer.Exit(code=1)
+        raise typer.Exit(code=1) from None

src/usethis/_integrations/github/tags.py

@@ -28,7 +28,7 @@ def get_github_latest_tag(owner: str, repo: str) -> str:
         response.raise_for_status()  # Raise an error for HTTP issues
     except (requests.exceptions.HTTPError, requests.exceptions.ConnectionError) as err:
         msg = f"Failed to fetch tags from GitHub API: {err}"
-        raise GitHubTagError(msg)
+        raise GitHubTagError(msg) from None
 
     tags = response.json()
 

src/usethis/_integrations/pre_commit/hooks.py

@@ -71,7 +71,7 @@ def add_repo(repo: LocalRepo | UriRepo) -> None:
                 hook_idx = _HOOK_ORDER.index(hook_name)
             except ValueError:
                 msg = f"Hook '{hook_name}' not recognized"
-                raise NotImplementedError(msg)
+                raise NotImplementedError(msg) from None
             precedents = _HOOK_ORDER[:hook_idx]
 
             # Find the last of the precedents in the existing hooks

src/usethis/_integrations/pyproject_toml/core.py

@@ -41,7 +41,7 @@ def set_pyproject_value(
             toml_document=pyproject, id_keys=id_keys, value=value, exists_ok=exists_ok
         )
     except TOMLValueAlreadySetError as err:
-        raise PyprojectTOMLValueAlreadySetError(err)
+        raise PyprojectTOMLValueAlreadySetError(err) from None
 
     PyprojectTOMLManager().commit(pyproject)
 
@@ -58,7 +58,7 @@ def remove_pyproject_value(
         pyproject = remove_toml_value(toml_document=pyproject, id_keys=id_keys)
     except TOMLValueMissingError as err:
         if not missing_ok:
-            raise PyprojectTOMLValueMissingError(err)
+            raise PyprojectTOMLValueMissingError(err) from None
         # Otherwise, no changes are needed so skip the write step.
         return
     PyprojectTOMLManager().commit(pyproject)

src/usethis/_integrations/pyproject_toml/io_.py

@@ -91,7 +91,7 @@ def read_file(self) -> None:
             self._content = parse(self._path.read_text())
         except FileNotFoundError:
             msg = "'pyproject.toml' not found in the current directory."
-            raise PyprojectTOMLNotFoundError(msg)
+            raise PyprojectTOMLNotFoundError(msg) from None
         except TOMLKitError as err:
             msg = f"Failed to decode 'pyproject.toml': {err}"
             raise PyprojectTOMLDecodeError(msg) from None

src/usethis/_integrations/pyproject_toml/name.py

@@ -16,12 +16,12 @@ def get_name() -> str:
         name = TypeAdapter(str).validate_python(project_dict["name"])
     except KeyError:
         msg = "The 'project.name' value is missing from 'pyproject.toml'."
-        raise PyprojectTOMLProjectNameError(msg)
+        raise PyprojectTOMLProjectNameError(msg) from None
     except ValidationError as err:
         msg = (
             f"The 'project.name' value in 'pyproject.toml' is not a valid string: {err}"
         )
-        raise PyprojectTOMLProjectNameError(msg)
+        raise PyprojectTOMLProjectNameError(msg) from None
 
     return name
 
@@ -33,9 +33,9 @@ def get_description() -> str:
         description = TypeAdapter(str).validate_python(project_dict["description"])
     except KeyError:
         msg = "The 'project.description' value is missing from 'pyproject.toml'."
-        raise PyprojectTOMLProjectDescriptionError(msg)
+        raise PyprojectTOMLProjectDescriptionError(msg) from None
     except ValidationError as err:
         msg = f"The 'project.description' value in 'pyproject.toml' is not a valid string: {err}"
-        raise PyprojectTOMLProjectDescriptionError(msg)
+        raise PyprojectTOMLProjectDescriptionError(msg) from None
 
     return description

src/usethis/_integrations/pyproject_toml/project.py

@@ -20,9 +20,9 @@ def get_project_dict() -> dict[str, Any]:
         project = TypeAdapter(dict).validate_python(pyproject["project"])
     except KeyError:
         msg = "The 'project' section is missing from 'pyproject.toml'."
-        raise PyprojectTOMLProjectSectionError(msg)
+        raise PyprojectTOMLProjectSectionError(msg) from None
     except ValidationError as err:
         msg = f"The 'project' section in 'pyproject.toml' is not a valid map: {err}"
-        raise PyprojectTOMLProjectSectionError(msg)
+        raise PyprojectTOMLProjectSectionError(msg) from None
 
     return project

src/usethis/_integrations/pyproject_toml/requires_python.py

@@ -19,6 +19,6 @@ def get_requires_python() -> SpecifierSet:
         )
     except KeyError:
         msg = "The 'project.requires-python' value is missing from 'pyproject.toml'."
-        raise MissingRequiresPythonError(msg)
+        raise MissingRequiresPythonError(msg) from None
 
     return SpecifierSet(requires_python)

src/usethis/_integrations/sonarqube/config.py

@@ -36,7 +36,7 @@ def get_sonar_project_properties() -> str:
         )
     except (FileNotFoundError, KeyError):
         msg = "Could not find SonarQube project key at 'tool.usethis.sonarqube.project-key' in 'pyproject.toml'."
-        raise MissingProjectKeyError(msg)
+        raise MissingProjectKeyError(msg) from None
     _validate_project_key(project_key)
 
     try:
@@ -63,7 +63,7 @@ def get_sonar_project_properties() -> str:
         )
     except (FileNotFoundError, KeyError):
         msg = "XML coverage report file path not found at 'tool.coverage.xml.output' in 'pyproject.toml'."
-        raise CoverageReportConfigNotFoundError(msg)
+        raise CoverageReportConfigNotFoundError(msg) from None
 
     # No file, so construct the contents
     source_dir_str = get_source_dir_str()

src/usethis/_integrations/toml/core.py

@@ -100,7 +100,7 @@ def remove_toml_value(
             d = d[key]
     except KeyError:
         msg = f"Configuration value '{'.'.join(id_keys)}' is missing."
-        raise TOMLValueMissingError(msg)
+        raise TOMLValueMissingError(msg) from None
 
     # Remove the configuration.
     d = toml_document

src/usethis/_interface/badge.py

@@ -2,12 +2,11 @@
 
 from usethis._config import offline_opt, quiet_opt, usethis_config
 from usethis._core.badge import (
-    add_pre_commit_badge,
-    add_pypi_badge,
-    add_ruff_badge,
-    remove_pre_commit_badge,
-    remove_pypi_badge,
-    remove_ruff_badge,
+    add_badge,
+    get_pre_commit_badge,
+    get_pypi_badge,
+    get_ruff_badge,
+    remove_badge,
 )
 from usethis._integrations.pyproject_toml.io_ import PyprojectTOMLManager
 
@@ -29,9 +28,9 @@ def pypi(
         PyprojectTOMLManager(),
     ):
         if not remove:
-            add_pypi_badge()
+            add_badge(get_pypi_badge())
         else:
-            remove_pypi_badge()
+            remove_badge(get_pypi_badge())
 
 
 @app.command(help="Add a badge for the Ruff linter.")
@@ -45,9 +44,9 @@ def ruff(
         PyprojectTOMLManager(),
     ):
         if not remove:
-            add_ruff_badge()
+            add_badge(get_ruff_badge())
         else:
-            remove_ruff_badge()
+            remove_badge(get_ruff_badge())
 
 
 @app.command(help="Add a badge for the pre-commit framework.")
@@ -61,6 +60,6 @@ def pre_commit(
         PyprojectTOMLManager(),
     ):
         if not remove:
-            add_pre_commit_badge()
+            add_badge(get_pre_commit_badge())
         else:
-            remove_pre_commit_badge()
+            remove_badge(get_pre_commit_badge())

src/usethis/_interface/ci.py

@@ -28,4 +28,4 @@ def bitbucket(
 
         if "mapping values are not allowed here" in str(err):
             info_print("Hint: You may have incorrect indentation the YAML file.")
-        raise typer.Exit(code=1)
+        raise typer.Exit(code=1) from None

src/usethis/_interface/readme.py

@@ -3,7 +3,11 @@
 import typer
 
 from usethis._config import quiet_opt, usethis_config
-from usethis._core.badge import add_pre_commit_badge, add_ruff_badge
+from usethis._core.badge import (
+    add_badge,
+    get_pre_commit_badge,
+    get_ruff_badge,
+)
 from usethis._core.readme import add_readme
 from usethis._integrations.pyproject_toml.io_ import PyprojectTOMLManager
 from usethis._tool import PreCommitTool, RuffTool
@@ -18,7 +22,7 @@ def readme(
 
         if badges:
             if RuffTool().is_used():
-                add_ruff_badge()
+                add_badge(get_ruff_badge())
 
             if PreCommitTool().is_used():
-                add_pre_commit_badge()
+                add_badge(get_pre_commit_badge())

src/usethis/_interface/tool.py

@@ -181,7 +181,7 @@ def _run_tool(caller: UseToolFunc, *, remove: bool):
         caller(remove=remove)
     except UsethisError as err:
         err_print(err)
-        raise typer.Exit(code=1)
+        raise typer.Exit(code=1) from None
 
 
 ALL_TOOL_COMMANDS: list[str] = [

tests/usethis/_core/test_core_badge.py

@@ -1,13 +1,27 @@
 from pathlib import Path
 
 import pytest
+import typer
 
 from usethis._core.badge import Badge, add_badge, remove_badge
 from usethis._integrations.pyproject_toml.io_ import PyprojectTOMLManager
 from usethis._test import change_cwd
 
 
 class TestAddBadge:
+    def test_not_markdown(self, bare_dir: Path):
+        # Arrange
+        path = bare_dir / "README.foo"
+        path.touch()
+
+        # Act, Assert
+        with change_cwd(bare_dir), PyprojectTOMLManager(), pytest.raises(typer.Exit):
+            add_badge(
+                Badge(
+                    markdown="![Licence](<https://img.shields.io/badge/licence-mit-green>)",
+                )
+            )
+
     def test_empty(self, bare_dir: Path, capfd: pytest.CaptureFixture[str]):
         # Arrange
         path = bare_dir / "README.md"

tests/usethis/_interface/test_interface_ci.py

@@ -65,3 +65,26 @@ def test_maximal_config(self, tmp_path: Path):
             Path(__file__).parent / "maximal_bitbucket_pipelines.yml"
         ).read_text()
         assert (tmp_path / "bitbucket-pipelines.yml").read_text() == expected_yml
+
+    def test_incorrect_indentation(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "bitbucket-pipelines.yml").write_text("""\
+- path: / 
+    backend: 
+      serviceName: <service_name> 
+      servicePort: <port> 
+""")
+        # Use something like pre-commit so we try and modify the file
+        (tmp_path / ".pre-commit-config.yaml").touch()
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app)
+
+        # Assert
+        assert result.exit_code == 1, result.output
+        assert "mapping values are not allowed here" in result.output
+        assert (
+            "Hint: You may have incorrect indentation the YAML file." in result.output
+        )

tests/usethis/_interface/test_interface_readme.py

@@ -15,3 +15,23 @@ def test_runs(self, tmp_path: Path):
 
         # Assert
         assert result.exit_code == 0, result.output
+        # Check no badges have been added
+        assert "ruff" not in (tmp_path / "README.md").read_text()
+        assert "pre-commit" not in (tmp_path / "README.md").read_text()
+
+    def test_badges(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "ruff.toml").touch()
+        (tmp_path / ".pre-commit-config.yaml").touch()
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["readme", "--badges"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+        assert (tmp_path / "README.md").exists()
+        # and check the badges get created
+        assert "ruff" in (tmp_path / "README.md").read_text()
+        assert "pre-commit" in (tmp_path / "README.md").read_text()

tests/usethis/_interface/test_show.py

@@ -41,3 +41,15 @@ def test_runs(self, tmp_path: Path):
 
         # Assert
         assert result.exit_code == 0, result.output
+
+    def test_missing_key(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").touch()
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["sonarqube-config"])
+
+        # Assert
+        assert result.exit_code == 1, result.output