orionis 0.226.0__py3-none-any.whl → 0.228.0__py3-none-any.whl

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/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/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/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.dist-info → orionis-0.228.0.dist-info}/METADATA

@@ -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.dist-info → orionis-0.228.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 orionis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/console.py,sha256=4gYWxf0fWYgJ4RKwARvnTPh06FL3GJ6SAZ7R2NzOICw,1342
-orionis/framework.py,sha256=WYK-9gzaBegqDEoeIGgEf97ew3r9EJI00joFmIpMfb0,1458
+orionis/framework.py,sha256=yvd4Qh0vImy8fXZUPVQya7sgXqCfXJMdu9FsRwpsthQ,1458
 orionis/installer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/installer/manager.py,sha256=Li4TVziRXWfum02xNG4JHwbnLk-u8xzHjdqKz-D894k,2755
 orionis/installer/output.py,sha256=7O9qa2xtXMB_4ZvVi-Klneom9YazwygAd_4uYAoxhbU,8548
@@ -161,9 +161,11 @@ orionis/luminate/support/asynchrony/async_io.py,sha256=IkgVrJnnvNExkhy9brfZpTq2E
 orionis/luminate/support/asynchrony/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/luminate/support/asynchrony/contracts/async_coroutine.py,sha256=lwtDa6r7I6qbxzKr5MyJtMRaYW6e5j2dbymEPNaNIEo,614
 orionis/luminate/support/environment/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/luminate/support/environment/env.py,sha256=MgFZ53fG77eugimdXfuYsbpXBadgi0KaM3b_DNB02D8,3291
-orionis/luminate/support/environment/functions.py,sha256=qiKc2oPaWwspSeUF0E8ZZYMsKlFDI1VGLl6vfpAnP4s,1129
+orionis/luminate/support/environment/env.py,sha256=smBVhxIJr4U0RO6CzqtQJLEu_il2Exjpa_564o2PTcI,4085
+orionis/luminate/support/environment/functions.py,sha256=L6gL4z3c89ZU17IWvOXyQ2_GdzA3XOmXeQpIpnQRios,1330
 orionis/luminate/support/environment/helper.py,sha256=G1670w1xkI1pj-rW_inv6D3XmU4oliwnWnrJO5CBm2E,818
+orionis/luminate/support/environment/contracts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+orionis/luminate/support/environment/contracts/env.py,sha256=buJfzebBOUuq2CnhQCWlnJuzJAEo06-S0_SPR4N_mOY,1647
 orionis/luminate/support/inspection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/luminate/support/inspection/container_integrity.py,sha256=6d9FsGk-Rm1AXgqBS3Nww49dR7n1ptXTTNyGUuBHgNY,10111
 orionis/luminate/support/inspection/functions.py,sha256=4wDT7iNp-5l4vuHk0UsIxN9wakASJRD4V0KY24uMDzk,7227
@@ -224,8 +226,7 @@ tests/support/adapters/fakes/fake_dict.py,sha256=KD48_xBc8pqj3LAe1_v1esu-1Fdz8fL
 tests/support/async_io/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/support/async_io/test_async_coroutine.py,sha256=qXmpfyqaeNUSRQFdKVViGiF2FsRQle9VqyFeR-jAetg,1532
 tests/support/environment/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/support/environment/test_env.py,sha256=jRJ2Xa7_cEnZg-1KzHOIDvGa0vQ-GxIw3u-MhuC3Aks,1899
-tests/support/environment/test_helper.py,sha256=YDTJMl-zAivnchPJMDzDh520GP73OL-nbU_LzRuZCeA,414
+tests/support/environment/test_env.py,sha256=w1TyhnM-xSgAmFr42pEuwGOyww16EboumndY_agDWPA,2662
 tests/support/inspection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/support/inspection/test_reflection_abstract.py,sha256=6w8vm8H_fR4Z-KYjQGm8bq-HcetlpQl0EsDmDy3WzQ8,9311
 tests/support/inspection/test_reflection_concrete.py,sha256=3BWSU7MkFEv2UgAVAwhiaMrzEwAyDBBJCa6edOENKSU,6782
@@ -248,9 +249,9 @@ tests/support/patterns/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 tests/support/patterns/test_singleton.py,sha256=U5uwpgGcP7-fIazsnFLwg30mmc24S62udhVIHuL-scY,634
 tests/support/standard/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/support/standard/test_std.py,sha256=bJ5LV_OKEEZa_Bk3PTk9Kapk6qECLzcKf0hfR_x2QqM,2042
-orionis-0.226.0.dist-info/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
-orionis-0.226.0.dist-info/METADATA,sha256=rxazC_s4DLlzY7n4jvuU5xLvrOEXxgZDsWdlXJzs0Fw,3003
-orionis-0.226.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-orionis-0.226.0.dist-info/entry_points.txt,sha256=a_e0faeSqyUCVZd0MqljQ2oaHHdlsz6g9sU_bMqi5zQ,49
-orionis-0.226.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
-orionis-0.226.0.dist-info/RECORD,,
+orionis-0.228.0.dist-info/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
+orionis-0.228.0.dist-info/METADATA,sha256=_wFvSjxKzyhc20WErhCgMTt0Hv9o9WpU8Qcsus_2PXk,3003
+orionis-0.228.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+orionis-0.228.0.dist-info/entry_points.txt,sha256=a_e0faeSqyUCVZd0MqljQ2oaHHdlsz6g9sU_bMqi5zQ,49
+orionis-0.228.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
+orionis-0.228.0.dist-info/RECORD,,

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()

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')