orionis 0.288.0__py3-none-any.whl → 0.289.0__py3-none-any.whl

orionis/metadata/framework.py

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

orionis/metadata/package.py

@@ -7,38 +7,9 @@ class PypiPackageApi:
     This class initializes by retrieving package information from the PyPI JSON API for the 'orionis' package.
     It exposes various methods to access metadata such as the package name, version, author, description, license,
     classifiers, required Python version, keywords, and project URLs.
-    Attributes:
-        _baseUrl (str): The URL to the PyPI JSON API for the Orionis package.
-        _info (dict): A dictionary containing the package metadata fetched from PyPI.
-    Methods:
-        getAllData():
-            Fetches and updates the internal information dictionary with the latest data from PyPI.
-        getName():
-            Returns the CLI name by appending '-cli' to the package name.
-        getVersion():
-            Returns the version string of the framework.
-        getAuthor():
-            Returns the author's name.
-        getAuthorEmail():
-            Returns the author's email address.
-        getDescription():
-            Returns the summary description of the framework.
-        getUrl():
-            Returns the homepage URL of the project.
-        getLongDescription():
-        getDescriptionContentType():
-            Returns the content type of the long description.
-        getLicense():
-            Returns the license type, defaulting to "MIT" if not specified.
-        getClassifiers():
-            Returns a list of PyPI classifiers for the package.
-        getPythonVersion():
-            Returns the required Python version specification.
-        getKeywords():
-            Returns a list of keywords associated with the package.
     """
 
-    def __init__(self):
+    def __init__(self) -> None:
         """
         Initializes the class by setting the base URL for the Orionis PyPI package,
         initializing the information dictionary, and retrieving all package data.
@@ -47,7 +18,7 @@ class PypiPackageApi:
         self._info = {}
         self.getAllData()
 
-    def getAllData(self):
+    def getAllData(self) -> dict:
         """
         Fetches all data from the base URL and updates the internal info attribute.
 
@@ -76,16 +47,16 @@ class PypiPackageApi:
                 f"Invalid response structure from PyPI: {ve}"
             )
 
-    def getName(self):
+    def getName(self) -> str:
         """
-        Returns the CLI name by appending '-cli' to the value of the 'name' key in the _info dictionary.
+        Returns the package name from the value of the 'name' key in the _info dictionary.
 
         Returns:
-            str: The CLI name in the format '<name>-cli'.
+            str: The package name.
         """
-        return f"{self._info['name']}-cli"
+        return self._info['name']
 
-    def getVersion(self):
+    def getVersion(self) -> str:
         """
         Returns the version information of the framework.
 
@@ -94,7 +65,7 @@ class PypiPackageApi:
         """
         return self._info['version']
 
-    def getAuthor(self):
+    def getAuthor(self) -> str:
         """
         Returns the author of the framework.
 
@@ -103,7 +74,7 @@ class PypiPackageApi:
         """
         return self._info['author']
 
-    def getAuthorEmail(self):
+    def getAuthorEmail(self) -> str:
         """
         Retrieve the author's email address from the internal information dictionary.
 
@@ -112,7 +83,7 @@ class PypiPackageApi:
         """
         return self._info['author_email']
 
-    def getDescription(self):
+    def getDescription(self) -> str:
         """
         Returns the summary description from the internal information dictionary.
 
@@ -121,7 +92,7 @@ class PypiPackageApi:
         """
         return self._info['summary']
 
-    def getUrl(self):
+    def getUrl(self) -> str:
         """
         Retrieves the homepage URL from the project's information.
 
@@ -130,7 +101,7 @@ class PypiPackageApi:
         """
         return self._info['project_urls']['Homepage']
 
-    def getLongDescription(self):
+    def getLongDescription(self) -> str:
         """
         Returns the long description of the framework.
 
@@ -139,7 +110,7 @@ class PypiPackageApi:
         """
         return self._info['description']
 
-    def getDescriptionContentType(self):
+    def getDescriptionContentType(self) -> str:
         """
         Returns the content type of the description from the internal information dictionary.
 
@@ -148,7 +119,7 @@ class PypiPackageApi:
         """
         return self._info['description_content_type']
 
-    def getLicense(self):
+    def getLicense(self) -> str:
         """
         Returns the license type specified in the framework information.
 
@@ -159,7 +130,7 @@ class PypiPackageApi:
         """
         return self._info['license'] or "MIT"
 
-    def getClassifiers(self):
+    def getClassifiers(self) -> list:
         """
         Returns the list of classifiers from the internal _info dictionary.
 
@@ -168,7 +139,7 @@ class PypiPackageApi:
         """
         return self._info['classifiers']
 
-    def getPythonVersion(self):
+    def getPythonVersion(self) -> str:
         """
         Retrieves the required Python version for the framework.
 
