orionis 0.625.0__tar.gz → 0.627.0__tar.gz

{orionis-0.625.0/orionis.egg-info → orionis-0.627.0}/PKG-INFO

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

orionis-0.627.0/orionis/console/commands/make_command.py

@@ -0,0 +1,130 @@
+from pathlib import Path
+import re
+from typing import List
+from orionis.console.args.argument import CLIArgument
+from orionis.console.base.command import BaseCommand
+from orionis.console.contracts.reactor import IReactor
+from orionis.console.exceptions import CLIOrionisRuntimeError
+from rich.console import Console
+from rich.panel import Panel
+
+from orionis.foundation.contracts.application import IApplication
+
+class MakeCommand(BaseCommand):
+    """
+    Command class to display usage information for the Orionis CLI.
+    """
+
+    # Indicates whether timestamps will be shown in the command output
+    timestamps: bool = False
+
+    # Command signature and description
+    signature: str = "make:command"
+
+    # Command description
+    description: str = "Creates a new custom console command for the Orionis CLI."
+
+    async def options(self) -> List[CLIArgument]:
+        """
+        Defines the command-line options available for the `make:command` command.
+
+        This method specifies the arguments that can be passed to the command when it is invoked
+        from the CLI. It includes both required and optional arguments, each represented as a
+        `CLIArgument` instance.
+
+        Returns
+        -------
+        List[CLIArgument]
+            A list of `CLIArgument` objects representing the available command-line options.
+        """
+
+        return [
+            CLIArgument(
+                flags=["name"],
+                type=str,
+                required=True,
+                help="The filename where the new command will be created."
+            ),
+            CLIArgument(
+                flags=["--signature", "-s"],
+                type=str,
+                required=False,
+                help="The signature for the new command."
+            ),
+        ]
+
+    def handle(self, app: IApplication) -> dict:
+        """
+        Handles the creation of a new custom console command file.
+
+        This method processes the user-provided arguments, validates them, loads a command stub template,
+        replaces placeholders with the appropriate values, and writes the resulting code to a new file
+        in the commands directory. It also ensures that the file does not already exist and provides
+        feedback to the user regarding the operation's success or failure.
+
+        Parameters
+        ----------
+        app : IApplication
+            The application instance used to resolve paths and interact with the application environment.
+
+        Returns
+        -------
+        dict
+            An empty dictionary. The method's primary purpose is side effects (file creation and user feedback).
+        """
+
+        try:
+
+            # Print a new line to separate output
+            self.newLine()
+
+            # Retrieve the 'name' argument (required) and 'signature' argument (optional, with default)
+            name: str = self.argument("name")
+            signature: str = self.argument("signature", "custom:command")
+
+            # Validate that the name argument is provided
+            if not name:
+                self.error("The 'name' argument is required.")
+
+            # Validate that the file name starts with a lowercase letter and contains only lowercase letters, numbers, or underscores
+            if not re.match(r'^[a-z][a-z0-9_]*$', name):
+                self.error("The 'name' argument must start with a lowercase letter and contain only lowercase letters, numbers, and underscores (_).")
+
+            # Validate the command signature: must start with a lowercase letter, can contain lowercase letters, numbers (not at the start), and the special characters ':' and '_'
+            if not re.match(r'^[a-z][a-z0-9_:]*$', signature):
+                self.error("The 'signature' argument must start with a lowercase letter and can only contain lowercase letters, numbers (not at the start), and the special characters ':' and '_'.")
+
+            # Load the command stub template from the stubs directory
+            stub_path = Path(__file__).parent.parent / "stubs" / "command.stub"
+            with open(stub_path, "r", encoding="utf-8") as file:
+                stub = file.read()
+
+            # Generate the class name by capitalizing each word and appending 'Command'
+            class_name = ''.join(word.capitalize() for word in name.split('_')) + "Command"
+            # Replace placeholders in the stub with the actual class name and signature
+            stub = stub.replace("{{class_name}}", class_name)
+            stub = stub.replace("{{signature}}", signature)
+
+            # Ensure the commands directory exists
+            commands_dir = app.path('console') / "commands"
+            commands_dir.mkdir(parents=True, exist_ok=True)
+            file_path = commands_dir / f"{name}.py"
+
+            # Check if the file already exists to prevent overwriting
+            if file_path.exists():
+                file_path = file_path.relative_to(app.path('root'))
+                self.error(f"The file [{file_path}] already exists. Please choose another name.")
+            else:
+                # Write the generated command code to the new file
+                with open(file_path, "w", encoding="utf-8") as file:
+                    file.write(stub)
+                file_path = file_path.relative_to(app.path('root'))
+                self.info(f"Console command [{file_path}] created successfully.")
+
+            # Print a new line to separate output
+            self.newLine()
+
+        except Exception as e:
+
+            # Catch any unexpected exceptions and raise a CLI-specific runtime error
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred: {e}") from e

{orionis-0.625.0 → orionis-0.627.0}/orionis/console/core/reactor.py

@@ -288,7 +288,7 @@ class Reactor(IReactor):
         from orionis.console.commands.cache import CacheClearCommand
         from orionis.console.commands.scheduler_work import ScheduleWorkCommand
         from orionis.console.commands.scheduler_list import ScheduleListCommand
