zrb 0.10.0__py3-none-any.whl → 0.11.2__py3-none-any.whl

zrb/builtin/project/add/fastapp/crud/_input.py

@@ -0,0 +1,40 @@
+from zrb.task_input.str_input import StrInput
+
+entity_name_input = StrInput(
+    name="entity-name",
+    shortcut="e",
+    description="Singular entity name",
+    prompt="Singular entity name",
+    default="book",
+)
+
+plural_entity_name_input = StrInput(
+    name="plural-entity-name",
+    description="Plural entity name",
+    prompt="Plural entity name",
+    default="books",
+)
+
+main_column_name_input = StrInput(
+    name="column-name",
+    shortcut="c",
+    description="Main column name",
+    prompt="Main column name",
+    default="code",
+)
+
+column_name_input = StrInput(
+    name="column-name",
+    shortcut="c",
+    description="Column name",
+    prompt="Column name",
+    default="title",
+)
+
+column_type_input = StrInput(
+    name="column-type",
+    shortcut="t",
+    description="Column type",
+    prompt="Column type",
+    default="str",
+)

zrb/builtin/project/add/fastapp/crud/_task_factory.py

@@ -0,0 +1,35 @@
+import os
+
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add.fastapp.app._input import app_name_input
+from zrb.builtin.project.add.fastapp.crud._input import entity_name_input
+from zrb.builtin.project.add.fastapp.module._input import module_name_input
+from zrb.helper.typecheck import typechecked
+from zrb.helper.typing import List
+from zrb.task.any_task import AnyTask
+from zrb.task.cmd_task import CmdTask
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_CODEMOD_DIR = os.path.join(_CURRENT_DIR, "nodejs", "codemod")
+
+_NAV_CONFIG_FILE_PATH = "{{input.project_dir}}/src/{{util.to_kebab_case(input.app_name)}}/src/frontend/src/lib/config/navData.ts"  # noqa
+_ENV_VAR_NAME = "navData"
+_NAV_TITLE = "{{util.to_pascal_case(input.entity_name)}}"
+_NAV_URL = "/{{util.to_kebab_case(input.module_name)}}/{{util.to_kebab_case(input.entity_name)}}"  # noqa
+_NAV_PERMISSION = "{{util.to_snake_case(input.module_name)}}:{{util.to_snake_case(input.entity_name)}}:get"  # noqa
+
+
+@typechecked
+def create_add_navigation_task(upstreams: List[AnyTask]) -> AnyTask:
+    return CmdTask(
+        name="add-navigation",
+        inputs=[
+            project_dir_input,
+            app_name_input,
+            module_name_input,
+            entity_name_input,
+        ],
+        upstreams=upstreams,
+        retry=0,
+        cmd=f'node {_CODEMOD_DIR}/dist/addNav.js "{_NAV_CONFIG_FILE_PATH}" "{_ENV_VAR_NAME}" "{_NAV_TITLE}" "{_NAV_URL}" "{_NAV_PERMISSION}"',  # noqa
+    )

zrb/builtin/project/add/fastapp/crud/crud.py

