zrb 0.23.0__py3-none-any.whl → 0.24.0__py3-none-any.whl

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

@@ -0,0 +1,102 @@
+import os
+
+from zrb.helper.string.parse_replacement import parse_replacement
+from zrb.helper.util import to_kebab_case, to_snake_case
+
+
+def replace_marker(text: str, marker: str, code: str) -> str:
+    return parse_replacement(text, {marker: "\n".join([code, marker])})
+
+
+def get_app_frontend_routes_dir(project_dir: str, app_name: str) -> str:
+    return os.path.join(
+        get_app_dir(project_dir, app_name), "src", "frontend", "src", "routes"
+    )
+
+
+def get_app_dir(project_dir: str, app_name: str) -> str:
+    kebab_app_name = to_kebab_case(app_name)
+    return os.path.join(project_dir, "src", kebab_app_name)
+
+
+def get_sqlalchemy_column_type(column_type: str) -> str:
+    default_value = "String"
+    type_map = {
+        "string": default_value,
+        "text": "Text",
+        "boolean": "Boolean",
+        "integer": "Integer",
+        "float": "Float",
+        "double": "Double",
+        "date": "Date",
+        "datetime": "DateTime",
+        "time": "Time",
+    }
+    column_type = column_type.lower()
+    return type_map.get(column_type.lower(), default_value)
+
+
+def get_python_column_type(column_type: str) -> str:
+    default_value = "str"
+    type_map = {
+        "string": default_value,
+        "text": "str",
+        "boolean": "bool",
+        "integer": "int",
+        "float": "float",
+        "double": "double",
+        "date": "date",
+        "datetime": "datetime",
+        "time": "time",
+    }
+    return type_map.get(column_type.lower(), default_value)
+
+
+def get_python_value_for_testing(column_type: str) -> str:
+    default_value = '"A string"'
+    type_map = {
+        "string": default_value,
+        "text": '"A text"',
+        "boolean": "True",
+        "integer": "42",
+        "float": "3.14",
+        "double": "3.14",
+        "date": "date(2024, 8, 10)",
+        "datetime": "datetime(2024, 8, 10, 14, 30)",
+        "time": "time(14, 30)",
+    }
+    return type_map.get(column_type.lower(), default_value)
+
+
+def get_default_js_value(column_type: str) -> str:
+    default_value = '""'
+    type_map = {
+        "string": default_value,
+        "text": '""',
+        "boolean": "true",
+        "integer": "0",
+        "float": "0.0",
+        "double": "0.0",
+        "date": "new Date()",
+        "datetime": "new Date()",
+        "time": "new Date().toLocaleTimeString('en-US', { hour12: false })",
+    }
+    return type_map.get(column_type.lower(), default_value)
+
+
+def get_html_input(column_type: str, column_name: str, column_caption: str) -> str:
+    snake_column_name = to_snake_case(column_name)
+    kebab_column_name = to_kebab_case(column_name)
+    default_value = f'<input type="text" class="input w-full" id="{kebab_column_name}" placeholder="{column_caption}" bind:value="{{row.{snake_column_name}}}" />'  # noqa
+    type_map = {
+        "string": default_value,
+        "text": f'<textarea class="textarea w-full" id="{kebab_column_name}" placeholder="{column_caption}" bind:value="{{row.{snake_column_name}}}"></textarea>',  # noqa
+        "boolean": f'<input type="checkbox" class="checkbox" id="{kebab_column_name}" bind:checked="{{row.{snake_column_name}}}" />',  # noqa
+        "integer": f'<input type="number" class="input w-full" id="{kebab_column_name}" placeholder="{column_caption}" bind:value="{{row.{snake_column_name}}}" />',  # noqa
+        "float": f'<input type="number" step="0.01" class="input w-full" id="{kebab_column_name}" placeholder="{column_caption}" bind:value="{{row.{snake_column_name}}}" />',  # noqa
+        "double": f'<input type="number" step="0.01" class="input w-full" id="{kebab_column_name}" placeholder="{column_caption}" bind:value="{{row.{snake_column_name}}}" />',  # noqa
+        "date": f'<input type="date" class="input w-full" id="{kebab_column_name}" placeholder="{column_caption}" bind:value="{{row.{snake_column_name}}}" />',  # noqa
+        "datetime": f'<input type="datetime-local" class="input w-full" id="{kebab_column_name}" placeholder="{column_caption}" bind:value="{{row.{snake_column_name}}}" />',  # noqa
+        "time": f'<input type="time" class="input w-full" id="{kebab_column_name}" placeholder="{column_caption}" bind:value="{{row.{snake_column_name}}}" />',  # noqa
+    }
+    return type_map.get(column_type.lower(), default_value)

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

