fix(dependencies): do not display unchanged additional dependencies

Author: noirbizarre

src/sync_pre_commit_lock/pdm_plugin.py

@@ -91,7 +91,7 @@ def _format_repo(self, package: str, old: PreCommitRepo, new: PreCommitRepo) ->
         return [repo, *hooks] if hooks else [repo]
 
     def _format_hook(self, old: PreCommitHook, new: PreCommitHook, last: bool) -> Sequence[Sequence[str]]:
-        if not (nb_deps := len(old.additional_dependencies)):
+        if not len(old.additional_dependencies):
             return []
         hook = (
             f"[info]{self.plugin_prefix}[/info]",
@@ -100,9 +100,14 @@ def _format_hook(self, old: PreCommitHook, new: PreCommitHook, last: bool) -> Se
             "",
             "",
         )
+        pairs = [
+            (old_dep, new_dep)
+            for old_dep, new_dep in zip(old.additional_dependencies, new.additional_dependencies)
+            if old_dep != new_dep
+        ]
         dependencies = [
-            self._format_additional_dependency(old_dep, new_dep, " " if last else "│", idx + 1 == nb_deps)
-            for idx, (old_dep, new_dep) in enumerate(zip(old.additional_dependencies, new.additional_dependencies))
+            self._format_additional_dependency(old_dep, new_dep, " " if last else "│", idx + 1 == len(pairs))
+            for idx, (old_dep, new_dep) in enumerate(pairs)
         ]
         return (hook, *dependencies)
 

src/sync_pre_commit_lock/poetry_plugin.py

@@ -9,6 +9,7 @@
 from cleo.exceptions import CleoValueError
 from cleo.helpers import option
 from cleo.io.outputs.output import Verbosity
+from cleo.ui.table_style import TableStyle
 from packaging.requirements import Requirement
 from poetry.__version__ import __version__ as poetry_version
 from poetry.console.application import Application
@@ -35,6 +36,16 @@
     from sync_pre_commit_lock.pre_commit_config import PreCommitHook, PreCommitRepo
 
 
+very_compact_style = (
+    TableStyle()
+    .set_horizontal_border_chars("")
+    .set_vertical_border_chars("", " ")
+    .set_default_crossing_char("")
+    .set_cell_row_content_format("{}")
+)
+"""A compact style without outside borders"""
+
+
 class PoetryPrinter(Printer):
     success_list_token: str = "<fg=green;options=bold>•</>"  # noqa: S105
 
@@ -60,7 +71,7 @@ def success(self, msg: str) -> None:
     def list_updated_packages(self, packages: dict[str, tuple[PreCommitRepo, PreCommitRepo]]) -> None:
         from cleo.ui.table import Table
 
