Cleanup RichTextBlockWithFootnotes (#2)

* Cleanup RichTextBlockWithFootnotes

* Make sure we have a context to work from and add a comment

* Remove unnecessary step from readme

* Add footnotes as a feature when using RichTextBlockWithFootnotes

* Update changelog

Author: Cameron Lamb

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+- Clean up old step from README - It is no longer recommended to define footnotes in `WAGTAILADMIN_RICH_TEXT_EDITORS`
+- Add `footnotes` rich text feature automatically
+- Clean up `RichTextBlockWithFootnotes`
+
 ## 0.6.0
 
 - Add `WAGTAIL_FOOTNOTES_TEXT_FEATURES` to add custom rich text features to footnote content

README.md

@@ -33,15 +33,6 @@ Add footnotes functionality to your Wagtail project.
  - Update your `RichTextBlock`s 
     - Add `"footnotes"` to the `features` arg for each `RichTextBlock` that you want to have this functionality
     - You will also need to change any `RichTextBlock`s to `wagtail_footnotes.blocks.RichTextBlockWithFootnotes`
-    - You can add the footnotes to `RichTextBlock`s across the project by updating `WAGTAILADMIN_RICH_TEXT_EDITORS["default"]["OPTIONS"]["features"]`:
-      ```python
-      WAGTAILADMIN_RICH_TEXT_EDITORS = {
-          "default": {
-              "WIDGET": "wagtail.admin.rich_text.DraftailRichTextArea",
-              "OPTIONS": {"features": ["bold", "italic", "h3", "h4", "ol", "ul", "link", "footnotes"]},
-          }
-      }
-      ```
  - Update your page templates to include `{% include "wagtail_footnotes/includes/footnotes.html" %}`
  - Make and run migrations:
    ```

wagtail_footnotes/blocks.py

@@ -16,14 +16,32 @@ class RichTextBlockWithFootnotes(RichTextBlock):
     final template context.
     """
 
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+        self.features += "footnotes"
+
     def replace_footnote_tags(self, 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 "page" not in new_context:
+            return html
+
+        page = new_context["page"]
+        if not hasattr(page, "footnotes_list"):
+            page.footnotes_list = []
+        self.footnotes = {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'<a href="#footnote-{index}" id="footnote-source-{index}"><sup>[{index}]</sup></a>'
+
         return mark_safe(FIND_FOOTNOTE_TAG.sub(replace_tag, html))
 
     def render(self, value, context=None):
@@ -39,13 +57,8 @@ def render_basic(self, value, context=None):
         return self.replace_footnote_tags(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