CMS: Update popular topics component and validation

Author: tushortz

cms/dynamic_content/blocks.py

@@ -13,6 +13,10 @@
 
 MINIMUM_ROWS_NUMBER_BLOCK_COUNT: int = 1
 MAXIMUM_ROWS_NUMBER_BLOCK_COUNT: int = 2
+
+POPULAR_TOPICS_BOTTOM_RIGHT_COLUMN_COUNT: int = 2
+POPULAR_TOPICS_HEADLINE_NUMBER_BLOCK_COUNT: int = 2
+
 METRIC_NUMBER_BLOCK_DATE_PREFIX_DEFAULT_TEXT = "Up to"
 
 
@@ -45,6 +49,46 @@ class Meta:
         icon = "table"
 
 
+class PopularTopicsHeadlineNumberBlockTypes(blocks.StreamBlock):
+    headline_number = HeadlineNumberComponent(help_text=help_texts.HEADLINE_BLOCK_FIELD)
+    trend_number = TrendNumberComponent(help_text=help_texts.TREND_BLOCK_FIELD)
+
+    class Meta:
+        icon = "bars"
+
+
+class PopularTopicsMetricNumberBlockTypes(blocks.StructBlock):
+    title = blocks.TextBlock(required=True, help_text=help_texts.TITLE_FIELD)
+    date_prefix = blocks.TextBlock(
+        required=True,
+        default=METRIC_NUMBER_BLOCK_DATE_PREFIX_DEFAULT_TEXT,
+        help_text=help_texts.HEADLINE_DATE_PREFIX,
+    )
+    headline_metrics = PopularTopicsHeadlineNumberBlockTypes(
+        required=True,
+        min_num=POPULAR_TOPICS_HEADLINE_NUMBER_BLOCK_COUNT,
+        max_num=POPULAR_TOPICS_HEADLINE_NUMBER_BLOCK_COUNT,
+        help_text=help_texts.POPULAR_TOPICS_METRIC_CARDS.format(
+            POPULAR_TOPICS_HEADLINE_NUMBER_BLOCK_COUNT
+        ),
+    )
+
+    class Meta:
+        icon = "table"
+
+
+class PopularTopicsRightColumnBottomRowBlockTypes(blocks.StreamBlock):
+    headline_metric_card = PopularTopicsMetricNumberBlockTypes(
+        required=True,
+        min_num=POPULAR_TOPICS_BOTTOM_RIGHT_COLUMN_COUNT,
+        max_num=POPULAR_TOPICS_BOTTOM_RIGHT_COLUMN_COUNT,
+        help_text=help_texts.POPULAR_TOPICS_HEADLINE_METRIC_CARDS,
+    )
+
+    class Meta:
+        icon = "table"
+
+
 class MetricNumberBlock(blocks.StreamBlock):
     column = MetricNumberBlockTypes()
 

cms/dynamic_content/cards.py

@@ -12,6 +12,7 @@
     HeadlineNumberBlockTypes,
     MetricNumberBlock,
     PageLinkChooserBlock,
+    PopularTopicsRightColumnBottomRowBlockTypes,
     RelatedLinkBlock,
     SourceLinkBlock,
 )
@@ -46,6 +47,9 @@
 
 MINIMUM_SEGMENTS_COUNT: int = 1
 
+POPULAR_TOPICS_SEGMENT_COUNT: int = 1
+POPULAR_TOPICS_RIGHT_COLUMN_BOTTOM_ROW_SEGMENT_COUNT: int = 2
+
 DEFAULT_SIMPLE_CHART_X_AXIS = "date"
 DEFAULT_SIMPLE_CHART_Y_AXIS = "metric"
 
@@ -575,6 +579,44 @@ class ChartRowBlockTypes(blocks.StreamBlock):
     dual_category_chart_card = DualCategoryChartCard()
 
 
