django-spire 0.23.4__py3-none-any.whl

django_spire/comment/templates/django_spire/comment/modal/comment_modal.html

@@ -0,0 +1,17 @@
+{% extends 'django_spire/modal/title_modal.html' %}
+
+{% load comment_tags %}
+
+{% block modal_trigger %}
+    {% include 'django_spire/button/secondary_outlined_button.html' with button_logo_only='bi bi-plus' %}
+{% endblock %}
+
+{% block modal_title %}
+    Add Comment
+{% endblock %}
+
+{% block modal_title_content %}
+    {% comment_form related_obj request.get_full_path request.user user_list=comment_user_list as comment_form %}
+    <div class="h6">Comment*</div>
+    {{ comment_form }}
+{% endblock %}

django_spire/comment/templates/django_spire/comment/modal/comment_reply_modal.html

@@ -0,0 +1,23 @@
+{% extends 'django_spire/modal/title_modal.html' %}
+
+{% load comment_tags %}
+
+{% block modal_trigger %}
+    <div class="px-4 p-1">Reply</div>
+{% endblock %}
+
+{% block modal_title %}
+    Reply to Comment
+{% endblock %}
+
+{% block modal_title_content %}
+    <div class="bg-layer-two border rounded p-3 my-2">
+        <div class="fs--1 text-secondary">{{ comment.user.get_full_name }}</div>
+        <div>{{ comment.information }}</div>
+    </div>
+    <div class="mx-4">
+        {% comment_form related_obj request.get_full_path request.user parent=comment user_list=comment_user_list as comment_form %}
+        <div class="h6">Reply*</div>
+        {{ comment_form }}
+    </div>
+{% endblock %}

django_spire/comment/templates/django_spire/comment/widget/tagging_widget.html

