',
+ },
+ ]
+ ),
+ )
+ home_page.add_child(instance=self.test_page_with_footnote)
+ self.test_page_with_footnote.save_revision().publish()
+ self.footnote = Footnote.objects.create(
+ page=self.test_page_with_footnote,
+ uuid=uuid,
+ text="This is a footnote",
+ )
+
+ self.admin_user = User.objects.create_superuser(
+ username="admin", email="", password="password" # noqa: S106
+ )
+
+ def test_no_footnote(self):
+ response = self.client.get("/test-page-no-footnote/")
+ self.assertEqual(response.status_code, 200)
+
+ soup = bs4(response.content, "html.parser")
+
+ # test that these html tags are not present
+ self.assertEqual(soup.find("sup"), None)
+ self.assertEqual(soup.find("a"), None)
+ self.assertEqual(soup.find("div", {"class": "footnotes"}), None)
+ self.assertEqual(soup.find("ol"), None)
+ self.assertEqual(soup.find("li"), None)
+ self.assertEqual(soup.find("p").text, "This is a paragraph with no footnote.")
+
+ def test_with_footnote(self):
+ response = self.client.get("/test-page-with-footnote/")
+ self.assertEqual(response.status_code, 200)
+
+ soup = bs4(response.content, "html.parser")
+
+ # Test that required html tags are present with correct
+ # attrs that enable the footnotes to respond to clicks
+ source_anchor = soup.find("a", {"id": "footnote-source-1"})
+ self.assertTrue(source_anchor)
+
+ source_anchor_string = str(source_anchor)
+ self.assertIn("[1]", source_anchor_string)
+ self.assertIn('href="#footnote-1"', source_anchor_string)
+ self.assertIn('id="footnote-source-1"', source_anchor_string)
+
+ footnotes = soup.find("div", {"class": "footnotes"})
+ self.assertTrue(footnotes)
+
+ footnotes_string = str(footnotes)
+ self.assertIn('id="footnote-1"', footnotes_string)
+ self.assertIn('href="#footnote-source-1"', footnotes_string)
+ self.assertIn("[1] This is a footnote", footnotes_string)
+
+ def test_edit_page_with_footnote(self):
+ self.client.force_login(self.admin_user)
+
+ response = self.client.get(
+ f"/admin/pages/{self.test_page_with_footnote.id}/edit/"
+ )
+
+ data_block = (
+ response.context["form"]
+ .fields["body"]
+ .get_bound_field(response.context["form"], "body")
+ )
+ soup = bs4(str(data_block), "html.parser")
+
+ # Test that the footnote uuid is present in the html
+ self.assertIn(self.footnote.uuid, str(soup))
diff --git a/tests/test/test_hooks.py b/tests/test/test_hooks.py
new file mode 100644
index 0000000..cbc2ce2
--- /dev/null
+++ b/tests/test/test_hooks.py
@@ -0,0 +1,25 @@
+from django.test import TestCase
+
+from wagtail_footnotes.wagtail_hooks import (
+ FootnotesEntityElementHandler,
+ footnotes_entity_decorator,
+)
+
+
+class TestHooks(TestCase):
+ def test_footnotes_entity_decorator(self):
+ props = {"footnote": "1", "children": ""}
+ dom = footnotes_entity_decorator(props)
+ self.assertEqual(dom.type, "footnote")
+ self.assertEqual(dom.children, [])
+
+ def test_footnotes_entity_decorator_with_children(self):
+ props = {"footnote": "1", "children": "This is a footnote"}
+ dom = footnotes_entity_decorator(props)
+ self.assertEqual(dom.type, "footnote")
+ self.assertEqual(dom.children, ["This is a footnote"])
+
+ def test_footnotes_entity_element_handler(self):
+ attrs = {"id": "1ahyt67", "footnote": "1"}
+ element = FootnotesEntityElementHandler(attrs)
+ self.assertEqual(element.get_attribute_data(attrs), {"footnote": "1ahyt67"})
diff --git a/tests/test/test_widgets.py b/tests/test/test_widgets.py
new file mode 100644
index 0000000..ce2b163
--- /dev/null
+++ b/tests/test/test_widgets.py
@@ -0,0 +1,18 @@
+from django import forms
+from django.test import TestCase
+
+from wagtail_footnotes.widgets import ReadonlyUUIDInput
+
+
+class TestWidgets(TestCase):
+ def test_read_only_uuid_input(self):
+ form = forms.Form()
+ form.fields["uuid"] = forms.CharField(widget=ReadonlyUUIDInput)
+ self.assertInHTML(
+ '',
+ form.as_p(),
+ )
+ self.assertInHTML(
+ '',
+ form.as_p(),
+ )
diff --git a/tests/urls.py b/tests/urls.py
new file mode 100644
index 0000000..2417fa8
--- /dev/null
+++ b/tests/urls.py
@@ -0,0 +1,16 @@
+from django.contrib import admin
+from django.urls import include, path
+from wagtail import urls as wagtail_urls
+from wagtail.admin import urls as wagtailadmin_urls
+from wagtail.documents import urls as wagtaildocs_urls
+
+from wagtail_footnotes import urls as footnotes_urls
+
+
+urlpatterns = [
+ path("django-admin/", admin.site.urls),
+ path("admin/", include(wagtailadmin_urls)),
+ path("documents/", include(wagtaildocs_urls)),
+ path("footnotes/", include(footnotes_urls)),
+ path("", include(wagtail_urls)),
+]
diff --git a/tox.ini b/tox.ini
new file mode 100644
index 0000000..c2fd6d5
--- /dev/null
+++ b/tox.ini
@@ -0,0 +1,47 @@
+[tox]
+min_version = 4.0
+
+envlist =
+ python{3.8,3.9,3.10}-django{3.2}-wagtail{4.1,5.1,5.2}
+ python{3.9,3.10,3.11}-django{4.1}-wagtail{4.1,5.1,5.2}
+ python{3.10,3.11}-django{4.2}-wagtail{5.1,5.2}
+ python3.12-django4.2-wagtail5.2
+
+[gh-actions]
+python =
+ 3.8: python3.8
+ 3.9: python3.9
+ 3.10: python3.10
+ 3.11: python3.11
+ 3.12: python3.12
+
+
+[testenv]
+package = wheel
+wheel_build_env = .pkg
+
+pass_env =
+ FORCE_COLOR
+ NO_COLOR
+
+deps =
+ coverage[toml]>=7.2,<8.0
+
+ django3.2: Django>=3.2,<4.0
+ django4.1: Django>=4.1,<4.2
+ django4.2: Django>=4.2,<4.3
+
+ wagtail4.1: wagtail>=4.1,<4.2
+ wagtail5.1: wagtail>=5.1,<5.2
+ wagtail5.2: wagtail>=5.2,<5.3
+
+
+install_command = python -Im pip install -U {opts} {packages}
+commands =
+ python -Im coverage run testmanage.py test --deprecation all {posargs: -v 2}
+
+
+[testenv:coverage-report]
+commands =
+ python -Im coverage combine
+ python -Im coverage report -m
diff --git a/wagtail_footnotes/__init__.py b/wagtail_footnotes/__init__.py
index e69de29..6c0877e 100644
--- a/wagtail_footnotes/__init__.py
+++ b/wagtail_footnotes/__init__.py
@@ -0,0 +1,3 @@
+VERSION = (0, 10, 0)
+
+__version__ = ".".join(map(str, VERSION))
diff --git a/wagtail_footnotes/apps.py b/wagtail_footnotes/apps.py
new file mode 100644
index 0000000..7746eb5
--- /dev/null
+++ b/wagtail_footnotes/apps.py
@@ -0,0 +1,8 @@
+from django.apps import AppConfig
+
+
+class WagtailFootnotesAppConfig(AppConfig):
+ label = "wagtail_footnotes"
+ name = "wagtail_footnotes"
+ verbose_name = "Wagtail Footnotes"
+ default_auto_field = "django.db.models.AutoField"
diff --git a/wagtail_footnotes/blocks.py b/wagtail_footnotes/blocks.py
index c2152a5..4157de1 100644
--- a/wagtail_footnotes/blocks.py
+++ b/wagtail_footnotes/blocks.py
@@ -2,7 +2,10 @@
from django.core.exceptions import ValidationError
from django.utils.safestring import mark_safe
-from wagtail.core.blocks import RichTextBlock
+from wagtail import VERSION as WAGTAIL_VERSION
+from wagtail.blocks import RichTextBlock
+from wagtail.models import Page
+
FIND_FOOTNOTE_TAG = re.compile(r'.*?')
@@ -16,36 +19,57 @@ class RichTextBlockWithFootnotes(RichTextBlock):
final template context.
"""
- def replace_footnote_tags(self, html, context=None):
+ def __init__(self, **kwargs):
+ super().__init__(**kwargs)
+ if not self.features:
+ self.features = []
+ if "footnotes" not in self.features:
+ self.features.append("footnotes")
+
+ def replace_footnote_tags(self, value, html, context=None):
+ if context is None:
+ new_context = self.get_context(value)
+ else:
+ new_context = self.get_context(value, parent_context=dict(context))
+
+ if not isinstance(new_context.get("page"), Page):
+ return html
+
+ page = new_context["page"]
+ if not hasattr(page, "footnotes_list"):
+ page.footnotes_list = []
+ self.footnotes = {
+ str(footnote.uuid): footnote for footnote in page.footnotes.all()
+ }
+
def replace_tag(match):
try:
- index = self.process_footnote(match.group(1), context["page"])
+ index = self.process_footnote(match.group(1), page)
except (KeyError, ValidationError):
return ""
else:
return f'[{index}]'
- return mark_safe(FIND_FOOTNOTE_TAG.sub(replace_tag, html))
+
+ # note: we return safe html
+ return mark_safe(FIND_FOOTNOTE_TAG.sub(replace_tag, html)) # noqa: S308
def render(self, value, context=None):
- if not self.get_template(context=context):
+ kwargs = {"value": value} if WAGTAIL_VERSION >= (5, 2) else {}
+
+ if not self.get_template(context=context, **kwargs):
return self.render_basic(value, context=context)
html = super().render(value, context=context)
- return self.replace_footnote_tags(html, context=context)
+ return self.replace_footnote_tags(value, html, context=context)
def render_basic(self, value, context=None):
html = super().render_basic(value, context)
- return self.replace_footnote_tags(html, context=context)
+ return self.replace_footnote_tags(value, html, context=context)
def process_footnote(self, footnote_id, page):
- footnotes = self.get_footnotes(page)
- footnote = page.footnotes.get(uuid=footnote_id)
- if footnote not in footnotes:
- footnotes.append(footnote)
- return footnotes.index(footnote) + 1
-
- def get_footnotes(self, page):
- if not hasattr(page, "footnotes_list"):
- page.footnotes_list = []
- return page.footnotes_list
+ footnote = self.footnotes[footnote_id]
+ if footnote not in page.footnotes_list:
+ page.footnotes_list.append(footnote)
+ # Add 1 to the index as footnotes are indexed starting at 1 not 0.
+ return page.footnotes_list.index(footnote) + 1
diff --git a/wagtail_footnotes/fields.py b/wagtail_footnotes/fields.py
index 9910d2a..de0bf90 100644
--- a/wagtail_footnotes/fields.py
+++ b/wagtail_footnotes/fields.py
@@ -2,7 +2,7 @@
class CustomUUIDField(UUIDField):
- """ Returns database value as a string, so that dashes are preserved. """
+ """Returns database value as a string, so that dashes are preserved."""
def from_db_value(self, value, expression, connection, context=None):
return str(value)
diff --git a/wagtail_footnotes/migrations/0001_initial.py b/wagtail_footnotes/migrations/0001_initial.py
index 7384ad4..ff64154 100644
--- a/wagtail_footnotes/migrations/0001_initial.py
+++ b/wagtail_footnotes/migrations/0001_initial.py
@@ -2,13 +2,14 @@
import django.db.models.deletion
import modelcluster.fields
-import wagtail.core.fields
-import wagtail_footnotes.fields
+import wagtail.fields as wagtail_fields
+
from django.db import migrations, models
+import wagtail_footnotes.fields
-class Migration(migrations.Migration):
+class Migration(migrations.Migration):
initial = True
dependencies = [
@@ -36,7 +37,7 @@ class Migration(migrations.Migration):
verbose_name="ID",
),
),
- ("text", wagtail.core.fields.RichTextField()),
+ ("text", wagtail_fields.RichTextField()),
(
"page",
modelcluster.fields.ParentalKey(
diff --git a/wagtail_footnotes/migrations/0003_footnote_bootstrap_migration_2.py b/wagtail_footnotes/migrations/0003_footnote_bootstrap_migration_2.py
index 4fa6503..fd3ff1c 100644
--- a/wagtail_footnotes/migrations/0003_footnote_bootstrap_migration_2.py
+++ b/wagtail_footnotes/migrations/0003_footnote_bootstrap_migration_2.py
@@ -1,15 +1,14 @@
# Generated by Django 3.1.11 on 2021-06-21 18:22
from django.db import migrations
-from wagtail.core.models import BootstrapTranslatableModel
+from wagtail.models import BootstrapTranslatableModel
class Migration(migrations.Migration):
-
dependencies = [
- ('wagtail_footnotes', '0002_footnote_bootstrap_migration'),
+ ("wagtail_footnotes", "0002_footnote_bootstrap_migration"),
]
operations = [
- BootstrapTranslatableModel('wagtail_footnotes.Footnote'),
+ BootstrapTranslatableModel("wagtail_footnotes.Footnote"),
]
diff --git a/wagtail_footnotes/migrations/0005_alter_footnote_unique_together.py b/wagtail_footnotes/migrations/0005_alter_footnote_unique_together.py
new file mode 100644
index 0000000..68dec39
--- /dev/null
+++ b/wagtail_footnotes/migrations/0005_alter_footnote_unique_together.py
@@ -0,0 +1,17 @@
+# Generated by Django 4.1.13 on 2024-01-16 17:31
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+ dependencies = [
+ ("wagtailcore", "0078_referenceindex"),
+ ("wagtail_footnotes", "0004_footnote_translatable_mixin_migration"),
+ ]
+
+ operations = [
+ migrations.AlterUniqueTogether(
+ name="footnote",
+ unique_together={("translation_key", "locale"), ("page", "uuid")},
+ ),
+ ]
diff --git a/wagtail_footnotes/models.py b/wagtail_footnotes/models.py
index 2d88b05..305af22 100644
--- a/wagtail_footnotes/models.py
+++ b/wagtail_footnotes/models.py
@@ -1,12 +1,13 @@
from django.conf import settings
from django.db import models
from modelcluster.fields import ParentalKey
-from wagtail.admin.edit_handlers import FieldPanel, InlinePanel
-from wagtail.core.fields import RichTextField
-from wagtail.core.models import TranslatableMixin
+from wagtail.admin.panels import FieldPanel
+from wagtail.fields import RichTextField
+from wagtail.models import TranslatableMixin
+
+from wagtail_footnotes.fields import CustomUUIDField
+from wagtail_footnotes.widgets import ReadonlyUUIDInput
-from .fields import CustomUUIDField
-from .widgets import ReadonlyUUIDInput
class Footnote(TranslatableMixin, models.Model):
"""
@@ -23,13 +24,15 @@ class Footnote(TranslatableMixin, models.Model):
)
text = RichTextField(
features=getattr(
- settings,
- 'WAGTAIL_FOOTNOTES_TEXT_FEATURES',
- ["bold", "italic", "link"]
+ settings, "WAGTAIL_FOOTNOTES_TEXT_FEATURES", ["bold", "italic", "link"]
)
)
panels = [FieldPanel("text"), FieldPanel("uuid", widget=ReadonlyUUIDInput)]
class Meta(TranslatableMixin.Meta):
+ unique_together = [("page", "uuid"), ("translation_key", "locale")]
verbose_name = "Translatable Footnote"
+
+ def __str__(self):
+ return str(self.uuid)
diff --git a/wagtail_footnotes/static/footnotes/js/footnotes.js b/wagtail_footnotes/static/footnotes/js/footnotes.js
index 0e79c47..ae1ff2d 100644
--- a/wagtail_footnotes/static/footnotes/js/footnotes.js
+++ b/wagtail_footnotes/static/footnotes/js/footnotes.js
@@ -47,19 +47,19 @@ class FootnoteSource extends React.Component {
table.empty();
var live_footnotes = document.querySelectorAll(
- "#id_footnotes-FORMS > li:not(.deleted)"
+ "#id_footnotes-FORMS .w-panel"
);
Array.prototype.forEach.call(live_footnotes, function (value) {
var text = $(".public-DraftEditor-content", value).text();
var uuid = $('input[id*="-uuid"]', value)[0].value;
var row = $(
"
" +
- text +
- "
" +
- uuid.substring(0, 6) +
- "
"
+ uuid +
+ ">
" +
+ text +
+ "
" +
+ uuid.substring(0, 6) +
+ "
"
).css({ cursor: "pointer" });
table.append(row);
@@ -112,6 +112,7 @@ class FootnoteSource extends React.Component {
}
render() {
+ console.log("FootnoteSource", this.props);
return null;
}
}
diff --git a/wagtail_footnotes/templates/wagtail_footnotes/admin/footnotes_modal.html b/wagtail_footnotes/templates/wagtail_footnotes/admin/footnotes_modal.html
index 0837abf..0f1c0d6 100644
--- a/wagtail_footnotes/templates/wagtail_footnotes/admin/footnotes_modal.html
+++ b/wagtail_footnotes/templates/wagtail_footnotes/admin/footnotes_modal.html
@@ -1,17 +1,17 @@
{% comment %}
- This template is used in wagtail CMS
+ This template is used in Wagtail CMS
{% endcomment %}
-
+
-
+
-
Choose a footnote
+
Choose a footnote
@@ -20,28 +20,30 @@
Choose a footnote
-
-
-
-
Footnotes
-
To add a new footnote, close this window and scroll to the "FOOTNOTES" section at bottom of the page.
-
-
-
-
Text
-
ID
-
-
-
+
+
+
+
+
+
+
Footnotes
+
To add a new footnote, close this window and scroll to the "FOOTNOTES" section at bottom of the page.
+
+
+
+
Text
+
ID
+
+
+
-
-
-
Footnotes will appear with arbitrary numbers here in the editor. In the published page, and in previews, their numbering will be numerical and ordered.
+
+
+
Footnotes will appear with arbitrary numbers here in the editor. In the published page, and in previews, their numbering will be numerical and ordered.