Merge pull request #7 from torchbox-forks/support/wagtail-60

Wagtail 7.0

Author: nickmoreton

README.md

@@ -125,7 +125,7 @@ StreamField([
 ### Customizing the widget's display and behaviour
 
 ```python
-from wagtail.contrib.modeladmin.options import ModelAdmin, modeladmin_register
+from wagtail_modeladmin.options import ModelAdmin, modeladmin_register
 from instance_selector.registry import registry
 from instance_selector.selectors import ModelAdminInstanceSelector
 from .models import MyModel

example/example_app/__init__.py

@@ -1 +0,0 @@
-default_app_config = "%s.apps.AppConfig" % __name__

example/example_app/wagtail_hooks.py

@@ -1,8 +1,10 @@
 from django.utils.safestring import mark_safe
-from wagtail.contrib.modeladmin.options import ModelAdmin, modeladmin_register
+from wagtail_modeladmin.options import ModelAdmin, modeladmin_register
+
 from instance_selector.registry import registry
 from instance_selector.selectors import ModelAdminInstanceSelector
-from .models import Shop, Product, Image
+
+from .models import Image, Product, Shop
 
 
 @modeladmin_register

example/example_project/settings.py

@@ -25,7 +25,7 @@
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = True
 
-ALLOWED_HOSTS = []
+ALLOWED_HOSTS = ["*"]
 
 
 # Application definition
@@ -39,7 +39,7 @@
     "django.contrib.staticfiles",
     "wagtail.admin",
     "wagtail",
-    "wagtail.contrib.modeladmin",
+    "wagtail_modeladmin",
     "wagtail.contrib.settings",
     "wagtail.users",
     "wagtail.documents",
@@ -113,7 +113,6 @@
 
 USE_I18N = True
 
-USE_L10N = True
 
 USE_TZ = True
 

example/requirements.txt

@@ -1,3 +1,4 @@
-django>=3.2
-wagtail>=4.1
+django>=4.2
+wagtail>=6.3
+wagtail-modeladmin>=2.0
 wagtail-instance-selector

instance_selector/blocks.py

@@ -1,3 +1,4 @@
+from django import forms
 from django.utils.functional import cached_property, lazy
 
 from instance_selector.widgets import InstanceSelectorWidget
@@ -11,6 +12,7 @@
 
 
 class InstanceSelectorBlock(ChooserBlock):
+    widget = forms.TextInput  # Dummy widget to satisfy Wagtail internals
     class Meta:
         icon = "placeholder"
 
@@ -28,12 +30,9 @@ def __init__(self, target_model, **kwargs):
     def target_model(self):
         return resolve_model_string(self._target_model)
 
-    @cached_property
-    def widget(self):
-        return InstanceSelectorWidget(self.target_model)
-
     def get_form_state(self, value):
-        return self.widget.get_value_data(value)
+        widget = InstanceSelectorWidget(self.target_model)
+        return widget.get_value_data(value)
 
     def get_instance_selector_icon(self):
         instance_selector = registry.get_instance_selector(self.target_model)

instance_selector/static/instance_selector/instance-selector-controller.js

@@ -0,0 +1,10 @@
+class InstanceSelectorController extends window.StimulusModule.Controller {
+    static values = { config: Object };
+
+    connect() {
+        create_instance_selector_widget(this.configValue);
+        console.log(this.configValue);
+    }
+}
+
+window.wagtail.app.register('instance-selector', InstanceSelectorController);

instance_selector/widgets.py

@@ -1,17 +1,19 @@
 import json
+
 from django.forms import widgets
 from django.template.loader import render_to_string
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
-from instance_selector.constants import OBJECT_PK_PARAM
-from instance_selector.registry import registry
-
 from wagtail.telepath import register
-from wagtail.utils.widgets import WidgetWithScript
 from wagtail.widget_adapters import WidgetAdapter
 
+from instance_selector.constants import OBJECT_PK_PARAM
+from instance_selector.registry import registry
+
+from django.forms import Media
+from django.utils.safestring import mark_safe
 
-class InstanceSelectorWidget(WidgetWithScript, widgets.Input):
+class InstanceSelectorWidget(widgets.Input):
     # when looping over form fields, this one should appear in visible_fields, not hidden_fields
     # despite the underlying input being type="hidden"
     input_type = "hidden"
@@ -30,6 +32,23 @@ def __init__(self, model, **kwargs):
 
         super().__init__(**kwargs)
 
+    def render(self, name, value, attrs=None, renderer=None):
+        # no point trying to come up with sensible semantics for when 'id' is missing from attrs,
+        # so let's make sure it fails early in the process
+
+        self.name = name
+        try:
+            self.id_ = attrs["id"]
+        except (KeyError, TypeError):
+            raise TypeError(
+                "InstanceSelectorWidget cannot be rendered without an 'id' attribute"
+            )
+
+        value_data = self.get_value_data(value)
+        widget_html = self.render_html(name, value_data, attrs)
+
+        return mark_safe(widget_html)
+
     def get_value_data(self, value):
         # Given a data value (which may be None, a model instance, or a PK here),
         # extract the necessary data for rendering the widget with that value.
@@ -38,7 +57,7 @@ def get_value_data(self, value):
         # cannot include model instances. Instead, we return the raw values used in rendering -
         # namely: pk, display_markup and edit_url
 
-        if not str(value).strip(): # value might be "" (Wagtail 5.0+)
+        if not str(value).strip():  # value might be "" (Wagtail 5.0+)
             value = None
 
         if value is None or isinstance(value, self.target_model):
@@ -61,8 +80,8 @@ def get_value_data(self, value):
 
     def render_html(self, name, value, attrs):
         value_data = value
-        
-        original_field_html = super().render_html(name, value_data["pk"], attrs)
+
+        original_field_html = super().render(name, value_data["pk"], attrs)
 
         app_label = self.target_model._meta.app_label
         model_name = self.target_model._meta.model_name
@@ -122,10 +141,20 @@ def get_js_config(self, id_, name):
             "OBJECT_PK_PARAM": OBJECT_PK_PARAM,
         }
 
-    def render_js_init(self, id_, name, value):
-        config = self.get_js_config(id_, name)
-        return "create_instance_selector_widget({config});".format(
-            config=json.dumps(config)
+    def build_attrs(self, *args, **kwargs):
+        attrs = super().build_attrs(*args, **kwargs)
+        attrs["data-controller"] = "instance-selector"
+        attrs["data-instance-selector-config-value"] = json.dumps(
+            self.get_js_config(self.id_, self.name)
+        )
+        return attrs
+
+    @property
+    def media(self):
+        return Media(
+            js=[
+                "instance_selector/instance-selector-controller.js",
+            ]
         )
 
 

requirements.txt

@@ -1,6 +1,6 @@
 django>=3.2
 django-webtest>=1.9.5,<2.0
-wagtail>=4.1
+wagtail>=6.3
 black==24.3.0
 ipdb>=0.12,<1.0
 

runtests.py

@@ -1,4 +1,5 @@
 import sys
+
 from django.conf import settings
 
 settings.configure(
@@ -16,7 +17,7 @@
             "django.contrib.messages",
             "wagtail.admin",
             "wagtail",
-            "wagtail.contrib.modeladmin",
+            "wagtail_modeladmin",
             "wagtail.contrib.settings",
             "wagtail.users",
             "wagtail.documents",