From e5535f12f7e5b21cd5b1457146e83b0e7984de77 Mon Sep 17 00:00:00 2001 From: Andy Chosak Date: Mon, 17 Jun 2024 14:27:51 -0400 Subject: [PATCH] Simplify usage of ItemIntroduction Commit 7cebc54f09f8510f4b8ce8836c7b5f609677b712 fixed a bug related to how the ItemIntroduction organism is rendered. This went undiscovered because we didn't have tests for the II. This commit adds a unit test for the II module and also simplifies its invocation across the various page types. Some local URLs to test to verify that this doesn't impact rendering: - http://localhost:8000/about-us/blog/recuperese-y-preparese-financieramente-para-las-tormentas/ - http://localhost:8000/enforcement/actions/pennsylvania-higher-education-assistance-agency-pheaa-dba-american-education-services-or-aes/ - http://localhost:8000/rules-policy/notice-opportunities-comment/commenting-on-notices/ - http://localhost:8000/data-research/research-reports/2012-college-credit-card-agreements/ --- cfgov/hmda/jinja2/hmda/hmda-explorer.html | 7 +- cfgov/v1/jinja2/v1/document-detail/index.html | 3 +- .../jinja2/v1/enforcement-action/index.html | 12 +--- cfgov/v1/jinja2/v1/includes/article.html | 10 +-- .../includes/organisms/item-introduction.html | 52 +++++++------- cfgov/v1/jinja2/v1/learn-page/index.html | 7 +- .../organisms/test_organisms.py | 67 +++++++++++++++++++ 7 files changed, 103 insertions(+), 55 deletions(-) diff --git a/cfgov/hmda/jinja2/hmda/hmda-explorer.html b/cfgov/hmda/jinja2/hmda/hmda-explorer.html index 6ae1bdf86c2..7a332c10972 100644 --- a/cfgov/hmda/jinja2/hmda/hmda-explorer.html +++ b/cfgov/hmda/jinja2/hmda/hmda-explorer.html @@ -3,17 +3,12 @@ {% import 'hmda-explorer-controls.html' as controls with context %} {% import 'hmda-explorer-results.html' as results with context %} {% import 'hmda-explorer-institutions.html' as institutions with context %} -{% import 'v1/includes/organisms/item-introduction.html' as item_introduction with context %} {% import 'v1/includes/templates/render_block.html' as render_block with context %} {% import 'v1/includes/templates/streamfield-sidefoot.html' as streamfield_sidefoot with context %} {% block content_main %} {% for block in page.header -%} - {% if block.block_type == 'item_introduction' %} - {{ item_introduction.render(block.value) }} - {% else %} - {{ render_block.render(block, loop.index) }} - {% endif %} + {{ render_block.render(block, loop.index) }} {%- endfor %}
diff --git a/cfgov/v1/jinja2/v1/document-detail/index.html b/cfgov/v1/jinja2/v1/document-detail/index.html index b53e2f34b8d..b92ec0b0e98 100644 --- a/cfgov/v1/jinja2/v1/document-detail/index.html +++ b/cfgov/v1/jinja2/v1/document-detail/index.html @@ -6,8 +6,7 @@ {% block content_main %} {% for block in page.header -%} {% if block.block_type == 'item_introduction' %} - {% import 'v1/includes/organisms/item-introduction.html' as item_introduction with context %} - {{ item_introduction.render(block.value) }} + {% include_block block %} {% else %}
diff --git a/cfgov/v1/jinja2/v1/enforcement-action/index.html b/cfgov/v1/jinja2/v1/enforcement-action/index.html index 9dc5a6bf28c..8b44bf1a229 100644 --- a/cfgov/v1/jinja2/v1/enforcement-action/index.html +++ b/cfgov/v1/jinja2/v1/enforcement-action/index.html @@ -6,15 +6,9 @@ {% block content_main %} {% for block in page.header -%} - {% if block.block_type == 'item_introduction' %} - {% import 'v1/includes/organisms/item-introduction.html' as item_introduction with context %} - {{ item_introduction.render(block.value) }} - {% else %} -
- {% include_block block %} -
- {% endif %} +
+ {% include_block block %} +
{%- endfor %} {% for block in page.content -%} diff --git a/cfgov/v1/jinja2/v1/includes/article.html b/cfgov/v1/jinja2/v1/includes/article.html index 70be5cf046a..eabdc7e392b 100644 --- a/cfgov/v1/jinja2/v1/includes/article.html +++ b/cfgov/v1/jinja2/v1/includes/article.html @@ -24,7 +24,6 @@ ========================================================================== #} -{% import 'v1/includes/organisms/item-introduction.html' as item_introduction with context %} {%- import 'v1/includes/templates/render_block.html' as render_block with context -%} {%- import 'v1/includes/tags.html' as tags -%} @@ -38,8 +37,7 @@
- {% set data = { - 'category': page.categories.all(), + {% set item_intro_data = { 'heading': page.title, 'date': page.date_published, 'has_social': True, @@ -48,11 +46,13 @@ {% for block in page.header -%} {% if block.block_type == 'article_subheader' %} - {% do data.update({'paragraph': block.value}) %} + {% do item_intro_data.update({'paragraph': block.value}) %} {% endif %} {% endfor %} - {{ item_introduction.render(data) }} + {% with value = item_intro_data -%} + {% include 'v1/includes/organisms/item-introduction.html' %} + {%- endwith %}
diff --git a/cfgov/v1/jinja2/v1/includes/organisms/item-introduction.html b/cfgov/v1/jinja2/v1/includes/organisms/item-introduction.html index f21b3765f59..70810ffd8fb 100644 --- a/cfgov/v1/jinja2/v1/includes/organisms/item-introduction.html +++ b/cfgov/v1/jinja2/v1/includes/organisms/item-introduction.html @@ -4,42 +4,42 @@ ========================================================================== - Description: - Create an Item Introduction molecule. See https://cfpb.github.io/design-system/patterns/item-introductions. - value: An object with the following options for value. + value: An object with the following options: value.show_category: Whether to show the category or not. value.heading: Heading text. value.paragraph.source: Body introduction text. - value.authors: Array of author names value.date: A datetime for the post. value.has_social: Whether to show the share icons or not. - value.social_options: An object with options for the share icons - ========================================================================== #} + page: The CFGOVPage object being rendered. + ========================================================================== #} -{% import 'v1/includes/molecules/social-media.html' as social_media with context %} -{% import 'v1/includes/macros/category-slug.html' as category_slug %} -{% macro render(value) %} +{%- import 'v1/includes/molecules/social-media.html' as social_media with context -%} +{%- import 'v1/includes/macros/category-slug.html' as category_slug -%} -{% set filter_page = page.get_filter_data() %} -{% set filter_page_url = pageurl(filter_page) if filter_page else none %} -{% set published_date = value.date %} -{% set has_authors = page.authors.exists() %} -{% set social_options = value.social_options or {} %} +{%- set filter_page = page.get_filter_data() %} +{%- set filter_page_url = pageurl(filter_page) if filter_page else none %} +{%- set authors = page.get_authors() -%}
- {% if filter_page_url and page.categories.count() > 0 and value.show_category %} + {% if value.show_category and filter_page_url -%} + {% set first_category = page.categories.first() -%} + {% if first_category -%}
- {{ category_slug.render(category=page.categories.first().name, href=filter_page_url) }} + {{ category_slug.render( + category=first_category.name, + href=filter_page_url + ) }}
- {% endif %} + {%- endif %} + {%- endif %} {% if value.heading -%}

{{ value.heading | safe }}

@@ -52,32 +52,30 @@

{{ value.heading | safe }}

{{ value.paragraph | safe }}
{% endif %} - {% if published_date or has_authors %} + {% if value.date or authors %}
{% endif %} - {% if filter_page_url and has_authors %} + {% if filter_page_url and authors %} - {%- for author in page.get_authors() -%} + {%- for author in authors -%} {% if loop.first %}By {% elif loop.last %}and {% endif %} {{ author }} {%- if loop.length > 2 and loop.index < loop.length %}, {% endif %} {% endfor %} - – + {% if value.date %}–{% endif %} {% endif %} - {% if published_date %} + {% if value.date %} {% import 'v1/includes/macros/time.html' as time %} - {{ time.render(published_date, {'date':true}) }} + {{ time.render(value.date, {'date':true}) }} {% endif %} - {% if published_date or has_authors %} + {% if value.date or authors %}
{% endif %} {% if value.has_social %} - {{ social_media.render(social_options) }} + {{ social_media.render(value.social_options or {}) }} {% endif %}
- -{% endmacro %} diff --git a/cfgov/v1/jinja2/v1/learn-page/index.html b/cfgov/v1/jinja2/v1/learn-page/index.html index 5b7cebde727..08a0affcf05 100644 --- a/cfgov/v1/jinja2/v1/learn-page/index.html +++ b/cfgov/v1/jinja2/v1/learn-page/index.html @@ -1,16 +1,11 @@ {% extends 'v1/layouts/layout-2-1.html' %} -{% import 'v1/includes/organisms/item-introduction.html' as item_introduction with context %} {% import 'v1/includes/templates/render_block.html' as render_block with context %} {% import 'v1/includes/templates/streamfield-sidefoot.html' as streamfield_sidefoot with context %} {% block content_main %} {% for block in page.header -%} - {% if block.block_type == 'item_introduction' %} - {{ item_introduction.render(block.value) }} - {% else %} - {{ render_block.render(block, loop.index) }} - {% endif %} + {{ render_block.render(block, loop.index) }} {%- endfor %} {% for block in page.content -%} diff --git a/cfgov/v1/tests/atomic_elements/organisms/test_organisms.py b/cfgov/v1/tests/atomic_elements/organisms/test_organisms.py index 43f1e4e3e15..3ca83d69c10 100644 --- a/cfgov/v1/tests/atomic_elements/organisms/test_organisms.py +++ b/cfgov/v1/tests/atomic_elements/organisms/test_organisms.py @@ -1,3 +1,5 @@ +from datetime import date + from django.core.exceptions import ValidationError from django.core.files import File from django.core.files.base import ContentFile @@ -9,16 +11,21 @@ from wagtailmedia.models import Media +from core.templatetags.svg_icon import svg_icon +from core.testutils.test_cases import WagtailPageTreeTestCase from scripts import _atomic_helpers as atomic from v1.atomic_elements.organisms import ( AudioPlayer, FeaturedContent, InfoUnitGroup, + ItemIntroduction, VideoPlayer, ) from v1.models import ( + BrowseFilterablePage, BrowsePage, CFGOVImage, + CFGOVPageCategory, Contact, LandingPage, LearnPage, @@ -399,6 +406,66 @@ def test_2575_with_some_images_fails(self): self.block.clean(value) +class ItemIntroductionTests(WagtailPageTreeTestCase): + @classmethod + def get_page_tree(cls): + return [ + ( + BrowseFilterablePage(title="landing"), + [LearnPage(title="intro")], + ) + ] + + def test_render(self): + # Related objects need to be added after page tree creation. + self.page_tree[1].authors.add("CFPB") + self.page_tree[1].categories.add(CFGOVPageCategory(name="at-the-cfpb")) + + block = ItemIntroduction() + value = block.to_python( + { + "heading": "An item introduction", + "date": date(2024, 1, 1), + "show_category": True, + } + ) + + html = block.render( + value, + context={ + "page": self.page_tree[1], + "request": RequestFactory().get("/intro/"), + }, + ) + + self.assertHTMLEqual( + html, + f""" +
+
+ + { svg_icon("bullhorn") } + + Category: + + At the CFPB + +
+

An item introduction

+
+ By CFPB + – + + + + + +
+
+""", + ) + + class VideoPlayerTests(SimpleTestCase): def test_video_id_required_by_default(self): block = VideoPlayer()