crown_marketplace_utils 0.1.0.beta.1 → 0.1.0.beta.3

data/lib/crown_marketplace_utils/gov_uk_helper/field.rb

@@ -0,0 +1,263 @@
+# frozen_string_literal: true
+
+require_relative 'fieldset'
+require_relative 'form_group'
+require_relative 'hint'
+require_relative 'label'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Field
+    #
+    # This module contains methods to wrap the:
+    # - fieldset
+    # - form group
+    # - label
+    # - hint
+    # - error message
+    # around some kind of input.
+    #
+    # The wrapper functions in this module are used
+    # to create the fields using the structure of a GDS input field component.
+
+    module Field
+      include Fieldset
+      include FormGroup
+      include Hint
+      include Label
+
+      # Generates the HTML to wrap arround a GDS input field component.
+      #
+      # @param type [Symbol] the type of the field
+      # @param attribute [String, Symbol] the attribute of the field
+      # @param error_message [String] the error message to be displayed
+      # @param govuk_field_options [Hash] options that will be used for the parts of the form group, label, hint and field
+      #
+      # @option govuk_field_options [Hash] :form_group_options ({}) the options for govuk_form_group {govuk_form_group}
+      # @option govuk_field_options [Hash] :label the parameters that will be used to create the label for the field:
+      #                                           - +:text+ (required) - the label text
+      #                                           - +:options+ - default: { } - the options for govuk_label {govuk_label}
+      # @option govuk_field_options [Hash] :hint (nil) the parameters that will be used to create the hint for the field
+      #                                                - +:text+ (required) - the hint text
+      #                                                - +:options+ - default: { } - the options for govuk_hint {govuk_hint}
+      #                                                If no hint is given then no hint will be rendered
+      # @option govuk_field_options [Hash] :field_options ({}) the options that will be used when rendering the field.
+      #                                                        For more details look at a module that uses +Field+.
+      #
+      # @yield the field HTML
+      #
+      # @yieldparam govuk_field_options [Hash] the HTML options used when rendering the field
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML that wraps arround the field
+
+      def govuk_field(type, attribute, error_message = nil, **govuk_field_options)
+        field_key = :"#{type}_options"
+
+        set_label_for_if_custom_id(field_key, govuk_field_options)
+        set_hint_id(attribute, govuk_field_options)
+
+        govuk_form_group(attribute, error_message, **(govuk_field_options[:form_group_options] || {})) do |display_error_message|
+          set_field_described_by(field_key, attribute, error_message, govuk_field_options)
+
+          capture do
+            concat(govuk_label(attribute, govuk_field_options[:label][:text], **govuk_field_options[:label][:options]))
+            concat(govuk_hint(govuk_field_options[:hint][:text], **govuk_field_options[:hint][:options])) if govuk_field_options[:hint]
+            concat(display_error_message)
+            yield(govuk_field_options[field_key])
+          end
+        end
+      end
+
+      # Generates the HTML to wrap arround a GDS input field component using an ActionView::Helpers::FormBuilder.
+      # Unlike {govuk_field}, the method will be able to automatically determine if the error message needs to be shown.
+      #
+      # @param type [Symbol] the type of the field
+      # @param form [ActionView::Helpers::FormBuilder] :form the form builder used to create the label
+      # @param attribute [String, Symbol] the attribute of the field
+      # @param govuk_field_options [Hash] options that will be used for the parts of the form group, label, hint and field
+      #
+      # @option govuk_field_options [Hash] :form_group_options ({}) the options for govuk_form_group {govuk_form_group}
+      # @option govuk_field_options [Hash] :label the parameters that will be used to create the label for the field:
+      #                                           - +:text+ (required) - the label text
+      #                                           - +:options+ - default: { } - the options for govuk_label {govuk_label}
+      # @option govuk_field_options [Hash] :hint (nil) the parameters that will be used to create the hint for the field
+      #                                                - +:text+ (required) - the hint text
+      #                                                - +:options+ - default: { } - the options for govuk_hint {govuk_hint}
+      #                                                If no hint is given then no hint will be rendered
+      # @option govuk_field_options [Hash] :field_options ({}) the options that will be used when rendering the field.
+      #                                                        For more details look at a module that uses +Field+.
+      #
+      # @yield the field HTML
+      #
+      # @yieldparam govuk_field_options [Hash] the HTML options used when rendering the field
+      # @yieldparam error_message [ActiveSupport::SafeBuffer] used by the field to indicate if there is an error
+      #
+      # @return (see govuk_field)
+
+      def govuk_field_with_form(type, form, attribute, **govuk_field_options)
+        field_key = :"#{type}_options"
+
+        set_label_for_if_custom_id(field_key, govuk_field_options)
+        set_hint_id(attribute, govuk_field_options)
+
+        govuk_form_group_with_model(form.object, attribute, **(govuk_field_options[:form_group_options] || {})) do |display_error_message|
+          set_field_described_by(field_key, attribute, display_error_message, govuk_field_options)
+
+          capture do
+            concat(govuk_label_with_form(form, attribute, govuk_field_options[:label][:text], **(govuk_field_options[:label][:options] || {})))
+            concat(govuk_hint(govuk_field_options[:hint][:text], **govuk_field_options[:hint][:options])) if govuk_field_options[:hint]
+            concat(display_error_message)
+            yield(govuk_field_options[field_key], display_error_message)
+          end
+        end
+      end
+
+      # Generates the HTML to wrap arround a GDS input fields component.
+      # These are inputs that require being wrapped in a fieldset, for example radio buttons.
+      #
+      # @param type [Symbol] the type of the fields
+      # @param attribute [String, Symbol] the attribute of the fields
+      # @param error_message [String] the error message to be displayed
+      # @param govuk_fields_options [Hash] options that will be used for the parts of the fieldset, form group, hint and fields
+      #
+      # @option govuk_fields_options [Hash] :form_group_options ({}) the options for govuk_form_group {govuk_form_group}
+      # @option govuk_fields_options [Hash] :fieldset_options ({}) the options for govuk_fieldset {govuk_fieldset}
+      # @option govuk_fields_options [Hash] :hint (nil) the parameters that will be used to create the hint for the fields
+      #                                                 - +:text+ (required) - the hint text
+      #                                                 - +:options+ - default: { } - the options for govuk_hint {govuk_hint}
+      #                                                 If no hint is given then no hint will be rendered
+      # @option govuk_fields_options [Hash] :field_options ({}) the options that will be used when rendering the fields.
+      #                                                         For more details look at a module that uses +Field+.
+      #
+      # @yield the fields HTML
+      #
+      # @yieldparam govuk_fields_options [Hash] the HTML options used when rendering the fields
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML that wraps arround the fields
+
+      def govuk_fields(type, attribute, error_message = nil, **govuk_fields_options)
+        field_key = :"#{type}_options"
+
+        set_hint_id(attribute, govuk_fields_options)
+
+        govuk_form_group(attribute, error_message, **(govuk_fields_options[:form_group_options] || {})) do |display_error_message|
+          set_field_described_by(:fieldset_options, attribute, error_message, govuk_fields_options)
+          (govuk_fields_options[field_key] ||= {})[:attributes] ||= {}
+
+          govuk_fieldset(**govuk_fields_options[:fieldset_options]) do
+            capture do
+              concat(govuk_hint(govuk_fields_options[:hint][:text], **govuk_fields_options[:hint][:options])) if govuk_fields_options[:hint]
+              concat(display_error_message)
+              yield(govuk_fields_options[field_key])
+            end
+          end
+        end
+      end
+
+      # Generates the HTML to wrap arround a GDS input fields component using an ActionView::Helpers::FormBuilder.
+      # These are inputs that require being wrapped in a fieldset, for example radio buttons.
+      #
+      # Unlike {govuk_fields}, the method will be able to automatically determine if the error message needs to be shown.
+      #
+      # @param type [Symbol] the type of the fields
+      # @param form [ActionView::Helpers::FormBuilder] :form the form builder used to create the label
+      # @param attribute [String, Symbol] the attribute of the fields
+      # @param govuk_fields_options [Hash] options that will be used for the parts of the fieldset, form group, hint and fields
+      #
+      # @option govuk_fields_options [Hash] :form_group_options ({}) the options for govuk_form_group {govuk_form_group}
+      # @option govuk_fields_options [Hash] :fieldset_options ({}) the options for govuk_fieldset {govuk_fieldset}
+      # @option govuk_fields_options [Hash] :hint (nil) the parameters that will be used to create the hint for the fields
+      #                                                 - +:text+ (required) - the hint text
+      #                                                 - +:options+ - default: { } - the options for govuk_hint {govuk_hint}
+      #                                                 If no hint is given then no hint will be rendered
+      # @option govuk_fields_options [Hash] :field_options ({}) the options that will be used when rendering the fields.
+      #                                                         For more details look at a module that uses +Field+.
+      #
+      # @yield the fields HTML
+      #
+      # @yieldparam govuk_fields_options [Hash] the HTML options used when rendering the fields
+      #
+      # @return (see govuk_fields)
+
+      def govuk_fields_with_form(type, form, attribute, **govuk_fields_options)
+        field_key = :"#{type}_options"
+
+        set_hint_id(attribute, govuk_fields_options)
+
+        govuk_form_group_with_model(form.object, attribute, **(govuk_fields_options[:form_group_options] || {})) do |display_error_message|
+          set_field_described_by(:fieldset_options, attribute, display_error_message, govuk_fields_options)
+          (govuk_fields_options[field_key] ||= {})[:attributes] ||= {}
+
+          govuk_fieldset(**govuk_fields_options[:fieldset_options]) do
+            capture do
+              concat(govuk_hint(govuk_fields_options[:hint][:text], **govuk_fields_options[:hint][:options])) if govuk_fields_options[:hint]
+              concat(display_error_message)
+              yield(govuk_fields_options[field_key])
+            end
+          end
+        end
+      end
+
+      private
+
+      # Sets the label +for+ if a custom ID has been given for the field.
+      #
+      # @param govuk_field_options [Hash] see {govuk_field} for details
+
+      def set_label_for_if_custom_id(field_key, govuk_field_options)
+        field_id = govuk_field_options.dig(field_key, :attributes, :id)
+
+        govuk_field_options[:label][:options] ||= {}
+        (govuk_field_options[:label][:options][:attributes] ||= {}).merge!({ for: field_id }) if field_id
+      end
+
+      # Sets the hint ID if there is a hint, and the ID for the hint has not been sent
+      #
+      # @param attribute [String, Symbol] the attribute of the field
+      # @param govuk_field_options [Hash] see {govuk_field} for details
+
+      def set_hint_id(attribute, govuk_field_options)
+        return if !govuk_field_options[:hint] || govuk_field_options.dig(:hint, :options, :attributes, :id)
+
+        govuk_field_options[:hint][:options] ||= {}
+        (govuk_field_options[:hint][:options][:attributes] ||= {}).merge!({ id: "#{attribute}-hint" })
+      end
+
+      # Adds the aira-describedby attribute for the field
+      # if there is a hint or an error message
+      #
+      # @param attribute [String, Symbol] the attribute of the input
+      # @param error_message [String] used to indicate if there is an error
+      # @param govuk_field_options [Hash] see {#govuk_field} for details
+
+      def set_field_described_by(field_key, attribute, error_message, govuk_field_options)
+        aria_described_by = []
+        aria_described_by << govuk_field_options.dig(field_key, :attributes, :aria, :describedby)
+        aria_described_by << govuk_field_options[:hint][:options][:attributes][:id] if govuk_field_options[:hint]
+        aria_described_by << "#{attribute}-error" if error_message
+        aria_described_by.compact!
+
+        govuk_field_options[field_key] ||= {}
+        govuk_field_options[field_key][:attributes] ||= {}
+
+        return unless aria_described_by.any?
+
+        (govuk_field_options[field_key][:attributes][:aria] ||= {}).merge!({ describedby: aria_described_by.join(' ') })
+      end
+
+      # Sets the hint classes and adds the aira-describedby attribute for a fields item
+      #
+      # @param type [String] the type of the item
+      # @param attribute [String, Symbol] the attribute of the item
+      # @param item [Hash] the options for that item
+
+      def set_item_options_for_hint(type, attribute, item)
+        (item[:hint][:options] ||= {})[:attributes] ||= {}
+        item[:hint][:options][:classes] = "govuk-#{type}__hint #{item[:hint][:options][:classes]}".rstrip
+        item[:hint][:options][:attributes][:id] ||= "#{attribute}_#{item[:value]}-item-hint"
+
+        (item[:attributes][:aria] ||= {})[:describedby] = item[:hint][:options][:attributes][:id]
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/fieldset.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Fieldset
+    #
+    # This helper is used for generating the fieldset component from the
+    # {https://design-system.service.gov.uk/components/fieldset GDS - Components - Fieldset}
+
+    module Fieldset
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+
+      # Generates the HTML for the GOV.UK Fieldset component
+      #
+      # @param govuk_fieldset_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_fieldset_options [String] :classes additional CSS classes for the fieldset HTML
+      # @option govuk_fieldset_options [Hash] :legend options for the legend which are used in {#govuk_legend}
+      # @option govuk_fieldset_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @yield HTML that will be contained within the 'govuk-fieldset' div and under the legend
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Fieldset
+      #                                     which can then be rendered on the page
+
+      def govuk_fieldset(**govuk_fieldset_options)
+        govuk_fieldset_classes = ['govuk-fieldset']
+        govuk_fieldset_classes << govuk_fieldset_options[:classes]
+        govuk_fieldset_options[:attributes] ||= {}
+
+        tag.fieldset(class: govuk_fieldset_classes, **govuk_fieldset_options[:attributes]) do
+          capture do
+            concat(govuk_legend(govuk_fieldset_options[:legend])) if govuk_fieldset_options[:legend]
+            concat(yield)
+          end
+        end
+      end
+
+      private
+
+      # Generates the HTML for the Legend as part of {#govuk_fieldset}
+      #
+      # @param govuk_legend_options [Hash] options that will be used in the legend
+      #
+      # @option govuk_legend_options [String] :classes additional CSS classes for the legend HTML
+      # @option govuk_legend_options [String] :text the text for the legend
+      # @option govuk_legend_options [boolean] :is_page_heading (false) if the legend is also the heading it will rendered in a h1
+      # @option govuk_legend_options [Hash] :caption an optional hash with the +text+ and +classes+ that will be used
+      #                                              to render a caption before the h1 if the legend is a page heading
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Fieldset
+      #                                     which can then be rendered on the page
+
+      def govuk_legend(govuk_legend_options)
+        govuk_legend_classes = ['govuk-fieldset__legend']
+        govuk_legend_classes << govuk_legend_options[:classes]
+
+        tag.legend(class: govuk_legend_classes) do
+          if govuk_legend_options[:is_page_heading]
+            capture do
+              concat(tag.span(govuk_legend_options[:caption][:text], class: govuk_legend_options[:caption][:classes])) if govuk_legend_options[:caption]
+              concat(tag.h1(govuk_legend_options[:text], class: 'govuk-fieldset__heading'))
+            end
+          else
+            govuk_legend_options[:text]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/form_group.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require_relative 'error_message'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK FormGroup
+    #
+    # This helper is used for generating the form group component from the Government Design Systems
+
+    module FormGroup
+      include ErrorMessage
+
+      # Generates the HTML for the GOV.UK Form Group component
+      #
+      # @param attribute [String, Symbol] the attribute that the form group is for
+      # @param error_message [String] the error message to be displayed
+      # @param govuk_form_group_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_form_group_options [String] :classes additional CSS classes for the form group HTML
+      # @option govuk_form_group_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @yield HTML that will be contained within the 'govuk-form-group' div
+      #
+      # @yieldparam displayed_error_message [ActiveSupport::SafeBuffer] the HTML for the error message (if there is one)
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Form Group
+      #                                     which can then be rendered on the page
+
+      def govuk_form_group(attribute, error_message = nil, **govuk_form_group_options)
+        govuk_form_group_classes = ['govuk-form-group']
+        govuk_form_group_classes += ['govuk-form-group--error'] if error_message
+        govuk_form_group_classes << govuk_form_group_options[:classes]
+        govuk_form_group_options[:attributes] ||= {}
+
+        tag.div(class: govuk_form_group_classes, id: "#{attribute}-form-group", **govuk_form_group_options[:attributes]) do
+          yield((govuk_error_message(error_message, attribute) if error_message))
+        end
+      end
+
+      # Generates the HTML for the GOV.UK Form Group component using an ActiveModel
+      #
+      # @param model [ActiveModel] model that will be used to find an error message
+      # @param attribute [String, Symbol] the attribute that the form group is for
+      # @param govuk_form_group_options [Hash] options that will be used in customising the HTML
+      #
+      # @option (see #govuk_form_group)
+      #
+      # @yield (see #govuk_form_group)
+      #
+      # @yieldparam (see #govuk_form_group)
+      #
+      # @return (see #govuk_form_group)
+
+      def govuk_form_group_with_model(model, attribute, **govuk_form_group_options, &block)
+        govuk_form_group(attribute, model.errors[attribute].first, **govuk_form_group_options, &block)
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/header.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Header
+    #
+    # This helper is used for generating the header component from the
+    # {https://design-system.service.gov.uk/components/header GDS - Components - Header}
+
+    module Header
+      include ActionView::Context
+      include ActionView::Helpers::FormTagHelper
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::UrlHelper
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
+
+      # Generates the HTML for the GOV.UK Header component
+      #
+      # @param govuk_header_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_header_options [String] :classes additional CSS classes for the header HTML
+      # @option govuk_header_options [Hash] :container_options (see: {govuk_header_container})
+      # @option govuk_header_options [Hash] :service_options (see: {govuk_header_service_name})
+      # @option govuk_header_options [Hash] :navigation_options (see: {govuk_header_navigation})
+      # @option govuk_header_options [Hash] :attributes ({data: { module: 'govuk-header' }})
+      #                                         any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Header
+      #                                     which can then be rendered on the page
+
+      def govuk_header(**govuk_header_options)
+        govuk_header_classes = ['govuk-header']
+        govuk_header_classes << govuk_header_options[:classes]
+        govuk_header_options[:attributes] ||= {}
+        (govuk_header_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-header' })
+
+        tag.header(class: govuk_header_classes, role: 'banner', **govuk_header_options[:attributes]) do
+          capture do
+            concat(govuk_header_container(govuk_header_options[:container_options] || {}))
+            if govuk_header_options[:service_options].present? || govuk_header_options[:navigation_options].present?
+              concat(tag.div(class: 'govuk-header__content') do
+                capture do
+                  concat(govuk_header_service_name(service_options)) if govuk_header_options[:service_options].present?
+                  concat(govuk_header_navigation(navigation_options)) if govuk_header_options[:navigation_options].present?
+                end
+              end)
+            end
+          end
+        end
+      end
+
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      private
+
+      # Generates the header container with the logo for {govuk_header}
+      #
+      # @param container_options [Hash] options that will be used in customising the HTML
+      #
+      # @option container_options [String] :classes additional CSS classes for the container HTML
+      # @option container_options [String] :home_url the URL of the homepage. Defaults to +/+
+      # @option container_options [String] :product_name used when the product name follows on directly from ‘GOV.UK’
+      # @option container_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the header container which is used in {govuk_header}
+
+      def govuk_header_container(container_options)
+        govuk_header_classes = ['govuk-header__container']
+        govuk_header_classes << (container_options[:classes] || 'govuk-width-container')
+
+        tag.div(class: govuk_header_classes) do
+          tag.div(class: 'govuk-header__logo') do
+            link_to(container_options[:home_url] || '/', class: 'govuk-header__link govuk-header__link--homepage') do
+              capture do
+                concat(tag.span(class: 'govuk-header__logotype') do
+                  capture do
+                    concat(tag.svg(class: 'govuk-header__logotype-crown', xmlns: 'http://www.w3.org/2000/svg', height: '30', width: '36', aria: { hidden: 'true' }, focusable: 'false', viewBox: '0 0 132 97') do
+                      tag.path(fill: 'currentColor', 'fill-rule': 'evenodd', d: 'M25 30.2c3.5 1.5 7.7-.2 9.1-3.7 1.5-3.6-.2-7.8-3.9-9.2-3.6-1.4-7.6.3-9.1 3.9-1.4 3.5.3 7.5 3.9 9zM9 39.5c3.6 1.5 7.8-.2 9.2-3.7 1.5-3.6-.2-7.8-3.9-9.1-3.6-1.5-7.6.2-9.1 3.8-1.4 3.5.3 7.5 3.8 9zM4.4 57.2c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.5-1.5-7.6.3-9.1 3.8-1.4 3.5.3 7.6 3.9 9.1zm38.3-21.4c3.5 1.5 7.7-.2 9.1-3.8 1.5-3.6-.2-7.7-3.9-9.1-3.6-1.5-7.6.3-9.1 3.8-1.3 3.6.4 7.7 3.9 9.1zm64.4-5.6c-3.6 1.5-7.8-.2-9.1-3.7-1.5-3.6.2-7.8 3.8-9.2 3.6-1.4 7.7.3 9.2 3.9 1.3 3.5-.4 7.5-3.9 9zm15.9 9.3c-3.6 1.5-7.7-.2-9.1-3.7-1.5-3.6.2-7.8 3.7-9.1 3.6-1.5 7.7.2 9.2 3.8 1.5 3.5-.3 7.5-3.8 9zm4.7 17.7c-3.6 1.5-7.8-.2-9.2-3.8-1.5-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.3 3.5-.4 7.6-3.9 9.1zM89.3 35.8c-3.6 1.5-7.8-.2-9.2-3.8-1.4-3.6.2-7.7 3.9-9.1 3.6-1.5 7.7.3 9.2 3.8 1.4 3.6-.3 7.7-3.9 9.1zM69.7 17.7l8.9 4.7V9.3l-8.9 2.8c-.2-.3-.5-.6-.9-.9L72.4 0H59.6l3.5 11.2c-.3.3-.6.5-.9.9l-8.8-2.8v13.1l8.8-4.7c.3.3.6.7.9.9l-5 15.4v.1c-.2.8-.4 1.6-.4 2.4 0 4.1 3.1 7.5 7 8.1h.2c.3 0 .7.1 1 .1.4 0 .7 0 1-.1h.2c4-.6 7.1-4.1 7.1-8.1 0-.8-.1-1.7-.4-2.4V34l-5.1-15.4c.4-.2.7-.6 1-.9zM66 92.8c16.9 0 32.8 1.1 47.1 3.2 4-16.9 8.9-26.7 14-33.5l-9.6-3.4c1 4.9 1.1 7.2 0 10.2-1.5-1.4-3-4.3-4.2-8.7L108.6 76c2.8-2 5-3.2 7.5-3.3-4.4 9.4-10 11.9-13.6 11.2-4.3-.8-6.3-4.6-5.6-7.9 1-4.7 5.7-5.9 8-.5 4.3-8.7-3-11.4-7.6-8.8 7.1-7.2 7.9-13.5 2.1-21.1-8 6.1-8.1 12.3-4.5 20.8-4.7-5.4-12.1-2.5-9.5 6.2 3.4-5.2 7.9-2 7.2 3.1-.6 4.3-6.4 7.8-13.5 7.2-10.3-.9-10.9-8-11.2-13.8 2.5-.5 7.1 1.8 11 7.3L80.2 60c-4.1 4.4-8 5.3-12.3 5.4 1.4-4.4 8-11.6 8-11.6H55.5s6.4 7.2 7.9 11.6c-4.2-.1-8-1-12.3-5.4l1.4 16.4c3.9-5.5 8.5-7.7 10.9-7.3-.3 5.8-.9 12.8-11.1 13.8-7.2.6-12.9-2.9-13.5-7.2-.7-5 3.8-8.3 7.1-3.1 2.7-8.7-4.6-11.6-9.4-6.2 3.7-8.5 3.6-14.7-4.6-20.8-5.8 7.6-5 13.9 2.2 21.1-4.7-2.6-11.9.1-7.7 8.8 2.3-5.5 7.1-4.2 8.1.5.7 3.3-1.3 7.1-5.7 7.9-3.5.7-9-1.8-13.5-11.2 2.5.1 4.7 1.3 7.5 3.3l-4.7-15.4c-1.2 4.4-2.7 7.2-4.3 8.7-1.1-3-.9-5.3 0-10.2l-9.5 3.4c5 6.9 9.9 16.7 14 33.5 14.8-2.1 30.8-3.2 47.7-3.2z')
+                    end)
+                    concat(tag.span('GOV.UK', class: 'govuk-header__logotype-text'))
+                  end
+                end)
+                concat(tag.span(container_options[:product_name], class: 'govuk-header__product-name')) if container_options[:product_name]
+              end
+            end
+          end
+        end
+      end
+
+      # rubocop:enable Metrics/AbcSize
+
+      # Generates the service name for {govuk_header}
+      #
+      # @param service_options [Hash] options that will be used in customising the HTML
+      #
+      # @option service_options [String] :service_name the name of your service, included in the header
+      # @option service_options [String] :service_url URL for the service name anchor
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the service name which is used in {govuk_header}
+
+      def govuk_header_service_name(service_options)
+        if service_options[:service_url]
+          link_to(service_options[:service_name], service_options[:service_url], class: 'govuk-header__link govuk-header__service-name')
+        else
+          tag.span(service_options[:service_name], class: 'govuk-header__service-name')
+        end
+      end
+
+      # Generates the navigation section for {govuk_header}
+      #
+      # @param navigation_options [Hash] options that will be used in customising the HTML
+      #
+      # @option navigation_options [String] :classes additional CSS classes for the navigation HTML
+      # @option navigation_options [String] :menu_button_text text of the button that opens the mobile navigation menu.
+      #                                                       By default, this is set to +'Menu'+.
+      # @option navigation_options [String] :menu_button_label text for the aria-label attribute of the button that opens the mobile navigation.
+      #                                                        Defaults to +'Show or hide menu'+.
+      # @option navigation_options [Array] :items the navigation items that will be rendered on the page (see {govuk_header_navigation_item})
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the navigation section which is used in {govuk_header}
+
+      def govuk_header_navigation(navigation_options)
+        menu_button_text = navigation_options[:menu_button_text] || 'Menu'
+        menu_button_label = navigation_options[:menu_button_label] || 'Show or hide menu'
+
+        govuk_header_navigation_classes = ['govuk-header__navigation']
+        govuk_header_navigation_classes << navigation_options[:classes]
+
+        tag.nav(class: govuk_header_navigation_classes, aria: { label: menu_button_text }) do
+          capture do
+            concat(button_tag(menu_button_text, class: 'govuk-header__menu-button govuk-js-header-toggle', type: 'button', hidden: true, aria: { controls: 'navigation', label: menu_button_label, }))
+            concat(tag.ul(id: 'navigation', class: 'govuk-header__navigation-list') do
+              capture do
+                navigation_options[:items].each do |navigation_item|
+                  concat(govuk_header_navigation_item(navigation_item))
+                end
+              end
+            end)
+          end
+        end
+      end
+
+      # Generates a navigation item for {govuk_header_navigation}
+      #
+      # @param navigation_item [Hash] options that will be used in customising the HTML
+      #
+      # @option navigation_item [Boolean] :active flag to mark the navigation item as active or not
+      # @option navigation_item [String] :text text for the navigation item
+      # @option navigation_item [String] :href URL of the navigation item anchor
+      # @option navigation_item [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for a navigation item which is used in {govuk_header_navigation}
+
+      def govuk_header_navigation_item(navigation_item)
+        govuk_header_navigation_item_classes = ['govuk-header__navigation-item']
+        govuk_header_navigation_item_classes << 'govuk-header__navigation-item--active' if navigation_item[:active]
+
+        tag.li(class: govuk_header_navigation_item_classes) do
+          if navigation_item[:href]
+            link_to(navigation_item[:text], navigation_item[:href], class: 'govuk-header__link', **(navigation_item[:attributes] || {}))
+          else
+            concat(navigation_item[:text])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/hint.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'action_view'
+
 module CrownMarketplaceUtils
   module GovUkHelper
     # = GOV.UK Hint
@@ -7,22 +9,26 @@ module CrownMarketplaceUtils
     # This helper is used for generating the hint text component from the Government Design Systems
 
     module Hint
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+
       # Generates the HTML for the GOV.UK Hint component
       #
       # @param hint_text [String]  the hint text
-      # @param hint_options [Hash] options that will be used in customising the HTML
+      # @param govuk_hint_options [Hash] options that will be used in customising the HTML
       #
-      # @option hint_options [String] :classes additional CSS classes for the hint HTML
-      # @option hint_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      # @option govuk_hint_options [String] :classes additional CSS classes for the hint HTML
+      # @option govuk_hint_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
       #
       # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Hint
       #                                     which can then be rendered on the page
 
-      def govuk_hint(hint_text, **hint_options)
+      def govuk_hint(hint_text, **govuk_hint_options)
         govuk_hint_classes = ['govuk-hint']
-        govuk_hint_classes << hint_options[:classes]
+        govuk_hint_classes << govuk_hint_options[:classes]
+        govuk_hint_options[:attributes] ||= {}
 
-        tag.div(hint_text, class: govuk_hint_classes, **(hint_options[:attributes] || {}))
+        tag.div(hint_text, class: govuk_hint_classes, **govuk_hint_options[:attributes])
       end
     end
   end