feat: start adding MVC Architecture

Author: alexeev-prog

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = "pyEchoNext"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "0.6.11"
+PROJECT_NUMBER         = "0.6.12"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.md

@@ -45,7 +45,7 @@ Welcome to **EchoNext**, where innovation meets simplicity! Are you tired of the
 
 **Imagine** a lightweight framework that empowers you to create modern web applications with lightning speed and flexibility. With EchoNext, you're not just coding; you're building a masterpiece!
 
- > Last stable version: 0.6.11 alpha
+ > Last stable version: 0.6.12 alpha
 
  > Next Big Update: ASYNC & unicorn support
 

SECURITY.md

@@ -8,6 +8,7 @@ currently being supported with security updates.
 | Version | Supported          |
 | ------- | ------------------ |
 | 0.6.11  | :white_check_mark: |
+| 0.6.11  | :white_check_mark: |
 | 0.6.10  | :white_check_mark: |
 | 0.6.9   | :white_check_mark: |
 | 0.5.9   | :white_check_mark: |

pyechonext/__init__.py

@@ -22,7 +22,7 @@
 from rich import print
 from rich.traceback import install
 
-__version__ = "0.6.11"
+__version__ = "0.6.12"
 install(show_locals=True)
 
 

pyechonext/app.py

@@ -25,6 +25,7 @@
 	WebError,
 )
 from pyechonext.views import View
+from pyechonext.mvc.routes import Router
 
 
 class ApplicationType(Enum):
@@ -55,7 +56,7 @@ class EchoNext:
 		"middlewares",
 		"application_type",
 		"urls",
-		"routes",
+		"router",
 		"i18n_loader",
 		"l10n_loader",
 		"history",