@@ -0,0 +1,49 @@
+import os
+
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_capitalized_human_readable, to_kebab_case, to_snake_case
+from zrb.task.task import Task
+
+from ._common import get_app_frontend_routes_dir, replace_marker
+
+
+@typechecked
+async def inject_delete_page(
+    task: Task,
+    project_dir: str,
+    app_name: str,
+    module_name: str,
+    entity_name: str,
+    column_name: str,
+):
+    kebab_module_name = to_kebab_case(module_name)
+    kebab_entity_name = to_kebab_case(entity_name)
+    snake_column_name = to_snake_case(column_name)
+    kebab_column_name = to_kebab_case(column_name)
+    column_caption = to_capitalized_human_readable(column_name)
+    file_path = os.path.join(
+        get_app_frontend_routes_dir(project_dir, app_name),
+        kebab_module_name,
+        kebab_entity_name,
+        "delete",
+        "[id]",
+        "+page.svelte",
+    )
+    task.print_out(f"Read HTML from: {file_path}")
+    html_content = await read_text_file_async(file_path)
+    task.print_out("Add field to delete page")
+    html_content = replace_marker(
+        html_content,
+        marker="<!-- DON'T DELETE: insert new field here-->",
+        code="\n".join(
+            [
+                '<div class="mb-4">',
+                f'    <label class="block text-gray-700 font-bold mb-2" for="{kebab_column_name}">{column_caption}</label>',  # noqa
+                f'    <span id="{kebab_column_name}">{{row.{snake_column_name}}}</span>',
+                "</div>",
+            ]
+        ),
+    )
+    task.print_out(f"Write modified HTML to: {file_path}")
+    await write_text_file_async(file_path, html_content)

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

@@ -0,0 +1,49 @@
+import os
+
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_capitalized_human_readable, to_kebab_case, to_snake_case
+from zrb.task.task import Task
+
+from ._common import get_app_frontend_routes_dir, replace_marker
+
+
+@typechecked
+async def inject_detail_page(
+    task: Task,
+    project_dir: str,
+    app_name: str,
+    module_name: str,
+    entity_name: str,
+    column_name: str,
+):
+    kebab_module_name = to_kebab_case(module_name)
+    kebab_entity_name = to_kebab_case(entity_name)
+    snake_column_name = to_snake_case(column_name)
+    kebab_column_name = to_kebab_case(column_name)
+    column_caption = to_capitalized_human_readable(column_name)
+    file_path = os.path.join(
+        get_app_frontend_routes_dir(project_dir, app_name),
+        kebab_module_name,
+        kebab_entity_name,
+        "detail",
+        "[id]",
+        "+page.svelte",
+    )
+    task.print_out(f"Read HTML from: {file_path}")
+    html_content = await read_text_file_async(file_path)
+    task.print_out("Add field to detail page")
+    html_content = replace_marker(
+        html_content,
+        marker="<!-- DON'T DELETE: insert new field here-->",
+        code="\n".join(
+            [
+                '<div class="mb-4">',
+                f'    <label class="block text-gray-700 font-bold mb-2" for="{kebab_column_name}">{column_caption}</label>',  # noqa
+                f'    <span id="{kebab_column_name}">{{row.{snake_column_name}}}</span>',
+                "</div>",
+            ]
+        ),
+    )
+    task.print_out(f"Write modified HTML to: {file_path}")
+    await write_text_file_async(file_path, html_content)

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

@@ -0,0 +1,62 @@
+import os
+
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_capitalized_human_readable, to_kebab_case, to_snake_case
+from zrb.task.task import Task
+
+from ._common import (
+    get_app_frontend_routes_dir,
+    get_default_js_value,
+    get_html_input,
+    replace_marker,
+)
+
+
+@typechecked
+async def inject_insert_page(
+    task: Task,
+    project_dir: str,
+    app_name: str,
+    module_name: str,
+    entity_name: str,
+    column_name: str,
+    column_type: str,
+):
+    kebab_module_name = to_kebab_case(module_name)
+    kebab_entity_name = to_kebab_case(entity_name)
+    snake_column_name = to_snake_case(column_name)
+    kebab_column_name = to_kebab_case(column_name)
+    column_caption = to_capitalized_human_readable(column_name)
+    file_path = os.path.join(
+        get_app_frontend_routes_dir(project_dir, app_name),
+        kebab_module_name,
+        kebab_entity_name,
+        "new",
+        "+page.svelte",
+    )
+    task.print_out(f"Read HTML from: {file_path}")
+    html_content = await read_text_file_async(file_path)
+    task.print_out("Add default value to insert page")
+    default_value = get_default_js_value(column_type)
+    html_content = replace_marker(
+        html_content,
+        marker="// DON'T DELETE: set field default value here",
+        code=f"row.{snake_column_name} = {default_value}",
+    )
+    task.print_out("Add field to insert page")
+    html_input = get_html_input(column_type, column_name, column_caption)
+    html_content = replace_marker(
+        html_content,
+        marker="<!-- DON'T DELETE: insert new field here-->",
+        code="\n".join(
+            [
+                '<div class="mb-4">',
+                f'    <label class="block text-gray-700 font-bold mb-2" for="{kebab_column_name}">{column_caption}</label>',  # noqa
+                f"    {html_input}",
+                "</div>",
+            ]
+        ),
+    )
+    task.print_out(f"Write modified HTML to: {file_path}")
+    await write_text_file_async(file_path, html_content)

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