@@ -177,7 +148,7 @@ class PypiPackageApi:
         """
         return self._info['requires_python']
 
-    def getKeywords(self):
+    def getKeywords(self) -> list:
         """
         Retrieve the list of keywords associated with the current object.
 

{orionis-0.288.0.dist-info → orionis-0.289.0.dist-info}/METADATA

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

{orionis-0.288.0.dist-info → orionis-0.289.0.dist-info}/RECORD

@@ -226,8 +226,8 @@ orionis/foundation/config/testing/entities/testing.py,sha256=m_i9jZlOXs_AzNKNNf0
 orionis/foundation/config/testing/enums/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/foundation/config/testing/enums/test_mode.py,sha256=IbFpauu7J-iSAfmC8jDbmTEYl8eZr-AexL-lyOh8_74,337
 orionis/metadata/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-orionis/metadata/framework.py,sha256=x5OCBOB5MhrzuSEZtVFLy7Il8jOL888WhWR3pKwdJio,4960
-orionis/metadata/package.py,sha256=5p4fxjPpaktsreJ458pAl-Oi1363MWACPQvqXi_N6oA,6704
+orionis/metadata/framework.py,sha256=jGJvnj_7dnLfXIAVVVGam0pSWqJ-lOA_dsfHtD5mD6g,4960
+orionis/metadata/package.py,sha256=tqLfBRo-w1j_GN4xvzUNFyweWYFS-qhSgAEc-AmCH1M,5452
 orionis/patterns/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/patterns/singleton/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/patterns/singleton/meta_class.py,sha256=YN5mSSQeIX_Gh_TK5HD-ms6IYBTRsRcuzoUtpX-9kYY,2134
@@ -351,7 +351,7 @@ orionis/test/suites/contracts/test_suite.py,sha256=eluzYwkNBbKjxYStj_tHN_Fm3YDPp
 orionis/test/suites/contracts/test_unit.py,sha256=l1LQllODyvcSByXMl1lGrUkoLsXbBHZZLWZI4A-mlQg,5881
 orionis/test/view/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 orionis/test/view/index.html,sha256=U4XYO4hA-mAJCK1gcVRgIysmISK3g3Vgi2ntLofFAhE,6592
-orionis-0.288.0.dist-info/licenses/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
+orionis-0.289.0.dist-info/licenses/LICENCE,sha256=-_4cF2EBKuYVS_SQpy1uapq0oJPUU1vl_RUWSy2jJTo,1111
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/example/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/example/test_example.py,sha256=byd_lI6tVDgGPEIrr7PLZbBu0UoZOymmdmyA_4u-QUw,601
@@ -408,6 +408,9 @@ tests/foundation/config/startup/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
 tests/foundation/config/startup/test_foundation_config_startup.py,sha256=xD5wuPAFsQMAuRACgK_O5wowPLZY-uftXNgxtFjnP7o,6776
 tests/foundation/config/testing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/foundation/config/testing/test_foundation_config_testing.py,sha256=AuR-h2974Hkdpo4iCkYOJyr8kydmDGN6G2wbVOYcqGM,8216
+tests/metadata/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/metadata/test_metadata_framework.py,sha256=V-GXnReHepHLGFvY9hQTYWrzVGgC-P7SinKHCmElXDA,3266
+tests/metadata/test_metadata_package.py,sha256=_vz476d-6ZdMrfnczWaO2kGUzjNPwEQSlVAHz6xOwNM,1773
 tests/patterns/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/patterns/singleton/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/patterns/singleton/test_patterns_singleton.py,sha256=DCvc-3nmsrM1xJr9WGeFZHyB-IVUVVGhfjvkly2E8rU,951
@@ -424,9 +427,9 @@ tests/services/inspection/dependencies/mocks/mock_user.py,sha256=RxATxe0-Vm4HfX5
 tests/services/inspection/dependencies/mocks/mock_user_controller.py,sha256=P3sOUXVZ55auudwiNtvNCEQuTz0cgAZjvhicLZ4xaz4,1208
 tests/services/inspection/dependencies/mocks/mock_users_permissions.py,sha256=oENXbS2qmQUudYSmnhB8fgHBqXZdbplplB-Y2nbx4hw,1388
 tests/services/parsers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/services/parsers/test_exception_parser.py,sha256=zk9h16FDJb5OopcTzqcHMH9ZTbL9-ztKjUeKSfgpuMY,2334
