Initial commit

Author: rszamszur

README.md

@@ -0,0 +1,4 @@
+# copier-controller
+
+more info soon
+

USAGE

@@ -0,0 +1,15 @@
+Description:
+    Creates a new controller and its endpoints. Pass the controller name
+    under_scored, and a list of endpoints as arguments.
+
+    This generates a controller file in app/controllers with unit test
+    file. Finally, edits config/router.py in order to add controller to
+    FastAPI router.
+
+Example:
+    `fastapi-mvc generate controller stock_market ticker buy:post sell:delete`
+
+    Creates controller with URLs like /stock_market/ticker.
+        Controller: app/controllers/stock_market.py
+        Test:       tests/unit/app/controllers/test_stock_market.py
+

copier.yml

@@ -0,0 +1,35 @@
+# TEMPLATE SETTINGS
+_subdirectory: template
+_templates_suffix: .jinja
+_min_copier_version: "6.2.0"
+_envops:
+  block_end_string: "%}"
+  block_start_string: "{%"
+  comment_end_string: "#}"
+  comment_start_string: "{#"
+  keep_trailing_newline: true
+  variable_end_string: "}}"
+  variable_start_string: "{{"
+
+# TEMPLATE QUESTIONS
+project_name:
+  type: str
+  help: >-
+    What's your project name?
+    
+    Do not use dots or spaces in the name; just "A-Za-z0-9-_" please.
+
+controller_name:
+  type: str
+  help: What is your new controller name?
+
+controller_endpoints:
+  type: json
+  help: What are your new controller endpoints?
+  multiline: true
+
+skip_routes:
+  type: bool
+  help: Skip modifying routes?
+  default: false
+

template/tests/unit/app/controllers/test_{{controller_name}}.py.jinja

@@ -0,0 +1,26 @@
+import pytest
+from fastapi.testclient import TestClient
+from {{package_name}}.app.asgi import get_app
+
+
+@pytest.fixture
+def client():
+    # This is an example fixture for generated test sake.
+    # By default there should be a 'app' fixture just like this under:
+    # tests/unit/app/conftest.py
+    app = get_app()
+    with TestClient(app) as client:
+        yield client
+{%- for endpoint, method in controller_endpoints.items() %}
+
+
+def test_{{endpoint}}(client):
+    response = client.{{method}}("/{{controller_name}}/{{endpoint}}")
+    assert response.status_code == 200
+    assert response.json() == {"hello": "world"}
+
+
+{%- endfor %}
+{%- raw %}
+
+{% endraw %}

template/{{package_name}}/app/controllers/{{controller_name}}.py.jinja

@@ -0,0 +1,28 @@
+"""{{ controller_name.capitalize().replace('_', ' ') }} controller implementation."""
+import logging
+
+from fastapi import APIRouter
+
+
+router = APIRouter(
+    prefix="/{{ controller_name }}"
+)
+log = logging.getLogger(__name__)
+{%- for endpoint, method in controller_endpoints.items() %}
+
+
+@router.{{ method }}(
+    "/{{ endpoint }}",
+    status_code=200,
+    # Decorator options:
+    # https://fastapi.tiangolo.com/tutorial/path-operation-configuration/
+)
+async def {{ endpoint }}():
+    # Implement endpoint logic here.
+    return {"hello": "world"}
+
+
+{%- endfor %}
+{%- raw %}
+
+{% endraw %}