orionis 0.25.0__tar.gz → 0.26.0__tar.gz

{orionis-0.25.0/orionis.egg-info → orionis-0.26.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: orionis
-Version: 0.25.0
+Version: 0.26.0
 Summary: Orionis Framework – Elegant, Fast, and Powerful.
 Home-page: https://github.com/orionis-framework/framework
 Author: Raul Mauricio Uñate Castro

{orionis-0.25.0 → orionis-0.26.0}/orionis/framework.py

@@ -5,7 +5,7 @@
 NAME = "orionis"
 
 # Current version of the framework
-VERSION = "0.25.0"
+VERSION = "0.26.0"
 
 # Full name of the author or maintainer of the project
 AUTHOR = "Raul Mauricio Uñate Castro"

orionis-0.26.0/orionis/luminate/bootstrap/cli_exception.py

@@ -0,0 +1,54 @@
+class BootstrapRuntimeError(RuntimeError):
+    """
+    Exception raised for errors related to dumping Orionis data.
+
+    Parameters
+    ----------
+    message : str
+        The error message describing the issue.
+
+    Attributes
+    ----------
+    message : str
+        The stored error message.
+
+    Methods
+    -------
+    __str__()
+        Returns a user-friendly string representation of the exception.
+    __repr__()
+        Returns a detailed representation for debugging purposes.
+    """
+
+    def __init__(self, message: str):
+        """
+        Initialize the exception with a message.
+
+        Parameters
+        ----------
+        message : str
+            The error message describing the issue.
+        """
+        super().__init__(f"[BootstrapRuntimeError]: {message}")
+
+    def __str__(self) -> str:
+        """
+        Returns a user-friendly string representation.
+
+        Returns
+        -------
+        str
+            A formatted error message.
+        """
+        return self.args[0]
+
+    def __repr__(self) -> str:
+        """
+        Returns a detailed representation for debugging.
+
+        Returns
+        -------
+        str
+            A detailed string representation including the exception name.
+        """
+        return f"{self.__class__.__name__}({self.args[0]!r})"

orionis-0.26.0/orionis/luminate/bootstrap/commands/bootstrapper.py

@@ -0,0 +1,99 @@
+import pathlib
+import importlib
+import inspect
+from orionis.luminate.bootstrap.cli_exception import BootstrapRuntimeError
+from orionis.luminate.bootstrap.commands.register import Register
+from orionis.luminate.console.base.command import BaseCommand
+from orionis.luminate.contracts.bootstrap.commands.bootstrapper_interface import IBootstrapper
+
+class Bootstrapper(IBootstrapper):
+    """
+    Manages the automatic loading and registration of command classes
+    from Python files located in predefined directories.
+
+    The `Bootstrapper` class scans specific directories for Python files, dynamically
+    imports them, and registers classes that inherit from `BaseCommand`.
+
+    Attributes
+    ----------
+    register : Register
+        An instance of the `Register` class used to register command classes.
+
+    Methods
+    -------
+    __init__(register: Register) -> None
+        Initializes the `Bootstrapper` with a `Register` instance and triggers autoloading.
+    _autoload() -> None
+        Scans predefined directories for Python files, dynamically imports modules,
+        and registers classes that extend `BaseCommand`.
+    """
+
+    def __init__(self, register: Register) -> None:
+        """
+        Initializes the `Bootstrapper` with a `Register` instance and triggers autoloading.
+
+        Parameters
+        ----------
+        register : Register
+            An instance of the `Register` class used to register command classes.
+        """
+        self.register = register
+        self._autoload()
+
+    def _autoload(self) -> None:
+        """
+        Autoloads command modules from specified directories and registers command classes.
+
+        This method searches for Python files in the predefined command directories,
+        dynamically imports the modules, and registers classes that inherit from `BaseCommand`.
+
+        The command directories searched are:
+        - `app/console/commands` relative to the current working directory.
+        - `console/commands` relative to the parent directory of the current file.
+
+        It skips `__init__.py` files and ignores directories that do not exist.
+
+        Raises
+        ------
+        BootstrapRuntimeError
+            If an error occurs while loading a module.
+        """
+
+        # Define the base project path
+        base_path = pathlib.Path.cwd()
+
+        # Define the command directories to search
+        command_dirs = [
+            base_path / "app" / "console" / "commands",
+            pathlib.Path(__file__).resolve().parent.parent / "console" / "commands"
+        ]
+
+        # Iterate over each command directory
+        for cmd_dir in command_dirs:
+
+            # Skip if the directory does not exist
+            if not cmd_dir.is_dir():
+                continue
+
+            # Iterate over Python files in the directory (recursive search)
+            for file_path in cmd_dir.rglob("*.py"):
+
+                # Skip `__init__.py` files
+                if file_path.name == "__init__.py":
+                    continue
+
+                # Convert file path to a Python module import path
+                module_path = ".".join(file_path.relative_to(base_path).with_suffix("").parts)
+
+                try:
+                    # Dynamically import the module
+                    module = importlib.import_module(module_path)
+
+                    # Find classes that inherit from `BaseCommand`
+                    for name, obj in inspect.getmembers(module, inspect.isclass):
+                        if issubclass(obj, BaseCommand) and obj is not BaseCommand:
+                            # Register the class
+                            self.register.command(obj)
+
+                except Exception as e:
+                    raise BootstrapRuntimeError(f"Error loading {module_path}") from e

{orionis-0.25.0/orionis/luminate/console → orionis-0.26.0/orionis/luminate/bootstrap/commands}/register.py

@@ -1,6 +1,7 @@
+from typing import Any, Callable
 from orionis.luminate.console.base.command import BaseCommand
 from orionis.luminate.cache.console.commands import CacheCommands
-from orionis.luminate.contracts.console.register_interface import IRegister
+from orionis.luminate.contracts.bootstrap.commands.register_interface import IRegister
 
 class Register(IRegister):
     """
@@ -12,13 +13,13 @@ class Register(IRegister):
         A dictionary storing registered command classes.
     """
 
-    def __init__(self, cache : CacheCommands = None):
+    def __init__(self, cache : CacheCommands):
         """
         Initializes the Register instance and prepares the cache commands system.
         """
-        self.cache_commands = cache or CacheCommands()
+        self.cache_commands = cache
 
-    def command(self, command_class):
+    def command(self, command_class: Callable[..., Any]) -> None:
         """
         Registers a command class after validating its structure.
 
@@ -84,15 +85,8 @@ class Register(IRegister):
 
         # Register the command
         self.cache_commands.register(
-            instance=command_class,
+            concrete=command_class,
             arguments=arguments,
             description=description,
             signature=signature
-        )
-
-        # Return Class
-        return command_class
-
-
-# Return Decorator.
-register = Register()
+        )

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/bootstrap/config/bootstrapper.py

@@ -1,5 +1,6 @@
 import importlib
 import pathlib
+from orionis.luminate.bootstrap.cli_exception import BootstrapRuntimeError
 from orionis.luminate.bootstrap.config.register import Register
 from orionis.luminate.contracts.bootstrap.config.bootstrapper_interface import IBootstrapper
 
@@ -74,5 +75,5 @@ class Bootstrapper(IBootstrapper):
                 if hasattr(module, "Config"):
                     self.register.config(getattr(module, "Config"))
             except Exception as e:
-                raise RuntimeError(f"Error loading module {module_path}") from e
+                raise BootstrapRuntimeError(f"Error loading module {module_path}") from e
 

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/cache/app/config.py

@@ -1,15 +1,22 @@
 from typing import Dict, Any
+from orionis.luminate.contracts.cache.app.config_interface import ICacheConfig
 
-class CacheConfig:
+class CacheConfig(ICacheConfig):
     """
-    This class ensures that configuration sections are registered only once
-    and provides methods to register, unregister, and retrieve configurations.
+    CacheConfig is a class that manages the registration, unregistration, and retrieval of configuration sections.
 
-    Attributes
-    ----------
-    config : dict
-        A dictionary storing registered configuration sections.
+    Methods
+    -------
+    __init__()
+        Initializes a new instance of the class with an empty configuration dictionary.
+    register(section: str, data: Dict[str, Any])
+        Registers a configuration section with its associated data.
+    unregister(section: str)
+        Unregisters a previously registered configuration section.
+    get(section: str)
+        Retrieves the configuration data for a specific section.
     """
+
     def __init__(self) -> None:
         """
         Initializes a new instance of the class with an empty configuration dictionary.

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/cache/console/commands.py

@@ -1,33 +1,32 @@
-from orionis.luminate.contracts.cache.cache_commands_interface import ICacheCommands
+from typing import Any, Callable
+from orionis.luminate.contracts.cache.console.commands_interface import ICacheCommands
 
 class CacheCommands(ICacheCommands):
     """
-    Singleton class for managing a cache of commands.
+    CacheCommands is a class that manages the registration, unregistration, and retrieval of command instances.
 
-    This class ensures that only one instance of the command cache exists
-    and provides methods for registering, unregistering, and retrieving commands.
+    Methods
+    -------
+    __init__()
+        Initializes the command cache with an empty dictionary.
+    register(signature: str, description: str, arguments: list, concrete: Callable[..., Any])
+        Register a new command with its signature, description, and class instance.
+    unregister(signature: str)
+        Unregister an existing command by its signature.
+    get(signature: str)
+        Retrieve the information of a registered command by its signature.
     """
 
-    _instance = None
+    def __init__(self):
 
-    def __new__(cls, *args, **kwargs):
         """
-        Create or return the singleton instance of the CacheCommands class.
+        Initializes the command cache.
 
-        Ensures that only one instance of the CacheCommands class exists
-        during the lifetime of the application.
-
-        Returns
-        -------
-        CacheCommands
-            The singleton instance of the class.
+        This constructor sets up an empty dictionary to store commands.
         """
-        if cls._instance is None:
-            cls._instance = super().__new__(cls, *args, **kwargs)
-            cls._instance.commands = {}
-        return cls._instance
+        self.commands = {}
 
-    def register(self, signature: str, description: str, arguments: list, instance):
+    def register(self, signature: str, description: str, arguments: list, concrete: Callable[..., Any]):
         """
         Register a new command with its signature, description, and class instance.
 
@@ -37,7 +36,7 @@ class CacheCommands(ICacheCommands):
             The unique identifier (signature) for the command.
         description : str
             A brief description of what the command does.
-        instance : class
+        concrete : class
             The class or callable instance that defines the command behavior.
 
         Raises
@@ -49,7 +48,7 @@ class CacheCommands(ICacheCommands):
             raise ValueError(f"Command '{signature}' is already registered. Please ensure signatures are unique.")
 
         self.commands[signature] = {
-            'instance':instance,
+            'concrete':concrete,
             'arguments':arguments,
             'description':description,
             'signature':signature

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/base/command.py

@@ -1,6 +1,6 @@
 from orionis.luminate.console.output.console import Console
 from orionis.luminate.console.output.progress_bar import ProgressBar
-from orionis.luminate.contracts.console.base_command_interface import IBaseCommand
+from orionis.luminate.contracts.console.base.base_command_interface import IBaseCommand
 
 class BaseCommand(IBaseCommand):
     """

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/commands/cache_clear.py

@@ -1,9 +1,8 @@
 import os
 import shutil
-from orionis.luminate.console.register import register
 from orionis.luminate.console.base.command import BaseCommand
+from orionis.luminate.console.exceptions.cli_exception import CLIOrionisRuntimeError
 
-@register.command
 class CacheClearCommand(BaseCommand):
     """
     Clears Python bytecode caches (__pycache__) within the project directory.
@@ -48,9 +47,9 @@ class CacheClearCommand(BaseCommand):
                         shutil.rmtree(pycache_path)
 
             # Log a success message once all caches are cleared
-            self.success(message='The application cache has been successfully cleared.', timestamp=True)
+            self.success(message='The application cache has been successfully cleared.')
 
         except Exception as e:
 
             # Handle any unexpected error and display the error message
-            raise RuntimeError(f"An unexpected error occurred while clearing the cache: {e}") from e
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred while clearing the cache: {e}") from e

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/commands/help.py

@@ -1,8 +1,7 @@
-from orionis.luminate.console.register import register
 from orionis.luminate.console.base.command import BaseCommand
 from orionis.luminate.cache.console.commands import CacheCommands
+from orionis.luminate.console.exceptions.cli_exception import CLIOrionisRuntimeError
 
-@register.command
 class HelpCommand(BaseCommand):
     """
     Command class to display the list of available commands in the Orionis application.
@@ -55,5 +54,5 @@ class HelpCommand(BaseCommand):
 
         except Exception as e:
 
-            # Raise a ValueError if an unexpected error occurs.
-            raise ValueError(f"An unexpected error occurred: {e}") from e
+            # Handle any unexpected error and display the error message
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred: {e}") from e

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/commands/schedule_work.py

@@ -1,9 +1,8 @@
-from orionis.luminate.console.register import register
 from orionis.luminate.console.base.command import BaseCommand
+from orionis.luminate.console.exceptions.cli_exception import CLIOrionisRuntimeError
 from orionis.luminate.console.tasks.scheduler import Schedule
 from orionis.luminate.contracts.console.task_manager_interface import ITaskManager
 
-@register.command
 class ScheduleWorkCommand(BaseCommand):
     """
     Command class to handle scheduled tasks within the Orionis application.
@@ -46,5 +45,5 @@ class ScheduleWorkCommand(BaseCommand):
 
         except Exception as e:
 
-            # Raise a RuntimeError if an unexpected error occurs.
-            raise RuntimeError(f"An unexpected error occurred: {e}") from e
+            # Handle any unexpected error and display the error message
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred: {e}") from e

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/commands/tests.py

@@ -1,8 +1,7 @@
+from orionis.luminate.console.exceptions.cli_exception import CLIOrionisRuntimeError
 from orionis.luminate.facades.tests import UnitTests
-from orionis.luminate.console.register import register
 from orionis.luminate.console.base.command import BaseCommand
 
-@register.command
 class TestsCommand(BaseCommand):
     """
     Command class to display the list of available commands in the Orionis application.
@@ -36,5 +35,5 @@ class TestsCommand(BaseCommand):
 
         except Exception as e:
 
-            # Raise a ValueError if an unexpected error occurs.
-            raise ValueError(f"An unexpected error occurred: {e}") from e
+            # Handle any unexpected error and display the error message
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred: {e}") from e

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/commands/version.py

@@ -1,8 +1,7 @@
 from orionis.framework import VERSION
-from orionis.luminate.console.register import register
 from orionis.luminate.console.base.command import BaseCommand
+from orionis.luminate.console.exceptions.cli_exception import CLIOrionisRuntimeError
 
-@register.command
 class VersionCommand(BaseCommand):
     """
     Command class to display the current version of the Orionis framework.
@@ -35,5 +34,5 @@ class VersionCommand(BaseCommand):
 
         except Exception as e:
 
-            # Raise a ValueError if an unexpected error occurs.
-            raise ValueError(f"An unexpected error occurred: {e}") from e
+            # Handle any unexpected error and display the error message
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred: {e}") from e

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/exceptions/cli_exception.py

@@ -125,3 +125,46 @@ class CLIOrionisScheduleException(Exception):
             A string containing the exception name and the response message.
         """
         return f"[CLIOrionisScheduleException]: {self.args[0]}"
+
+
+class CLIOrionisRuntimeError(RuntimeError):
+    """
+    Custom exception raised when there is a runtime issue with Orionis processing.
+
+    Parameters
+    ----------
+    message : str
+        The response message associated with the exception.
+
+    Attributes
+    ----------
+    message : str
+        Stores the response message passed during initialization.
+
+    Methods
+    -------
+    __str__()
+        Returns a string representation of the exception, including the response message.
+    """
+
+    def __init__(self, message: str):
+        """
+        Initializes the CLIOrionisRuntimeError with the given response message.
+
+        Parameters
+        ----------
+        message : str
+            The response message associated with the exception.
+        """
+        super().__init__(message)
+
+    def __str__(self):
+        """
+        Returns a string representation of the exception, including the response message.
+
+        Returns
+        -------
+        str
+            A string containing the exception name and the response message.
+        """
+        return f"[CLIOrionisRuntimeError]: {self.args[0]}"

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/kernel.py

@@ -1,4 +1,4 @@
-from typing import Any, Tuple
+from typing import Any
 from orionis.luminate.console.runner import CLIRunner
 from orionis.luminate.contracts.console.kernel_interface import ICLIKernel
 

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/output/console.py

@@ -3,7 +3,7 @@ import sys
 import getpass
 import datetime
 from orionis.luminate.console.output.styles import ANSIColors
-from orionis.luminate.contracts.console.console_interface import IConsole
+from orionis.luminate.contracts.console.output.console_interface import IConsole
 
 class Console(IConsole):
     """

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/output/executor.py

@@ -1,6 +1,6 @@
 from datetime import datetime
 from orionis.luminate.console.output.styles import ANSIColors
-from orionis.luminate.contracts.console.executor_interface import IExecutor
+from orionis.luminate.contracts.console.output.executor_interface import IExecutor
 
 class Executor(IExecutor):
     """

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/output/progress_bar.py

@@ -1,5 +1,5 @@
 import sys
-from orionis.luminate.contracts.console.progress_bar_interface import IProgressBar
+from orionis.luminate.contracts.console.output.progress_bar_interface import IProgressBar
 
 class ProgressBar(IProgressBar):
     """

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/scripts/management.py

@@ -1,7 +1,7 @@
 from orionis.luminate.installer.setup import Setup
 from orionis.luminate.installer.output import Output
 from orionis.luminate.installer.upgrade import Upgrade
-from orionis.luminate.contracts.console.management_interface import IManagement
+from orionis.luminate.contracts.console.scripts.management_interface import IManagement
 
 class Management(IManagement):
     """

{orionis-0.25.0 → orionis-0.26.0}/orionis/luminate/console/tasks/scheduler.py

@@ -8,7 +8,7 @@ from apscheduler.triggers.cron import CronTrigger
 from orionis.luminate.console.command import Command
 from apscheduler.triggers.interval import IntervalTrigger
 from apscheduler.schedulers.background import BackgroundScheduler
-from orionis.luminate.contracts.console.schedule_interface import ISchedule
+from orionis.luminate.contracts.console.tasks.schedule_interface import ISchedule
 from orionis.luminate.console.exceptions.cli_exception import CLIOrionisScheduleException
 
 class Schedule(ISchedule):