From 980f28d8a50a9a8aa5229c68f9bef4fad30fb690 Mon Sep 17 00:00:00 2001
From: MEHRSHAD MIRSHEKARY <mehrshad_mirshekary@email.com>
Date: Fri, 4 Oct 2024 16:10:36 +0330
Subject: [PATCH] :sparkles: feat(commands): Add Django Management Command for
 Reformatting XML Files

#### Key Features:
- **Command Overview**: The command searches for .xml files in the specified log directory and reformats them by encapsulating the existing content within a <logs> element, creating a valid XML structure.
- **Directory Setup**: Utilizes helper functions to ensure that the required input and output directories are properly set up, enhancing usability and preventing file access errors.
- **File Processing**: Iterates through each XML file, applies the reformatting logic, and saves the modified content to a new directory, helping maintain the original files unaltered.
- **Error Handling**: Implements error handling to manage file access issues gracefully, providing feedback to users about any encountered problems.
- **User Feedback**: Offers real-time console output during execution, notifying users of the processing status for each file and confirming successful reformatting.

This management command simplifies the task of restructuring XML logs, making them more organized and easier to work with for further analysis or integration.

Closes #94
---
 .../commands/generate_pretty_xml.py           | 77 +++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 django_logging/management/commands/generate_pretty_xml.py

diff --git a/django_logging/management/commands/generate_pretty_xml.py b/django_logging/management/commands/generate_pretty_xml.py
new file mode 100644
index 0000000..7adc729
--- /dev/null
+++ b/django_logging/management/commands/generate_pretty_xml.py
@@ -0,0 +1,77 @@
+import os
+from typing import Any, Dict, Tuple
+
+from django.conf import settings
+from django.core.management.base import BaseCommand
+
+from django_logging.constants import DefaultLoggingSettings
+from django_logging.constants.config_types import LogDir
+from django_logging.utils.command.process_file import process_files, setup_directories
+
+
+class Command(BaseCommand):
+    """Command to find and reformat XML files in a specified directory.
+
+    This command processes all XML files in the specified log directory, reformats
+    them by wrapping their content in a <logs> element, and saves the reformatted
+    files to a new directory. It handles parsing errors and logs the process steps.
+
+    Attributes:
+        help (str): A brief description of the command's functionality.
+
+    """
+
+    help = "Find and reformat XML files in a directory"
+
+    def handle(self, *args: Tuple[Any], **kwargs: Dict[str, Any]) -> None:
+        """Handles the command execution.
+
+        Args:
+            *args: Positional arguments passed to the command.
+            **kwargs: Keyword arguments passed to the command.
+
+        """
+        default_settings = DefaultLoggingSettings()
+        log_dir: LogDir = settings.DJANGO_LOGGING.get(
+            "LOG_DIR", os.path.join(os.getcwd(), default_settings.log_dir)
+        )
+
+        try:
+            xml_dir, pretty_dir = setup_directories(log_dir, "xml")
+        except FileNotFoundError as e:
+            self.stdout.write(self.style.ERROR(str(e)))
+            return
+
+        for file_path, filename in process_files(
+            xml_dir, ".xml", self.reformat_and_write_xml
+        ):
+            self.stdout.write(self.style.NOTICE(f"Processing file: {file_path}"))
+
+            new_file_path = os.path.join(pretty_dir, f"formatted_{filename}")
+            self.reformat_and_write_xml(file_path, new_file_path)
+            self.stdout.write(
+                self.style.SUCCESS(f"File {filename} reformatted successfully.")
+            )
+
+    def reformat_and_write_xml(self, file_path: str, new_file_path: str) -> None:
+        """Reformats XML content by wrapping it in a <logs> element and writes
+        it to a new file.
+
+        Args:
+            file_path (str): The path of the original XML file to be reformatted.
+            new_file_path (str): The path where the reformatted XML file will be saved.
+
+        """
+        with open(file_path, encoding="utf-8") as infile, open(
+            new_file_path, "w", encoding="utf-8"
+        ) as outfile:
+            # Start the <logs> element
+            outfile.write("<logs>\n")
+
+            for line in infile:
+                # Write each line to the formatted file
+                if line.strip():  # Only process non-empty lines
+                    outfile.write(line)
+
+            # End the <logs> element
+            outfile.write("</logs>\n")