Chore/update tooling

.github/workflows/python-tox.yml

@@ -5,57 +5,20 @@ on: [push, pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
-    services:
-      postgres:
-        image: postgres
-        env:
-          POSTGRES_PASSWORD: secret
-          POSTGRES_USER: wagtail_factories
-          POSTGRES_DB: wagtail_factories
-        options: >-
-          --health-cmd pg_isready
-          --health-interval 10s
-          --health-timeout 5s
-          --health-retries 5
-        ports:
-          - 5432:5432
 
     strategy:
-      max-parallel: 4
       matrix:
-        python-version:
-          - {version: 3.7, tox: 37}
-          - {version: 3.8, tox: 38}
-          - {version: 3.9, tox: 39}
-          - {version: '3.10', tox: 310}
-          - {version: '3.11', tox: 311}
-        django: [32, 40, 41]
-        wagtail: [41, 42, 50]
-        factoryboy: [32]
-        exclude:
-          - python-version: {version: 3.7, tox: 37}
-            django: 40
-          - python-version: {version: 3.7, tox: 37}
-            django: 41
-          - python-version: {version: '3.11', tox: 311}
-            django: 40
-          - python-version: {version: '3.11', tox: 311}
-            django: 32
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
-        python-version: ${{ matrix.python-version.version }}
+        python-version: ${{ matrix.python-version }}
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip tox
+        python -m pip install --upgrade pip
+        python -m pip install tox tox-gh-actions
     - name: Test with tox
-      env:
-        TEST_DB_NAME: wagtail_factories
-        TEST_DB_USER: wagtail_factories
-        TEST_DB_PASSWORD: secret
-        TOX_ENV: "py${{ matrix.python-version.tox }}-django${{ matrix.django }}-wagtail${{ matrix.wagtail }}-factoryboy${{ matrix.factoryboy }}"
-      run: |
-        tox -e $TOX_ENV
+      run: tox

CHANGES

@@ -1,5 +1,11 @@
 Unreleased
 ==========
+- Update for Wagtail >5.1
+- Drop support for Django <4.2
+- Drop support for Wagtail <5.2
+- Add support for Django 5
+- Add support for Wagtail 6
+- Add support for Python 3.12
 
 4.1.0
 =====

MANIFEST.in

@@ -4,7 +4,7 @@ recursive-exclude * *
 
 graft src/wagtail_factories
 
-include README.rst
+include README.md
 include CHANGES
 include setup.py
 

README.md

@@ -0,0 +1,180 @@
+# wagtail-factories
+
+
+Factory boy classes for Wagtail CMS
+
+## Status
+
+[![image](https://readthedocs.org/projects/wagtail-factories/badge/?version=latest)](https://readthedocs.org/projects/wagtail-factories/)
+[![image](https://github.com/wagtail/wagtail-factories/workflows/Python%20Tests/badge.svg)](https://github.com/wagtail/wagtail-factories/actions?query=workflow%3A%22Python+Tests%22)
+[![image](https://img.shields.io/pypi/v/wagtail-factories.svg)](https://pypi.python.org/pypi/wagtail-factories/)
+
+## Installation
+
+``` shell
+pip install wagtail-factories
+```
+
+## Usage
+
+Documentation is still in progress, but see the
+[tests](https://github.com/wagtail/wagtail-factories/tree/main/tests)
+for more examples.
+
+``` python
+import wagtail_factories
+from . import models
+
+
+class MyCarouselItemFactory(wagtail_factories.StructBlockFactory):
+    label = 'my-label'
+    image = factory.SubFactory(
+        wagtail_factories.ImageChooserBlockFactory)
+
+    class Meta:
+        model = models.MyBlockItem
+
+
+class MyCarouselFactory(wagtail_factories.StructBlockFactory):
+    title = "Carousel title"
+    items = wagtail_factories.ListBlockFactory(
+        MyCarouselItemFactory)
+
+    class Meta:
+        model = models.MyCarousel
+
+
+class MyNewsPageFactory(wagtail_factories.PageFactory):
+    class Meta:
+        model = models.MyNewsPage
+
+
+class MyNewsPageChooserBlockFactory(wagtail_factories.PageChooserBlockFactory):
+    page = factory.SubFactory(MyNewsPageFactory)
+
+
+class MyTestPageFactory(wagtail_factories.PageFactory):
+    body = wagtail_factories.StreamFieldFactory({
+        'carousel': factory.SubFactory(MyCarouselFactory),
+        'news_page': factory.SubFactory(MyNewsPageChooserBlockFactory),
+    })
+
+    class Meta:
+        model = models.MyTestPage
+
+
+def test_my_page():
+    root_page = wagtail_factories.PageFactory(parent=None)
+    my_page = MyTestPageFactory(
+        parent=root_page,
+        body__0__carousel__items__0__label='Slide 1',
+        body__0__carousel__items__0__image__image__title='Image Slide 1',
+        body__0__carousel__items__1__label='Slide 2',
+        body__0__carousel__items__1__image__image__title='Image Slide 2',
+        body__0__carousel__items__2__label='Slide 3',
+        body__0__carousel__items__2__image__image__title='Image Slide 3',
+        body__1__news_page__page__title="News",
+    )
+```
+
+### Using StreamBlockFactory
+
+`StreamBlockFactory` can be used in conjunction with the other block
+factory types to create complex, nested `StreamValues`, much like how
+`StreamBlock` can be used to declare the blocks for a complex
+`StreamField`.
+
+First, define your `StreamBlockFactory` subclass, using
+`factory.SubFactory` to wrap child block declarations. Be sure to
+include your `StreamBlock` subclass as the model attribute on the inner
+`Meta` class.
+
+``` python
+class MyStreamBlockFactory(wagtail_factories.StreamBlockFactory):
+    my_struct_block = factory.SubFactory(MyStructBlockFactory)
+
+    class Meta:
+        model = MyStreamBlock
+```
+
+Then include your `StreamBlockFactory` subclass on a model factory as
+the argument to a `StreamFieldFactory`.
+
+``` python
+class MyPageFactory(wagtail_factories.PageFactory):
+    body = wagtail_factories.StreamFieldFactory(MyStreamBlockFactory)
+
+    class Meta:
+        model = MyPage
+```
+
+You can then use a modified version of factory\_boy\'s deep object
+declaration syntax to build up `StreamValues` on the fly.
+
+``` python
+MyPageFactory(
+    body__0__my_struct_block__some_field="some value",
+    body__0__my_struct_block__some_other_field="some other value",
+)
+```
+
+To generate the default value for a block factory, terminate your
+declaration at the index and provide the block name as the value.
+
+``` python
+MyPageFactory(body__0="my_struct_block")
+```
+
+### Alternative StreamFieldFactory declaration syntax
+
+Prior to version 3.0, `StreamFieldFactory` could only be used by
+providing a dict mapping block names to block factory classes as the
+single argument, for example:
+
+``` python
+class MyTestPageWithStreamFieldFactory(wagtail_factories.PageFactory):
+    body = wagtail_factories.StreamFieldFactory(
+        {
+            "char_array": wagtail_factories.ListBlockFactory(
+                wagtail_factories.CharBlockFactory
+            ),
+            "int_array": wagtail_factories.ListBlockFactory(
+                wagtail_factories.IntegerBlockFactory
+            ),
+            "struct": MyBlockFactory,
+            "image": wagtail_factories.ImageChooserBlockFactory,
+        }
+    )
+
+    class Meta:
+        model = models.MyTestPage
+```
+
+This style of declaration is still supported, with the caveat that
+nested stream blocks are not supported for this approach. From version
+3.0, all `BlockFactory` values in a `StreamFieldFactory` definition of
+this style *must* be wrapped in factory\_boy `SubFactories`. For
+example, the above example must be updated to the following for 3.0
+compatibility.
+
+``` python
+class MyTestPageWithStreamFieldFactory(wagtail_factories.PageFactory):
+    body = wagtail_factories.StreamFieldFactory(
+        {
+            "char_array": wagtail_factories.ListBlockFactory(
+                wagtail_factories.CharBlockFactory
+            ),
+            "int_array": wagtail_factories.ListBlockFactory(
+                wagtail_factories.IntegerBlockFactory
+            ),
+            "struct": factory.SubFactory(MyBlockFactory),
+            "image": factory.SubFactory(wagtail_factories.ImageChooserBlockFactory),
+        }
+    )
+
+    class Meta:
+        model = models.MyTestPage
+```
+
+This requirement does *not* apply to `ListBlockFactory`, which is a
+subclass of `SubFactory`.