govuk_publishing_components 32.1.0 → 35.0.0

data/config/locales/zh.yml

@@ -1,12 +1,14 @@
 ---
 zh:
   common:
+    hide: 隐藏
+    show: 显示
+    toggle_less: 显示更少
+    toggle_more: "%{show} %{number}更多"
     translations: 翻译
   components:
     accordion:
-      hide: 隐藏
       hide_all: 隐藏所有小节
-      show: 显示
       show_all: 显示所有小节
       this_section_visually_hidden: " 本小节"
     article_schema:
@@ -37,8 +39,12 @@ zh:
       buttons:
         accept_cookies: 接受额外cookies
         reject_cookies: 拒绝额外cookies
-      confirmation_message_html: 您可以随时 %{link}。
-      confirmation_message_link: 更改您的cookie设置
+        view_cookies:
+      confirmation_message:
+        accepted:
+        html: 您可以随时 %{link}。
+        link: 更改您的cookie设置
+        rejected:
       hide: 隐藏此消息
       text:
       - 我们使用一些基本的cookie以使本网站运作。
@@ -107,7 +113,10 @@ zh:
       menu_toggle_label:
         hide:
         show:
-      navigation_links:
+      navigation_link:
+        href:
+        label:
+      navigation_links_columns:
       navigation_menu_heading:
       navigation_search_heading:
       navigation_search_subheading:
@@ -121,8 +130,6 @@ zh:
       part_of: 一部分
       published: 已发布
       see_all_updates: 查看全部更新
-      toggle_less: 显示更少
-      toggle_more: "+ %{number}更多"
     modal_dialogue:
       close_modal: 关闭模态对话
     notice:
@@ -154,13 +161,6 @@ zh:
       statistical_data_sets: 统计数据集
       topical_events: 局部事件
       topics: 探索本主题
-      transition:
-        hub_page_link_path: "/transition-check/questions"
-        hub_page_link_text: 获得个性化的操作列表
-        hub_page_title: 英国脱欧检查程序
-        link_path: "/brexit"
-        link_text: 检查您需要做的事情
-        title: 英国脱欧
       ukraine:
         links:
         title:

data/lib/govuk_publishing_components/app_helpers/asset_helper.rb

@@ -0,0 +1,86 @@
+module GovukPublishingComponents
+  module AppHelpers
+    module AssetHelper
+      # This is a list of all the components that have stylesheets - so a new
+      # component needs to be added to this list rather than being laboriously
+      # added and removed from every single rendering application.
+      COMPONENT_CSS_PATHS = Dir.glob("#{GovukPublishingComponents::Config.gem_directory}/app/assets/stylesheets/govuk_publishing_components/components/_*.scss").map { |path|
+        filename = path.split("/").last
+        component_name = filename.sub("_", "").sub(".scss", "")
+        "govuk_publishing_components/components/_#{component_name}.css"
+      }.freeze
+
+      # This list includes components already included in Static; taken from
+      # https://github.com/alphagov/static/blob/198a598682df40ce4a2c3c286c06244297c18cf0/app/assets/stylesheets/application.scss
+
+      # This is used to dedupe stylesheets.
+      STATIC_STYLESHEET_LIST = %w[
+        govuk_publishing_components/components/_breadcrumbs.css
+        govuk_publishing_components/components/_button.css
+        govuk_publishing_components/components/_error-message.css
+        govuk_publishing_components/components/_heading.css
+        govuk_publishing_components/components/_hint.css
+        govuk_publishing_components/components/_input.css
+        govuk_publishing_components/components/_label.css
+        govuk_publishing_components/components/_search.css
+        govuk_publishing_components/components/_skip-link.css
+        govuk_publishing_components/components/_textarea.css
+        govuk_publishing_components/components/_title.css
+
+        govuk_publishing_components/components/_cookie-banner.css
+        govuk_publishing_components/components/_feedback.css
+        govuk_publishing_components/components/_layout-footer.css
+        govuk_publishing_components/components/_layout-for-public.css
+        govuk_publishing_components/components/_layout-header.css
+        govuk_publishing_components/components/_layout-super-navigation-header.css
+      ].freeze
+
+      def add_stylesheet_path(component_path)
+        unless is_already_used?(component_path)
+          all_component_stylesheets_being_used << component_path
+        end
+      end
+
+      # Used to add a component that exists in the gem to the list
+      def add_gem_component_stylesheet(gem_component)
+        add_stylesheet_path("govuk_publishing_components/components/_#{gem_component}.css")
+      end
+
+      # Used to add a component that exists in the application to the list
+      def add_app_component_stylesheet(app_component)
+        add_stylesheet_path("components/_#{app_component}.css")
+      end
+
+      # Some applications have view-specific stylesheets - use this method
+      # to add them to the list
+      def add_view_stylesheet(view_component)
+        add_stylesheet_path("views/_#{view_component}.css")
+      end
+
+      def all_component_stylesheets_being_used
+        @all_component_stylesheets_being_used ||= []
+      end
+
+      def render_component_stylesheets
+        list_of_stylesheets = all_component_stylesheets_being_used.map do |component|
+          stylesheet_link_tag(component, integrity: false)
+        end
+        raw(list_of_stylesheets.join(""))
+      end
+
+      def get_component_css_paths
+        COMPONENT_CSS_PATHS
+      end
+
+    private
+
+      def is_already_used?(component)
+        if GovukPublishingComponents::Config.exclude_css_from_static
+          all_component_stylesheets_being_used.include?(component) || STATIC_STYLESHEET_LIST.include?(component)
+        else
+          all_component_stylesheets_being_used.include?(component)
+        end
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/config.rb

