django-spire 0.25.2__py3-none-any.whl → 0.26.0__py3-none-any.whl

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

@@ -2,10 +2,13 @@ from __future__ import annotations
 
 import re
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Tuple
 
 from django.core.management.base import CommandError
 
+from django_spire.core.management.commands.spire_startapp_pkg.exceptions import \
+    AppExistsError
+
 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
@@ -30,6 +33,8 @@ class UserInputCollector:
         self.reporter = reporter
         self.validator = validator
 
+        self.skip_app_creation = False
+
     def collect_all_inputs(self) -> dict[str, str]:
         """
         Collects all required user inputs for app creation.
@@ -52,13 +57,19 @@ class UserInputCollector:
         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)
+        if not self.skip_app_creation:
+            permission_data = self._collect_permission_inheritance(components)
+        else:
+            permission_data = {}
+
+        template_options = self._collect_template_generation_options(components)
 
         verbose_name, verbose_name_plural = self._derive_verbose_names(model_name, model_name_plural)
 
         return {
             'app_path': app_path,
             'app_name': app_name,
+            'skip_app_generation': self.skip_app_creation,
             'model_name': model_name,
             'model_name_plural': model_name_plural,
             'app_label': app_label,
@@ -67,6 +78,7 @@ class UserInputCollector:
             'verbose_name': verbose_name,
             'verbose_name_plural': verbose_name_plural,
             **permission_data,
+            **template_options
         }
 
     def _collect_app_label(self, components: list[str], app_name: str) -> str:
@@ -79,8 +91,12 @@ class UserInputCollector:
         """
 
         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')
+        if self.skip_app_creation:
+            return default
+        else:
+            return self._collect_input('Enter the app label', default, '3/8')
 
     def _collect_app_name(self, components: list[str]) -> str:
         """
@@ -91,7 +107,10 @@ class UserInputCollector:
         """
 
         default = components[-1]
-        return self._collect_input('Enter the app name', default, '2/8')
+        if self.skip_app_creation:
+            return default
+        else:
+            return self._collect_input('Enter the app name', default, '2/8')
 
     def _collect_app_path(self) -> str:
         """
@@ -110,7 +129,12 @@ class UserInputCollector:
             raise CommandError(message)
 
         components = app_path.split('.')
-        self.validator.validate_app_path(components)
+
+        try:
+            self.validator.validate_app_path(components)
+        except AppExistsError as exc:
+            self.reporter.write('\nSkipping app creation.', self.reporter.style_notice)
+            self.skip_app_creation = True
 
         return app_path
 
@@ -125,7 +149,10 @@ class UserInputCollector:
 
         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')
+        if self.skip_app_creation:
+            return default
+        else:
+            return self._collect_input('Enter the database table name', default, '6/8')
 
     def _collect_input(self, prompt: str, default: str, step_number: str) -> str:
         """
@@ -150,7 +177,10 @@ class UserInputCollector:
         """
 
         default = ''.join(word.title() for word in app_name.split('_'))
-        return self._collect_input('Enter the model name', default, '4/8')
+        if self.skip_app_creation:
+            return default
+        else:
+            return self._collect_input('Enter the model name', default, '4/8')
 
     def _collect_model_name_plural(self, model_name: str) -> str:
         """
@@ -161,7 +191,10 @@ class UserInputCollector:
         """
 
         default = model_name + 's'
-        return self._collect_input('Enter the model name plural', default, '5/8')
+        if self.skip_app_creation:
+            return default
+        else:
+            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:
         """
@@ -173,7 +206,11 @@ class UserInputCollector:
         """
 
         default = f'{app_path}.models.{model_name}'
-        return self._collect_input('Enter the model permission path', default, '7/8')
+        if self.skip_app_creation:
+            return default
+        else:
+            return self._collect_input('Enter the model permission path', default,
+                                       '7/8')
 
     def _collect_permission_inheritance(self, components: list[str]) -> dict[str, str]:
         """