@@ -95,9 +96,8 @@ def __init__(
 		self.application_type = application_type
 		self.static_files = static_files
 		self.static_files_manager = StaticFilesManager(self.static_files)
-		self.routes = {}
-
 		self.urls = urls
+		self.router = Router(self.urls)
 		self.main_cache = InMemoryCache(timeout=60 * 10)
 		self.history: List[HistoryEntry] = []
 		self.i18n_loader = JSONi18nLoader(
@@ -114,24 +114,6 @@ def __init__(
 
 		logger.debug(f"Application {self.application_type.value}: {self.app_name}")
 
-	def _find_view(self, raw_url: str) -> Union[Type[URL], None]:
-		"""
-		Finds a view by raw url.
-
-		:param		raw_url:  The raw url
-		:type		raw_url:  str
-
-		:returns:	URL dataclass
-		:rtype:		Type[URL]
-		"""
-		url = _prepare_url(raw_url)
-
-		for path in self.urls:
-			if url == _prepare_url(path.url):
-				return path
-
-		return None
-
 	def _check_request_method(self, view: View, request: Request):
 		"""
 		Check request method for view
@@ -146,20 +128,6 @@ def _check_request_method(self, view: View, request: Request):
 		if not hasattr(view, request.method.lower()):
 			raise MethodNotAllow(f"Method not allow: {request.method}")
 
-	def _get_view(self, request: Request) -> View:
-		"""
-		Gets the view.
-
-		:param		request:  The request
-		:type		request:  Request
-
-		:returns:	The view.
-		:rtype:		View
-		"""
-		url = request.path
-
-		return self._find_view(url)
-
 	def _get_request(self, environ: dict) -> Request:
 		"""
 		Gets the request.
@@ -191,9 +159,6 @@ def route_page(self, page_path: str) -> Callable:
 		:returns:	wrapper handler
 		:rtype:		Callable
 		"""
-		if page_path in self.routes:
-			raise RoutePathExistsError("Such route already exists.")
-
 		def wrapper(handler):
 			"""
 			Wrapper for handler
@@ -204,7 +169,7 @@ def wrapper(handler):
 			:returns:	handler
 			:rtype:		callable
 			"""
-			self.routes[page_path] = handler
+			self.router.add_page_route(page_path, handler)
 			return handler
 
 		return wrapper
@@ -216,7 +181,7 @@ def _apply_middleware_to_request(self, request: Request):
 		:param		request:  The request
 		:type		request:  Request
 		"""
-		for middleware in self.middlewares:
+		for middleware in self.middlewares[::-1]:
 			middleware().to_request(request)
 
 	def _apply_middleware_to_response(self, response: Response):
@@ -226,7 +191,7 @@ def _apply_middleware_to_response(self, response: Response):
 		:param		response:  The response
 		:type		response:  Response
 		"""
-		for middleware in self.middlewares:
+		for middleware in self.middlewares[::-1]:
 			middleware().to_response(response)
 
 	def _default_response(self, response: Response, error: WebError) -> None:
@@ -254,20 +219,7 @@ def _find_handler(self, request: Request) -> Tuple[Callable, str]:
 		if self.static_files_manager.serve_static_file(url):
 			return self._serve_static_file, {}
 
-		for path, handler in self.routes.items():
-			parse_result = parse(path, url)
-			if parse_result is not None:
-				return handler, parse_result.named
-
-		view = self._get_view(request)
-
-		if view is not None:
-			parse_result = parse(view.url, url)
-
-			if parse_result is not None:
-				return view.view, parse_result.named
-
-		return None, None
+		return self.router.resolve(request)
 
 	def get_and_save_cache_item(self, key: str, value: Any) -> Any:
 		"""

pyechonext/mvc/controllers.py

@@ -0,0 +1,6 @@
+from abc import ABC, abstractmethod
+from typing import Any, Union
+
+
+class BaseView(ABC):
+	def __init__(self)

pyechonext/mvc/models.py

@@ -0,0 +1,141 @@
+from typing import Callable, Optional, List, Tuple, Dict, Union
+from enum import Enum
+from dataclasses import dataclass
+from parse import parse
+# from pyechonext.mvc.controllers import BaseController
+from pyechonext.views import View
+from pyechonext.urls import URL
+from pyechonext.utils.exceptions import RoutePathExistsError
+from pyechonext.request import Request
+from pyechonext.utils import _prepare_url
+from pyechonext.utils.exceptions import (
+	MethodNotAllow,
+	RoutePathExistsError,
+	TeapotError,
+	URLNotFound,
+	WebError,
+)
+
+
+class RoutesTypes(Enum):
+	"""
+	This class describes routes types.
+	"""
+
+	URL = 0
+	PAGE = 1
+
+
+@dataclass
+class Route:
+	"""
+	This class describes a route.
+	"""
+
+	page_path: str
+	handler: Callable | View
+	route_type: RoutesTypes
+
+
+def _create_url_route(url: URL) -> Route:
+	"""
+	Creates an url route.
+
+	:param      url:  The url
+	:type       url:  URL
+
+	:returns:   Route dataclass object
+	:rtype:     Route
+	"""
+	return Route(page_path=url.url, handler=url.view, route_type=RoutesTypes.URL)
+
+
+def _create_page_route(page_path: str, handler: Callable) -> Route:
+	"""
+	Creates a page route.
+
+	:param      page_path:  The page path
+	:type       page_path:  str
+	:param      handler:    The handler
+	:type       handler:    Callable
+
+	:returns:   Route dataclass object
+	:rtype:     Route
+	"""
+	return Route(page_path=page_path, handler=handler, route_type=RoutesTypes.PAGE)
+
+
+class Router:
+	"""
+	This class describes a router.
+	"""
+
+	def __init__(self, urls: Optional[List[URL]] = []):
+		"""
+		Constructs a new instance.
+
+		:param      urls:  The urls
+		:type       urls:  Array
+		"""
+		self.urls = urls
+		self.routes = {}
+
+		self._prepare_urls()
+
+	def _prepare_urls(self):
+		"""
+		Prepare URLs (add to routes)
+		"""
+		for url in self.urls:
+			self.routes[url.url] = _create_url_route(url)
+
+	def add_page_route(self, page_path: str, handler: Callable):
+		"""
+		Adds a page route.
+
+		:param      page_path:             The page path
+		:type       page_path:             str
+		:param      handler:               The handler
+		:type       handler:               Callable
+
+		:raises     RoutePathExistsError:  Such route already exists
+		"""
+		if page_path in self.routes:
+			raise RoutePathExistsError(f'Route "{page_path}" already exists.')
+
+		self.routes[page_path] = _create_page_route(page_path, handler)
+
+	def add_url(self, url: URL):
+		"""
+		Adds an url.
+
+		:param      url:  The url
+		:type       url:  URL
+		"""
+		self.routes[url.url] = _create_url_route(url)
+
+	def resolve(self, request: Request, raise_404: Optional[bool] = True) -> Union[Tuple[Callable, Dict], None]:
+		"""
+		Resolve path from request
+
+		:param      request:      The request
+		:type       request:      Request
+		:param      raise_404:    Indicates if the 404 is raised
+		:type       raise_404:    bool
+
+		:returns:   handler and named OR raise URLNotFound (if raise_404) OR None
+		:rtype:     Union[Tuple[Callable, Dict], None]:
+
+		:raises     URLNotFound:  URL Not Found
+		"""
+		url = _prepare_url(request.path)
+
+		for path, route in self.routes.items():
+			parse_result = parse(path, url)
+			if parse_result is not None:
+				return route.handler, parse_result.named
+
+		if raise_404:
+			raise URLNotFound(f'URL "{url}" not found.')
+		else:
+			return None, None

pyechonext/mvc/routes.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyechonext"
-version = "0.6.11"
+version = "0.6.12"
 description = "EchoNext is a lightweight, fast and scalable web framework for Python"
 authors = ["alexeev-prog <[email protected]>"]
 license = "LGPL-2.1"