@@ -12,12 +12,12 @@ module GovukPublishingComponents
     mattr_accessor :application_stylesheet
     self.application_stylesheet = "application"
 
-    mattr_accessor :application_print_stylesheet
-    self.application_print_stylesheet = "print"
-
     mattr_accessor :application_javascript
     self.application_javascript = "application"
 
+    mattr_accessor :exclude_css_from_static
+    self.exclude_css_from_static = true
+
     def self.component_directory_name
       APP_COMPONENT_DIRECTORY
     end

data/lib/govuk_publishing_components/presenters/accordion_helper.rb

@@ -0,0 +1,38 @@
+module GovukPublishingComponents
+  module Presenters
+    class AccordionHelper
+      def initialise; end
+
+      def translations
+        {
+          show_text: "common.show",
+          hide_text: "common.hide",
+          show_all_text: "components.accordion.show_all",
+          hide_all_text: "components.accordion.hide_all",
+          this_section_visually_hidden: "components.accordion.this_section_visually_hidden",
+        }
+      end
+
+      def apply_translations
+        shared_helper = GovukPublishingComponents::Presenters::SharedHelper.new({})
+        locales = {}
+        data_attributes = {}
+
+        translations.each do |key, translation|
+          locales[key] = shared_helper.t_locale(translation)
+          data_attributes[key] = I18n.translate(translation)
+        end
+
+        unique_locales = locales.values.uniq
+
+        if unique_locales.length > 1
+          data_attributes[:locale] = locales
+        elsif unique_locales[0] != I18n.locale
+          data_attributes[:locale] = unique_locales[0]
+        end
+
+        data_attributes
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/breadcrumb_selector.rb

@@ -3,10 +3,11 @@ module GovukPublishingComponents
     class BreadcrumbSelector
       attr_reader :content_item, :request, :prioritise_taxon_breadcrumbs
 
-      def initialize(content_item, request, prioritise_taxon_breadcrumbs)
+      def initialize(content_item, request, prioritise_taxon_breadcrumbs, ga4_tracking)
         @content_item = content_item
         @request = request
         @prioritise_taxon_breadcrumbs = prioritise_taxon_breadcrumbs
+        @ga4_tracking = ga4_tracking
       end
 
       def breadcrumbs
@@ -37,7 +38,7 @@ module GovukPublishingComponents
         elsif navigation.content_tagged_to_current_step_by_step?
           {
             step_by_step: true,
-            breadcrumbs: navigation.step_nav_helper.header,
+            breadcrumbs: navigation.step_nav_helper.header(@ga4_tracking),
           }
         elsif navigation.content_is_tagged_to_a_live_taxon? && prioritise_taxon_breadcrumbs
           {

data/lib/govuk_publishing_components/presenters/{breadcrumbs.rb → breadcrumbs_helper.rb}

@@ -58,6 +58,14 @@ module GovukPublishingComponents
             dimension28: breadcrumbs_length.to_s,
             dimension29: crumb[:title],
           },
