wbwriter 1.54.17__tar.gz → 1.59.4__tar.gz

{wbwriter-1.54.17 → wbwriter-1.59.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wbwriter
-Version: 1.54.17
+Version: 1.59.4
 Author-email: Christopher Wittlinger <c.wittlinger@stainly.com>
 Requires-Dist: reportlab==3.*
 Requires-Dist: wbcore

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/admin.py

@@ -51,7 +51,7 @@ class MetaInformationInstanceInline(admin.TabularInline):
 
 @admin.register(ArticleType)
 class ArticleTypeModelAdmin(admin.ModelAdmin):
-    list_display = ("id", "label", "slug")
+    list_display = ("id", "label", "slug", "can_be_published", "allow_empty_author")
 
     ordering = ["slug"]
     search_fields = ["id", "label", "slug"]
@@ -61,8 +61,6 @@ class ArticleTypeModelAdmin(admin.ModelAdmin):
         "qa_reviewers",
     ]
 
-    # prepopulated_fields = {"slug": ("label",)}
-
 
 @admin.register(Article)
 class ArticleModelAdmin(CompareVersionAdmin, admin.ModelAdmin):

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/factories/article.py

@@ -80,6 +80,7 @@ class ArticleTypeFactory(factory.django.DjangoModelFactory):
         model = ArticleType
 
     label = factory.Sequence(lambda n: f"articletype {n}")
+    can_be_published = True
 
     @factory.post_generation
     def parsers(self, create, extracted, **kwargs):

wbwriter-1.59.4/wbwriter/migrations/0013_articletype_allow_empty_author_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.0.12 on 2025-12-02 10:19
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('wbwriter', '0012_i18n'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='articletype',
+            name='allow_empty_author',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='articletype',
+            name='can_be_published',
+            field=models.BooleanField(default=True),
+        ),
+    ]

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/models/article.py

@@ -39,7 +39,7 @@ from weasyprint import CSS
 
 from wbwriter.models.publication_models import Publication
 from wbwriter.pdf_generator import PdfGenerator
-from wbwriter.publication_parser import ParserValidationException
+from wbwriter.publication_parser import ParserValidationError
 from wbwriter.typings import ArticleDTO
 
 from .mixins import PublishableMixin
@@ -167,7 +167,7 @@ class DependantArticle(WBModel):
     )
 
     @classmethod
-    def get_endpoint_basename(self):
+    def get_endpoint_basename(cls):
         return "wbwriter:dependantarticle"
 
     @classmethod
@@ -770,16 +770,10 @@ class Article(CloneMixin, TagModelMixin, PublishableMixin, WBModel):
             generate_publications.delay(self.id)
 
     def can_publish(self) -> dict[str, str]:
-        """Allow only one-off and deep-dive articles to be published."""
         errors = dict()
         if self.status not in [self.Status.APPROVED, self.Status.PUBLISHED]:
             errors["status"] = [gettext_lazy("Status needs to be approved in order to allow publication")]
-        if not self.type or self.type.slug not in [
-            "one-off-article",
-            "deep-dive-article",
-            "mid-year-review",
-            "year-s-favorites",
-        ]:
+        if not self.type or not self.type.can_be_published:
             errors["type"] = [gettext_lazy("unvalid type for publication")]
         # We ensure the article's parser can be published
         if article_type := self.type:
@@ -789,7 +783,7 @@ class Article(CloneMixin, TagModelMixin, PublishableMixin, WBModel):
                         self._build_dto(),
                         date.today(),
                     ).is_valid()
-                except ParserValidationException as e:
+                except ParserValidationError as e:
                     errors["non_field_errors"] = e.errors
                 except ModuleNotFoundError:
                     errors["non_field_errors"] = [gettext_lazy("invalid parser")]
@@ -811,20 +805,6 @@ class Article(CloneMixin, TagModelMixin, PublishableMixin, WBModel):
         # we delete existing publication in case the user unpublish it
         Publication.objects.filter(object_id=self.id, content_type=ContentType.objects.get_for_model(self)).delete()
 
