revert samples changes

Author: eadwinCode

samples/01-carapp/README.md

@@ -0,0 +1,23 @@
+## Car Application
+
+This is just a quick demonstration of ellar web framework. Modifications will be made on this project as the Ellar project 
+evolves to become better.
+
+## Installation
+having setup up your virtual environment,
+```shell
+$(venv) poetry
+```
+## Project Setup
+```shell
+$(venv) poetry install
+```
+
+## Start Development Server
+Start the dev server by running the code below:
+
+```bash
+ellar runserver --reload
+```
+
+Once the server is up, you can visit [SwaggerDoc](http://localhost:8000/docs#) or [ReDoc](http://localhost:8000/redoc#)

samples/01-carapp/carapp/apps/car/controllers.py

@@ -0,0 +1,66 @@
+"""
+Define endpoints routes in python class-based fashion
+example:
+
+@Controller("/dogs", tag="Dogs", description="Dogs Resources")
+class MyController(ControllerBase):
+    @get('/')
+    def index(self):
+        return {'detail': "Welcome Dog's Resources"}
+"""
+
+import typing_extensions as types
+from ellar.common import (
+    Body,
+    Controller,
+    ControllerBase,
+    Query,
+    Version,
+    get,
+    post,
+    render,
+)
+from ellar.openapi import ApiTags
+
+from .schemas import CarListFilter, CreateCarSerializer
+from .services import CarRepository
+
+
+@Controller("/car")
+@ApiTags(
+    description="Example of Car Resource with <strong>Controller</strong>",
+    name="CarController",
+)
+class CarController(ControllerBase):
+    def __init__(self, repo: CarRepository):
+        self.repo = repo
+
+    @get("/list-html")
+    @render()
+    async def list(self):
+        return self.repo.get_all()
+
+    @post()
+    async def create(self, payload: types.Annotated[CreateCarSerializer, Body()]):
+        result = self.repo.create_car(payload)
+        result.update(message="This action adds a new car")
+        return result
+
+    @get("/{car_id:str}")
+    async def get_one(self, car_id: str):
+        return f"This action returns a #{car_id} car"
+
+    @get()
+    async def get_all(self, query: CarListFilter = Query()):
+        res = {
+            "cars": self.repo.get_all(),
+            "message": f"This action returns all cars at limit={query.limit}, offset={query.offset}",
+        }
+        return res
+
+    @post("/", name="v2_create")
+    @Version("v2")
+    async def create_v2(self, payload: Body[CreateCarSerializer]):
+        result = self.repo.create_car(payload)
+        result.update(message="This action adds a new car - version 2")
+        return result

samples/01-carapp/carapp/apps/car/module.py

@@ -0,0 +1,43 @@
+"""
+@Module(
+    controllers=[MyController],
+    providers=[
+        YourService,
+        ProviderConfig(IService, use_class=AService),
+        ProviderConfig(IFoo, use_value=FooService()),
+    ],
+    routers=(routerA, routerB)
+    statics='statics',
+    template='template_folder',
+    # base_directory -> default is the `car` folder
+)
+class MyModule(ModuleBase):
+    def register_providers(self, container: Container) -> None:
+        # for more complicated provider registrations
+        pass
+
+"""
+
+from ellar.common import Module
+from ellar.core import ModuleBase
+from ellar.di import Container
+
+from .controllers import CarController
+from .routers import router
+from .services import CarRepository
+
+
+@Module(
+    controllers=[CarController],
+    providers=[CarRepository],
+    routers=[router],
+    template_folder="views",
+    static_folder="statics",
+)
+class CarModule(ModuleBase):
+    """
+    Car Module
+    """
+
+    def register_providers(self, container: Container) -> None:
+        """for more complicated provider registrations, use container.register_instance(...)"""

samples/01-carapp/carapp/apps/car/routers.py

@@ -0,0 +1,54 @@
+"""
+Define endpoints routes in python function fashion
+example:
+
+my_router = ModuleRouter("/cats", tag="Cats", description="Cats Resource description")
+
+@my_router.get('/')
+def index(request: Request):
+    return {'detail': 'Welcome to Cats Resource'}
+"""
+
+from dataclasses import dataclass
+from typing import List
+
+from ellar.common import (
+    Inject,
+    ModuleRouter,
+    render,
+    render_template,
+)
+from ellar.core import Request
+from ellar.openapi import ApiTags
+
+from .services import CarRepository
+
+router = ModuleRouter("/car-as-router")
+ApiTags(
+    name="Router",
+    description="Example of Car Resource from a <strong>ModuleRouter</strong>",
+)(router)
+
+
+@dataclass
+class CarObject:
+    name: str
+    model: str
+
+
+@router.get(response={200: List[CarObject]})
+async def get_cars(repo: Inject[CarRepository]):
+    return repo.get_all()
+
+
+@router.http_route("/html", methods=["get", "post"])
+@render("index.html")
+async def get_car_html(repo: Inject[CarRepository]):
+    return repo.get_all()
+
+
+@router.get("/html/outside")
+async def get_car_html_with_render(
+    repo: Inject[CarRepository], request: Inject[Request]
+):
+    return render_template("car/list.html", request=request, model=repo.get_all())

samples/01-carapp/carapp/apps/car/schemas.py

@@ -0,0 +1,36 @@
+"""
+Define Serializers/DTOs
+Example:
+
+class ASampleDTO(Serializer):
+    name: str
+    age: t.Optional[int] = None
+
+for dataclasses, Inherit from DataclassSerializer
+
+@dataclass
+class ASampleDTO(DataclassSerializer):
+    name: str
+    age: t.Optional[int] = None
+"""
+
+from ellar.common.serializer import Serializer
+from pydantic import Field
+
+
+class CreateCarSerializer(Serializer):
+    name: str
+    year: int = Field(..., gt=0)
+    model: str
+
+
+class CarListFilter(Serializer):
+    offset: int = 1
+    limit: int = 10
+
+
+class CarSerializer(Serializer):
+    id: int
+    name: str
+    year: int
+    model: str

samples/01-carapp/carapp/apps/car/services.py

@@ -0,0 +1,31 @@
+"""
+Create a provider and declare its scope
+
+@injectable
+class AProvider
+    pass
+
+@injectable(scope=transient_scope)
+class BProvider
+    pass
+"""
+
+import typing as t
+
+from ellar.di import injectable, singleton_scope
+
+from .schemas import CarSerializer, CreateCarSerializer
+
+
+@injectable(scope=singleton_scope)
+class CarRepository:
+    def __init__(self):
+        self._cars: t.List[CarSerializer] = []
+
+    def create_car(self, data: CreateCarSerializer) -> dict:
+        data = CarSerializer(id=len(self._cars) + 1, **data.dict())
+        self._cars.append(data)
+        return data.dict()
+
+    def get_all(self) -> t.List[CarSerializer]:
+        return self._cars

samples/01-carapp/carapp/apps/car/statics/blog/blog.css

@@ -0,0 +1,103 @@
+/* stylelint-disable selector-list-comma-newline-after */
+
+.blog-header {
+  line-height: 1;
+  border-bottom: 1px solid #e5e5e5;
+}
+
+.blog-header-logo {
+  font-family: "Playfair Display", Georgia, "Times New Roman", serif/*rtl:Amiri, Georgia, "Times New Roman", serif*/;
+  font-size: 2.25rem;
+}
+
+.blog-header-logo:hover {
+  text-decoration: none;
+}
+
+h1, h2, h3, h4, h5, h6 {
+  font-family: "Playfair Display", Georgia, "Times New Roman", serif/*rtl:Amiri, Georgia, "Times New Roman", serif*/;
+}
+
+.display-4 {
+  font-size: 2.5rem;
+}
+@media (min-width: 768px) {
+  .display-4 {
+    font-size: 3rem;
+  }
+}
+
+.nav-scroller {
+  position: relative;
+  z-index: 2;
+  height: 2.75rem;
+  overflow-y: hidden;
+}
+
+.nav-scroller .nav {
+  display: flex;
+  flex-wrap: nowrap;
+  padding-bottom: 1rem;
+  margin-top: -1px;
+  overflow-x: auto;
+  text-align: center;
+  white-space: nowrap;
+  -webkit-overflow-scrolling: touch;
+}
+
+.nav-scroller .nav-link {
+  padding-top: .75rem;
+  padding-bottom: .75rem;
+  font-size: .875rem;
+}
+
+.card-img-right {
+  height: 100%;
+  border-radius: 0 3px 3px 0;
+}
+
+.flex-auto {
+  flex: 0 0 auto;
+}
+
+.h-250 { height: 250px; }
+@media (min-width: 768px) {
+  .h-md-250 { height: 250px; }
+}
+
+/* Pagination */
+.blog-pagination {
+  margin-bottom: 4rem;
+}
+.blog-pagination > .btn {
+  border-radius: 2rem;
+}
+
+/*
+ * Blog posts
+ */
+.blog-post {
+  margin-bottom: 4rem;
+}
+.blog-post-title {
+  margin-bottom: .25rem;
+  font-size: 2.5rem;
+}
+.blog-post-meta {
+  margin-bottom: 1.25rem;
+  color: #727272;
+}
+
+/*
+ * Footer
+ */
+.blog-footer {
+  padding: 2.5rem 0;
+  color: #727272;
+  text-align: center;
+  background-color: #f9f9f9;
+  border-top: .05rem solid #e5e5e5;
+}
+.blog-footer p:last-child {
+  margin-bottom: 0;
+}