-        from orionis.console.commands.make_listener import MakeListenerCommand
+        from orionis.console.commands.make_command import MakeCommand
 
         # List of core command classes to load (extend this list as more core commands are added)
         core_commands = [
@@ -300,7 +300,7 @@ class Reactor(IReactor):
             CacheClearCommand,
             ScheduleWorkCommand,
             ScheduleListCommand,
-            MakeListenerCommand
+            MakeCommand
         ]
 
         # Iterate through the core command classes and register them

orionis-0.627.0/orionis/console/stubs/command.stub

@@ -0,0 +1,31 @@
+from orionis.console.base.command import BaseCommand
+from orionis.console.args.argument import CLIArgument
+from typing import List
+
+class {{class_name}}(BaseCommand):
+    """
+    [Command objective]
+    """
+
+    # Command signature
+    signature: str = "{{signature}}"
+
+    # Command description
+    description: str = "[Command description]"
+
+    def options(cls) -> List[CLIArgument]:
+        """
+        Define the command's arguments and options.
+        Returns a list of CLIArgument instances.
+        """
+        return []
+
+    async def handle(self) -> None:
+        """
+        Implement the command logic here.
+        You can access arguments using self.argument("name").
+        """
+        try:
+            pass
+        except Exception as e:
+            raise e

{orionis-0.625.0 → orionis-0.627.0}/orionis/metadata/framework.py

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

{orionis-0.625.0 → orionis-0.627.0/orionis.egg-info}/PKG-INFO

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

{orionis-0.625.0 → orionis-0.627.0}/orionis.egg-info/SOURCES.txt

@@ -20,7 +20,7 @@ orionis/console/base/scheduler_event_listener.py
 orionis/console/commands/__init__.py
 orionis/console/commands/cache.py
 orionis/console/commands/help.py
-orionis/console/commands/make_listener.py
+orionis/console/commands/make_command.py
 orionis/console/commands/publisher.py
 orionis/console/commands/scheduler_list.py
 orionis/console/commands/scheduler_work.py
@@ -71,8 +71,8 @@ orionis/console/output/console.py
 orionis/console/output/executor.py
 orionis/console/request/__init__.py
 orionis/console/request/cli_request.py
-orionis/console/stub/command.stub
-orionis/console/stub/listener.stub
+orionis/console/stubs/command.stub
+orionis/console/stubs/listener.stub
 orionis/console/tasks/__init__.py
 orionis/console/tasks/schedule.py
 orionis/container/__init__.py

orionis-0.625.0/orionis/console/commands/make_listener.py

@@ -1,54 +0,0 @@
-from orionis.console.base.command import BaseCommand
-from orionis.console.exceptions import CLIOrionisRuntimeError
-
-class MakeListenerCommand(BaseCommand):
-    """
-    Este comando se encarga de crear los listener tando para CLI como para otro tipo de Eventos.
-    """
-
-    # Indicates whether timestamps will be shown in the command output
-    timestamps: bool = False
-
-    # Command signature and description
-    signature: str = "make:listener"
-
-    # Command description
-    description: str = "Displays usage information, examples, and a list of available commands in the Orionis CLI."
-
-    def handle(self) -> dict:
-        """
-        Displays usage information and a list of available commands for the Orionis CLI.
-
-        Parameters
-        ----------
-        reactor : IReactor
-            The reactor instance providing command metadata via the `info()` method.
-
-        Returns
-        -------
-        dict
-            A dictionary containing the list of available commands, each with its signature and description.
-
-        Raises
-        ------
-        CLIOrionisRuntimeError
-            If an unexpected error occurs during help information generation or display.
-        """
-        try:
-
-            # Solicitar el nombre del listener al usuario
-            ans = self.choice(
-                question="Tipo de Listener",
-                choices=[
-                    "Listener para eventos CLI",
-                    "Listener para eventos de Schedule",
-                ],
-                default_index=0
-            )
-
-            print(ans)
-
-        except Exception as e:
-
-            # Raise a custom runtime error if any exception occurs
-            raise CLIOrionisRuntimeError(f"An unexpected error occurred: {e}") from e

orionis-0.625.0/orionis/console/stub/command.stub

@@ -1,42 +0,0 @@
-from orionis.console.base.command import BaseCommand
-from orionis.console.args.argument import CLIArgument
-from orionis.console.exceptions import CLIOrionisRuntimeError
-
-class {{class_name}}(BaseCommand):
-    """
-    Command: {{signature}}
-    {{description}}
-    """
-
-    # Enable timestamps
-    timestamps: bool = True
-
-    # Command signature
-    signature: str = "{{signature}}"
-
-    # Command description
-    description: str = "{{description}}"
-
-    # Arguments (edit as needed)
-    arguments = [
-        CLIArgument(
-            flags=["--example", "-e"],
-            type=str,
-            help="Example argument for {{class_name}}",
-            default=None,
-            required=False,
-            metavar="EXAMPLE",
-            dest="example",
-            action="store",
-        ),
-    ]
-
-    async def handle(self, *args, **kwargs) -> None:
-        try:
-            self.textSuccessBold("{{class_name}} executed successfully!")
-            example_value = self.argument("example")
-            if example_value:
-                self.info(f"Received argument: {example_value}")
-
-        except Exception as e:
-            raise CLIOrionisRuntimeError(f"An error occurred: {str(e)}") from e