Refactor add_badges to reduce complexity

nathanjmcdougall · nathanjmcdougall · commit 1be42b119842 · 2025-04-04T17:44:12.000+13:00
Add tests for interfaces
diff --git a/src/usethis/_core/badge.py b/src/usethis/_core/badge.py
@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import re
+from dataclasses import dataclass
 from pathlib import Path
 from typing import TYPE_CHECKING
 
@@ -81,6 +82,33 @@ def get_badge_order() -> list[Badge]:
     ]
 
 
+@dataclass
+class MarkdownH1Status:
+    """A way of keeping track of whether we're in a block of H1 tags.
+
+    We don't want to add badges inside a block of H1 tags.
+    """
+
+    h1_count: int = 0
+    in_block: bool = False
+
+    def update_from_line(self, line: str) -> None:
+        self.h1_count += self._count_h1_open_tags(line)
+        self.in_block = self.h1_count > 0
+        self.h1_count -= self._count_h1_close_tags(line)
+
+    @staticmethod
+    def _count_h1_open_tags(line: str) -> int:
+        h1_start_match = re.match(r"(<h1\s.*>)", line)
+        if h1_start_match is not None:
+            return len(h1_start_match.groups())
+        return 0
+
+    @staticmethod
+    def _count_h1_close_tags(line: str) -> int:
+        return line.count("</h1>")
+
+
 def add_badge(badge: Badge) -> None:
     add_readme()
 
@@ -91,27 +119,28 @@ def add_badge(badge: Badge) -> None:
         print(badge.markdown)
         return
 
-    prerequisites: list[Badge] = []
-    for _b in get_badge_order():
-        if badge.equivalent_to(_b):
-            break
-        prerequisites.append(_b)
-
-    content = path.read_text(encoding="utf-8")
+    try:
+        content = path.read_text(encoding="utf-8")
+    except UnicodeDecodeError:
+        warn_print(
+            "README file uses an unsupported encoding, printing badge markdown instead..."
+        )
+        print(badge.markdown)
+        return
 
     original_lines = content.splitlines()
 
+    prerequisites = _get_prerequisites(badge)
+
     have_added = False
     have_encountered_badge = False
-    html_h1_count = 0
+    h1_status = MarkdownH1Status()
     lines: list[str] = []
     for original_line in original_lines:
         if is_badge(original_line):
             have_encountered_badge = True
 
-        html_h1_count += _count_h1_open_tags(original_line)
-        in_block = html_h1_count > 0
-        html_h1_count -= _count_h1_close_tags(original_line)
+        h1_status.update_from_line(original_line)
 
         original_badge = Badge(markdown=original_line)
 
@@ -126,7 +155,7 @@ def add_badge(badge: Badge) -> None:
             not original_line_is_prerequisite
             and (not is_blank(original_line) or have_encountered_badge)
             and not is_header(original_line)
-            and not in_block
+            and not h1_status.in_block
         ):
             lines.append(badge.markdown)
             have_added = True
@@ -160,6 +189,20 @@ def add_badge(badge: Badge) -> None:
     path.write_text(output, encoding="utf-8")
 
 
+def _get_prerequisites(badge: Badge) -> list[Badge]:
+    """Get the prerequisites for a badge.
+
+    We want to place the badges in a specific order, so we need to check if we've got
+    past those prerequisites.
+    """
+    prerequisites: list[Badge] = []
+    for _b in get_badge_order():
+        if badge.equivalent_to(_b):
+            break
+        prerequisites.append(_b)
+    return prerequisites
+
+
 def _get_markdown_readme_path() -> Path:
     path = get_readme_path()
 
@@ -196,17 +239,6 @@ def is_badge(line: str) -> bool:
     )
 
 
-def _count_h1_open_tags(line: str) -> int:
-    h1_start_match = re.match(r"(<h1\s.*>)", line)
-    if h1_start_match is not None:
-        return len(h1_start_match.groups())
-    return 0
-
-
-def _count_h1_close_tags(line: str) -> int:
-    return line.count("</h1>")
-
-
 def remove_badge(badge: Badge) -> None:
     path = Path.cwd() / "README.md"
 
diff --git a/src/usethis/_core/show.py b/src/usethis/_core/show.py
@@ -1,13 +1,9 @@
 from __future__ import annotations
 
-import typer
-
 from usethis._config import usethis_config
-from usethis._console import err_print
 from usethis._integrations.file.pyproject_toml.name import get_name
 from usethis._integrations.sonarqube.config import get_sonar_project_properties
 from usethis._integrations.uv.init import ensure_pyproject_toml
-from usethis.errors import UsethisError
 
 
 def show_name() -> None:
@@ -19,8 +15,4 @@ def show_name() -> None:
 def show_sonarqube_config() -> None:
     with usethis_config.set(quiet=True):
         ensure_pyproject_toml()
