wbcore 1.59.9__py2.py3-none-any.whl

wbcore/contrib/tags/models/tags.py

@@ -0,0 +1,107 @@
+from django.contrib.contenttypes.models import ContentType
+from django.db import models
+from django.db.models.fields.reverse_related import ManyToManyRel
+from django.db.models.signals import m2m_changed
+from django.dispatch import receiver
+from slugify import slugify
+
+from wbcore.contrib.color.fields import ColorField
+from wbcore.models import WBModel
+from wbcore.utils.models import ComplexToStringMixin
+
+
+class ManagedMixin(models.Model):
+    managed = models.BooleanField(default=False)
+
+    class Meta:
+        abstract = True
+
+
+class Tag(ComplexToStringMixin, ManagedMixin):
+    title = models.CharField(max_length=255)
+
+    slug = models.CharField(max_length=255, null=True, blank=True)
+    color = ColorField(default="#D3D3D3")
+
+    groups = models.ManyToManyField(to="tags.TagGroup", blank=True)
+    description = models.TextField(default="", blank=True)
+
+    content_type = models.ForeignKey(
+        ContentType, on_delete=models.CASCADE, blank=True, null=True, related_name="associated_tags"
+    )
+
+    class Meta:
+        unique_together = [("slug", "content_type")]
+        verbose_name = "Tag"
+        verbose_name_plural = "Tags"
+
+    def __str__(self) -> str:
+        return super().__str__()
+
+    @classmethod
+    def get_endpoint_basename(cls):
+        return "wbcore:tags:tag"
+
+    @classmethod
+    def get_representation_endpoint(cls):
+        return "wbcore:tags:tagrepresentation-list"
+
+    @classmethod
+    def get_representation_value_key(cls):
+        return "id"
+
+    @classmethod
+    def get_representation_label_key(cls):
+        return "{{computed_str}}"
+
+    def compute_str(self) -> str:
+        # We need to check here if the instance already is in the database, otherwise groups cannot be linked yet
+        if self.id and self.groups.exists():
+            groups = ",".join(self.groups.all().values_list("title", flat=True))
+            return f"{groups}::{self.title}"
+        return self.title
+
+    def save(self, *args, **kwargs):
+        if not self.slug:
+            self.slug = slugify(self.title)
+        self.computed_str = self.compute_str()
+        super().save(*args, **kwargs)
+
+    def get_tagged_queryset(self):
+        qs = self.__class__.objects.none()
+        for field in filter(lambda x: isinstance(x, ManyToManyRel), self.__class__._meta.get_fields()):
+            _qs = getattr(self, field.related_name).all()
+            qs = qs.union(_qs.values("tag_detail_endpoint", "tag_representation"))
+        return qs
+
+
+class TagGroup(ManagedMixin, WBModel):
+    title = models.CharField(max_length=255, unique=True)
+
+    @classmethod
+    def get_endpoint_basename(cls):
+        return "wbcore:tags:taggroup"
+
+    @classmethod
+    def get_representation_endpoint(cls):
+        return "wbcore:tags:taggrouprepresentation-list"
+
+    @classmethod
+    def get_representation_value_key(cls):
+        return "id"
+
+    @classmethod
+    def get_representation_label_key(cls):
+        return "{{title}}"
+
+    def __str__(self) -> str:
+        return f"{self.title}"
+
+    class Meta:
+        verbose_name = "Tag Group"
+        verbose_name_plural = "Tag Groups"
+
+
+@receiver(m2m_changed, sender=Tag.groups.through)
+def tag_groups_m2m_changed(sender, instance, action, **kwargs):
+    instance.save()

wbcore/contrib/tags/release_notes/1_0_0.md

@@ -0,0 +1,13 @@
+Date: 2023-04-26
+Module: Tags
+Summary: Initial Release Note
+Version: 1.0.0
+
+## New Features
+- Bootstrap module versioning
+
+## Enhancements
+./.
+
+## Bugfixes
+./.

wbcore/contrib/tags/serializers.py

