Refactor cookiecutter replay file copying

The cleaning up of the replay file is now done in a separate function,
as more cleaning up is coming soon.

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

cookiecutter/hooks/post_gen_project.py

@@ -131,6 +131,43 @@ def finish_setup() -> None:
     commit_git_changes(first_commit=was_repo_initialized)
 
 
+def clean_replay_file(
+    *,
+    replay_data: dict[str, Any],
+    src: _pathlib.Path,  # pylint: disable=unused-argument
+    dst: _pathlib.Path,
+) -> dict[str, Any]:
+    """Clean the replay file.
+
+    Performs some cleaning of the replay file generated by cookiecutter to make it
+    more suitable for the generated project.
+
+    Args:
+        replay_data: The replay data to clean.
+        src: The path of the original replay file.
+        dst: The path of the cleaned replay file.
+
+    Returns:
+        The cleaned replay data.
+    """
+    # Remove the _output_dir key from the replay data because it is an absolute path
+    # that depends on the current environment and we don't want to add it as part of
+    # the generated project.
+    replay_data["cookiecutter"].pop("_output_dir", None)
+
+    if template := replay_data["cookiecutter"].get("_template"):
+        if not template.startswith(("gh:", "git@", "https://")):
+            print(
+                f"WARNING: The replay file's `_template` ({template}) doesn't seem "
+                "to be a remote repository, it won't be saved to avoid storing a "
+                "local template in the new repository. If this is incorrect, "
+                f"please add it back manually to {dst}."
+            )
+            replay_data["cookiecutter"].pop("_template", None)
+
+    return replay_data
+
+
 def copy_replay_file() -> None:
     """Copy the replay file to the project root."""
     src = _pathlib.Path("~/.cookiecutter_replay/cookiecutter.json").expanduser()
@@ -146,22 +183,9 @@ def copy_replay_file() -> None:
 
     try:
         with src.open("r", encoding="utf8") as input_file:
-            replay_data = _json.load(input_file)
-
-        # Remove the _output_dir key from the replay data because it is an absolute path
-        # that depends on the current environment and we don't want to add it as part of
-        # the generated project.
-        replay_data["cookiecutter"].pop("_output_dir", None)
-
-        if template := replay_data["cookiecutter"].get("_template"):
-            if not template.startswith(("gh:", "git@", "https://")):
-                print(
-                    f"WARNING: The replay file's `_template` ({template}) doesn't seem "
-                    "to be a remote repository, it won't be saved to avoid storing a "
-                    "local template in the new repository. If this is incorrect, "
-                    f"please add it back manually to {dst}."
-                )
-                replay_data["cookiecutter"].pop("_template", None)
+            replay_data = clean_replay_file(
+                replay_data=_json.load(input_file), src=src, dst=dst
+            )
 
         with dst.open("w", encoding="utf8") as output_file:
             _json.dump(replay_data, output_file, indent=2)