feat: added scripts

JuanVilla424 · JuanVilla424 · commit bc8e401bca0f · 2024-10-23T09:49:24.000-05:00
diff --git a/scripts/bump_year/main.py b/scripts/bump_year/main.py
@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+"""
+bump_year.py
+
+A script to bump the year part of the version in pyproject.toml.
+Resets major and minor versions to 0 when the year is incremented.
+
+Usage:
+    bump_year.py
+"""
+
+import datetime
+import toml
+import sys
+
+
+def bump_year() -> None:
+    """
+    Bumps the year in pyproject.toml and resets major and minor versions to 0.
+    """
+    current_year = datetime.datetime.now().year
+    pyproject_path = "pyproject.toml"
+
+    try:
+        with open(pyproject_path, "r", encoding="utf-8") as file:
+            data = toml.load(file)
+    except FileNotFoundError:
+        print(f"Error: {pyproject_path} not found.")
+        sys.exit(1)
+    except toml.TomlDecodeError:
+        print(f"Error: Failed to parse {pyproject_path}.")
+        sys.exit(1)
+
+    try:
+        version = data["tool"]["poetry"]["version"]
+        year, major, minor = version.split(".")
+    except (KeyError, ValueError):
+        print("Error: Version format is incorrect in pyproject.toml.")
+        sys.exit(1)
+
+    if int(year) < current_year:
+        print(f"Updating year from {year} to {current_year}")
+        year = str(current_year)
+        major = "0"
+        minor = "0"
+        new_version = f"{year}.{major}.{minor}"
+        data["tool"]["poetry"]["version"] = new_version
+        try:
+            with open(pyproject_path, "w", encoding="utf-8") as file:
+                toml.dump(data, file)
+            print(f"Year bumped to {new_version}")
+        except Exception as e:
+            print(f"Error writing to {pyproject_path}: {e}")
+            sys.exit(1)
+    else:
+        print("Year is up-to-date. No need to bump.")
+
+
+def main() -> None:
+    """
+    Main function to execute the year bumping process.
+    """
+    bump_year()
+
+
+if __name__ == "__main__":
+    main()
diff --git a/scripts/commit_msg_version_bump/main.py b/scripts/commit_msg_version_bump/main.py
@@ -0,0 +1,123 @@
+#!/usr/bin/env python3
+"""
+commit_msg_version_bump.py
+
+A script to bump the version in pyproject.toml based on commit message keywords.
+Handles major, minor, and patch releases.
+
+Usage:
+    commit_msg_version_bump.py <commit_msg_file>
+"""
+
+import sys
+import re
+import subprocess
+import toml
+
+DEBUG = False
+
+
+def bump_version(part: str) -> None:
+    """
+    Bumps the specified part of the version using bump2version and commits the change.
+
+    Args:
+        part (str): The part of the version to bump ('major', 'minor', 'patch').
+
+    Raises:
+        subprocess.CalledProcessError: If bump2version or git commands fail.
+    """
+    try:
+        subprocess.run(["bump2version", part], check=True)
+        print(f"Successfully bumped the {part} version.")
+    except subprocess.CalledProcessError:
+        print(f"Failed to bump the {part} version.")
+        sys.exit(1)
+
+    # Retrieve the new version from pyproject.toml
+    new_version = get_new_version()
+
+    if DEBUG:
+        print(f"Target version {new_version}")
+
+    # Stage the changed pyproject.toml
+    try:
+        subprocess.run(["git", "add", "pyproject.toml"], check=True)
+    except subprocess.CalledProcessError:
+        print("Failed to stage pyproject.toml.")
+        sys.exit(1)
+
+    # Commit the change
+    try:
+        subprocess.run(["git", "commit", "-m", f"Bump {part} version to {new_version}"], check=True)
+        print(f"Committed the bumped {part} version to {new_version}.")
+    except subprocess.CalledProcessError:
+        print(f"Failed to commit the bumped {part} version.")
+        sys.exit(1)
+
+
+def get_new_version() -> str:
+    """
+    Retrieves the new version from pyproject.toml.
+
+    Returns:
+        str: The new version string.
+
+    Raises:
+        SystemExit: If the version cannot be retrieved.
+    """
+    pyproject_path = "pyproject.toml"
+    try:
+        with open(pyproject_path, "r", encoding="utf-8") as file:
+            data = toml.load(file)
+        version = data["tool"]["poetry"]["version"]
+        return version
+    except (FileNotFoundError, KeyError, ValueError, toml.TomlDecodeError):
+        print(f"Error: Unable to retrieve the version from {pyproject_path}.")
+        sys.exit(1)
+
+
+def main() -> None:
+    """
+    Main function to parse the commit message and perform version bumping.
+    """
+    if DEBUG:
+        print(f"Sys: {sys}")
+
+    if len(sys.argv) < 2:
+        print("Usage: commit_msg_version_bump.py <commit_msg_file>")
+        sys.exit(1)
+
+    commit_msg_file = sys.argv[1]
+
+    try:
+        with open(commit_msg_file, "r", encoding="utf-8") as file:
+            commit_msg = file.read().strip()
+    except FileNotFoundError:
+        print(f"Commit message file not found: {commit_msg_file}")
+        sys.exit(1)
+
+    if DEBUG:
+        print(f"Commit message file: {commit_msg_file}")
+        print(f"commit_msg: {commit_msg}")
+
+    # Define patterns for candidate types
+    major_pattern = re.compile(r"\bmajor candidate\b", re.IGNORECASE)
+    minor_pattern = re.compile(r"\bminor candidate\b", re.IGNORECASE)
+    patch_pattern = re.compile(r"\bpatch candidate\b", re.IGNORECASE)
+
+    if major_pattern.search(commit_msg):
+        print("Major candidate release detected. Bumping major version...")
+        bump_version("major")
+    elif minor_pattern.search(commit_msg):
+        print("Minor candidate release detected. Bumping minor version...")
+        bump_version("minor")
+    elif patch_pattern.search(commit_msg):
+        print("Patch candidate release detected. Bumping patch version...")
+        bump_version("patch")
+    else:
+        print("No version bump detected in commit message.")
+
+
+if __name__ == "__main__":
+    main()
diff --git a/scripts/format_yaml/main.py b/scripts/format_yaml/main.py
@@ -0,0 +1,101 @@
+# scripts/validate_docker_compose.py
+import re
+import sys
+import os
+
+DEBUG = False
+
+
+def format_yaml_file(file_path):
+    """
+    Format a yaml file
+
+    Args:
+        :param file_path:
+    """
+    with open(file_path, "r", encoding="utf-8") as f:
+        content = f.read()
+
+    lines = content.splitlines()
+
+    if not lines or not lines[0].strip().startswith("---"):
+        lines.insert(0, "---")
+        print(f"[FORMAT] Added '---' at the beginning of {file_path}.")
+
+    for i, line in enumerate(lines):
+        original_line = line
+        line = re.sub(r"\[\s+", "[", line)
+        line = re.sub(r"\s+]", "]", line)
+        line = re.sub(r"\(\s+", "(", line)
+        line = re.sub(r"\s+\)", ")", line)
+        if line != original_line:
+            lines[i] = line
+            print(f"[FORMAT] Removed extra spaces inside brackets in line {i+1} of {file_path}.")
+
+    inside_run_block = False
+    new_lines = []
+    for i, line in enumerate(lines):
+        if re.match(r"^run:\s*\|", line):
+            inside_run_block = True
+            new_lines.append(line)
+            continue
+        if inside_run_block and re.match(r"^\S", line):
+            inside_run_block = False
+
+        if inside_run_block and len(line) > 120:
+            split_pos = line.rfind(" ", 0, 120)
+            if split_pos != -1:
+                split_line1 = line[:split_pos]
+                split_line2 = "  " + line[split_pos + 1 :].lstrip()
+                new_lines.append(split_line1)
+                new_lines.append(split_line2)
+                print(f"[FORMAT] Split long line in 'run' block at line {i+1} of {file_path}.")
+                continue
+            if not split_pos != -1:
+                split_line1 = line[:120]
+                split_line2 = "  " + line[120:].lstrip()
+                new_lines.append(split_line1)
+                new_lines.append(split_line2)
+                print(f"[FORMAT] Split long line in 'run' block at line {i+1} of {file_path}.")
+                continue
+
+        new_lines.append(line)
+
+    formatted_content = "\n".join(lines) + "\n"
+
+    with open(file_path, "w", newline="\n", encoding="utf-8") as f:
+        f.write(formatted_content)
+
+    print(f"[FORMAT] Formatted {file_path} with LF line endings.")
+    sys.exit(0)
+
+
+def main():
+    """Main void function to format yaml files."""
+
+    if len(sys.argv) < 2:
+        print("[ERROR] Incorrect usage. Must specify at least one file.")
+        sys.exit(1)
+
+    files_to_validate = sys.argv[1:]
+    for file in files_to_validate:
+        file_path = os.path.abspath(file)
+        if os.path.isfile(file_path):
+            format_yaml_file(file_path)
+        else:
+            print(f"[ERROR] File {file_path} does not exist.")
+            sys.exit(1)
+
+    print("[OK] All checks passed successfully.")
+    sys.exit(0)
+
+
+if __name__ == "__main__":
+    if sys.stdout.encoding.lower() != "utf-8":
+        try:
+            sys.stdout.reconfigure(encoding="utf-8")
+        except AttributeError:
+            import io
+
+            sys.stdout = io.TextIOWrapper(sys.stdout.buffer, encoding="utf-8")
+    main()
diff --git a/scripts/format_yml/main.py b/scripts/format_yml/main.py
@@ -0,0 +1,88 @@
+# scripts/validate_docker_compose.py
+import re
+import sys
+import os
+
+DEBUG = False
+
+
+def format_yml_file(file_path):
+    """
+    Function to format yml files
+
+    Args:
+        file_path (str):
+    """
+    with open(file_path, "r", encoding="utf-8") as f:
+        content = f.read()
+
+    lines = content.splitlines()
+    new_lines = []
+
+    if not lines or not lines[0].strip().startswith("---"):
+        lines.insert(0, "---")
+        print(f"[FORMAT] Added '---' at the beginning of {file_path}.")
+
+    for i, line in enumerate(lines):
+        original_line = line
+        line = re.sub(r"\[\s+", "[", line)
+        line = re.sub(r"\s+]", "]", line)
+        line = re.sub(r"\(\s+", "(", line)
+        line = re.sub(r"\s+\)", ")", line)
+        if line != original_line:
+            lines[i] = line
+            print(f"[FORMAT] Removed extra spaces inside brackets in line {i+1} of {file_path}.")
+
+    for i, line in enumerate(lines, start=1):
+        current_indent = len(line) - len(line.lstrip(" "))
+
+        while len(line) > 120:
+            split_pos = line.rfind(" ", 0, 120)
+            if split_pos != -1:
+                split_line1 = line[:split_pos] + " \\"
+                split_line2 = " " * current_indent + " " + line[split_pos + 1 :].lstrip()
+                new_lines.append(split_line1)
+                new_lines.append(split_line2)
+                print(f"[FORMAT] Split long line at line {i} in {file_path}.")
+                continue
+            if not split_pos != -1:
+                split_line1 = line[:120] + " \\"
+                split_line2 = " " * current_indent + " " + line[120 + 1 :].lstrip()
+                new_lines.append(split_line1)
+                new_lines.append(split_line2)
+                print(f"[FORMAT] Force split long line at line {i} in {file_path}.")
+                continue
+
+        new_lines.append(line)
+
+    formatted_content = "\n".join(new_lines) + "\n"
+
+    with open(file_path, "w", newline="\n", encoding="utf-8") as f:
+        f.write(formatted_content)
+
+    print(f"[FORMAT] Formatted {file_path} with LF line endings.")
+    sys.exit(0)
+
+
+def main():
+    """Main void function to format yml files."""
+
+    if len(sys.argv) < 2:
+        print("[ERROR] Incorrect usage. Must specify at least one file.")
+        sys.exit(1)
+
+    files_to_validate = sys.argv[1:]
+    for file in files_to_validate:
+        file_path = os.path.abspath(file)
+        if os.path.isfile(file_path):
+            format_yml_file(file_path)
+        else:
+            print(f"[ERROR] File {file_path} does not exist.")
+            sys.exit(1)
+
+    print("[OK] All checks passed successfully.")
+    sys.exit(0)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/scripts/generate_changelog/main.py b/scripts/generate_changelog/main.py
diff --git a/scripts/validate_docker_compose/main.py b/scripts/validate_docker_compose/main.py
