wagtail 7.0.2__py3-none-any.whl → 7.1__py3-none-any.whl

wagtail/tests/test_blocks.py

@@ -191,6 +191,7 @@ class TestFieldBlock(WagtailTestUtils, SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--char_field w-field--text_input",
+                "attrs": {},
                 "showAddCommentButton": True,
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },
@@ -214,6 +215,27 @@ class TestFieldBlock(WagtailTestUtils, SimpleTestCase):
         js_args = FieldBlockAdapter().js_args(block_with_classname)
         self.assertIn(" special-char-classname", js_args[2]["classname"])
 
+    def test_charblock_adapter_attrs(self):
+        block = blocks.CharBlock(
+            form_attrs={
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            },
+        )
+
+        block.set_name("test_block")
+        js_args = FieldBlockAdapter().js_args(block)
+
+        self.assertEqual(js_args[0], "test_block")
+        self.assertIsInstance(js_args[1], forms.TextInput)
+        self.assertEqual(
+            js_args[2].get("attrs"),
+            {
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            },
+        )
+
     def test_charfield_render_with_template_with_extra_context(self):
         block = ContextCharBlock(template="tests/blocks/heading_block.html")
         html = block.render(
@@ -253,6 +275,13 @@ class TestFieldBlock(WagtailTestUtils, SimpleTestCase):
         with self.assertRaises(ValidationError):
             block.clean("bar")
 
+    def test_charfield_with_callable_default(self):
+        def callable_default():
+            return "Hello world!"
+
+        block = blocks.CharBlock(default=callable_default)
+        self.assertEqual(block.get_default(), "Hello world!")
+
     def test_choicefield_render(self):
         class ChoiceBlock(blocks.FieldBlock):
             field = forms.ChoiceField(
@@ -300,6 +329,7 @@ class TestFieldBlock(WagtailTestUtils, SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--choice_field w-field--select",
+                "attrs": {},
                 "showAddCommentButton": True,
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },
@@ -677,6 +707,11 @@ class TestRichTextBlock(TestCase):
         self.assertIsInstance(default_value, RichText)
         self.assertEqual(default_value.source, "<p>foo</p>")
 
+    def test_get_default_with_localized_string(self):
+        default_value = blocks.RichTextBlock(default=_("<p>english</p>")).get_default()
+        self.assertIsInstance(default_value, RichText)
+        self.assertEqual(default_value.source, "<p>english</p>")
+
     def test_get_default_with_richtext_value(self):
         default_value = blocks.RichTextBlock(
             default=RichText("<p>foo</p>")
@@ -684,6 +719,14 @@ class TestRichTextBlock(TestCase):
         self.assertIsInstance(default_value, RichText)
         self.assertEqual(default_value.source, "<p>foo</p>")
 
+    def test_get_default_with_callable(self):
+        def callable_default():
+            return RichText("<p>foo</p>")
+
+        default_value = blocks.RichTextBlock(default=callable_default).get_default()
+        self.assertIsInstance(default_value, RichText)
+        self.assertEqual(default_value.source, "<p>foo</p>")
+
     def test_render(self):
         block = blocks.RichTextBlock()
         value = RichText('<p>Merry <a linktype="page" id="4">Christmas</a>!</p>')
@@ -711,6 +754,7 @@ class TestRichTextBlock(TestCase):
                 "description": "",
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
+                "attrs": {},
                 "required": True,
                 "showAddCommentButton": True,
                 "strings": {"ADD_COMMENT": "Add Comment"},
@@ -737,6 +781,7 @@ class TestRichTextBlock(TestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--char_field w-field--draftail_rich_text_area",
+                "attrs": {},
                 "showAddCommentButton": False,  # Draftail manages its own comments
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },
@@ -762,6 +807,7 @@ class TestRichTextBlock(TestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--char_field w-field--draftail_rich_text_area",
+                "attrs": {},
                 "showAddCommentButton": False,  # Draftail manages its own comments
                 "strings": {"ADD_COMMENT": "Add Comment"},
                 "maxLength": 400,
@@ -798,12 +844,29 @@ class TestRichTextBlock(TestCase):
         with self.assertRaises(ValidationError):
             block.clean(RichText("<p>this exceeds the 20 character limit</p>"))
 
+        # Case to test that markup is not counted towards length
         block.clean(
             RichText(
                 '<p><a href="http://really-long-domain-name.example.com">also</a> short</p>'
             )
         )
 
+    def test_validate_min_length(self):
+        block = blocks.RichTextBlock(min_length=20)
+
+        block.clean(RichText("<p>this passes the 20 character minimum</p>"))
+
+        with self.assertRaises(ValidationError):
+            block.clean(RichText("<p>too short</p>"))
+
+        # Case to test that markup is not counted towards length
+        with self.assertRaises(ValidationError):
+            block.clean(
+                RichText(
+                    '<p><a href="http://really-long-domain-name.example.com">also</a> too short</p>'
+                )
+            )
+
     def test_get_searchable_content(self):
         block = blocks.RichTextBlock()
         value = RichText(
@@ -880,6 +943,7 @@ class TestChoiceBlock(WagtailTestUtils, SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--choice_field w-field--select",
+                "attrs": {},
                 "showAddCommentButton": True,
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },
@@ -1284,6 +1348,7 @@ class TestMultipleChoiceBlock(WagtailTestUtils, SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--multiple_choice_field w-field--select_multiple",
+                "attrs": {},
                 "showAddCommentButton": True,
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },
@@ -1680,6 +1745,14 @@ class TestRawHTMLBlock(unittest.TestCase):
         self.assertEqual(default_value, "<blink>BÖÖM</blink>")
         self.assertIsInstance(default_value, SafeData)
 
+    def test_get_default_with_callable(self):
+        def callable_default():
+            return "<blink>BÖÖM</blink>"
+
+        default_value = blocks.RawHTMLBlock(default=callable_default).get_default()
+        self.assertEqual(default_value, "<blink>BÖÖM</blink>")
+        self.assertIsInstance(default_value, SafeData)
+
     def test_serialize(self):
         block = blocks.RawHTMLBlock()
         result = block.get_prep_value(mark_safe("<blink>BÖÖM</blink>"))
@@ -1723,6 +1796,7 @@ class TestRawHTMLBlock(unittest.TestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--char_field w-field--textarea",
+                "attrs": {},
                 "showAddCommentButton": True,
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },
@@ -2068,6 +2142,8 @@ class TestStructBlock(SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "struct-block",
+                "collapsed": False,
+                "attrs": {},
             },
         )
 
@@ -2100,10 +2176,61 @@ class TestStructBlock(SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "struct-block",
+                "collapsed": False,
+                "attrs": {},
                 "formTemplate": "<div>Hello</div>",
             },
         )
 
+    def test_adapt_with_form_attrs(self):
+        class LinkBlock(blocks.StructBlock):
+            title = blocks.CharBlock(required=False)
+            link = blocks.URLBlock(required=False)
+
+        block = LinkBlock(
+            form_attrs={
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            }
+        )
+
+        block.set_name("test_structblock")
+        js_args = StructBlockAdapter().js_args(block)
+
+        self.assertEqual(js_args[0], "test_structblock")
+        self.assertEqual(
+            js_args[2].get("attrs"),
+            {
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            },
+        )
+
+    def test_adapt_with_form_attrs_on_meta(self):
+        class LinkBlock(blocks.StructBlock):
+            title = blocks.CharBlock(required=False)
+            link = blocks.URLBlock(required=False)
+
+            class Meta:
+                form_attrs = {
+                    "data-controller": "w-custom",
+                    "data-action": "click->w-custom#doSomething",
+                }
+
+        block = LinkBlock()
+
+        block.set_name("test_structblock")
+        js_args = StructBlockAdapter().js_args(block)
+
+        self.assertEqual(js_args[0], "test_structblock")
+        self.assertEqual(
+            js_args[2].get("attrs"),
+            {
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            },
+        )
+
     def test_adapt_with_form_template_jinja(self):
         class LinkBlock(blocks.StructBlock):
             title = blocks.CharBlock(required=False)
@@ -2127,6 +2254,8 @@ class TestStructBlock(SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "struct-block",
+                "collapsed": False,
+                "attrs": {},
                 "formTemplate": "<div>Hello</div>",
             },
         )
@@ -2140,6 +2269,25 @@ class TestStructBlock(SimpleTestCase):
         default_val = block.get_default()
         self.assertEqual(default_val.get("title"), "Torchbox")
 
+    def test_get_default_with_callable(self):
+        def callable_struct_default():
+            return {"title": "Torchbox"}
+
+        def default_link():
+            return "http://www.torchbox.com"
+
+        class LinkBlock(blocks.StructBlock):
+            title = blocks.CharBlock()
+            link = blocks.URLBlock(default=default_link)
+
+        block = LinkBlock(default=callable_struct_default)
+        default_val = block.get_default()
+
+        # Should combine the defaults from the StructBlock's default and the
+        # child block's default, and allow them both to be callable
+        self.assertEqual(default_val.get("title"), "Torchbox")
+        self.assertEqual(default_val.get("link"), "http://www.torchbox.com")
+
     def test_adapt_with_help_text_on_meta(self):
         class LinkBlock(blocks.StructBlock):
             title = blocks.CharBlock()
@@ -2163,6 +2311,8 @@ class TestStructBlock(SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "struct-block",
+                "collapsed": False,
+                "attrs": {},
                 "helpIcon": (
                     '<svg class="icon icon-help default" aria-hidden="true">'
                     '<use href="#icon-help"></use></svg>'
@@ -2191,6 +2341,8 @@ class TestStructBlock(SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "struct-block",
+                "collapsed": False,
+                "attrs": {},
                 "helpIcon": (
                     '<svg class="icon icon-help default" aria-hidden="true">'
                     '<use href="#icon-help"></use></svg>'
@@ -2199,6 +2351,21 @@ class TestStructBlock(SimpleTestCase):
             },
         )
 
+    def test_adapt_with_collapsed(self):
+        class LinkBlock(blocks.StructBlock):
+            title = blocks.CharBlock()
+            link = blocks.URLBlock()
+
+        cases = [None, False, True]
+        for case in cases:
+            with self.subTest(collapsed=case):
+                block = LinkBlock(collapsed=case)
+
+                block.set_name("test_structblock")
+                js_args = StructBlockAdapter().js_args(block)
+
+                self.assertIs(js_args[2]["collapsed"], case)
+
     def test_searchable_content(self):
         class LinkBlock(blocks.StructBlock):
             title = blocks.CharBlock()
@@ -2822,6 +2989,7 @@ class TestListBlock(WagtailTestUtils, SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": None,
+                "attrs": {},
                 "collapsed": False,
                 "strings": {
                     "DELETE": "Delete",
@@ -2856,6 +3024,7 @@ class TestListBlock(WagtailTestUtils, SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": None,
+                "attrs": {},
                 "collapsed": False,
                 "minNum": 2,
                 "maxNum": 5,
@@ -2975,6 +3144,14 @@ class TestListBlock(WagtailTestUtils, SimpleTestCase):
 
         self.assertEqual(list(block.get_default()), ["peas", "beans", "carrots"])
 
+    def test_default_callable(self):
+        def callable_default():
+            return ["chocolate", "vanilla"]
+
+        block = blocks.ListBlock(blocks.CharBlock(), default=callable_default)
+
+        self.assertEqual(list(block.get_default()), ["chocolate", "vanilla"])
+
     def test_default_default(self):
         """
         if no explicit 'default' is set on the ListBlock, it should fall back on
@@ -3034,6 +3211,7 @@ class TestListBlock(WagtailTestUtils, SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "special-list-class",
+                "attrs": {},
                 "collapsed": False,
                 "strings": {
                     "DELETE": "Delete",
@@ -3071,6 +3249,7 @@ class TestListBlock(WagtailTestUtils, SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "custom-list-class",
+                "attrs": {},
                 "collapsed": False,
                 "strings": {
                     "DELETE": "Delete",
@@ -3083,6 +3262,33 @@ class TestListBlock(WagtailTestUtils, SimpleTestCase):
             },
         )
 
+    def test_adapt_with_form_attrs(self):
+        class LinkBlock(blocks.StructBlock):
+            title = blocks.CharBlock()
+            link = blocks.URLBlock()
+
+        block = blocks.ListBlock(
+            LinkBlock,
+            form_attrs={
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            },
+        )
+
+        block.set_name("test_listblock")
+        js_args = ListBlockAdapter().js_args(block)
+
+        self.assertEqual(js_args[0], "test_listblock")
+        self.assertIsInstance(js_args[1], LinkBlock)
+        self.assertEqual(js_args[2], {"title": None, "link": None})
+        self.assertEqual(
+            js_args[3].get("attrs"),
+            {
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            },
+        )
+
     def test_clean_preserves_block_ids(self):
         block = blocks.ListBlock(blocks.CharBlock())
         block_val = block.to_python(
@@ -3712,6 +3918,7 @@ class TestStreamBlock(WagtailTestUtils, SimpleTestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": None,
+                "attrs": {},
                 "collapsed": False,
                 "maxNum": None,
                 "minNum": None,
@@ -4031,6 +4238,29 @@ class TestStreamBlock(WagtailTestUtils, SimpleTestCase):
         self.assertEqual(stream_value[0].block_type, "heading")
         self.assertEqual(stream_value[0].value, "A different default heading")
 
+    def test_callable_default(self):
+        class ArticleBlock(blocks.StreamBlock):
+            heading = blocks.CharBlock()
+            paragraph = blocks.CharBlock()
+
+        def callable_default():
+            return [("heading", "A default heading from callable")]
+
+        # to access the default value, we retrieve it through a StructBlock
+        # from a struct value that's missing that key
+        class ArticleContainerBlock(blocks.StructBlock):
+            author = blocks.CharBlock()
+            article = ArticleBlock(default=callable_default)
+
+        block = ArticleContainerBlock()
+        struct_value = block.to_python({"author": "Bob"})
+        stream_value = struct_value["article"]
+
+        self.assertIsInstance(stream_value, blocks.StreamValue)
+        self.assertEqual(len(stream_value), 1)
+        self.assertEqual(stream_value[0].block_type, "heading")
+        self.assertEqual(stream_value[0].value, "A default heading from callable")
+
     def test_stream_value_equality(self):
         block = blocks.StreamBlock(
             [
@@ -4419,6 +4649,29 @@ class TestStreamBlock(WagtailTestUtils, SimpleTestCase):
             ],
         )
 
+    def test_adapt_with_form_attrs(self):
+        block = blocks.StreamBlock(
+            [
+                (b"heading", blocks.CharBlock()),
+                (b"paragraph", blocks.CharBlock()),
+            ],
+            form_attrs={
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            },
+        )
+
+        block.set_name("test_streamblock")
+        js_args = StreamBlockAdapter().js_args(block)
+
+        self.assertEqual(
+            js_args[3].get("attrs"),
+            {
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            },
+        )
+
     def test_adapt_with_classname_via_kwarg(self):
         """form_classname from kwargs to be used as an additional class when rendering stream block"""
 
@@ -4447,6 +4700,7 @@ class TestStreamBlock(WagtailTestUtils, SimpleTestCase):
                 "collapsed": False,
                 "required": True,
                 "classname": "rocket-section",
+                "attrs": {},
                 "strings": {
                     "DELETE": "Delete",
                     "DUPLICATE": "Duplicate",
@@ -4553,6 +4807,7 @@ class TestStreamBlock(WagtailTestUtils, SimpleTestCase):
                 "collapsed": False,
                 "required": True,
                 "classname": "profile-block-large",
+                "attrs": {},
                 "strings": {
                     "DELETE": "Delete",
                     "DUPLICATE": "Duplicate",
@@ -4900,6 +5155,7 @@ class TestPageChooserBlock(TestCase):
                 "isPreviewable": block.is_previewable,
                 "helpText": "pick a page, any page",
                 "classname": "w-field w-field--model_choice_field w-field--admin_page_chooser",
+                "attrs": {},
                 "showAddCommentButton": True,
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },
@@ -5105,6 +5361,7 @@ class TestStaticBlock(unittest.TestCase):
                 "isPreviewable": block.is_previewable,
                 "label": "Posts static block",
                 "description": "",
+                "attrs": {},
             },
         )
 
@@ -5129,6 +5386,7 @@ class TestStaticBlock(unittest.TestCase):
                 "isPreviewable": block.is_previewable,
                 "label": "Posts static block",
                 "description": "",
+                "attrs": {},
             },
         )
 
@@ -5152,6 +5410,7 @@ class TestStaticBlock(unittest.TestCase):
                 "isPreviewable": block.is_previewable,
                 "label": "Latest posts",
                 "description": "",
+                "attrs": {},
             },
         )
 
@@ -5176,6 +5435,7 @@ class TestStaticBlock(unittest.TestCase):
                 "isPreviewable": block.is_previewable,
                 "label": "Posts static block",
                 "description": "",
+                "attrs": {},
             },
         )
 
@@ -5200,6 +5460,29 @@ class TestStaticBlock(unittest.TestCase):
                 "isPreviewable": block.is_previewable,
                 "label": "Posts static block",
                 "description": "",
+                "attrs": {},
+            },
+        )
+
+    def test_adapt_with_form_attrs(self):
+        block = blocks.StaticBlock(
+            admin_text="Latest posts - This block doesn't need to be configured, it will be displayed automatically",
+            template="tests/blocks/posts_static_block.html",
+            form_attrs={
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
+            },
+        )
+
+        block.set_name("posts_static_block")
+        js_args = StaticBlockAdapter().js_args(block)
+
+        self.assertEqual(js_args[0], "posts_static_block")
+        self.assertEqual(
+            js_args[1].get("attrs"),
+            {
+                "data-controller": "w-custom",
+                "data-action": "click->w-custom#doSomething",
             },
         )
 
@@ -5258,6 +5541,7 @@ class TestDateBlock(TestCase):
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--date_field w-field--admin_date_input",
                 "showAddCommentButton": True,
+                "attrs": {},
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },
         )
@@ -5294,6 +5578,7 @@ class TestTimeBlock(TestCase):
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--time_field w-field--admin_time_input",
                 "showAddCommentButton": True,
+                "attrs": {},
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },
         )
@@ -5329,6 +5614,7 @@ class TestDateTimeBlock(TestCase):
                 "blockDefId": block.definition_prefix,
                 "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--date_time_field w-field--admin_date_time_input",
+                "attrs": {},
                 "showAddCommentButton": True,
                 "strings": {"ADD_COMMENT": "Add Comment"},
             },

wagtail/tests/test_date_validators.py

@@ -0,0 +1,68 @@
+import datetime
+from unittest.mock import patch
+
+from django.core.exceptions import ValidationError
+from django.test import TestCase
+
+from wagtail.fields import NoFutureDateValidator
+
+
+class TestNoFutureDateValidator(TestCase):
+    def setUp(self):
+        self.validator = NoFutureDateValidator()
+
+    def test_validates_past_date(self):
+        """Past dates should pass validation"""
+        past_date = datetime.date.today() - datetime.timedelta(days=1)
+        # Should not raise ValidationError
+        self.validator(past_date)
+
+    def test_validates_today(self):
+        """Today's date should pass validation"""
+        today = datetime.date.today()
+        # Should not raise ValidationError
+        self.validator(today)
+
+    def test_rejects_future_date(self):
+        """Future dates should raise ValidationError"""
+        future_date = datetime.date.today() + datetime.timedelta(days=1)
+        with self.assertRaises(ValidationError) as cm:
+            self.validator(future_date)
+
+        self.assertEqual(cm.exception.code, "future_date")
+        self.assertEqual(str(cm.exception.message), "Date cannot be in the future.")
+
+    def test_validates_none_value(self):
+        """None values should pass validation (let required validation handle empty values)"""
+        # Should not raise ValidationError
+        self.validator(None)
+
+    def test_custom_message(self):
+        """Test custom error message"""
+        custom_message = "Custom future date error message"
+        validator = NoFutureDateValidator(message=custom_message)
+        future_date = datetime.date.today() + datetime.timedelta(days=1)
+
+        with self.assertRaises(ValidationError) as cm:
+            validator(future_date)
+
+        self.assertEqual(str(cm.exception.message), custom_message)
+
+    @patch("wagtail.fields.datetime")
+    def test_validates_with_mocked_today(self, mock_datetime):
+        """Test that validation uses the correct 'today' reference"""
+        # Mock today to be 2024-01-15
+        mock_today = datetime.date(2024, 1, 15)
+        mock_datetime.date.today.return_value = mock_today
+
+        # Test date exactly one day in the future
+        future_date = datetime.date(2024, 1, 16)
+        with self.assertRaises(ValidationError):
+            self.validator(future_date)
+
+        # Test date exactly 'today'
+        self.validator(mock_today)  # Should not raise
+
+        # Test past date
+        past_date = datetime.date(2024, 1, 14)
+        self.validator(past_date)  # Should not raise