django-spire 0.17.11__py3-none-any.whl → 0.18.1__py3-none-any.whl

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

@@ -1,31 +0,0 @@
-from __future__ import annotations
-
-from typing import TYPE_CHECKING
-
-from django_spire.knowledge.entry.version.block.blocks.block import BaseBlock
-from django_spire.knowledge.entry.version.block.choices import BlockTypeChoices
-from django_spire.knowledge.entry.version.block.constants import SPACES_PER_INDENT
-
-if TYPE_CHECKING:
-    from django_spire.knowledge.entry.version.block.models import EntryVersionBlock
-
-
-class ListItemBlock(BaseBlock):
-    value: str
-    type: BlockTypeChoices = BlockTypeChoices.LIST_ITEM
-    detail_template: str = 'django_spire/knowledge/entry/version/block/detail/component/list_item_component.html'
-    update_template: str = 'django_spire/knowledge/entry/version/block/update/component/list_item_component.html'
-    indent_level: int = 0
-    bullet: str = '-'
-    ordered: bool = False
-
-    def render_to_text(self) -> str:
-        indent = ' ' * self.indent_level * SPACES_PER_INDENT
-        return f'{indent}{self.bullet} {self.value}\n'
-
-    def to_dict(self, version_block: EntryVersionBlock):
-        return super().to_dict(version_block) | {
-            'indent_level': self.indent_level,
-            'bullet': self.bullet,
-            'ordered': self.ordered,
-        }

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

@@ -1,14 +0,0 @@
-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
-
-
-class SubHeadingBlock(BaseBlock):
-    value: str
-    type: BlockTypeChoices = BlockTypeChoices.SUB_HEADING
-    detail_template: str = 'django_spire/knowledge/entry/version/block/detail/component/sub_heading_component.html'
-    update_template: str = 'django_spire/knowledge/entry/version/block/update/component/sub_heading_component.html'
-
-    def render_to_text(self) -> str:
-        return f'{self.value}\n'

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

@@ -1,14 +0,0 @@
-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
-
-
-class TextBlock(BaseBlock):
-    value: str
-    type: BlockTypeChoices = BlockTypeChoices.TEXT
-    detail_template: str = 'django_spire/knowledge/entry/version/block/detail/component/text_component.html'
-    update_template: str = 'django_spire/knowledge/entry/version/block/update/component/text_component.html'
-
-    def render_to_text(self) -> str:
-        return f'{self.value}\n'

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

@@ -1,16 +0,0 @@
-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
-from django_spire.knowledge.entry.version.block.blocks.sub_heading_block import \
-    SubHeadingBlock
-from django_spire.knowledge.entry.version.block.blocks.text_block import TextBlock
-
-
-ENTRY_BLOCK_MAP = {
-    BlockTypeChoices.TEXT: TextBlock,
-    BlockTypeChoices.HEADING: HeadingBlock,
-    BlockTypeChoices.SUB_HEADING: SubHeadingBlock,
-    BlockTypeChoices.LIST_ITEM: ListItemBlock,
-}

django_spire/knowledge/entry/version/block/services/processor_service.py

@@ -1,33 +0,0 @@
-from __future__ import annotations
-
-from copy import deepcopy
-
-from django_spire.contrib.service import BaseDjangoModelService
-
-from typing import TYPE_CHECKING, Any
-
-from django_spire.knowledge.entry.version.block.choices import BlockTypeChoices
-
-if TYPE_CHECKING:
-    from django_spire.knowledge.entry.version.block.models import EntryVersionBlock
-
-
-class EntryVersionBlockProcessorService(BaseDjangoModelService['EntryVersionBlock']):
-    obj: EntryVersionBlock
-
-    def set_deleted(self):
-        self.obj.ordering_services.processor.remove_from_objects(
-            destination_objects=self.obj.version.blocks.active()
-        )
-
-        self.obj.set_deleted()
-
-    def update_block(self, value: Any, block_type: BlockTypeChoices):
-        block = deepcopy(self.obj.block)
-        block.value = value
-        block.type = block_type
-
-        self.obj.block = block
-        self.obj.save()
-
-        return self.obj

django_spire/knowledge/entry/version/block/services/transformation_service.py

