orionis 0.223.0__tar.gz → 0.224.0__tar.gz

{orionis-0.223.0/orionis.egg-info → orionis-0.224.0}/PKG-INFO

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

{orionis-0.223.0 → orionis-0.224.0}/orionis/framework.py

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

orionis-0.224.0/orionis/luminate/support/paths/contracts/resolver.py

@@ -0,0 +1,67 @@
+from abc import ABC, abstractmethod
+from typing import Optional
+
+class IResolver(ABC):
+    """
+    Interface for a utility class that resolves file and directory paths relative to a base path.
+    """
+
+    @abstractmethod
+    def __init__(self, root_path: Optional[str] = None):
+        """
+        Initializes the resolver with an optional root path.
+
+        Parameters
+        ----------
+        root_path : str, optional
+            The root directory to resolve relative paths from.
+        """
+        pass
+
+    @abstractmethod
+    def relativePath(self, relative_path: str):
+        """
+        Resolves a relative path into an absolute one and validates its existence.
+
+        Parameters
+        ----------
+        relative_path : str
+            The relative path to resolve.
+
+        Returns
+        -------
+        ResolverInterface
+            The instance itself for method chaining.
+
+        Raises
+        ------
+        FileNotFoundError
+            If the resolved path does not exist.
+        ValueError
+            If the resolved path is neither a file nor a directory.
+        """
+        pass
+
+    @abstractmethod
+    def toString(self) -> str:
+        """
+        Returns the resolved path as a string.
+
+        Returns
+        -------
+        str
+            The resolved path.
+        """
+        pass
+
+    @abstractmethod
+    def __str__(self) -> str:
+        """
+        Returns the resolved path as a string (for print or str()).
+
+        Returns
+        -------
+        str
+            The resolved path.
+        """
+        pass

orionis-0.224.0/orionis/luminate/support/paths/resolver.py

@@ -0,0 +1,83 @@
+import os
+from pathlib import Path
+from orionis.luminate.support.paths.contracts.resolver import IResolver
+
+class Resolver(IResolver):
+    """
+    A utility class for resolving file and directory paths relative to the project's root directory.
+    """
+
+    def __init__(self, root_path: str = None):
+        """
+        Initializes the Resolver instance with the project's root directory.
+
+        Parameters
+        ----------
+        root_path : str, optional
+            The root directory of the project. If not provided, it defaults to the current working directory.
+        """
+        self.base_path = Path(root_path).resolve() if root_path else Path(os.getcwd()).resolve()
+        self.resolved_path = None
+
+    def relativePath(self, relative_path: str) -> 'Resolver':
+        """
+        Resolves a given relative path to an absolute path and validates its existence.
+
+        This method combines the project's root directory with the provided relative path,
+        resolves it to an absolute path, and ensures it exists as either a directory or a file.
+
+        Parameters
+        ----------
+        relative_path : str
+            The relative path to a directory or file to be resolved.
+
+        Returns
+        -------
+        Resolver
+            The current instance of the Resolver class with the resolved path.
+
+        Raises
+        ------
+        FileNotFoundError
+            If the resolved path does not exist.
+        ValueError
+            If the resolved path is neither a valid directory nor a file.
+        """
+        # Combine the base path with the relative path and resolve it
+        resolved_path = (self.base_path / relative_path).resolve()
+
+        # Validate that the path exists
+        if not resolved_path.exists():
+            raise FileNotFoundError(f"The requested path does not exist: {resolved_path}")
+
+        # Validate that the path is either a directory or a file
+        if not (resolved_path.is_dir() or resolved_path.is_file()):
+            raise ValueError(f"The requested path is neither a valid directory nor a file: {resolved_path}")
+
+        # Store the resolved path in the instance variable
+        self.resolved_path = resolved_path
+
+        # Return the current instance
+        return self
+
+    def toString(self) -> str:
+        """
+        Returns the string representation of the resolved path.
+
+        Returns
+        -------
+        str
+            The resolved path as a string.
+        """
+        return str(self.resolved_path)
+
+    def __str__(self) -> str:
+        """
+        Returns the string representation of the resolved path.
+
+        Returns
+        -------
+        str
+            The resolved path as a string.
+        """
+        return str(self.resolved_path)

{orionis-0.223.0 → orionis-0.224.0/orionis.egg-info}/PKG-INFO

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

{orionis-0.223.0 → orionis-0.224.0}/orionis.egg-info/SOURCES.txt

@@ -172,6 +172,7 @@ orionis/luminate/support/adapters/__init__.py
 orionis/luminate/support/adapters/dot_dict.py
 orionis/luminate/support/asynchrony/__init__.py
 orionis/luminate/support/asynchrony/async_io.py
+orionis/luminate/support/asynchrony/contracts/__init__.py
 orionis/luminate/support/asynchrony/contracts/async_coroutine.py
 orionis/luminate/support/inspection/__init__.py
 orionis/luminate/support/inspection/container_integrity.py
@@ -191,6 +192,10 @@ orionis/luminate/support/parsers/__init__.py
 orionis/luminate/support/parsers/exception_parser.py
 orionis/luminate/support/parsers/contracts/__init__.py
 orionis/luminate/support/parsers/contracts/exception_parser.py
+orionis/luminate/support/paths/__init__.py
+orionis/luminate/support/paths/resolver.py
+orionis/luminate/support/paths/contracts/__init__.py
+orionis/luminate/support/paths/contracts/resolver.py
 orionis/luminate/support/patterns/__init__.py
 orionis/luminate/support/patterns/singleton.py
 orionis/luminate/support/standard/__init__.py
@@ -244,6 +249,8 @@ tests/support/parsers/__init__.py
 tests/support/parsers/test_exception_parser.py
 tests/support/parsers/fakes/__init__.py
 tests/support/parsers/fakes/fake_custom_error.py
+tests/support/path/__init__.py
+tests/support/path/test_resolver.py
 tests/support/patterns/__init__.py
 tests/support/patterns/test_singleton.py
 tests/support/standard/__init__.py

orionis-0.224.0/tests/support/path/test_resolver.py

@@ -0,0 +1,33 @@
+from orionis.luminate.support.paths.resolver import Resolver
+from orionis.luminate.test.test_case import TestCase
+
+class TestsResolver(TestCase):
+
+    async def testFileNotFound(self):
+        """
+        Test the Resolver class for a non-existent file path.
+        """
+        file_path = "non_existent_file.txt"
+        with self.assertRaises(FileNotFoundError):
+            Resolver().relativePath(file_path)
+
+    async def testValidFilePath(self):
+        """
+        Test the Resolver class for a valid file path.
+        """
+        path = Resolver().relativePath('orionis/luminate/test/test_suite.py').toString()
+        self.assertTrue(path.endswith('test_suite.py'))
+
+    async def testOtherBasePath(self):
+        """
+        Test the Resolver class for a different base path.
+        """
+        path = Resolver('orionis/luminate/test').relativePath('test_suite.py').toString()
+        self.assertTrue(path.endswith('test_suite.py'))
+
+    async def testEqualOutputString(self):
+        """
+        Test the Resolver class for a string representation of the resolved path.
+        """
+        path = Resolver().relativePath('orionis/luminate/test/test_suite.py')
+        self.assertEqual(path.toString(), str(path))