orionis 0.442.0__tar.gz → 0.443.0__tar.gz

{orionis-0.442.0/orionis.egg-info → orionis-0.443.0}/PKG-INFO

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

orionis-0.443.0/orionis/console/arguments/parser.py

@@ -0,0 +1,6 @@
+class ArgumentPaser():
+
+    def __init__(self, args: dict):
+        self.__args = args
+
+    def 

orionis-0.443.0/orionis/foundation/providers/inspirational_provider.py

@@ -0,0 +1,61 @@
+from orionis.container.providers.service_provider import ServiceProvider
+from orionis.services.inspirational.contracts.inspire import IInspire
+from orionis.services.inspirational.inspire import Inspire
+
+class InspirationalProvider(ServiceProvider):
+    """
+    Provides and registers the inspirational service within the application container.
+
+    This provider is responsible for determining and registering the appropriate
+    implementation of the inspirational service. It ensures that the service is
+    available for dependency injection throughout the application by binding the
+    `IInspire` contract to its concrete implementation.
+
+    Attributes
+    ----------
+    app : Application
+        The application container instance where services are registered.
+
+    Returns
+    -------
+    None
+        This class does not return a value; it registers services within the container.
+    """
+
+    def register(self) -> None:
+        """
+        Registers the inspirational service in the application container.
+
+        This method binds the `IInspire` contract to its concrete implementation `Inspire`
+        as a transient service within the application's service container. The service is
+        also registered with the alias "core.orionis.inspire" to allow for convenient
+        resolution elsewhere in the application.
+
+        Parameters
+        ----------
+        None
+
+        Returns
+        -------
+        None
+            This method does not return a value. It performs service registration as a side effect.
+        """
+
+        self.app.transient(IInspire, Inspire, alias="core.orionis.inspire")
+
+    def boot(self) -> None:
+        """
+        Executes post-registration initialization for the inspirational service.
+
+        This method is intended for any setup or initialization logic that should
+        occur after the inspirational service has been registered in the application
+        container. By default, it does nothing, but it can be overridden in subclasses
+        to perform additional configuration or resource allocation as needed.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It is intended for side effects only.
+        """
+
+        pass

{orionis-0.442.0 → orionis-0.443.0}/orionis/metadata/framework.py

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

orionis-0.443.0/orionis/services/inspirational/contracts/inspire.py

@@ -0,0 +1,15 @@
+from abc import ABC, abstractmethod
+
+class IInspire(ABC):
+
+    @abstractmethod
+    def random(self) -> dict:
+        """
+        Generate and return a random inspirational item.
+
+        Returns
+        -------
+        dict
+            A dictionary containing the details of the randomly selected inspirational item.
+        """
+        pass  # This method must be implemented by subclasses

orionis-0.443.0/orionis/services/inspirational/inspire.py

@@ -0,0 +1,104 @@
+from typing import Dict, List
+from orionis.services.inspirational.contracts.inspire import IInspire
+from orionis.services.inspirational.quotes import INSPIRATIONAL_QUOTES
+import random
+
+class Inspire(IInspire):
+
+    def __init__(self, quotes: List[Dict] = None) -> None:
+        """
+        Initializes the Inspire service with a list of inspirational quotes.
+
+        This constructor sets up the internal list of quotes to be used by the service.
+        If no list is provided or the provided list is empty, it defaults to using the
+        predefined `INSPIRATIONAL_QUOTES`. The method also validates the structure of
+        the provided quotes to ensure each entry is a dictionary containing both 'quote'
+        and 'author' keys.
+
+        Parameters
+        ----------
+        quotes : List[dict], optional
+            A list of dictionaries, where each dictionary must contain the keys 'quote'
+            (str) and 'author' (str). If not provided or empty, the default list
+            `INSPIRATIONAL_QUOTES` will be used.
+
+        Returns
+        -------
+        None
+            This method does not return any value. It initializes the internal state
+            of the Inspire service.
+
+        Raises
+        ------
+        ValueError
+            If any item in the provided list is not a dictionary, or if a dictionary
+            does not contain both 'quote' and 'author' keys.
+        """
+
+        # Use the default quotes if none are provided or the list is empty
+        if quotes is None or not quotes:
+
+            # Assign the default list of inspirational quotes
+            self.__quotes = INSPIRATIONAL_QUOTES
+
+        # Validate the provided list of quotes
+        else:
+
+            # Validate each quote in the provided list
+            for row in quotes:
+                if not isinstance(row, dict):
+                    raise ValueError("Quotes must be provided as a list of dictionaries.")
+                if 'quote' not in row or 'author' not in row:
+                    raise ValueError("Each quote dictionary must contain 'quote' and 'author' keys.")
+
+            # Assign the validated list of quotes
+            self.__quotes = quotes
+
+    def random(self) -> dict:
+        """
+        Returns a random inspirational quote from the available list.
+
+        This method selects and returns a random quote from the list of inspirational quotes.
+        If the list is empty, it returns a fallback quote to ensure a valid response is always provided.
+
+        Returns
+        -------
+        dict
+            A dictionary containing two keys: 'quote' (str) and 'author' (str), representing
+            the selected inspirational quote and its author. If no quotes are available, a fallback
+            quote is returned.
+        """
+
+        # Count the number of quotes available
+        count = len(self.__quotes)
+
+        # If there are no quotes available, return the fallback quote
+        if count == 0:
+            return self.__fallback()
+
+        # Select a random index within the range of available quotes
+        num_random = random.randint(0, count - 1)
+
+        # Return the randomly selected quote
+        return self.__quotes[num_random] or self.__fallback()
+
+    def __fallback(self) -> dict:
+        """
+        Returns a default inspirational quote when no quotes are available.
+
+        This method provides a fallback quote in case the list of inspirational quotes
+        is empty or unavailable. It ensures that the service always returns a valid
+        response, even in edge cases.
+
+        Returns
+        -------
+        dict
+            A dictionary containing two keys: 'quote' (str) and 'author' (str), representing
+            the fallback inspirational quote and its author.
+        """
+
+        # Return a hardcoded fallback quote and author
+        return {
+            'quote': 'Greatness is not measured by what you build, but by what you inspire others to create.',
+            'author': 'Raul M. Uñate'
+        }