Get the project working with Wagtail 4.1+

.github/workflows/test.yml

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

.gitignore

@@ -57,3 +57,4 @@ webpack-stats.json
 
 # local virtual environment
 /venv
+/my_project

.python-version

@@ -1 +1 @@
-3.7
+3.9

CHANGELOG.rst

@@ -3,6 +3,22 @@
 History
 -------
 
+Unreleased
++++++++++++
+
+Modernise the project for later versions of python, Django and Wagtail.
+The aim is to support modern versions of Django and Wagtail and continue to use the existing tests to ensure compatibility.
+
+* Django >= 4.1, <= 4.2
+* Wagtail >= 4.1, <= 5.2
+* Python >= 3.9, <= 3.11
+* Fixes the api url to be at the root of the domain
+
+
+TODO: These are parts of the project that need further work.
+
+* Currently it may not be possible to use the longclaw.contrib apps
+
 1.0.0
 +++++++++++
 

README.md

@@ -24,9 +24,9 @@ We are working to upgrade the package for the latest versions of Django and Wagt
 
 We are currently running the tests against the following versions of Python, Django and Wagtail.
 
-- Django >= 2.2, < 3.1
-- Wagtail >= 2.11, < 2.14
-- Python >= 3.7, < 3.10
+- Django >= 4.1, <= 4.2
+- Wagtail >= 4.1, <= 5.2
+- Python >= 3.9, <= 3.11
 
 ### Developers
 

docs/tutorial/integrate.md