+class PopularTopicsLeftColumnBlockTypes(blocks.StreamBlock):
+    weather_health_alert_card = WeatherHealthAlertsCard()
+    chart_card_with_description = ChartWithDescriptionCard()
+
+    class Meta:
+        icon = "standalone_chart"
+
+
+class PopularTopicsRightColumnTopRowBlockTypes(blocks.StreamBlock):
+    chart_card = SimplifiedChartWithLink()
+
+    class Meta:
+        icon = "standalone_chart"
+
+
+class PopularTopicsCard(blocks.StructBlock):
+    left_column = PopularTopicsLeftColumnBlockTypes(
+        min_num=POPULAR_TOPICS_SEGMENT_COUNT,
+        max_num=POPULAR_TOPICS_SEGMENT_COUNT,
+        help_text=help_texts.POPULAR_TOPICS_LEFT_COLUMN,
+    )
+    right_column_top_row = PopularTopicsRightColumnTopRowBlockTypes(
+        min_num=POPULAR_TOPICS_SEGMENT_COUNT,
+        max_num=POPULAR_TOPICS_SEGMENT_COUNT,
+        help_text=help_texts.POPULAR_TOPICS_RIGHT_COLUMN_TOP_ROW,
+    )
+    right_column_bottom_row = PopularTopicsRightColumnBottomRowBlockTypes(
+        min_num=POPULAR_TOPICS_RIGHT_COLUMN_BOTTOM_ROW_SEGMENT_COUNT,
+        max_num=POPULAR_TOPICS_RIGHT_COLUMN_BOTTOM_ROW_SEGMENT_COUNT,
+        help_text=help_texts.POPULAR_TOPICS_RIGHT_COLUMN_BOTTOM_ROW.format(
+            POPULAR_TOPICS_RIGHT_COLUMN_BOTTOM_ROW_SEGMENT_COUNT
+        ),
+    )
+
+    class Meta:
+        icon = "standalone_chart"
+
+
 class ChartRowCard(blocks.StructBlock):
     columns = ChartRowBlockTypes(
         min_num=MINIMUM_COLUMNS_CHART_COLUMNS_COUNT,

cms/dynamic_content/help_texts.py

@@ -4,6 +4,31 @@
 So by moving 1 column component above the other, that component will be rendered in the column left of the other. 
 """
 
+POPULAR_TOPICS_LEFT_COLUMN: str = """
+This will be used to display a full height card on the left column.
+Choose either a weather health alerts card or a chart card with description.
+"""
+
+POPULAR_TOPICS_RIGHT_COLUMN_TOP_ROW: str = """
+This will be used to display a chart card in the top row of the second (right) column.
+"""
+
+POPULAR_TOPICS_RIGHT_COLUMN_BOTTOM_ROW: str = """
+This will require {} headline metrics cards which will be displayed from left to right  
+with each card occupying and sharing half of the bottom row right column of the 
+popular topics component.
+"""
+
+POPULAR_TOPICS_METRIC_CARDS: str = """
+This block only allows {} headline number blocks to be added.
+It can be used to add headline number and trend number.
+"""
+
+POPULAR_TOPICS_HEADLINE_METRIC_CARDS: str = """
+Each card will be displayed from left to right and will share and occupy half 
+of the bottom row right column of the popular topics component.
+"""
+
 HEADLINE_COLUMNS_IN_CHART_CARD: str = """
 Add up to {} headline or trend number column components within this space.
 Note that these figures will be displayed within the card, and above the chart itself.

cms/dynamic_content/sections.py

@@ -40,6 +40,7 @@ class ContentCardsSectionWithLink(StreamBlock):
     chart_card_section = cards.ChartCardSection()
     headline_numbers_row_card = cards.HeadlineNumbersRowCard()
     weather_health_alert_card = cards.WeatherHealthAlertsCard()
+    popular_topics_card = cards.PopularTopicsCard()
 
 
 class Section(StructBlock):

metrics/domain/common/utils.py

@@ -67,7 +67,7 @@ def selectable_simplified_chart_choices(cls) -> tuple[tuple[str, str], ...]:
             Examples:
                 (("line_single_simplified", "line_single_simplified"), ...)
         """
-        selectable = (cls.line_single_simplified,)
+        selectable = (cls.line_single_simplified, cls.line_multi_coloured)
         return tuple((chart_type.value, chart_type.value) for chart_type in selectable)
 
     @classmethod

tests/unit/cms/dynamic_content/test_popular_topics_card.py

@@ -0,0 +1,162 @@
+import pytest
+
+from cms.dynamic_content.blocks import (
+    POPULAR_TOPICS_BOTTOM_RIGHT_COLUMN_COUNT,
+    POPULAR_TOPICS_HEADLINE_NUMBER_BLOCK_COUNT,
+    PopularTopicsMetricNumberBlockTypes,
+    PopularTopicsRightColumnBottomRowBlockTypes,
+)
+from cms.dynamic_content.cards import (
+    POPULAR_TOPICS_RIGHT_COLUMN_BOTTOM_ROW_SEGMENT_COUNT,
+    PopularTopicsCard,
+    PopularTopicsLeftColumnBlockTypes,
+    PopularTopicsRightColumnTopRowBlockTypes,
+    SimplifiedChartWithLink,
+)
+
+
+class TestPopularTopicsFirstColumnBlockTypes:
+    @pytest.mark.parametrize(
+        "expected_field_name",
+        (
+            "weather_health_alert_card",
+            "chart_card_with_description",
+        ),
+    )
+    def test_has_expected_child_blocks(self, expected_field_name: str) -> None:
+        """
+        Given an instance of `PopularTopicsLeftColumnBlockTypes`
+        When inspecting child blocks
+        Then the expected field(s) are available
+        """
+        # Given
+        first_column_block_types = PopularTopicsLeftColumnBlockTypes()
+
+        # When
+        selected_field = first_column_block_types.child_blocks.get(expected_field_name)
+
+        # Then
+        assert selected_field is not None
+
+
+class TestPopularTopicsSecondColumnTopRightBlockTypes:
+    def test_has_expected_chart_card_block(self) -> None:
+        """
+        Given an instance of `PopularTopicsRightColumnTopRowBlockTypes`
+        When inspecting child blocks
+        Then the chart card field is available and correctly typed
+        """
+        # Given
+        top_right_block_types = PopularTopicsRightColumnTopRowBlockTypes()
+
+        # When
+        selected_field = top_right_block_types.child_blocks.get("chart_card")
+
+        # Then
+        assert isinstance(selected_field, SimplifiedChartWithLink)
+
+
+class TestPopularTopicsSecondColumnBottomRowBlockTypes:
+    def test_has_expected_headline_metric_card_block(self) -> None:
+        """
+        Given an instance of `PopularTopicsRightColumnBottomRowBlockTypes`
+        When inspecting child blocks
+        Then the headline metric card field is available and correctly typed
+        """
+        # Given
+        bottom_row_block_types = PopularTopicsRightColumnBottomRowBlockTypes()
+
+        # When
+        selected_field = bottom_row_block_types.child_blocks.get("headline_metric_card")
+
+        # Then
+        assert isinstance(selected_field, PopularTopicsMetricNumberBlockTypes)
+        assert selected_field.meta.min_num == POPULAR_TOPICS_BOTTOM_RIGHT_COLUMN_COUNT
+        assert selected_field.meta.max_num == POPULAR_TOPICS_BOTTOM_RIGHT_COLUMN_COUNT
+
+
+class TestPopularTopicsCard:
+    @pytest.mark.parametrize(
+        "field_name, expected_block_type",
+        (
+            ("left_column", PopularTopicsLeftColumnBlockTypes),
+            ("right_column_top_row", PopularTopicsRightColumnTopRowBlockTypes),
+            ("right_column_bottom_row", PopularTopicsRightColumnBottomRowBlockTypes),
+        ),
+    )
+    def test_has_expected_child_blocks(
+        self,
+        field_name: str,
+        expected_block_type: type,
+    ) -> None:
+        """
+        Given an instance of `PopularTopicsCard`
+        When inspecting child blocks
+        Then the expected field(s) use the correct block type
+        """
+        # Given
+        popular_topics_card = PopularTopicsCard()
+
+        # When
+        selected_field = popular_topics_card.child_blocks.get(field_name)
+
+        # Then
+        assert isinstance(selected_field, expected_block_type)
+
+    @pytest.mark.parametrize(
+        "field_name, expected_min_num, expected_max_num",
+        (
+            ("left_column", 1, 1),
+            ("right_column_top_row", 1, 1),
+            (
+                "right_column_bottom_row",
+                POPULAR_TOPICS_RIGHT_COLUMN_BOTTOM_ROW_SEGMENT_COUNT,
+                POPULAR_TOPICS_RIGHT_COLUMN_BOTTOM_ROW_SEGMENT_COUNT,
+            ),
+        ),
+    )
+    def test_card_columns_have_expected_required_counts(
+        self,
+        field_name: str,
+        expected_min_num: int,
+        expected_max_num: int,
+    ) -> None:
+        """
+        Given an instance of `PopularTopicsCard`
+        When inspecting stream count constraints for each card area
+        Then each field has the expected min and max values
+        """
+        # Given
+        popular_topics_card = PopularTopicsCard()
+
+        # When
+        selected_field = popular_topics_card.child_blocks[field_name]
+
+        # Then
+        assert selected_field.meta.min_num == expected_min_num
+        assert selected_field.meta.max_num == expected_max_num
+
+
+class TestPopularTopicsMetricNumberBlockTypes:
+    def test_headline_metrics_are_required_and_allow_exactly_two_entries(self) -> None:
+        """
+        Given an instance of `PopularTopicsMetricNumberBlockTypes`
+        When inspecting the headline_metrics field configuration
+        Then headline_metrics are required and constrained to exactly two entries
+        """
+        # Given
+        metric_number_block = PopularTopicsMetricNumberBlockTypes()
+
+        # When
+        headline_metrics_block = metric_number_block.child_blocks["headline_metrics"]
+
+        # Then
+        assert headline_metrics_block.meta.required is True
+        assert (
+            headline_metrics_block.meta.min_num
+            == POPULAR_TOPICS_HEADLINE_NUMBER_BLOCK_COUNT
+        )
+        assert (
+            headline_metrics_block.meta.max_num
+            == POPULAR_TOPICS_HEADLINE_NUMBER_BLOCK_COUNT
+        )