orionis 0.582.0__py3-none-any.whl → 0.584.0__py3-none-any.whl

orionis/foundation/config/roots/paths.py

@@ -14,35 +14,35 @@ class Paths(BaseEntity):
         }
     )
 
-    console: str = field(
-        default_factory = lambda: str((Path.cwd() / 'app' / 'console').resolve()),
+    app: str = field(
+        default_factory = lambda: str((Path.cwd() / 'app').resolve()),
         metadata = {
-            'description': 'Directory containing subfolders for console commands and scheduler.py.',
-            'default': lambda: str((Path.cwd() / 'app' / 'console').resolve())
+            'description': 'The main application directory containing core code.',
+            'default': lambda: str((Path.cwd() / 'app').resolve())
         }
     )
 
-    controllers: str = field(
-        default_factory = lambda: str((Path.cwd() / 'app' / 'http' / 'controllers').resolve()),
+    console: str = field(
+        default_factory = lambda: str((Path.cwd() / 'app' / 'console').resolve()),
         metadata = {
-            'description': 'Directory containing HTTP controller classes.',
-            'default': lambda: str((Path.cwd() / 'app' / 'http' / 'controllers').resolve())
+            'description': 'Directory containing subfolders for console commands and scheduler.py.',
+            'default': lambda: str((Path.cwd() / 'app' / 'console').resolve())
         }
     )
 
-    middleware: str = field(
-        default_factory = lambda: str((Path.cwd() / 'app' / 'http' / 'middleware').resolve()),
+    exceptions: str = field(
+        default_factory = lambda: str((Path.cwd() / 'app' / 'exceptions').resolve()),
         metadata = {
-            'description': 'Directory containing HTTP middleware classes.',
-            'default': lambda: str((Path.cwd() / 'app' / 'http' / 'middleware').resolve())
+            'description': 'Directory containing exception handler classes.',
+            'default': lambda: str((Path.cwd() / 'app' / 'exceptions').resolve())
         }
     )
 
-    requests: str = field(
-        default_factory = lambda: str((Path.cwd() / 'app' / 'http' / 'requests').resolve()),
+    http: str = field(
+        default_factory = lambda: str((Path.cwd() / 'app' / 'http').resolve()),
         metadata = {
-            'description': 'Directory containing HTTP form request validation classes.',
-            'default': lambda: str((Path.cwd() / 'app' / 'http' / 'requests').resolve())
+            'description': 'Directory containing HTTP-related classes (controllers, middleware, requests).',
+            'default': lambda: str((Path.cwd() / 'app' / 'http').resolve())
         }
     )
 
@@ -62,22 +62,6 @@ class Paths(BaseEntity):
         }
     )
 
-    events: str = field(
-        default_factory = lambda: str((Path.cwd() / 'app' / 'events').resolve()),
-        metadata = {
-            'description': 'Directory containing event classes.',
-            'default': lambda: str((Path.cwd() / 'app' / 'events').resolve())
-        }
-    )
-
-    listeners: str = field(
-        default_factory = lambda: str((Path.cwd() / 'app' / 'listeners').resolve()),
-        metadata = {
-            'description': 'Directory containing event listener classes.',
-            'default': lambda: str((Path.cwd() / 'app' / 'listeners').resolve())
-        }
-    )
-
     notifications: str = field(
         default_factory = lambda: str((Path.cwd() / 'app' / 'notifications').resolve()),
         metadata = {
@@ -86,30 +70,6 @@ class Paths(BaseEntity):
         }
     )
 
-    jobs: str = field(
-        default_factory = lambda: str((Path.cwd() / 'app' / 'jobs').resolve()),
-        metadata = {
-            'description': 'Directory containing queued job classes.',
-            'default': lambda: str((Path.cwd() / 'app' / 'jobs').resolve())
-        }
-    )
-
-    policies: str = field(
-        default_factory = lambda: str((Path.cwd() / 'app' / 'policies').resolve()),
-        metadata = {
-            'description': 'Directory containing authorization policy classes.',
-            'default': lambda: str((Path.cwd() / 'app' / 'policies').resolve())
-        }
-    )
-
-    exceptions: str = field(
-        default_factory = lambda: str((Path.cwd() / 'app' / 'exceptions').resolve()),
-        metadata = {
-            'description': 'Directory containing exception handler classes.',
-            'default': lambda: str((Path.cwd() / 'app' / 'exceptions').resolve())
-        }
-    )
-
     services: str = field(
         default_factory = lambda: str((Path.cwd() / 'app' / 'services').resolve()),
         metadata = {
@@ -118,35 +78,19 @@ class Paths(BaseEntity):
         }
     )
 
-    views: str = field(
-        default_factory = lambda: str((Path.cwd() / 'resources' / 'views').resolve()),
-        metadata = {
-            'description': 'Directory containing template view files.',
-            'default': lambda: str((Path.cwd() / 'resources' / 'views').resolve())
-        }
-    )
-
-    lang: str = field(
-        default_factory = lambda: str((Path.cwd() / 'resources' / 'lang').resolve()),
-        metadata = {
-            'description': 'Directory containing internationalization files.',
-            'default': lambda: str((Path.cwd() / 'resources' / 'lang').resolve())
-        }
-    )
-
-    assets: str = field(
-        default_factory = lambda: str((Path.cwd() / 'resources' / 'assets').resolve()),
+    jobs: str = field(
+        default_factory = lambda: str((Path.cwd() / 'app' / 'jobs').resolve()),
         metadata = {
-            'description': 'Directory containing frontend assets (JS, CSS, images).',
-            'default': lambda: str((Path.cwd() / 'resources' / 'assets').resolve())
+            'description': 'Directory containing queued job classes.',
+            'default': lambda: str((Path.cwd() / 'app' / 'jobs').resolve())
         }
     )
 
-    routes: str = field(
-        default_factory = lambda: str((Path.cwd() / 'routes').resolve()),
+    bootstrap: str = field(
+        default_factory = lambda: str((Path.cwd() / 'app' / 'bootstrap').resolve()),
         metadata = {
-            'description': 'Path to the web routes definition file.',
-            'default': lambda: str((Path.cwd() / 'routes').resolve())
+            'description': 'Directory containing application bootstrap files.',
+            'default': lambda: str((Path.cwd() / 'app' / 'bootstrap').resolve())
         }
     )
 
@@ -158,75 +102,27 @@ class Paths(BaseEntity):
         }
     )
 
-    migrations: str = field(
-        default_factory = lambda: str((Path.cwd() / 'database' / 'migrations').resolve()),
-        metadata = {
-            'description': 'Directory containing database migration files.',
-            'default': lambda: str((Path.cwd() / 'database' / 'migrations').resolve())
-        }
-    )
-
-    seeders: str = field(
-        default_factory = lambda: str((Path.cwd() / 'database' / 'seeders').resolve()),
-        metadata = {
-            'description': 'Directory containing database seeder files.',
-            'default': lambda: str((Path.cwd() / 'database' / 'seeders').resolve())
-        }
-    )
-
-    factories: str = field(
-        default_factory = lambda: str((Path.cwd() / 'database' / 'factories').resolve()),
-        metadata = {
-            'description': 'Directory containing model factory files.',
-            'default': lambda: str((Path.cwd() / 'database' / 'factories').resolve())
-        }
-    )
-
-    logs: str = field(
-        default_factory = lambda: str((Path.cwd() / 'storage' / 'logs').resolve()),
-        metadata = {
-            'description': 'Directory containing application log files.',
-            'default': lambda: str((Path.cwd() / 'storage' / 'logs').resolve())
-        }
-    )
-
-    framework: str = field(
-        default_factory = lambda: str((Path.cwd() / 'storage' / 'framework').resolve()),
-        metadata = {
-            'description': 'Directory for framework-generated files (cache, sessions, views).',
-            'default': lambda: str((Path.cwd() / 'storage' / 'framework').resolve())
-        }
-    )
-
-    sessions: str = field(
-        default_factory = lambda: str((Path.cwd() / 'storage' / 'framework' / 'sessions').resolve()),
-        metadata = {
-            'description': 'Directory containing session files.',
-            'default': lambda: str((Path.cwd() / 'storage' / 'framework' / 'sessions').resolve())
-        }
-    )
-
-    cache: str = field(
-        default_factory = lambda: str((Path.cwd() / 'storage' / 'framework' / 'cache').resolve()),
+    database: str = field(
+        default_factory = lambda: str((Path.cwd() / 'database' / 'database').resolve()),
         metadata = {
-            'description': 'Directory containing framework cache files.',
-            'default': lambda: str((Path.cwd() / 'storage' / 'framework' / 'cache').resolve())
+            'description': 'Directory containing the SQLite database file.',
+            'default': lambda: str((Path.cwd() / 'database' / 'database').resolve())
         }
     )
 
-    views: str = field(
-        default_factory = lambda: str((Path.cwd() / 'storage' / 'framework' / 'views').resolve()),
+    resources: str = field(
+        default_factory = lambda: str((Path.cwd() / 'resources').resolve()),
         metadata = {
-            'description': 'Directory containing compiled view files.',
-            'default': lambda: str((Path.cwd() / 'storage' / 'framework' / 'views').resolve())
+            'description': 'Directory containing application resources (views, lang, assets).',
+            'default': lambda: str((Path.cwd() / 'resources').resolve())
         }
     )
 
-    testing: str = field(
-        default_factory = lambda: str((Path.cwd() / 'storage' / 'framework' / 'testing').resolve()),
+    routes: str = field(
+        default_factory = lambda: str((Path.cwd() / 'routes').resolve()),
         metadata = {
-            'description': 'Directory containing compiled view files.',
-            'default': lambda: str((Path.cwd() / 'storage' / 'framework' / 'testing').resolve())
+            'description': 'Path to the web routes definition file.',
+            'default': lambda: str((Path.cwd() / 'routes').resolve())
         }
     )
 
@@ -248,12 +144,12 @@ class Paths(BaseEntity):
 
     def __post_init__(self) -> None:
         """
-        Post-initialization hook to validate path attributes.
+        Post-initialization hook to validate and normalize path attributes.
 
         This method is called automatically after the dataclass is initialized.
-        It ensures that all attributes representing paths are of type `str`.
-        If any attribute is not a string, an `OrionisIntegrityException` is raised
-        to prevent invalid configuration.
+        It ensures that all path-related attributes of the class are stored as strings.
+        If any attribute is a `pathlib.Path`, it is converted to a string. If any attribute
+        cannot be converted to a string, an `OrionisIntegrityException` is raised.
 
         Parameters
         ----------
@@ -263,21 +159,30 @@ class Paths(BaseEntity):
         Returns
         -------
         None
-            This method does not return any value.
+            This method does not return any value. It modifies the instance in place if necessary.
 
         Raises
         ------
         OrionisIntegrityException
-            If any attribute is not of type `str`.
+            If any attribute is not a string after conversion.
         """
-        super().__post_init__()  # Call the parent class's post-init if defined
 
-        # Iterate over all dataclass fields to validate their types
+        # Call the parent class's __post_init__ if it exists
+        super().__post_init__()
+
+        # Iterate over all dataclass fields to validate and normalize their values
         for field_ in fields(self):
+
+            # Get the current value of the field
             value = getattr(self, field_.name)
-            # Check if the field value is not a string
+
+            # Convert Path objects to strings
+            if isinstance(value, Path):
+                object.__setattr__(self, field_.name, str(value))
+                value = str(value)
+
+            # Raise an exception if the value is not a string
             if not isinstance(value, str):
-                # Raise an exception if the type is invalid
                 raise OrionisIntegrityException(
                     f"Invalid type for '{field_.name}': expected str, got {type(value).__name__}"
-                )
+                )