+tests/services/parsers/test_services_parser_exceptions.py,sha256=fCi_nUsXSh80r7HzQibXbUuYMpqjBefsP-QPF76MLfM,2650
 tests/services/parsers/mocks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/services/parsers/mocks/mock_custom_error.py,sha256=W4rrnK0S5wGDNRyN0hNFuGmUfOpRS2iJBTv6nxOjPiQ,518
+tests/services/parsers/mocks/mock_custom_error.py,sha256=LWgjeog2rpmfw6j7Bgzvfvmeby8uSBuB1B3d_DgRcFQ,752
 tests/services/path/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/services/path/test_services_resolver.py,sha256=ny6vyx_psF9iWXyMhqI95SJs84_dD1NIOXt0k1MfBQA,3902
 tests/services/standard/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -452,8 +455,8 @@ tests/support/inspection/fakes/fake_reflection_instance_with_abstract.py,sha256=
 tests/testing/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/testing/test_testing_result.py,sha256=MrGK3ZimedL0b5Ydu69Dg8Iul017AzLTm7VPxpXlpfU,4315
 tests/testing/test_testing_unit.py,sha256=A6QkiOkP7GPC1Szh_GqsrV7GxjWjK8cIwFez6YfrzmM,7683
-orionis-0.288.0.dist-info/METADATA,sha256=43ady3vDJBtIQQa48YPKjdDYp_OjIKPS__6uSiUtdQ8,4772
-orionis-0.288.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-orionis-0.288.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
-orionis-0.288.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
-orionis-0.288.0.dist-info/RECORD,,
+orionis-0.289.0.dist-info/METADATA,sha256=h7nzzgx-NOJZldvDJfW1X8_f5Ddp3k9Th-zxu7HWm_c,4772
+orionis-0.289.0.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
+orionis-0.289.0.dist-info/top_level.txt,sha256=2bdoHgyGZhOtLAXS6Om8OCTmL24dUMC_L1quMe_ETbk,14
+orionis-0.289.0.dist-info/zip-safe,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+orionis-0.289.0.dist-info/RECORD,,

tests/metadata/test_metadata_framework.py

@@ -0,0 +1,101 @@
+from orionis.metadata.framework import *
+from orionis.test.cases.test_case import TestCase
+
+class TestMetadataFramework(TestCase):
+    """
+    Test cases for the metadata constants and utility functions in orionis.metadata.framework.
+
+    Notes
+    -----
+    This test suite validates the existence, type, and structure of metadata constants and utility
+    functions provided by the `orionis.metadata.framework` module.
+    """
+
+    async def testConstantsExistAndAreStr(self):
+        """
+        Test that all metadata constants exist and are of type `str`.
+
+        Raises
+        ------
+        AssertionError
+            If any constant is not a string.
+        """
+        for const in [
+            NAME, VERSION, AUTHOR, AUTHOR_EMAIL, DESCRIPTION,
+            SKELETON, FRAMEWORK, DOCS, API, PYTHON_REQUIRES
+        ]:
+            assert isinstance(const, str)
+
+    async def testClassifiersStructure(self):
+        """
+        Test that `CLASSIFIERS` is a list of tuples of strings.
+
+        Raises
+        ------
+        AssertionError
+            If `CLASSIFIERS` is not a list of tuples of strings.
+        """
+        assert isinstance(CLASSIFIERS, list)
+        for item in CLASSIFIERS:
+            assert isinstance(item, tuple)
+            assert all(isinstance(part, str) for part in item)
+
+    async def testGetClassifiers(self):
+        """
+        Test that `get_classifiers` returns a list of classifier strings.
+
+        Raises
+        ------
+        AssertionError
+            If the returned value is not a list of strings containing '::'.
+        """
+        classifiers = get_classifiers()
+        assert isinstance(classifiers, list)
+        for c in classifiers:
+            assert isinstance(c, str)
+            assert " :: " in c or len(c.split(" :: ")) > 1
+
+    async def testKeywords(self):
+        """
+        Test that `KEYWORDS` is a list of strings and contains specific keywords.
+
+        Raises
+        ------
+        AssertionError
+            If `KEYWORDS` is not a list of strings or required keywords are missing.
+        """
+        assert isinstance(KEYWORDS, list)
+        for kw in KEYWORDS:
+            assert isinstance(kw, str)
+        assert "orionis" in KEYWORDS
+        assert "framework" in KEYWORDS
+
+    async def testRequiresStructure(self):
+        """
+        Test that `REQUIRES` is a list of 2-element tuples of strings.
+
+        Raises
+        ------
+        AssertionError
+            If `REQUIRES` is not a list of 2-element tuples of strings.
+        """
+        assert isinstance(REQUIRES, list)
+        for req in REQUIRES:
+            assert isinstance(req, tuple)
+            assert len(req) == 2
+            assert all(isinstance(part, str) for part in req)
+
+    async def testGetRequires(self):
+        """
+        Test that `get_requires` returns a list of requirement strings.
+
+        Raises
+        ------
+        AssertionError
+            If the returned value is not a list of strings containing '>='.
+        """
+        requires = get_requires()
+        assert isinstance(requires, list)
+        for req in requires:
+            assert isinstance(req, str)
+            assert ">=" in req