-        table = Table(self.io, style="compact")
+        table = Table(self.io, style=very_compact_style)
 
         table.set_rows(
             [list(row) for package, (old, new) in packages.items() for row in self._format_repo(package, old, new)]
@@ -91,7 +102,7 @@ def _format_repo_url(self, old_repo_url: str, new_repo_url: str, package_name: s
         return url.replace(package_name, f"<c1>{package_name}</>")
 
     def _format_hook(self, old: PreCommitHook, new: PreCommitHook, last: bool) -> Sequence[Sequence[str]]:
-        if not (nb_deps := len(old.additional_dependencies)):
+        if not len(old.additional_dependencies):
             return []
         hook = (
             f"<info>{self.plugin_prefix}</>",
@@ -100,9 +111,14 @@ def _format_hook(self, old: PreCommitHook, new: PreCommitHook, last: bool) -> Se
             "",
             "",
         )
+        pairs = [
+            (old_dep, new_dep)
+            for old_dep, new_dep in zip(old.additional_dependencies, new.additional_dependencies)
+            if old_dep != new_dep
+        ]
         dependencies = [
-            self._format_additional_dependency(old_dep, new_dep, " " if last else "│", idx + 1 == nb_deps)
-            for idx, (old_dep, new_dep) in enumerate(zip(old.additional_dependencies, new.additional_dependencies))
+            self._format_additional_dependency(old_dep, new_dep, " " if last else "│", idx + 1 == len(pairs))
+            for idx, (old_dep, new_dep) in enumerate(pairs)
         ]
         return (hook, *dependencies)
 

tests/test_pdm/test_pdm_plugin.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 from pathlib import Path
+from textwrap import dedent
 from unittest import mock
 
 import pytest
@@ -78,6 +79,15 @@ def test_on_pdm_install_setup_pre_commit_success(project: Project) -> None:
     action_mock.execute.assert_called_once()
 
 
+def assert_output(out: str, expected: str):
+    __tracebackhide__ = True
+
+    # Invisible whitespace enfinf lines (table side effect)
+    out = "\n".join(line.rstrip() for line in out.splitlines())
+
+    assert out.strip() == dedent(expected).strip()
+
+
 def test_pdm_printer_list_success(capsys: pytest.CaptureFixture[str]) -> None:
     printer = PDMPrinter(UI())
 
@@ -91,7 +101,7 @@ def test_pdm_printer_list_success(capsys: pytest.CaptureFixture[str]) -> None:
     )
     captured = capsys.readouterr()
 
-    assert "[sync-pre-commit-lock]  ✔ https://repo1.local/test   rev1 -> rev2" in captured.out
+    assert_output(captured.out, "[sync-pre-commit-lock]  ✔ https://repo1.local/test   rev1 -> rev2")
 
 
 def test_pdm_printer_list_success_additional_dependency(capsys: pytest.CaptureFixture[str]) -> None:
@@ -107,9 +117,12 @@ def test_pdm_printer_list_success_additional_dependency(capsys: pytest.CaptureFi
     )
     captured = capsys.readouterr()
 
-    assert "[sync-pre-commit-lock]  ✔ https://repo1.local/test" in captured.out
-    assert "[sync-pre-commit-lock]    └ hook" in captured.out
-    assert "[sync-pre-commit-lock]      └ dep                    * -> 0.1.2" in captured.out
+    expected = """
+    [sync-pre-commit-lock]  ✔ https://repo1.local/test
+    [sync-pre-commit-lock]    └ hook
+    [sync-pre-commit-lock]      └ dep                    * -> 0.1.2
+    """
+    assert_output(captured.out, expected)
 
 
 def test_pdm_printer_list_success_repo_with_multiple_hooks_and_additional_dependency(
@@ -141,12 +154,15 @@ def test_pdm_printer_list_success_repo_with_multiple_hooks_and_additional_depend
     )
     captured = capsys.readouterr()
 
-    assert "[sync-pre-commit-lock]  ✔ https://repo1.local/test   rev1   -> rev2" in captured.out
-    assert "[sync-pre-commit-lock]    ├ 1st-hook" in captured.out
-    assert "[sync-pre-commit-lock]    │ └ other                  0.42   -> 3.4.5" in captured.out
-    assert "[sync-pre-commit-lock]    └ 2nd-hook" in captured.out
-    assert "[sync-pre-commit-lock]      ├ dep                    *      -> 0.1.2" in captured.out
-    assert "[sync-pre-commit-lock]      └ other                  >=0.42 -> 3.4.5" in captured.out
+    expected = """
+    [sync-pre-commit-lock]  ✔ https://repo1.local/test   rev1   -> rev2
+    [sync-pre-commit-lock]    ├ 1st-hook
+    [sync-pre-commit-lock]    │ └ other                  0.42   -> 3.4.5
+    [sync-pre-commit-lock]    └ 2nd-hook
+    [sync-pre-commit-lock]      ├ dep                    *      -> 0.1.2
+    [sync-pre-commit-lock]      └ other                  >=0.42 -> 3.4.5
+    """
+    assert_output(captured.out, expected)
 
 
 def test_pdm_printer_list_success_renamed_repository(capsys: pytest.CaptureFixture[str]) -> None:
@@ -162,4 +178,4 @@ def test_pdm_printer_list_success_renamed_repository(capsys: pytest.CaptureFixtu
     )
     captured = capsys.readouterr()
 
-    assert "[sync-pre-commit-lock]  ✔ https://{old -> new}.repo.local/test   rev1 -> rev2" in captured.out
+    assert_output(captured.out, "[sync-pre-commit-lock]  ✔ https://{old -> new}.repo.local/test   rev1 -> rev2")

tests/test_poetry/test_poetry_plugin.py

@@ -1,4 +1,5 @@
 import re
+from textwrap import dedent
 from unittest.mock import MagicMock, patch
 
 import pytest
@@ -107,6 +108,18 @@ def test_handle_post_command_application_none() -> None:
         pytest.fail("RuntimeError not raised")
 
 
+def assert_output(out: str, expected: str):
+    __tracebackhide__ = True
+
+    # Remove all <..> tags, as we don't have the real parser
+    out = re.sub(r"<[^>]*>", "", out)
+
+    # Invisible whitespace enfinf lines (table side effect)
+    out = "\n".join(line.rstrip() for line in out.splitlines())
+
+    assert out.strip() == dedent(expected).strip()
+
+
 def test_poetry_printer_list_success(capsys: pytest.CaptureFixture[str]) -> None:
     from cleo.io.inputs.input import Input
     from cleo.io.io import IO
@@ -131,10 +144,8 @@ def _write(message: str, new_line: bool = False):
         }
     )
     captured = capsys.readouterr()