-    try:
-        print(get_sonar_project_properties())
-    except UsethisError as err:
-        err_print(err)
-        raise typer.Exit(code=1) from None
+    get_sonar_project_properties()
diff --git a/tests/usethis/_core/test_core_badge.py b/tests/usethis/_core/test_core_badge.py
@@ -539,6 +539,31 @@ def test_add_to_no_file_extension_readme(self, bare_dir: Path):
 """
         )
 
+    def test_wrong_readme_encoding(
+        self, bare_dir: Path, capfd: pytest.CaptureFixture[str]
+    ):
+        # Arrange
+        path = bare_dir / "README.md"
+        path.write_text(
+            """\
+# usethis
+""",
+            encoding="utf-16",
+        )
+
+        # Act
+        with change_cwd(bare_dir), PyprojectTOMLManager():
+            add_badge(
+                Badge(
+                    markdown="[![Ruff](https://example.com>)](<https://example.com)",
+                )
+            )
+
+        # Assert
+        out, err = capfd.readouterr()
+        assert not err
+        assert "encoding" in out
+
 
 class TestRemoveBadge:
     def test_empty(self, bare_dir: Path, capfd: pytest.CaptureFixture[str]):
diff --git a/tests/usethis/_interface/test_browse.py b/tests/usethis/_interface/test_browse.py
@@ -0,0 +1,29 @@
+from pathlib import Path
+
+from typer.testing import CliRunner
+
+from usethis._interface.browse import app
+from usethis._test import change_cwd
+
+
+class TestBrowse:
+    def test_success(self, tmp_path: Path):
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["usethis"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+
+    def test_missing_package_name(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, [])
+
+        # Assert
+        assert result.exit_code == 2, result.output
diff --git a/tests/usethis/_interface/test_docstyle.py b/tests/usethis/_interface/test_docstyle.py
@@ -2,7 +2,9 @@
 
 import pytest
 import typer
+from typer.testing import CliRunner
 
+from usethis._app import app
 from usethis._interface.docstyle import docstyle
 from usethis._test import change_cwd
 
@@ -18,3 +20,19 @@ def test_invalid_style(self, capfd: pytest.CaptureFixture[str]):
     def test_google_runs(self, tmp_path: Path):
         with change_cwd(tmp_path):
             docstyle("google")
+
+    def test_invalid_pyproject_toml(
+        self, tmp_path: Path, capfd: pytest.CaptureFixture[str]
+    ):
+        # Arrange
+        invalid_pyproject_toml = tmp_path / "pyproject.toml"
+        invalid_pyproject_toml.write_text("[")
+
+        # Act
+        with change_cwd(tmp_path):
+            runner = CliRunner()
+            with change_cwd(tmp_path):
+                result = runner.invoke(app, ["docstyle", "google"])
+
+        # Assert
+        assert result.exit_code == 1, result.output
diff --git a/tests/usethis/_interface/test_interface_badge.py b/tests/usethis/_interface/test_interface_badge.py
@@ -51,6 +51,18 @@ def test_remove(self, tmp_path: Path):
         # Assert
         assert result.exit_code == 0, result.output
 
+    def test_wrong_encoding(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "README.md").write_text("utf-8", encoding="utf-16")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["ruff"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+
 
 class TestPreCommit:
     def test_add(self, tmp_path: Path):
diff --git a/tests/usethis/_interface/test_interface_ci.py b/tests/usethis/_interface/test_interface_ci.py
@@ -65,3 +65,15 @@ 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_invalid_pyproject_toml(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("(")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app)
+
+        # Assert
+        assert result.exit_code == 1, result.output
diff --git a/tests/usethis/_interface/test_interface_readme.py b/tests/usethis/_interface/test_interface_readme.py
@@ -37,3 +37,15 @@ def test_badges(self, tmp_path: Path):
         assert "ruff" in (tmp_path / "README.md").read_text()
         assert "pre-commit" in (tmp_path / "README.md").read_text()
         assert "uv" in (tmp_path / "README.md").read_text()
+
+    def test_invalid_pyproject_toml(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("[")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["readme", "--badges"])
+
+        # Assert
+        assert result.exit_code == 1, result.output
diff --git a/tests/usethis/_interface/test_list.py b/tests/usethis/_interface/test_list.py
@@ -0,0 +1,30 @@
+from pathlib import Path
+
+from typer.testing import CliRunner
+
+from usethis._app import app
+from usethis._test import change_cwd
+
+
+class TestList:
+    def test_success(self, tmp_path: Path):
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["list"])
+
+        # Assert
+        assert result.exit_code == 0, result.output
+
+    def test_error(self, tmp_path: Path):
+        # Arrange
+        # Syntax error in pyproject.toml to trigger an error
+        (tmp_path / "pyproject.toml").write_text("[")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["list"])
+
+        # Assert
+        assert result.exit_code == 1, result.output
diff --git a/tests/usethis/_interface/test_show.py b/tests/usethis/_interface/test_show.py
@@ -21,6 +21,18 @@ def test_output(self, tmp_path: Path):
         assert result.exit_code == 0, result.output
         assert result.output == """fun\n"""
 
+    def test_invalid_pyproject(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("[")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["name"])
+
+        # Assert
+        assert result.exit_code == 1, result.output
+
 
 class TestSonarqube:
     def test_runs(self, tmp_path: Path):
@@ -53,3 +65,15 @@ def test_missing_key(self, tmp_path: Path):
 
         # Assert
         assert result.exit_code == 1, result.output
+
+    def test_invalid_pyproject(self, tmp_path: Path):
+        # Arrange
+        (tmp_path / "pyproject.toml").write_text("[")
+
+        # Act
+        runner = CliRunner()
+        with change_cwd(tmp_path):
+            result = runner.invoke(app, ["sonarqube"])
+
+        # Assert
+        assert result.exit_code == 1, result.output
