orionis 0.730.0__py3-none-any.whl → 0.731.0__py3-none-any.whl

orionis/console/commands/make_command.py

@@ -106,7 +106,11 @@ class MakeCommand(BaseCommand):
                 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"
+            class_name = ''.join(word.capitalize() for word in name.split('_'))
+            if not class_name.endswith("Command"):
+                class_name = class_name.rstrip("_") + "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)
@@ -114,6 +118,12 @@ class MakeCommand(BaseCommand):
             # Ensure the commands directory exists
             commands_dir = app.path('console') / "commands"
             commands_dir.mkdir(parents=True, exist_ok=True)
+
+            # Ensure the name ends with 'command' (case-insensitive)
+            if not name.lower().endswith("command"):
+                name = name.rstrip("_") + "_command"
+
+            # Define the full path for the new command file
             file_path = commands_dir / f"{name}.py"
 
             # Check if the file already exists to prevent overwriting

orionis/console/commands/make_scheduler_listener.py

@@ -0,0 +1,131 @@
+import re
+from pathlib import Path
+from typing import List
+from orionis.console.args.argument import CLIArgument
+from orionis.console.base.command import BaseCommand
+from orionis.console.exceptions import CLIOrionisRuntimeError
+from orionis.foundation.contracts.application import IApplication
+
+class MakeSchedulerListenerCommand(BaseCommand):
+    """
+    Command to create a new custom scheduler listener for scheduled task events.
+
+    Attributes
+    ----------
+    timestamps : bool
+        Indicates whether timestamps will be shown in the command output.
+    signature : str
+        Command signature.
+    description : str
+        Command description.
+
+    Methods
+    -------
+    options() -> List[CLIArgument]
+        Returns the CLI arguments required for this command.
+    handle(app: IApplication) -> dict
+        Handles the creation of the scheduler listener file.
+    """
+
+    # Indicates whether timestamps will be shown in the command output
+    timestamps: bool = False
+
+    # Command signature and description
+    signature: str = "make:scheduler-listener"
+
+    # Command description
+    description: str = (
+        "Creates a new custom scheduler listener to handle events for a scheduled task."
+    )
+
+    async def options(self) -> List[CLIArgument]:
+        """
+        Returns the CLI arguments required for this command.
+
+        Returns
+        -------
+        List[CLIArgument]
+            A list containing the required CLIArgument for the listener name.
+        """
+
+        # Define the required CLI argument for the listener name
+        return [
+            CLIArgument(
+                flags=["name"],
+                type=str,
+                required=True,
+                help="The filename where the new command will be created."
+            )
+        ]
+
+    def handle(self, app: IApplication) -> dict:
+        """
+        Handles the creation of the scheduler listener file.
+
+        This method validates the listener name, loads the stub template,
+        generates the listener class, ensures the listeners directory exists,
+        and writes the new listener file. If the file already exists, it
+        prevents overwriting and displays an error.
+
+        Parameters
+        ----------
+        app : IApplication
+            The application instance used to resolve paths.
+
+        Returns
+        -------
+        dict
+            An empty dictionary. All output is handled via CLI messaging.
+        """
+
+        try:
+
+            # Retrieve the 'name' argument (required)
+            listener_name: str = self.argument("name")
+
+            # Validate that the listener_name argument is provided
+            if not listener_name:
+                self.error("The 'name' argument is required.")
+
+            # Validate that the listener name starts with a lowercase letter and contains only lowercase letters, numbers, or underscores
+            if not re.match(r'^[a-z][a-z0-9_]*$', listener_name):
+                self.error("The 'name' argument must start with a lowercase letter and contain only lowercase letters, numbers, and underscores (_).")
+
+            # Load the listener stub template from the stubs directory
+            stub_path = Path(__file__).parent.parent / "stubs" / "listener.stub"
+            with open(stub_path, "r", encoding="utf-8") as file:
+                stub_content = file.read()
+
+            # Generate the class name by capitalizing each word and appending 'Listener'
+            class_name = ''.join(word.capitalize() for word in listener_name.split('_'))
+            if not class_name.endswith("Listener"):
+                class_name = class_name.rstrip("_") + "Listener"
+
+            # Replace placeholders in the stub with the actual class name
+            stub_content = stub_content.replace("{{class_name}}", class_name)
+
+            # Ensure the listeners directory exists
+            listeners_dir = app.path('console') / "listeners"
+            listeners_dir.mkdir(parents=True, exist_ok=True)
+
+            # Ensure the listener_name ends with 'listener' (case-insensitive)
+            if not listener_name.lower().endswith("listener"):
+                listener_name = listener_name.rstrip("_") + "_listener"
+
+            file_path = listeners_dir / f"{listener_name}.py"
+
+            # Check if the file already exists to prevent overwriting
+            if file_path.exists():
+                relative_path = file_path.relative_to(app.path('root'))
+                self.error(f"The file [{relative_path}] already exists. Please choose a different name.")
+            else:
+                # Write the generated listener code to the new file
+                with open(file_path, "w", encoding="utf-8") as file:
+                    file.write(stub_content)
+                relative_path = file_path.relative_to(app.path('root'))
+                self.info(f"Listener [{relative_path}] was created successfully.")
+
+        except Exception as exc:
+
+            # Catch any unexpected exceptions and raise a CLI-specific runtime error
+            raise CLIOrionisRuntimeError(f"An unexpected error occurred: {exc}") from exc

