EWPP-6963: Add the "Subscribe for updates" action button to the site footer.

Author: 22Alexandra

composer.json

@@ -49,9 +49,9 @@
         "openeuropa/code-review-drupal": "^1.0.0-alpha1",
         "openeuropa/oe_contact_forms": "^1.24.0",
         "openeuropa/oe_content": "4.x-dev",
-        "openeuropa/oe_corporate_blocks": "5.x-dev",
+        "openeuropa/oe_corporate_blocks": "dev-EWPP-6963",
         "openeuropa/oe_corporate_countries": "2.x-dev",
-        "openeuropa/oe_corporate_site_info": "1.x-dev",
+        "openeuropa/oe_corporate_site_info": "dev-EWPP-6963",
         "openeuropa/oe_media": "dev-master as 1.37.0",
         "openeuropa/oe_multilingual": "dev-master",
         "openeuropa/oe_paragraphs": "dev-master",

oe_theme.theme

@@ -1708,6 +1708,7 @@ function oe_theme_preprocess_oe_corporate_blocks_ec_footer(array &$variables) {
 
   _oe_theme_preprocess_site_specific_footer_links($variables);
   _oe_theme_preprocess_accessibility_link($variables);
+  _oe_theme_preprocess_subscribe_link($variables);
 }
 
 /**
@@ -1729,6 +1730,7 @@ function oe_theme_preprocess_oe_corporate_blocks_eu_footer(array &$variables) {
 
   _oe_theme_preprocess_site_specific_footer_links($variables);
   _oe_theme_preprocess_accessibility_link($variables);
+  _oe_theme_preprocess_subscribe_link($variables);
 
   // Hide the default Accessibility link inside "Legal" section for
   // standardised ECL branding.
@@ -1844,6 +1846,17 @@ function _oe_theme_preprocess_accessibility_link(array &$variables) {
   $variables['accessibility_link'] = $variables['accessibility_link']->toString();
 }
 
+/**
+ * Get the Subscribe for updates link.
+ */
+function _oe_theme_preprocess_subscribe_link(array &$variables) {
+  if (!isset($variables['subscribe_link']) || !$variables['subscribe_link'] instanceof Url) {
+    return;
+  }
+
+  $variables['subscribe_link'] = $variables['subscribe_link']->toString();
+}
+
 /**
  * Implements hook_preprocess_HOOK().
  */

templates/navigation/oe-corporate-blocks-ec-footer--core.html.twig

@@ -16,6 +16,21 @@
 {% else %}
   {% set site_owner_description = site_owner ? 'This site is managed by:<br />@name'|t({'@name': site_owner|first}) %}
 {% endif %}