+          ga4_link: {
+            event_name: "navigation",
+            type: "breadcrumbs",
+            index: {
+              index_link: index.to_s,
+            },
+            index_total: breadcrumbs_length.to_s,
+          },
         }
 
         is_homepage = crumb[:url] == "/"

data/lib/govuk_publishing_components/presenters/button_helper.rb

@@ -23,7 +23,9 @@ module GovukPublishingComponents
                   :name,
                   :value,
                   :classes,
-                  :aria_label
+                  :aria_label,
+                  :aria_controls,
+                  :aria_describedby
 
       def initialize(local_assigns)
         @href = local_assigns[:href]
@@ -36,7 +38,8 @@ module GovukPublishingComponents
           @info_text_classes << margin_class
         end
         @rel = local_assigns[:rel]
-        @data_attributes = local_assigns[:data_attributes]
+        @data_attributes = local_assigns[:data_attributes]&.symbolize_keys || {}
+        @data_attributes[:module] = "govuk-button #{data_attributes[:module]}".strip if link?
         @margin_bottom = local_assigns[:margin_bottom]
         @inline_layout = local_assigns[:inline_layout]
         @target = local_assigns[:target]
@@ -52,6 +55,8 @@ module GovukPublishingComponents
         @aria_label = local_assigns[:aria_label]
         @info_text_id = "info-text-id-#{SecureRandom.hex(4)}"
         @button_id = "button-id-#{SecureRandom.hex(4)}"
+        @aria_controls = local_assigns[:aria_controls]
+        @aria_describedby = local_assigns[:aria_describedby]
       end
 
       def link?
@@ -90,6 +95,8 @@ module GovukPublishingComponents
         options[:name] = name if name.present? && value.present?
         options[:value] = value if name.present? && value.present?
         options[:aria] = { label: aria_label } if aria_label
+        options[:aria][:controls] =  aria_controls if aria_controls
+        options[:aria][:describedby] = aria_describedby if aria_describedby
         options[:draggable] = false if link?
         options
       end

data/lib/govuk_publishing_components/presenters/component_wrapper_helper.rb

