Extracted log_changes function from ConfiguredFile !minor

Author: coordt

bumpversion/files.py

@@ -61,6 +61,35 @@ def contains_pattern(search: re.Pattern, contents: str) -> bool:
     return False
 
 
+def log_changes(file_path: str, file_content_before: str, file_content_after: str, dry_run: bool = False) -> None:
+    """
+    Log the changes that would be made to the file.
+
+    Args:
+        file_path: The path to the file
+        file_content_before: The file contents before the change
+        file_content_after: The file contents after the change
+        dry_run: True if this is a report-only job
+    """
+    if file_content_before != file_content_after:
+        logger.info("%s file %s:", "Would change" if dry_run else "Changing", file_path)
+        logger.info(
+            "\n".join(
+                list(
+                    context_diff(
+                        file_content_before.splitlines(),
+                        file_content_after.splitlines(),
+                        fromfile=f"before {file_path}",
+                        tofile=f"after {file_path}",
+                        lineterm="",
+                    )
+                )
+            )
+        )
+    else:
+        logger.info("%s file %s", "Would not change" if dry_run else "Not changing", file_path)
+
+
 class ConfiguredFile:
     """A file to modify in a configured way."""
 
@@ -156,23 +185,7 @@ def replace_version(
             search_for_og, og_raw_search_pattern = get_search_pattern(self.search, og_context, self.regex)
             file_content_after = search_for_og.sub(replace_with, file_content_before)
 
-        if file_content_before != file_content_after:
-            logger.info("%s file %s:", "Would change" if dry_run else "Changing", self.path)
-            logger.info(
-                "\n".join(
-                    list(
-                        context_diff(
-                            file_content_before.splitlines(),
-                            file_content_after.splitlines(),
-                            fromfile=f"before {self.path}",
-                            tofile=f"after {self.path}",
-                            lineterm="",
-                        )
-                    )
-                )
-            )
-        else:
-            logger.info("%s file %s", "Would not change" if dry_run else "Not changing", self.path)
+        log_changes(self.path, file_content_before, file_content_after, dry_run)
 
         if not dry_run:  # pragma: no-coverage
             self.write_file_contents(file_content_after)

tests/fixtures/file_config_overrides.toml

@@ -0,0 +1,31 @@
+[tool.bumpversion]
+current_version = "0.0.1"
+ignore_missing_version = true
+regex = true
+
+[[tool.bumpversion.files]]
+filename = "should_contain_defaults.txt"
+
+[[tool.bumpversion.files]]
+filename = "should_override_search.txt"
+search = "**unreleased**"
+
+[[tool.bumpversion.files]]
+filename = "should_override_replace.txt"
+replace = "**unreleased**"
+
+[[tool.bumpversion.files]]
+filename = "should_override_parse.txt"
+parse = "version(?P<major>\\d+)"
+
+[[tool.bumpversion.files]]
+filename = "should_override_serialize.txt"
+serialize = ["{major}"]
+
+[[tool.bumpversion.files]]
+filename = "should_override_ignore_missing.txt"
+ignore_missing_version = false
+
+[[tool.bumpversion.files]]
+filename = "should_override_regex.txt"
+regex = false

tests/test_config.py

@@ -274,3 +274,58 @@ def test_get_glob_files(glob_pattern: str, file_list: set, fixtures_path: Path):
     assert len(result) == len(file_list)
     for f in result:
         assert Path(f.filename) in file_list
+
+
+def test_file_overrides_config(fixtures_path: Path):
+    """If a file has a different config, it should override the main config."""
+    cfg_file = fixtures_path / "file_config_overrides.toml"
+    conf = config.get_configuration(cfg_file)
+    file_map = {f.filename: f for f in conf.files}
+    assert file_map["should_contain_defaults.txt"].parse == conf.parse
+    assert file_map["should_contain_defaults.txt"].serialize == conf.serialize
+    assert file_map["should_contain_defaults.txt"].search == conf.search
+    assert file_map["should_contain_defaults.txt"].replace == conf.replace
+    assert file_map["should_contain_defaults.txt"].regex == conf.regex
+    assert file_map["should_contain_defaults.txt"].ignore_missing_version == conf.ignore_missing_version
+
+    assert file_map["should_override_search.txt"].parse == conf.parse
+    assert file_map["should_override_search.txt"].serialize == conf.serialize
+    assert file_map["should_override_search.txt"].search == "**unreleased**"
+    assert file_map["should_override_search.txt"].replace == conf.replace
+    assert file_map["should_override_search.txt"].regex == conf.regex
+    assert file_map["should_override_search.txt"].ignore_missing_version == conf.ignore_missing_version
+
+    assert file_map["should_override_replace.txt"].parse == conf.parse
+    assert file_map["should_override_replace.txt"].serialize == conf.serialize
+    assert file_map["should_override_replace.txt"].search == conf.search
+    assert file_map["should_override_replace.txt"].replace == "**unreleased**"
+    assert file_map["should_override_replace.txt"].regex == conf.regex
+    assert file_map["should_override_replace.txt"].ignore_missing_version == conf.ignore_missing_version
+
+    assert file_map["should_override_parse.txt"].parse == "version(?P<major>\d+)"
+    assert file_map["should_override_parse.txt"].serialize == conf.serialize
+    assert file_map["should_override_parse.txt"].search == conf.search
+    assert file_map["should_override_parse.txt"].replace == conf.replace
+    assert file_map["should_override_parse.txt"].regex == conf.regex
+    assert file_map["should_override_parse.txt"].ignore_missing_version == conf.ignore_missing_version
+
+    assert file_map["should_override_serialize.txt"].parse == conf.parse
+    assert file_map["should_override_serialize.txt"].serialize == ["{major}"]
+    assert file_map["should_override_serialize.txt"].search == conf.search
+    assert file_map["should_override_serialize.txt"].replace == conf.replace
+    assert file_map["should_override_serialize.txt"].regex == conf.regex
+    assert file_map["should_override_serialize.txt"].ignore_missing_version == conf.ignore_missing_version
+
+    assert file_map["should_override_ignore_missing.txt"].parse == conf.parse
+    assert file_map["should_override_ignore_missing.txt"].serialize == conf.serialize
+    assert file_map["should_override_ignore_missing.txt"].search == conf.search
+    assert file_map["should_override_ignore_missing.txt"].replace == conf.replace
+    assert file_map["should_override_ignore_missing.txt"].regex == conf.regex
+    assert file_map["should_override_ignore_missing.txt"].ignore_missing_version is False
+
+    assert file_map["should_override_regex.txt"].parse == conf.parse
+    assert file_map["should_override_regex.txt"].serialize == conf.serialize
+    assert file_map["should_override_regex.txt"].search == conf.search
+    assert file_map["should_override_regex.txt"].replace == conf.replace
+    assert file_map["should_override_regex.txt"].regex is False
+    assert file_map["should_override_regex.txt"].ignore_missing_version == conf.ignore_missing_version