crown_marketplace_utils 0.1.0.beta.4 → 0.1.0.beta.6

data/lib/crown_marketplace_utils/helpers/gov_uk_helper/pagination.rb

@@ -0,0 +1,338 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils::Helpers
+  module GovUkHelper
+    # rubocop:disable Metrics/ModuleLength
+
+    # = 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
+
+      # Generates the HTML for the GOV.UK Pagination component
+      #
+      # @param (see _govuk_pagination)
+      #
+      # @option (see _govuk_pagination)
+      #
+      # @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(**govuk_pagination_options) do |block_is_level|
+          capture do
+            concat(govuk_pagination_previous(block_is_level, form: govuk_pagination_options[:form], **govuk_pagination_options[:previous])) if govuk_pagination_options[:previous]
+            concat(govuk_pagination_items(govuk_pagination_options[:items], form: govuk_pagination_options[:form])) if govuk_pagination_options[:items]
+            concat(govuk_pagination_next(block_is_level, form: govuk_pagination_options[:form], **govuk_pagination_options[:next])) if govuk_pagination_options[:next]
+          end
+        end
+      end
+
+      private
+
+      # Wrapper method used by {govuk_pagination}
+      #
+      # @param govuk_pagination_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_pagination_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create pagination buttons
+      # @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
+      #
+      # @yield the pagination HTML generated by {govuk_pagination}
+      #
+      # @yieldparam block_is_level [Boolean] flag to indicate if there are no items
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the Pagination
+      #                                     which is used in {govuk_pagination}
+
+      def _govuk_pagination(**govuk_pagination_options)
+        govuk_pagination_options[:attributes] ||= {}
+        govuk_pagination_options[:attributes][:class] = "govuk-pagination #{govuk_pagination_options[:classes]}".rstrip
+
+        block_is_level = govuk_pagination_options[:items].blank? && (govuk_pagination_options[:next].present? || govuk_pagination_options[:previous].present?)
+
+        govuk_pagination_options[:attributes][:class] << ' govuk-pagination--block' if block_is_level
+
+        govuk_pagination_options[:attributes].merge!({ role: 'navigation' })
+        (govuk_pagination_options[:attributes][:aria] ||= {})[:label] ||= 'results'
+
+        tag.nav(**govuk_pagination_options[:attributes]) do
+          yield(block_is_level)
+        end
+      end
+
+      # Generates the previous link for {govuk_pagination}
+      #
+      # @param (see govuk_pagination_previous_content)
+      #
+      # @option (see govuk_pagination_previous_content)
+      #
+      # @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_options[:attributes] ||= {}
+        govuk_pagination_previous_options[:attributes][:class] = "govuk-link govuk-pagination__link #{'pagination--button_as_link' if govuk_pagination_previous_options[:form]}".rstrip
+        govuk_pagination_previous_options[:attributes][:rel] = 'prev'
+
+        pagination_previous_content = govuk_pagination_previous_content(block_is_level, govuk_pagination_previous_options)
+
+        tag.div(class: 'govuk-pagination__prev') do
+          if govuk_pagination_previous_options[:form]
+            govuk_pagination_previous_options[:form].button(pagination_previous_content, **govuk_pagination_previous_options[:attributes])
+          else
+            link_to(pagination_previous_content, govuk_pagination_previous_options[:href], **govuk_pagination_previous_options[:attributes])
+          end
+        end
+      end
+
+      # Used by {govuk_pagination_previous}
+      # to generate the previous link content
+      #
+      # @param block_is_level [Boolean] when there are no items, this will be true and will add extra classes
+      #                                 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 [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create previous button
+      # @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/button
+
+      def govuk_pagination_previous_content(block_is_level, govuk_pagination_previous_options)
+        capture do
+          concat(govuk_pagination_icon(:prev))
+          concat(tag.span(govuk_pagination_previous_options[:text] || 'Previous', class: pagination_next_and_previous_classes(block_is_level, govuk_pagination_previous_options)))
+          concat(govuk_pagination_icon_label_text(block_is_level, govuk_pagination_previous_options[:lable_text]))
+        end
+      end
+
+      # Generates the next link for {govuk_pagination}
+      #
+      # @param (see govuk_pagination_next_content)
+      #
+      # @option (see govuk_pagination_next_content)
+      #
+      # @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_options[:attributes] ||= {}
+        govuk_pagination_next_options[:attributes][:class] = "govuk-link govuk-pagination__link #{'pagination--button_as_link' if govuk_pagination_next_options[:form]}".rstrip
+        govuk_pagination_next_options[:attributes][:rel] = 'next'
+
+        pagination_next_content = govuk_pagination_next_content(block_is_level, govuk_pagination_next_options)
+
+        tag.div(class: 'govuk-pagination__next') do
+          if govuk_pagination_next_options[:form]
+            govuk_pagination_next_options[:form].button(pagination_next_content, **govuk_pagination_next_options[:attributes])
+          else
+            link_to(pagination_next_content, govuk_pagination_next_options[:href], **govuk_pagination_next_options[:attributes])
+          end
+        end
+      end
+
+      # Used by {govuk_pagination_next} to generate the next link content
+      #
+      # @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 [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create next button
+      # @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/button
+
+      def govuk_pagination_next_content(block_is_level, **govuk_pagination_next_options)
+        capture do
+          concat(govuk_pagination_icon(:next)) if block_is_level
+          concat(tag.span(govuk_pagination_next_options[:text] || 'Next', class: pagination_next_and_previous_classes(block_is_level, govuk_pagination_next_options)))
+          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
+
+      # Returns the classes for the previous and next link/button label
+      #
+      # @param (see govuk_pagination_next_content)
+
+      def pagination_next_and_previous_classes(block_is_level, govuk_pagination_options)
+        "govuk-pagination__link-title #{'govuk-pagination__link-title--decorated' if block_is_level && !govuk_pagination_options[:lable_text]}".rstrip
+      end
+
+      # Generates the item links for {govuk_pagination}
+      #
+      # @param (see _govuk_pagination_items)
+      # @param form [ActionView::Helpers::FormBuilder] optional form builder used to create the item buttons
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the lits of items which is used in {govuk_pagination}
+
+      def govuk_pagination_items(govuk_pagination_items, form:)
+        if form
+          _govuk_pagination_items(govuk_pagination_items) do |govuk_pagination_item|
+            govuk_pagination_item_number_form(form, govuk_pagination_item)
+          end
+        else
+          _govuk_pagination_items(govuk_pagination_items) do |govuk_pagination_item|
+            govuk_pagination_item_number_tag(govuk_pagination_item)
+          end
+        end
+      end
+
+      # Wrapper method used by {govuk_pagination_items}
+      # to generate the pagination items HTML
+      #
+      # @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_tag number item}
+      #
+      # @yield the pagination number item HTML generated by {govuk_pagination_items}
+      #
+      # @yieldparam govuk_pagination_item [Hash] the current pagination item in the loop
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the lits of items which is
+      #                                     used in {govuk_pagination_items}
+
+      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(yield(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 (see _govuk_pagination_item_number)
+      #
+      # @option (see _govuk_pagination_item_number)
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for an number item which is used in {govuk_pagination_items}
+
+      def govuk_pagination_item_number_tag(govuk_pagination_item)
+        _govuk_pagination_item_number(govuk_pagination_item) do
+          link_to(govuk_pagination_item[:number], govuk_pagination_item[:href], **govuk_pagination_item[:attributes])
+        end
+      end
+
+      # Generates the number item HTML for {govuk_pagination_items} when there is a ActionView::Helpers::FormBuilder
+      #
+      # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the item button
+      # @param (see _govuk_pagination_item_number)
+      #
+      # @option (see _govuk_pagination_item_number)
+      #
+      # @return (see govuk_pagination_item_number_tag)
+
+      def govuk_pagination_item_number_form(form, govuk_pagination_item)
+        govuk_pagination_item[:classes] = 'pagination-number--button_as_link'
+
+        _govuk_pagination_item_number(govuk_pagination_item) do
+          form.button(govuk_pagination_item[:number], **govuk_pagination_item[:attributes])
+        end
+      end
+
+      # Wrapper method used by {govuk_pagination_item_number_tag} and {govuk_pagination_item_number_form}
+      # to generate the pagination number item HTML
+      #
+      # @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
+      #
+      # @yield the pagination number item link (when {govuk_pagination_item_number_tag}) or button (when {govuk_pagination_item_number_form})
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for an number item which is used
+      #                                     in {govuk_pagination_item_number_tag} or {govuk_pagination_item_number_form}
+
+      def _govuk_pagination_item_number(govuk_pagination_item, &block)
+        (govuk_pagination_item[:attributes] ||= {})[:aria] ||= {}
+        govuk_pagination_item[:attributes][:class] = "govuk-link govuk-pagination__link #{govuk_pagination_item[:classes]}".rstrip
+        govuk_pagination_item[:attributes][:aria][:label] ||= "Page #{govuk_pagination_item[:number]}"
+
+        govuk_pagination_list_classes = +'govuk-pagination__item'
+
+        if govuk_pagination_item[:current]
+          govuk_pagination_list_classes << ' govuk-pagination__item--current'
+          govuk_pagination_item[:attributes][:aria][:current] = 'page'
+        end
+
+        tag.li(class: govuk_pagination_list_classes, &block)
+      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
+    # rubocop:enable Metrics/ModuleLength
+  end
+end

data/lib/crown_marketplace_utils/{gov_uk_helper → helpers/gov_uk_helper}/step_by_step_navigation.rb

@@ -2,7 +2,7 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils
+module CrownMarketplaceUtils::Helpers
   module GovUkHelper
     # = GOV.UK Step by step navigation
     #

data/lib/crown_marketplace_utils/{gov_uk_helper → helpers/gov_uk_helper}/tag.rb

@@ -2,7 +2,7 @@
 
 require 'action_view'
 
-module CrownMarketplaceUtils
+module CrownMarketplaceUtils::Helpers
   module GovUkHelper
     # = GOV.UK Tag
     #

data/lib/crown_marketplace_utils/helpers/gov_uk_helper/warning_text.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils::Helpers
+  module GovUkHelper
+    # = GOV.UK Warning text
+    #
+    # This helper is used for generating the warning text component from the
+    # {https://design-system.service.gov.uk/components/warning-text GDS - Components - Warning text}
+
+    module WarningText
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+
+      # Generates the HTML for the GOV.UK Warning text component
+      #
+      # @param text [String] (nil) the text for the warning
+      # @param govuk_warning_text_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_warning_text_options [String] :classes additional CSS classes for the tag HTML
+      # @option govuk_warning_text_options [String] :icon_fallback_text the fallback text for the icon (default: +'Warning'+)
+      # @option govuk_warning_text_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @yield HTML that will be used in the warning text. Ignored if text is passed.
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Warning text
+      #                                     which can then be rendered on the page
+
+      def govuk_warning_text(text = nil, **govuk_warning_text_options)
+        govuk_warning_text_options[:class] = "govuk-warning-text #{govuk_warning_text_options[:classes]}".rstrip
+
+        tag.div(class: govuk_warning_text_options[:class], **(govuk_warning_text_options[:attributes] || {})) do
+          capture do
+            concat(tag.span('!', class: 'govuk-warning-text__icon'))
+            concat(tag.strong(class: 'govuk-warning-text__text') do
+              capture do
+                concat(tag.span(govuk_warning_text_options[:icon_fallback_text] || 'Warning', class: 'govuk-warning-text__assistive'))
+                if text
+                  concat(text)
+                else
+                  yield
+                end
+              end
+            end)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/{gov_uk_helper.rb → helpers/gov_uk_helper.rb}

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative 'gov_uk_helper/accordion'
+require_relative 'gov_uk_helper/back_link'
 require_relative 'gov_uk_helper/breadcrumbs'
 require_relative 'gov_uk_helper/button'
 require_relative 'gov_uk_helper/details'
@@ -22,12 +24,15 @@ require_relative 'gov_uk_helper/notification_banner'
 require_relative 'gov_uk_helper/pagination'
 require_relative 'gov_uk_helper/step_by_step_navigation'
 require_relative 'gov_uk_helper/tag'
+require_relative 'gov_uk_helper/warning_text'
 
-module CrownMarketplaceUtils
+module CrownMarketplaceUtils::Helpers
   # This module loads in all the GOV.UK Helper methods.
   # These are a collection of view helpers to help render GOV.UK components
 
   module GovUkHelper
+    include Accordion
+    include BackLink
     include Breadcrumbs
     include Button
     include Details
@@ -50,5 +55,6 @@ module CrownMarketplaceUtils
     include Pagination
     include StepByStepNavigation
     include Tag
+    include WarningText
   end
 end

data/lib/crown_marketplace_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CrownMarketplaceUtils
-  VERSION = '0.1.0.beta.4 '
+  VERSION = '0.1.0.beta.6'
 end

data/lib/crown_marketplace_utils.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'crown_marketplace_utils/gov_uk_helper'
+require 'crown_marketplace_utils/helpers/gov_uk_helper'
 
 require_relative 'crown_marketplace_utils/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: crown_marketplace_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta.4
+  version: 0.1.0.beta.6
 platform: ruby
 authors:
 - tim-s-ccs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -168,29 +168,32 @@ files:
 - Rakefile
 - crown_marketplace_utils.gemspec
 - lib/crown_marketplace_utils.rb
-- lib/crown_marketplace_utils/gov_uk_helper.rb
-- lib/crown_marketplace_utils/gov_uk_helper/breadcrumbs.rb
-- lib/crown_marketplace_utils/gov_uk_helper/button.rb
-- lib/crown_marketplace_utils/gov_uk_helper/details.rb
-- lib/crown_marketplace_utils/gov_uk_helper/error_message.rb
-- lib/crown_marketplace_utils/gov_uk_helper/field.rb
-- lib/crown_marketplace_utils/gov_uk_helper/field/character_count.rb
-- lib/crown_marketplace_utils/gov_uk_helper/field/checkboxes.rb
-- lib/crown_marketplace_utils/gov_uk_helper/field/date_input.rb
-- lib/crown_marketplace_utils/gov_uk_helper/field/file_upload.rb
-- lib/crown_marketplace_utils/gov_uk_helper/field/input.rb
-- lib/crown_marketplace_utils/gov_uk_helper/field/radios.rb
-- lib/crown_marketplace_utils/gov_uk_helper/field/select.rb
-- lib/crown_marketplace_utils/gov_uk_helper/field/textarea.rb
-- lib/crown_marketplace_utils/gov_uk_helper/fieldset.rb
-- lib/crown_marketplace_utils/gov_uk_helper/form_group.rb
-- lib/crown_marketplace_utils/gov_uk_helper/header.rb
-- lib/crown_marketplace_utils/gov_uk_helper/hint.rb
-- lib/crown_marketplace_utils/gov_uk_helper/label.rb
-- lib/crown_marketplace_utils/gov_uk_helper/notification_banner.rb
-- lib/crown_marketplace_utils/gov_uk_helper/pagination.rb
-- lib/crown_marketplace_utils/gov_uk_helper/step_by_step_navigation.rb
-- lib/crown_marketplace_utils/gov_uk_helper/tag.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/accordion.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/back_link.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/breadcrumbs.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/button.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/details.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/error_message.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/field.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/field/character_count.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/field/checkboxes.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/field/date_input.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/field/file_upload.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/field/input.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/field/radios.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/field/select.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/field/textarea.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/fieldset.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/form_group.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/header.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/hint.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/label.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/notification_banner.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/pagination.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/step_by_step_navigation.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/tag.rb
+- lib/crown_marketplace_utils/helpers/gov_uk_helper/warning_text.rb
 - lib/crown_marketplace_utils/version.rb
 - sig/crown_marketplace_utils.rbs
 homepage: https://github.com/tim-s-ccs/crown_marketplace_utils

data/lib/crown_marketplace_utils/gov_uk_helper/field/file_upload.rb

@@ -1,125 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../field'
-
-module CrownMarketplaceUtils
-  module GovUkHelper
-    module Field
-      # = GOV.UK File Upload
-      #
-      # This helper is used for generating the file upload component from the
-      # {https://design-system.service.gov.uk/components/file-upload GDS - Components - File Upload}
-      #
-      # This is considered a Field module and so makes use of the methods in {CrownMarketplaceUtils::GovUkHelper::Field}
-
-      module FileUpload
-        include Field
-
-        # Generates the HTML for the GOV.UK file upload component
-        #
-        # @param attribute [String, Symbol] the attribute of the file upload
-        # @param error_message [String] the error message to be displayed
-        # @param govuk_file_upload_options [Hash] options that will be used for the parts of the form group, label, hint and file upload
-        #
-        # @option govuk_file_upload_options [Hash] :form_group see {govuk_field}
-        # @option govuk_file_upload_options [Hash] :label see {govuk_field}
-        # @option govuk_file_upload_options [Hash] :hint see {govuk_field}
-        # @option govuk_file_upload_options [Hash] :file_upload ({}) the options that will be used when rendering the file upload.
-        #                                                            See {govuk_file_upload_field} for more details.
-        #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK File Upload
-        #                                     which can then be rendered on the page
-
-        def govuk_file_upload(attribute, error_message = nil, **govuk_file_upload_options)
-          govuk_field(:file_upload, attribute, error_message, **govuk_file_upload_options) do |govuk_field_options|
-            concat(govuk_file_upload_field(attribute, error_message, **govuk_field_options))
-          end
-        end
-
-        # Generates the HTML for the GOV.UK file upload component using an ActiveModel.
-        # Unlike {govuk_file_upload}, the method will be able to automatically determine if the error message needs to be shown.
-        #
-        # @param model [ActiveModel] model that will be used to find an error message for the file upload
-        # @param attribute [String, Symbol] the attribute of the file upload
-        # @param govuk_file_upload_options [Hash] options that will be used for the parts of the form group, label, hint and file upload
-        #
-        # @option (see govuk_file_upload)
-        #
-        # @return (see govuk_file_upload)
-
-        def govuk_file_upload_with_model(model, attribute, **govuk_file_upload_options)
-          govuk_field_with_model(:file_upload, model, attribute, **govuk_file_upload_options) do |govuk_field_options, error_message|
-            concat(govuk_file_upload_field(attribute, error_message, **govuk_field_options))
-          end
-        end
-
-        # Generates the HTML for the GOV.UK file upload component using an ActionView::Helpers::FormBuilder.
-        # Unlike {govuk_file_upload}, the method will be able to automatically determine if the error message needs to be shown.
-        #
-        # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the file upload input
-        # @param attribute [String, Symbol] the attribute of the file upload
-        # @param govuk_file_upload_options [Hash] options that will be used for the parts of the form group, label, hint and file upload
-        #
-        # @option (see govuk_file_upload)
-        #
-        # @return (see govuk_file_upload)
-
-        def govuk_file_upload_with_form(form, attribute, **govuk_file_upload_options)
-          govuk_field_with_form(:file_upload, form, attribute, **govuk_file_upload_options) do |govuk_field_options, error_message|
-            concat(govuk_file_upload_field_with_form(form, attribute, error_message, **govuk_field_options))
-          end
-        end
-
-        private
-
-        # Generates the file upload HTML for {govuk_file_upload} and {govuk_file_upload_with_model}
-        #
-        # @param attribute [String, Symbol] the attribute of the file upload
-        # @param error_message [String] the error message to be displayed
-        # @param govuk_file_upload_options [Hash] options that will be used in customising the HTML
-        #
-        # @option (see set_file_upload_options)
-        #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the file upload field which is used in {govuk_file_upload} and {govuk_file_upload_with_model}
-
-        def govuk_file_upload_field(attribute, error_message, **govuk_file_upload_options)
-          set_file_upload_options(error_message, govuk_file_upload_options)
-
-          file_field_tag(attribute, class: govuk_file_upload_options[:classes], **govuk_file_upload_options[:attributes])
-        end
-
-        # Generates the file upload HTML for {govuk_file_upload_with_form}
-        #
-        # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the file upload input
-        # @param attribute [String, Symbol] the attribute of the file upload
-        # @param error_message [String] used to indicate if there is an error which will add an extra classes
-        # @param govuk_file_upload_options [Hash] options that will be used in customising the HTML
-        #
-        # @option (see set_file_upload_options)
-        #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the file upload field which is used in {govuk_file_upload_with_form}
-
-        def govuk_file_upload_field_with_form(form, attribute, error_message, **govuk_file_upload_options)
-          set_file_upload_options(error_message, govuk_file_upload_options)
-
-          form.file_field(attribute, class: govuk_file_upload_options[:classes], **govuk_file_upload_options[:attributes])
-        end
-
-        # Initialises the attributes for the file upload input
-        #
-        # @param error_message [String] used to indicate if there is an error which will add extra classes
-        # @param govuk_file_upload_options [Hash] options that will be used in customising the HTML
-        #
-        # @option govuk_file_upload_options [String] :classes additional CSS classes for the file iupload HTML
-        # @option govuk_file_upload_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
-
-        def set_file_upload_options(error_message, govuk_file_upload_options)
-          govuk_file_upload_options[:classes] = "govuk-file-upload #{govuk_file_upload_options[:classes]}".rstrip
-          govuk_file_upload_options[:classes] << ' govuk-file-upload--error' if error_message
-
-          govuk_file_upload_options[:attributes] ||= {}
-        end
-      end
-    end
-  end
-end