refactor(bump_rule): deprecate wip

Author: bearomorphism

commitizen/bump_rule.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import re
+from collections.abc import Iterable
 from functools import cached_property
 from typing import Callable, Protocol
 
@@ -10,7 +11,7 @@
 
 
 def find_increment_by_callable(
-    commit_messages: list[str], get_increment: Callable[[str], Increment | None]
+    commit_messages: Iterable[str], get_increment: Callable[[str], Increment | None]
 ) -> Increment | None:
     """Find the highest version increment from a list of messages.
 
@@ -29,7 +30,7 @@ def find_increment_by_callable(
 
     Example:
         >>> commit_messages = ["feat: new feature", "fix: bug fix"]
-        >>> rule = DefaultBumpRule()
+        >>> rule = ConventionalCommitBumpRule()
         >>> find_increment_by_callable(commit_messages, lambda x: rule.get_increment(x, False))
         'MINOR'
     """
@@ -44,7 +45,7 @@ def get_increment(
     ) -> Increment | None: ...
 
 
-class DefaultBumpRule(BumpRule):
+class ConventionalCommitBumpRule(BumpRule):
     _PATCH_CHANGE_TYPES = set(["fix", "perf", "refactor"])
 
     def get_increment(
@@ -85,10 +86,4 @@ def _head_pattern(self) -> re.Pattern:
         return re.compile(f"^{re_change_type}{re_scope}{re_bang}:")
 
 
-class CustomBumpRule(BumpRule):
-    """TODO: Implement"""
-
-    def get_increment(
-        self, commit_message: str, major_version_zero: bool
-    ) -> Increment | None:
-        return None
+# TODO: Implement CustomBumpRule

commitizen/commands/bump.py

@@ -7,6 +7,7 @@
 import questionary
 
 from commitizen import bump, factory, git, hooks, out
+from commitizen.bump_rule import find_increment_by_callable
 from commitizen.changelog_formats import get_changelog_format
 from commitizen.commands.changelog import Changelog
 from commitizen.config import BaseConfig
@@ -122,7 +123,13 @@ def is_initial_tag(
     def find_increment(self, commits: list[git.GitCommit]) -> Increment | None:
         # Update the bump map to ensure major version doesn't increment.
         is_major_version_zero: bool = self.bump_settings["major_version_zero"]
-        # self.cz.bump_map = defaults.bump_map_major_version_zero
+
+        if rule := self.cz.bump_rule:
+            return find_increment_by_callable(
+                (commit.message for commit in commits),
+                lambda x: rule.get_increment(x, is_major_version_zero),
+            )
+
         bump_map = (
             self.cz.bump_map_major_version_zero
             if is_major_version_zero

commitizen/cz/base.py

@@ -8,6 +8,7 @@
 from prompt_toolkit.styles import Style, merge_styles
 
 from commitizen import git
+from commitizen.bump_rule import BumpRule
 from commitizen.config.base_config import BaseConfig
 from commitizen.defaults import Questions
 
@@ -25,9 +26,13 @@ def __call__(
 
 
 class BaseCommitizen(metaclass=ABCMeta):
+    bump_rule: BumpRule | None = None
+
+    # TODO: deprecate these
     bump_pattern: str | None = None
     bump_map: dict[str, str] | None = None
     bump_map_major_version_zero: dict[str, str] | None = None
+
     default_style_config: list[tuple[str, str]] = [
         ("qmark", "fg:#ff9d00 bold"),
         ("question", "bold"),

commitizen/cz/conventional_commits/conventional_commits.py

@@ -2,6 +2,7 @@
 import re
 
 from commitizen import defaults
+from commitizen.bump_rule import ConventionalCommitBumpRule
 from commitizen.cz.base import BaseCommitizen
 from commitizen.cz.utils import multiple_line_breaker, required_validator
 from commitizen.defaults import Questions
@@ -28,6 +29,8 @@ def parse_subject(text):
 
 
 class ConventionalCommitsCz(BaseCommitizen):
+    bump_rule = ConventionalCommitBumpRule()
+
     bump_pattern = defaults.BUMP_PATTERN
     bump_map = defaults.BUMP_MAP
     bump_map_major_version_zero = defaults.BUMP_MAP_MAJOR_VERSION_ZERO

tests/test_bump_rule.py

@@ -1,15 +1,15 @@
 import pytest
 
-from commitizen.bump_rule import DefaultBumpRule, find_increment_by_callable
+from commitizen.bump_rule import ConventionalCommitBumpRule, find_increment_by_callable
 from commitizen.defaults import MAJOR, MINOR, PATCH
 
 
 @pytest.fixture
 def bump_rule():
-    return DefaultBumpRule()
+    return ConventionalCommitBumpRule()
 
 
-class TestDefaultBumpRule:
+class TestConventionalCommitBumpRule:
     def test_feat_commit(self, bump_rule):
         assert bump_rule.get_increment("feat: add new feature", False) == MINOR
         assert bump_rule.get_increment("feat: add new feature", True) == MINOR
@@ -137,7 +137,7 @@ def test_empty_commits(self, get_increment):
         assert find_increment_by_callable(commit_messages, get_increment) is None
 
     def test_major_version_zero(self):
-        bump_rule = DefaultBumpRule()
+        bump_rule = ConventionalCommitBumpRule()
 
         commit_messages = [
             "feat!: breaking change",