orionis 0.226.0__tar.gz → 0.228.0__tar.gz

{orionis-0.226.0/orionis.egg-info → orionis-0.228.0}/PKG-INFO

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

{orionis-0.226.0 → orionis-0.228.0}/orionis/framework.py

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

orionis-0.228.0/orionis/luminate/support/environment/contracts/env.py

@@ -0,0 +1,68 @@
+from abc import ABC, abstractmethod
+from typing import Any, Optional, Union
+
+class IEnv(ABC):
+    """
+    Interface for a utility class to manage environment variables in a `.env` file.
+    """
+
+    @staticmethod
+    @abstractmethod
+    def get(key: str, default: Optional[Any] = None) -> Any:
+        """
+        Retrieve the value of an environment variable.
+
+        Parameters
+        ----------
+        key : str
+            Name of the environment variable.
+        default : Any, optional
+            Default value if variable is not found.
+
+        Returns
+        -------
+        Any
+            Parsed value or default.
+        """
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def set(key: str, value: Union[str, int, float, bool, list, dict]) -> None:
+        """
+        Set the value of an environment variable.
+
+        Parameters
+        ----------
+        key : str
+            Name of the environment variable.
+        value : str, int, float, bool, list, or dict
+            Value to assign, will be serialized.
+        """
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def unset(key: str) -> None:
+        """
+        Remove an environment variable.
+
+        Parameters
+        ----------
+        key : str
+            Name of the environment variable.
+        """
+        pass
+
+    @staticmethod
+    @abstractmethod
+    def all() -> dict:
+        """
+        Retrieve all environment variables as a dictionary.
+
+        Returns
+        -------
+        dict
+            Dictionary of parsed environment variables.
+        """
+        pass

{orionis-0.226.0 → orionis-0.228.0}/orionis/luminate/support/environment/env.py

@@ -1,13 +1,15 @@
 import os
 from typing import Any, Optional, Union
 from dotenv import set_key, unset_key, dotenv_values
+from orionis.luminate.support.environment.contracts.env import IEnv
 from orionis.luminate.support.environment.functions import (
     _initialize,
     _parse_value,
     _serialize_value,
+    _delete_file
 )
 
-class Env:
+class Env(IEnv):
     """
     A utility class for managing environment variables stored in a `.env` file.
     """
@@ -102,3 +104,35 @@ class Env:
             env_vars[key] = _parse_value(value)
 
         return env_vars
+
+    @staticmethod
+    def initialize() -> None:
+        """
+        Initializes the `.env` file if it does not exist.
+
+        Parameters
+        ----------
+        path : str or Path, optional
+            The path to the `.env` file. If None, a default path is used.
+
+        Returns
+        -------
+        None
+        """
+        _initialize()
+
+    @staticmethod
+    def destroy() -> None:
+        """
+        Deletes the `.env` file.
+
+        Parameters
+        ----------
+        path : str or Path, optional
+            The path to the `.env` file. If None, a default path is used.
+
+        Returns
+        -------
+        None
+        """
+        _delete_file()

{orionis-0.226.0 → orionis-0.228.0}/orionis/luminate/support/environment/functions.py

@@ -38,4 +38,12 @@ def _serialize_value(value: Any) -> str:
     """
     if isinstance(value, (list, dict, bool, int, float)):
         return repr(value)
-    return str(value)
+    return str(value)
+
+def _delete_file() -> None:
+    """
+    Elimina el archivo especificado.
+    """
+    resolved_path = Path(os.getcwd()) / ".env"
+    if resolved_path.exists():
+        os.remove(resolved_path)

{orionis-0.226.0 → orionis-0.228.0/orionis.egg-info}/PKG-INFO

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

{orionis-0.226.0 → orionis-0.228.0}/orionis.egg-info/SOURCES.txt

@@ -174,6 +174,8 @@ orionis/luminate/support/environment/__init__.py
 orionis/luminate/support/environment/env.py
 orionis/luminate/support/environment/functions.py
 orionis/luminate/support/environment/helper.py
+orionis/luminate/support/environment/contracts/__init__.py
+orionis/luminate/support/environment/contracts/env.py
 orionis/luminate/support/inspection/__init__.py
 orionis/luminate/support/inspection/container_integrity.py
 orionis/luminate/support/inspection/functions.py
@@ -235,7 +237,6 @@ tests/support/async_io/__init__.py
 tests/support/async_io/test_async_coroutine.py
 tests/support/environment/__init__.py
 tests/support/environment/test_env.py
-tests/support/environment/test_helper.py
 tests/support/inspection/__init__.py
 tests/support/inspection/test_reflection_abstract.py
 tests/support/inspection/test_reflection_concrete.py

{orionis-0.226.0 → orionis-0.228.0}/tests/support/environment/test_env.py

@@ -19,6 +19,9 @@ class TestsEnvironment(TestCase):
         result = Env.get('NON_EXISTENT_KEY', True)
         self.assertEqual(result, True)
 
+        # Delete File .env
+        Env.destroy()
+
     async def testSetEnvVariable(self):
         """
         Test setting an environment variable in the `.env` file.
@@ -31,6 +34,9 @@ class TestsEnvironment(TestCase):
         result = Env.get('TEST_KEY')
         self.assertEqual(result, 'NEW_VALUE')
 
+        # Delete File .env
+        Env.destroy()
+
     async def testUnsetEnvVariable(self):
         """
         Test removing an environment variable from the `.env` file.
@@ -44,6 +50,27 @@ class TestsEnvironment(TestCase):
         result = Env.get('TEST_KEY')
         self.assertIsNone(result)
 
+        # Delete File .env
+        Env.destroy()
+
+    async def testGetEnvHelper(self):
+        """"
+        Test retrieving an environment variable using the env helper.
+        """
+
+        # Mock the environment setup
+        Env.set('FRAMEWORK', 'https://github.com/orionis-framework/framework')
+
+        # Import the env helper and retrieve the variable
+        from orionis.luminate.support.environment.helper import env as get_env
+        result = get_env('FRAMEWORK')
+
+        # Verify the result
+        self.assertEqual(result, 'https://github.com/orionis-framework/framework')
+
+        # Delete File .env
+        Env.destroy()
+
     async def test_get_all_env_variables(self):
         """
         Test retrieving all environment variables from the `.env` file.
@@ -60,5 +87,5 @@ class TestsEnvironment(TestCase):
         self.assertEqual(result.get('KEY1'), 'value1')
         self.assertEqual(result.get('KEY2'), 'value2')
 
-        Env.unset('KEY1')
-        Env.unset('KEY2')
+        # Delete File .env
+        Env.destroy()

orionis-0.226.0/tests/support/environment/test_helper.py

@@ -1,11 +0,0 @@
-from orionis.luminate.support.environment.helper import env
-from orionis.luminate.test.test_case import TestCase
-
-class TestsEnvironmentHelper(TestCase):
-
-    async def testGetEnvHelper(self):
-        """"
-        Test retrieving an environment variable using the env helper.
-        """
-        result = env('FRAMEWORK')
-        self.assertEqual(result, 'https://github.com/orionis-framework/framework')