Skip to content

Commit 3df1f8f

Browse files
committed
refactor(bump): cleanup related to update_version_file
1 parent cc981fc commit 3df1f8f

File tree

1 file changed

+41
-38
lines changed

1 file changed

+41
-38
lines changed

commitizen/bump.py

Lines changed: 41 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
import os
44
import re
55
from collections import OrderedDict
6-
from collections.abc import Iterable
6+
from collections.abc import Callable, Iterable
77
from glob import iglob
88
from logging import getLogger
99
from string import Template
10-
from typing import cast
10+
from typing import Never, TextIO, cast
1111

1212
from commitizen.defaults import BUMP_MESSAGE, ENCODING, MAJOR, MINOR, PATCH
1313
from commitizen.exceptions import CurrentVersionNotFoundError
@@ -77,34 +77,40 @@ def update_version_in_files(
7777
"""
7878
# TODO: separate check step and write step
7979
updated = []
80-
for path, regex in _files_and_regexes(files, current_version):
81-
current_version_found, version_file = _bump_with_regex(
82-
path,
83-
current_version,
84-
new_version,
85-
regex,
86-
encoding=encoding,
80+
81+
for path, pattern in _resolve_files_and_regexes(files, current_version):
82+
error = CurrentVersionNotFoundError(
83+
f"Current version {current_version} is not found in {path}.\n"
84+
"The version defined in commitizen configuration and the ones in "
85+
"version_files are possibly inconsistent."
86+
)
87+
error_on_not_found = (
88+
None if not check_consistency else lambda: (_ for _ in ()).throw(error)
8789
)
8890

89-
if check_consistency and not current_version_found:
90-
raise CurrentVersionNotFoundError(
91-
f"Current version {current_version} is not found in {path}.\n"
92-
"The version defined in commitizen configuration and the ones in "
93-
"version_files are possibly inconsistent."
91+
with open(path, encoding=encoding) as file:
92+
bumped_version_file_content = _bump_line_by_line(
93+
file,
94+
lambda line: line.replace(current_version, new_version)
95+
if pattern.search(line)
96+
else line,
97+
error_on_not_found,
9498
)
9599

96100
# Write the file out again
97101
with smart_open(path, "w", encoding=encoding) as file:
98-
file.write(version_file)
102+
file.write(bumped_version_file_content)
99103
updated.append(path)
100104
return updated
101105

102106

103-
def _files_and_regexes(patterns: Iterable[str], version: str) -> list[tuple[str, str]]:
107+
def _resolve_files_and_regexes(
108+
patterns: Iterable[str], version: str
109+
) -> list[tuple[str, re.Pattern]]:
104110
"""
105111
Resolve all distinct files with their regexp from a list of glob patterns with optional regexp
106112
"""
107-
out: set[tuple[str, str]] = set()
113+
out: set[tuple[str, re.Pattern]] = set()
108114
for pattern in patterns:
109115
drive, tail = os.path.splitdrive(pattern)
110116
path, _, regex = tail.partition(":")
@@ -113,33 +119,30 @@ def _files_and_regexes(patterns: Iterable[str], version: str) -> list[tuple[str,
113119
regex = re.escape(version)
114120

115121
for file in iglob(filepath):
116-
out.add((file, regex))
122+
out.add((file, re.compile(regex)))
117123

118124
return sorted(out)
119125

120126

121-
def _bump_with_regex(
122-
version_filepath: str,
123-
current_version: str,
124-
new_version: str,
125-
regex: str,
126-
encoding: str = ENCODING,
127-
) -> tuple[bool, str]:
127+
def _bump_line_by_line(
128+
version_file: TextIO,
129+
bump_line: Callable[[str], str],
130+
error_on_not_found: Callable[[], Never] | None,
131+
) -> str:
128132
current_version_found = False
129133
lines = []
130-
pattern = re.compile(regex)
131-
with open(version_filepath, encoding=encoding) as f:
132-
for line in f:
133-
if not pattern.search(line):
134-
lines.append(line)
135-
continue
136-
137-
bumped_line = line.replace(current_version, new_version)
138-
if bumped_line != line:
139-
current_version_found = True
140-
lines.append(bumped_line)
141-
142-
return current_version_found, "".join(lines)
134+
135+
for line in version_file:
136+
bumped_line = bump_line(line)
137+
if bumped_line != line:
138+
current_version_found = True
139+
140+
lines.append(bumped_line)
141+
142+
if error_on_not_found is not None and not current_version_found:
143+
error_on_not_found()
144+
145+
return "".join(lines)
143146

144147

145148
def create_commit_message(

0 commit comments

Comments
 (0)