@@ -1,35 +0,0 @@
-from __future__ import annotations
-
-import json
-
-from django.db.models import QuerySet
-from django.template.loader import render_to_string
-
-from django_spire.contrib.service import BaseDjangoModelService
-
-from typing import TYPE_CHECKING, Iterable
-
-if TYPE_CHECKING:
-    from django_spire.knowledge.entry.version.block.models import EntryVersionBlock
-
-
-class EntryVersionBlockTransformationService(BaseDjangoModelService['EntryVersionBlock']):
-    obj: EntryVersionBlock
-
-    def to_dict(self) -> dict:
-        return {
-            'id': self.obj.id,
-            'type': self.obj.type,
-            'order': self.obj.order,
-            'block': self.obj.block.to_dict(self.obj)
-        }
-
-    def to_json(self) -> str:
-        return json.dumps(self.obj.services.transformation.to_dict())
-
-    @staticmethod
-    def objects_to_json(objects: Iterable[EntryVersionBlock]) -> str:
-        return json.dumps([
-            block.services.transformation.to_dict()
-            for block in objects
-        ])

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

@@ -1,28 +0,0 @@
-from __future__ import annotations
-
-import json
-
-from django.urls import reverse
-
-from django_spire.core.tests.test_cases import BaseTestCase
-from django_spire.knowledge.entry.version.block.tests.factories import create_test_version_block
-
-
-class EntryVersionBlockJsonUrlsTests(BaseTestCase):
-    def setUp(self):
-        super().setUp()
-
-        self.test_version_block = create_test_version_block()
-
-    def test_update_text_view_url_path(self):
-        response = self.client.post(
-            reverse('django_spire:knowledge:entry:version:block:json:update_text'),
-            data=json.dumps({
-                'pk': self.test_version_block.pk,
-                'value': '',
-                'block_type': 'text'
-            }),
-            content_type='application/json'
-        )
-
-        self.assertEqual(response.status_code, 200)

django_spire/knowledge/entry/version/block/urls/__init__.py

@@ -1,13 +0,0 @@
-from django.urls import include, path
-
-app_name = 'block'
-
-urlpatterns = [
-    path(
-        'json/',
-        include(
-            'django_spire.knowledge.entry.version.block.urls.json_urls',
-            namespace='json'
-        )
-    ),
-]

django_spire/knowledge/entry/version/block/urls/json_urls.py

@@ -1,9 +0,0 @@
-from django.urls import path
-
-from django_spire.knowledge.entry.version.block.views import json_views
-
-app_name = 'json'
-
-urlpatterns = [
-    path('update_text/', json_views.update_text_view, name='update_text'),
-]

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

@@ -1,30 +0,0 @@
-from __future__ import annotations
-
-import json
-
-from django.core.handlers.wsgi import WSGIRequest
-from django.http import JsonResponse
-
-from django_spire.core.decorators import valid_ajax_request_required
-from django_spire.knowledge.entry.version.block.models import EntryVersionBlock
-
-
-@valid_ajax_request_required
-def update_text_view(request: WSGIRequest) -> JsonResponse:
-    body_data = json.loads(request.body.decode('utf-8'))
-    pk = body_data.get('pk')
-
-    try:
-        version_block = EntryVersionBlock.objects.get(pk=pk)
-    except EntryVersionBlock.DoesNotExist:
-        return JsonResponse({'type': 'error', 'message': 'Block Not Found'})
-
-    value = body_data.get('value')
-    block_type = body_data.get('block_type')
-
-    if value is None or block_type is None:
-        return JsonResponse({'type': 'error', 'message': 'Missing Required Data'})
-
-    version_block.services.processor.update_block(value=value, block_type=block_type)
-
-    return JsonResponse({'type': 'success'})

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

@@ -1,28 +0,0 @@
-from __future__ import annotations
-
-from django.urls import reverse
-
-from django_spire.core.tests.test_cases import BaseTestCase
-from django_spire.knowledge.entry.tests.factories import create_test_entry
-from django_spire.knowledge.entry.version.tests.factories import \
-    create_test_entry_version
-
-
-class EntryVersionFormUrlsTests(BaseTestCase):
-    def setUp(self):
-        super().setUp()
-
-        self.test_entry = create_test_entry()
-        self.test_entry_version = create_test_entry_version(entry=self.test_entry)
-        self.test_entry.current_version = self.test_entry_version
-        self.test_entry.save()
-
-    def test_update_form_view_url_path(self):
-        response = self.client.get(
-            reverse(
-                'django_spire:knowledge:entry:version:form:update',
-                kwargs={'pk': self.test_entry_version.pk}
-            )
-        )
-
-        self.assertEqual(response.status_code, 200)

django_spire/knowledge/entry/version/urls/form_urls.py

@@ -1,10 +0,0 @@
-from django.urls import path
-
-from django_spire.knowledge.entry.version.views import form_views
-
-
-app_name = 'form'
-
-urlpatterns = [
-    path('<int:pk>/update/', form_views.update_form_view, name='update'),
-]

