orionis 0.1.0__py3-none-any.whl

orionis/luminate/facades/paths.py

@@ -0,0 +1,268 @@
+import os
+from orionis.luminate.files.paths import SkeletonPath
+from orionis.luminate.contracts.facades.paths_interface import IPath
+
+class Path(IPath):
+
+    @staticmethod
+    def _resolve_directory(directory: str, file: str = None):
+        """
+        Internal helper function to resolve an absolute path for a given directory.
+
+        Parameters
+        ----------
+        directory : str
+            The base directory to resolve the path from.
+        file : str, optional
+            The relative file path inside the directory (default is an empty string).
+
+        Returns
+        -------
+        SkeletonPath
+            The resolved absolute path wrapped in a SkeletonPath object.
+        """
+        # Default to an empty string if None
+        file = file or ""
+
+        # Construct path safely
+        route = os.path.join(directory, file)
+
+        # Normalize path (removes redundant slashes)
+        route = os.path.normpath(route)
+
+        return SkeletonPath(route).resolve()
+
+    @staticmethod
+    def app(file: str = None):
+        """
+        Returns the absolute path for a file inside the 'app' directory.
+
+        Parameters
+        ----------
+        file : str, optional
+            The relative file path inside the 'app' directory.
+
+        Returns
+        -------
+        SkeletonPath
+            The resolved path wrapped in a SkeletonPath object.
+        """
+        return Path._resolve_directory("app", file)
+
+    @staticmethod
+    def config(file: str = None):
+        """
+        Returns the absolute path for a file inside the 'config' directory.
+
+        Parameters
+        ----------
+        file : str, optional
+            The relative file path inside the 'config' directory.
+
+        Returns
+        -------
+        SkeletonPath
+            The resolved path wrapped in a SkeletonPath object.
+        """
+        return Path._resolve_directory("config", file)
+
+    @staticmethod
+    def database(file: str = None):
+        """
+        Returns the absolute path for a file inside the 'database' directory.
+
+        Parameters
+        ----------
+        file : str, optional
+            The relative file path inside the 'database' directory.
+
+        Returns
+        -------
+        SkeletonPath
+            The resolved path wrapped in a SkeletonPath object.
+        """
+        return Path._resolve_directory("database", file)
+
+    @staticmethod
+    def resource(file: str = None):
+        """
+        Returns the absolute path for a file inside the 'resource' directory.
+
+        Parameters
+        ----------
+        file : str, optional
+            The relative file path inside the 'resource' directory.
+
+        Returns
+        -------
+        SkeletonPath
+            The resolved path wrapped in a SkeletonPath object.
+        """
+        return Path._resolve_directory("resource", file)
+
+    @staticmethod
+    def routes(file: str = None):
+        """
+        Returns the absolute path for a file inside the 'routes' directory.
+
+        Parameters
+        ----------
+        file : str, optional
+            The relative file path inside the 'routes' directory.
+
+        Returns
+        -------
+        SkeletonPath
+            The resolved path wrapped in a SkeletonPath object.
+        """
+        return Path._resolve_directory("routes", file)
+
+    @staticmethod
+    def storage(file: str = None):
+        """
+        Returns the absolute path for a file inside the 'storage' directory.
+
+        Parameters
+        ----------
+        file : str, optional
+            The relative file path inside the 'storage' directory.
+
+        Returns
+        -------
+        SkeletonPath
+            The resolved path wrapped in a SkeletonPath object.
+        """
+        return Path._resolve_directory("storage", file)
+
+    @staticmethod
+    def tests(file: str = None):
+        """
+        Returns the absolute path for a file inside the 'tests' directory.
+
+        Parameters
+        ----------
+        file : str, optional
+            The relative file path inside the 'tests' directory.
+
+        Returns
+        -------
+        SkeletonPath
+            The resolved path wrapped in a SkeletonPath object.
+        """
+        return Path._resolve_directory("tests", file)
+
+
+# -------------- Functions --------------
+
+
+def app_path(file: str = None):
+    """
+    Returns the absolute path for a file inside the 'app' directory.
+
+    Parameters
+    ----------
+    file : str, optional
+        The relative file path inside the 'app' directory.
+
+    Returns
+    -------
+    SkeletonPath
+        The resolved path wrapped in a SkeletonPath object.
+    """
+    return Path._resolve_directory("app", file)
+
+def config_path(file: str = None):
+    """
+    Returns the absolute path for a file inside the 'config' directory.
+
+    Parameters
+    ----------
+    file : str, optional
+        The relative file path inside the 'config' directory.
+
+    Returns
+    -------
+    SkeletonPath
+        The resolved path wrapped in a SkeletonPath object.
+    """
+    return Path._resolve_directory("config", file)
+
+def database_path(file: str = None):
+    """
+    Returns the absolute path for a file inside the 'database' directory.
+
+    Parameters
+    ----------
+    file : str, optional
+        The relative file path inside the 'database' directory.
+
+    Returns
+    -------
+    SkeletonPath
+        The resolved path wrapped in a SkeletonPath object.
+    """
+    return Path._resolve_directory("database", file)
+
+def resource_path(file: str = None):
+    """
+    Returns the absolute path for a file inside the 'resource' directory.
+
+    Parameters
+    ----------
+    file : str, optional
+        The relative file path inside the 'resource' directory.
+
+    Returns
+    -------
+    SkeletonPath
+        The resolved path wrapped in a SkeletonPath object.
+    """
+    return Path._resolve_directory("resource", file)
+
+def routes_path(file: str = None):
+    """
+    Returns the absolute path for a file inside the 'routes' directory.
+
+    Parameters
+    ----------
+    file : str, optional
+        The relative file path inside the 'routes' directory.
+
+    Returns
+    -------
+    SkeletonPath
+        The resolved path wrapped in a SkeletonPath object.
+    """
+    return Path._resolve_directory("routes", file)
+
+def storage_path(file: str = None):
+    """
+    Returns the absolute path for a file inside the 'storage' directory.
+
+    Parameters
+    ----------
+    file : str, optional
+        The relative file path inside the 'storage' directory.
+
+    Returns
+    -------
+    SkeletonPath
+        The resolved path wrapped in a SkeletonPath object.
+    """
+    return Path._resolve_directory("storage", file)
+
+def tests_path(file: str = None):
+    """
+    Returns the absolute path for a file inside the 'tests' directory.
+
+    Parameters
+    ----------
+    file : str, optional
+        The relative file path inside the 'tests' directory.
+
+    Returns
+    -------
+    SkeletonPath
+        The resolved path wrapped in a SkeletonPath object.
+    """
+    return Path._resolve_directory("tests", file)

