fixed some pytest deprecated warning

Author: eadwinCode

docs/basics/testing.md

@@ -246,10 +246,19 @@ During testing, there two ways to apply or modify configuration.
             test_module = Test.create_test_module(
                 controllers=[CarController,], 
                 providers=[ProviderConfig(CarRepository, use_class=CarRepository)],
-                config_module='project_name.config.TestingConfiguration'
+                config_module='project_name.config:TestingConfiguration'
             )
             self.controller: CarController = test_module.get(CarController)
     ```
+    Also, we can expose the testing config to environment for more global scope, for example:
+    
+    ```python
+    # project_name/tests/conftest.py
+    import os
+    from ellar.constants import ELLAR_CONFIG_MODULE
+    os.environ.setdefault(ELLAR_CONFIG_MODULE, 'project_name.config:TestingConfiguration')
+    ```
+
 === "Inline"
     This method doesn't require configuration file, we simply go ahead and define the configuration variables in a dictionary type set to `config_module`. 
 

examples/catapp/README.md renamed to examples/01-carapp/README.md

@@ -1,15 +1,19 @@
-## CATAPP Application
+## 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.
 
-### Start Development Server
-Currently, to start development server, you need to tell uvicorn where the app
-instance is.
-So, run the command below:
+## Installation
+having setup up your virtual environment,
+```shell
+$(venv) pip install ellar-cli
+```
+
+## Start Development Server
+Start the dev server by running the code below:
 
 ```bash
-uvicorn catapp.server.app --reload
+ellar runserver --reload
 ```
 
 Once the server is up, you can visit [SwaggerDoc](http://localhost:8000/docs#) or [ReDocs](http://localhost:8000/redoc#)

examples/catapp/__init__.py renamed to examples/01-carapp/carapp/__init__.py

@@ -0,0 +1,52 @@
+"""
+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, Query, get, post, render, Version
+from ellar.core import ControllerBase
+
+from .schemas import CarListFilter, CreateCarSerializer
+from .services import CarRepository
+
+
+@Controller("/car", description='Example of Car Resource with <strong>Controller</strong>', tag='Controller')
+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 = dict(
+            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: CreateCarSerializer):
+        result = self.repo.create_car(payload)
+        result.update(message="This action adds a new car - version 2")
+        return result

examples/catapp/application/__init__.py renamed to examples/01-carapp/carapp/apps/__init__.py

@@ -0,0 +1,40 @@
+"""
+@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 .services import CarRepository
+from .controllers import CarController
+from .routers import router
+
+@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(...)"""

examples/catapp/application/cats/__init__.py renamed to examples/01-carapp/carapp/apps/car/__init__.py

@@ -0,0 +1,44 @@
+"""
+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 Provide, render, Req
+from ellar.core.routing import ModuleRouter
+from ellar.core.templating import render_template
+from ellar.serializer import DataclassSerializer
+
+from .services import CarRepository
+
+router = ModuleRouter("/car-as-router", tag='Router', description='Example of car Resource from a <strong>ModuleRouter</strong>')
+
+
+@dataclass
+class CarObject(DataclassSerializer):
+    name: str
+    model: str
+
+
+@router.get(response={200: List[CarObject]})
+async def get_cars(repo: CarRepository = Provide()):
+    return repo.get_all()
+
+
+@router.http_route('/html', methods=['get', 'post'])
+@render("index.html")
+async def get_car_html(repo: CarRepository = Provide()):
+    return repo.get_all()
+
+
+@router.get('/html/outside')
+async def get_car_html_with_render(repo: CarRepository = Provide(), request=Req()):
+    return render_template("car/list.html", request=request, model=repo.get_all())

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

@@ -0,0 +1,35 @@
+"""
+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.serializer import DataclassSerializer, 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: str
+    name: str
+    year: int
+    model: str

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

@@ -0,0 +1,30 @@
+"""
+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