-    # Remove all <..> tags, as we don't have the real parser
-    out = re.sub(r"<[^>]*>", "", captured.out)
 
-    assert "[sync-pre-commit-lock]  • https://repo1.local/test   rev1 -> rev2" in out
+    assert_output(captured.out, "[sync-pre-commit-lock]  • https://repo1.local/test   rev1 -> rev2")
 
 
 def test_poetry_printer_list_success_additional_dependency(capsys: pytest.CaptureFixture[str]) -> None:
@@ -161,12 +172,13 @@ def _write(message: str, new_line: bool = False):
         }
     )
     captured = capsys.readouterr()
-    # Remove all <..> tags, as we don't have the real parser
-    out = re.sub(r"<[^>]*>", "", captured.out)
 
-    assert "[sync-pre-commit-lock]  • https://repo1.local/test" in out
-    assert "[sync-pre-commit-lock]    └ hook" in out
-    assert "[sync-pre-commit-lock]      └ dep                    * -> 0.1.2" in out
+    expected = """
+    [sync-pre-commit-lock]  • https://repo1.local/test
+    [sync-pre-commit-lock]    └ hook
+    [sync-pre-commit-lock]      └ dep                    * -> 0.1.2
+    """
+    assert_output(captured.out, expected)
 
 
 def test_poetry_printer_list_success_with_multiple_hooks_and_additional_dependency(
@@ -209,15 +221,16 @@ def _write(message: str, new_line: bool = False):
         }
     )
     captured = capsys.readouterr()
-    # Remove all <..> tags, as we don't have the real parser
-    out = re.sub(r"<[^>]*>", "", captured.out)
 
-    assert "[sync-pre-commit-lock]  • https://repo1.local/test   rev1   -> rev2" in out
-    assert "[sync-pre-commit-lock]    ├ 1st-hook" in out
-    assert "[sync-pre-commit-lock]    │ └ other                  0.42   -> 3.4.5" in out
-    assert "[sync-pre-commit-lock]    └ 2nd-hook" in out
-    assert "[sync-pre-commit-lock]      ├ dep                    *      -> 0.1.2" in out
-    assert "[sync-pre-commit-lock]      └ other                  >=0.42 -> 3.4.5" in out
+    expected = """
+    [sync-pre-commit-lock]  • https://repo1.local/test   rev1   -> rev2
+    [sync-pre-commit-lock]    ├ 1st-hook
+    [sync-pre-commit-lock]    │ └ other                  0.42   -> 3.4.5
+    [sync-pre-commit-lock]    └ 2nd-hook
+    [sync-pre-commit-lock]      ├ dep                    *      -> 0.1.2
+    [sync-pre-commit-lock]      └ other                  >=0.42 -> 3.4.5
+    """
+    assert_output(captured.out, expected)
 
 
 def test_poetry_printer_list_success_renamed_repository(capsys: pytest.CaptureFixture[str]) -> None:
@@ -244,10 +257,8 @@ def _write(message: str, new_line: bool = False):
         }
     )
     captured = capsys.readouterr()
-    # Remove all <..> tags, as we don't have the real parser
-    out = re.sub(r"<[^>]*>", "", captured.out)
 
-    assert "[sync-pre-commit-lock]  • https://{old -> new}.repo.local/test   rev1 -> rev2" in out
+    assert_output(captured.out, "[sync-pre-commit-lock]  • https://{old -> new}.repo.local/test   rev1 -> rev2")
 
 
 def test_direct_command_invocation():