@@ -0,0 +1,130 @@
+{% load spire_core_tags %}
+
+<div x-data="{
+                async init(){
+                    // Set the user list.
+                    this.user_list = JSON.parse('{{ user_list }}')
+                    this.set_information('{{ widget.value }}')
+                },
+                // Instead of information it should be information. This can work for all text area fields.
+                information: '',
+                id: $id('information-textarea'),
+                show_user_list: false,
+                user_list: [],
+                add_user_to_comment(user){
+                    let end_index = this.word_end_index()
+                    let start_index = this.word_start_index()
+                    this.information = this.information.substring(0, start_index) + '@' + user.full_name + this.information.slice(end_index)
+                    this.show_user_list = false;
+                    document.getElementById(this.id).focus()
+                },
+                char_is_space(char){
+                    return /\s/.test(char);
+                },
+                get filtered_users(){
+                    return this.user_list.filter(
+                        user => user.full_name.toLowerCase().includes(this.word_at_cursor().substring(1).toLowerCase())
+                    )
+                },
+                get parse_users(){
+                    // Returns a list of users who have been tagged in the information.
+                    var re = /(?:^|\W)@(\w+)(?!\w)/g, match, matches = [];
+                    while (match = re.exec(this.information)) {
+                        matches.push(match[1].toLowerCase());
+                    }
+                    return this.user_list.filter( user => matches.indexOf(user.full_name.toLowerCase()) > -1)
+                },
+                get user_id_list(){
+                    let id_list = []
+                    this.parse_users.forEach(user => id_list.push(user['id']))
+                    return id_list
+                 },
+                 set_information(initial_value) {
+                    if (initial_value !== 'None') {
+                        this.information = initial_value
+                    }
+                 },
+                user_dropdown_toggle(){
+                    if(this.user_list.some(user => user.full_name === (this.word_at_cursor().substring(1)))){
+                        // Does not toggle if the correct full_name is attached to an @
+                        this.show_user_list = false
+                    } else {
+                        // Toggles if first character is @
+                        this.show_user_list = this.word_at_cursor().charAt(0) === '@';
+                    }
+                },
+                word_at_cursor(){
+                    const cursor_position = document.getElementById(this.id).selectionStart
+                    const string_start = this.information.substring(0, cursor_position).match(/[a-zA-Z0-9-_@]+$/)
+                    const string_end = this.information.substring(cursor_position).match(/^[a-zA-Z0-9-_@]+/)
+                    if(!string_start && !string_end) return ''
+                    return (string_start || '') + (string_end || '')
+                },
+                word_end_index(){
+                    let current_index = document.getElementById(this.id).selectionStart
+                    for(let i = current_index; i <= this.information.length; i++ ){
+                        if(this.char_is_space(this.information.charAt(i))){
+                            // Works forward to find a space and returns that index
+                            return i;
+                        }
+                    }
+                   return current_index;
+                },
+                word_start_index(){
+                    let current_index = document.getElementById(this.id).selectionStart
+                    if(this.char_is_space(this.information.charAt(current_index))){
+                        // Subtract one to get the word before the cursor
+                        current_index -= 1
+                    }
+                    for(let i = current_index; i >= 0; i-- ){
+                       if(this.char_is_space(this.information.charAt(i))){
+                           // Once we find a space we need to return the spot after it.
+                           return i + 1;
+                       }
+                    }
+                    // Return the start if there are no spaces
+                    return 0;
+                },
+                get return_value(){
+                    return JSON.stringify({
+                        'user_id_list': this.user_id_list,
+                        'information': this.information
+                    })
+                }
+           }">
+
+
+    <input type="hidden" class="form-control" id="id_{{ widget.name }}" name="{{ widget.name }}" x-model="return_value"  value="{{ widget.value }}"/>
+    <div class="position-relative">
+            <input name="user_list" type="hidden" x-model=user_id_list />
+            <div class="border border-1 rounded p-1">
+                <textarea required :id="id" x-model="information" @keyup="user_dropdown_toggle" rows="6" type="text" name="information"
+                          autocomplete="off" size="26" class="w-100" placeholder="Type your information here..."></textarea>
+            </div>
+        <div style="max-height: 200px; z-index: 2; overflow-x: hidden; overflow-y: auto" x-show="show_user_list" @click.outside="show_user_list=false" x-transition
+             @keydown.right.prevent.stop="$focus.wrap().next()"
+             @keydown.down.prevent.stop="$focus.wrap().next()"
+             @keydown.left.prevent.stop="$focus.wrap().prev()"
+             @keydown.up.prevent.stop="$focus.wrap().prev()"
+             @keydown.tab.prevent.stop="$focus.wrap().next()"
+             @keydown.esc.prevent.stop="document.getElementById(id).focus()"
+             class="w-100 shadow border border-1 rounded position-absolute top-100 start-0 mt-1">
+            <template x-if="filtered_users.length > 0">
+                <template x-for="user in filtered_users" :key="user.id">
+                        <button
+                            @keydown.enter.prevent.stop="add_user_to_comment(user)"
+                            @click="add_user_to_comment(user)"
+                            class="text-start text-app-primary-hover bg-app-primary-soft-hover d-block w-100 fs-0 px-2 py-2 cursor-pointer border-app-none border-bottom bg-transparent">
+                            <span x-text="user.display_name"></span>
+                            <span x-text="user.full_name"></span>
+                        </button>
+
+                </template>
+            </template>
+            <template x-if="filtered_users.length === 0">
+                <div class="text-start fs-0 px-2 py-1">No matches found.</div>
+            </template>
+        </div>
+    </div>
+</div>
+

django_spire/comment/templatetags/comment_tags.py