@@ -0,0 +1,47 @@
+import os
+
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_capitalized_human_readable, to_kebab_case, to_snake_case
+from zrb.task.task import Task
+
+from ._common import get_app_frontend_routes_dir, replace_marker
+
+
+@typechecked
+async def inject_list_page(
+    task: Task,
+    project_dir: str,
+    app_name: str,
+    module_name: str,
+    entity_name: str,
+    column_name: str,
+):
+    kebab_module_name = to_kebab_case(module_name)
+    kebab_entity_name = to_kebab_case(entity_name)
+    snake_column_name = to_snake_case(column_name)
+    column_caption = to_capitalized_human_readable(column_name)
+    file_path = os.path.join(
+        get_app_frontend_routes_dir(project_dir, app_name),
+        kebab_module_name,
+        kebab_entity_name,
+        "+page.svelte",
+    )
+    task.print_out(f"Read HTML from: {file_path}")
+    html_content = await read_text_file_async(file_path)
+    # process header
+    task.print_out("Add column header to table")
+    html_content = replace_marker(
+        html_content,
+        marker="<!-- DON'T DELETE: insert new column header here-->",
+        code=f"<th>{column_caption}</th>",
+    )
+    # process column
+    task.print_out("Add column to table")
+    html_content = replace_marker(
+        html_content,
+        marker="<!-- DON'T DELETE: insert new column here-->",
+        code=f"<td>{{row.{snake_column_name}}}</td>",
+    )
+    task.print_out(f"Write modified HTML to: {file_path}")
+    await write_text_file_async(file_path, html_content)

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

@@ -0,0 +1,47 @@
+import os
+
+from zrb.helper.codemod.add_property_to_class import add_property_to_class
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_pascal_case, to_snake_case
+from zrb.task.task import Task
+
+from ._common import get_app_dir, get_sqlalchemy_column_type
+
+
+@typechecked
+async def inject_repo(
+    task: Task,
+    project_dir: str,
+    app_name: str,
+    module_name: str,
+    entity_name: str,
+    column_name: str,
+    column_type: str,
+):
+    snake_module_name = to_snake_case(module_name)
+    snake_entity_name = to_snake_case(entity_name)
+    pascal_entity_name = to_pascal_case(entity_name)
+    snake_column_name = to_snake_case(column_name)
+    repo_file_path = os.path.join(
+        get_app_dir(project_dir, app_name),
+        "src",
+        "module",
+        snake_module_name,
+        "entity",
+        snake_entity_name,
+        "repo.py",
+    )
+    task.print_out(f"Read code from: {repo_file_path}")
+    code = await read_text_file_async(repo_file_path)
+    task.print_out(f'Add column "{snake_column_name}" to the repo')
+    sqlalchemy_column_type = get_sqlalchemy_column_type(column_type)
+    code = add_property_to_class(
+        code=code,
+        class_name=f"DBEntity{pascal_entity_name}",
+        property_name=snake_column_name,
+        property_type="Column",
+        property_value=f"Column({sqlalchemy_column_type})",
+    )
+    task.print_out(f"Write modified code to: {repo_file_path}")
+    await write_text_file_async(repo_file_path, code)

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

@@ -0,0 +1,45 @@
+import os
+
+from zrb.helper.codemod.add_property_to_class import add_property_to_class
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_pascal_case, to_snake_case
+from zrb.task.task import Task
+
+from ._common import get_app_dir, get_python_column_type
+
+
+@typechecked
+async def inject_schema(
+    task: Task,
+    project_dir: str,
+    app_name: str,
+    module_name: str,
+    entity_name: str,
+    column_name: str,
+    column_type: str,
+):
+    snake_module_name = to_snake_case(module_name)
+    snake_entity_name = to_snake_case(entity_name)
+    pascal_entity_name = to_pascal_case(entity_name)
+    snake_column_name = to_snake_case(column_name)
+    schema_file_path = os.path.join(
+        get_app_dir(project_dir, app_name),
+        "src",
+        "module",
+        snake_module_name,
+        "schema",
+        f"{snake_entity_name}.py",
+    )
+    task.print_out(f"Read code from: {schema_file_path}")
+    code = await read_text_file_async(schema_file_path)
+    task.print_out(f'Add column "{snake_column_name}" to the schema')
+    python_column_type = get_python_column_type(column_type)
+    code = add_property_to_class(
+        code=code,
+        class_name=f"{pascal_entity_name}Data",
+        property_name=snake_column_name,
+        property_type=f"Optional[{python_column_type}]",
+    )
+    task.print_out(f"Write modified code to: {schema_file_path}")
+    await write_text_file_async(schema_file_path, code)

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

