Refactor valid_bumps and invalid_bumps to include_bumps and exclude_bumps

coordt · coordt · commit 2df57cc05433 · 2024-06-13T09:09:19.000-05:00
The configuration parameters `valid_bumps` and `invalid_bumps` were renamed to `include_bumps` and `exclude_bumps` respectively. This new naming better denotes their function, and the changes were consistently applied across all related files and tests. Numerous fixture outputs were also updated to reflect these changes.
diff --git a/bumpversion/bump.py b/bumpversion/bump.py
@@ -98,8 +98,8 @@ def do_bump(
 
     if version_part:
         # filter the files that are not valid for this bump
-        configured_files = [file for file in configured_files if version_part in file.file_change.valid_bumps]
-        configured_files = [file for file in configured_files if version_part not in file.file_change.invalid_bumps]
+        configured_files = [file for file in configured_files if version_part in file.file_change.include_bumps]
+        configured_files = [file for file in configured_files if version_part not in file.file_change.exclude_bumps]
 
     modify_files(configured_files, version, next_version, ctx, dry_run)
     if config_file and config_file.suffix in {".cfg", ".ini"}:
diff --git a/bumpversion/config/models.py b/bumpversion/config/models.py
@@ -35,8 +35,8 @@ class FileChange(BaseModel):
     glob: Optional[str] = None  # Conflicts with filename. If both are specified, glob wins
     glob_exclude: Optional[tuple] = None
     key_path: Optional[str] = None  # If specified, and has an appropriate extension, will be treated as a data file
-    valid_bumps: Optional[tuple] = None
-    invalid_bumps: Optional[tuple] = None
+    include_bumps: Optional[tuple] = None
+    exclude_bumps: tuple = Field(default_factory=tuple)
 
     def __hash__(self):
         """Return a hash of the model."""
@@ -122,8 +122,7 @@ def add_files(self, filename: Union[str, List[str]]) -> None:
                     regex=self.regex,
                     ignore_missing_version=self.ignore_missing_version,
                     ignore_missing_file=self.ignore_missing_files,
-                    valid_bumps=tuple(self.parts.keys()),
-                    invalid_bumps=(),
+                    include_bumps=tuple(self.parts.keys()),
                 )
             )
         self.files = list(files)
diff --git a/bumpversion/config/utils.py b/bumpversion/config/utils.py
@@ -22,8 +22,7 @@ def get_all_file_configs(config_dict: dict) -> List[FileChange]:
         "ignore_missing_version": config_dict["ignore_missing_version"],
         "ignore_missing_file": config_dict["ignore_missing_files"],
         "regex": config_dict["regex"],
-        "valid_bumps": tuple(config_dict["parts"]),
-        "invalid_bumps": (),
+        "include_bumps": tuple(config_dict["parts"]),
     }
     files = [{k: v for k, v in filecfg.items() if v is not None} for filecfg in config_dict["files"]]
     for f in files:
