Merge branch 'dev'

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.7.11"
 
 # 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.7.11 alpha
 
  > Next Big Update: ASYNC & unicorn support
 
@@ -767,7 +767,7 @@ To test the web framework, PyTest with the pytest-cov plugin is used. You can lo
 
 | Statements | Miss       | Coverage |
 |------------|------------|----------|
-| 1327       | 997        | 28%      |
+| 1327       | 936        | 34%      |
 
 ## Documentation 🌍
 Extended documentation and framework specifications are available at the following links:

SECURITY.md

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

docs/en/index.md

@@ -8,6 +8,7 @@
 4. [Request/Response](./requests_responses.md)
 5. [i18n](./i18n_locales.md)
 6. [Security](./security.md)
+7. [MVC](./mvc.md)
 
 ## Additional materials
 

docs/en/mvc.md

@@ -0,0 +1,17 @@
+# pyEchoNext / MVC Architecture
+
+---
+
+MVC stands for Model-View-Controller, an architectural pattern that divides an application into three logical components: the model, the View, and the controller.
+
+The main idea of the MVC pattern is that each section of code has its own purpose. Part of the code contains application data, the other is responsible for how the user sees it, the latter controls its operation.
+
++ Model code **Model** stores data and associated logic, and anchors the structure of the application. That is, the programmer will determine the main components of the application using the template.
++ The application's appearance code, **View**, consists of functions that are responsible for the interface and how the user interacts with it. Views are created based on data collected from the model.
++ The controller code, **Controller**, links the model and view. It receives user input, interprets it and informs about the necessary changes. For example, sends commands to update state, such as saving a document.
+
+---
+
+[Contents](./index.md)
+
+

docs/ru/index.md

@@ -8,6 +8,7 @@
 4. [Request/Response](./requests_responses.md)
 5. [i18n](./i18n_locales.md)
 6. [Безопасность](./security.md)
+7. [MVC](./mvc.md)
 
 ## Дополнительные материалы
 

docs/ru/mvc.md

@@ -0,0 +1,17 @@
+# pyEchoNext / MVC Architecture
+
+---
+
+MVC - Model-View-Controller, архитектурный паттерн, который разделяет приложение на три логических компонента: модель, View (представление) и контроллер.
+
+Основная идея паттерна MVC в том, что у каждого раздела кода есть своя цель. Часть кода содержит данные приложения, друга отвечает за то, каким видит его пользователь, последняя управлеяет его работой.
+
+ + Код модели **Model** хранит данные и связанную с ними логику, а также закрепляет структуру приложения. То есть программист по шаблону будет определять основные компоненты приложения.
+ + Код внешнего вида приложения, **View**, состоит из функций, которые отвечают за интерфейс и способы взаимодействия пользователя с ним. Представления создают на основе данных, собранных из модели.
+ + Код контроллера, **Controller**, связывает модель и представление. Он получает на вход пользовательский ввод, интепретирует его и информирует о необходимых изменениях. Например, отправляет команды для обновления состояния, таких как сохранение документа.
+
+---
+
+[Содержание](./index.md)
+
+

examples/advanced_app.py

@@ -3,35 +3,35 @@
 from pyechonext.app import ApplicationType, EchoNext
 from pyechonext.config import Settings
 from pyechonext.middleware import middlewares
-from pyechonext.urls import URL, IndexView
-from pyechonext.views import View
+from pyechonext.mvc.controllers import PageController
+from pyechonext.urls import URL
 
 
-class UsersView(View):
-    def get(self, request, response, **kwargs):
-        return "users get"
+class UsersPageController(PageController):
+	def get(self, request, response, **kwargs):
+		return "users get"
 
-    def post(self, request, response, **kwargs):
-        return "users post"
+	def post(self, request, response, **kwargs):
+		return "users post"
 
 
-url_patterns = [URL(url="/", view=IndexView), URL(url="/users", view=UsersView)]
+url_patterns = [URL(path="/users", controller=UsersPageController)]
 settings = Settings(
-    BASE_DIR=os.path.dirname(os.path.abspath(__file__)), TEMPLATES_DIR="templates"
+	BASE_DIR=os.path.dirname(os.path.abspath(__file__)), TEMPLATES_DIR="templates"
 )
 echonext = EchoNext(
-    __name__,
-    settings,
-    middlewares,
-    urls=url_patterns,
-    application_type=ApplicationType.HTML,
+	__name__,
+	settings,
+	middlewares,
+	urls=url_patterns,
+	application_type=ApplicationType.HTML,
 )
 
 
 @echonext.route_page("/book")
-class BooksResource(View):
-    def get(self, request, response, **kwargs):
-        return f"Books Page: {request.GET}"
+class BooksResource(PageController):
+	def get(self, request, response, **kwargs):
+		return f"Books Page: {request.GET}"
 
-    def post(self, request, response, **kwargs):
-        return "Endpoint to create a book"
+	def post(self, request, response, **kwargs):
+		return "Endpoint to create a book"

examples/example_locale.py

