crown_marketplace_utils 0.1.0.beta.4 → 0.1.0.beta.5

data/lib/crown_marketplace_utils/gov_uk_helper/pagination.rb

@@ -1,214 +0,0 @@
-# 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[:number], govuk_pagination_item[:href], 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