refactor controller routes (#46)

* refactor: refactor route decorators to use a common helper function and remove redundant code

* run black

* add event triggres to run actions

* fix: HTTP methods in controller decorators

* move http methods decorators to seperate file

---------

Co-authored-by: lucas alves <[email protected]>
Co-authored-by: ItayTheDar <[email protected]>

Author: 3 people

.github/workflows/cli_test.yaml

@@ -1,6 +1,6 @@
 name: CLI Test
 
-on: [ push, workflow_call ]
+on: [ push, workflow_call, pull_request ]
 
 jobs:
   test:

.github/workflows/integration_test.yaml

@@ -1,6 +1,6 @@
 name: Integration Test
 
-on: [push, workflow_call]
+on: [push, workflow_call, pull_request]
 
 jobs:
   test:

.github/workflows/tests.yaml

@@ -1,6 +1,6 @@
 name: Tests
 
-on: [push, workflow_call]
+on: [push, workflow_call, pull_request]
 
 jobs:
   test:

nest/common/templates/mysql_template.py

@@ -36,7 +36,6 @@ def requirements_file(self):
 """
 
 
-
 class AsyncMySQLTemplate(AsyncORMTemplate, ABC):
     def __init__(self, module_name: str):
         super().__init__(

nest/common/templates/orm_template.py

@@ -225,7 +225,6 @@ def config_file(self):
     def requirements_file(self):
         pass
 
-
     def entity_file(self):
         return f"""from config import config
 from sqlalchemy import Integer, String

nest/core/app.py

@@ -4,11 +4,7 @@
 
 class App(FastAPI):
     def __init__(
-            self,
-            description: str,
-            modules: List,
-            title: str = "PyNest Service",
-            **kwargs
+        self, description: str, modules: List, title: str = "PyNest Service", **kwargs
     ):
         """
         Initializes the App instance.
@@ -18,9 +14,7 @@ def __init__(
             modules (List): A list of modules to register.
 
         """
-        super().__init__(
-            description=description, title=title, **kwargs
-        )
+        super().__init__(description=description, title=title, **kwargs)
         self.modules = modules
         self._register_controllers()
 

nest/core/decorators/__init__.py

@@ -1,2 +1,3 @@
-from nest.core.decorators.controller import Controller, Get, Post, Delete, Put, Patch
+from nest.core.decorators.controller import Controller
+from nest.core.decorators.http_methods import Get, Post, Delete, Put, Patch
 from nest.core.decorators.database import db_request_handler, async_db_request_handler

nest/core/decorators/controller.py

@@ -1,5 +1,9 @@
+from typing import Any
 from fastapi.routing import APIRouter
-from nest.core.decorators.helpers import class_based_view as ClassBasedView
+from nest.core.decorators.helpers import (
+    class_based_view as ClassBasedView,
+    route_decorator,
+)
 
 
 def Controller(tag: str = None, prefix: str = None):
@@ -58,113 +62,3 @@ def get_router() -> APIRouter:
         return ClassBasedView(router=router, cls=cls)
 
     return wrapper
-
-
-def Get(path: str, **kwargs):
-    """
-    Decorator that defines a GET route for the controller.
-
-    Args:
-        path (str): The URL path for the route.
-        **kwargs: Additional keyword arguments to configure the route.
-
-    Returns:
-        function: The decorated function.
-
-    """
-
-    def decorator(func):
-        func.method = "GET"
-        func.__path__ = path
-        func.__kwargs__ = kwargs
-        return func
-
-    return decorator
-
-
-def Post(path: str, **kwargs):
-    """
-    Decorator that defines a POST route for the controller.
-
-    Args:
-        path (str): The URL path for the route.
-        **kwargs: Additional keyword arguments to configure the route.
-
-    Returns:
-        function: The decorated function.
-
-    """
-
-    def decorator(func):
-        func.method = "POST"
-        func.__path__ = path
-        func.__kwargs__ = kwargs
-        return func
-
-    return decorator
-
-
-def Delete(path: str, **kwargs):
-    """
-    Decorator that defines a DELETE route for the controller.
-
-    Args:
-        path (str): The URL path for the route.
-        **kwargs: Additional keyword arguments to configure the route.
-
-    Returns:
-        function: The decorated function.
-
-    """
-
-    def decorator(func):
-        func.method = "DELETE"
-        func.__path__ = path
-        func.__kwargs__ = kwargs
-        return func
-
-    return decorator
-
-
-def Put(path: str, **kwargs):
-    """
-    Decorator that defines a PUT route for the controller.
-
-    Args:
-        path (str): The URL path for the route.
-        **kwargs: Additional keyword arguments to configure the route.
-
-    Returns:
-        function: The decorated function.
-
-    """
-
-    def decorator(func):
-        func.method = "PUT"
-        func.__path__ = path
-        func.__kwargs__ = kwargs
-        return func
-
-    return decorator
-
-
-def Patch(path: str, **kwargs):
-    """
-    Decorator that defines a PATCH route for the controller.
-
-    Args:
-        path (str): The URL path for the route.
-        **kwargs: Additional keyword arguments to configure the route.
-
-    Returns:
-        function: The decorated function.
-
-    """
-
-    def decorator(func):
-        func.method = "PATCH"
-        func.__path__ = path
-        func.__kwargs__ = kwargs
-        return func
-
-    return decorator

nest/core/decorators/helpers.py

@@ -12,6 +12,8 @@
 from starlette.routing import Route, WebSocketRoute
 
 T = TypeVar("T")
+K = TypeVar("K", bound=Callable[..., Any])
+
 
 CBV_CLASS_KEY = "__cbv_class__"
 
@@ -102,3 +104,13 @@ def _update_cbv_route_endpoint_signature(
     ]
     new_signature = old_signature.replace(parameters=new_parameters)
     setattr(route.endpoint, "__signature__", new_signature)
+
+
+def route_decorator(path: str, method: str, **kwargs: Any):
+    def decorator(func: K) -> K:
+        setattr(func, "method", method)
+        setattr(func, "__path__", path)
+        setattr(func, "__kwargs__", kwargs)
+        return func
+
+    return decorator

nest/core/decorators/http_methods.py

@@ -0,0 +1,82 @@
+from typing import Any
+from nest.core.decorators.helpers import route_decorator
+
+
+def Get(path: str, **kwargs: Any):
+    """
+    Decorator that defines a GET route for the controller.
+
+    Args:
+        path (str): The URL path for the route.
+        **kwargs: Additional keyword arguments to configure the route.
+
+    Returns:
+        function: The decorated function.
+
+    """
+
+    return route_decorator(path, "GET", **kwargs)
+
+
+def Post(path: str, **kwargs: Any):
+    """
+    Decorator that defines a POST route for the controller.
+
+    Args:
+        path (str): The URL path for the route.
+        **kwargs: Additional keyword arguments to configure the route.
+
+    Returns:
+        function: The decorated function.
+
+    """
+
+    return route_decorator(path, "POST", **kwargs)
+
+
+def Delete(path: str, **kwargs: Any):
+    """
+    Decorator that defines a DELETE route for the controller.
+
+    Args:
+        path (str): The URL path for the route.
+        **kwargs: Additional keyword arguments to configure the route.
+
+    Returns:
+        function: The decorated function.
+
+    """
+
+    return route_decorator(path, "DELETE", **kwargs)
+
+
+def Put(path: str, **kwargs: Any):
+    """
+    Decorator that defines a PUT route for the controller.
+
+    Args:
+        path (str): The URL path for the route.
+        **kwargs: Additional keyword arguments to configure the route.
+
+    Returns:
+        function: The decorated function.
+
+    """
+
+    return route_decorator(path, "PUT", **kwargs)
+
+
+def Patch(path: str, **kwargs: Any):
+    """
+    Decorator that defines a PATCH route for the controller.
+
+    Args:
+        path (str): The URL path for the route.
+        **kwargs: Additional keyword arguments to configure the route.
+
+    Returns:
+        function: The decorated function.
+
+    """
+
+    return route_decorator(path, "PATCH", **kwargs)

tests/test_core/test_decorators/test_controller.py

@@ -1,6 +1,6 @@
 import pytest
 
-from nest.core.decorators.controller import Controller, Get, Post, Delete, Put, Patch
+from nest.core import Controller, Get, Post, Delete, Put, Patch
 
 
 @Controller(tag="test", prefix="/api/v1")