@@ -0,0 +1,29 @@
+from __future__ import annotations
+
+from django import template
+
+register = template.Library()
+
+
+@register.simple_tag()
+def comment_form(related_obj, return_url, user, comment=None, parent=None, user_list=None):
+    from django_spire.comment.forms import CommentForm
+
+    return CommentForm(
+        related_obj,
+        return_url,
+        user,
+        instance=comment,
+        parent=parent,
+        user_list=user_list
+    )
+
+
+@register.simple_tag()
+def user_list_from_content_type(related_obj):
+    from django_spire.comment.utils import find_user_list_from_content_type
+
+    return find_user_list_from_content_type(
+        related_obj._meta.app_label,
+        related_obj._meta.model_name
+    )

django_spire/comment/urls.py

@@ -0,0 +1,20 @@
+from django.urls import path
+
+from django_spire.comment import views
+
+
+app_name = 'comment'
+
+urlpatterns = [
+    path('<int:comment_pk>/<int:obj_pk>/<str:app_label>/<str:model_name>/form/content/',
+         views.comment_modal_form_content,
+         name='form_content'),
+
+    path('<int:comment_pk>/<int:obj_pk>/<str:app_label>/<str:model_name>/form/',
+         views.comment_form_view,
+         name='form'),
+
+    path('<int:comment_pk>/<int:obj_pk>/<str:app_label>/<str:model_name>/delete/form/',
+         views.comment_modal_delete_form_view,
+         name='delete_form'),
+]

django_spire/comment/utils.py

@@ -0,0 +1,45 @@
+from __future__ import annotations
+
+
+def find_user_list_from_content_type(app_label, model_name):
+    from django.contrib.contenttypes.models import ContentType
+    from django.contrib.auth.models import Permission, Group, User
+
+    content_type = ContentType.objects.get(app_label=app_label, model=model_name)
+    permission = Permission.objects.get(content_type=content_type, codename=f'view_{model_name}')
+    groups = Group.objects.filter(permissions=permission)
+
+    return User.objects.filter(groups__in=groups).distinct()
+
+
+def generate_comment_user_list_data(user_list):
+    user_data = []
+
+    for user in user_list:
+        user_data.append({
+            'full_name': user.get_full_name().replace(' ', '_'),
+            'id': user.pk,
+        })
+
+    return user_data
+
+
+def parse_user_id_to_int_list(user_id_str):
+    from django.contrib.auth.models import User
+
+    user_id_list =  [int(user_id) for user_id in user_id_str.split(',')]
+    return User.objects.filter(id__in=user_id_list)
+
+
+def process_comment_notifications(user_list, comment_information, related_obj, user_commenting):
+    from django_spire.notification.models import Notification
+    from django.contrib.sites.models import Site
+
+    for user in user_list:
+        if user != user_commenting:
+            Notification.create(
+                email=user.email,
+                title='New Comment',
+                body=f'You were tagged in a new comment! {user_commenting.get_full_name()} wrote "{comment_information}" on {related_obj}.',
+                url=Site.objects.get_current()
+            )

django_spire/comment/views.py