@@ -1,86 +1,83 @@
-import os
-
 from pyechonext.apidoc_ui import APIDocUI, APIDocumentation
 from pyechonext.app import ApplicationType, EchoNext
 from pyechonext.config import SettingsConfigType, SettingsLoader
 from pyechonext.middleware import middlewares
-from pyechonext.response import Response
+from pyechonext.mvc.controllers import PageController
 from pyechonext.static import StaticFile
 from pyechonext.template_engine.jinja import render_template
-from pyechonext.urls import URL, IndexView
+from pyechonext.urls import URL
 from pyechonext.utils.exceptions import MethodNotAllow
-from pyechonext.views import View
 
 
-class UsersView(View):
-    def get(self, request, response, **kwargs):
-        return render_template(
-            request,
-            "index.html",
-            user_name="User",
-            session_id=request.session_id,
-            friends=["Bob", "Anna", "John"],
-        )
+class UsersView(PageController):
+	def get(self, request, response, *args, **kwargs):
+		return render_template(
+			request,
+			"index.html",
+			user_name="User",
+			session_id=request.session_id,
+			friends=["Bob", "Anna", "John"],
+		)
 
-    def post(self, request, response, **kwargs):
-        raise MethodNotAllow(f"Request {request.path}: method not allow")
+	def post(self, request, response, *args, **kwargs):
+		raise MethodNotAllow(f"Request {request.path}: method not allow")
 
 
-url_patterns = [URL(url="/", view=IndexView), URL(url="/users", view=UsersView)]
+url_patterns = [URL(path="/users", controller=UsersView)]
 config_loader = SettingsLoader(SettingsConfigType.PYMODULE, "el_config.py")
 settings = config_loader.get_settings()
 static_files = [StaticFile(settings, "styles.css")]
 echonext = EchoNext(
-    __name__,
-    settings,
-    middlewares,
-    urls=url_patterns,
-    application_type=ApplicationType.HTML,
-    static_files=static_files,
+	__name__,
+	settings,
+	middlewares,
+	urls=url_patterns,
+	application_type=ApplicationType.HTML,
+	static_files=static_files,
 )
 apidoc = APIDocumentation(echonext)
 
 
 @echonext.route_page("/api-docs")
 def api_docs(request, response):
-    ui = APIDocUI(apidoc.generate_spec())
-    return ui.generate_html_page()
+	ui = APIDocUI(apidoc.generate_spec())
+	return ui.generate_html_page()
 
 
 @echonext.route_page("/book")
-class BooksResource(View):
-    """
-    This class describes a books resource.
-    """
-
-    def get(self, request, response, **kwargs):
-        """
-        get queries
-
-        :param      request:   The request
-        :type       request:   Request
-        :param      response:  The response
-        :type       response:  Response
-        :param      kwargs:    The keywords arguments
-        :type       kwargs:    dictionary
-
-        :returns:   result
-        :rtype:     str
-        """
-        return echonext.i18n_loader.get_string("title %{name}", name=str(request.GET))
-
-    def post(self, request, response, **kwargs):
-        """
-        post queries
-
-        :param      request:   The request
-        :type       request:   Request
-        :param      response:  The response
-        :type       response:  Response
-        :param      kwargs:    The keywords arguments
-        :type       kwargs:    dictionary
-
-        :returns:   result
-        :rtype:     str
-        """
-        return echonext.l10n_loader.format_currency(1305.50)
+class BooksResource(PageController):
+	"""
+	This class describes a books resource.
+	"""
+
+	def get(self, request, response, **kwargs):
+		"""
+		get queries
+
+		:param		request:   The request
+		:type		request:   Request
+		:param		response:  The response
+		:type		response:  Response
+		:param		kwargs:	   The keywords arguments
+		:type		kwargs:	   dictionary
+
+		:returns:	result
+		:rtype:		str
+		"""
+		return echonext.i18n_loader.get_string("title %{name}", name=str(request.GET))
+
+	def post(self, request, response, **kwargs):
+		"""
+		post queries
+
+		:param		request:   The request
+		:type		request:   Request
+		:param		response:  The response
+		:type		response:  Response
+		:param		kwargs:	   The keywords arguments
+		:type		kwargs:	   dictionary
+
+		:returns:	result
+		:rtype:		str
+		"""
+		return echonext.l10n_loader.format_currency(1305.50)

examples/hashing.py

@@ -0,0 +1,22 @@
+from pyechonext.security.hashing import HashAlgorithm, PlainHasher, SaltedHasher
+
+hasher = PlainHasher(HashAlgorithm.BLAKE2S)
+old_hash = hasher.hash("TEXT")
+new_hash = hasher.hash("TEXT")
+
+if hasher.verify("TEXT", new_hash):	 # true
+	print("Yes!")
+
+if hasher.verify("TEXT2", old_hash):  # false
+	print("Yes!")
+
+
+hasher = SaltedHasher(HashAlgorithm.BLAKE2S, salt="bob")
+old_hash = hasher.hash("TEXT")
+new_hash = hasher.hash("TEXT")
+
+if hasher.verify("TEXT", new_hash):	 # true
+	print("Yes!")
+
+if hasher.verify("TEXT2", old_hash):  # false
+	print("Yes!")