Merge pull request #391 from torchbox/TWE-62-as-an-editor-i-want-the-ability-to-add-a-promo-block-to-the-service-area-pages

TWE-62: Add PromoBlock to ServiceAreaPage (with link optional)

Author: bmispelon

tbx/core/blocks.py

@@ -209,7 +209,10 @@ class Meta:
 
 class ButtonLinkStructValue(blocks.StructValue):
     def get_button_link_block(self):
-        return self.get("button_link")[0]
+        try:
+            return self.get("button_link")[0]
+        except IndexError:
+            return None
 
     # return an href-ready value for button_link
     def get_button_link(self):

tbx/project_styleguide/templates/patterns/molecules/streamfield/blocks/promo_block.html

@@ -4,7 +4,9 @@
     <div class="promo-block__content">
         {% include "patterns/atoms/section-title/section-title.html" with title=value.title classes="promo-block__title" %}
         <p class="promo-block__description">{{ value.description }}</p>
-        <a href="{{ value.get_button_link }}" class="button promo-block__button">{{ value.button_text }}</a>
+        {% if value.button_text %}
+            <a href="{{ value.get_button_link }}" class="button promo-block__button">{{ value.button_text }}</a>
+        {% endif %}
         {% if value.secondary_link %}
             <hr class="promo-block__divider" aria-hidden="true" />
             {% with secondary_link=value.secondary_link.0.value %}

tbx/services/blocks.py

@@ -1,3 +1,5 @@
+from django.core.exceptions import ValidationError
+
 from wagtail import blocks
 
 from tbx.core.blocks import (
@@ -13,6 +15,7 @@
     PromoBlock,
     ShowcaseBlock,
     StoryBlock,
+    StructBlockValidationError,
     TabbedParagraphBlock,
     WorkChooserBlock,
 )
@@ -69,9 +72,31 @@ class ServiceStoryBlock(StoryBlock):
     )
 
 
+class OptionalLinkPromoBlock(PromoBlock):
+    """
+    Identical to PromoBlock in all aspects, except that button_link is optional.
+    """
+
+    button_text = blocks.CharBlock(max_length=55, required=False)
+    button_link = blocks.StreamBlock(
+        PromoBlock.declared_blocks["button_link"].child_blocks.items(),
+        required=False,
+        max_num=1,
+    )
+
+    def clean(self, value):
+        cleaned = super().clean(value)
+        if cleaned.get("button_text") and not cleaned.get("button_link"):
+            raise StructBlockValidationError(
+                {"button_link": ValidationError("This field is required.")},
+            )
+        return cleaned
+
+
 class ServiceAreaStoryBlock(StoryBlock):
     blog_chooser = BlogChooserBlock()
     four_photo_collage = FourPhotoCollageBlock()
     key_points = IconKeyPointsBlock(label="Key points with icons")
     link_columns = LinkColumnsBlock()
+    promo = OptionalLinkPromoBlock()
     work_chooser = WorkChooserBlock()

tbx/services/tests/__init__.py

@@ -0,0 +1,45 @@
+from django.test import SimpleTestCase
+
+from wagtail.blocks import StructBlockValidationError
+
+from tbx.services.blocks import OptionalLinkPromoBlock, PromoBlock
+
+
+class OptionalLinkPromoBlockTestCase(SimpleTestCase):
+    def test_basic_promo_block_button_link_required(self):
+        try:
+            PromoBlock().clean({"button_link": []})
+        except StructBlockValidationError:
+            pass
+        else:
+            self.fail("PromoBlock.button_link should be required")
+
+    def test_custom_promo_block_button_link_optional(self):
+        try:
+            OptionalLinkPromoBlock().clean({"button_link": []})
+        except StructBlockValidationError as e:
+            self.fail(e.as_json_data())
+
+    def test_basic_promo_block_button_text_required(self):
+        try:
+            PromoBlock().clean({"button_text": ""})
+        except StructBlockValidationError:
+            pass
+        else:
+            self.fail("PromoBlock.button_text should be required")
+
+    def test_custom_promo_block_button_text_optional(self):
+        try:
+            OptionalLinkPromoBlock().clean({"button_text": ""})
+        except StructBlockValidationError as e:
+            self.fail(e.as_json_data())
+
+    def test_custom_promo_block_link_required_if_text_provided(self):
+        try:
+            OptionalLinkPromoBlock().clean({"button_text": "test", "button_link": []})
+        except StructBlockValidationError:
+            pass
+        else:
+            self.fail(
+                "PromoBlock.button_link should be required if button_text is provided"
+            )