orionis/console/core/reactor.py

@@ -288,6 +288,7 @@ class Reactor(IReactor):
         from orionis.console.commands.scheduler_work import ScheduleWorkCommand
         from orionis.console.commands.test import TestCommand
         from orionis.console.commands.version import VersionCommand
+        from orionis.console.commands.make_scheduler_listener import MakeSchedulerListenerCommand
 
         # List of core command classes to load (extend this list as more core commands are added)
         core_commands = [
@@ -298,7 +299,8 @@ class Reactor(IReactor):
             ScheduleListCommand,
             ScheduleWorkCommand,
             TestCommand,
-            VersionCommand
+            VersionCommand,
+            MakeSchedulerListenerCommand
         ]
 
         # Iterate through the core command classes and register them

orionis/console/stubs/command.stub

@@ -10,7 +10,7 @@ class {{class_name}}(BaseCommand):
     # Command description
     description: str = "[Command description]"
 
-    def options(cls) -> List[CLIArgument]:
+    def options(self) -> List[CLIArgument]:
         """
         Define the command's arguments and options.
         Returns a list of CLIArgument instances.

orionis/metadata/framework.py

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

{orionis-0.730.0.dist-info → orionis-0.731.0.dist-info}/METADATA

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

{orionis-0.730.0.dist-info → orionis-0.731.0.dist-info}/RECORD

@@ -12,7 +12,8 @@ orionis/console/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZ
 orionis/console/commands/__publisher__.py,sha256=TS2WGZoWx7YX8CP7ixKB5lHc_1r-bBDNB8OkkWR9lzc,21647
 orionis/console/commands/cache_clear.py,sha256=UlFEZI8Q4BONsZybE6IgKrjLhW5N-JJLNEPMVFRw6LA,2926
 orionis/console/commands/help.py,sha256=GF5N6uabqBaGVVgiBRmlB0TQkUlDK71bvIgJQIPJxak,3760
-orionis/console/commands/make_command.py,sha256=WHE2J78fuY9RHScCOn9R_2KjkiayYJHFlm-Mp-k8X-o,5956
+orionis/console/commands/make_command.py,sha256=eL33zKDRmKaTsuqdYjyMzKsDb1D-R4iWcqMNbLyko5A,6308
+orionis/console/commands/make_scheduler_listener.py,sha256=LT4pbUsCqrrYDfuantW65GAjlWZrJlqY0frJtHiH42M,5239
 orionis/console/commands/scheduler_list.py,sha256=7E0C926e7YVU3YxqQ8Ot2as7Yco0jviFaxM8WrOYfsg,5316
 orionis/console/commands/scheduler_work.py,sha256=dDW9XTjGb-5ABuhPYjfd1rfO7xLDhgYu5nd6nToiYFE,5597
 orionis/console/commands/test.py,sha256=G3pveONRbeWTcVwaHat3wTAhxMm4g_BwhJhIejq6V0Y,3518
@@ -32,7 +33,7 @@ orionis/console/contracts/reactor.py,sha256=iT6ShoCutAWEeJzOf_PK7CGXi9TgrOD5tewH
 orionis/console/contracts/schedule.py,sha256=NaVOUpuE08X5rm9-oXyNs6r3LbOg7B_rIz-k4r7y4Qk,13703
 orionis/console/contracts/schedule_event_listener.py,sha256=h06qsBxuEMD3KLSyu0JXdUDHlQW19BX9lA09Qrh2QXg,3818
 orionis/console/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/console/core/reactor.py,sha256=z3Yp4fvZoXv5YcDJc8sS8AfV9wHC80IgkTO31EijZUg,44184
+orionis/console/core/reactor.py,sha256=I_3Ix0lzbS1gZ8pyfkHYA8DUQB0lzxyvBk_g9cthrmE,44326
 orionis/console/debug/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/debug/dumper.py,sha256=vbmP_GlrzBj0KDjiQl4iDudPRe6V0W5r5UA8i3h9_c4,6555
 orionis/console/dynamic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -61,7 +62,7 @@ orionis/console/output/console.py,sha256=xRZXSZiVqlyc1L16MBUV1M3TUHQwrWSFYUtisiv
 orionis/console/output/executor.py,sha256=uQjFPOlyZLFj9pcyYPugCqxwJog0AJgK1OcmQH2ELbw,7314
 orionis/console/request/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/request/cli_request.py,sha256=sH7Q2MpMIasiPiEPBeGhExnbfpSic98vQdAKvG9cgew,9071
-orionis/console/stubs/command.stub,sha256=hvtIUd5JHOOsoHnrwF2yMkzFs2sZeeBgM8RZMPrNgjM,691
+orionis/console/stubs/command.stub,sha256=d5qSvgDkA54BD5I5tbpp3zc_oRGKgFwxW0BLsszG1bE,692
 orionis/console/stubs/listener.stub,sha256=R6QNFU2I2OiUJAvSye2Zrboith5v4S8GlePUIQNNFjc,4264
 orionis/console/tasks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console/tasks/schedule.py,sha256=QExrIRcxr7s31xY1-DLUsrc7GmeuAhFjpCo4OicnChg,93309
@@ -206,7 +207,7 @@ orionis/foundation/providers/scheduler_provider.py,sha256=IrPQJwvQVLRm5Qnz0Cxon4
 orionis/foundation/providers/testing_provider.py,sha256=eI1p2lUlxl25b5Z487O4nmqLE31CTDb4c3Q21xFadkE,1615
 orionis/foundation/providers/workers_provider.py,sha256=GdHENYV_yGyqmHJHn0DCyWmWId5xWjD48e6Zq2PGCWY,1674
 orionis/metadata/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/metadata/framework.py,sha256=144rPMiaSWVBgDzcZ9H-EIukPrsUG1X23SMS4BFaR-E,4720
+orionis/metadata/framework.py,sha256=R7byA9N4aFOQgGCWBzwwHyXnKxctpdVPNoZo0c18AU8,4720
 orionis/metadata/package.py,sha256=s1JeGJPwdVh4jO3IOfmpwMuJ_oX6Vf9NL7jgPEQNf5Y,16050
 orionis/services/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/services/asynchrony/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -401,8 +402,8 @@ orionis/test/validators/workers.py,sha256=HcZ3cnrk6u7cvM1xZpn_lsglHAq69_jx9RcTSv
 orionis/test/view/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/test/view/render.py,sha256=arysoswhkV2vUd2aVMZRPpmH317jaWbgjDpQ_AWQ5AE,5663
 orionis/test/view/report.stub,sha256=QLqqCdRoENr3ECiritRB3DO_MOjRQvgBh5jxZ3Hs1r0,28189
-orionis-0.730.0.dist-info/licenses/LICENCE,sha256=JhC-z_9mbpUrCfPjcl3DhDA8trNDMzb57cvRSam1avc,1463
-orionis-0.730.0.dist-info/METADATA,sha256=4AI8C0GfVSxyoeL4xbmObgz6Q9_gbTxqY5WBPub7H34,4962
-orionis-0.730.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-orionis-0.730.0.dist-info/top_level.txt,sha256=lyXi6jArpqJ-0zzNqd_uwsH-z9TCEBVBL-pC3Ekv7hU,8
-orionis-0.730.0.dist-info/RECORD,,
+orionis-0.731.0.dist-info/licenses/LICENCE,sha256=JhC-z_9mbpUrCfPjcl3DhDA8trNDMzb57cvRSam1avc,1463
+orionis-0.731.0.dist-info/METADATA,sha256=_7l305UGl4mv2vm-X8S3KNsjkBmiTdrNKCeIKptgZ88,4962
+orionis-0.731.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+orionis-0.731.0.dist-info/top_level.txt,sha256=lyXi6jArpqJ-0zzNqd_uwsH-z9TCEBVBL-pC3Ekv7hU,8
+orionis-0.731.0.dist-info/RECORD,,