@@ -0,0 +1,49 @@
+import os
+
+from zrb.helper.codemod.add_key_value_to_dict import add_key_value_to_dict
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_snake_case
+from zrb.task.task import Task
+
+from ._common import get_app_dir, get_python_value_for_testing
+
+
+@typechecked
+async def inject_test(
+    task: Task,
+    project_dir: str,
+    app_name: str,
+    module_name: str,
+    entity_name: str,
+    column_name: str,
+    column_type: str,
+):
+    snake_module_name = to_snake_case(module_name)
+    snake_entity_name = to_snake_case(entity_name)
+    snake_column_name = to_snake_case(column_name)
+    test_file_path = os.path.join(
+        get_app_dir(project_dir, app_name),
+        "test",
+        snake_module_name,
+        f"test_{snake_entity_name}.py",
+    )
+    task.print_out(f"Read code from: {test_file_path}")
+    code = await read_text_file_async(test_file_path)
+    task.print_out(f'Add column "{snake_column_name}" to the test')
+    dict_names = [
+        "inserted_success_data",
+        "to_be_updated_success_data",
+        "updated_success_data",
+        "to_be_deleted_success_data",
+    ]
+    default_python_value = get_python_value_for_testing(column_type)
+    for dict_name in dict_names:
+        code = add_key_value_to_dict(
+            code=code,
+            dict_name=dict_name,
+            key=f"'{snake_column_name}'",
+            value=default_python_value,
+        )
+    task.print_out(f"Write modified code to: {test_file_path}")
+    await write_text_file_async(test_file_path, code)

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

@@ -0,0 +1,50 @@
+import os
+
+from zrb.helper.file.text import read_text_file_async, write_text_file_async
+from zrb.helper.typecheck import typechecked
+from zrb.helper.util import to_capitalized_human_readable, to_kebab_case
+from zrb.task.task import Task
+
+from ._common import get_app_frontend_routes_dir, get_html_input, replace_marker
+
+
+@typechecked
+async def inject_update_page(
+    task: Task,
+    project_dir: str,
+    app_name: str,
+    module_name: str,
+    entity_name: str,
+    column_name: str,
+    column_type: str,
+):
+    kebab_module_name = to_kebab_case(module_name)
+    kebab_entity_name = to_kebab_case(entity_name)
+    kebab_column_name = to_kebab_case(column_name)
+    column_caption = to_capitalized_human_readable(column_name)
+    list_page_file_path = os.path.join(
+        get_app_frontend_routes_dir(project_dir, app_name),
+        kebab_module_name,
+        kebab_entity_name,
+        "update",
+        "[id]",
+        "+page.svelte",
+    )
+    task.print_out(f"Read HTML from: {list_page_file_path}")
+    html_content = await read_text_file_async(list_page_file_path)
+    task.print_out("Add field to update page")
+    html_input = get_html_input(column_type, column_name, column_caption)
+    html_content = replace_marker(
+        html_content,
+        marker="<!-- DON'T DELETE: insert new field here-->",
+        code="\n".join(
+            [
+                '<div class="mb-4">',
+                f'    <label class="block text-gray-700 font-bold mb-2" for="{kebab_column_name}">{column_caption}</label>',  # noqa
+                f"    {html_input}",
+                "</div>",
+            ]
+        ),
+    )
+    task.print_out(f"Write modified HTML to: {list_page_file_path}")
+    await write_text_file_async(list_page_file_path, html_content)

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

@@ -1,3 +1,4 @@
+from zrb.task_input.choice_input import ChoiceInput
 from zrb.task_input.str_input import StrInput
 
 column_name_input = StrInput(
@@ -8,10 +9,21 @@ column_name_input = StrInput(
     default="title",
 )
 
-column_type_input = StrInput(
+column_type_input = ChoiceInput(
     name="column-type",
     shortcut="t",
     description="Column type",
     prompt="Column type",
-    default="str",
+    choices=[
+        "string",
+        "text",
+        "boolean",
+        "integer",
+        "float",
+        "double",
+        "date",
+        "datetime",
+        "time",
+    ],
+    default="string",
 )