diff --git a/bumpversion/files.py b/bumpversion/files.py
@@ -90,8 +90,8 @@ def __init__(
             filename=file_change.filename,
             glob=file_change.glob,
             key_path=file_change.key_path,
-            valid_bumps=file_change.valid_bumps,
-            invalid_bumps=file_change.invalid_bumps,
+            include_bumps=file_change.include_bumps,
+            exclude_bumps=file_change.exclude_bumps,
         )
         self.version_config = VersionConfig(
             self.file_change.parse,
diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
@@ -723,24 +723,24 @@ If `True`, don't fail if the version string to be replaced is not found in the f
 
 if `True`, don't fail if the configured file is missing.
 
-### valid_bumps
+### include_bumps
 
 ::: field-list
 
     required
     : No
     
     default
-    : all version parts
+    : all version components
     
     type
     : list of strings
 
-The `valid_bumps` file configuration allows you to control when this file is changed. When a `bump <version component>` command is issued, this file is changed only if the version component is in this list and not in [`invalid_bumps`](#invalid_bumps). The [parse](#parse) configuration defines version components.
+The `include_bumps` file configuration allows you to control when this file is changed by inclusion. Its alternative is the `exclude_bumps` configuration. When a `bump <version component>` command is issued, this file is changed only if the version component is in this list and not in [`exclude_bumps`](#exclude_bumps). The [parse](#parse) configuration defines version components.
 
-The default value, or an empty list, includes all version components.
+The default value, or an empty list, includes all version components. 
 
-### invalid_bumps
+### exclude_bumps
 
 ::: field-list
 
@@ -753,7 +753,7 @@ The default value, or an empty list, includes all version components.
      type
      : list of strings
 
-The `invalid_bumps` file configuration allows you to control when this file is changed by exclusion. When a `bump <version component>` command is issued, this file is only changed if the version component is *not in this list.* The [parse](#parse) configuration defines version components.
+The `exclude_bumps` file configuration allows you to control when this file is changed by exclusion. Its alternative is the `include_bumps` configuration.When a `bump <version component>` command is issued, this file is only changed if the version component is *not in this list.* The [parse](#parse) configuration defines version components.
 
 The default value does not exclude anything.
 
diff --git a/tests/fixtures/basic_cfg_expected.txt b/tests/fixtures/basic_cfg_expected.txt
@@ -3,48 +3,48 @@
  'commit_args': None,
  'current_version': '1.0.0',
  'excluded_paths': [],
- 'files': [{'filename': 'setup.py',
+ 'files': [{'exclude_bumps': (),
+            'filename': 'setup.py',
             'glob': None,
             'glob_exclude': None,
             'ignore_missing_file': False,
             'ignore_missing_version': False,
-            'invalid_bumps': (),
+            'include_bumps': ('major', 'minor', 'patch', 'release'),
             'key_path': None,
             'parse': '(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?',
             'regex': False,
             'replace': '{new_version}',
             'search': '{current_version}',
             'serialize': ('{major}.{minor}.{patch}-{release}',
-                          '{major}.{minor}.{patch}'),
-            'valid_bumps': ('major', 'minor', 'patch', 'release')},
-           {'filename': 'bumpversion/__init__.py',
+                          '{major}.{minor}.{patch}')},
+           {'exclude_bumps': (),
+            'filename': 'bumpversion/__init__.py',
             'glob': None,
             'glob_exclude': None,
             'ignore_missing_file': False,
             'ignore_missing_version': False,
-            'invalid_bumps': (),
+            'include_bumps': ('major', 'minor', 'patch', 'release'),
             'key_path': None,
             'parse': '(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?',
             'regex': False,
             'replace': '{new_version}',
             'search': '{current_version}',
             'serialize': ('{major}.{minor}.{patch}-{release}',
-                          '{major}.{minor}.{patch}'),
-            'valid_bumps': ('major', 'minor', 'patch', 'release')},
-           {'filename': 'CHANGELOG.md',
+                          '{major}.{minor}.{patch}')},
+           {'exclude_bumps': (),
+            'filename': 'CHANGELOG.md',
             'glob': None,
             'glob_exclude': None,
             'ignore_missing_file': False,
             'ignore_missing_version': False,
-            'invalid_bumps': (),
+            'include_bumps': ('major', 'minor', 'patch', 'release'),
             'key_path': None,
             'parse': '(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?',
             'regex': False,
             'replace': '**unreleased**\n**v{new_version}**',
             'search': '**unreleased**',
             'serialize': ('{major}.{minor}.{patch}-{release}',
-                          '{major}.{minor}.{patch}'),
-            'valid_bumps': ('major', 'minor', 'patch', 'release')}],
+                          '{major}.{minor}.{patch}')}],
  'ignore_missing_files': False,
  'ignore_missing_version': False,
  'included_paths': [],
diff --git a/tests/fixtures/basic_cfg_expected.yaml b/tests/fixtures/basic_cfg_expected.yaml
@@ -5,13 +5,18 @@ current_version: "1.0.0"
 excluded_paths:
 
 files:
-  - filename: "setup.py"
+  - exclude_bumps:
+
+    filename: "setup.py"
     glob: null
     glob_exclude: null
     ignore_missing_file: false
     ignore_missing_version: false
-    invalid_bumps:
-
+    include_bumps:
+      - "major"
+      - "minor"
+      - "patch"
+      - "release"
     key_path: null
     parse: "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?"
     regex: false
@@ -20,18 +25,18 @@ files:
     serialize:
       - "{major}.{minor}.{patch}-{release}"
       - "{major}.{minor}.{patch}"
-    valid_bumps:
-      - "major"
-      - "minor"
-      - "patch"
-      - "release"
-  - filename: "bumpversion/__init__.py"
+  - exclude_bumps:
+
+    filename: "bumpversion/__init__.py"
     glob: null
     glob_exclude: null
     ignore_missing_file: false
     ignore_missing_version: false
-    invalid_bumps:
-
+    include_bumps:
+      - "major"
+      - "minor"
+      - "patch"
+      - "release"
     key_path: null
     parse: "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?"
     regex: false
@@ -40,18 +45,18 @@ files:
     serialize:
       - "{major}.{minor}.{patch}-{release}"
       - "{major}.{minor}.{patch}"
-    valid_bumps:
-      - "major"
-      - "minor"
-      - "patch"
-      - "release"
-  - filename: "CHANGELOG.md"
+  - exclude_bumps:
+
+    filename: "CHANGELOG.md"
     glob: null
     glob_exclude: null
     ignore_missing_file: false
     ignore_missing_version: false
-    invalid_bumps:
-
+    include_bumps:
+      - "major"
+      - "minor"
+      - "patch"
+      - "release"
     key_path: null
     parse: "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?"
     regex: false
@@ -60,11 +65,6 @@ files:
     serialize:
       - "{major}.{minor}.{patch}-{release}"
       - "{major}.{minor}.{patch}"
-    valid_bumps:
-      - "major"
-      - "minor"
-      - "patch"
-      - "release"
 ignore_missing_files: false
 ignore_missing_version: false
 included_paths:
diff --git a/tests/fixtures/basic_cfg_expected_full.json b/tests/fixtures/basic_cfg_expected_full.json
@@ -6,12 +6,18 @@
   "excluded_paths": [],
   "files": [
     {
+      "exclude_bumps": [],
       "filename": "setup.py",
       "glob": null,
       "glob_exclude": null,
       "ignore_missing_file": false,
       "ignore_missing_version": false,
-      "invalid_bumps": [],
+      "include_bumps": [
+        "major",
+        "minor",
+        "patch",
+        "release"
+      ],
       "key_path": null,
       "parse": "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
       "regex": false,
@@ -20,21 +26,21 @@
       "serialize": [
         "{major}.{minor}.{patch}-{release}",
         "{major}.{minor}.{patch}"
-      ],
-      "valid_bumps": [
-        "major",
-        "minor",
-        "patch",
-        "release"
       ]
     },
     {
+      "exclude_bumps": [],
       "filename": "bumpversion/__init__.py",
       "glob": null,
       "glob_exclude": null,
       "ignore_missing_file": false,
       "ignore_missing_version": false,
-      "invalid_bumps": [],
+      "include_bumps": [
+        "major",
+        "minor",
+        "patch",
+        "release"
+      ],
       "key_path": null,
       "parse": "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
       "regex": false,
@@ -43,21 +49,21 @@
       "serialize": [
         "{major}.{minor}.{patch}-{release}",
         "{major}.{minor}.{patch}"
-      ],
-      "valid_bumps": [
-        "major",
-        "minor",
-        "patch",
-        "release"
       ]
     },
     {
+      "exclude_bumps": [],
       "filename": "CHANGELOG.md",
       "glob": null,
       "glob_exclude": null,
       "ignore_missing_file": false,
       "ignore_missing_version": false,
-      "invalid_bumps": [],
+      "include_bumps": [
+        "major",
+        "minor",
+        "patch",
+        "release"
+      ],
       "key_path": null,
       "parse": "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)(\\-(?P<release>[a-z]+))?",
       "regex": false,
@@ -66,12 +72,6 @@
       "serialize": [
         "{major}.{minor}.{patch}-{release}",
         "{major}.{minor}.{patch}"
-      ],
-      "valid_bumps": [
-        "major",
-        "minor",
-        "patch",
-        "release"
       ]
     }
   ],
diff --git a/tests/test_bump.py b/tests/test_bump.py
@@ -157,14 +157,14 @@ def test_passing_no_arguments_raises_error(self):
 
     @patch("bumpversion.files.modify_files")
     @patch("bumpversion.bump.update_config_file")
-    def test_includes_files_with_valid_bumps(self, mock_update_config_file, mock_modify_files):
-        """Files that have valid_bumps are included when those bumps happen."""
+    def test_includes_files_with_include_bumps(self, mock_update_config_file, mock_modify_files):
+        """Files that have include_bumps are included when those bumps happen."""
         # Arrange
         new_version = None
         config, version_config, current_version = get_config_data(
             {
                 "current_version": "1.2.3",
-                "files": [{"filename": "foo.txt", "valid_bumps": ["major", "minor"]}, {"filename": "bar.txt"}],
+                "files": [{"filename": "foo.txt", "include_bumps": ["major", "minor"]}, {"filename": "bar.txt"}],
             }
         )
         config.scm_info = SCMInfo()
@@ -184,14 +184,14 @@ def test_includes_files_with_valid_bumps(self, mock_update_config_file, mock_mod
 
     @patch("bumpversion.files.modify_files")
     @patch("bumpversion.bump.update_config_file")
-    def test_excludes_files_with_invalid_bumps(self, mock_update_config_file, mock_modify_files):
-        """Files that have invalid_bumps are excluded when those bumps happen."""
+    def test_excludes_files_with_exclude_bumps(self, mock_update_config_file, mock_modify_files):
+        """Files that have exclude_bumps are excluded when those bumps happen."""
         # Arrange
         new_version = None
         config, version_config, current_version = get_config_data(
             {
                 "current_version": "1.2.3",
-                "files": [{"filename": "foo.txt", "invalid_bumps": ["patch"]}, {"filename": "bar.txt"}],
+                "files": [{"filename": "foo.txt", "exclude_bumps": ["patch"]}, {"filename": "bar.txt"}],
             }
         )
         config.scm_info = SCMInfo()
diff --git a/tests/test_config/test_utils.py b/tests/test_config/test_utils.py
@@ -44,7 +44,7 @@ def test_uses_defaults_for_missing_keys(self, tmp_path: Path):
 
         for key in FileChange.model_fields.keys():
             global_key = key if key != "ignore_missing_file" else "ignore_missing_files"
-            variable_fields = ["filename", "glob", "key_path", "glob_exclude", "valid_bumps", "invalid_bumps"]
+            variable_fields = ["filename", "glob", "key_path", "glob_exclude", "include_bumps", "exclude_bumps"]
 
             if key not in variable_fields:
                 file_val = getattr(file_configs[0], key)

Original file line number	Diff line number	Diff line change
`@@ -157,14 +157,14 @@ def test_passing_no_arguments_raises_error(self):`
`157`	`157`
`158`	`158`	`@patch("bumpversion.files.modify_files")`
`159`	`159`	`@patch("bumpversion.bump.update_config_file")`
`160`		`- def test_includes_files_with_valid_bumps(self, mock_update_config_file, mock_modify_files):`
`161`		`- """Files that have valid_bumps are included when those bumps happen."""`
	`160`	`+ def test_includes_files_with_include_bumps(self, mock_update_config_file, mock_modify_files):`
	`161`	`+ """Files that have include_bumps are included when those bumps happen."""`
`162`	`162`	`# Arrange`
`163`	`163`	`new_version = None`
`164`	`164`	`config, version_config, current_version = get_config_data(`
`165`	`165`	`{`
`166`	`166`	`"current_version": "1.2.3",`
`167`		`- "files": [{"filename": "foo.txt", "valid_bumps": ["major", "minor"]}, {"filename": "bar.txt"}],`
	`167`	`+ "files": [{"filename": "foo.txt", "include_bumps": ["major", "minor"]}, {"filename": "bar.txt"}],`
`168`	`168`	`}`
`169`	`169`	`)`
`170`	`170`	`config.scm_info = SCMInfo()`
`@@ -184,14 +184,14 @@ def test_includes_files_with_valid_bumps(self, mock_update_config_file, mock_mod`
`184`	`184`
`185`	`185`	`@patch("bumpversion.files.modify_files")`
`186`	`186`	`@patch("bumpversion.bump.update_config_file")`
`187`		`- def test_excludes_files_with_invalid_bumps(self, mock_update_config_file, mock_modify_files):`
`188`		`- """Files that have invalid_bumps are excluded when those bumps happen."""`
	`187`	`+ def test_excludes_files_with_exclude_bumps(self, mock_update_config_file, mock_modify_files):`
	`188`	`+ """Files that have exclude_bumps are excluded when those bumps happen."""`
`189`	`189`	`# Arrange`
`190`	`190`	`new_version = None`
`191`	`191`	`config, version_config, current_version = get_config_data(`
`192`	`192`	`{`
`193`	`193`	`"current_version": "1.2.3",`
`194`		`- "files": [{"filename": "foo.txt", "invalid_bumps": ["patch"]}, {"filename": "bar.txt"}],`
	`194`	`+ "files": [{"filename": "foo.txt", "exclude_bumps": ["patch"]}, {"filename": "bar.txt"}],`
`195`	`195`	`}`
`196`	`196`	`)`
`197`	`197`	`config.scm_info = SCMInfo()`