@@ -0,0 +1,136 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from django.contrib import messages
+from django.contrib.auth.decorators import login_required
+from django.http import HttpResponseRedirect
+from django.shortcuts import get_object_or_404
+from django.template.response import TemplateResponse
+from django.urls import reverse
+
+from django_spire.comment import models
+from django_spire.comment.forms import CommentForm
+from django_spire.core.redirect import safe_redirect_url
+from django_spire.core.shortcuts import get_object_or_null_obj, model_object_from_app_label
+from django_spire.contrib.form.utils import show_form_errors
+from django_spire.auth.group.utils import has_app_permission_or_404
+from django_spire.contrib.generic_views import dispatch_modal_delete_form_content
+
+import django_glue as dg
+
+if TYPE_CHECKING:
+    from django.core.handlers.wsgi import WSGIRequest
+
+
+@login_required()
+def comment_modal_form_content(
+    request: WSGIRequest,
+    comment_pk: int,
+    obj_pk: int,
+    app_label: str,
+    model_name: str
+) -> TemplateResponse:
+    has_app_permission_or_404(request.user, app_label, model_name, 'change')
+
+    if comment_pk == 0:
+        comment = get_object_or_null_obj(models.Comment, pk=comment_pk)
+    else:
+        comment = get_object_or_404(models.Comment, pk=comment_pk, user__id=request.user.pk)
+
+    dg.glue_model_object(request, 'comment', comment)
+
+    context_data = {
+        'app_label': app_label,
+        'model_name': model_name,
+        'comment': comment,
+        'obj_pk': obj_pk,
+    }
+
+    return TemplateResponse(
+        request,
+        context=context_data,
+        template='django_spire/comment/form/comment_form.html',
+    )
+
+
+@login_required()
+def comment_form_view(
+    request: WSGIRequest,
+    comment_pk: int,
+    obj_pk: int,
+    app_label: str,
+    model_name: str
+) -> HttpResponseRedirect:
+    has_app_permission_or_404(request.user, app_label, model_name, 'change')
+
+    if comment_pk == 0:
+        comment = get_object_or_null_obj(models.Comment, pk=comment_pk)
+    else:
+        comment = get_object_or_404(models.Comment, pk=comment_pk, user__id=request.user.pk)
+
+    obj = model_object_from_app_label(app_label, model_name, obj_pk)
+
+    if not hasattr(obj, 'add_comment'):
+        message = f'Object {obj} does not have the comment model mixin.'
+        raise Exception(message)
+
+    if request.method == 'POST':
+        form = CommentForm(request.POST, instance=comment)
+        if form.is_valid():
+            # Todo: Create comment factory.
+            if comment_pk == 0:
+                obj.add_comment(
+                    user=request.user,
+                    information=form.cleaned_data['information']
+                )
+            else:
+                comment.information = form.cleaned_data['information']
+                comment.is_edited = True
+                comment.save()
+        else:
+            show_form_errors(request, form)
+
+    return HttpResponseRedirect(safe_redirect_url(request))
+
+
+@login_required()
+def comment_modal_delete_form_view(
+    request: WSGIRequest,
+    comment_pk: int,
+    obj_pk: int,
+    app_label: str,
+    model_name: str
+) -> HttpResponseRedirect | TemplateResponse:
+    has_app_permission_or_404(request.user, app_label, model_name, 'change')
+
+    comment = get_object_or_404(models.Comment, pk=comment_pk)
+    obj = model_object_from_app_label(app_label, model_name, obj_pk)
+    return_url = safe_redirect_url(request)
+
+    if comment.user != request.user:
+        messages.warning(request, 'You can only delete your comments.')
+        return HttpResponseRedirect(return_url)
+
+    form_action = reverse('comment:delete_form', kwargs={
+        'comment_pk': comment_pk,
+        'obj_pk': obj_pk,
+        'app_label': app_label,
+        'model_name': model_name
+    })
+
+    def add_activity() -> None:
+        obj.add_activity(
+            user=request.user,
+            verb='deleted',
+            device=request.device,
+            information=f'{request.user.get_full_name()} deleted a comment on "{obj}".'
+        )
+
+    return dispatch_modal_delete_form_content(
+        request,
+        obj=comment,
+        form_action=form_action,
+        activity_func=add_activity,
+        return_url=return_url,
+    )

django_spire/comment/widgets.py