orionis/luminate/facades/tests.py

@@ -0,0 +1,48 @@
+import os
+from orionis.luminate.test.unit_test import UnitTest
+from orionis.luminate.contracts.facades.tests_interface import IUnitTests
+
+class UnitTests(IUnitTests):
+    """
+    Concrete implementation of the IUnitTests interface.
+
+    This class provides the functionality to execute unit tests using a specified pattern
+    to filter test files within the 'tests' directory and its subdirectories.
+
+    Methods
+    -------
+    execute(pattern: str) -> dict
+        Executes unit tests by iterating over the 'tests' directory and its subdirectories,
+        matching test files based on the provided pattern.
+    """
+
+    @staticmethod
+    def execute(pattern='test_*.py') -> dict:
+        """
+        Executes the unit tests in the 'tests' directory and its subdirectories
+        by filtering test files based on a specified pattern.
+
+        Parameters
+        ----------
+        pattern : str, optional
+            The pattern to filter test files (default is 'test_*.py').
+
+        Returns
+        -------
+        dict
+            A dictionary containing the results of the executed tests.
+        """
+
+        # Initialize the test suite using the UnitTest framework
+        test_suite = UnitTest()
+
+        # Define the base directory for test files
+        tests_path = os.path.join(os.getcwd(), 'tests')
+
+        # Recursively walk through the 'tests' directory
+        for root, dirs, files in os.walk(tests_path):
+            for dir in dirs:
+                test_suite.addFolderTests(folder_path=dir, pattern=pattern)
+
+        # Execute the tests and return the results
+        return test_suite.run()

orionis/luminate/files/paths.py

