docs: improve docs

Author: alexeev-prog

CHANGELOG.md

@@ -1,3 +1,39 @@
+commit dd7f1d3f45d3bc5137fafe1da2a5ca7cfd39c68b
+Author: alexeev-prog <[email protected]>
+Date:   Sat Nov 23 19:13:19 2024 +0700
+
+    feat/fix: improve apidoc_ui, add tests, add auditing, performance, slugger, permissions
+
+commit 7d4f639a95b8bb865696e1f3aa2e311fbd9c2171
+Author: alexeev-prog <[email protected]>
+Date:   Fri Nov 22 19:15:20 2024 +0700
+
+    feat/docs: create static files manageer, improve docs
+
+commit 2f845556d01ef76b460acc268a58ab5fc44b1412
+Author: alexeev-prog <[email protected]>
+Date:   Wed Nov 20 23:03:23 2024 +0700
+
+    feat/fix: add cache, improve api docs, other small changes
+
+commit 6a338e798919dc868e8de8431a1c4de78c6bb2ba
+Author: alexeev-prog <[email protected]>
+Date:   Thu Nov 14 21:19:35 2024 +0700
+
+    fix/style/docs: new version, improve docs, fix codestyle
+
+commit afc2300b2707cbe328a3256178a37dd0420dae00
+Author: alexeev-prog <[email protected]>
+Date:   Wed Nov 13 22:55:27 2024 +0700
+
+    feat/dpcs: create api docs html template generator, fix bugs, improve docs
+
+commit 4c1b03a23940e8221b6fb8643f6553d37ab165a2
+Author: alexeev-prog <[email protected]>
+Date:   Tue Nov 12 23:43:34 2024 +0700
+
+    docs: improve docs
+
 commit a709254bea3fe0b653a5a9117f7cd8f8989253ac
 Author: alexeev-prog <[email protected]>
 Date:   Tue Nov 12 23:41:51 2024 +0700

README.md

@@ -41,8 +41,8 @@ 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.5.9 alpha
  > Last unstable version: 0.6.9 alpha
+ > Last stable version: 0.5.9 alpha
 
  > Next Big Update: ASYNC & unicorn support
 
@@ -118,6 +118,9 @@ Welcome to **EchoNext**, where innovation meets simplicity! Are you tired of the
  + basic security and hashing
  + static files management
  + cache response bodies
+ + performance
+ + slugger
+ + permissions
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -212,6 +215,104 @@ python3 -m pyburn_build build --project-config example_configs/project_config.js
 ## 💻 Usage Examples
 You can view examples at [examples directory](./examples).
 
+### Performance caching
+
+```python
+import random
+from pyechonext.utils.performance import InMemoryPerformanceCache, SingletonPerformanceCache, performance_cached
+
+memorycache = InMemoryPerformanceCache
+perf = SingletonPerformanceCache(memorycache)
+
+
+@performance_cached(perf)
+def example_function(a: int = 10 ** 6):
+    inside_circle = 0
+
+    for _ in range(a):
+        x = random.uniform(-1, 1)
+        y = random.uniform(-1, 1)
+        if x ** 2 + y ** 2 <= 1:
+            inside_circle += 1
+
+    return (inside_circle / a) * 4
+
+
+if __name__ == '__main__':
+    print('start')
+    print(f'{example_function()} - Caching')
+    print(f'{example_function()} - Cached')
+    print(f'{example_function(10 ** 7)} - Caching new')
+```
+
+### Permissions
+
+```python
+from pyechonext.permissions import (
+    Permission,
+    Role,
+    Resource,
+    AccessControlRule,
+    Policy,
+    AgeRestrictionsABP,
+    User,
+    DefaultPermissionChecker,
+    UserController,
+)
+
+view_users_perm = Permission("view_users")
+edit_users_perm = Permission("edit_users")
+
+admin_role = Role("admin")
+admin_role.add_permission(view_users_perm)
+admin_role.add_permission(edit_users_perm)
+
+user_role = Role("user")
+user_role.add_permission(view_users_perm)
+
+user_resource = Resource("UserResource")
+
+policy = Policy()
+policy.add_rule(AccessControlRule(admin_role, view_users_perm, user_resource, True))
+policy.add_rule(AccessControlRule(admin_role, edit_users_perm, user_resource, True))
+policy.add_rule(AccessControlRule(user_role, view_users_perm, user_resource, True))
+policy.add_rule(AccessControlRule(user_role, edit_users_perm, user_resource, False))
+
+age_policy = AgeRestrictionsABP(conditions={"age": 18}, rules=policy.rules)
+age_policy.add_rule(AccessControlRule(user_role, view_users_perm, user_resource, True))
+
+admin_user = User("admin", attributes={"age": 30})
+admin_user.add_role(admin_role)
+
+young_user = User("john_doe", attributes={"age": 17})
+young_user.add_role(user_role)
+
+permission_checker = DefaultPermissionChecker(policy)
+user_controller = UserController(permission_checker)
+
+
+def main():
+    assert user_controller.view_users(admin_user, user_resource) == (
+        "200 OK",
+        "User edit form",
+    )
+    assert user_controller.edit_users(admin_user, user_resource) == (
+        "200 OK",
+        "User edit form",
+    )
+    assert user_controller.edit_users(young_user, user_resource) == (
+        "403 Forbidden",
+        "You do not have permission to edit users.",
+    )
+
+    assert age_policy.evaluate(young_user, user_resource, view_users_perm) == False
+    assert age_policy.evaluate(admin_user, user_resource, view_users_perm) == True
+
+
+if __name__ == "__main__":
+    main()
+```
+
 ### FullApp with locale, static files, docs generation
 Also see in [examples](./examples/example_locale.py)
 

pyechonext/utils/performance.py

@@ -1,7 +1,7 @@
 import time
 from functools import wraps
 from typing import Callable, Type, Any
-from pyechonext.patterns import Singleton
+from pyechonext.utils.patterns import Singleton
 
 
 class PerformanceCacheBase(object):