@@ -0,0 +1,90 @@
+from django.contrib.contenttypes.models import ContentType
+from rest_framework.reverse import reverse
+
+from wbcore import serializers
+from wbcore.content_type.serializers import ContentTypeRepresentationSerializer
+from wbcore.content_type.utils import get_view_content_type_id
+
+from .models import Tag, TagGroup
+
+
+class TagGroupRepresentationSerializer(serializers.RepresentationSerializer):
+    _detail = serializers.HyperlinkField(reverse_name="wbcore:tags:taggroup-detail")
+
+    class Meta:
+        model = TagGroup
+        fields = ("id", "title", "_detail")
+
+
+class TagGroupModelSerializer(serializers.ModelSerializer):
+    @serializers.register_resource()
+    def additional_resources(self, instance, request, user):
+        return {
+            "tags": reverse(
+                "wbcore:tags:group-tag-list",
+                args=[instance.id],
+                request=request,
+            )
+        }
+
+    class Meta:
+        model = TagGroup
+        read_only_fields = ("slug",)
+        fields = ("id", "title", "_additional_resources")
+
+
+class TagRepresentationSerializer(serializers.RepresentationSerializer):
+    _detail = serializers.HyperlinkField(reverse_name="wbcore:tags:tag-detail")
+    _detail_preview = serializers.HyperlinkField(reverse_name="wbcore:tags:tag-detail")
+
+    def get_filter_params(self, request):
+        content_type_id = get_view_content_type_id(request.parser_context["view"])
+        return {"content_type": content_type_id}
+
+    class Meta:
+        model = Tag
+        read_only_fields = ("slug",)
+        fields = (
+            "id",
+            "title",
+            "computed_str",
+            "color",
+            "slug",
+            "description",
+            "_detail",
+            "_detail_preview",
+        )
+
+
+class TagModelSerializer(serializers.ModelSerializer):
+    _groups = TagGroupRepresentationSerializer(source="groups", many=True)
+    _content_type = ContentTypeRepresentationSerializer(source="content_type")
+    content_type = serializers.PrimaryKeyRelatedField(
+        queryset=ContentType.objects.all(), required=False, allow_null=True
+    )
+    groups = serializers.PrimaryKeyRelatedField(
+        queryset=TagGroup.objects.all(),
+        many=True,
+        default=serializers.DefaultFromKwargs("group_id"),
+    )
+
+    class Meta:
+        model = Tag
+        read_only_fields = ("slug",)
+        fields = (
+            "id",
+            "title",
+            "computed_str",
+            "color",
+            "content_type",
+            "_content_type",
+            "slug",
+            "description",
+            "groups",
+            "_groups",
+        )
+
+
+class TagSerializerMixin(serializers.Serializer):
+    tags = serializers.PrimaryKeyRelatedField(queryset=Tag.objects.all(), label="Tags", many=True)
+    _tags = TagRepresentationSerializer(source="tags", many=True)

wbcore/contrib/tags/signals.py

@@ -0,0 +1,19 @@
+from django.db.models.signals import m2m_changed
+
+from wbcore.dispatch import receiver_inherited_through_models
+
+from .models.mixins import TagModelMixin
+
+
+@receiver_inherited_through_models(m2m_changed, sender=TagModelMixin, through_field_name="tags")
+def pre_add_tags(sender, instance, action, pk_set, **kwargs):
+    from django.contrib.contenttypes.models import ContentType
+
+    from wbcore.contrib.tags.models.tags import Tag
+
+    if action == "post_add" and pk_set:
+        content_type = ContentType.objects.get_for_model(instance)
+        for tag_id in pk_set:
+            tag = Tag.objects.get(id=tag_id)
+            if tag.content_type and tag.content_type != content_type:
+                instance.tags.remove(tag)

wbcore/contrib/tags/tests/conftest.py

@@ -0,0 +1,7 @@
+from pytest_factoryboy import register
+from wbcore.tests.conftest import *
+
+from ..factories import TagFactory, TagGroupFactory
+
+register(TagFactory)
+register(TagGroupFactory)

wbcore/contrib/tags/tests/tests.py

