zrb 1.0.0a17__tar.gz → 1.0.0a19__tar.gz

{zrb-1.0.0a17 → zrb-1.0.0a19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: zrb
-Version: 1.0.0a17
+Version: 1.0.0a19
 Summary: Your Automation Powerhouse
 Home-page: https://github.com/state-alchemists/zrb
 License: AGPL-3.0-or-later

{zrb-1.0.0a17 → zrb-1.0.0a19}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "zrb"
-version = "1.0.0a17"
+version = "1.0.0a19"
 description = "Your Automation Powerhouse"
 authors = ["Go Frendi Gunawan <gofrendiasgard@gmail.com>"]
 license = "AGPL-3.0-or-later"

{zrb-1.0.0a17 → zrb-1.0.0a19}/src/zrb/__init__.py

@@ -27,6 +27,7 @@ from zrb.group.group import Group
 from zrb.input.any_input import AnyInput
 from zrb.input.base_input import BaseInput
 from zrb.input.bool_input import BoolInput
+from zrb.input.float_input import FloatInput
 from zrb.input.int_input import IntInput
 from zrb.input.option_input import OptionInput
 from zrb.input.password_input import PasswordInput
@@ -73,6 +74,7 @@ assert CmdResult
 assert CmdTask
 assert HttpCheck
 assert TcpCheck
+assert FloatInput
 assert IntInput
 assert OptionInput
 assert PasswordInput

{zrb-1.0.0a17 → zrb-1.0.0a19}/src/zrb/builtin/project/add/fastapp/fastapp_task.py

@@ -6,19 +6,18 @@ from zrb.builtin.project.add.fastapp.fastapp_input import (
     project_dir_input,
 )
 from zrb.builtin.project.add.fastapp.fastapp_util import (
-    get_zrb_init_import_code,
-    get_zrb_init_load_app_name_task,
+    is_in_project_app_dir,
+    is_project_zrb_init_file,
+    update_project_zrb_init_file,
 )
+from zrb.content_transformer.content_transformer import ContentTransformer
 from zrb.context.any_context import AnyContext
 from zrb.task.make_task import make_task
 from zrb.task.scaffolder import Scaffolder
 from zrb.task.task import Task
-from zrb.util.file import read_file, write_file
 from zrb.util.string.conversion import to_snake_case
 from zrb.util.string.name import get_random_name
 
-_DIR = os.path.dirname(__file__)
-
 
 @make_task(
     name="validate-create-fastapp",
@@ -41,51 +40,38 @@ scaffold_fastapp = Scaffolder(
         app_name_input,
     ],
     upstream=validate_create_fastapp,
-    source_path=os.path.join(_DIR, "fastapp_template"),
+    source_path=os.path.join(os.path.dirname(__file__), "fastapp_template"),
     render_source_path=False,
-    destination_path=lambda ctx: os.path.join(
-        ctx.input.project_dir, to_snake_case(ctx.input.app)
-    ),
-    transform_content={
-        "fastapp_template": "{to_snake_case(ctx.input.app)}",
-        "My App Name": "{ctx.input.app.title()}",
-        "my-app-name": "{to_kebab_case(ctx.input.app)}",
+    destination_path="{ctx.input.project_dir}",
+    transform_path={
         "my_app_name": "{to_snake_case(ctx.input.app)}",
-        "MY_APP_NAME": "{to_snake_case(ctx.input.app).upper()}",
-        "my-secure-password": lambda _: get_random_name(),
     },
-    retries=0,
-)
-
-
-@make_task(
-    name="update-fastapp-zrb-init",
-    input=[
-        project_dir_input,
-        app_name_input,
+    transform_content=[
+        # Common transformation (project_dir/app_dir/**/*)
+        ContentTransformer(
+            match=is_in_project_app_dir,
+            transform={
+                "My App Name": "{ctx.input.app.title()}",
+                "my-app-name": "{to_kebab_case(ctx.input.app)}",
+                "my_app_name": "{to_snake_case(ctx.input.app)}",
+                "MY_APP_NAME": "{to_snake_case(ctx.input.app).upper()}",
+                "my-secure-password": lambda _: get_random_name(),
+            },
+        ),
+        # Register fastapp's tasks to project's zrb_init (project_dir/zrb_init.py)
+        ContentTransformer(
+            match=is_project_zrb_init_file,
+            transform=update_project_zrb_init_file,
+        ),
     ],
-    upstream=scaffold_fastapp,
     retries=0,
 )
-def update_fastapp_zrb_init(ctx: AnyContext):
-    zrb_init_path = os.path.join(ctx.input.project_dir, "zrb_init.py")
-    old_zrb_init_code = read_file(zrb_init_path)
-    write_file(
-        file_path=zrb_init_path,
-        content=[
-            get_zrb_init_import_code(old_zrb_init_code),
-            old_zrb_init_code.strip(),
-            get_zrb_init_load_app_name_task(ctx.input.app),
-            "",
-        ],
-    )
-
 
 add_fastapp_to_project = add_to_project_group.add_task(
     Task(
         name="add-fastapp",
         description="🚀 Add FastApp to project",
-        upstream=update_fastapp_zrb_init,
+        upstream=scaffold_fastapp,
         retries=0,
     ),
     alias="fastapp",

zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 95
+extend-ignore = E203, E704

zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/column/create_column_task.py

@@ -0,0 +1,14 @@
+from my_app_name._zrb.format_task import format_my_app_name_code
+from my_app_name._zrb.group import app_create_group
+
+from zrb import Task
+
+add_my_app_name_column = app_create_group.add_task(
+    Task(
+        name="add-my-app-name-column",
+        description="📊 Create new column on an entity",
+        successor=format_my_app_name_code,
+        retries=0,
+    ),
+    alias="column",
+)

zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/add_entity_task.py

@@ -0,0 +1,128 @@
+import os
+
+from my_app_name._zrb.config import APP_DIR
+from my_app_name._zrb.entity.add_entity_util import (
+    is_in_app_schema_dir,
+    is_in_module_entity_dir,
+    is_module_any_client_file,
+    is_module_api_client_file,
+    is_module_direct_client_file,
+    is_module_migration_metadata_file,
+    is_module_route_file,
+    update_any_client,
+    update_api_client,
+    update_direct_client,
+    update_migration_metadata,
+    update_route,
+)
+from my_app_name._zrb.format_task import format_my_app_name_code
+from my_app_name._zrb.group import app_create_group
+from my_app_name._zrb.input import (
+    existing_module_input,
+    new_entity_column_input,
+    new_entity_input,
+    plural_entity_input,
+)
+from my_app_name._zrb.util import get_existing_module_names, get_existing_schema_names
+
+from zrb import AnyContext, ContentTransformer, Scaffolder, Task, make_task
+from zrb.util.string.conversion import to_snake_case
+
+
+@make_task(
+    name="validate-create-my-app-name-entity",
+    input=[
+        existing_module_input,
+        new_entity_input,
+        plural_entity_input,
+        new_entity_column_input,
+    ],
+    retries=0,
+)
+async def validate_create_my_app_name_entity(ctx: AnyContext):
+    module_name = to_snake_case(ctx.input.module)
+    if module_name not in get_existing_module_names():
+        raise ValueError(f"Module not exist: {module_name}")
+    schema_name = to_snake_case(ctx.input.entity)
+    if schema_name in get_existing_schema_names():
+        raise ValueError(f"Schema already exists: {schema_name}")
+
+
+scaffold_my_app_name_entity = Scaffolder(
+    name="scaffold-my-app-name-entity",
+    input=[
+        existing_module_input,
+        new_entity_input,
+        plural_entity_input,
+        new_entity_column_input,
+    ],
+    source_path=os.path.join(os.path.dirname(__file__), "template", "app_template"),
+    render_source_path=False,
+    destination_path=APP_DIR,
+    transform_path={
+        "my_module": "{to_snake_case(ctx.input.module)}",
+        "my_entity": "{to_snake_case(ctx.input.entity)}",
+    },
+    transform_content=[
+        # Schema tranformation (my_app_name/schema/snake_entity_name)
+        ContentTransformer(
+            match=is_in_app_schema_dir,
+            transform={
+                "MyEntity": "{to_pascal_case(ctx.input.entity)}",
+                "my_column": "{to_snake_case(ctx.input.column)}",
+            },
+        ),
+        # Common module's entity transformation
+        # (my_app_name/module/snake_module_name/service/snake_entity_name)
+        ContentTransformer(
+            match=is_in_module_entity_dir,
+            transform={
+                "my_module": "{to_snake_case(ctx.input.module)}",
+                "MyEntity": "{to_pascal_case(ctx.input.entity)}",
+                "my_entity": "{to_snake_case(ctx.input.entity)}",
+                "my_entities": "{to_snake_case(ctx.input.plural)}",
+                "my-entities": "{to_kebab_case(ctx.input.plural)}",
+            },
+        ),
+        # Add entity to migration metadata
+        # (my_app_name/module/snake_module_name/migration_metadata.py)
+        ContentTransformer(
+            match=is_module_migration_metadata_file,
+            transform=update_migration_metadata,
+        ),
+        # Update API Client (my_app_name/module/snake_module_name/client/api_client.py)
+        ContentTransformer(
+            match=is_module_api_client_file,
+            transform=update_api_client,
+        ),
+        # Update Direct Client (my_app_name/module/snake_module_name/client/direct_client.py)
+        ContentTransformer(
+            match=is_module_direct_client_file,
+            transform=update_direct_client,
+        ),
+        # Update Any Client (my_app_name/module/snake_module_name/client/any_client.py)
+        ContentTransformer(
+            match=is_module_any_client_file,
+            transform=update_any_client,
+        ),
+        # Update module route (my_app_name/module/route.py)
+        ContentTransformer(
+            match=is_module_route_file,
+            transform=update_route,
+        ),
+        # TODO: Register gateway route
+    ],
+    retries=0,
+    upstream=validate_create_my_app_name_entity,
+)
+
+add_my_app_name_entity = app_create_group.add_task(
+    Task(
+        name="add-my-app-name-entity",
+        description="🏗️ Create new entity on a module",
+        upstream=scaffold_my_app_name_entity,
+        successor=format_my_app_name_code,
+        retries=0,
+    ),
+    alias="entity",
+)

zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/add_entity_util.py

@@ -0,0 +1,213 @@
+import os
+
+from my_app_name._zrb.config import APP_DIR
+
+from zrb.context.any_context import AnyContext
+from zrb.util.codemod.append_code_to_class import append_code_to_class
+from zrb.util.codemod.append_code_to_function import append_code_to_function
+from zrb.util.codemod.prepend_code_to_module import prepend_code_to_module
+from zrb.util.codemod.prepend_parent_to_class import prepend_parent_class
+from zrb.util.file import read_file, write_file
+from zrb.util.string.conversion import to_pascal_case, to_snake_case
+
+
+def is_in_app_schema_dir(ctx: AnyContext, file_path: str) -> bool:
+    return file_path.startswith(
+        os.path.join(APP_DIR, "schema", to_snake_case(ctx.input.entity))
+    )
+
+
+def is_in_module_entity_dir(ctx: AnyContext, file_path: str) -> bool:
+    return file_path.startswith(
+        os.path.join(
+            APP_DIR,
+            "module",
+            to_snake_case(ctx.input.module),
+            "service",
+            to_snake_case(ctx.input.entity),
+        )
+    )
+
+
+def is_module_route_file(ctx: AnyContext, file_path: str) -> bool:
+    module_route_file = os.path.join(
+        APP_DIR,
+        "module",
+        to_snake_case(ctx.input.module),
+        "route.py",
+    )
+    return file_path == module_route_file
+
+
+def is_module_migration_metadata_file(ctx: AnyContext, file_path: str) -> bool:
+    module_migration_metadata_file = os.path.join(
+        APP_DIR,
+        "module",
+        to_snake_case(ctx.input.module),
+        "migration_metadata.py",
+    )
+    return file_path == module_migration_metadata_file
+
+
+def is_module_any_client_file(ctx: AnyContext, file_path: str) -> bool:
+    module_any_client_file = os.path.join(
+        APP_DIR,
+        "module",
+        to_snake_case(ctx.input.module),
+        "client",
+        "any_client.py",
+    )
+    return file_path == module_any_client_file
+
+
+def is_module_api_client_file(ctx: AnyContext, file_path: str) -> bool:
+    module_api_client_file = os.path.join(
+        APP_DIR,
+        "module",
+        to_snake_case(ctx.input.module),
+        "client",
+        "api_client.py",
+    )
+    return file_path == module_api_client_file
+
+
+def is_module_direct_client_file(ctx: AnyContext, file_path: str) -> bool:
+    module_direct_client_file = os.path.join(
+        APP_DIR,
+        "module",
+        to_snake_case(ctx.input.module),
+        "client",
+        "direct_client.py",
+    )
+    return file_path == module_direct_client_file
+
+
+def update_migration_metadata(ctx: AnyContext, migration_metadata_file_path: str):
+    app_name = os.path.basename(APP_DIR)
+    existing_migration_metadata_code = read_file(migration_metadata_file_path)
+    write_file(
+        file_path=migration_metadata_file_path,
+        content=[
+            _get_import_schema_code(
+                existing_migration_metadata_code, app_name, ctx.input.entity
+            ),
+            existing_migration_metadata_code.strip(),
+            _get_entity_metadata_assignment_code(
+                existing_migration_metadata_code, ctx.input.entity
+            ),
+        ],
+    )
+
+
+def _get_import_schema_code(
+    existing_code: str, app_name: str, entity_name: str
+) -> str | None:
+    snake_entity_name = to_snake_case(entity_name)
+    pascal_entity_name = to_pascal_case(entity_name)
+    import_module_path = f"{app_name}.schema.{snake_entity_name}"
+    import_schema_code = f"from {import_module_path} import {pascal_entity_name}"
+    if import_schema_code in existing_code:
+        return None
+    return import_schema_code
+
+
+def _get_entity_metadata_assignment_code(
+    existing_code: str, entity_name: str
+) -> str | None:
+    pascal_entity_name = to_pascal_case(entity_name)
+    entity_metadata_assignment_code = "\n".join(
+        [
+            f"{pascal_entity_name}.metadata = metadata",
+            f"{pascal_entity_name}.__table__.tometadata(metadata)",
+        ]
+    )
+    if entity_metadata_assignment_code in existing_code:
+        return None
+    return entity_metadata_assignment_code
+
+
+def update_any_client(ctx: AnyContext, any_client_file_path: str):
+    existing_any_client_code = read_file(any_client_file_path)
+    app_name = os.path.basename(APP_DIR)
+    snake_entity_name = to_snake_case(ctx.input.entity)
+    snake_plural_entity_name = to_snake_case(ctx.input.plural)
+    pascal_entity_name = to_pascal_case(ctx.input.entity)
+    any_client_method = read_file(
+        file_path=os.path.join(
+            os.path.dirname(__file__), "template", "any_client_method.py"
+        ),
+        replace_map={
+            "my_entity": snake_entity_name,
+            "my_entities": snake_plural_entity_name,
+            "MyEntity": pascal_entity_name,
+        },
+    )
+    new_code = append_code_to_class(
+        existing_any_client_code, "AnyClient", any_client_method
+    )
+    write_file(
+        file_path=any_client_file_path,
+        content=[
+            f"from {app_name}.schema.{snake_entity_name}.{snake_entity_name} import (",
+            f"    {pascal_entity_name}CreateWithAudit, {pascal_entity_name}Response, {pascal_entity_name}UpdateWithAudit",  # noqa
+            ")",
+            new_code.strip(),
+        ],
+    )
+
+
+def update_api_client(ctx: AnyContext, api_client_file_path: str):
+    existing_api_client_code = read_file(api_client_file_path)
+    upper_snake_module_name = to_snake_case(ctx.input.module).upper()
+    app_name = os.path.basename(APP_DIR)
+    snake_entity_name = to_snake_case(ctx.input.entity)
+    snake_module_name = to_snake_case(ctx.input.module)
+    write_file(
+        file_path=api_client_file_path,
+        content=[
+            f"from {app_name}.module.{snake_module_name}.service.{snake_entity_name}.{snake_entity_name}_usecase import {snake_entity_name}_usecase",  # noqa
+            prepend_code_to_module(
+                prepend_parent_class(
+                    existing_api_client_code, "APIClient", "user_api_client"
+                ),
+                f"user_api_client = user_usecase.as_api_client(base_url=APP_{upper_snake_module_name}_BASE_URL)",  # noqa
+            ),
+        ],
+    )
+
+
+def update_direct_client(ctx: AnyContext, direct_client_file_path: str):
+    existing_direct_client_code = read_file(direct_client_file_path)
+    app_name = os.path.basename(APP_DIR)
+    snake_entity_name = to_snake_case(ctx.input.entity)
+    snake_module_name = to_snake_case(ctx.input.module)
+    write_file(
+        file_path=direct_client_file_path,
+        content=[
+            f"from {app_name}.module.{snake_module_name}.service.{snake_entity_name}.{snake_entity_name}_usecase import {snake_entity_name}_usecase",  # noqa
+            prepend_code_to_module(
+                prepend_parent_class(
+                    existing_direct_client_code, "DirectClient", "user_direct_client"
+                ),
+                "user_direct_client = user_usecase.as_direct_client()",
+            ).strip(),
+        ],
+    )
+
+
+def update_route(ctx: AnyContext, route_file_path: str):
+    existing_route_code = read_file(route_file_path)
+    entity_name = to_snake_case(ctx.input.entity)
+    app_name = os.path.basename(APP_DIR)
+    module_name = to_snake_case(ctx.input.module)
+    write_file(
+        file_path=route_file_path,
+        content=[
+            f"from {app_name}.module.{module_name}.service.{entity_name}.{entity_name}_usecase import {entity_name}_usecase",  # noqa
+            append_code_to_function(
+                existing_route_code,
+                "serve_route",
+                f"{entity_name}_usecase.serve_route(app)",
+            ),
+        ],
+    )

zrb-1.0.0a17/src/zrb/builtin/project/add/fastapp/fastapp_template/_zrb/entity/any_client_method.template.py → zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/template/any_client_method.py

@@ -4,7 +4,7 @@ async def get_my_entity_by_id(self, my_entity_id: str) -> MyEntityResponse:
 
 
 @abstractmethod
-async def get_all_my_entitys(self) -> list[MyEntityResponse]:
+async def get_all_my_entities(self) -> list[MyEntityResponse]:
     pass
 
 

{zrb-1.0.0a17/src/zrb/builtin/project/add/fastapp/fastapp_template/_zrb/entity/module_template → zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/template/app_template/module/my_module}/service/my_entity/my_entity_usecase.py

@@ -1,11 +1,11 @@
-from fastapp_template.common.base_usecase import BaseUsecase
-from fastapp_template.module.my_module.service.my_entity.repository.factory import (
+from my_app_name.common.base_usecase import BaseUsecase
+from my_app_name.module.my_module.service.my_entity.repository.factory import (
     my_entity_repository,
 )
-from fastapp_template.module.my_module.service.my_entity.repository.my_entity_repository import (
+from my_app_name.module.my_module.service.my_entity.repository.my_entity_repository import (
     MyEntityRepository,
 )
-from fastapp_template.schema.my_entity import (
+from my_app_name.schema.my_entity import (
     MyEntityCreateWithAudit,
     MyEntityResponse,
     MyEntityUpdateWithAudit,
@@ -13,7 +13,6 @@ from fastapp_template.schema.my_entity import (
 
 
 class MyEntityUsecase(BaseUsecase):
-
     def __init__(self, my_entity_repository: MyEntityRepository):
         super().__init__()
         self.my_entity_repository = my_entity_repository

zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/template/app_template/module/my_module/service/my_entity/repository/factory.py

@@ -0,0 +1,13 @@
+from my_app_name.common.db_engine import engine
+from my_app_name.config import APP_REPOSITORY_TYPE
+from my_app_name.module.my_module.service.my_entity.repository.my_entity_db_repository import (
+    MyEntityDBRepository,
+)
+from my_app_name.module.my_module.service.my_entity.repository.my_entity_repository import (
+    MyEntityRepository,
+)
+
+if APP_REPOSITORY_TYPE == "db":
+    my_entity_repository: MyEntityRepository = MyEntityDBRepository(engine)
+else:
+    my_entity_repository: MyEntityRepository = None

{zrb-1.0.0a17/src/zrb/builtin/project/add/fastapp/fastapp_template/_zrb/entity/module_template → zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/template/app_template/module/my_module}/service/my_entity/repository/my_entity_db_repository.py

@@ -1,9 +1,9 @@
-from fastapp_template.common.base_db_repository import BaseDBRepository
-from fastapp_template.common.error import NotFoundError
-from fastapp_template.module.my_module.service.my_entity.repository.my_entity_repository import (
+from my_app_name.common.base_db_repository import BaseDBRepository
+from my_app_name.common.error import NotFoundError
+from my_app_name.module.my_module.service.my_entity.repository.my_entity_repository import (
     MyEntityRepository,
 )
-from fastapp_template.schema.my_entity import (
+from my_app_name.schema.my_entity import (
     MyEntity,
     MyEntityCreateWithAudit,
     MyEntityResponse,

{zrb-1.0.0a17/src/zrb/builtin/project/add/fastapp/fastapp_template/_zrb/entity/module_template → zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/entity/template/app_template/module/my_module}/service/my_entity/repository/my_entity_repository.py

@@ -1,6 +1,6 @@
 from abc import ABC, abstractmethod
 
-from fastapp_template.schema.my_entity import (
+from my_app_name.schema.my_entity import (
     MyEntity,
     MyEntityCreateWithAudit,
     MyEntityResponse,
@@ -9,7 +9,6 @@ from fastapp_template.schema.my_entity import (
 
 
 class MyEntityRepository(ABC):
-
     @abstractmethod
     async def create(self, my_entity_data: MyEntityCreateWithAudit) -> MyEntityResponse:
         pass

zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name/_zrb/format_task.py

@@ -0,0 +1,17 @@
+from my_app_name._zrb.config import APP_DIR
+from my_app_name._zrb.group import app_group
+
+from zrb.task.cmd_task import CmdTask
+
+format_my_app_name_code = app_group.add_task(
+    CmdTask(
+        name="format-my-app-name-code",
+        description="✏️ Format Python code",
+        cmd=[
+            "isort . --profile black --force-grid-wrap 0",
+            "black .",
+        ],
+        cwd=APP_DIR,
+    ),
+    alias="format",
+)

{zrb-1.0.0a17/src/zrb/builtin/project/add/fastapp/fastapp_template → zrb-1.0.0a19/src/zrb/builtin/project/add/fastapp/fastapp_template/my_app_name}/_zrb/input.py

@@ -1,7 +1,4 @@
-from fastapp_template._zrb.util import (
-    get_existing_module_names,
-    get_existing_schema_names,
-)
+from my_app_name._zrb.util import get_existing_module_names, get_existing_schema_names
 
 from zrb import OptionInput, StrInput
 from zrb.util.string.conversion import pluralize