@@ -66,12 +66,12 @@ urlpatterns = [
 
 6. In this new app, add the following models
 
-```
+```python
 from django.db import models
 from django_extensions.db.fields import AutoSlugField
 from modelcluster.fields import ParentalKey
-from wagtail.core.models import Page, Orderable
-from wagtail.core.fields import RichTextField
+from wagtail.models import Page, Orderable
+from wagtail.fields import RichTextField
 from wagtail.admin.edit_handlers import FieldPanel, InlinePanel
 from wagtail.images.edit_handlers import ImageChooserPanel
 from longclaw.products.models import ProductVariantBase, ProductBase
@@ -138,4 +138,4 @@ We'll be building on top these basic templates in the next section.
 PRODUCT_VARIANT_MODEL = 'webshop.ProductVariant'
 PAYMENT_GATEWAY = 'longclaw.checkout.gateways.BasePayment'
 ```
-We'll be covering their function in the [setup](/docs/guide/install).
+We'll be covering their function in the [setup](/docs/guide/install).

docs/tutorial/products.md

@@ -109,11 +109,11 @@ You will need to sign in with the super user you created at the start of the tut
 
 Under 'Pages', select the root page:
 
-![Root page](assets/longclaw-select-root-page.png)
+![Root page](../assets/longclaw-select-root-page.png)
 
 On the 'Root' screen select 'Add Child Page' at the top. Here I selected my 'Home' page, but if you are running a small shop, you may wish your home page to be your product listing, in which case you might select 'Product Index'.
 
-![Adding a home page](assets/longclaw-bakery-create-product-index.png)
+![Adding a home page](../assets/longclaw-bakery-create-product-index.png)
 
 
 We can now add `Product` models as children of `ProductIndex`. Only pages of type `Product` can be created under `ProductIndex`.
@@ -127,10 +127,10 @@ Add a title, description then start adding variants.
 You will see that in the product variants are the custom fields we added for
 applying discounts.
 
-![Image of the product](assets/longclaw-bakery-add-product.png)
+![Image of the product](../assets/longclaw-bakery-add-product.png)
 
 
 If we navigate back to the product index page, we see the new product listed:
 
-![Image of the product index](assets/longclaw-bakery-product-index.png)
+![Image of the product index](../assets/longclaw-bakery-product-index.png)
 

docs/tutorial/shipping.md

@@ -21,7 +21,7 @@ using the `loadcountries` command:
 In the image below, we set a standard rate for the UK. It is possible to select multiple countries
 for a rate to apply to. We can also create more than one shipping rate for the same country.
 
-![Shipping](assets/shipping.png)
+![Shipping](../assets/shipping.png)
 
 ## Default Shipping Rate
 
@@ -37,7 +37,7 @@ To enable default shipping:
 - Fill in `Default Shipping Rate` and `Default Shipping Carrier`
 - Ensure `Enable Default Shipping` is checked.
 
-![Default shipping](assets/default_shipping.png)
+![Default shipping](../assets/default_shipping.png)
 
 ### Currency
 

longclaw/basket/signals.py

@@ -1,3 +1,3 @@
 import django.dispatch
 
-basket_modified = django.dispatch.Signal(providing_args=['basket_id'])
+basket_modified = django.dispatch.Signal('basket_id')

longclaw/basket/templates/basket/add_to_basket.html

@@ -8,11 +8,11 @@
   var btn = document.getElementById('btn-add-to-basket');
   btn.addEventListener("click", function (e) {
     longclawclient.basketList.post({
-      prefix: "{% longclaw_api_url_prefix %}",
+      prefix: "/{% longclaw_api_url_prefix %}",
       data: {
         variant_id: e.target.dataset.variantId
       }
     });
   });
 
-</script>
+</script>

longclaw/basket/tests.py

@@ -1,12 +1,10 @@
 import mock
+from io import StringIO
+
 from django.test.client import RequestFactory
 from django.test import TestCase
-try:
-    from django.urls import reverse_lazy
-except ImportError:
-    from django.core.urlresolvers import reverse_lazy
+from django.urls import reverse_lazy
 from django.core.management import call_command
-from django.utils.six import StringIO
 
 from longclaw.tests.utils import LongclawTestCase, BasketItemFactory, ProductVariantFactory, catch_signal
 from longclaw.basket.utils import basket_id

longclaw/basket/urls.py

@@ -1,4 +1,5 @@
-from django.conf.urls import url
+from django.urls import re_path
+
 from longclaw.basket import api
 from longclaw.basket import views
 from longclaw.settings import API_URL_PREFIX
@@ -23,20 +24,20 @@
 
 urlpatterns = [
 
-    url(API_URL_PREFIX + r'basket/$',
+    re_path(API_URL_PREFIX + r'basket/$',
         basket_list,
         name='longclaw_basket_list'),
-    url(API_URL_PREFIX + r'basket/count/$',
+    re_path(API_URL_PREFIX + r'basket/count/$',
         total_items,
         name="longclaw_basket_total_items"),
-    url(API_URL_PREFIX + r'basket/(?P<variant_id>[0-9]+)/$',
+    re_path(API_URL_PREFIX + r'basket/(?P<variant_id>[0-9]+)/$',
         basket_detail,
         name='longclaw_basket_detail'),
-    url(API_URL_PREFIX + r'basket/(?P<variant_id>[0-9]+)/count/$',
+    re_path(API_URL_PREFIX + r'basket/(?P<variant_id>[0-9]+)/count/$',
         item_count,
         name='longclaw_basket_item_count'),
 
-    url(r'basket/$',
+    re_path(r'basket/$',
         views.BasketView.as_view(),
         name="longclaw_basket")
 ]

longclaw/checkout/tests.py

@@ -1,12 +1,10 @@
 import uuid
-from django.utils.encoding import force_text
+from django.utils.encoding import force_str
+from django.urls import reverse_lazy
 from django.test import TestCase
 from django.test.client import RequestFactory
-from wagtail.core.models import Site
-try:
-    from django.urls import reverse_lazy
-except ImportError:
-    from django.core.urlresolvers import reverse_lazy
+
+from wagtail.models import Site
 
 from longclaw.tests.utils import (
     LongclawTestCase,
@@ -98,10 +96,10 @@ def setUp(self):
     def test_create_order_with_basket_shipping_option(self):
         amount = 11
         rate = ShippingRate.objects.create(
-            name=force_text(uuid.uuid4()),
+            name=force_str(uuid.uuid4()),
             rate=amount,
-            carrier=force_text(uuid.uuid4()),
-            description=force_text(uuid.uuid4()),
+            carrier=force_str(uuid.uuid4()),
+            description=force_str(uuid.uuid4()),
             basket_id=self.basket_id,
         )
         order = create_order(
@@ -116,10 +114,10 @@ def test_create_order_with_basket_shipping_option(self):
     def test_create_order_with_address_shipping_option(self):
         amount = 12
         rate = ShippingRate.objects.create(
-            name=force_text(uuid.uuid4()),
+            name=force_str(uuid.uuid4()),
             rate=amount,
-            carrier=force_text(uuid.uuid4()),
-            description=force_text(uuid.uuid4()),
+            carrier=force_str(uuid.uuid4()),
+            description=force_str(uuid.uuid4()),
             destination=self.shipping_address,
         )
         order = create_order(
@@ -134,10 +132,10 @@ def test_create_order_with_address_shipping_option(self):
     def test_create_order_with_address_and_basket_shipping_option(self):
         amount = 13
         rate = ShippingRate.objects.create(
-            name=force_text(uuid.uuid4()),
+            name=force_str(uuid.uuid4()),
             rate=amount,
-            carrier=force_text(uuid.uuid4()),
-            description=force_text(uuid.uuid4()),
+            carrier=force_str(uuid.uuid4()),
+            description=force_str(uuid.uuid4()),
             destination=self.shipping_address,
             basket_id=self.basket_id,
         )

longclaw/checkout/urls.py

@@ -1,21 +1,22 @@
-from django.conf.urls import url
+from django.urls import re_path
+
 from longclaw.checkout import api, views
 from longclaw.settings import API_URL_PREFIX
 
 urlpatterns = [
-    url(API_URL_PREFIX + r'checkout/$',
+    re_path(API_URL_PREFIX + r'checkout/$',
         api.capture_payment,
         name='longclaw_checkout'),
-    url(API_URL_PREFIX + r'checkout/prepaid/$',
+    re_path(API_URL_PREFIX + r'checkout/prepaid/$',
         api.create_order_with_token,
         name='longclaw_checkout_prepaid'),
-    url(API_URL_PREFIX + r'checkout/token/$',
+    re_path(API_URL_PREFIX + r'checkout/token/$',
         api.create_token,
         name='longclaw_checkout_token'),
-    url(r'checkout/$',
+    re_path(r'checkout/$',
         views.CheckoutView.as_view(),
         name='longclaw_checkout_view'),
-    url(r'checkout/success/(?P<pk>[0-9]+)/$',
+    re_path(r'checkout/success/(?P<pk>[0-9]+)/$',
         views.checkout_success,
         name='longclaw_checkout_success')
 ]

longclaw/checkout/views.py

@@ -2,11 +2,7 @@
 from django.views.generic import TemplateView
 from django.views.decorators.http import require_GET
 from django.http import HttpResponseRedirect
-
-try:
-    from django.urls import reverse
-except ImportError:
-    from django.core.urlresolvers import reverse
+from django.urls import reverse
 
 from longclaw.shipping.forms import AddressForm
 from longclaw.checkout.forms import CheckoutForm

longclaw/client/.nvmrc

@@ -1 +1 @@
-12
+16