@@ -0,0 +1,95 @@
+module GovukPublishingComponents
+  module Presenters
+    class ComponentWrapperHelper
+      def initialize(options)
+        @options = options
+
+        check_id_is_valid(@options[:id]) if @options.include?(:id)
+        check_classes_are_valid(@options[:classes]) if @options.include?(:classes)
+        check_aria_is_valid(@options[:aria]) if @options.include?(:aria)
+        check_role_is_valid(@options[:role]) if @options.include?(:role)
+      end
+
+      def all_attributes
+        attributes = {}
+
+        attributes[:id] = @options[:id] if @options[:id]
+        attributes[:data] = @options[:data_attributes] if @options[:data_attributes]
+        attributes[:aria] = @options[:aria] if @options[:aria]
+        attributes[:class] = @options[:classes] if @options[:classes]
+        attributes[:role] = @options[:role] if @options[:role]
+
+        attributes
+      end
+
+      def set_id(id)
+        check_id_is_valid(id)
+        @options[:id] = id
+      end
+
+      def add_class(classes)
+        check_classes_are_valid(classes)
+        extend_string(:classes, classes)
+      end
+
+      def add_data_attribute(attributes)
+        extend_object(:data_attributes, attributes)
+      end
+
+      def add_aria_attribute(attributes)
+        check_aria_is_valid(attributes)
+        extend_object(:aria, attributes)
+      end
+
+      def add_role(role)
+        check_role_is_valid(role)
+        extend_string(:role, role)
+      end
+
+    private
+
+      def check_id_is_valid(id)
+        raise(ArgumentError, "Id cannot start with a number or contain whitespace and can only contain letters, digits, `_` and `-`") unless /^[a-zA-Z][\w:-]*$/.match?(id)
+      end
+
+      def check_classes_are_valid(classes)
+        classes = classes.split(" ")
+        unless classes.all? { |c| c.start_with?("js-", "gem-c-", "govuk-", "brand--") }
+          raise(ArgumentError, "Passed classes must be prefixed with `js-`")
+        end
+      end
+
+      def check_aria_is_valid(attributes)
+        arias = %w[activedescendant atomic autocomplete busy checked colcount colindex colspan controls current describedby description details disabled dropeffect errormessage expanded flowto grabbed haspopup hidden invalid keyshortcuts label labelledby level live modal multiline multiselectable orientation owns placeholder posinset pressed readonly relevant required roledescription rowcount rowindex rowspan selected setsize sort valuemax valuemin valuenow valuetext]
+
+        unless attributes.all? { |key, _value| arias.include? key.to_s }
+          raise(ArgumentError, "Aria attribute is not recognised")
+        end
+      end
+
+      def check_role_is_valid(role)
+        roles = %w[alert alertdialog application article associationlist associationlistitemkey associationlistitemvalue banner blockquote caption cell code columnheader combobox complementary contentinfo definition deletion dialog directory document emphasis feed figure form group heading img insertion list listitem log main marquee math menu menubar meter navigation none note paragraph presentation region row rowgroup rowheader scrollbar search searchbox separator separator slider spinbutton status strong subscript superscript switch tab table tablist tabpanel term time timer toolbar tooltip tree treegrid treeitem]
+        role = role.split(" ") # can have more than one role
+        unless role.all? { |r| roles.include? r }
+          raise(ArgumentError, "Role attribute is not recognised")
+        end
+      end
+
+      def extend_string(option, string)
+        ((@options[option] ||= "") << " #{string}").strip!
+      end
+
+      def extend_object(option, object)
+        @options[option] ||= {}
+        object.each_key do |key|
+          @options[option][key] =
+            if @options[option].key?(key)
+              "#{@options[option][key]} #{object[key]}"
+            else
+              object[key]
+            end
+        end
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/image_card_helper.rb

@@ -4,14 +4,15 @@ module GovukPublishingComponents
       include ActionView::Helpers
       include ActionView::Context
 
-      attr_reader :href, :href_data_attributes, :extra_details, :large, :extra_details_no_indent, :heading_text, :metadata, :lang, :image_loading
+      attr_reader :href_data_attributes, :extra_details, :extra_details_no_indent, :heading_text, :metadata, :lang, :image_loading, :youtube_video_id, :image_src
 
-      def initialize(local_assigns)
+      def initialize(local_assigns, brand_helper)
         @href = local_assigns[:href]
         @href_data_attributes = local_assigns[:href_data_attributes]
         @extra_details = local_assigns[:extra_details] || []
         @image_src = local_assigns[:image_src]
         @image_alt = local_assigns[:image_alt] || ""
+        @youtube_video_alt = local_assigns[:youtube_video_alt]
         @image_loading = local_assigns[:image_loading] || "auto"
         @srcset = local_assigns[:srcset] || nil
         @sizes = local_assigns[:sizes] || nil
@@ -23,6 +24,22 @@ module GovukPublishingComponents
         @extra_details_no_indent = local_assigns[:extra_details_no_indent]
         @metadata = local_assigns[:metadata]
         @lang = local_assigns[:lang]
+        @youtube_video_id = local_assigns[:youtube_video_id] || nil
+
+        @brand_helper = brand_helper
+      end
+
+      def href
+        return youtube_href if @youtube_video_id
+
+        @href
+      end
+
+      def large
+        # if youtube video, we don't want to use
+        # the small variant, large will be always
+        # true if a youtube_video_id is supplied
+        @youtube_video_id || @large
       end
 
       def is_tracking?
@@ -36,6 +53,12 @@ module GovukPublishingComponents
         false
       end
 
+      def media
+        return youtube_link if @youtube_video_id
+
+        image
+      end
+
       def image
         if @image_src
           content_tag(:figure, class: "gem-c-image-card__image-wrapper") do
@@ -75,6 +98,46 @@ module GovukPublishingComponents
       def description
         content_tag(:div, @description, class: "gem-c-image-card__description") if @description
       end
