feat: Support versions on random positions

Author: jaysonsantos

commitizen/bump.py

@@ -150,22 +150,31 @@ def update_version_in_files(
     """
     # TODO: separate check step and write step
     for location in files:
-        filepath, *regexes = location.split(":", maxsplit=1)
+        filepath, *regexes = location.split(":")
         regex = regexes[0] if regexes else None
+        after = regexes[1] if regexes[1:] else None
+        after_found = False
 
         # Read in the file
         file_content = []
         current_version_found = False
         with open(filepath, "r") as version_file:
             for line in version_file:
-                if regex:
+                if regex and (not after or after_found):
                     match = re.search(regex, line)
                     if not match:
                         file_content.append(line)
                         continue
+                if after:
+                    match = re.search(after, line)
+                    if match:
+                        file_content.append(line)
+                        after_found = True
+                        continue
 
                 # Replace the target string
-                if current_version in line:
+                if current_version in line and (not after or after_found):
+                    after_found = False  # Consume after otherwise next matches of regex will match
                     current_version_found = True
                     file_content.append(line.replace(current_version, new_version))
                 else:

tests/test_bump_update_version_in_files.py

@@ -1,3 +1,5 @@
+import re
+
 import pytest
 
 from commitizen import bump
@@ -33,6 +35,21 @@
 }
 """
 
+# The order cannot be guaranteed here
+CARGO_LOCK = """
+[[package]]
+name = "textwrap"
+version = "1.2.3"
+
+[[package]]
+name = "there-i-fixed-it"
+version = "1.2.3"
+
+[[package]]
+name = "other-project"
+version = "1.2.3"
+"""
+
 
 @pytest.fixture(scope="function")
 def commitizen_config_file(tmpdir):
@@ -55,6 +72,13 @@ def inconsistent_python_version_file(tmpdir):
     return str(tmp_file)
 
 
+@pytest.fixture(scope="function")
+def random_location_version_file(tmpdir):
+    tmp_file = tmpdir.join("Cargo.lock")
+    tmp_file.write(CARGO_LOCK)
+    return str(tmp_file)
+
+
 @pytest.fixture(scope="function")
 def version_repeated_file(tmpdir):
     tmp_file = tmpdir.join("package.json")
@@ -90,6 +114,19 @@ def test_partial_update_of_file(version_repeated_file):
         assert old_version in data
 
 
+def test_random_location(random_location_version_file):
+    old_version = "1.2.3"
+    new_version = "2.0.0"
+    regex = "version"
+    location = f"{random_location_version_file}:{regex}:there-i-fixed-it"
+
+    bump.update_version_in_files(old_version, new_version, [location])
+    with open(random_location_version_file, "r") as f:
+        data = f.read()
+        assert len(re.findall(old_version, data)) == 2
+        assert len(re.findall(new_version, data)) == 1
+
+
 def test_file_version_inconsistent_error(
     commitizen_config_file, inconsistent_python_version_file, version_repeated_file
 ):