tests/metadata/test_metadata_package.py

@@ -0,0 +1,69 @@
+from orionis.unittesting import TestCase
+from orionis.metadata.package import PypiPackageApi
+
+class TestPypiPackageApi(TestCase):
+
+    async def testGetName(self):
+        """
+        Test getName method.
+
+        Tests that getName returns the correct package name.
+
+        Returns
+        -------
+        None
+        """
+        api = PypiPackageApi()
+        self.assertEqual(api.getName(), "orionis")
+
+    async def testGetAuthor(self):
+        """
+        Test getAuthor method.
+
+        Tests that getAuthor returns the correct author name.
+
+        Returns
+        -------
+        None
+        """
+        api = PypiPackageApi()
+        self.assertEqual(api.getAuthor(), "Raul Mauricio Uñate Castro")
+
+    async def testGetAuthorEmail(self):
+        """
+        Test getAuthorEmail method.
+
+        Tests that getAuthorEmail returns the correct author email.
+
+        Returns
+        -------
+        None
+        """
+        api = PypiPackageApi()
+        self.assertEqual(api.getAuthorEmail(), "raulmauriciounate@gmail.com")
+
+    async def testGetDescription(self):
+        """
+        Test getDescription method.
+
+        Tests that getDescription returns the correct description.
+
+        Returns
+        -------
+        None
+        """
+        api = PypiPackageApi()
+        self.assertEqual(api.getDescription(), "Orionis Framework – Elegant, Fast, and Powerful.")
+
+    async def testGetPythonVersion(self):
+        """
+        Test getPythonVersion method.
+
+        Tests that getPythonVersion returns the correct required Python version.
+
+        Returns
+        -------
+        None
+        """
+        api = PypiPackageApi()
+        self.assertEqual(api.getPythonVersion(), ">=3.12")

tests/services/parsers/mocks/mock_custom_error.py

@@ -1,15 +1,25 @@
 class CustomError(Exception):
     """
-    A custom exception class for handling errors with an optional error code.
+    Custom exception class for handling errors with an optional error code.
+
+    Parameters
+    ----------
+    message : str
+        The error message describing the exception.
+    code : any, optional
+        An optional error code associated with the exception.
     """
 
     def __init__(self, message, code=None):
         """
         Initialize the custom error with a message and an optional error code.
 
-        Args:
-            message (str): The error message describing the exception.
-            code (Optional[Any]): An optional error code associated with the exception.
+        Parameters
+        ----------
+        message : str
+            The error message describing the exception.
+        code : any, optional
+            An optional error code associated with the exception.
         """
         super().__init__(message)
         self.code = code

tests/services/parsers/{test_exception_parser.py → test_services_parser_exceptions.py}

@@ -2,11 +2,15 @@ from orionis.services.parsers.serializer import Parser
 from orionis.unittesting import TestCase
 from tests.services.parsers.mocks.mock_custom_error import CustomError
 
-class TestsExceptionParser(TestCase):
+class TestServicesParserExceptions(TestCase):
 
     async def testBasicExceptionStructure(self):
         """
         Ensure that the ExceptionParser correctly structures a basic exception.
+
+        Returns
+        -------
+        None
         """
         try:
             raise ValueError("Something went wrong")
@@ -29,7 +33,11 @@ class TestsExceptionParser(TestCase):
 
     async def testRawExceptionProperty(self):
         """
-        Ensure that the raw_exception property returns the original exception.
+        Ensure that the rawException property returns the original exception.
+
+        Returns
+        -------
+        None
         """
         try:
             raise RuntimeError("Test exception")
@@ -38,6 +46,13 @@ class TestsExceptionParser(TestCase):
             self.assertIs(parser.raw_exception, e)
 
     async def testExceptionWithCode(self):
+        """
+        Ensure that exceptions with a custom error code are serialized correctly.
+
+        Returns
+        -------
+        None
+        """
         try:
             raise CustomError("Custom message", code=404)
         except Exception as e:
@@ -48,6 +63,10 @@ class TestsExceptionParser(TestCase):
     async def testNestedExceptionCause(self):
         """
         Ensure that the Parser.exception correctly handles nested exceptions.
+
+        Returns
+        -------
+        None
         """
         try:
             try: