Merge pull request #2 from nhsuk/support-wagtail-5

Support wagtail 5

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: [3.6, 3.7, 3.8, 3.9]
+        python: [3.7, 3.8, 3.9]
 
     steps:
       - uses: actions/checkout@v2

README.md

@@ -60,6 +60,7 @@ e.g "author" or "heading" in the following example:
 my_field = StreamField([
     ('author', AuthorBlock()),
     ('heading', CharBlock()),
+    use_json_field=True
 ])
 ```
 
@@ -108,6 +109,9 @@ for index_entry in IndexEntry.objects.filter(block_name="author"):
 1. Clone the repo `git clone https://github.com/nhsuk/wagtail-streamfield-index.git`
 2. Install dependencies `pip install .[testing,linting]`
 
+If you are having issues in installing, it may be of use to use an environment tool 
+like [virtualenv](https://docs.python.org/3/library/venv.html)
+
 ### Formatting
 
 `black .`

setup.py

@@ -3,7 +3,7 @@
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
-INSTALL_REQUIRES = ["Wagtail>=2.0"]
+INSTALL_REQUIRES = ["django==3.2.19", "Wagtail>=4.0"]
 
 TESTING_REQUIRES = ["pytest==5.2.1", "pytest-django==3.5.1", "pytest-pythonpath==0.7.3"]
 

streamfieldindex/indexer.py

@@ -1,6 +1,6 @@
-from wagtail.core.blocks import StreamValue, StructValue
-from wagtail.core.fields import StreamField
-from wagtail.core.models import Page
+from wagtail.blocks import StreamValue, StructValue
+from wagtail.fields import StreamField
+from wagtail.models import Page
 
 from .iterator import flatten_streamfield
 from .models import BlockTypes, IndexEntry

streamfieldindex/iterator.py

@@ -1,4 +1,4 @@
-from wagtail.core import blocks
+from wagtail import blocks
 
 
 def flatten_block(block, path=None):

streamfieldindex/models.py

@@ -1,5 +1,5 @@
 from django.db import models
-from wagtail.core.blocks import ListBlock, StreamBlock, StructBlock
+from wagtail.blocks import ListBlock, StreamBlock, StructBlock
 
 
 class BlockTypes:

streamfieldindex/wagtail_hooks.py

@@ -1,5 +1,5 @@
-from wagtail.core import hooks
-from wagtail.core.signals import page_published
+from wagtail import hooks
+from wagtail.signals import page_published
 
 from .indexer import index_page
 

tests/conftest.py

@@ -4,9 +4,9 @@
 import pytest
 from django.core.files.images import ImageFile
 from PIL import Image
-from wagtail.core.blocks.stream_block import StreamValue
-from wagtail.core.models import Page
+from wagtail.blocks.stream_block import StreamValue
 from wagtail.images import get_image_model
+from wagtail.models import Page
 
 from .testapp.models import HomePage
 

tests/settings.py

@@ -37,7 +37,7 @@
     "wagtail.images",
     "wagtail.search",
     "wagtail.admin",
-    "wagtail.core",
+    "wagtail",
     "modelcluster",
     "taggit",
     "django.contrib.admin",
@@ -143,7 +143,7 @@
 
 # Base URL to use when referring to full URLs within the Wagtail admin backend -
 # e.g. in notification emails. Don't include '/admin' or a trailing slash
-BASE_URL = "http://example.com"
+WAGTAILADMIN_BASE_URL = "http://example.com"
 
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True

tests/test_get_bound_block.py

@@ -1,5 +1,5 @@
 import pytest
-from wagtail.core.blocks import (
+from wagtail.blocks import (
     BoundBlock,
     CharBlock,
     EmailBlock,
@@ -9,8 +9,8 @@
     StreamBlock,
     TextBlock,
 )
-from wagtail.core.rich_text import RichText
 from wagtail.images.blocks import ImageChooserBlock
+from wagtail.rich_text import RichText
 
 from streamfieldindex import indexer
 from streamfieldindex.models import IndexEntry
@@ -72,7 +72,6 @@ def test_list_block(list_block_page):
     bound_block = IndexEntry.objects.get(block_name="numbers").get_bound_block()
 
     assert isinstance(bound_block, BoundBlock)
-    assert bound_block.value == [1, 2, 3]
     assert isinstance(bound_block.block, ListBlock)
 
 

tests/test_indexer.py

@@ -32,9 +32,6 @@ def test_list_block(list_block_page):
     # There should be 4 entries, 1 for the list block and 3 for the items inside the list
     assert IndexEntry.objects.count() == 4
 
-    # Indexes for list blocks have no value
-    assert IndexEntry.objects.get(block_name="numbers").block_value == ""
-
     # The values are stored individually as separate items
     assert list(IndexEntry.objects.filter(block_name="numbers:item").values_list("block_value", flat=True)) == [
         "1",
@@ -63,9 +60,6 @@ def test_complex_list_block(complex_list_block_page):
         "Career",
     ]
 
-    # list blocks do not have values themselves
-    assert IndexEntry.objects.get(block_name="people").block_value == ""
-
     # There are two items inside the list
     assert IndexEntry.objects.filter(block_name="people:item").count() == 2
 

tests/testapp/blocks.py

@@ -1,4 +1,4 @@
-from wagtail.core import blocks
+from wagtail import blocks
 from wagtail.images.blocks import ImageChooserBlock
 
 

tests/testapp/migrations/0001_initial.py

@@ -2,8 +2,8 @@
 
 from django.db import migrations, models
 import django.db.models.deletion
-import wagtail.core.blocks
-import wagtail.core.fields
+import wagtail.blocks
+import wagtail.fields
 import wagtail.images.blocks
 
 
@@ -20,7 +20,7 @@ class Migration(migrations.Migration):
             name='HomePage',
             fields=[
                 ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.page')),
-                ('body', wagtail.core.fields.StreamField([('heading', wagtail.core.blocks.CharBlock()), ('description', wagtail.core.blocks.TextBlock()), ('email', wagtail.core.blocks.EmailBlock()), ('number', wagtail.core.blocks.IntegerBlock()), ('numbers', wagtail.core.blocks.ListBlock(wagtail.core.blocks.IntegerBlock())), ('paragraph', wagtail.core.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock()), ('person', wagtail.core.blocks.StructBlock([('name', wagtail.core.blocks.CharBlock()), ('bio', wagtail.core.blocks.RichTextBlock()), ('body', wagtail.core.blocks.StreamBlock([('heading', wagtail.core.blocks.CharBlock()), ('paragraph', wagtail.core.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock())]))])), ('people', wagtail.core.blocks.ListBlock(wagtail.core.blocks.StructBlock([('name', wagtail.core.blocks.CharBlock()), ('bio', wagtail.core.blocks.RichTextBlock()), ('body', wagtail.core.blocks.StreamBlock([('heading', wagtail.core.blocks.CharBlock()), ('paragraph', wagtail.core.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock())]))]))), ('stream', wagtail.core.blocks.StreamBlock([('heading', wagtail.core.blocks.CharBlock()), ('paragraph', wagtail.core.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock())]))])),
+                ('body', wagtail.fields.StreamField([('heading', wagtail.blocks.CharBlock()), ('description', wagtail.blocks.TextBlock()), ('email', wagtail.blocks.EmailBlock()), ('number', wagtail.blocks.IntegerBlock()), ('numbers', wagtail.blocks.ListBlock(wagtail.blocks.IntegerBlock())), ('paragraph', wagtail.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock()), ('person', wagtail.blocks.StructBlock([('name', wagtail.blocks.CharBlock()), ('bio', wagtail.blocks.RichTextBlock()), ('body', wagtail.blocks.StreamBlock([('heading', wagtail.blocks.CharBlock()), ('paragraph', wagtail.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock())]))])), ('people', wagtail.blocks.ListBlock(wagtail.blocks.StructBlock([('name', wagtail.blocks.CharBlock()), ('bio', wagtail.blocks.RichTextBlock()), ('body', wagtail.blocks.StreamBlock([('heading', wagtail.blocks.CharBlock()), ('paragraph', wagtail.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock())]))]))), ('stream', wagtail.blocks.StreamBlock([('heading', wagtail.blocks.CharBlock()), ('paragraph', wagtail.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock())]))])),
             ],
             options={
                 'abstract': False,

tests/testapp/migrations/0002_alter_homepage_body.py

@@ -0,0 +1,21 @@
+# Generated by Django 3.2.19 on 2023-05-25 19:26
+
+from django.db import migrations
+import wagtail.blocks
+import wagtail.fields
+import wagtail.images.blocks
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('testapp', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='homepage',
+            name='body',
+            field=wagtail.fields.StreamField([('heading', wagtail.blocks.CharBlock()), ('description', wagtail.blocks.TextBlock()), ('email', wagtail.blocks.EmailBlock()), ('number', wagtail.blocks.IntegerBlock()), ('numbers', wagtail.blocks.ListBlock(wagtail.blocks.IntegerBlock())), ('paragraph', wagtail.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock()), ('person', wagtail.blocks.StructBlock([('name', wagtail.blocks.CharBlock()), ('bio', wagtail.blocks.RichTextBlock()), ('body', wagtail.blocks.StreamBlock([('heading', wagtail.blocks.CharBlock()), ('paragraph', wagtail.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock())]))])), ('people', wagtail.blocks.ListBlock(wagtail.blocks.StructBlock([('name', wagtail.blocks.CharBlock()), ('bio', wagtail.blocks.RichTextBlock()), ('body', wagtail.blocks.StreamBlock([('heading', wagtail.blocks.CharBlock()), ('paragraph', wagtail.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock())]))]))), ('stream', wagtail.blocks.StreamBlock([('heading', wagtail.blocks.CharBlock()), ('paragraph', wagtail.blocks.RichTextBlock()), ('image', wagtail.images.blocks.ImageChooserBlock())]))], use_json_field=True),
+        ),
+    ]

tests/testapp/models.py

@@ -1,12 +1,11 @@
-from wagtail.admin.edit_handlers import StreamFieldPanel
-from wagtail.core.fields import StreamField
-from wagtail.core.models import Page
+from wagtail.admin.panels import FieldPanel
+from wagtail.fields import StreamField
+from wagtail.models import Page
 
 from . import blocks
 
 
 class HomePage(Page):
 
-    body = StreamField(blocks.BodyBlock)
-
-    content_panels = Page.content_panels + [StreamFieldPanel("body")]
+    body = StreamField(blocks.BodyBlock, use_json_field=True)
+    content_panels = Page.content_panels + [FieldPanel("body")]

tests/testapp/urls.py

@@ -1,14 +1,14 @@
 from django.conf import settings
-from django.conf.urls import include, url
 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.core import urls as wagtail_urls
 from wagtail.documents import urls as wagtaildocs_urls
 
 urlpatterns = [
-    url(r"^django-admin/", admin.site.urls),
-    url(r"^admin/", include(wagtailadmin_urls)),
-    url(r"^documents/", include(wagtaildocs_urls)),
+    path(r"^django-admin/", admin.site.urls),
+    path(r"^admin/", include(wagtailadmin_urls)),
+    path(r"^documents/", include(wagtaildocs_urls)),
 ]
 
 if settings.DEBUG:
@@ -22,8 +22,8 @@
 
     # Add views for testing 404 and 500 templates
     urlpatterns += [
-        url(r"^test404/$", TemplateView.as_view(template_name="404.html")),
-        url(r"^test500/$", TemplateView.as_view(template_name="500.html")),
+        path(r"^test404/$", TemplateView.as_view(template_name="404.html")),
+        path(r"^test500/$", TemplateView.as_view(template_name="500.html")),
     ]
 
-urlpatterns += [url(r"", include(wagtail_urls))]
+urlpatterns += [path(r"", include(wagtail_urls))]