refactor(bump_rule): add find_increment_by_callable

Author: bearomorphism

commitizen/bump.py

@@ -18,6 +18,7 @@
 logger = getLogger("commitizen")
 
 
+# TODO: replace this with find_increment_by_callable?
 def find_increment(
     commits: list[GitCommit], regex: str, increments_map: dict | OrderedDict
 ) -> Increment | None:

commitizen/bump_rule.py

@@ -2,10 +2,41 @@
 
 import re
 from functools import cached_property
-from typing import Protocol
+from typing import Callable, Protocol
 
 from commitizen.version_schemes import Increment
 
+_VERSION_ORDERING = dict(zip((None, "PATCH", "MINOR", "MAJOR"), range(4)))
+
+
+def find_increment_by_callable(
+    commit_messages: list[str], get_increment: Callable[[str], Increment | None]
+) -> Increment | None:
+    """Find the highest version increment from a list of messages.
+
+    This function processes a list of messages and determines the highest version
+    increment needed based on the commit messages. It splits multi-line commit messages
+    and evaluates each line using the provided get_increment callable.
+
+    Args:
+        commit_messages: A list of messages to analyze.
+        get_increment: A callable that takes a commit message string and returns an
+            Increment value (MAJOR, MINOR, PATCH) or None if no increment is needed.
+
+    Returns:
+        The highest version increment needed (MAJOR, MINOR, PATCH) or None if no
+        increment is needed. The order of precedence is MAJOR > MINOR > PATCH.
+
+    Example:
+        >>> commit_messages = ["feat: new feature", "fix: bug fix"]
+        >>> rule = DefaultBumpRule()
+        >>> find_increment_by_callable(commit_messages, lambda x: rule.get_increment(x, False))
+        'MINOR'
+    """
+    lines = (line for message in commit_messages for line in message.split("\n"))
+    increments = map(get_increment, lines)
+    return max(increments, key=lambda x: _VERSION_ORDERING[x], default=None)
+
 
 class BumpRule(Protocol):
     def get_increment(

tests/test_bump_rule.py

@@ -1,6 +1,6 @@
 import pytest
 
-from commitizen.bump_rule import DefaultBumpRule
+from commitizen.bump_rule import DefaultBumpRule, find_increment_by_callable
 from commitizen.defaults import MAJOR, MINOR, PATCH
 
 
@@ -93,3 +93,75 @@ def test_other_commit_types(self, bump_rule):
         assert bump_rule.get_increment("test: add unit tests", False) is None
         assert bump_rule.get_increment("build: update build config", False) is None
         assert bump_rule.get_increment("ci: update CI pipeline", False) is None
+
+
+class TestFindIncrementByCallable:
+    @pytest.fixture
+    def get_increment(self, bump_rule):
+        return lambda x: bump_rule.get_increment(x, False)
+
+    def test_single_commit(self, get_increment):
+        commit_messages = ["feat: add new feature"]
+        assert find_increment_by_callable(commit_messages, get_increment) == MINOR
+
+    def test_multiple_commits(self, get_increment):
+        commit_messages = [
+            "feat: new feature",
+            "fix: bug fix",
+            "docs: update readme",
+        ]
+        assert find_increment_by_callable(commit_messages, get_increment) == MINOR
+
+    def test_breaking_change(self, get_increment):
+        commit_messages = [
+            "feat: new feature",
+            "feat!: breaking change",
+        ]
+        assert find_increment_by_callable(commit_messages, get_increment) == MINOR
+
+    def test_multi_line_commit(self, get_increment):
+        commit_messages = [
+            "feat: new feature\n\nBREAKING CHANGE: major change",
+        ]
+        assert find_increment_by_callable(commit_messages, get_increment) == MINOR
+
+    def test_no_increment_needed(self, get_increment):
+        commit_messages = [
+            "docs: update documentation",
+            "style: format code",
+        ]
+        assert find_increment_by_callable(commit_messages, get_increment) is None
+
+    def test_empty_commits(self, get_increment):
+        commit_messages = []
+        assert find_increment_by_callable(commit_messages, get_increment) is None
+
+    def test_major_version_zero(self):
+        bump_rule = DefaultBumpRule()
+
+        commit_messages = [
+            "feat!: breaking change",
+            "BREAKING CHANGE: major change",
+        ]
+        assert (
+            find_increment_by_callable(
+                commit_messages, lambda x: bump_rule.get_increment(x, True)
+            )
+            == MAJOR
+        )
+
+    def test_mixed_commit_types(self, get_increment):
+        commit_messages = [
+            "feat: new feature",
+            "fix: bug fix",
+            "perf: improve performance",
+            "refactor: restructure code",
+        ]
+        assert find_increment_by_callable(commit_messages, get_increment) == MINOR
+
+    def test_commit_with_scope(self, get_increment):
+        commit_messages = [
+            "feat(api): add new endpoint",
+            "fix(ui): fix button alignment",
+        ]
+        assert find_increment_by_callable(commit_messages, get_increment) == MINOR