@@ -0,0 +1,144 @@
+import pytest
+from django.forms.models import model_to_dict
+from rest_framework import status
+from rest_framework.test import APIRequestFactory
+
+from wbcore.contrib.authentication.factories import SuperUserFactory
+from wbcore.contrib.tags.factories import (
+    TagFactory,
+    TagGroupFactory,
+)
+from wbcore.contrib.tags.viewsets import (
+    TagGroupModelViewSet,
+    TagGroupRepresentationViewSet,
+    TagModelViewSet,
+    TagRepresentationViewSet,
+)
+
+
+@pytest.mark.viewset_tests
+@pytest.mark.with_db
+@pytest.mark.django_db
+class TestTagViewSets:
+    @pytest.fixture()
+    def api_rf(self):
+        factory = APIRequestFactory()
+        return factory
+
+    @pytest.fixture()
+    def super_user(self):
+        super_user = SuperUserFactory()
+        return super_user
+
+    @pytest.mark.parametrize(
+        "viewset, factory",
+        [
+            (TagGroupModelViewSet, TagGroupFactory),
+            (TagModelViewSet, TagFactory),
+            (TagGroupRepresentationViewSet, TagGroupFactory),
+            (TagRepresentationViewSet, TagFactory),
+        ],
+    )
+    def test_get_list(self, viewset, factory, api_rf, super_user):
+        # Arrange
+        request = api_rf.get("")
+        request.user = super_user
+        factory.create_batch(3)
+        vs = viewset.as_view({"get": "list"})
+        # Act
+        response = vs(request)
+        # Assert
+        assert response.status_code == status.HTTP_200_OK
+        assert len(response.data["results"]) == 3
+        assert not response.data.get("instance")
+
+    @pytest.mark.parametrize(
+        "viewset, factory",
+        [
+            (TagGroupModelViewSet, TagGroupFactory),
+            (TagModelViewSet, TagFactory),
+            (TagGroupRepresentationViewSet, TagGroupFactory),
+            (TagRepresentationViewSet, TagFactory),
+        ],
+    )
+    def test_get_instance(self, viewset, factory, api_rf, super_user):
+        # Arrange
+        request = api_rf.get("")
+        request.user = super_user
+        instance = factory()
+        vs = viewset.as_view({"get": "retrieve"})
+        # Act
+        response = vs(request, pk=instance.pk)
+        # Assert
+        assert response.status_code == status.HTTP_200_OK
+        assert response.data["instance"]["id"] == instance.id
+        assert not response.data.get("results")
+
+    @pytest.mark.parametrize(
+        "viewset, factory",
+        [
+            (TagGroupModelViewSet, TagGroupFactory),
+            (TagModelViewSet, TagFactory),
+        ],
+    )
+    def test_delete_instance(self, viewset, factory, api_rf, super_user):
+        # Arrange
+        request = api_rf.delete("")
+        request.user = super_user
+        instance = factory()
+        vs = viewset.as_view({"delete": "destroy"})
+        model = viewset.get_model()
+        # Act
+        response = vs(request, pk=instance.pk)
+        # Assert
+        assert response.status_code == status.HTTP_204_NO_CONTENT
+        assert not model.objects.filter(id=instance.id).exists()
+
+    @pytest.mark.parametrize(
+        "viewset, factory",
+        [
+            (TagGroupModelViewSet, TagGroupFactory),
+            (TagModelViewSet, TagFactory),
+        ],
+    )
+    def test_update_instance(self, viewset, factory, api_rf, super_user):
+        # Arrange
+        instance = factory()
+        new_data = model_to_dict(factory.build())
+        new_title = instance.title + "Foo Bar"
+        new_data["id"] = instance.id
+        new_data["title"] = new_title
+        request = api_rf.put("", data=new_data, format="json")
+        request.user = super_user
+        vs = viewset.as_view({"put": "update"})
+        # Act
+        response = vs(request, pk=instance.pk)
+        updated_instance = response.data.get("instance")
+        print("RESPONSE:----------------->\n", response.data)  # noqa
+        # Assert
+        assert response.status_code == status.HTTP_200_OK
+        assert updated_instance["id"] == instance.id
+        assert updated_instance["title"] == new_title
+        assert updated_instance["title"] != instance.title
+
+    @pytest.mark.parametrize(
+        "viewset, factory",
+        [
+            (TagGroupModelViewSet, TagGroupFactory),
+            (TagModelViewSet, TagFactory),
+        ],
+    )
+    def test_patch_instance(self, viewset, factory, api_rf, super_user):
+        # Arrange
+        instance = factory()
+        new_title = instance.title + "Foo Bar"
+        request = api_rf.patch("", data={"title": new_title})
+        request.user = super_user
+        vs = viewset.as_view({"patch": "partial_update"})
+        # Act
+        response = vs(request, pk=instance.pk)
+        updated_instance = response.data.get("instance")
+        # Assert
+        assert response.status_code == status.HTTP_200_OK
+        assert updated_instance["title"] == new_title
+        assert updated_instance["title"] != instance.title

wbcore/contrib/tags/urls.py

