Build BlogPosting JSON-LD as Python dict instead of in template

Author: kevinhowbrook

tbx/blog/models.py

@@ -228,6 +228,47 @@ def first_author(self):
             return author.author
         return None
 
+    def get_blog_posting_jsonld(self, request):
+        """Build the BlogPosting JSON-LD structured data as a dict."""
+        data = {
+            "@context": "https://schema.org",
+            "@type": "BlogPosting",
+            "mainEntityOfPage": {
+                "@type": "WebPage",
+                "@id": self.get_full_url(request),
+            },
+            "headline": self.title,
+            "description": self.search_description or self.listing_summary or "",
+            "publisher": {
+                "@type": "Organization",
+                "name": "Torchbox",
+                "logo": {
+                    "@type": "ImageObject",
+                    "url": f"{request.site.root_url}/apple-touch-icon.png",
+                },
+            },
+            "datePublished": self.date.isoformat(),
+            "dateModified": (
+                self.last_published_at.date().isoformat()
+                if self.last_published_at
+                else self.date.isoformat()
+            ),
+        }
+
+        if self.feed_image:
+            data["image"] = self.feed_image.get_rendition("width-1200|format-webp").url
+
+        if self.first_author:
+            author_data = {
+                "@type": "Person",
+                "name": self.first_author.name,
+            }
+            if self.first_author.person_page:
+                author_data["url"] = self.first_author.person_page.get_full_url(request)
+            data["author"] = author_data
+
+        return data
+
     @property
     def read_time(self):
         if self.body_word_count:

tbx/blog/templatetags/__init__.py

@@ -0,0 +1,17 @@
+import json
+
+from django import template
+from django.utils.safestring import mark_safe
+
+
+register = template.Library()
+
+
+@register.simple_tag(takes_context=True)
+def blog_posting_jsonld(context):
+    """Return the BlogPosting JSON-LD structured data as JSON."""
+    page = context.get("page")
+    request = context.get("request")
+    if page and hasattr(page, "get_blog_posting_jsonld") and request:
+        return mark_safe(json.dumps(page.get_blog_posting_jsonld(request), indent=4))  # noqa: S308
+    return ""

tbx/blog/templatetags/blog_tags.py

@@ -1,4 +1,7 @@
+import json
+
 from django import template
+from django.utils.safestring import mark_safe
 from django.utils.text import camel_case_to_spaces, slugify
 
 from wagtail.blocks import StreamValue
@@ -9,6 +12,12 @@
 register = template.Library()
 
 
+@register.filter(name="json")
+def json_filter(value):
+    """Serialize a value to JSON."""
+    return mark_safe(json.dumps(value, indent=4))  # noqa: S308
+
+
 # Social text
 @register.filter(name="social_text")
 def social_text(page, site):

tbx/core/templatetags/util_tags.py

@@ -1,29 +1,4 @@
-{% load wagtailcore_tags wagtailimages_tags %}
+{% load blog_tags %}
 <script type="application/ld+json">
-    {
-        "@context": "https://schema.org",
-        "@type": "BlogPosting",
-        "mainEntityOfPage": {
-            "@type": "WebPage",
-            "@id": "{% fullpageurl page %}"
-        },
-        "headline": "{{ page.title|escapejs }}",
-        "description": "{% if page.search_description %}{{ page.search_description|escapejs }}{% elif page.listing_summary %}{{ page.listing_summary|escapejs }}{% endif %}"{% if page.feed_image %},
-            "image": "{% image page.feed_image format-webp width-1200 as blog_image %}{{ blog_image.url }}"{% endif %}{% if page.first_author %},
-                "author": {
-                    "@type": "Person",
-                    "name": "{{ page.first_author.name|escapejs }}"{% if page.first_author.person_page %},
-                        "url": "{% fullpageurl page.first_author.person_page %}"{% endif %}
-                }{% endif %},
-        "publisher": {
-            "@type": "Organization",
-            "name": "Torchbox",
-            "logo": {
-                "@type": "ImageObject",
-                "url": "{% wagtail_site as current_site %}{{ current_site.root_url }}/apple-touch-icon.png"
-            }
-        },
-        "datePublished": "{{ page.date|date:'Y-m-d' }}",
-        "dateModified": "{% if page.last_published_at %}{{ page.last_published_at|date:'Y-m-d' }}{% else %}{{ page.date|date:'Y-m-d' }}{% endif %}"
-    }
+    {% blog_posting_jsonld %}
 </script>