@@ -253,3 +290,39 @@ class UserInputCollector:
         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'
+
+    def _collect_template_generation_options(self, components):
+        user_input = {}
+
+        try:
+            self.validator.validate_template_path(components)
+        except AppExistsError:
+            user_input['skip_template_generation'] = True
+            return user_input
+
+        self.reporter.write('\n[Template Creation Wizard]\n\n',
+                            self.reporter.style_success)
+
+        user_input[
+            'skip_template_generation'] = self._collect_skip_template_generation()
+
+        if not user_input['skip_template_generation']:
+            user_input['list_display_type'] = self._collect_input(
+                'How do you want to display items on the list page? (items/table)',
+                'items',
+                '2/2')
+
+        return user_input
+
+    def _collect_skip_template_generation(self):
+        """
+        Prompts the user to generate templates.
+
+        :return: True if user wants to skip template generation, False otherwise.
+        """
+
+        user_input = self._collect_input(
+            'Do you want to generate templates for this app? (y/n)', 'n',
+            '1/2')
+
+        return user_input == 'n'

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

@@ -4,6 +4,9 @@ from typing import TYPE_CHECKING
 
 from django.core.management.base import CommandError
 
+from django_spire.core.management.commands.spire_startapp_pkg.exceptions import \
+    AppExistsError
+
 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
@@ -65,14 +68,24 @@ class AppValidator:
         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}.'
+            self._reporter.write(f'\n{message}', self._reporter.style_notice)
+            raise AppExistsError(message)
 
