django-spire 0.16.12__py3-none-any.whl → 0.17.0__py3-none-any.whl

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

@@ -0,0 +1,252 @@
+from __future__ import annotations
+
+import re
+
+from typing_extensions 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(app_label)
+        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.
+        """
+
+        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 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, app_label: str) -> str:
+        """
+        Prompts the user for the database table name.
+
+        :param app_label: App label to use as default.
+        :return: User-provided or default database table name.
+        """
+
+        return self._collect_input('Enter the database table name', app_label, '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) <= 2:
+            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 FileSystemInterface
+    from django_spire.core.management.commands.spire_startapp_pkg.registry import AppRegistryInterface
+    from django_spire.core.management.commands.spire_startapp_pkg.reporter import ReporterInterface
+    from django_spire.core.management.commands.spire_startapp_pkg.resolver import PathResolverInterface
+
+
+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: ReporterInterface,
+        registry: AppRegistryInterface,
+        path_resolver: PathResolverInterface,
+        filesystem: FileSystemInterface
+    ):
+        """
+        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 interface 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)

django_spire/core/middleware/__init__.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from django_spire.core.middleware.maintenance import MaintenanceMiddleware
-from django_spire.core.middleware.profiling import ProfilingMiddleware
 
 
-__all__ = ['MaintenanceMiddleware', 'ProfilingMiddleware']
+__all__ = ['MaintenanceMiddleware']

django_spire/knowledge/admin.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 # These imports are for the migrations to work as a single app "django_spire_knowledge"
 
 from django_spire.knowledge.collection.admin import *

django_spire/knowledge/apps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.apps import AppConfig
 
 from django_spire.utils import check_required_apps

django_spire/knowledge/auth/controller.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django_spire.auth.controller.controller import BaseAuthController
 
 

django_spire/knowledge/collection/admin.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 from django.contrib import admin
+
 from .models import Collection, CollectionGroup
 
 

django_spire/knowledge/collection/forms.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django import forms
 
 from django_spire.knowledge.collection.models import Collection

django_spire/knowledge/collection/models.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.db import models
 
 from django_spire.auth.group.models import AuthGroup
@@ -44,10 +46,12 @@ class CollectionGroup(models.Model):
         related_name='groups',
         related_query_name='group',
     )
+
     auth_group = models.ForeignKey(
         AuthGroup,
         on_delete=models.CASCADE,
         related_name='collection_groups',
         related_query_name='collection_group',
     )
+
     services = CollectionGroupService()

django_spire/knowledge/collection/querysets.py

@@ -2,15 +2,14 @@ from __future__ import annotations
 
 from typing import TYPE_CHECKING
 
-from django.core.handlers.wsgi import WSGIRequest
-from django.db.models import Count, Q
+from django.db.models import Count
 
 from django_spire.auth.controller.controller import AppAuthController
 from django_spire.contrib.ordering.querysets import OrderingQuerySetMixin
 from django_spire.history.querysets import HistoryQuerySet
 
 if TYPE_CHECKING:
-    from django_spire.auth.user.models import AuthUser
+    from django.core.handlers.wsgi import WSGIRequest
     from django.db.models import QuerySet
     from django_spire.knowledge.collection.models import Collection
 
@@ -57,6 +56,7 @@ class CollectionQuerySet(HistoryQuerySet, OrderingQuerySetMixin):
         accessible_ids = set(direct_access.values_list('id', flat=True))
 
         current_level_ids = accessible_ids.copy()
+
         while current_level_ids:
             next_level = self.filter(parent_id__in=current_level_ids)
             new_ids = set(next_level.values_list('id', flat=True)) - accessible_ids

django_spire/knowledge/collection/seeding/seed.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django_spire.knowledge.collection.seeding.seeder import CollectionSeeder
 
 parent_collections = CollectionSeeder.seed_database(count=5)

django_spire/knowledge/collection/tests/factories.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django_spire.knowledge.collection.models import Collection
 
 

django_spire/knowledge/collection/tests/test_services/test_transformation_service.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from django.contrib.sites.models import Site

django_spire/knowledge/collection/tests/test_urls/test_form_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase

django_spire/knowledge/collection/tests/test_urls/test_json_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase

django_spire/knowledge/collection/tests/test_urls/test_page_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase

