Skip to content

Commit b1ec6b2

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

File tree

1 file changed

+46
-39
lines changed

1 file changed

+46
-39
lines changed

commitizen/bump.py

Lines changed: 46 additions & 39 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
@@ -75,36 +75,46 @@ def update_version_in_files(
7575
7676
Returns the list of updated files.
7777
"""
78-
# TODO: separate check step and write step
7978
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,
79+
80+
for path, pattern in _resolve_files_and_regexes(files, current_version):
81+
error = CurrentVersionNotFoundError(
82+
f"Current version {current_version} is not found in {path}.\n"
83+
"The version defined in commitizen configuration and the ones in "
84+
"version_files are possibly inconsistent."
85+
)
86+
error_on_not_found = (
87+
None if not check_consistency else lambda: (_ for _ in ()).throw(error)
8788
)
8889

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."
90+
def bump_line(line: str) -> str:
91+
return (
92+
line.replace(current_version, new_version)
93+
if pattern.search(line)
94+
else line
95+
)
96+
97+
with open(path, encoding=encoding) as file:
98+
bumped_version_file_content = _get_bumped_version_file_content(
99+
file,
100+
bump_line,
101+
error_on_not_found,
94102
)
95103

96104
# Write the file out again
97105
with smart_open(path, "w", encoding=encoding) as file:
98-
file.write(version_file)
106+
file.write(bumped_version_file_content)
99107
updated.append(path)
100108
return updated
101109

102110

103-
def _files_and_regexes(patterns: Iterable[str], version: str) -> list[tuple[str, str]]:
111+
def _resolve_files_and_regexes(
112+
patterns: Iterable[str], version: str
113+
) -> list[tuple[str, re.Pattern]]:
104114
"""
105115
Resolve all distinct files with their regexp from a list of glob patterns with optional regexp
106116
"""
107-
out: set[tuple[str, str]] = set()
117+
out: set[tuple[str, re.Pattern]] = set()
108118
for pattern in patterns:
109119
drive, tail = os.path.splitdrive(pattern)
110120
path, _, regex = tail.partition(":")
@@ -113,33 +123,30 @@ def _files_and_regexes(patterns: Iterable[str], version: str) -> list[tuple[str,
113123
regex = re.escape(version)
114124

115125
for file in iglob(filepath):
116-
out.add((file, regex))
126+
out.add((file, re.compile(regex)))
117127

118128
return sorted(out)
119129

120130

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]:
131+
def _get_bumped_version_file_content(
132+
version_file: TextIO,
133+
bump_line: Callable[[str], str],
134+
error_on_not_found: Callable[[], Never] | None,
135+
) -> str:
128136
current_version_found = False
129137
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)
138+
139+
for line in version_file:
140+
bumped_line = bump_line(line)
141+
if bumped_line != line:
142+
current_version_found = True
143+
144+
lines.append(bumped_line)
145+
146+
if error_on_not_found is not None and not current_version_found:
147+
error_on_not_found()
148+
149+
return "".join(lines)
143150

144151

145152
def create_commit_message(

0 commit comments

Comments
 (0)