django_spire/knowledge/entry/version/views/form_views.py

@@ -1,63 +0,0 @@
-from __future__ import annotations
-
-import json
-
-from django.core.handlers.wsgi import WSGIRequest
-from django.shortcuts import get_object_or_404
-from django.template.response import TemplateResponse
-from django.urls import reverse
-
-from django_spire.auth.controller.controller import AppAuthController
-from django_spire.contrib import Breadcrumbs
-from django_spire.contrib.generic_views import portal_views
-from django_spire.knowledge.entry.version.block.choices import BlockTypeChoices
-from django_spire.knowledge.entry.version.block.models import EntryVersionBlock
-from django_spire.knowledge.entry.version.models import EntryVersion
-
-
-@AppAuthController('knowledge').permission_required('can_change')
-def update_form_view(request: WSGIRequest, pk: int) -> TemplateResponse:
-    current_version = get_object_or_404(EntryVersion, pk=pk)
-    entry = current_version.entry
-    version_blocks = current_version.blocks.active().order_by('order')
-
-    if version_blocks.count() == 0:
-        version_blocks = [
-            EntryVersionBlock.services.factory.create_blank_block(
-                entry_version=current_version,
-                block_type=BlockTypeChoices.TEXT,
-                order=0
-            )
-        ]
-
-    breadcrumbs = Breadcrumbs()
-    breadcrumbs.add_breadcrumb(name='Knowledge')
-    breadcrumbs.add_breadcrumb(
-        name='Collections',
-        href=reverse('django_spire:knowledge:page:home')
-    )
-    breadcrumbs.add_breadcrumb(
-        name=f'View {entry.name}',
-        href=reverse(
-            'django_spire:knowledge:entry:version:page:detail',
-            kwargs={'pk': entry.current_version_id}
-        )
-    )
-    breadcrumbs.add_breadcrumb(name=f'Edit {entry.name}')
-
-    return portal_views.template_view(
-        request,
-        page_title=f'Edit {entry.name}',
-        page_description=f'Edit {entry.name}',
-        breadcrumbs=breadcrumbs,
-        context_data={
-            'entry': entry,
-            'current_version': current_version,
-            'version_blocks_json': EntryVersionBlock.services.transformation.objects_to_json(
-                objects=version_blocks
-            ),
-            'version_blocks': version_blocks,
-            'block_types': BlockTypeChoices,
-        },
-        template='django_spire/knowledge/entry/version/page/form_page.html',
-    )

django_spire/knowledge/templates/django_spire/knowledge/entry/version/block/detail/component/heading_component.html

@@ -1,3 +0,0 @@
-{% load spire_knowledge_tags %}
-
-<div class="fs-2 fw-bold">{{ value|format_to_html|safe }}</div>

django_spire/knowledge/templates/django_spire/knowledge/entry/version/block/detail/component/list_item_component.html

@@ -1,38 +0,0 @@
-{% load spire_knowledge_tags %}
-
-{% if version_block.block.ordered %}
-<div
-{% else %}
-<ol
-{% endif %}
-    class="d-flex mb-1"
-    style="
-        padding-left: calc(20 * {{ version_block.block.indent_level }}px);
-        {% if not version_block.block.ordered %}
-            {% if version_block.block.indent_level|divisibleby:2 %}
-                list-style-type: disc;
-                list-style-position: inside;
-            {% else %}
-                list-style-type: circle;
-                list-style-position: inside;
-            {% endif %}
-        {% endif %}
-    "
->
-    {% if version_block.block.ordered %}
-        <span class="col-auto" style="width: 20px">
-            {{ version_block.block.bullet }}
-        </span>
-        <span class="col">
-            {{ version_block.block.value|format_to_html|safe }}
-        </span>
-    {% else %}
-        <li class="col">
-            {{ version_block.block.value|format_to_html|safe }}
-        </li>
-    {% endif %}
-{% if version_block.block.ordered %}
-</div>
-{% else %}
-</ol>
-{% endif %}

django_spire/knowledge/templates/django_spire/knowledge/entry/version/block/detail/component/sub_heading_component.html

@@ -1,3 +0,0 @@
-{% load spire_knowledge_tags %}
-
-<div class="fs-4 fw-bold">{{ value|format_to_html|safe }}</div>

django_spire/knowledge/templates/django_spire/knowledge/entry/version/block/detail/component/text_component.html

@@ -1,3 +0,0 @@
-{% load spire_knowledge_tags %}
-
-<div class="fs-6 py-1">{{ value|format_to_html|safe }}</div>