@@ -0,0 +1,15 @@
+from django.urls import include, path
+
+from wbcore.routers import WBCoreRouter
+
+from .viewsets import viewsets
+
+router = WBCoreRouter()
+router.register(r"tagrepresentation", viewsets.TagRepresentationViewSet, basename="tagrepresentation")
+router.register(r"tag", viewsets.TagModelViewSet, basename="tag")
+router.register(r"taggrouprepresentation", viewsets.TagGroupRepresentationViewSet, basename="taggrouprepresentation")
+router.register(r"taggroup", viewsets.TagGroupModelViewSet, basename="taggroup")
+
+group_router = WBCoreRouter()
+group_router.register(r"tag", viewsets.TagTagGroupModelViewSet, basename="group-tag")
+urlpatterns = [path("", include(router.urls)), path("group/<int:group_id>/", include(group_router.urls))]

wbcore/contrib/tags/viewsets/__init__.py

@@ -0,0 +1,10 @@
+from .menu import TAG_MENUITEM
+from .viewsets import (
+    TagGroupModelSerializer,
+    TagGroupRepresentationSerializer,
+    TagModelViewSet,
+    TagGroupModelViewSet,
+    TagGroupRepresentationViewSet,
+    TagRepresentationViewSet,
+    TagTagGroupModelViewSet,
+)

wbcore/contrib/tags/viewsets/display.py

@@ -0,0 +1,50 @@
+from typing import Optional
+
+from wbcore.metadata.configs import display as dp
+from wbcore.metadata.configs.display.instance_display.shortcuts import (
+    Display,
+    create_simple_display,
+    create_simple_section,
+)
+from wbcore.metadata.configs.display.instance_display.utils import repeat_field
+from wbcore.metadata.configs.display.view_config import DisplayViewConfig
+from wbcore.metadata.configs.preview import PreviewViewConfig
+
+
+class TagGroupDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(fields=[dp.Field(key="title", label="Title")])
+
+    def get_instance_display(self) -> Display:
+        return create_simple_display(
+            [["title"], ["tags_sections"]],
+            [create_simple_section("tags_sections", "Tags", [["tags"]], "tags", collapsed=True)],
+        )
+
+
+class TagDisplayConfig(DisplayViewConfig):
+    def get_list_display(self) -> Optional[dp.ListDisplay]:
+        return dp.ListDisplay(
+            fields=[
+                dp.Field(key="title", label="Title"),
+                dp.Field(key="color", label="Color"),
+                dp.Field(key="slug", label="Slug"),
+                dp.Field(key="groups", label="Groups"),
+                dp.Field(key="content_type", label="Content Type"),
+                dp.Field(key="description", label="Description"),
+            ]
+        )
+
+    def get_instance_display(self) -> Display:
+        return create_simple_display(
+            [
+                [repeat_field(2, "title"), "slug"],
+                ["groups", "color", "content_type"],
+                [repeat_field(3, "description")],
+            ]
+        )
+
+
+class TagPreviewConfig(PreviewViewConfig):
+    def get_display(self):
+        return create_simple_display([["title", "groups", "description"]])

wbcore/contrib/tags/viewsets/menu.py

@@ -0,0 +1,15 @@
+from wbcore.menus import ItemPermission, MenuItem
+
+TAG_MENUITEM = MenuItem(
+    label="Tag",
+    endpoint="wbcore:tags:tag-list",
+    add=MenuItem(label="New Tag", endpoint="wbcore:tags:tag-list"),
+    permission=ItemPermission(permissions=["tags.change_tag"]),
+)
+
+TAGGROUP_MENUITEM = MenuItem(
+    label="Tag Group",
+    endpoint="wbcore:tags:taggroup-list",
+    add=MenuItem(label="New Tag Group", endpoint="wbcore:tags:taggroup-list"),
+    permission=ItemPermission(permissions=["tags.change_taggroup"]),
+)

wbcore/contrib/tags/viewsets/viewsets.py

