crown_marketplace_utils 0.1.0.beta.2 → 0.1.0.beta.3

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/label.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK label
+    #
+    # This helper is used for generating the label component from the Government Design Systems
+
+    module Label
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::FormTagHelper
+
+      # Generates the HTML for the GOV.UK label component
+      #
+      # @param attribute [String, Symbol] the attribute of the input that requires a label
+      # @param label_text [String] the label text, it is ignored if a block is given
+      # @param govuk_label_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_label_options [String] :classes additional CSS classes for the label HTML
+      # @option govuk_label_options [Boolean] :is_page_heading (false) if the legend is also the heading it will rendered in a h1
+      # @option govuk_label_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @yield HTML that will be contained within the 'govuk-label' label
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Label
+      #                                     which can then be rendered on the page
+
+      def govuk_label(attribute, label_text = nil, **govuk_label_options)
+        _govuk_label(**govuk_label_options) do |govuk_label_classes, govuk_label_attributes|
+          label_tag(attribute, class: govuk_label_classes, **govuk_label_attributes) do
+            if block_given?
+              yield
+            else
+              concat(label_text)
+            end
+          end
+        end
+      end
+
+      # Generates the HTML for the GOV.UK label component using an ActionView::Helpers::FormBuilder
+      #
+      # @param form [ActionView::Helpers::FormBuilder] :form the form builder used to create the label
+      # @param attribute [String, Symbol] the attribute of the input that requires a label
+      # @param label_text [String] the label text, it is ignored if a block is given
+      # @param govuk_label_options [Hash] options that will be used in customising the HTML
+      #
+      # @option (see govuk_label)
+      #
+      # @yield (see govuk_label)
+      #
+      # @return (see govuk_label)
+
+      def govuk_label_with_form(form, attribute, label_text = nil, **govuk_label_options, &block)
+        _govuk_label(**govuk_label_options) do |govuk_label_classes, govuk_label_attributes|
+          if block_given?
+            form.label(attribute, class: govuk_label_classes, **govuk_label_attributes, &block)
+          else
+            form.label(attribute, label_text, class: govuk_label_classes, **govuk_label_attributes)
+          end
+        end
+      end
+
+      private
+
+      # Wrapper method used by {#govuk_label} and {#govuk_label_with_form} to generate the Label HTML
+      #
+      # @param govuk_label_options [Hash] options that will be used in customising the HTML
+      #
+      # @option (see govuk_label)
+      #
+      # @yield the label HTML generated by {#govuk_label} or {#govuk_label_with_form}
+      #
+      # @yieldparam govuk_label_classes [Array] the classes for the label HTML
+      # @yieldparam govuk_label_attributes [Hash] additional attributes that will added as part of the HTML
+      #
+      # @return (see govuk_label)
+
+      def _govuk_label(**govuk_label_options)
+        govuk_label_classes = ['govuk-label']
+        govuk_label_classes << govuk_label_options[:classes]
+        govuk_label_options[:attributes] ||= {}
+
+        label_html = yield(govuk_label_classes, govuk_label_options[:attributes])
+
+        if govuk_label_options[:is_page_heading]
+          tag.h1(label_html, class: 'govuk-label-wrapper')
+        else
+          label_html
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/notification_banner.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Notification Banner
+    #
+    # This helper is used for generating the notification banner component from the
+    # {https://design-system.service.gov.uk/components/notification-banner GDS - Components - Notification banner}
+
+    module NotificationBanner
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+
+      # Generates the HTML for the GOV.UK Notification banner component
+      #
+      # @param text [String] the text that will be used for the heading in the content section of the banner.
+      #                      It is ignored if a block is given
+      # @param success_banner [Boolean] will use the success banner options if this is set to true
+      # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_notification_banner_options [String] :classes additional CSS classes for the notification banner HTML
+      # @option govuk_notification_banner_options [String] :title_text ('Important') the title text shown at the top of the banner
+      # @option govuk_notification_banner_options [String] :title_id ('govuk-notification-banner-title') the ID for the title text
+      # @option govuk_notification_banner_options [String] :role ('region') the role for the banner
+      # @option govuk_notification_banner_options [String] :heading_level (2) the heading level for the title text
+      # @option govuk_notification_banner_options [Hash] :attributes ({data: { module: 'govuk-notification-banner' }, aria: { labelledby: 'govuk-notification-banner-title' }})
+      #                                                  any additional attributes that will added as part of the HTML
+      #
+      # @yield HTML that will be contained within the 'govuk-notification-banner__content' div
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Notification banner
+      #                                     which can then be rendered on the page
+
+      def govuk_notification_banner(text = nil, success_banner = false, **govuk_notification_banner_options)
+        banner_options = fetch_banner_options(success_banner, govuk_notification_banner_options)
+        govuk_notification_banner_classes = fetch_banner_classes(banner_options, govuk_notification_banner_options)
+        govuk_notification_banner_attributes = fetch_banner_attributes(banner_options, govuk_notification_banner_options)
+
+        tag.div(class: govuk_notification_banner_classes, role: banner_options[:role], **govuk_notification_banner_attributes) do
+          capture do
+            concat(tag.div(class: 'govuk-notification-banner__header') do
+              tag.send(:"h#{govuk_notification_banner_options[:heading_level] || 2}", banner_options[:title_text], class: 'govuk-notification-banner__title', id: banner_options[:title_id])
+            end)
+            concat(tag.div(class: 'govuk-notification-banner__content') do
+              if block_given?
+                yield
+              else
+                tag.p(text, class: 'govuk-notification-banner__heading')
+              end
+            end)
+          end
+        end
+      end
+
+      private
+
+      # Determines the banner options to be used for {#govuk_notification_banner}
+      #
+      # @param success_banner [Boolean] will use the success banner options if this is set to true
+      # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_notification_banner_options [String] :title_text ('Important') the title text shown at the top of the banner
+      # @option govuk_notification_banner_options [String] :title_id ('govuk-notification-banner-title') the ID for the title text
+      # @option govuk_notification_banner_options [String] :role ('region') the role for the banner
+      #
+      # @return [Hash] contains the following options used in {#govuk_notification_banner}:
+      #                - +classes+
+      #                - +title_text+
+      #                - +title_id+
+      #                - +role+
+
+      def fetch_banner_options(success_banner, govuk_notification_banner_options)
+        banner_options = DEFAULT_OPTIONS.dup
+
+        banner_options.merge!(SUCCESS_BANNER_OPTIONS) if success_banner
+
+        govuk_notification_banner_options.each do |key, value|
+          banner_options[key] = value if banner_options.key?(key)
+        end
+
+        banner_options
+      end
+
+      # Determines the banner classes to be used for {#govuk_notification_banner}
+      #
+      # @param banner_options [Hash] this is the return value from {#fetch_banner_options}
+      # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_notification_banner_options [String] :classes additional CSS classes for the notification banner HTML
+      #
+      # @return [Array<String>] an array of classes to be used in {#govuk_notification_banner}
+
+      def fetch_banner_classes(banner_options, govuk_notification_banner_options)
+        govuk_notification_banner_classes = ['govuk-notification-banner']
+        govuk_notification_banner_classes << govuk_notification_banner_options[:classes]
+        govuk_notification_banner_classes << banner_options[:classes]
+
+        govuk_notification_banner_classes
+      end
+
+      # Default HTML attributes for {#govuk_notification_banner}
+      #
+      # @param banner_options [Hash] this is the return value from {#fetch_banner_options}
+      # @param govuk_notification_banner_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_notification_banner_options [Hash] :attributes ({data: { module: 'govuk-notification-banner' }, aria: { labelledby: 'govuk-notification-banner-title' }})
+      #                                                  any additional attributes that will added as part of the HTML
+      #
+      # @return [Hash] contains the default attributes for {#govuk_notification_banner} and any additional attributes that were passed
+
+      def fetch_banner_attributes(banner_options, govuk_notification_banner_options)
+        govuk_notification_banner_attributes = govuk_notification_banner_options[:attributes] || {}
+        (govuk_notification_banner_attributes[:data] ||= {}).merge!({ module: 'govuk-notification-banner' })
+        (govuk_notification_banner_attributes[:aria] ||= {}).merge!({ labelledby: banner_options[:title_id] })
+
+        govuk_notification_banner_attributes
+      end
+
+      # Default options used in normal versions of {#govuk_notification_banner}
+
+      DEFAULT_OPTIONS = {
+        title_text: 'Important',
+        title_id: 'govuk-notification-banner-title',
+        role: 'region'
+      }.freeze
+
+      # Options specific for the success version of {#govuk_notification_banner}
+
+      SUCCESS_BANNER_OPTIONS = {
+        classes: 'govuk-notification-banner--success',
+        title_text: 'Success',
+        role: 'alert'
+      }.freeze
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/pagination.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Pagination
+    #
+    # This helper is used for generating the pagination component from the
+    # {https://design-system.service.gov.uk/components/pagination GDS - Components - Pagination}
+
+    module Pagination
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::UrlHelper
+
+      # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      # Generates the HTML for the GOV.UK Pagination component
+      #
+      # @param govuk_pagination_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_pagination_options [String] :classes additional CSS classes for the pagination HTML
+      # @option govuk_pagination_options [Array] :items an array of items for the pagination (see: {govuk_pagination_items})
+      # @option govuk_pagination_options [Hash] :previous the previous link (see: {govuk_pagination_previous})
+      # @option govuk_pagination_options [Hash] :next the next link (see: {govuk_pagination_next})
+      # @option govuk_pagination_options [Hash] :attributes ({role: 'navigation', aria: { label: 'results' }})
+      #                                         any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Pagination
+      #                                     which can then be rendered on the page
+
+      def govuk_pagination(**govuk_pagination_options)
+        govuk_pagination_classes = ['govuk-pagination']
+        govuk_pagination_classes << govuk_pagination_options[:classes]
+
+        block_is_level = govuk_pagination_options[:items].blank? && (govuk_pagination_options[:next].present? || govuk_pagination_options[:previous].present?)
+
+        govuk_pagination_classes << 'govuk-pagination--block' if block_is_level
+
+        (govuk_pagination_options[:attributes] ||= {}).merge({ role: 'navigation' })
+        (govuk_pagination_options[:attributes][:aria] ||= {})[:label] ||= 'results'
+
+        tag.nav(class: govuk_pagination_classes, **govuk_pagination_options[:attributes]) do
+          capture do
+            concat(govuk_pagination_previous(block_is_level, **govuk_pagination_options[:previous])) if govuk_pagination_options[:previous]
+            concat(govuk_pagination_items(govuk_pagination_options[:items])) if govuk_pagination_options[:items]
+            concat(govuk_pagination_next(block_is_level, **govuk_pagination_options[:next])) if govuk_pagination_options[:next]
+          end
+        end
+      end
+
+      # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+      private
+
+      # Generates the previous link for {govuk_pagination}
+      #
+      # @param block_is_level [Boolean] when there are no items, this will be true and will add extra classe
+      #                                 to the link to make the next and previous pagination links level
+      # @param govuk_pagination_previous_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_pagination_previous_options [String] :href the URL for the link
+      # @option govuk_pagination_previous_options [String] :text ('Previous') the text for the link
+      # @option govuk_pagination_previous_options [String] :lable_text additional text for the link when the pagination block is level
+      # @option govuk_pagination_previous_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the previous link which is used in {govuk_pagination}
+
+      def govuk_pagination_previous(block_is_level, **govuk_pagination_previous_options)
+        govuk_pagination_previous_classes = ['govuk-pagination__link-title']
+        govuk_pagination_previous_classes << 'govuk-pagination__link-title--decorated' if block_is_level && !govuk_pagination_previous_options[:lable_text]
+
+        tag.div(class: 'govuk-pagination__prev') do
+          link_to(govuk_pagination_previous_options[:href], class: 'govuk-link govuk-pagination__link', rel: 'prev', **(govuk_pagination_previous_options[:attributes] || {})) do
+            capture do
+              concat(govuk_pagination_icon(:prev))
+              concat(tag.span(govuk_pagination_previous_options[:text] || 'Previous', class: govuk_pagination_previous_classes))
+              concat(govuk_pagination_icon_label_text(block_is_level, govuk_pagination_previous_options[:lable_text]))
+            end
+          end
+        end
+      end
+
+      # Generates the next link for {govuk_pagination}
+      #
+      # @param block_is_level [Boolean] when there are no items, this will be true and will add extra classe
+      #                                 to the link to make the next and previous pagination links level
+      # @param govuk_pagination_next_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_pagination_next_options [String] :href the URL for the link
+      # @option govuk_pagination_next_options [String] :text ('Next') the text for the link
+      # @option govuk_pagination_next_options [String] :lable_text additional text for the link when the pagination block is level
+      # @option govuk_pagination_next_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the next link which is used in {govuk_pagination}
+
+      def govuk_pagination_next(block_is_level, **govuk_pagination_next_options)
+        govuk_pagination_next_classes = ['govuk-pagination__link-title']
+        govuk_pagination_next_classes << 'govuk-pagination__link-title--decorated' if block_is_level && !govuk_pagination_next_options[:lable_text]
+
+        tag.div(class: 'govuk-pagination__next') do
+          link_to(govuk_pagination_next_options[:href], class: 'govuk-link govuk-pagination__link', rel: 'next', **(govuk_pagination_next_options[:attributes] || {})) do
+            capture do
+              concat(govuk_pagination_icon(:next)) if block_is_level
+              concat(tag.span(govuk_pagination_next_options[:text] || 'Next', class: govuk_pagination_next_classes))
+              concat(govuk_pagination_icon_label_text(block_is_level, govuk_pagination_next_options[:lable_text]))
+              concat(govuk_pagination_icon(:next)) unless block_is_level
+            end
+          end
+        end
+      end
+
+      # Generates the item links for {govuk_pagination}
+      #
+      # @param govuk_pagination_items [Array(Hash)] an array of item hashes for the pagination.
+      #                                             There are two types of item:
+      #                                             - {govuk_pagination_item_ellipsis ellipsis item}
+      #                                             - {govuk_pagination_item_number number item}
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the lits of items which is used in {govuk_pagination}
+
+      def govuk_pagination_items(govuk_pagination_items)
+        tag.ul(class: 'govuk-pagination__list') do
+          capture do
+            govuk_pagination_items.each do |govuk_pagination_item|
+              case govuk_pagination_item[:type]
+              when :ellipsis
+                concat(govuk_pagination_item_ellipsis)
+              when :number
+                concat(govuk_pagination_item_number(govuk_pagination_item))
+              end
+            end
+          end
+        end
+      end
+
+      # Generates the icon for:
+      # - {govuk_pagination_previous}
+      # - {govuk_pagination_next}
+      #
+      # @param type [Symbol] the type of the pagination icon (+:prev+ or +:next+)
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def govuk_pagination_icon(type)
+        tag.svg(class: "govuk-pagination__icon govuk-pagination__icon--#{type}", xmlns: 'http://www.w3.org/2000/svg', height: '13', width: '15', aria: { hidden: 'true' }, focusable: 'false', viewBox: '0 0 15 13') do
+          tag.path(d: PAGINATION_ICON_PATHS[type])
+        end
+      end
+
+      # Generates the label text for:
+      # - {govuk_pagination_previous}
+      # - {govuk_pagination_next}
+      #
+      # @param block_is_level [Boolean] when there are no items, this will be true
+      # @param label_text [String] the additional text for the link
+      #
+      # @return [ActiveSupport::SafeBuffer]
+
+      def govuk_pagination_icon_label_text(block_is_level, label_text)
+        return unless block_is_level && label_text
+
+        capture do
+          concat(tag.span(':', class: 'govuk-visually-hidden'))
+          concat(tag.span(label_text, class: 'govuk-pagination__link-label'))
+        end
+      end
+
+      # Generates the ellipsis HTML for {govuk_pagination_items}
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for an ellipsis item which is used in {govuk_pagination_items}
+
+      def govuk_pagination_item_ellipsis
+        tag.li('⋯', class: 'govuk-pagination__item govuk-pagination__item--ellipses')
+      end
+
+      # Generates the number item HTML for {govuk_pagination_items}
+      #
+      # @param govuk_pagination_item [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_pagination_item [String] :href the URL for the link
+      # @option govuk_pagination_item [String] :number the number for the link
+      # @option govuk_pagination_item [String] :current is this item the current page
+      # @option govuk_pagination_item [Hash] :attributes ({aria: { label: 'Page <NUMBER>' } })
+      #                                                  any additional attributes that will added as part of the HTML
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for an number item which is used in {govuk_pagination_items}
+
+      def govuk_pagination_item_number(govuk_pagination_item)
+        govuk_pagination_item_classes = ['govuk-pagination__item']
+        (govuk_pagination_item[:attributes] ||= {})[:aria] ||= {}
+        govuk_pagination_item[:attributes][:aria][:label] ||= "Page #{govuk_pagination_item[:number]}"
+
+        if govuk_pagination_item[:current]
+          govuk_pagination_item_classes << 'govuk-pagination__item--current'
+          govuk_pagination_item[:attributes][:aria][:current] = 'page'
+        end
+
+        tag.li(class: govuk_pagination_item_classes) do
+          link_to(govuk_pagination_item[:href], govuk_pagination_item[:number], class: 'govuk-link govuk-pagination__link', **govuk_pagination_item[:attributes])
+        end
+      end
+
+      # The paths for the pagination next and previous icons
+
+      PAGINATION_ICON_PATHS = {
+        prev: 'm6.5938-0.0078125-6.7266 6.7266 6.7441 6.4062 1.377-1.449-4.1856-3.9768h12.896v-2h-12.984l4.2931-4.293-1.414-1.414z',
+        next: 'm8.107-0.0078125-1.4136 1.414 4.2926 4.293h-12.986v2h12.896l-4.1855 3.9766 1.377 1.4492 6.7441-6.4062-6.7246-6.7266z'
+      }.freeze
+    end
+  end
+end