+
+      def youtube_href
+        "https://www.youtube.com/watch?v=#{@youtube_video_id}"
+      end
+
+      def youtube_thumbnail_url
+        "https://img.youtube.com/vi/#{@youtube_video_id}/maxresdefault.jpg"
+      end
+
+      def youtube_thumbnail
+        thumbnail = content_tag(:div, class: "gem-c-image-card__youtube-thumbnail-image-container") do
+          image_tag(
+            youtube_thumbnail_url,
+            class: "gem-c-image-card__image gem-c-image-card__youtube-thumbnail-image",
+            alt: "",
+            loading: @image_loading,
+          )
+        end
+        thumbnail + content_tag(:figcaption, @youtube_video_alt, class: "gem-c-image-card__youtube-thumbnail-container-text govuk-link #{@brand_helper.color_class}")
+      end
+
+      def youtube_link
+        content_tag(
+          :figure,
+          class: "gem-c-image-card__image-wrapper gem-c-image-card__image-wrapper--youtube-embed",
+        ) do
+          content_tag(:div) do
+            link_to(
+              href,
+              {
+                class: "govuk-body govuk-link gem-c-image-card__youtube-thumbnail-container js-youtube-card-embed",
+                "data-youtube-player-analytics": true,
+                "data-youtube-player-analytics-category": "EmbeddedYoutube",
+              },
+            ) do
+              youtube_thumbnail
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/govuk_publishing_components/presenters/page_with_step_by_step_navigation.rb

@@ -77,17 +77,18 @@ module GovukPublishingComponents
         if show_sidebar?
           @sidebar ||= current_step_nav.content.tap do |sb|
             configure_for_sidebar(sb)
-            sb.merge!(small: true, heading_level: 3, tracking_id: current_step_nav.content_id)
+            sb.merge!(small: true, heading_level: 3, tracking_id: current_step_nav.content_id, ga4_tracking: @query_parameters[:ga4_tracking])
           end
         end
       end
 
-      def header
+      def header(ga4_tracking)
         if show_header?
           {
             title: current_step_nav.title,
             path: current_step_nav.base_path,
             tracking_id: current_step_nav.content_id,
+            ga4_tracking: ga4_tracking,
           }
         else
           {}

data/lib/govuk_publishing_components/presenters/related_navigation_helper.rb

@@ -53,18 +53,27 @@ module GovukPublishingComponents
         end
       end
 
-      def construct_section_heading(section_title)
-        unless section_title == "related_items"
+      def construct_section_text(section, underscores_to_spaces)
+        unless section == "related_items"
+          defaults = [I18n.t("components.related_navigation.#{section}")]
+          defaults << section.tr("_", " ") if underscores_to_spaces
+
           I18n.t(
-            "components.related_#{@context}_navigation." + section_title,
-            default: [
-              I18n.t("components.related_navigation.#{section_title}"),
-              section_title.tr("_", " "),
-            ],
+            "components.related_#{@context}_navigation.#{section}",
+            default: defaults,
           )
         end
       end
 
+      def construct_ga4_section_text(section)
+        # Force English so we can still understand what is being tracked if translated.
+        underscores_to_spaces = true
+        underscores_to_spaces = false if section == "related_content"
+        I18n.with_locale(:en) do
+          construct_section_text(section, underscores_to_spaces)
+        end
+      end
+
       def section_css_class(css_class, section_title, link: {}, link_is_inline: false)
         css_classes = [css_class]
         css_classes << "#{css_class}--#{@context}" unless @context.nil?

data/lib/govuk_publishing_components/presenters/single_page_notification_button_helper.rb

@@ -1,7 +1,7 @@
 module GovukPublishingComponents
   module Presenters
     class SinglePageNotificationButtonHelper
-      attr_reader :already_subscribed, :data_attributes, :base_path, :js_enhancement, :button_type, :button_location, :classes
+      attr_reader :already_subscribed, :data_attributes, :base_path, :js_enhancement, :button_type, :button_location, :classes, :skip_account
 
       def initialize(local_assigns)
         @local_assigns = local_assigns
