django-spire 0.23.4__py3-none-any.whl

django_spire/core/management/commands/spire_startapp_pkg/template/app/views/form_views.py.template

@@ -0,0 +1,134 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib.auth.decorators import permission_required
+from django.shortcuts import get_object_or_404, redirect
+from django.template.response import TemplateResponse
+from django.urls import reverse
+
+from django_spire.contrib.form.utils import show_form_errors
+from django_spire.contrib.generic_views import modal_views, portal_views
+from django_spire.core.redirect.safe_redirect import safe_redirect_url
+from django_spire.core.shortcuts import get_object_or_null_obj
+from django_spire.history.activity.utils import add_form_activity
+
+import django_glue as dg
+
+from ${module_path} import forms, models
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.http import HttpResponseRedirect
+
+
+@permission_required('${permission_prefix}.delete_${model_instance_name}')
+def ${delete_modal_form_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    ${context_single_var} = get_object_or_404(models.${model_class_name}, pk=pk)
+
+    form_action = reverse(
+        '${url_reverse_path}:form:delete_modal',
+        kwargs={'pk': pk}
+    )
+
+    def add_activity() -> None:
+        ${context_single_var}.add_activity(
+            user=request.user,
+            verb='deleted',
+            device=request.device,
+            information=f'{request.user.get_full_name()} deleted a ${model_instance_name}.'
+        )
+
+    fallback = reverse('${url_reverse_path}:page:list')
+    return_url = safe_redirect_url(request, fallback=fallback)
+
+    return modal_views.dispatch_modal_delete_form_content(
+        request,
+        obj=${context_single_var},
+        form_action=form_action,
+        activity_func=add_activity,
+        return_url=return_url,
+    )
+
+
+@permission_required('${permission_prefix}.delete_${model_instance_name}')
+def ${delete_form_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    ${context_single_var} = get_object_or_404(models.${model_class_name}, pk=pk)
+
+    return_url = request.GET.get(
+        'return_url',
+        reverse('${url_reverse_path}:page:list')
+    )
+
+    return portal_views.delete_form_view(
+        request,
+        obj=${context_single_var},
+        return_url=return_url
+    )
+
+
+@permission_required('${permission_prefix}.add_${model_instance_name}')
+def ${create_modal_form_view_name}(request: WSGIRequest) -> TemplateResponse:
+    return _modal_form_view(request)
+
+
+@permission_required('${permission_prefix}.change_${model_instance_name}')
+def ${update_modal_form_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    return _modal_form_view(request, pk)
+
+
+def _modal_form_view(request: WSGIRequest, pk: int = 0) -> TemplateResponse:
+    ${context_single_var} = get_object_or_404(models.${model_class_name}, pk=pk)
+
+    dg.glue_model_object(request, '${glue_model_key}', ${context_single_var})
+
+    context_data = {
+        '${context_single_var}': ${context_single_var}
+    }
+
+    return TemplateResponse(
+        request,
+        context=context_data,
+        template='${template_directory_path}/modal/content/${form_template_name}.html'
+    )
+
+
+@permission_required('${permission_prefix}.add_${model_instance_name}')
+def ${create_form_view_name}(request: WSGIRequest) -> TemplateResponse:
+    return _form_view(request)
+
+
+@permission_required('${permission_prefix}.change_${model_instance_name}')
+def ${update_form_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    return _form_view(request, pk)
+
+
+def _form_view(request: WSGIRequest, pk: int = 0) -> TemplateResponse|HttpResponseRedirect:
+    ${context_single_var} = get_object_or_null_obj(models.${model_class_name}, pk=pk)
+
+    dg.glue_model_object(request, '${glue_model_key}', ${context_single_var}, 'view')
+
+    if request.method == 'POST':
+        form = forms.${form_class_name}(request.POST, instance=${context_single_var})
+
+        if form.is_valid():
+            ${context_single_var} = form.save()
+            add_form_activity(${context_single_var}, pk, request.user)
+
+            return redirect(
+                request.GET.get(
+                    'return_url',
+                    reverse('${url_reverse_path}:page:list')
+                )
+            )
+
+        show_form_errors(request, form)
+    else:
+        form = forms.${form_class_name}(instance=${context_single_var})
+
+    return portal_views.form_view(
+        request,
+        form=form,
+        obj=${context_single_var},
+        template='${template_directory_path}/page/${form_page_template_name}.html'
+    )

django_spire/core/management/commands/spire_startapp_pkg/template/app/views/page_views.py.template

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib.auth.decorators import permission_required
+from django.shortcuts import get_object_or_404
+
+from django_spire.contrib.generic_views import portal_views
+
+from ${module_path} import models
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+    from django.template.response import TemplateResponse
+
+
+@permission_required('${permission_prefix}.view_${model_instance_name}')
+def ${detail_page_view_name}(request: WSGIRequest, pk: int) -> TemplateResponse:
+    ${context_single_var} = get_object_or_404(models.${model_class_name}, pk=pk)
+
+    context_data = {
+        '${context_single_var}': ${context_single_var},
+    }
+
+    return portal_views.detail_view(
+        request,
+        obj=${context_single_var},
+        context_data=context_data,
+        template='${template_directory_path}/page/${detail_page_template_name}.html'
+    )
+
+
+@permission_required('${permission_prefix}.view_${model_instance_name}')
+def ${list_page_view_name}(request: WSGIRequest) -> TemplateResponse:
+    context_data = {
+        '${context_plural_var}': models.${model_class_name}.objects.all()
+    }
+
+    return portal_views.list_view(
+        request,
+        model=models.${model_class_name},
+        context_data=context_data,
+        template='${template_directory_path}/page/${list_page_template_name}.html'
+    )

django_spire/core/management/commands/spire_startapp_pkg/template/templates/card/${detail_card_template_name}.html.template

@@ -0,0 +1,24 @@
+{% extends 'django_spire/card/title_card.html' %}
+
+{% block card_title %}
+    ${model_verbose_name}
+{% endblock %}
+
+{% block card_button %}
+    {% if perms.${permission_prefix}.change_${model_instance_name} %}
+        {% url '${url_reverse_path}:form:update' pk=${context_single_var}.pk as ${context_single_var}_edit_url %}
+        {% include 'django_spire/button/primary_dark_button.html' with button_text='Edit' button_icon='bi bi-pencil' button_href=${context_single_var}_edit_url %}
+    {% endif %}
+{% endblock %}
+
+{% block card_title_content %}
+    <div class="row g-3">
+        <div class="col-12">
+            {% include 'django_spire/element/attribute_element.html' with attribute_title='Name' attribute_value=${context_single_var}.name %}
+        </div>
+
+        <div class="col-12">
+            {% include 'django_spire/element/attribute_element.html' with attribute_title='Description' attribute_value=${context_single_var}.description|linebreaksbr %}
+        </div>
+    </div>
+{% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/card/${form_card_template_name}.html.template

@@ -0,0 +1,9 @@
+{% extends 'django_spire/card/title_card.html' %}
+
+{% block card_title %}
+    ${model_verbose_name}
+{% endblock %}
+
+{% block card_title_content %}
+    {% include '${template_directory_path}/form/${form_template_name}' %}
+{% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/card/${list_card_template_name}.html.template

@@ -0,0 +1,18 @@
+{% extends 'django_spire/card/title_card.html' %}
+
+{% block card_title %}
+    ${model_verbose_name_plural}
+{% endblock %}
+
+{% block card_button %}
+    {% url '${url_reverse_path}:form:create' as new_${context_single_var}_url %}
+    {% include 'django_spire/button/primary_dark_button.html' with button_text='Add' button_icon='bi bi-plus' button_href=new_${context_single_var}_url %}
+{% endblock %}
+
+{% block card_title_content %}
+    {% for ${context_single_var} in ${context_plural_var} %}
+        {% include '${template_directory_path}/item/${item_template_name}' %}
+    {% empty %}
+        {% include 'django_spire/item/no_data_item.html' %}
+    {% endfor %}
+{% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/form/${form_template_name}.html.template

@@ -0,0 +1,22 @@
+<div
+    x-data="{
+        async init() {
+            await this.${glue_model_key}.get()
+        },
+        ${glue_model_key}: new ModelObjectGlue('${glue_model_key}')
+    }"
+>
+    {% include 'django_spire/element/divider_element.html' with divider_title='Details' %}
+
+    <div class="row g-3 mb-3">
+        <div class="col-12">
+            {% include 'django_glue/form/field/char_field.html' with glue_model_field='${glue_model_key}.name' %}
+        </div>
+
+        <div class="col-12">
+            {% include 'django_glue/form/field/text_field.html' with glue_model_field='${glue_model_key}.description' %}
+        </div>
+    </div>
+</div>
+
+{% include 'django_spire/contrib/form/button/form_submit_button.html' %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/item/${item_template_name}.html.template

@@ -0,0 +1,24 @@
+{% extends 'django_spire/item/item.html' %}
+
+{% block item_title %}
+    {% url '${url_reverse_path}:page:detail' pk=${context_single_var}.pk as ${context_single_var}_view_url %}
+    {% include 'django_spire/element/attribute_element.html' with attribute_title='${model_verbose_name}' attribute_value=${context_single_var}.name attribute_href=${context_single_var}_view_url %}
+{% endblock %}
+
+{% block item_row_content %}
+    {% include 'django_spire/element/attribute_element.html' with attribute_title='Description' attribute_value=${context_single_var}.description %}
+{% endblock %}
+
+{% block item_button %}
+    {% url '${url_reverse_path}:page:detail' pk=${context_single_var}.pk as ${context_single_var}_view_url %}
+
+    {% if perms.${permission_prefix}.change_${model_instance_name} %}
+        {% url '${url_reverse_path}:form:update' pk=${context_single_var}.pk as ${context_single_var}_edit_url %}
+    {% endif %}
+
+    {% if perms.${permission_prefix}.delete_${model_instance_name} %}
+        {% url '${url_reverse_path}:form:delete' pk=${context_single_var}.pk as ${context_single_var}_delete_url %}
+    {% endif %}
+
+    {% include 'django_spire/dropdown/ellipsis_dropdown.html' with view_url=${context_single_var}_view_url edit_url=${context_single_var}_edit_url delete_url=${context_single_var}_delete_url %}
+{% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/page/${detail_page_template_name}.html.template

@@ -0,0 +1,13 @@
+{% extends 'django_spire/page/full_page.html' %}
+
+{% block page_content %}
+    <div class="row g-3">
+        <div class="col-12">
+            {% include '${template_directory_path}/card/${detail_card_template_name}' %}
+        </div>
+
+        <div class="col-4">
+            {% include 'history/card/activity_list_card.html' with activity_log=${context_single_var}.activity_log.prefetch_user %}
+        </div>
+    </div>
+{% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/page/${form_page_template_name}.html.template

@@ -0,0 +1,13 @@
+{% extends 'django_spire/page/form_full_page.html' %}
+
+{% block page_content %}
+    <form method="post">
+        {% csrf_token %}
+
+        <div class="row g-3">
+            <div class="col-12">
+                {% include '${template_directory_path}/card/${form_card_template_name}' %}
+            </div>
+        </div>
+    </form>
+{% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/template/templates/page/${list_page_template_name}.html.template

@@ -0,0 +1,9 @@
+{% extends 'django_spire/page/full_page.html' %}
+
+{% block page_content %}
+    <div class="row">
+        <div class="col-12">
+            {% include '${template_directory_path}/card/${list_card_template_name}' %}
+        </div>
+    </div>
+{% endblock %}

django_spire/core/management/commands/spire_startapp_pkg/user_input.py

@@ -0,0 +1,255 @@
+from __future__ import annotations
+
+import re
+
+from typing import TYPE_CHECKING
+
+from django.core.management.base import CommandError
+
+if TYPE_CHECKING:
+    from django_spire.core.management.commands.spire_startapp_pkg.reporter import Reporter
+    from django_spire.core.management.commands.spire_startapp_pkg.validator import AppValidator
+
+
+class UserInputCollector:
+    """
+    Collects user input for Django app creation through an interactive wizard.
+
+    This class guides users through a step-by-step process to gather all
+    necessary configuration for creating a new Django app.
+    """
+
+    def __init__(self, reporter: Reporter, validator: AppValidator):
+        """
+        Initializes the collector with a reporter and validator.
+
+        :param reporter: Reporter instance for displaying prompts and messages.
+        :param validator: Validator for checking user input validity.
+        """
+
+        self.reporter = reporter
+        self.validator = validator
+
+    def collect_all_inputs(self) -> dict[str, str]:
+        """
+        Collects all required user inputs for app creation.
+
+        Guides the user through an 8-step wizard to gather app path, names,
+        labels, and configuration options.
+
+        :return: Dictionary containing all collected user inputs.
+        """
+
+        self.reporter.write('\n[App Creation Wizard]\n\n', self.reporter.style_success)
+
+        app_path = self._collect_app_path()
+        components = app_path.split('.')
+
+        app_name = self._collect_app_name(components)
+        app_label = self._collect_app_label(components, app_name)
+        model_name = self._collect_model_name(app_name)
+        model_name_plural = self._collect_model_name_plural(model_name)
+        db_table_name = self._collect_db_table_name(components, app_name)  # Changed from app_label to components, app_name
+        model_permission_path = self._collect_model_permission_path(app_path, model_name)
+
+        permission_data = self._collect_permission_inheritance(components)
+
+        verbose_name, verbose_name_plural = self._derive_verbose_names(model_name, model_name_plural)
+
+        return {
+            'app_path': app_path,
+            'app_name': app_name,
+            'model_name': model_name,
+            'model_name_plural': model_name_plural,
+            'app_label': app_label,
+            'db_table_name': db_table_name,
+            'model_permission_path': model_permission_path,
+            'verbose_name': verbose_name,
+            'verbose_name_plural': verbose_name_plural,
+            **permission_data,
+        }
+
+    def _collect_app_label(self, components: list[str], app_name: str) -> str:
+        """
+        Prompts the user for the Django app label.
+
+        :param components: List of app path components.
+        :param app_name: Name of the app.
+        :return: User-provided or default app label.
+        """
+
+        immediate_parent = components[-2] if len(components) > 2 else None
+        default = immediate_parent.lower() + '_' + app_name.lower() if immediate_parent else app_name.lower()
+        return self._collect_input('Enter the app label', default, '3/8')
+
+    def _collect_app_name(self, components: list[str]) -> str:
+        """
+        Prompts the user for the app name.
+
+        :param components: List of app path components.
+        :return: User-provided or default app name.
+        """
+
+        default = components[-1]
+        return self._collect_input('Enter the app name', default, '2/8')
+
+    def _collect_app_path(self) -> str:
+        """
+        Prompts the user for the app path and validates it.
+
+        :return: Validated app path in dot notation.
+        :raises CommandError: If the app path is empty or invalid.
+        """
+
+        app_path = self._collect_simple_input('Enter the app path (e.g., "app.human_resource.employee.skill")', '1/8')
+
+        if not app_path:
+            self.reporter.write('\n', self.reporter.style_notice)
+
+            message = 'The app path is required'
+            raise CommandError(message)
+
+        components = app_path.split('.')
+        self.validator.validate_app_path(components)
+
+        return app_path
+
+    def _collect_db_table_name(self, components: list[str], app_name: str) -> str:
+        """
+        Prompts the user for the database table name.
+
+        :param components: List of app path components.
+        :param app_name: Name of the app.
+        :return: User-provided or default database table name.
+        """
+
+        parent_parts = components[1:-1] if len(components) > 1 else []
+        default = '_'.join(parent_parts).lower() + '_' + app_name.lower() if parent_parts else app_name.lower()
+        return self._collect_input('Enter the database table name', default, '6/8')
+
+    def _collect_input(self, prompt: str, default: str, step_number: str) -> str:
+        """
+        Prompts the user for input with a default value.
+
+        :param prompt: Prompt message to display.
+        :param default: Default value if user presses Enter.
+        :param step_number: Step number in the wizard (e.g., '1/8').
+        :return: User-provided input or default value.
+        """
+
+        self.reporter.write(f'\n[{step_number}]: {prompt} (default: "{default}")', self.reporter.style_notice)
+        user_input = input('Press Enter to use default or type a custom value: ').strip()
+        return user_input if user_input else default
+
+    def _collect_model_name(self, app_name: str) -> str:
+        """
+        Prompts the user for the model class name.
+
+        :param app_name: App name to derive default from.
+        :return: User-provided or default model name in TitleCase.
+        """
+
+        default = ''.join(word.title() for word in app_name.split('_'))
+        return self._collect_input('Enter the model name', default, '4/8')
+
+    def _collect_model_name_plural(self, model_name: str) -> str:
+        """
+        Prompts the user for the plural form of the model name.
+
+        :param model_name: Singular model name.
+        :return: User-provided or default plural model name.
+        """
+
+        default = model_name + 's'
+        return self._collect_input('Enter the model name plural', default, '5/8')
+
+    def _collect_model_permission_path(self, app_path: str, model_name: str) -> str:
+        """
+        Prompts the user for the model permission path.
+
+        :param app_path: Dot-separated app path.
+        :param model_name: Model class name.
+        :return: User-provided or default model permission path.
+        """
+
+        default = f'{app_path}.models.{model_name}'
+        return self._collect_input('Enter the model permission path', default, '7/8')
+
+    def _collect_permission_inheritance(self, components: list[str]) -> dict[str, str]:
+        """
+        Collects permission inheritance configuration if applicable.
+
+        Prompts the user about inheriting permissions from parent apps
+        and collects necessary parent model information.
+
+        :param components: List of app path components.
+        :return: Dictionary containing permission inheritance settings.
+        """
+
+        if len(components) <= 1:
+            return {'inherit_permissions': False, 'parent_permission_prefix': '', 'parent_model_instance_name': ''}
+
+        if not self._should_inherit_permissions():
+            return {'inherit_permissions': False, 'parent_permission_prefix': '', 'parent_model_instance_name': ''}
+
+        parent_parts = components[1:-1]
+        parent_name = components[-2]
+        parent_model_class = ''.join(word.title() for word in parent_name.split('_'))
+
+        self.reporter.write('\n[Permission Inheritance Configuration]\n', self.reporter.style_notice)
+
+        return {
+            'inherit_permissions': True,
+            'parent_permission_prefix': self._collect_input(
+                'Enter the parent permission prefix',
+                '_'.join(parent_parts).lower(),
+                '1/3'
+            ),
+            'parent_model_instance_name': self._collect_input(
+                'Enter the parent model instance name',
+                parent_name.lower(),
+                '2/3'
+            ),
+            'parent_model_path': self._collect_input(
+                'Enter the parent model path',
+                '.'.join(components[:-1]) + f'.models.{parent_model_class}',
+                '3/3'
+            ),
+        }
+
+    def _collect_simple_input(self, prompt: str, step_number: str) -> str:
+        """
+        Prompts the user for simple input without a default value.
+
+        :param prompt: Prompt message to display.
+        :param step_number: Step number in the wizard.
+        :return: User-provided input.
+        """
+
+        return input(f'[{step_number}]: {prompt}: ').strip()
+
+    def _derive_verbose_names(self, model_name: str, model_name_plural: str) -> tuple[str, str]:
+        """
+        Derives human-readable verbose names from model names.
+
+        Converts CamelCase model names to space-separated words.
+
+        :param model_name: Singular model name in CamelCase.
+        :param model_name_plural: Plural model name in CamelCase.
+        :return: Tuple of (verbose_name, verbose_name_plural).
+        """
+
+        verbose_name = re.sub(r'(?<!^)(?=[A-Z])', ' ', model_name)
+        verbose_name_plural = re.sub(r'(?<!^)(?=[A-Z])', ' ', model_name_plural)
+        return verbose_name, verbose_name_plural
+
+    def _should_inherit_permissions(self) -> bool:
+        """
+        Prompts the user to confirm permission inheritance.
+
+        :return: True if user wants to inherit permissions, False otherwise.
+        """
+
+        self.reporter.write('\n[8/8]: Do you want this app to inherit permissions from its parent? (y/n)', self.reporter.style_notice)
+        user_input = input('Default is "n": ').strip().lower()
+        return user_input == 'y'

django_spire/core/management/commands/spire_startapp_pkg/validator.py

@@ -0,0 +1,96 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.core.management.base import CommandError
+
+if TYPE_CHECKING:
+    from django_spire.core.management.commands.spire_startapp_pkg.filesystem import FileSystem
+    from django_spire.core.management.commands.spire_startapp_pkg.registry import AppRegistry
+    from django_spire.core.management.commands.spire_startapp_pkg.reporter import Reporter
+    from django_spire.core.management.commands.spire_startapp_pkg.resolver import PathResolver
+
+
+class AppValidator:
+    """
+    Validates Django app paths and configurations.
+
+    This class performs validation checks to ensure app paths are properly
+    formatted, don't conflict with existing apps, and use valid root apps.
+    """
+
+    def __init__(
+        self,
+        reporter: Reporter,
+        registry: AppRegistry,
+        path_resolver: PathResolver,
+        filesystem: FileSystem
+    ):
+        """
+        Initializes the validator with required dependencies.
+
+        :param reporter: Reporter for displaying error messages.
+        :param registry: Registry for checking installed apps.
+        :param path_resolver: Path resolver for determining file locations.
+        :param filesystem: File system for checking file existence.
+        """
+
+        self._filesystem = filesystem
+        self._path_resolver = path_resolver
+        self._registry = registry
+        self._reporter = reporter
+
+    def validate_app_format(self, app_path: str) -> None:
+        """
+        Validates that an app path uses dot notation.
+
+        :param app_path: App path to validate.
+        :raises CommandError: If the app path doesn't contain dots.
+        """
+
+        if '.' not in app_path:
+            self._reporter.write('\n', self._reporter.style_notice)
+
+            message = 'Invalid app name format. The app path must use dot notation (e.g., "parent.child").'
+            raise CommandError(message)
+
+    def validate_app_path(self, components: list[str]) -> None:
+        """
+        Validates that an app path doesn't already exist.
+
+        :param components: List of app path components.
+        :raises CommandError: If an app already exists at the destination path.
+        """
+
+        destination = self._path_resolver.get_app_destination(components)
+
+        if self._filesystem.has_content(destination):
+            self._reporter.write('\n', self._reporter.style_notice)
+
+            message = (
+                f'The app already exists at {destination}. '
+                'Please remove the existing app or choose a different name.'
+            )
+
+            raise CommandError(message)
+
+    def validate_root_app(self, components: list[str]) -> None:
+        """
+        Validates that the root app component is registered in Django.
+
+        :param components: List of app path components.
+        :raises CommandError: If the root app is not a valid registered app.
+        """
+
+        valid_roots = self._registry.get_valid_root_apps()
+        root = components[0]
+
+        if root not in valid_roots:
+            self._reporter.write('\n', self._reporter.style_notice)
+
+            message = (
+                f'Invalid root app "{root}". '
+                f'Valid root apps: {", ".join(sorted(valid_roots))}.'
+            )
+
+            raise CommandError(message)