@@ -0,0 +1,58 @@
+from wbcore import viewsets
+
+from ..filters import TagFilterSet
+from ..models import Tag, TagGroup
+from ..serializers import (
+    TagGroupModelSerializer,
+    TagGroupRepresentationSerializer,
+    TagModelSerializer,
+    TagRepresentationSerializer,
+)
+from .display import TagDisplayConfig, TagGroupDisplayConfig, TagPreviewConfig
+
+
+class TagGroupRepresentationViewSet(viewsets.RepresentationViewSet):
+    queryset = TagGroup.objects.all()
+    serializer_class = TagGroupRepresentationSerializer
+
+    search_fields = ["title"]
+
+
+class TagGroupModelViewSet(viewsets.ModelViewSet):
+    queryset = TagGroup.objects.all()
+    serializer_class = TagGroupModelSerializer
+
+    filterset_fields = {"title": ["icontains", "exact"]}
+    search_fields = ["title"]
+
+    display_config_class = TagGroupDisplayConfig
+
+
+class TagRepresentationViewSet(viewsets.RepresentationViewSet):
+    queryset = Tag.objects.all()
+    serializer_class = TagRepresentationSerializer
+    filterset_class = TagFilterSet
+
+    search_fields = ["title", "slug", "groups__title"]
+
+
+class TagModelViewSet(viewsets.ModelViewSet):
+    queryset = Tag.objects.all()
+    serializer_class = TagModelSerializer
+
+    filterset_class = TagFilterSet
+    search_fields = ("title", "description")
+    ordering_fields = [
+        "title",
+        "color",
+        "slug",
+        "content_type",
+    ]
+    ordering = ["title"]
+    display_config_class = TagDisplayConfig
+    preview_config_class = TagPreviewConfig
+
+
+class TagTagGroupModelViewSet(TagModelViewSet):
+    def get_queryset(self):
+        return super().get_queryset().filter(groups=self.kwargs["group_id"])

wbcore/contrib/workflow/__init__.py

@@ -0,0 +1 @@
+from .decorators import register, register_assignee

wbcore/contrib/workflow/admin/__init__.py

@@ -0,0 +1,15 @@
+from .condition import ConditionAdmin
+from .data import DataAdmin, DataValueAdmin
+from .display import DisplayAdmin
+from .process import ProcessAdmin
+from .step import (
+    DecisionStepAdmin,
+    EmailStepAdmin,
+    FinishStepAdmin,
+    JoinStepAdmin,
+    SplitStepAdmin,
+    UserStepAdmin,
+    StartStepAdmin,
+)
+from .transition import TransitionAdmin
+from .workflow import WorkflowAdmin

wbcore/contrib/workflow/admin/condition.py

@@ -0,0 +1,9 @@
+from django.contrib import admin
+
+from wbcore.contrib.workflow.models import Condition
+
+
+@admin.register(Condition)
+class ConditionAdmin(admin.ModelAdmin):
+    search_fields = ("name",)
+    list_display = ("id", "transition", "attribute_name", "operator", "negate_operator", "expected_value")

wbcore/contrib/workflow/admin/data.py

@@ -0,0 +1,15 @@
+from django.contrib import admin
+
+from wbcore.contrib.workflow.models import Data, DataValue
+
+
+@admin.register(Data)
+class DataAdmin(admin.ModelAdmin):
+    search_fields = ("label",)
+    list_display = ("id", "label", "data_type", "workflow", "help_text", "required", "default")
+
+
+@admin.register(DataValue)
+class DataValueAdmin(admin.ModelAdmin):
+    search_fields = ("value",)
+    list_display = ("id", "value", "data")

wbcore/contrib/workflow/admin/display.py

@@ -0,0 +1,9 @@
+from django.contrib import admin
+
+from wbcore.contrib.workflow.models import Display
+
+
+@admin.register(Display)
+class DisplayAdmin(admin.ModelAdmin):
+    search_fields = ("name",)
+    list_display = ("id", "name", "grid_template_areas")

wbcore/contrib/workflow/admin/process.py

@@ -0,0 +1,37 @@
+from django.contrib import admin
+
+from wbcore.contrib.workflow.models import Process, ProcessStep
+
+
+@admin.register(Process)
+class ProcessAdmin(admin.ModelAdmin):
+    search_fields = ("id", "workflow")
+    list_display = (
+        "id",
+        "workflow",
+        "state",
+        "started",
+        "finished",
+        "instance_id",
+        "content_type",
+        "instance",
+        "preserved_instance",
+    )
+
+
+@admin.register(ProcessStep)
+class ProcessStepAdmin(admin.ModelAdmin):
+    search_fields = ("id", "process", "step")
+    list_display = (
+        "id",
+        "process",
+        "step",
+        "state",
+        "error_message",
+        "started",
+        "finished",
+        "assignee",
+        "group",
+        "permission",
+        "status",
+    )