@@ -0,0 +1,56 @@
+import os
+from pathlib import Path as SysPath
+from orionis.luminate.contracts.files.paths_interface import ISkeletonPath
+
+class SkeletonPath(ISkeletonPath):
+    """
+    Resolves the absolute path for a given relative directory based on the script's execution directory.
+    Ensures that the requested path is a valid directory.
+
+    Attributes
+    ----------
+    route : str
+        The resolved absolute path to the directory.
+
+    Methods
+    -------
+    __str__():
+        Returns the absolute path as a string.
+    """
+
+    def __init__(self, route: str):
+        """
+        Initializes the Path class, resolving the absolute path for a given relative directory.
+
+        The path is resolved relative to the script's execution directory.
+
+        Parameters
+        ----------
+        route : str
+            The relative directory path to be resolved.
+
+        Raises
+        ------
+        ValueError
+            If the path does not exist or is not a directory.
+        """
+        # Get the absolute path based on the script's execution directory
+        base_path = SysPath(os.getcwd())  # Get the directory where the script is executed
+        real_path = (base_path / route).resolve()  # Combine base path with the relative route
+
+        # Validate that the path exists and is a directory
+        if not real_path.is_dir():
+            raise ValueError(f"The requested directory does not exist or is not a directory: {real_path}")
+
+        self.route = str(real_path)
+
+    def resolve(self) -> str:
+        """
+        Returns the absolute path as a string.
+
+        Returns
+        -------
+        str
+            The absolute directory path.
+        """
+        return self.route

orionis/luminate/installer/icon.ascii

@@ -0,0 +1,11 @@
+-------------------------------------------
+ ██████  ██████  ██  ██████  ███    ██ ██ ███████
+██    ██ ██   ██ ██ ██    ██ ████   ██ ██ ██
+██    ██ ██████  ██ ██    ██ ██ ██  ██ ██ ███████
+██    ██ ██   ██ ██ ██    ██ ██  ██ ██ ██      ██
+ ██████  ██   ██ ██  ██████  ██   ████ ██ ███████
+{{message}}
+-------------------------------------------
+Orionis Team © 2023 - {{year}}
+Version: {{version}}
+Docs: {{docs}}

orionis/luminate/installer/info.ascii

@@ -0,0 +1,13 @@
+-------------------------------------------
+ ██████  ██████  ██  ██████  ███    ██ ██ ███████
+██    ██ ██   ██ ██ ██    ██ ████   ██ ██ ██
+██    ██ ██████  ██ ██    ██ ██ ██  ██ ██ ███████
+██    ██ ██   ██ ██ ██    ██ ██  ██ ██ ██      ██
+ ██████  ██   ██ ██  ██████  ██   ████ ██ ███████
+{{message}}
+-------------------------------------------
+{{commands}}
+-------------------------------------------
+Orionis Team © 2023 - {{year}}
+Version: {{version}}
+Docs: {{docs}}

orionis/luminate/installer/output.py