django_spire/knowledge/templates/django_spire/knowledge/entry/version/block/dropdown/add_dropdown.html

@@ -1,25 +0,0 @@
-{% extends 'django_spire/dropdown/dropdown.html' %}
-
-{% block dropdown_trigger %}
-    <span
-        class="bi bi-plus-lg fs-5 p-0 cursor-pointer opacity-50"
-        x-bind="trigger"
-        :type="manager.block_order_focus === version_block.order ? 'button' : 'not-allowed'"
-    >
-    </span>
-{% endblock %}
-
-{% block dropdown_content %}
-    {% for block_type in block_types %}
-        <div
-            class="bg-app-layer-one bg-app-layer-three-hover dropdown-item"
-            x-data="{
-                create_block() {
-                    create_blank_block({block_type: '{{ block_type.value }}', order: version_block.order + 1})
-                }
-            }"
-        >
-            {% include 'django_spire/dropdown/element/dropdown_link_element.html' with link_text=block_type.label x_click="create_block()" %}
-        </div>
-    {% endfor %}
-{% endblock %}

django_spire/knowledge/templates/django_spire/knowledge/entry/version/block/update/component/heading_component.html

@@ -1,3 +0,0 @@
-{% extends 'django_spire/knowledge/entry/version/block/update/component/text_component.html' %}
-
-{% block textarea_class %}fs-2{% endblock %}

django_spire/knowledge/templates/django_spire/knowledge/entry/version/block/update/component/list_item_component.html

@@ -1,13 +0,0 @@
-{% extends 'django_spire/knowledge/entry/version/block/update/component/text_component.html' %}
-
-{% block before_text_content %}
-    <span
-        x-text="version_block.block.bullet"
-        :style="`padding-left: ${20 * version_block.block.indent_level}px;`"
-    >
-    </span>
-{% endblock %}
-
-{% block shift_enter_event %}
-    @keydown.shift.enter.prevent="create_list_item_block({previous_block: version_block})"
-{% endblock %}

django_spire/knowledge/templates/django_spire/knowledge/entry/version/block/update/component/sub_heading_component.html

@@ -1,3 +0,0 @@
-{% extends 'django_spire/knowledge/entry/version/block/update/component/text_component.html' %}
-
-{% block textarea_class %}fs-4{% endblock %}

django_spire/knowledge/templates/django_spire/knowledge/entry/version/block/update/component/text_component.html

@@ -1,50 +0,0 @@
-<div
-    class="d-flex align-items-center"
-    x-data="{
-        is_focused: false,
-        init() {
-            $nextTick(() => {
-                $refs.textarea.style.height = 'auto'
-                $refs.textarea.style.height = $refs.textarea.scrollHeight + 'px'
-            })
-        },
-        update_cursor_position({order, cursor_position}) {
-            if (order === version_block.order) {
-                $refs.textarea.focus()
-                $refs.textarea.setSelectionRange(cursor_position, cursor_position)
-            }
-        }
-    }"
-    @update_cursor_position.window="
-        update_cursor_position({order: $event.detail.order, cursor_position: $event.detail.cursor_position})
-    "
->
-    <style>
-        textarea:focus {
-            outline: none;
-            border: none;
-        }
-    </style>
-    {% block before_text_content %}
-    {% endblock %}
-    <textarea
-        rows="1"
-        class="w-100 border-0 bg-transparent px-1 auto-resize overflow-y-hidden text-app-default-text-color {% block textarea_class %}fs-6{% endblock %}"
-        style="height: 30px; resize: none;"
-        x-ref="textarea"
-        x-model="version_block.block.value"
-        @input="update_height($event)"
-        :placeholder="is_focused ? 'Write Something...' : ''"
-        @focus="is_focused = true"
-        @blur="is_focused = false"
-        @beforeinput.debounce.300ms="update_value({version_block: version_block})"
-        @keydown.backspace="delete_block_if_empty({version_block: version_block})"
-        {% block shift_enter_event %}
-        @keydown.shift.enter.prevent="create_blank_block({block_type: 'text', order: version_block.order + 1})"
-        {% endblock %}
-        @keydown.up.prevent="$dispatch('update_cursor_position', {order: version_block.order - 1, cursor_position: $event.target.selectionStart})"
-        @keydown.down.prevent="$dispatch('update_cursor_position', {order: version_block.order + 1, cursor_position: $event.target.selectionStart})"
-        {% block textarea_attributes %}
-        {% endblock %}
-    ></textarea>
-</div>

django_spire/knowledge/templates/django_spire/knowledge/entry/version/container/form_container.html