django_spire/knowledge/collection/views/json_views.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from django.core.handlers.wsgi import WSGIRequest

django_spire/knowledge/collection/views/page_views.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.core.handlers.wsgi import WSGIRequest
 from django.shortcuts import get_object_or_404
 from django.template.response import TemplateResponse

django_spire/knowledge/context_processors.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import Any
 
 from django.core.handlers.wsgi import WSGIRequest

django_spire/knowledge/entry/services/tool_service.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import json
+
 from typing import TYPE_CHECKING
 
 from django.contrib.contenttypes.models import ContentType

django_spire/knowledge/entry/services/transformation_services.py

@@ -1,6 +1,5 @@
 from __future__ import annotations
 
-import json
 from typing import TYPE_CHECKING
 
 from django.conf import settings

django_spire/knowledge/entry/tests/factories.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django_spire.knowledge.collection.tests.factories import create_test_collection
 from django_spire.knowledge.entry.models import Entry
 
@@ -9,5 +11,6 @@ def create_test_entry(**kwargs) -> Entry:
         'is_deleted': False,
         'is_active': True
     }
+
     data.update(kwargs)
     return Entry.objects.create(**data)

django_spire/knowledge/entry/tests/test_urls/test_form_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase

django_spire/knowledge/entry/tests/test_urls/test_json_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase

django_spire/knowledge/entry/tests/test_urls/test_page_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.urls import reverse
 
 from django_spire.core.tests.test_cases import BaseTestCase

django_spire/knowledge/entry/urls/form_urls.py

@@ -2,6 +2,7 @@ from django.urls import path
 
 from django_spire.knowledge.entry.views import form_views
 
+
 app_name = 'form'
 
 urlpatterns = [

django_spire/knowledge/entry/urls/json_urls.py

@@ -2,6 +2,7 @@ from django.urls import path
 
 from django_spire.knowledge.entry.views import json_views
 
+
 app_name = 'json'
 
 urlpatterns = [

django_spire/knowledge/entry/urls/page_urls.py

@@ -2,6 +2,7 @@ from django.urls import path
 
 from django_spire.knowledge.entry.views import page_views
 
+
 app_name = 'page'
 
 urlpatterns = [

django_spire/knowledge/entry/urls/template_urls.py

@@ -2,6 +2,7 @@ from django.urls import path
 
 from django_spire.knowledge.entry.views import template_views
 
+
 app_name = 'template'
 
 urlpatterns = [

django_spire/knowledge/entry/version/admin.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.contrib import admin
 
 from django_spire.knowledge.entry.version.models import EntryVersion

django_spire/knowledge/entry/version/block/admin.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.contrib import admin
 
 from django_spire.knowledge.entry.version.block.models import EntryVersionBlock

django_spire/knowledge/entry/version/block/blocks/heading_block.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django_spire.knowledge.entry.version.block.choices import BlockTypeChoices
 from django_spire.knowledge.entry.version.block.blocks.block import BaseBlock
 

django_spire/knowledge/entry/version/block/blocks/sub_heading_block.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django_spire.knowledge.entry.version.block.choices import BlockTypeChoices
 from django_spire.knowledge.entry.version.block.blocks.block import BaseBlock
 

django_spire/knowledge/entry/version/block/blocks/text_block.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django_spire.knowledge.entry.version.block.choices import BlockTypeChoices
 from django_spire.knowledge.entry.version.block.blocks.block import BaseBlock
 

django_spire/knowledge/entry/version/block/maps.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django_spire.knowledge.entry.version.block.blocks.list_block import ListItemBlock
 from django_spire.knowledge.entry.version.block.choices import BlockTypeChoices
 from django_spire.knowledge.entry.version.block.blocks.heading_block import HeadingBlock

django_spire/knowledge/entry/version/block/models.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from django.db import models
 from django.forms import model_to_dict
 from django.template.loader import render_to_string

django_spire/knowledge/entry/version/block/tests/factories.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from django_spire.knowledge.entry.version.block.blocks.text_block import TextBlock

django_spire/knowledge/entry/version/block/tests/test_urls/test_json_urls.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from django.urls import reverse

django_spire/knowledge/entry/version/block/views/json_views.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import json
 
 from django.core.handlers.wsgi import WSGIRequest