@@ -0,0 +1,162 @@
+import asyncio
+import os
+
+from zrb.builtin.project._helper import validate_existing_project_dir
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add.fastapp._group import project_add_fastapp_group
+from zrb.builtin.project.add.fastapp.app._input import app_name_input
+from zrb.builtin.project.add.fastapp.crud._helper import (
+    register_api,
+    register_permission,
+    register_rpc,
+)
+from zrb.builtin.project.add.fastapp.crud._input import (
+    entity_name_input,
+    main_column_name_input,
+    plural_entity_name_input,
+)
+from zrb.builtin.project.add.fastapp.crud._task_factory import (
+    create_add_navigation_task,
+)
+from zrb.builtin.project.add.fastapp.module._input import module_name_input
+from zrb.helper import util
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.cmd_task import CmdTask
+from zrb.task.decorator import python_task
+from zrb.task.resource_maker import ResourceMaker
+from zrb.task.task import Task
+
+_CURRENT_DIR = os.path.dirname(__file__)
+_CODEMOD_DIR = os.path.join(_CURRENT_DIR, "nodejs", "codemod")
+
+
+@python_task(
+    name="validate",
+    inputs=[project_dir_input, app_name_input, module_name_input, entity_name_input],
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get("project_dir")
+    validate_existing_project_dir(project_dir)
+    app_name = kwargs.get("app_name")
+    module_name = kwargs.get("module_name")
+    entity_name = kwargs.get("entity_name")
+    snake_module_name = util.to_snake_case(module_name)
+    snake_entity_name = util.to_snake_case(entity_name)
+    automation_dir = os.path.join(
+        project_dir, "_automate", util.to_snake_case(app_name)
+    )
+    if not os.path.exists(automation_dir):
+        raise Exception(f"Automation directory does not exist: {automation_dir}")
+    app_dir = os.path.join(project_dir, "src", f"{util.to_kebab_case(app_name)}")
+    if not os.path.exists(app_dir):
+        raise Exception(f"App directory does not exist: {app_dir}")
+    module_path = os.path.join(app_dir, "src", "module", snake_module_name)
+    if not os.path.exists(module_path):
+        raise Exception(f"Module directory does not exist: {module_path}")
+    entity_path = os.path.join(module_path, "entity", snake_entity_name)
+    if os.path.exists(entity_path):
+        raise Exception(f"Entity directory already exists: {entity_path}")
+
+
+copy_resource = ResourceMaker(
+    name="copy-resource",
+    inputs=[
+        project_dir_input,
+        app_name_input,
+        module_name_input,
+        entity_name_input,
+        plural_entity_name_input,
+        main_column_name_input,
+    ],
+    upstreams=[validate],
+    replacements={
+        "zrbAppName": "{{input.app_name}}",
+        "zrbModuleName": "{{input.module_name}}",
+        "zrbEntityName": "{{input.entity_name}}",
+        "zrbPluralEntityName": "{{input.plural_entity_name}}",
+        "zrbColumnName": "{{input.column_name}}",
+    },
+    template_path=os.path.join(_CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
+    excludes=[
+        "*/__pycache__",
+    ],
+)
+
+
+@python_task(
+    name="register-crud",
+    inputs=[
+        project_dir_input,
+        app_name_input,
+        module_name_input,
+        entity_name_input,
+        plural_entity_name_input,
+        main_column_name_input,
+    ],
+    upstreams=[
+        copy_resource,
+    ],
+)
+async def register_crud(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    project_dir = kwargs.get("project_dir", ".")
+    app_name = kwargs.get("app_name")
+    module_name = kwargs.get("module_name")
+    entity_name = kwargs.get("entity_name")
+    kebab_app_name = util.to_kebab_case(app_name)
+    snake_module_name = util.to_snake_case(module_name)
+    snake_entity_name = util.to_snake_case(entity_name)
+    await asyncio.gather(
+        asyncio.create_task(
+            register_api(
+                task, project_dir, kebab_app_name, snake_module_name, snake_entity_name
+            )
+        ),
+        asyncio.create_task(
+            register_rpc(
+                task, project_dir, kebab_app_name, snake_module_name, snake_entity_name
+            )
+        ),
+        asyncio.create_task(
+            register_permission(
+                task, project_dir, kebab_app_name, snake_module_name, snake_entity_name
+            )
+        ),
+    )
+
+
+prepare_codemod = CmdTask(
+    name="prepare-codemod",
+    cwd=_CODEMOD_DIR,
+    cmd=["npm install --save-dev", "node_modules/.bin/tsc"],
+)
+
+add_navigation = create_add_navigation_task(
+    upstreams=[
+        copy_resource,
+        prepare_codemod,
+    ]
+)
+
+
+@python_task(
+    name="crud",
+    group=project_add_fastapp_group,
+    description="Add Fastapp CRUD",
+    inputs=[
+        project_dir_input,
+        app_name_input,
+        module_name_input,
+        entity_name_input,
+        plural_entity_name_input,
+        main_column_name_input,
+    ],
+    upstreams=[register_crud, add_navigation],
+    runner=runner,
+)
+async def add_fastapp_crud(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    task.print_out(colored("Fastapp crud added", color="yellow"))

zrb/builtin/project/add/fastapp/field/__init__.py

@@ -0,0 +1,3 @@
+from zrb.builtin.project.add.fastapp.field.field import add_fastapp_field
+
+assert add_fastapp_field

zrb/builtin/project/add/fastapp/field/_input.py

@@ -0,0 +1,17 @@
+from zrb.task_input.str_input import StrInput
+
+column_name_input = StrInput(
+    name="column-name",
+    shortcut="c",
+    description="Column name",
+    prompt="Column name",
+    default="title",
+)
+
+column_type_input = StrInput(
+    name="column-type",
+    shortcut="t",
+    description="Column type",
+    prompt="Column type",
+    default="str",
+)

zrb/builtin/project/add/fastapp/field/field.py

@@ -0,0 +1,190 @@
+import asyncio
+import os
+
+from zrb.builtin.project._helper import validate_existing_project_dir
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add.fastapp._group import project_add_fastapp_group
+from zrb.builtin.project.add.fastapp.app._input import app_name_input
+from zrb.builtin.project.add.fastapp.crud._input import entity_name_input
+from zrb.builtin.project.add.fastapp.field._helper import (
+    add_column_to_delete_page,
+    add_column_to_detail_page,
+    add_column_to_insert_page,
+    add_column_to_list_page,
+    add_column_to_repo,
+    add_column_to_schema,
+    add_column_to_test,
+    add_column_to_update_page,
+)
+from zrb.builtin.project.add.fastapp.field._input import (
+    column_name_input,
+    column_type_input,
+)
+from zrb.builtin.project.add.fastapp.module._input import module_name_input
+from zrb.helper import util
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.decorator import python_task
+from zrb.task.task import Task
+
+
+@python_task(
+    name="validate",
+    inputs=[project_dir_input, app_name_input, module_name_input, entity_name_input],
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get("project_dir")
+    validate_existing_project_dir(project_dir)
+    app_name = kwargs.get("app_name")
+    module_name = kwargs.get("module_name")
+    entity_name = kwargs.get("entity_name")
+    snake_module_name = util.to_snake_case(module_name)
+    snake_entity_name = util.to_snake_case(entity_name)
+    automation_dir = os.path.join(
+        project_dir, "_automate", util.to_snake_case(app_name)
+    )
+    if not os.path.exists(automation_dir):
+        raise Exception(f"Automation directory does not exist: {automation_dir}")
+    app_dir = os.path.join(project_dir, "src", f"{util.to_kebab_case(app_name)}")
+    if not os.path.exists(app_dir):
+        raise Exception(f"App directory does not exist: {app_dir}")
+    module_path = os.path.join(app_dir, "src", "module", snake_module_name)
+    if not os.path.exists(module_path):
+        raise Exception(f"Module directory does not exist: {module_path}")
+    entity_path = os.path.join(module_path, "entity", snake_entity_name)
+    if not os.path.exists(entity_path):
+        raise Exception(f"Entity directory does not exist: {entity_path}")
+
+
+@python_task(
+    name="field",
+    group=project_add_fastapp_group,
+    description="Add Fastapp Field",
+    inputs=[
+        project_dir_input,
+        app_name_input,
+        module_name_input,
+        entity_name_input,
+        column_name_input,
+        column_type_input,
+    ],
+    upstreams=[validate],
+    runner=runner,
+)
+async def add_fastapp_field(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    project_dir = kwargs.get("project_dir", ".")
+    app_name = kwargs.get("app_name")
+    module_name = kwargs.get("module_name")
+    entity_name = kwargs.get("entity_name")
+    column_name = kwargs.get("column_name")
+    column_type = kwargs.get("column_name")
+    kebab_app_name = util.to_kebab_case(app_name)
+    kebab_module_name = util.to_kebab_case(module_name)
+    snake_module_name = util.to_snake_case(module_name)
+    kebab_entity_name = util.to_kebab_case(entity_name)
+    snake_entity_name = util.to_snake_case(entity_name)
+    pascal_entity_name = util.to_pascal_case(entity_name)
+    snake_column_name = util.to_snake_case(column_name)
+    kebab_column_name = util.to_kebab_case(column_name)
+    capitalized_human_readable_column_name = util.to_capitalized_human_readable(  # noqa
+        column_name
+    )
+    await asyncio.gather(
+        asyncio.create_task(
+            add_column_to_test(
+                task,
+                project_dir,
+                kebab_app_name,
+                snake_module_name,
+                snake_entity_name,
+                snake_column_name,
+                column_type,
+            )
+        ),
+        asyncio.create_task(
+            add_column_to_schema(
+                task,
+                project_dir,
+                kebab_app_name,
+                snake_module_name,
+                snake_entity_name,
+                pascal_entity_name,
+                snake_column_name,
+                column_type,
+            )
+        ),
+        asyncio.create_task(
+            add_column_to_repo(
+                task,
+                project_dir,
+                kebab_app_name,
+                snake_module_name,
+                snake_entity_name,
+                pascal_entity_name,
+                snake_column_name,
+                column_type,
+            )
+        ),
+        asyncio.create_task(
+            add_column_to_list_page(
+                task,
+                project_dir,
+                kebab_app_name,
+                kebab_module_name,
+                kebab_entity_name,
+                snake_column_name,
+                capitalized_human_readable_column_name,
+            )
+        ),
+        asyncio.create_task(
+            add_column_to_detail_page(
+                task,
+                project_dir,
+                kebab_app_name,
+                kebab_module_name,
+                kebab_entity_name,
+                kebab_column_name,
+                snake_column_name,
+                capitalized_human_readable_column_name,
+            )
+        ),
+        asyncio.create_task(
+            add_column_to_delete_page(
+                task,
+                project_dir,
+                kebab_app_name,
+                kebab_module_name,
+                kebab_entity_name,
+                kebab_column_name,
+                snake_column_name,
+                capitalized_human_readable_column_name,
+            )
+        ),
+        asyncio.create_task(
+            add_column_to_update_page(
+                task,
+                project_dir,
+                kebab_app_name,
+                kebab_module_name,
+                kebab_entity_name,
+                kebab_column_name,
+                snake_column_name,
+                capitalized_human_readable_column_name,
+            )
+        ),
+        asyncio.create_task(
+            add_column_to_insert_page(
+                task,
+                project_dir,
+                kebab_app_name,
+                kebab_module_name,
+                kebab_entity_name,
+                kebab_column_name,
+                snake_column_name,
+                capitalized_human_readable_column_name,
+            )
+        ),
+    )
+    task.print_out(colored("Fastapp crud added", color="yellow"))

zrb/builtin/project/add/fastapp/module/__init__.py

@@ -0,0 +1,3 @@
+from zrb.builtin.project.add.fastapp.module.module import add_fastapp_module
+
+assert add_fastapp_module

zrb/builtin/project/add/fastapp/module/_input.py

@@ -0,0 +1,9 @@
+from zrb.task_input.str_input import StrInput
+
+module_name_input = StrInput(
+    name="module-name",
+    shortcut="m",
+    description="module name",
+    prompt="module name",
+    default="library",
+)

zrb/builtin/project/add/fastapp/module/module.py

@@ -0,0 +1,144 @@
+import asyncio
+import os
+
+from zrb.builtin.project._helper import validate_existing_project_dir
+from zrb.builtin.project._input import project_dir_input
+from zrb.builtin.project.add.fastapp._group import project_add_fastapp_group
+from zrb.builtin.project.add.fastapp.app._input import app_name_input
+from zrb.builtin.project.add.fastapp.module._helper import (
+    append_all_disabled_env,
+    append_all_enabled_env,
+    append_deployment_template_env,
+    append_src_template_env,
+    create_app_config,
+    create_microservice_config,
+    register_migration,
+    register_module,
+)
+from zrb.builtin.project.add.fastapp.module._input import module_name_input
+from zrb.helper import util
+from zrb.helper.accessories.color import colored
+from zrb.helper.typing import Any
+from zrb.runner import runner
+from zrb.task.decorator import python_task
+from zrb.task.resource_maker import ResourceMaker
+from zrb.task.task import Task
+
+_CURRENT_DIR = os.path.dirname(__file__)
+
+
+@python_task(
+    name="validate",
+    inputs=[project_dir_input, app_name_input, module_name_input],
+    retry=0,
+)
+async def validate(*args: Any, **kwargs: Any):
+    project_dir = kwargs.get("project_dir")
+    validate_existing_project_dir(project_dir)
+    app_name = kwargs.get("app_name")
+    module_name = kwargs.get("module_name")
+    snake_module_name = util.to_snake_case(module_name)
+    automation_dir = os.path.join(
+        project_dir, "_automate", util.to_snake_case(app_name)
+    )
+    if not os.path.exists(automation_dir):
+        raise Exception(f"Automation directory does not exist: {automation_dir}")
+    app_dir = os.path.join(project_dir, "src", f"{util.to_kebab_case(app_name)}")
+    if not os.path.exists(app_dir):
+        raise Exception(f"App directory does not exist: {app_dir}")
+    module_path = os.path.join(app_dir, "src", "module", snake_module_name)
+    if os.path.exists(module_path):
+        raise Exception(f"Module directory already exists: {module_path}")
+
+
+copy_resource = ResourceMaker(
+    name="copy-resource",
+    inputs=[
+        project_dir_input,
+        app_name_input,
+        module_name_input,
+    ],
+    upstreams=[validate],
+    replacements={
+        "zrbAppName": "{{input.app_name}}",
+        "zrbModuleName": "{{input.module_name}}",
+    },
+    template_path=os.path.join(_CURRENT_DIR, "template"),
+    destination_path="{{ input.project_dir }}",
+    excludes=[
+        "*/__pycache__",
+    ],
+)
+
+
+@python_task(
+    name="module",
+    group=project_add_fastapp_group,
+    description="Add Fastapp module",
+    inputs=[
+        project_dir_input,
+        app_name_input,
+        module_name_input,
+    ],
+    upstreams=[copy_resource],
+    runner=runner,
+)
+async def add_fastapp_module(*args: Any, **kwargs: Any):
+    task: Task = kwargs.get("_task")
+    project_dir = kwargs.get("project_dir", ".")
+    app_name = kwargs.get("app_name")
+    module_name = kwargs.get("module_name")
+    kebab_app_name = util.to_kebab_case(app_name)
+    snake_app_name = util.to_snake_case(app_name)
+    kebab_module_name = util.to_kebab_case(module_name)
+    snake_module_name = util.to_snake_case(module_name)
+    upper_snake_module_name = snake_module_name.upper()
+    await asyncio.gather(
+        asyncio.create_task(
+            create_microservice_config(
+                task,
+                project_dir,
+                kebab_app_name,
+                snake_app_name,
+                kebab_module_name,
+                snake_module_name,
+                upper_snake_module_name,
+            )
+        ),
+        asyncio.create_task(
+            register_module(task, project_dir, kebab_app_name, snake_module_name)
+        ),
+        asyncio.create_task(
+            register_migration(task, project_dir, kebab_app_name, snake_module_name)
+        ),
+        asyncio.create_task(
+            create_app_config(
+                task,
+                project_dir,
+                kebab_app_name,
+                snake_module_name,
+                upper_snake_module_name,
+            )
+        ),
+        asyncio.create_task(
+            append_all_enabled_env(
+                task, project_dir, kebab_app_name, upper_snake_module_name
+            )
+        ),
+        asyncio.create_task(
+            append_all_disabled_env(
+                task, project_dir, kebab_app_name, upper_snake_module_name
+            )
+        ),
+        asyncio.create_task(
+            append_src_template_env(
+                task, project_dir, kebab_app_name, upper_snake_module_name
+            )
+        ),
+        asyncio.create_task(
+            append_deployment_template_env(
+                task, project_dir, kebab_app_name, upper_snake_module_name
+            )
+        ),
+    )
+    task.print_out(colored("Fastapp crud added", color="yellow"))

zrb/builtin/project/add/plugin/__init__.py

@@ -0,0 +1,3 @@
+from zrb.builtin.project.add.plugin.plugin import add_plugin
+
+assert add_plugin

zrb/builtin/project/add/plugin/_input.py

@@ -0,0 +1,74 @@
+import os
+
+from zrb.helper.accessories.name import get_random_name
+from zrb.task_input.str_input import StrInput
+
+SYSTEM_USER = os.getenv("USER", "incognito")
+
+package_name_input = StrInput(
+    name="package-name",
+    shortcut="p",
+    description="Package name",
+    prompt="Package name",
+    default=get_random_name(),
+)
+
+package_description_input = StrInput(
+    name="package-description",
+    description="Package description",
+    prompt="Package description",
+    default="Just another package",
+)
+
+package_homepage_input = StrInput(
+    name="package-homepage",
+    description="Package homepage",
+    prompt="Package homepage",
+    default="".join(
+        [
+            "https://github.com/",
+            SYSTEM_USER,
+            "/{{util.to_kebab_case(input.package_name)}}",
+        ]
+    ),
+)
+
+package_repository_input = StrInput(
+    name="package-repository",
+    description="Package repository",
+    prompt="Package repository",
+    default="".join(
+        [
+            "https://github.com/",
+            SYSTEM_USER,
+            "/{{util.to_kebab_case(input.package_name)}}",
+        ]
+    ),
+)
+
+package_documentation_input = StrInput(
+    name="package-documentation",
+    description="Package documentation",
+    prompt="Package documentation",
+    default="".join(
+        [
+            "https://github.com/",
+            SYSTEM_USER,
+            "/{{util.to_kebab_case(input.package_name)}}",
+        ]
+    ),
+)
+
+package_author_name_input = StrInput(
+    name="package-author-name",
+    prompt="Package author name",
+    description="Package author name",
+    default=SYSTEM_USER,
+)
+
+package_author_email_input = StrInput(
+    name="package-author-email",
+    prompt="Package author email",
+    description="Package author email",
+    default=f"{SYSTEM_USER}@gmail.com",
+)