@@ -1,129 +0,0 @@
-{% extends 'django_spire/container/container.html' %}
-
-{% block container_title %}
-    <div class="ps-3">
-        {{ entry.name }}
-    </div>
-{% endblock %}
-
-{% block container_content %}
-    <div
-        x-data="{
-            first_load: true,
-            init() {
-                this.manager = new EntryVersionManager({
-                    id: {{ current_version.pk }},
-                    version_blocks_json: {{ version_blocks_json }}
-                })
-            },
-            async create_blank_block({block_type, order, ...optional_fields}) {
-                let response = await django_glue_fetch(
-                    '{% url "django_spire:knowledge:entry:version:json:create_blank_block" pk=current_version.pk %}',
-                    {payload: {block_type: block_type, order: order, ...optional_fields}},
-                )
-                if (response.type === 'error') {
-                    $dispatch('notify', {type:'error', message: response.message})
-                } else {
-                    let block_data = JSON.parse(response.entry_version_block_json)
-                    const new_version_block = await this.manager.insert_blank_block(
-                        {
-                            id: block_data.id,
-                            block_type: block_data.type,
-                            order: block_data.order,
-                            block: block_data.block
-                        }
-                    )
-                    $dispatch('update_cursor_position', {order: new_version_block.order, cursor_position: 0})
-                }
-            },
-            async create_list_item_block({previous_block}) {
-                let bullet = null
-                if (previous_block.block.ordered) {
-                    const number = parseInt(previous_block.block.bullet.split('.')[0]) + 1
-                    bullet = number + '.'
-                } else {
-                    bullet = previous_block.block.bullet
-                }
-                await this.create_blank_block({
-                    block_type: 'list_item',
-                    order: previous_block.order + 1,
-                    bullet: bullet,
-                    indent_level: previous_block.block.indent_level,
-                    ordered: previous_block.block.ordered
-                })
-            },
-            async delete_block_if_empty({version_block}) {
-                if (version_block.block.value !== '') return
-
-                const previous_order = version_block.order - 1
-                if (previous_order === 0) return
-
-                const previous_block_length = this.manager.get_block_length({order: previous_order})
-                $dispatch(
-                    'update_cursor_position',
-                    {order: previous_order, cursor_position: previous_block_length}
-                )
-
-                let response = await django_glue_fetch(
-                    '{% url "django_spire:knowledge:entry:version:json:delete_block" pk=current_version.pk %}',
-                    {payload: {version_block_pk: version_block.id}},
-                )
-                if (response.type === 'error') {
-                    $dispatch('notify', {type: 'error', message: response.message})
-                } else {
-                    this.manager.delete_block({id: version_block.id})
-                }
-            },
-            update_height(event) {
-                event.target.style.height = 'auto'
-                event.target.style.height = event.target.scrollHeight + 'px'
-            },
-            async update_value({version_block}) {
-                let response = await django_glue_fetch(
-                    '{% url "django_spire:knowledge:entry:version:block:json:update_text" %}',
-                    {payload: {
-                        pk: version_block.id,
-                        value: version_block.block.value,
-                        block_type: version_block.block.type
-                    }},
-                )
-
-                if (response.type === 'error') {
-                    $dispatch('notify', {type: 'error', message: 'An error occurred while saving the text block.'})
-                }
-            },
-            async reorder_block({block, order}){
-                let response = null
-                try {
-                    response = await django_glue_fetch(
-                        '{% url "django_spire:knowledge:entry:version:json:reorder" pk=current_version.pk %}',
-                        { payload: {'block_id': block, 'order': order} }
-                    )
-                } catch (e) {
-                    window.location.reload()
-                }
-
-                if (response.type === 'error') {
-                    $dispatch('notify', {'type': response.type, 'message': response.message})
-                }
-            }
-        }"
-        x-sort="await reorder_block({block: $item, order: $position})"
-        x-sort:config="{handle: '[x-sort\\:handle]'}"
-    >
-        <template x-for="(version_block, index) in manager.entry_version.version_blocks" :key="version_block.id">
-            <div class="row align-items-center block" x-sort:item="version_block.id">
-                <div class="col-auto action-items pe-0" x-sort:handle>
-                    <div class="row m-0 p-0 align-items-center">
-                        {% include 'django_spire/element/grabber_element.html' with grabber_class='col-auto opacity-50' %}
-                        <div class="col pe-0">
-                            {% include 'django_spire/knowledge/entry/version/block/dropdown/add_dropdown.html' %}
-                        </div>
-                    </div>
-                </div>
-                <div class="col" x-html="version_block.block.update_template_rendered">
-                </div>
-            </div>
-        </template>
-    </div>
-{% endblock %}