@@ -13,6 +13,9 @@ module GovukPublishingComponents
         @button_type = @local_assigns[:already_subscribed] ? "Unsubscribe" : "Subscribe"
         @classes = %w[gem-c-single-page-notification-button]
         @classes << "js-personalisation-enhancement" if js_enhancement
+        @button_text_subscribe = custom_button_text_is_valid? ? custom_subscribe_text : default_subscribe_text
+        @button_text_unsubscribe = custom_button_text_is_valid? ? custom_unsubscribe_text : default_unsubscribe_text
+        @skip_account = @local_assigns[:skip_account] || nil
       end
 
       def data
@@ -24,6 +27,8 @@ module GovukPublishingComponents
         @data_attributes[:track_category] = "Single-page-notification-button"
         # This attribute is passed through to the personalisation API to ensure when a new button is returned from the API, it has the same button_location
         @data_attributes[:button_location] = button_location
+        @data_attributes[:button_text_subscribe] = @button_text_subscribe
+        @data_attributes[:button_text_unsubscribe] = @button_text_unsubscribe
         @data_attributes
       end
 
@@ -32,7 +37,43 @@ module GovukPublishingComponents
       end
 
       def button_text
-        @already_subscribed ? I18n.t("components.single_page_notification_button.unsubscribe_text") : I18n.t("components.single_page_notification_button.subscribe_text")
+        @already_subscribed ? @button_text_unsubscribe : @button_text_subscribe
+      end
+
+      def custom_button_text_is_valid?
+        custom_subscribe_text.present? && custom_unsubscribe_text.present?
+      end
+
+      def custom_subscribe_text
+        @local_assigns.dig(:button_text, :subscribe)
+      end
+
+      def custom_unsubscribe_text
+        @local_assigns.dig(:button_text, :unsubscribe)
+      end
+
+      def default_subscribe_text
+        I18n.t("components.single_page_notification_button.subscribe_text")
+      end
+
+      def default_unsubscribe_text
+        I18n.t("components.single_page_notification_button.unsubscribe_text")
+      end
+
+      def form_action
+        @skip_account ? email_alert_frontend_endpoint_no_account : email_alert_frontend_endpoint_enforce_account
+      end
+
+      def email_alert_frontend_endpoint_enforce_account
+        "/email/subscriptions/single-page/new"
+      end
+
+      def email_alert_frontend_endpoint_no_account
+        "/email-signup"
+      end
+
+      def skip_account_param
+        "single_page_subscription"
       end
     end
   end

data/lib/govuk_publishing_components/presenters/step_by_step_nav_helper.rb

@@ -46,6 +46,7 @@ module GovukPublishingComponents
                 :li,
                 class: "gem-c-step-nav__list-item js-list-item #{link_active(contents[:active])}",
               ) do
+                @options[:ga4_index_total] = element[:contents].length if @options[:ga4_tracking]
                 create_list_item_content(contents)
               end,
             )
@@ -64,11 +65,26 @@ module GovukPublishingComponents
             concat create_context(link[:context])
           end
 
+          ga4_link_data ||= nil
+          if @options[:ga4_tracking]
+            ga4_link_data = {
+              "event_name": "navigation",
+              "type": "step by step",
+              "index": {
+                "index_section": (@options[:step_index] + 1).to_s,
+                "index_link": @link_index.to_s,
+              },
+              "index_total": @options[:ga4_index_total].to_s,
+              "section": @options[:step_title],
+            }.to_json
+          end
+
           link_to(
             href,
             rel: ("external" if href.start_with?("http")),
             data: {
               position: "#{@options[:step_index] + 1}.#{@link_index}",
+              ga4_link: ga4_link_data,
             },
             class: "gem-c-step-nav__link js-link",
           ) do

data/lib/govuk_publishing_components/railtie.rb

@@ -0,0 +1,7 @@
+module GovukPublishingComponents
+  class Railtie < Rails::Railtie
+    initializer "govuk_publishing_components.view_helpers" do
+      ActiveSupport.on_load(:action_view) { include GovukPublishingComponents::AppHelpers::AssetHelper }
+    end
+  end
+end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "32.1.0".freeze
+  VERSION = "35.0.0".freeze
 end