-            message = (
-                f'The app already exists at {destination}. '
-                'Please remove the existing app or choose a different name.'
-            )
+    def validate_template_path(self, components: list[str]) -> None:
+        """
+        Validates that an app's template path doesn't already exist.
 
-            raise CommandError(message)
+        :param components: List of app path components.
+        :raises CommandError: If an app already exists at the destination path.
+        """
+
+        destination = self._path_resolver.get_template_destination(components)
+
+        if self._filesystem.has_content(destination):
+            message = f'App templates already exists at {destination}.'
+            self._reporter.write(f'\n{message}', self._reporter.style_notice)
+            raise AppExistsError(message)
 
     def validate_root_app(self, components: list[str]) -> None:
         """

django_spire/core/querysets.py

@@ -0,0 +1,19 @@
+from django.db.models import QuerySet, Q
+
+
+class SearchQuerySetMixin:
+    def search(self, search_value: str) -> QuerySet:
+        words = search_value.split(' ')
+
+        filtered_query = self
+
+        char_fields = [
+            field.name for field in self.model._meta.fields
+            if field.get_internal_type() == 'CharField'
+        ]
+
+        for word in words:
+            or_conditions = Q()
+            for field in char_fields:
+                or_conditions |= Q(**{f"{field}__icontains": word})
+            filtered_query = filtered_query.filter(or_conditions)

django_spire/core/templates/django_spire/badge/base_badge.html

@@ -4,9 +4,8 @@
         {{ badge_class|default:'fs--1' }}
     "
 >
-    {% if badge_text %}
-        {{ badge_text }}
-    {% endif %}
+    {% block badge_text %}{% endblock %}
+    {{ badge_text }}
 
     {% if x_badge_text %}
         <span x-text="{{ x_badge_text }}"></span>

django_spire/core/templates/django_spire/base/base.html

@@ -42,6 +42,7 @@
                     path: '{{ DJANGO_SPIRE_THEME_PATH|escapejs }}'
                 };
             </script>
+            <link rel="manifest" href="{% static 'django_spire/favicons/manifest.json' %}">
 
             <script src="https://cdn.jsdelivr.net/npm/flatpickr"></script>
             <script src="https://cdn.jsdelivr.net/npm/echarts@5.4.x/dist/echarts.min.js"></script>

django_spire/core/templates/django_spire/button/base_button.html

@@ -1,8 +1,9 @@
 <a
     class="btn shadow-sm {% block button_class %}{% endblock %} {{ button_class|default:'btn-sm' }}"
     {% block button_attributes %}{% endblock %}
+        {{ button_attributes }}
     {% if button_href %}href="{{ button_href }}{{ button_url_params }}"{% endif %}
-    {% if x_button_click %}@click="{{ x_button_click }}"{% endif %}
+    {% if x_button_click or button_modal_href %}@click="{% if button_modal_href %}dispatch_modal_view('{{ button_modal_href }}'){% else %}{{ x_button_click }}{% endif %}"{% endif %}
 >
     {% if button_icon %}
         <i class="{{ button_icon }}"></i>

django_spire/core/templates/django_spire/card/title_card.html

@@ -7,7 +7,8 @@
 {% block card_body_style %}display: flex; flex-direction: column; min-height: 0;{% endblock %}
 
 {% block card_content %}
-    <div
+    <{% block card_title_content_container_element_type %}div{% endblock %}
+            {% block card_title_content_container_attributes %}{% endblock %}
         class="d-flex flex-column flex-grow-1"
         style="min-height: 0;"
         x-data="{
@@ -17,17 +18,19 @@
             }
         }"
     >
-        <div class="row justify-content-between align-items-center mb-2 pb-2 border-bottom flex-shrink-0" style="min-height: 38px;">
-            <div class="col d-flex align-items-center">
-                <div class="card-title text-uppercase mb-0">
-                    {% block card_title %}
-                    {% endblock %}
+        {% block card_title_header_content %}
+            <div class="row justify-content-between align-items-center mb-2 pb-2 border-bottom flex-shrink-0" style="min-height: 38px;">
+                <div class="col d-flex align-items-center">
+                    <div class="card-title text-uppercase mb-0">
+                        {% block card_title %}
+                        {% endblock %}
+                    </div>
+                </div>
+                <div class="{% block card_button_col_class %}col-auto{% endblock %} d-flex">
+                    {% block card_button %}{% endblock %}
                 </div>
             </div>
-            <div class="col-auto d-flex">
-                {% block card_button %}{% endblock %}
-            </div>
-        </div>
+        {% endblock %}
         <div x-show="card_title_dropdown" x-cloak x-collapse class="flex-shrink-0">
             {% block card_dropdown_content %}
             {% endblock %}

django_spire/core/templates/django_spire/container/container.html

@@ -2,7 +2,7 @@
     <div class="col-12">
         <div class="row justify-content-between align-items-end px-md-3 py-2">
             <div class="col">
-                <h1 class="fs-1 fw-semi-bold">
+                <h1 class="{% block container_title_class %}fs-1 fw-semi-bold{% endblock %}">
                     {% block container_title %}
                     {% endblock %}
                 </h1>

django_spire/core/templates/django_spire/filtering/form/base_session_filter_form.html

@@ -1,7 +1,7 @@
 <form
     method="get"
     action="{% block session_filter_url %}{% endblock %}"
-    class="row border-bottom"
+    class="{% block form_class %}row border-bottom{% endblock %}"
 >
     <div class="col-12">
         <input type="text" hidden value="{% block session_filter_key %}{% endblock %}" name="session_filter_key">

django_spire/core/templates/django_spire/form/field/_base_file_field.html

@@ -0,0 +1,216 @@
+{% extends 'django_spire/form/field/base_field.html' %}
+
+{% block field_content %}
+    <input
+            type="text"
+            x-model="value"
+            x-ref="glue_field"
+            hidden
+    >
+
+    <div
+            class="position-relative"
+            x-data="{
+            show_dropdown: false,
+            files: [],
+            objects: {},
+
+            accept: '{{ accept|default:'' }}',
+            compression: {{ compression|default:'true' }},
+            compression_ratio: {{ compression_ratio|default:'0.75' }},
+            disable_camera: '{{ disable_camera|default:'False' }}' === 'True',
+            disable_file: '{{ disable_file|default:'False' }}' === 'True',
+            maximum_filesize: {{ maximum_filesize|default:'10' }} * 1024 * 1024,
+            units: ['B', 'KB', 'MB', 'GB'],
+
+            init() {
+                if (!this.value) return;
+
+                try {
+                    this.files = Array.isArray(this.value) ? this.value : JSON.parse(this.value);
+                } catch(e) {
+                    this.files = [];
+                }
+
+                this.update_form_files();
+            },
+
+            async compress(file, quality = 0.75, maximum_width = 1920) {
+                try {
+                    let image = await createImageBitmap(file);
+
+                    let scale = Math.min(
+                        1,
+                        maximum_width / Math.max(image.width, image.height)
+                    );
+
+                    let width = image.width * scale;
+                    let height = image.height * scale;
+
+                    let canvas = Object.assign(document.createElement('canvas'), { width: width, height: height });
+                    let ctx = canvas.getContext('2d');
+
+                    ctx.drawImage(image, 0, 0, width, height);
+
+                    let filename = file.name.replace(/\.[^/.]+$/, '') + '.jpg';
+
+                    return new Promise(result => canvas.toBlob(
+                        blob => result(new File([blob], filename, { type: 'image/jpeg' })),
+                        'image/jpeg',
+                        quality
+                    ));
+                } catch (error) {
+                    console.error('Compression failed:', error);
+                    return file;
+                }
+            },
+
+            format_file_size(bytes) {
+                if (!bytes) return '';
+
+                let size = bytes;
+                let index = 0;
+
+                while (size >= 1024 && index < this.units.length - 1) {
+                    size /= 1024;
+                    index++;
+                }
+
+                return `${size.toFixed(1)} ${this.units[index]}`;
+            },
+
+            take_photo() {
+                this.$refs.camera_input.click();
+            },
+
+            truncate_name(name, max = 30) {
+                return name && name.length > max ? name.slice(0, max - 3) + '...' : name;
+            },
+
+            update_form_files() {
+                let transfer = new DataTransfer();
+
+                for (let object in this.objects) {
+                    transfer.items.add(this.objects[object]);
+                }
+
+                this.$refs.upload.files = transfer.files;
+            },
+
+            update_value() {
+                this.value = this.files.length > 0 ? JSON.stringify(this.files) : null;
+            },
+
+            {% block x-data %}{% endblock %}
+        }"
+    >
+        <input
+                type="file"
+                :name="{{ glue_field }}.name"
+                x-ref="upload"
+                class="d-none"
+                :accept="accept"
+                {% block upload_attributes %}{% endblock %}
+        >
+
+        <div class="d-flex">
+            <button
+                    class="form-control text-start d-flex justify-content-between flex-grow-1"
+                    type="button"
+                    @click="show_dropdown = !show_dropdown"
+                    :class="disable_file ? 'd-none' : ''"
+            >
+                <span class="d-flex flex-wrap align-items-center">
+                    {% block selection_display %}{% endblock %}
+                </span>
+
+                <span class="d-flex align-items-center">
+                    {% include 'django_glue/form/field/element/select_down_arrow_element.html' %}
+                </span>
+            </button>
+
+            <button
+                    type="button"
+                    class="btn border ms-2"
+                    @click="take_photo()"
+                    :class="disable_camera ? 'd-none' : ''"
+            >
+                <i class="bi bi-camera"></i>
+            </button>
+        </div>
+
+        <input
+                type="file"
+                x-ref="file_input"
+                class="d-none"
+                @change="handle_files_change"
+                :accept="accept"
+                :class="disable_file ? 'd-none' : ''"
+                {% block file_input_attributes %}{% endblock %}
+        >
+
+        <input
+                type="file"
+                x-ref="camera_input"
+                class="d-none"
+                @change="handle_files_change"
+                accept="image/*"
+                capture="environment"
+                :class="disable_camera ? 'd-none' : ''"
+                {% block camera_input_attributes %}{% endblock %}
+        >
+
+        <div
+                x-cloak
+                x-show="show_dropdown"
+                @click.outside="show_dropdown = false"
+                class="shadow border rounded-2 mt-2 bg-app-glue-layer-one w-100 p-0 list-group"
+                style="max-height: 350px; overflow-y: auto;"
+        >
+            <template x-for="file in files" :key="file.id">
+                <div
+                        class="py-2 d-flex align-items-center list-group-item px-2 bg-app-glue-layer-one-hover"
+                >
+                    <div class="me-2" style="width: 40px; height: 40px;">
+                        <template x-if="file.preview">
+                            <img :src="file.preview" class="img-fluid rounded"
+                                 style="max-width: 40px; max-height: 40px; object-fit: cover;">
+                        </template>
+
+                        <template x-if="!file.preview">
+                            <div class="d-flex align-items-center justify-content-center rounded"
+                                 style="width: 40px; height: 40px;">
+                                <i class="bi bi-file-earmark"></i>
+                            </div>
+                        </template>
+                    </div>
+
+                    <div class="flex-grow-1 ms-2">
+                        <div class="text-truncate" x-text="truncate_name(file.name)"></div>
+                        <div class="glue-fs--2" x-text="format_file_size(file.size)"></div>
+                    </div>
+
+                    <div class="d-flex align-items-center">
+                        <i
+                                class="bi bi-trash text-danger glue-cursor-pointer mx-2"
+                                @click="remove_file(file.id)"
+                        ></i>
+                    </div>
+                </div>
+            </template>
+
+            <div
+                    class="m-2 border border-dashed rounded p-3 text-center bg-app-glue-layer-one glue-cursor-pointer"
+                    @dragover.prevent="$el.classList.add('border-primary')"
+                    @dragleave.prevent="$el.classList.remove('border-primary')"
+                    @drop.prevent="$el.classList.remove('border-primary'); handle_files_change({target: {files: $event.dataTransfer.files}})"
+                    @click="$refs.file_input.click()"
+            >
+                <div>
+                    <i class="bi bi-cloud-arrow-up me-2"></i>
+                    {% block drop_area_text %}{% endblock %}
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock %}

django_spire/core/templates/django_spire/form/field/_multi_checkbox_field.html

@@ -0,0 +1,52 @@
+{% extends 'django_spire/form/field/base_field.html' %}
+
+{% block field_content %}
+    <div
+            class="glue-form-group"
+            x-ref="glue_field"
+            x-data="{
+            selected_values: [],
+            init_value(value) {
+                if (value === null || value === undefined) {
+                    this.selectedValues = [];
+                } else if (Array.isArray(value)) {
+                    this.selectedValues = [...value];
+                } else {
+                    this.selectedValues = [value];
+                }
+            },
+            update_value() {
+                this.value = this.selectedValues.length > 0 ? this.selectedValues : null;
+            },
+            toggle_value(choice) {
+                if (this.selectedValues.includes(choice)) {
+                    this.selectedValues = this.selectedValues.filter(v => v !== choice);
+                } else {
+                    this.selectedValues.push(choice);
+                }
+                this.update_value();
+            }
+        }"
+            x-effect="init_value(value)"
+    >
+        <template x-for="choice in glue_field.choices" :key="choice[0]">
+            <div class="d-flex align-items-center mb-2">
+                <input
+                        type="checkbox"
+                        class="glue-form-check-input me-2"
+                        :id="glue_field.id + '_' + choice[0]"
+                        :name="glue_field.name"
+                        :value="choice[0]"
+                        :checked="selectedValues.includes(choice[0])"
+                        @change="toggle_value(choice[0])"
+                        style="accent-color: var(--glue-primary);"
+                >
+                <label
+                        class="glue-form-check-label glue-text-primary glue-cursor-pointer"
+                        :for="glue_field.id + '_' + choice[0]"
+                        x-text="choice[1]"
+                ></label>
+            </div>
+        </template>
+    </div>
+{% endblock %}