@@ -0,0 +1,28 @@
+from __future__ import annotations
+
+import json
+
+from django.forms import Widget
+from django.template import loader
+from django.utils.safestring import mark_safe
+
+
+class TaggingWidget(Widget):
+    template_name = 'django_spire/comment/widget/tagging_widget.html'
+    user_list = None
+    information = None
+
+    def __init__(self, user_list, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.user_list = user_list
+
+    def get_context(self, name: str, value, attrs):
+        context_data = super().get_context(name, value, attrs)
+        context_data['user_list'] = json.dumps(self.user_list)
+        # context_data['information'] = self.information
+        return context_data
+
+    def render(self, name: str, value, attrs = None, renderer = None):
+        context = self.get_context(name, value, attrs)
+        template = loader.get_template(self.template_name).render(context)
+        return mark_safe(template)

django_spire/conf.py

@@ -0,0 +1,32 @@
+from django.conf import settings as django_settings
+
+from django_spire import settings as django_spire_default_settings
+
+
+class Settings:
+    def __getattr__(self, name: str):
+        django_value = None
+        django_spire_value = None
+
+        if hasattr(django_settings, name):
+            django_value = getattr(django_settings, name)
+
+        if hasattr(django_spire_default_settings, name):
+            django_spire_value = getattr(django_spire_default_settings, name)
+
+        if name == 'DJANGO_SPIRE_AUTH_CONTROLLERS':
+            if isinstance(django_value, dict) and isinstance(django_spire_value, dict):
+                return {
+                    **django_spire_value,
+                    **django_value
+                }
+
+        if django_value is not None:
+            return django_value
+
+        if django_spire_value is not None:
+            return django_spire_value
+
+        return None
+
+settings = Settings()

django_spire/consts.py

@@ -0,0 +1,5 @@
+__VERSION__ = '0.23.4'
+
+MAINTENANCE_MODE_SETTINGS_NAME = 'MAINTENANCE_MODE'
+
+NOTIFICATION_THROTTLE_RATE_PER_MINUTE_SETTINGS_NAME = 'NOTIFICATION_THROTTLE_RATE_PER_MINUTE'

django_spire/contrib/__init__.py

@@ -0,0 +1,5 @@
+from django_spire.contrib.breadcrumb.breadcrumbs import Breadcrumbs
+
+__all__ = [
+    'Breadcrumbs'
+]

django_spire/contrib/breadcrumb/__init__.py

@@ -0,0 +1,5 @@
+from django_spire.contrib.breadcrumb.breadcrumbs import Breadcrumbs
+
+__all__ = [
+    'Breadcrumbs'
+]

django_spire/contrib/breadcrumb/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class BreadcrumbsConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    label = 'django_spire_breadcrumb'
+    name = 'django_spire.contrib.breadcrumb'

django_spire/contrib/breadcrumb/breadcrumbs.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from typing import TypedDict
+
+
+class BreadcrumbDict(TypedDict):
+    name: str
+    href: str | None
+
+
+class BreadcrumbItem:
+    def __init__(self, name: str, href: str | None = None):
+        self.name = name
+        self.href = href
+
+    def to_dict(self) -> BreadcrumbDict:
+        return {'name': self.name, 'href': self.href}
+
+
+class Breadcrumbs:
+    def __init__(self, branch_slug: str | None = None):
+        self.data: list[BreadcrumbItem] = []
+        self.index: int = 0
+
+    def __add__(self, other):
+        self.data += other.data
+        return self
+
+    def __iter__(self):
+        self.index = 0
+        return self
+
+    def __str__(self) -> str:
+        return str(self.data)
+
+    def __len__(self) -> int:
+        return len(self.data)
+
+    def __next__(self) -> BreadcrumbDict:
+        if self.index >= len(self.data):
+            raise StopIteration
+
+        breadcrumb_item = self.data[self.index]
+        self.index += 1
+        return breadcrumb_item.to_dict()
+
+    def add_base_breadcrumb(self, model) -> None:
+        if hasattr(model, 'base_breadcrumb'):
+            self += model.base_breadcrumb()
+
+    def add_breadcrumb(self, name: str, href: str | None = None) -> None:
+        breadcrumb_item = BreadcrumbItem(name=name, href=href)
+        self.data.append(breadcrumb_item)
+
+    def add_obj_breadcrumbs(self, obj) -> None:
+        # Expects a breadcrumb object to be returned from the object
+        if hasattr(obj, 'breadcrumbs'):
+            object_breadcrumbs = obj.breadcrumbs()
+            self.data += object_breadcrumbs.data
+
+    def add_form_breadcrumbs(self, obj) -> None:
+        self.add_obj_breadcrumbs(obj)
+
+        if obj.pk is None:
+            self.add_breadcrumb(name=obj._meta.model._meta.verbose_name)
+            self.add_breadcrumb(name='Create')
+        else:
+            self.add_breadcrumb(name='Edit')
+
+    def remove(self, index: int):
+        del self.data[index]
+        return self
+
+    def reverse(self):
+        self.data.reverse()
+        return self

django_spire/contrib/constructor/__init__.py

@@ -0,0 +1,9 @@
+from django_spire.contrib.constructor.exceptions import ConstructorException
+from django_spire.contrib.constructor.django_model_constructor import BaseDjangoModelConstructor
+from django_spire.contrib.constructor.constructor import BaseConstructor
+
+__all__ = [
+    'BaseConstructor',
+    'BaseDjangoModelConstructor',
+    'ConstructorException'
+]

django_spire/contrib/constructor/constructor.py

@@ -0,0 +1,86 @@
+from __future__ import annotations
+
+from abc import ABC
+from typing import Any, Generic, TypeVar
+
+from django_spire.contrib.constructor.exceptions import ConstructorException
+
+
+TypeAny = TypeVar('TypeAny', bound=Any, covariant=True)
+
+
+class BaseConstructor(
+    ABC,
+    Generic[TypeAny]
+):
+    def __init__(self, obj: Any = None):
+        self._obj_type_name: str = str(
+            list(self.__class__.__annotations__.values())[0]
+        ).split('.')[-1]
+
+        if obj is None:
+            return
+
+        self._obj_mro_type_names = [cls.__name__ for cls in obj.__class__.__mro__]
+
+        if not self._obj_type_name in self._obj_mro_type_names:
+            raise ConstructorException(
+                f'{self.__class__.__name__} was instantiated with obj type "{obj.__class__.__name__}" and failed as it was expecting "{self._obj_type_name}".'
+            )
+
+        self._obj_type: type[TypeAny] = obj.__class__
+
+        if self._obj_type is None or self._obj_type is ...:
+            raise ConstructorException(
+                f'{self.__class__.__name__} top class attribute must have an annotated type.')
+
+        self.obj: TypeAny = obj
+
+        if ABC not in self.__class__.__bases__:
+            if not self._obj_is_valid:
+                raise ConstructorException(f'{self._obj_type_name} failed to validate on {self.__class__.__name__}')
+
+        self.__post_init__()
+
+    def __init_subclass__(cls):
+        super().__init_subclass__()
+
+        if ABC not in cls.__bases__:
+            if 'obj' not in cls.__annotations__:
+                raise ConstructorException(
+                    f'{cls.__name__} must have an "obj" attribute annotated with a type.')
+
+            # Typing Does not work properly for services if you override __get__ in the BaseService class.
+            # This is a workaround and should be fixed in future versions of the python lsp.
+            def __get__(self, instance, owner):
+
+                if instance is None:
+                    target: cls | Any = owner()
+                else:
+                    target: cls | Any = instance
+
+                if issubclass(target.__class__, BaseConstructor):
+
+                    self._validate_base_service_target_or_error(target)
+
+                    return cls(getattr(target, 'obj'))
+
+                return cls(target)
+
+            setattr(cls, '__get__', __get__)
+
+    def __post_init__(self):
+        pass
+
+    @property
+    def obj_class(self) -> type[TypeAny]:
+        return self._obj_type
+
+    @property
+    def _obj_is_valid(self) -> bool:
+        return isinstance(self.obj, self._obj_type)
+
+    def _validate_base_service_target_or_error(self, target: BaseConstructor):
+        if self._obj_type_name not in target._obj_mro_type_names:
+            raise ConstructorException(
+                f'{target.__class__.__name__} must use the same obj type as {self.__class__.__name__}. {self._obj_type_name} is not in {target._obj_mro_type_names}')