+{# Build the "Subscribe for updates" action button, if a link is provided. #}
+{% set _action_button = [] %}
+{% if subscribe_link is not empty %}
+  {% set _action_button = {
+    'link': {
+      'label': 'Subscribe for updates'|t,
+      'path': subscribe_link,
+    },
+    'icon': {
+      'name': 'envelope-simple',
+      'family': 'phosphor',
+      'style': 'inverted',
+    },
+  } %}
+{% endif %}
 {% set section_site_info = {
   'logo': {
     'picture': {
@@ -28,6 +43,7 @@
     'path': path,
   },
   'description': site_owner ? site_owner_description,
+  'action_button': _action_button,
 } %}
 
 {# Populate the core section. #}

templates/navigation/oe-corporate-blocks-ec-footer--standardised.html.twig

@@ -16,6 +16,21 @@
 {% else %}
   {% set site_owner_description = site_owner ? 'This site is managed by:<br />@name'|t({'@name': site_owner|first}) %}
 {% endif %}
+{# Build the "Subscribe for updates" action button, if a link is provided. #}
+{% set _action_button = [] %}
+{% if subscribe_link is not empty %}
+  {% set _action_button = {
+    'link': {
+      'label': 'Subscribe for updates'|t,
+      'path': subscribe_link,
+    },
+    'icon': {
+      'name': 'envelope-simple',
+      'family': 'phosphor',
+      'style': 'inverted',
+    },
+  } %}
+{% endif %}
 {% set section_site_info = {
   'title': {
     'link': {
@@ -30,6 +45,7 @@
     }
   },
   'description': site_owner ? site_owner_description,
+  'action_button': _action_button,
 } %}
 
 {% if site_specific_footer.social_links is not empty %}

templates/navigation/oe-corporate-blocks-eu-footer--core.html.twig

@@ -15,6 +15,21 @@
 {% else %}
   {% set site_owner_description = site_owner ? 'This site is managed by:<br />@name'|t({'@name': site_owner|first}) %}
 {% endif %}
+{# Build the "Subscribe for updates" action button, if a link is provided. #}
+{% set _action_button = [] %}
+{% if subscribe_link is not empty %}
+  {% set _action_button = {
+    'link': {
+      'label': 'Subscribe for updates'|t,
+      'path': subscribe_link,
+    },
+    'icon': {
+      'name': 'envelope-simple',
+      'family': 'phosphor',
+      'style': 'inverted',
+    },
+  } %}
+{% endif %}
 {% set _row = [
   [
     {
@@ -27,6 +42,7 @@
         'alt': 'European Union flag'|t,
       },
       'description': site_owner ? site_owner_description,
+      'action_button': _action_button,
     },
   ],
   [

templates/navigation/oe-corporate-blocks-eu-footer--standardised.html.twig

@@ -94,6 +94,7 @@
         },
         'description': site_owner ? site_owner_description,
         'links': _top_row_links,
+        'action_button': _action_button,
         'section_class_name': 'ecl-site-footer__section--site-info',
       }
     ],

tests/src/Functional/CorporateFooterRenderTest.php

@@ -104,6 +104,9 @@ public function testCorporateFooterRendering(): void {
     // Site owner is not set yet, let's make sure we don't have a description.
     $assert->elementNotExists('css', 'div.ecl-site-footer__description');
 
+    // The subscribe action button is not rendered without a subscribe link.
+    $assert->elementNotExists('css', 'footer.ecl-site-footer a.ecl-site-footer__action-button');
+
     $section = $assert->elementExists('css', 'footer.ecl-site-footer div.ecl-site-footer__row--specific div.ecl-site-footer__section--core');
     foreach (array_values($ec_core_links) as $key => $expected) {
       $index = $key + 1;
@@ -120,13 +123,20 @@ public function testCorporateFooterRendering(): void {
       $this->assertListLink($actual, $expected);
     }
 
+    // Set a subscribe link in the corporate site information settings.
+    $this->configFactory->getEditable('oe_corporate_site_info.settings')->set('subscribe', 'https://example.com/subscribe')->save();
+
     // Update settings, assert footer changed.
     $this->updateSiteSettings(['http://publications.europa.eu/resource/authority/corporate-body/ACP-EU_JA'], 'EC Site Name');
     $this->drupalGet('<front>');
 
     $actual = $assert->elementExists('css', 'div.ecl-site-footer__description');
     $this->assertEquals('This site is managed by:ACP–EU Joint Assembly', $actual->getText());
 
+    // Assert the subscribe action button in the site info section.
+    $section = $assert->elementExists('css', 'footer.ecl-site-footer div.ecl-site-footer__row--specific div.ecl-site-footer__section--site-info');
+    $this->assertSubscribeActionButton($section, 'secondary-inverted', 'https://example.com/subscribe');
+
     // Test European Commission footer standardised block rendering.
     $this->branding = 'standardised';
     $this->configFactory->getEditable('oe_theme.settings')->set('branding', $this->branding)->save();
@@ -154,6 +164,9 @@ public function testCorporateFooterRendering(): void {
     $actual = $section->find('css', 'div.ecl-site-footer__description');
     $this->assertEquals('This site is managed by:ACP–EU Joint Assembly', $actual->getText());
 
+    // Assert the subscribe action button in the site info section.
+    $this->assertSubscribeActionButton($section, 'secondary-inverted', 'https://example.com/subscribe');
+
     $section = $assert->elementExists('css', 'footer.ecl-site-footer div.ecl-site-footer__row--common');
     // Assert presence of ecl logo in the standardised footer.
     $this->assertEclLogoPresence($section);
@@ -240,6 +253,9 @@ public function testCorporateFooterRendering(): void {
     // Assert presence of ecl logo in the core footer.
     $this->assertEclLogoPresence($section);
 
+    // Assert the subscribe action button in the site info section.
+    $this->assertSubscribeActionButton($section, 'secondary-neutral', 'https://example.com/subscribe');
+
     $column = $assert->elementExists('css', 'footer.ecl-site-footer div.ecl-site-footer__column:nth-child(2)');
     $subsection = $assert->elementExists('css', '.ecl-site-footer__section:nth-child(1)', $column);
 
@@ -332,6 +348,9 @@ public function testCorporateFooterRendering(): void {
     $this->assertEquals('Accessibility', $actual->getText());
     $this->assertEquals('/build/', $actual->getAttribute('href'));
 
+    // Assert the subscribe action button in the site info section.
+    $this->assertSubscribeActionButton($section, 'secondary-neutral', 'https://example.com/subscribe');
+
     $section = $assert->elementExists('css', 'footer.ecl-site-footer div.ecl-site-footer__row:nth-child(2) div.ecl-site-footer__column:nth-child(1) div.ecl-site-footer__section:nth-child(1)');
 
     $actual = $section->find('css', 'div.ecl-site-footer__description');
@@ -915,6 +934,26 @@ public function testCorporateFooterRendering(): void {
     $assert->elementNotExists('css', 'footer.ecl-site-footer div.ecl-site-footer__row--specific .ecl-social-media-follow');
   }
 
+  /**
+   * Asserts the "Subscribe for updates" action button in a site info section.
+   *
+   * @param \Behat\Mink\Element\NodeElement $section
+   *   The footer site info section.
+   * @param string $type
+   *   The expected ECL link type, e.g. 'secondary-inverted'.
+   * @param string $href
+   *   The expected button link.
+   */
+  protected function assertSubscribeActionButton(NodeElement $section, string $type, string $href): void {
+    $button = $this->assertSession()->elementExists('css', 'a.ecl-site-footer__action-button', $section);
+    $this->assertEquals('Subscribe for updates', $button->getText());
+    $this->assertEquals($href, $button->getAttribute('href'));
+    $this->assertEquals("ecl-link ecl-link--{$type} ecl-link--icon ecl-site-footer__action-button ecl-button--m", $button->getAttribute('class'));
+    // Assert the default icon: "envelope-simple" from the "phosphor" family
+    // with the "inverted" style.
+    $this->assertSession()->elementExists('css', 'span.ecl-icon.ecl-icon-phosphor--envelope-simple.wt-icon--inverted.ecl-link__icon', $button);
+  }
+
   /**
    * Get fixture content.
    *