@@ -0,0 +1,188 @@
+import os
+import sys
+import datetime
+from orionis.framework import NAME, VERSION, DOCS
+from orionis.luminate.contracts.installer.output_interface import IOutput
+
+class Output(IOutput):
+    """
+    Class for displaying various types of messages to the console, including:
+    - Welcome messages
+    - Informational messages
+    - Failure messages
+    - Error messages
+
+    Methods
+    -------
+    welcome() -> None
+        Displays a welcome message to the framework.
+    finished() -> None
+        Displays a success message after initialization.
+    info(message: str) -> None
+        Displays an informational message to the console.
+    fail(message: str) -> None
+        Displays a failure message to the console.
+    error(message: str) -> None
+        Displays an error message to the console and terminates the program.
+    """
+
+    @staticmethod
+    def _print(label: str, message: str, color_code: str):
+        """
+        Prints messages to the console with specific formatting and colors.
+
+        Parameters
+        ----------
+        label : str
+            The label for the message (e.g., INFO, FAIL, ERROR).
+        message : str
+            The message to display.
+        color_code : str
+            ANSI color code for the background of the message.
+        """
+        # Get the current timestamp to display with the message
+        timestamp = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+
+        # Print the formatted message with the specified color and label
+        print(f'\u001b[{color_code}m\u001b[97m {label} \u001b[0m {timestamp} [Orionis Framework] - {message}\u001b[0m')
+
+    @staticmethod
+    def asciiIco():
+        """
+        Displays a welcome message to the framework, including ASCII art.
+
+        Attempts to load an ASCII art file (art.ascii). If not found, defaults to displaying basic information.
+
+        If the ASCII art file is found, placeholders are replaced with dynamic content such as version, docs, and year.
+        """
+        print("\n")
+
+        try:
+            # Try loading and printing ASCII art from the file
+            dir_path = os.path.dirname(__file__)
+            path = os.path.join(dir_path, 'icon.ascii')
+            with open(path, 'r', encoding='utf-8') as file:
+                content = file.read()
+
+            # Replace placeholders with dynamic content
+            year = datetime.datetime.now().year
+            message = "\u001b[32m{} \u001b[0m".format("Python isn't just powerful; it’s thrilling.")
+            output = content.replace('{{version}}', VERSION) \
+                            .replace('{{docs}}', DOCS) \
+                            .replace('{{year}}', str(year)) \
+                            .replace('{{message}}', message)
+            print(output)
+
+        except FileNotFoundError:
+            # Fallback if ASCII art file is not found
+            print(str(NAME).upper())
+            print(f"Version: {VERSION}")
+            print(f"Docs: {DOCS}")
+
+        print("\n")
+
+    @staticmethod
+    def asciiInfo():
+        """
+        Displays another type of welcome message to the framework, including different ASCII art.
+
+        Attempts to load an ASCII art file (info.ascii). If not found, defaults to displaying basic information.
+
+        Similar to `asciiIco()`, but with different ASCII art.
+        """
+        print("\n")
+
+        try:
+            # Try loading and printing ASCII art from the file
+            dir_path = os.path.dirname(__file__)
+            path = os.path.join(dir_path, 'info.ascii')
+            with open(path, 'r', encoding='utf-8') as file:
+                content = file.read()
+
+            # Replace placeholders with dynamic content
+            year = datetime.datetime.now().year
+            message = "\033[92m{} \033[0m".format("The list of commands accepted by the Orionis interpreter are:")
+            commands = [
+                {'name':'orionis new <app_name>', 'description': 'Creates a new Orionis app with the specified name.'},
+                {'name':'orionis --version', 'description': 'Displays the current version of Orionis.'},
+                {'name':'orionis --upgrade', 'description': 'Upgrades Orionis to the latest version.'}
+            ]
+            commands_array = []
+            for command in commands:
+                commands_array.append("\033[1m\033[93m- {} :\033[0m {}".format(command['name'],command['description']))
+
+            output = content.replace('{{version}}', VERSION) \
+                            .replace('{{docs}}', DOCS) \
+                            .replace('{{year}}', str(year))\
+                            .replace('{{message}}', message)\
+                            .replace('{{commands}}', str("\n").join(commands_array))
+            print(output)
+
+        except FileNotFoundError:
+            # Fallback if ASCII art file is not found
+            print(str(NAME).upper())
+            print(f"Version: {VERSION}")
+            print(f"Docs: {DOCS}")
+
+        print("\n")
+
+    @staticmethod
+    def startInstallation():
+        """
+        Displays the starting message when the installation begins.
+        This includes a welcoming message and the ASCII art.
+        """
+        Output.asciiIco()
+        print(f'\u001b[32m{NAME}\u001b[0m: Thank you for using the framework!')
+
+    @staticmethod
+    def endInstallation():
+        """
+        Displays the ending message after the installation is complete.
+        Provides a message of encouragement to start using the framework.
+        """
+        print(f'\u001b[32m{NAME}\u001b[0m: Welcome aboard, the journey starts now. Let your imagination soar!')
+        print("\n")
+
+    @staticmethod
+    def info(message: str = ''):
+        """
+        Displays an informational message to the console.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display. Defaults to an empty string.
+        """
+        Output._print("INFO", message, "44")
+
+    @staticmethod
+    def fail(message: str = ''):
+        """
+        Displays a failure message to the console.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display. Defaults to an empty string.
+        """
+        Output._print("FAIL", message, "43")
+
+    @staticmethod
+    def error(message: str = ''):
+        """
+        Displays an error message to the console and terminates the program.
+
+        Parameters
+        ----------
+        message : str, optional
+            The message to display. Defaults to an empty string.
+
+        Raises
+        ------
+        SystemExit
+            Terminates the program with a non-zero exit code, indicating an error occurred.
+        """
+        Output._print("ERROR", message, "41")
+        print("\n")
+        sys.exit(1)