refactor(command_bump): use bump rules

bearomorphism · bearomorphism · commit be7cb23ba033 · 2025-05-18T04:24:22.000+08:00
diff --git a/commitizen/bump.py b/commitizen/bump.py
@@ -2,63 +2,20 @@
 
 import os
 import re
-from collections import OrderedDict
 from glob import iglob
 from logging import getLogger
 from string import Template
-from typing import cast
 
 from commitizen.defaults import MAJOR, MINOR, PATCH, bump_message, encoding
 from commitizen.exceptions import CurrentVersionNotFoundError
-from commitizen.git import GitCommit, smart_open
-from commitizen.version_schemes import Increment, Version
+from commitizen.git import smart_open
+from commitizen.version_schemes import Version
 
 VERSION_TYPES = [None, PATCH, MINOR, MAJOR]
 
 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:
- if isinstance(increments_map, dict):
- increments_map = OrderedDict(increments_map)
-
- # Most important cases are major and minor.
- # Everything else will be considered patch.
- select_pattern = re.compile(regex)
- increment: str | None = None
-
- for commit in commits:
- for message in commit.message.split("\n"):
- result = select_pattern.search(message)
-
- if result:
- found_keyword = result.group(1)
- new_increment = None
- for match_pattern in increments_map.keys():
- if re.match(match_pattern, found_keyword):
- new_increment = increments_map[match_pattern]
- break
-
- if new_increment is None:
- logger.debug(
- f"no increment needed for '{found_keyword}' in '{message}'"
- )
-
- if VERSION_TYPES.index(increment) < VERSION_TYPES.index(new_increment):
- logger.debug(
- f"increment detected is '{new_increment}' due to '{found_keyword}' in '{message}'"
- )
- increment = new_increment
-
- if increment == MAJOR:
- break
-
- return cast(Increment, increment)
-
-
 def update_version_in_files(
 current_version: str,
 new_version: str,
diff --git a/commitizen/bump_rule.py b/commitizen/bump_rule.py
@@ -48,6 +48,8 @@ def get_increment(
 
 class ConventionalCommitBumpRule(BumpRule):
 _PATCH_CHANGE_TYPES = set(["fix", "perf", "refactor"])
+ _BREAKING_CHANGE = r"BREAKING[\-\ ]CHANGE"
+ _RE_BREAKING_CHANGE = re.compile(_BREAKING_CHANGE)
 
 def get_increment(
 self, commit_message: str, major_version_zero: bool
@@ -56,8 +58,8 @@ def get_increment(
 return None
 
 change_type = m.group("change_type")
- if m.group("bang") or change_type == "BREAKING CHANGE":
- return "MAJOR" if major_version_zero else "MINOR"
+ if m.group("bang") or self._RE_BREAKING_CHANGE.match(change_type):
+ return "MINOR" if major_version_zero else "MAJOR"
 
 if change_type == "feat":
 return "MINOR"
@@ -70,7 +72,7 @@ def get_increment(
 @cached_property
 def _head_pattern(self) -> re.Pattern:
 change_types = [
- r"BREAKING[\-\ ]CHANGE",
+ self._BREAKING_CHANGE,
 "fix",
 "feat",
 "docs",
diff --git a/commitizen/commands/bump.py b/commitizen/commands/bump.py
@@ -7,7 +7,7 @@
 import questionary
 
 from commitizen import bump, factory, git, hooks, out
-from commitizen.bump_rule import find_increment_by_callable
+from commitizen.bump_rule import OldSchoolBumpRule, find_increment_by_callable
 from commitizen.changelog_formats import get_changelog_format
 from commitizen.commands.changelog import Changelog
 from commitizen.config import BaseConfig
@@ -124,27 +124,31 @@ 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"]
 
- 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
- else self.cz.bump_map
+ # Fallback to old school bump rule if no bump rule is provided
+ rule = self.cz.bump_rule or OldSchoolBumpRule(
+ *self._get_validated_cz_bump(),
+ )
+ return find_increment_by_callable(
+ (commit.message for commit in commits),
+ lambda x: rule.get_increment(x, is_major_version_zero),
 )
- bump_pattern = self.cz.bump_pattern
 
- if not bump_map or not bump_pattern:
+ def _get_validated_cz_bump(
+ self,
+ ) -> tuple[str, dict[str, Increment], dict[str, Increment]]:
+ """For fixing the type errors"""
+ bump_pattern = self.cz.bump_pattern
+ bump_map = self.cz.bump_map
+ bump_map_major_version_zero = self.cz.bump_map_major_version_zero
+ if not bump_pattern or not bump_map or not bump_map_major_version_zero:
 raise NoPatternMapError(
 f"'{self.config.settings['name']}' rule does not support bump"
 )
- increment = bump.find_increment(
- commits, regex=bump_pattern, increments_map=bump_map
+
+ return cast(
+ tuple[str, dict[str, Increment], dict[str, Increment]],
+ (bump_pattern, bump_map, bump_map_major_version_zero),
 )
- return increment
 
 def __call__(self) -> None: # noqa: C901
 """Steps executed to bump."""
diff --git a/tests/test_bump_find_increment.py b/tests/test_bump_find_increment.py
diff --git a/tests/test_bump_rule.py b/tests/test_bump_rule.py
@@ -39,12 +39,12 @@ def test_refactor_commit(self, bump_rule):
 assert bump_rule.get_increment("refactor: restructure code", True) == PATCH
 
 def test_breaking_change_with_bang(self, bump_rule):
- assert bump_rule.get_increment("feat!: breaking change", False) == MINOR
- assert bump_rule.get_increment("feat!: breaking change", True) == MAJOR
+ assert bump_rule.get_increment("feat!: breaking change", False) == MAJOR
+ assert bump_rule.get_increment("feat!: breaking change", True) == MINOR
 
 def test_breaking_change_type(self, bump_rule):
- assert bump_rule.get_increment("BREAKING CHANGE: major change", False) == MINOR
- assert bump_rule.get_increment("BREAKING CHANGE: major change", True) == MAJOR
+ assert bump_rule.get_increment("BREAKING CHANGE: major change", False) == MAJOR
+ assert bump_rule.get_increment("BREAKING CHANGE: major change", True) == MINOR
 
 def test_commit_with_scope(self, bump_rule):
 assert bump_rule.get_increment("feat(api): add new endpoint", False) == MINOR
@@ -72,25 +72,25 @@ def test_commit_with_complex_scopes(self, bump_rule):
 # Test with breaking changes and scopes
 assert (
 bump_rule.get_increment("feat(api)!: remove deprecated endpoints", False)
- == MINOR
+ == MAJOR
 )
 assert (
 bump_rule.get_increment("feat(api)!: remove deprecated endpoints", True)
- == MAJOR
+ == MINOR
 )
 
 # Test with BREAKING CHANGE and scopes
 assert (
 bump_rule.get_increment(
 "BREAKING CHANGE(api): remove deprecated endpoints", False
 )
- == MINOR
+ == MAJOR
 )
 assert (
 bump_rule.get_increment(
 "BREAKING CHANGE(api): remove deprecated endpoints", True
 )
- == MAJOR
+ == MINOR
 )
 
 def test_invalid_commit_message(self, bump_rule):
@@ -129,13 +129,13 @@ def test_breaking_change(self, get_increment):
 "feat: new feature",
 "feat!: breaking change",
 ]
- assert find_increment_by_callable(commit_messages, get_increment) == MINOR
+ assert find_increment_by_callable(commit_messages, get_increment) == MAJOR
 
 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
+ assert find_increment_by_callable(commit_messages, get_increment) == MAJOR
 
 def test_no_increment_needed(self, get_increment):
 commit_messages = [
@@ -159,7 +159,7 @@ def test_major_version_zero(self):
 find_increment_by_callable(
 commit_messages, lambda x: bump_rule.get_increment(x, True)
 )
- == MAJOR
+ == MINOR
 )
 
 def test_mixed_commit_types(self, get_increment):

-Original file line number
+Diff line change
 importos
 importre
 -fromcollectionsimportOrderedDict
 fromglobimportiglob
 fromloggingimportgetLogger
 fromstringimportTemplate
 -fromtypingimportcast
 fromcommitizen.defaultsimportMAJOR, MINOR, PATCH, bump_message, encoding
 fromcommitizen.exceptionsimportCurrentVersionNotFoundError
 -fromcommitizen.gitimportGitCommit, smart_open
 -fromcommitizen.version_schemesimportIncrement, Version
 +fromcommitizen.gitimportsmart_open
 +fromcommitizen.version_schemesimportVersion
 VERSION_TYPES= [None, PATCH, MINOR, MAJOR]
 logger=getLogger("commitizen")
 -# TODO: replace this with find_increment_by_callable?
 -deffind_increment(
 -commits: list[GitCommit], regex: str, increments_map: dict|OrderedDict
 -) ->Increment|None:
 -ifisinstance(increments_map, dict):
 -increments_map=OrderedDict(increments_map)
+-
 -# Most important cases are major and minor.
 -# Everything else will be considered patch.
 -select_pattern=re.compile(regex)
 -increment: str|None=None
+-
 -forcommitincommits:
 -formessageincommit.message.split("\n"):
 -result=select_pattern.search(message)
+-
 -ifresult:
 -found_keyword=result.group(1)
 -new_increment=None
 -formatch_patterninincrements_map.keys():
 -ifre.match(match_pattern, found_keyword):
 -new_increment=increments_map[match_pattern]
 -break
+-
 -ifnew_incrementisNone:
 -logger.debug(
 -f"no increment needed for '{found_keyword}' in '{message}'"
 - )
+-
 -ifVERSION_TYPES.index(increment) <VERSION_TYPES.index(new_increment):
 -logger.debug(
 -f"increment detected is '{new_increment}' due to '{found_keyword}' in '{message}'"
 - )
 -increment=new_increment
+-
 -ifincrement==MAJOR:
 -break
+-
 -returncast(Increment, increment)
+-
+-
 defupdate_version_in_files(
 current_version: str,
 new_version: str,
-Original file line number
+Diff line change
 classConventionalCommitBumpRule(BumpRule):
 _PATCH_CHANGE_TYPES=set(["fix", "perf", "refactor"])
 +_BREAKING_CHANGE=r"BREAKING[\-\ ]CHANGE"
 +_RE_BREAKING_CHANGE=re.compile(_BREAKING_CHANGE)
 defget_increment(
 self, commit_message: str, major_version_zero: bool
 returnNone
 change_type=m.group("change_type")
 -ifm.group("bang") orchange_type=="BREAKING CHANGE":
 -return"MAJOR"ifmajor_version_zeroelse"MINOR"
 +ifm.group("bang") orself._RE_BREAKING_CHANGE.match(change_type):
 +return"MINOR"ifmajor_version_zeroelse"MAJOR"
 ifchange_type=="feat":
 return"MINOR"
 @cached_property
 def_head_pattern(self) ->re.Pattern:
 change_types= [
 -r"BREAKING[\-\ ]CHANGE",
 +self._BREAKING_CHANGE,
 "fix",
 "feat",
 "docs",
-Original file line number
+Diff line change
 importquestionary
 fromcommitizenimportbump, factory, git, hooks, out
 -fromcommitizen.bump_ruleimportfind_increment_by_callable
 +fromcommitizen.bump_ruleimportOldSchoolBumpRule, find_increment_by_callable
 fromcommitizen.changelog_formatsimportget_changelog_format
 fromcommitizen.commands.changelogimportChangelog
 fromcommitizen.configimportBaseConfig
 # Update the bump map to ensure major version doesn't increment.
 is_major_version_zero: bool=self.bump_settings["major_version_zero"]
 -ifrule:=self.cz.bump_rule:
 -returnfind_increment_by_callable(
 - (commit.messageforcommitincommits),
 -lambdax: rule.get_increment(x, is_major_version_zero),
 - )
+-
 -bump_map= (
 -self.cz.bump_map_major_version_zero
 -ifis_major_version_zero
 -elseself.cz.bump_map
 +# Fallback to old school bump rule if no bump rule is provided
 +rule=self.cz.bump_ruleorOldSchoolBumpRule(
 +*self._get_validated_cz_bump(),
 + )
 +returnfind_increment_by_callable(
 + (commit.messageforcommitincommits),
 +lambdax: rule.get_increment(x, is_major_version_zero),
+ )
 -bump_pattern=self.cz.bump_pattern
 -ifnotbump_mapornotbump_pattern:
 +def_get_validated_cz_bump(
 +self,
 + ) ->tuple[str, dict[str, Increment], dict[str, Increment]]:
 +"""For fixing the type errors"""
 +bump_pattern=self.cz.bump_pattern
 +bump_map=self.cz.bump_map
 +bump_map_major_version_zero=self.cz.bump_map_major_version_zero
 +ifnotbump_patternornotbump_mapornotbump_map_major_version_zero:
 raiseNoPatternMapError(
 f"'{self.config.settings['name']}' rule does not support bump"
+ )
 -increment=bump.find_increment(
 -commits, regex=bump_pattern, increments_map=bump_map
++
 +returncast(
 +tuple[str, dict[str, Increment], dict[str, Increment]],
 + (bump_pattern, bump_map, bump_map_major_version_zero),
+ )
 -returnincrement
 def__call__(self) ->None: # noqa: C901
 """Steps executed to bump."""
-Original file line number
+Diff line change
 assertbump_rule.get_increment("refactor: restructure code", True) ==PATCH
 deftest_breaking_change_with_bang(self, bump_rule):
 -assertbump_rule.get_increment("feat!: breaking change", False) ==MINOR
 -assertbump_rule.get_increment("feat!: breaking change", True) ==MAJOR
 +assertbump_rule.get_increment("feat!: breaking change", False) ==MAJOR
 +assertbump_rule.get_increment("feat!: breaking change", True) ==MINOR
 deftest_breaking_change_type(self, bump_rule):
 -assertbump_rule.get_increment("BREAKING CHANGE: major change", False) ==MINOR
 -assertbump_rule.get_increment("BREAKING CHANGE: major change", True) ==MAJOR
 +assertbump_rule.get_increment("BREAKING CHANGE: major change", False) ==MAJOR
 +assertbump_rule.get_increment("BREAKING CHANGE: major change", True) ==MINOR
 deftest_commit_with_scope(self, bump_rule):
 assertbump_rule.get_increment("feat(api): add new endpoint", False) ==MINOR
 # Test with breaking changes and scopes
 assert (
 bump_rule.get_increment("feat(api)!: remove deprecated endpoints", False)
 -==MINOR
 +==MAJOR
+ )
 assert (
 bump_rule.get_increment("feat(api)!: remove deprecated endpoints", True)
 -==MAJOR
 +==MINOR
+ )
 # Test with BREAKING CHANGE and scopes
 assert (
 bump_rule.get_increment(
 "BREAKING CHANGE(api): remove deprecated endpoints", False
+ )
 -==MINOR
 +==MAJOR
+ )
 assert (
 bump_rule.get_increment(
 "BREAKING CHANGE(api): remove deprecated endpoints", True
+ )
 -==MAJOR
 +==MINOR
+ )
 deftest_invalid_commit_message(self, bump_rule):
 "feat: new feature",
 "feat!: breaking change",
+ ]
 -assertfind_increment_by_callable(commit_messages, get_increment) ==MINOR
 +assertfind_increment_by_callable(commit_messages, get_increment) ==MAJOR
 deftest_multi_line_commit(self, get_increment):
 commit_messages= [
 "feat: new feature\n\nBREAKING CHANGE: major change",
+ ]
 -assertfind_increment_by_callable(commit_messages, get_increment) ==MINOR
 +assertfind_increment_by_callable(commit_messages, get_increment) ==MAJOR
 deftest_no_increment_needed(self, get_increment):
 commit_messages= [
 find_increment_by_callable(
 commit_messages, lambdax: bump_rule.get_increment(x, True)
+ )
 -==MAJOR
 +==MINOR
+ )
 deftest_mixed_commit_types(self, get_increment):