-    # @transition(
-    #     status,
-    #     source=[Status.APPROVED, Status.PUBLISHED],
-    #     target=Status.DRAFT,
-    #     permission=can_revise,
-    #     custom={"_transition_button": revise_button},
-    # )
-    # def revise(self, by=None):
-    #     """Move the article back to the draft state."""
-    #     self.peer_reviewer_approved = False
-    #     self.peer_reviewer = None
-    #     if self.type.slug == "ddq":
-    #         self.author = None
-
     @transition(
         status,
         source=[Status.APPROVED],
@@ -867,10 +847,6 @@ class Article(CloneMixin, TagModelMixin, PublishableMixin, WBModel):
         if not self.qa_reviewer:
             self.qa_reviewer = self.roll_qa()
 
-        # if self.type and self.type.slug == "ddq":
-        #     with suppress(Person.DoesNotExist):
-        #         self.qa_reviewer = Person.objects.get(computed_str__icontains="Stefano Rodella")
-
         create_dependencies(self)
         super().save(*args, **kwargs)
 
@@ -1048,58 +1024,44 @@ class Article(CloneMixin, TagModelMixin, PublishableMixin, WBModel):
         styles = []
         pdf_content = None
         if not self.content or "sections" not in self.content:
-            html = template.Template(empty_template).render(
-                {"content": "<h1>There seems to be no content to render.</h1>"}
-            )
+            template_context = {"content": "<h1>There seems to be no content to render.</h1>"}
         else:
             content = self.content["sections"][self.content["sectionOrder"][0]]["content"]["content"]
             resolved_content = resolve_content(content, extensions=["sane_lists"], article=self)
             template_context = template.Context({"content": resolved_content})
             if self.type:
-                if "ddq" in self.type.slug:
-                    # TODO: Replace self.content with the raw_contents equivalent.
-
-                    # If there is a template defined, then render that one and use its styles.
-                    if self.template and self.template.template:
-                        html = template.Template(self.template.template).render(template_context)
-
-                        styles = [CSS(string=style.style) for style in self.template.styles.all()]
-                        if header := self.template.header_template:
-                            styles += [CSS(string=style.style) for style in header.styles.all()]
-                        if footer := self.template.footer_template:
-                            styles += [CSS(string=style.style) for style in footer.styles.all()]
-
-                        pdf_content = PdfGenerator(
-                            main_html=html,
-                            header_html=self.template.header_template.template,
-                            footer_html=self.template.footer_template.template,
-                            custom_css=styles,
-                            side_margin=self.template.side_margin,
-                            extra_vertical_margin=self.template.extra_vertical_margin,
-                        ).render_pdf()
-
-                elif (
-                    "one-off" in self.type.slug
-                    or "deep-dive" in self.type.slug
-                    or "mid-year" in self.type.slug
-                    or "year-s-favorites" in self.type.slug
-                ):
-                    parsers = self.type.parsers.all()
-                    if parsers.exists():
-                        parser = parsers.first().parser_class(self._build_dto(), datetime.date.today())
-                        if parser.is_valid(raise_exception=False):
-                            pdf_content = parser.get_file()
-                        else:
-                            template_context["content"] = f"""
-                            <p>To generate the PDF, please correct the following errors:</p>
-                            <ul>
-                            {"".join([f"<li>{error}</li>" for error in parser.errors])}
-                            </ul>
-                            """
-            html = template.Template(empty_template).render(template_context)
+                parsers = self.type.parsers.all()
+                if parsers.exists():
+                    parser = parsers.first().parser_class(self._build_dto(), datetime.date.today())
+                    if parser.is_valid(raise_exception=False):
+                        pdf_content = parser.get_file()
+                    else:
+                        template_context["content"] = f"""
+                        <p>To generate the PDF, please correct the following errors:</p>
+                        <ul>
+                        {"".join([f"<li>{error}</li>" for error in parser.errors])}
+                        </ul>
+                        """
+                elif self.template and self.template.template:
+                    html = template.Template(self.template.template).render(template_context)
+
+                    styles = [CSS(string=style.style) for style in self.template.styles.all()]
+                    if header := self.template.header_template:
+                        styles += [CSS(string=style.style) for style in header.styles.all()]
+                    if footer := self.template.footer_template:
+                        styles += [CSS(string=style.style) for style in footer.styles.all()]
+
+                    pdf_content = PdfGenerator(
+                        main_html=html,
+                        header_html=self.template.header_template.template,
+                        footer_html=self.template.footer_template.template,
+                        custom_css=styles,
+                        side_margin=self.template.side_margin,
+                        extra_vertical_margin=self.template.extra_vertical_margin,
+                    ).render_pdf()
         if not pdf_content:
             pdf_content = PdfGenerator(
-                main_html=html,
+                main_html=template.Template(empty_template).render(template_context),
                 custom_css=styles,
                 side_margin=0,
                 extra_vertical_margin=0,
@@ -1175,7 +1137,7 @@ class Article(CloneMixin, TagModelMixin, PublishableMixin, WBModel):
         return mapping
 
     @classmethod
-    def get_endpoint_basename(self):
+    def get_endpoint_basename(cls):
         return "wbwriter:article"
 
     @classmethod

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/models/article_type.py

@@ -30,9 +30,11 @@ class ArticleType(WBModel):
     parsers = models.ManyToManyField("wbwriter.PublicationParser", related_name="publication_parsers", blank=True)
     peer_reviewers = models.ManyToManyField("directory.Person", related_name="article_type_peer_reviewers")
     qa_reviewers = models.ManyToManyField("directory.Person", related_name="article_type_qa_reviewers")
+    can_be_published = models.BooleanField(default=True)
+    allow_empty_author = models.BooleanField(default=False)
 
     @classmethod
-    def get_endpoint_basename(self):
+    def get_endpoint_basename(cls):
         return "wbwriter:articletyperepresentation"
 
     @classmethod

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/models/in_editor_template.py

@@ -86,7 +86,7 @@ class InEditorTemplate(WBModel):
         return self.title
 
     @classmethod
-    def get_endpoint_basename(self):
+    def get_endpoint_basename(cls):
         return "wbwriter:in-editor-template"
 
     @classmethod

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/models/meta_information.py

@@ -24,7 +24,7 @@ class MetaInformation(WBModel):
         verbose_name_plural = "Meta Information"
 
     @classmethod
-    def get_endpoint_basename(self):
+    def get_endpoint_basename(cls):
         return "wbwriter:metainformation"
 
     @classmethod
@@ -60,7 +60,7 @@ class MetaInformationInstance(WBModel):
         ]
 
     @classmethod
-    def get_endpoint_basename(self):
+    def get_endpoint_basename(cls):
         return "wbwriter:metainformationinstance"
 
     @classmethod

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/models/publication_models.py

@@ -77,6 +77,9 @@ class Publication(TagModelMixin, models.Model):
     object_id = models.PositiveIntegerField()
     content_object = GenericForeignKey("content_type", "object_id")
 
+    def __str__(self) -> str:
+        return self.title
+
     @classmethod
     def create_or_update_from_parser_and_object(cls, parser, generic_object):
         if hasattr(generic_object, "_build_dto") and callable(generic_object._build_dto):
@@ -91,7 +94,7 @@ class Publication(TagModelMixin, models.Model):
             pub.save()
 
     @classmethod
-    def get_endpoint_basename(self):
+    def get_endpoint_basename(cls):
         return "wbwriter:publication"
 
     @classmethod

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/pdf_generator.py

@@ -31,7 +31,7 @@ class PdfGenerator:
         main_html,
         header_html=None,
         footer_html=None,
-        custom_css=[],
+        custom_css=None,
         base_url=None,
         side_margin=2,
         extra_vertical_margin=30,
@@ -61,7 +61,7 @@ class PdfGenerator:
         self.main_html = main_html
         self.header_html = header_html
         self.footer_html = footer_html
-        self.custom_css = custom_css
+        self.custom_css = custom_css if custom_css else []
         self.base_url = base_url
         self.side_margin = side_margin
         self.extra_vertical_margin = extra_vertical_margin

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/publication_parser.py

@@ -1,6 +1,5 @@
 import json
 import os
-from abc import ABC
 from datetime import date
 from io import BytesIO
 from typing import Iterable
@@ -17,12 +16,12 @@ from wbwriter.pdf_generator import PdfGenerator
 from .typings import ArticleDTO
 
 
-class ParserValidationException(Exception):
+class ParserValidationError(Exception):
     def __init__(self, *args, errors=None, **kwargs):  # real signature unknown
         self.errors = errors
 
 
-class PublicationParser(ABC):  # pragma: no cover
+class PublicationParser:  # pragma: no cover
     def __init__(self, article: ArticleDTO, published_date: date):
         self.article = article
         self.published_date = published_date
@@ -64,7 +63,7 @@ class PublicationParser(ABC):  # pragma: no cover
         self._errors = []
         is_valid = self._is_valid()
         if self.errors and raise_exception:
-            raise ParserValidationException(errors=self.errors)
+            raise ParserValidationError(errors=self.errors)
         return is_valid
 
     def _get_additional_information(self) -> dict[str, any]:

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/serializers/article.py

@@ -7,6 +7,7 @@ from wbcore.contrib.directory.serializers import (
     InternalUserProfileRepresentationSerializer,
 )
 from wbcore.contrib.documents.models import Document
+from wbcore.contrib.i18n.serializers.mixins import ModelTranslateSerializerMixin
 from wbcore.contrib.tags.serializers import TagSerializerMixin
 from wbcore.serializers import (
     HyperlinkField,
@@ -58,9 +59,6 @@ class DependantArticleModelSerializer(ModelSerializer):
         )
 
 
-from wbcore.contrib.i18n.serializers.mixins import ModelTranslateSerializerMixin
-
-
 class ArticleModelSerializer(ModelTranslateSerializerMixin, TagSerializerMixin, ModelSerializer):
     """Serializes a subset of the fields of of the Article model to minimize
     workload on serializing lists of instances.
@@ -323,15 +321,13 @@ class ArticleFullModelSerializer(ArticleModelSerializer):
             if (
                 self.instance
                 and data.get("type")
-                and data.get("type").slug != "ddq"
+                and data.get("type").allow_empty_author
                 and (
                     ("author" in data and not data.get("author"))
                     or ("author" not in data and self.instance.author is None)
                 )
             ):
-                raise serializers.ValidationError(
-                    {"type": 'This must be set to "DDQ" as long as no author has been assigned!'}
-                )
+                raise serializers.ValidationError({"type": f'The type {data["type"]} does not allow empty author.'})
 
         return data
 

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/tests/signals.py

@@ -1,6 +1,7 @@
 from django.dispatch import receiver
 from dynamic_preferences.registries import global_preferences_registry
 from wbcore.test.signals import custom_update_kwargs
+
 from wbwriter.models import Article
 from wbwriter.viewsets import ArticleModelViewSet, ReviewerArticleModelViewSet
 

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/tests/test_filter.py

@@ -1,6 +1,7 @@
 import pytest
 from rest_framework.test import APIRequestFactory
 from wbcore.contrib.authentication.factories import InternalUserFactory
+
 from wbwriter.factories import ArticleFactory, MetaInformationInstanceFactory
 from wbwriter.filters import MetaInformationInstanceFilter
 from wbwriter.models import MetaInformationInstance

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/tests/test_model.py

@@ -5,6 +5,7 @@ from django.forms.models import model_to_dict
 from django_fsm import has_transition_perm
 from wbcore.contrib.authentication.factories import UserFactory
 from wbcore.contrib.authentication.models import Permission, User
+
 from wbwriter.factories import (
     ArticleFactory,
     ArticleTypeFactory,
@@ -422,7 +423,7 @@ class TestArticlePermissions:
             status=Article.Status.APPROVED, type=ArticleTypeFactory(label="Mid Year Review")
         )
         article_d: Article = ArticleFactory(
-            status=Article.Status.APPROVED, type=ArticleTypeFactory(label="Unalligned Article")
+            status=Article.Status.APPROVED, type=ArticleTypeFactory(can_be_published=False, label="Unalligned Article")
         )
         assert article_a.can_be_published()
         assert article_b.can_be_published()

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/tests/test_writer.py

@@ -1,4 +1,5 @@
 import pytest
+
 from wbwriter.templatetags.writer import cite_article, table_of_contents
 
 

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/urls.py

@@ -21,7 +21,6 @@ router.register(
 
 router.register(r"article", viewsets.ArticleModelViewSet, basename="article")
 router.register(r"articlerepresentation", viewsets.ArticleRepresentionViewSet, basename="articlerepresentation")
-# router.register(r"ddq", viewsets.DDQArticleModelViewSet, basename="ddq")
 router.register(r"review-article", viewsets.ReviewerArticleModelViewSet, basename="review-article")
 router.register(
     r"articletyperepresentation",

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/viewsets/buttons.py

@@ -46,7 +46,7 @@ class ArticleModelButtonConfig(ButtonViewConfig):
             if (
                 instance.status == Article.Status.DRAFT
                 and instance.type
-                and instance.type.slug == "ddq"
+                and instance.type.allow_empty_author
                 and not instance.author
             ):
                 custom_instance_buttons.add(bt.ActionButton(key="edit", label="Edit", icon=WBIcon.EDIT.icon))

{wbwriter-1.54.17 → wbwriter-1.59.4}/wbwriter/viewsets/menu.py

@@ -15,15 +15,6 @@ WRITER_MENU = Menu(
                 method=lambda request: is_internal_user(request.user), permissions=["wbwriter.view_article"]
             ),
         ),
-        # MenuItem(
-        #     label="DDQ",
-        #     endpoint="wbwriter:ddq-list",
-        #     add=MenuItem(
-        #         label="Create a DDQ related entry",
-        #         endpoint="wbwriter:ddq-list",
-        #     ),
-        #     permission=ItemPermission(permissions=["wbwriter.view_article"]),
-        # ),
         MenuItem(
             label="Articles to review",
             endpoint="wbwriter:review-article-list",