ccs-frontend_helpers 0.1.0.rc.1

data/lib/ccs/frontend_helpers/govuk_frontend/field/character_count.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require_relative 'textarea'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      module Field
+        # = GOV.UK Character count
+        #
+        # This helper is used for generating the character count component from the
+        # {https://design-system.service.gov.uk/components/character-count GDS - Components - Character count}
+        #
+        # This is a wrapper around a Textarea module and so makes use of the methods in {Textarea}
+
+        module CharacterCount
+          include Textarea
+
+          # Generates the HTML for the GOV.UK character count component.
+          # It works by warpping the govuk_textarea in HTML which will trigger the JavaScript to do the character count.
+          #
+          # @param attribute [String, Symbol] the attribute of the character count text area
+          # @param govuk_character_count_options [Hash] options that will be used for the parts of the form group, label, hint, textarea and the character count
+          #
+          # @option govuk_character_count_options [String] :error_message (nil) the error message to be displayed
+          # @option govuk_character_count_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+          # @option govuk_character_count_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+          #                                                                                 the textarea tag and find the error message
+          # @option govuk_character_count_options [Hash] :form_group see {govuk_field}
+          # @option govuk_character_count_options [Hash] :label see {govuk_field}
+          # @option govuk_character_count_options [Hash] :hint see {govuk_field}
+          # @option govuk_character_count_options [Hash] :textarea see {govuk_textarea}
+          # @option govuk_character_count_options [Hash] :character_count ({}) the options that will be used when rendering the textarea.
+          #                                                                    See {_govuk_character_count} for more details.
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK chracter count
+          #                                     which can then be rendered on the page
+
+          def govuk_character_count(attribute, **govuk_character_count_options)
+            character_count_attribute = govuk_character_count_options[:form] ? "#{form.object_name}_#{attribute}" : attribute
+
+            _govuk_character_count(character_count_attribute, **govuk_character_count_options) do |govuk_textarea_options|
+              govuk_textarea(
+                attribute,
+                error_message: govuk_character_count_options[:error_message],
+                model: govuk_character_count_options[:model],
+                form: govuk_character_count_options[:form],
+                **govuk_textarea_options
+              )
+            end
+          end
+
+          private
+
+          # Wrapper method used by {govuk_character_count} to generate the character count HTML
+          #
+          # @param attribute [String, Symbol] the attribute of the character count
+          # @param govuk_character_count_options [Hash] options that will be used in customising the HTML.
+          #                                             This includes everything described in {govuk_character_count}
+          #                                             with the addition of the +:character_count+ which are described below
+          #
+          # @option govuk_character_count_options [String] :maxlength (required) - if +maxwords+ is set, this is not required.
+          #                                                           The maximum number of characters.
+          #                                                           If +maxwords+ is provided, the +maxlength+ option will be ignored.
+          # @option govuk_character_count_options [String] :maxwords (required) - if maxlength is set, this is not required.
+          #                                                          The maximum number of words.
+          #                                                          If +maxwords+ is provided, the +maxlength+ option will be ignored.
+          # @option govuk_character_count_options [String] :threshold the percentage value of the limit at which point the count message is displayed.
+          #                                                           If this attribute is set, the count message will be hidden by default.
+          # @option govuk_textarea_options [Hash] :fallback_hint ({}) additional parameters that will be used to create the hint containing the character count text.
+          #                                                                This includes all the options in {govuk_hint} plus +:count_message+.
+          #                                                                This will replace the default text for the count message.
+          #                                                                If you want the count number to appear, put %<count>s in the string and it will be replaced with the number
+          #
+          # @yield the textarea HTML generated by {govuk_character_count}
+          #
+          # @yieldparam govuk_textarea_options [Hash] the options used in the textarea called by {govuk_character_count}
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the chracter count which wrpas arround {govuk_character_count}
+
+          def _govuk_character_count(attribute, **govuk_character_count_options)
+            deep_init_hash(govuk_character_count_options, :textarea, :attributes, :aria)
+            govuk_character_count_options[:textarea][:attributes][:aria][:describedby] = [govuk_character_count_options.dig(:textarea, :attributes, :aria, :describedby), "#{attribute}-info"].compact.join(' ')
+
+            govuk_character_count_options[:textarea][:classes] = "#{govuk_character_count_options[:textarea][:classes]} govuk-js-character-count".lstrip
+
+            tag.div(**get_character_count_attributes(**govuk_character_count_options)) do
+              concat(yield(govuk_character_count_options))
+              concat(character_count_hint(attribute, **govuk_character_count_options))
+            end
+          end
+
+          # Generates the fallback hint HTML for {_govuk_character_count}
+          #
+          # @param (see _govuk_character_count)
+          #
+          # @option (see _govuk_character_count)
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the fullback hint used in {_govuk_character_count}
+
+          def character_count_hint(attribute, **govuk_character_count_options)
+            fallback_hint_length = govuk_character_count_options[:character_count][:maxwords] || govuk_character_count_options[:character_count][:maxlength]
+            fallback_hint_default = "You can enter up to %<count>s #{govuk_character_count_options[:character_count][:maxwords] ? 'words' : 'characters'}"
+
+            deep_init_hash(govuk_character_count_options, :character_count, :fallback_hint, :attributes)
+
+            fallback_hint_text = format(govuk_character_count_options[:character_count][:fallback_hint][:count_message] || fallback_hint_default, count: fallback_hint_length)
+
+            govuk_character_count_options[:character_count][:fallback_hint][:classes] = "#{govuk_character_count_options.dig(:character_count, :fallback_hint, :classes)} govuk-character-count__message".lstrip
+            govuk_character_count_options[:character_count][:fallback_hint][:attributes].merge!(id: "#{attribute}-info")
+
+            govuk_hint(fallback_hint_text, **govuk_character_count_options[:character_count][:fallback_hint])
+          end
+
+          # Generates a hash with the character count attributes used in {_govuk_character_count}
+          #
+          # @param govuk_character_count_options [Hash] options that will be used in customising the HTML.
+          #                                             This includes everything described in {govuk_character_count}
+          #                                             with the addition of the +:character_count+ which are described below
+          #
+          # @option (see _govuk_character_count)
+          #
+          # @return [Hash] contains the HTMl attributes used in {_govuk_character_count}
+
+          def get_character_count_attributes(**govuk_character_count_options)
+            govuk_character_count_attributes = { class: 'govuk-character-count', data: { module: 'govuk-character-count' } }
+
+            %i[maxlength threshold maxwords].each do |data_attribute|
+              govuk_character_count_attributes[:data][data_attribute] = govuk_character_count_options[:character_count][data_attribute].to_s if govuk_character_count_options[:character_count][data_attribute]
+            end
+
+            govuk_character_count_attributes
+          end
+
+          # Method to initialise hashes within hashes if it is not already initialised
+          #
+          # @param hash [Hash] the hash that is going to be initialised
+          # @param keys [Array] the keys that are going to be initialised in the hash
+          #
+          # @example When the hash is completely empty
+          #   hash = { }
+          #   keys = [:a, :b, :c]
+          #
+          #   deep_init_hash(hash, *keys)
+          #
+          #   hash = { a: { b: { c: { } } } }
+          #
+          # @example When the hash has already been initialised
+          #   hash = { a: { b: { d: 'hello' } } }
+          #   keys = [:a, :b, :c]
+          #
+          #   deep_init_hash(hash, *keys)
+          #
+          #   hash = { a: { b: { d: 'hello', c: { } } } }
+
+          def deep_init_hash(hash, *keys)
+            current_hash = hash
+
+            keys.each { |key| current_hash = (current_hash[key] ||= {}) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/frontend_helpers/govuk_frontend/field/checkboxes.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      module Field
+        # = GOV.UK Checkboxes
+        #
+        # This helper is used for generating the checkboxes component from the
+        # {https://design-system.service.gov.uk/components/checkboxes GDS - Components - Checkboxes}
+        #
+        # This is considered a Field module and so makes use of the methods in {CCS::FrontendHelpers::GovUKFrontend::Field}
+
+        module Checkboxes
+          include Field
+
+          # Generates the HTML for the GOV.UK Checkboxes component
+          #
+          # @param attribute [String, Symbol] the attribute of the raido buttons
+          # @param items [Array] array of checkbox items, see {_govuk_checkboxes_fields}
+          # @param govuk_checkboxes_options [Hash] options that will be used for the parts of the fieldset, form group, hint and checkbox buttons
+          #
+          # @option govuk_checkboxes_options [String] :error_message (nil) the error message to be displayed
+          # @option govuk_checkboxes_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+          # @option govuk_checkboxes_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+          #                                                                           the checkbox tags and find the error message
+          # @option govuk_checkboxes_options [Hash] :form_group see {govuk_fields}
+          # @option govuk_checkboxes_options [Hash] :fieldset see {govuk_fields}
+          # @option govuk_checkboxes_options [Hash] :hint see {govuk_field}
+          # @option govuk_checkboxes_options [Hash] :checkboxes ({}) the options that will be used when rendering the checkbox buttons.
+          #                                                                  See {_govuk_checkboxes_fields} for more details.
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Checkboxes
+          #                                     which can then be rendered on the page
+
+          def govuk_checkboxes(attribute, items, **govuk_checkboxes_options)
+            govuk_fields(:checkboxes, attribute, **govuk_checkboxes_options) do |govuk_field_options|
+              if govuk_checkboxes_options[:model] || govuk_checkboxes_options[:form]
+                values = (govuk_checkboxes_options[:model] || govuk_checkboxes_options[:form].object).send(attribute) || []
+                items.each { |item| item[:checked] = values.include?(item[:value]) }
+              end
+
+              concat(
+                if govuk_checkboxes_options[:form]
+                  govuk_checkbox_field_form(govuk_checkboxes_options[:form], attribute, items, **govuk_field_options)
+                else
+                  govuk_checkbox_field_tag(attribute, items, **govuk_field_options)
+                end
+              )
+            end
+          end
+
+          private
+
+          # Generates the checkboxes HTML for {govuk_checkboxes}
+          #
+          # @param attribute [String, Symbol] the attribute of the raido buttons
+          # @param items [Array] array of checkbox items, see {_govuk_checkboxes_fields}
+          # @param govuk_checkboxes_options [Hash] options that will be used in customising the HTML
+          #
+          # @option (see _govuk_checkboxes_fields)
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the checkbox buttons which is used in {govuk_checkboxes}
+
+          def govuk_checkbox_field_tag(attribute, items, **govuk_checkboxes_options)
+            _govuk_checkboxes_fields(items, **govuk_checkboxes_options) do |checkbox_item|
+              govuk_checkbox_item_tag(attribute, checkbox_item)
+            end
+          end
+
+          # Generates the checkboxes HTML for {govuk_checkboxes} when there is a ActionView::Helpers::FormBuilder
+          #
+          # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the checkbox buttons
+          # @param (see govuk_checkbox_field_tag)
+          #
+          # @option (see _govuk_checkboxes_fields)
+          #
+          # @return (see govuk_checkbox_field_tag)
+
+          def govuk_checkbox_field_form(form, attribute, items, **govuk_checkboxes_options)
+            _govuk_checkboxes_fields(items, **govuk_checkboxes_options) do |checkbox_item|
+              govuk_checkbox_item_form(form, attribute, checkbox_item)
+            end
+          end
+
+          # Wrapper method used by {govuk_checkbox_field_tag} and {govuk_checkbox_field_form} to generate the checkboxes HTML
+          #
+          # @param items [Array] array of checkbox items.
+          #                      Each item is a hash which can be:
+          #                      - +:divider+ text to separate checkbox items
+          #                      - checkbox item, see {_govuk_checkbox_item}
+          # @param govuk_checkboxes_options [Hash] options that will be used in customising the HTML
+          #
+          # @option govuk_checkboxes_options [String] :classes additional CSS classes for the checkboxes HTML
+          # @option govuk_checkboxes_options [Hash] :attributes ({ module: 'govuk-checkboxes' }) any additional attributes that will added as part of the HTML
+          #
+          # @yield the checkbox item HTML generated by {govuk_checkbox_field_tag} or {govuk_checkbox_field_form}
+          #
+          # @yieldparam checkbox_item [Hash] the current checkbox item to be rendered
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the checkbox buttons which is used in {govuk_checkbox_field_tag} or {govuk_checkbox_field_form}
+
+          def _govuk_checkboxes_fields(items, **govuk_checkboxes_options)
+            initialise_attributes_and_set_classes(govuk_checkboxes_options, 'govuk-checkboxes')
+            set_data_module(govuk_checkboxes_options, 'govuk-checkboxes')
+
+            tag.div(**govuk_checkboxes_options[:attributes]) do
+              items.each do |checkbox_item|
+                concat(
+                  if checkbox_item[:divider]
+                    tag.div(checkbox_item[:divider], class: 'govuk-checkboxes__divider')
+                  else
+                    tag.div(class: 'govuk-checkboxes__item') do
+                      yield(checkbox_item)
+                    end
+                  end
+                )
+              end
+            end
+          end
+
+          # Generates the HTML for a checkbox button for {govuk_checkbox_field_form}
+          #
+          # @param (see _govuk_checkbox_item)
+          #
+          # @option (see _govuk_checkbox_item)
+          #
+          # @return (see _govuk_checkbox_item)
+
+          def govuk_checkbox_item_tag(attribute, checkbox_item)
+            _govuk_checkbox_item(attribute, checkbox_item) do
+              checkbox_item[:attributes][:id] ||= "#{sanitize_to_id(attribute)}_#{sanitize_to_id(checkbox_item[:value])}"
+
+              concat(check_box_tag("#{attribute}[]", checkbox_item[:value], checkbox_item[:checked], **checkbox_item[:attributes]))
+              concat(govuk_label(checkbox_item[:attributes][:id], checkbox_item[:label][:text], **checkbox_item[:label]))
+            end
+          end
+
+          # Generates the HTML for a checkbox button for {govuk_checkbox_field_tag}
+          #
+          # @param (see _govuk_checkbox_item)
+          # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the checkbox buttons
+          #
+          # @option (see _govuk_checkbox_item)
+          #
+          # @return (see _govuk_checkbox_item)
+
+          def govuk_checkbox_item_form(form, attribute, checkbox_item)
+            _govuk_checkbox_item(attribute, checkbox_item) do
+              (checkbox_item[:label][:attributes] ||= {})[:value] = checkbox_item[:value]
+              checkbox_item[:label][:attributes][:for] = checkbox_item[:attributes][:id] if checkbox_item[:attributes][:id]
+
+              concat(form.check_box(attribute, checkbox_item[:attributes].merge({ multiple: true, include_hidden: false }), checkbox_item[:value]))
+              concat(govuk_label(attribute, checkbox_item[:label][:text], form: form, **checkbox_item[:label]))
+            end
+          end
+
+          # rubocop:disable Metrics/AbcSize
+
+          # Wrapper method used by {govuk_checkbox_item_tag} and {govuk_checkbox_item_form} to generate the checkboxes HTML
+          # including the label and hint, if there is one.
+          #
+          # @param attribute [String, Symbol] the attribute of the raido buttons
+          # @param checkbox_item [Hash] the options for the checkbox item
+          #
+          # @option checkbox_item [String] :classes additional CSS classes for the checkbox button HTML
+          # @option checkbox_item [Hash] :label the parameters that will be used to create the label for the checkbox button, see {govuk_label}
+          # @option checkbox_item [Hash] :hint (nil) the parameters that will be used to create the hint for the checkbox button, see {govuk_hint}.
+          #                                          If no hint is given then no hint will be rendered
+          # @option checkbox_item [Hash] :conditional (nil) content that will appear when the checkbox input is checked.
+          #                                                 It can have the following options:
+          #                                                 - +[:content]+ the content that will be shown
+          #                                                 - +[:attributes][:id]+ the id of the conditional section
+          #                                                 If no conditional is given then no conditional content will be rendered
+          # @option checkbox_item [Hash] :attributes ({}) any additional attributes that will be added as part of the checkbox button HTML
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the checkbox buttons, label and hint
+          #                                     which is used in {govuk_checkbox_item_tag} and {govuk_checkbox_item_form}
+
+          def _govuk_checkbox_item(attribute, checkbox_item)
+            (checkbox_item[:attributes] ||= {})[:class] = 'govuk-checkboxes__input'
+            checkbox_item[:label] ||= {}
+            checkbox_item[:label][:classes] = "govuk-checkboxes__label #{checkbox_item[:label][:classes]}".rstrip
+
+            set_item_options_for_hint('checkboxes', attribute, checkbox_item)
+            set_conditional_item_options('checkboxes', attribute, checkbox_item)
+
+            yield
+            concat(govuk_hint(checkbox_item[:hint][:text], **checkbox_item[:hint])) if checkbox_item[:hint]
+            concat(tag.div(checkbox_item[:conditional][:content], class: checkbox_item[:conditional][:attributes][:class], id: checkbox_item[:conditional][:attributes][:id])) if checkbox_item[:conditional]
+          end
+
+          # rubocop:enable Metrics/AbcSize
+        end
+      end
+    end
+  end
+end

data/lib/ccs/frontend_helpers/govuk_frontend/field/date_input.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+require_relative 'input'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      module Field
+        # = GOV.UK Date Input
+        #
+        # This helper is used for generating the date input component from the
+        # {https://design-system.service.gov.uk/components/date-input GDS - Components -  Date Input}
+        #
+        # This is considered a Field module and so makes use of the methods in {CCS::FrontendHelpers::GovUKFrontend::Field}
+
+        module DateInput
+          include Field
+          include Input
+
+          # Generates the HTML for the GOV.UK date input component
+          #
+          # @param attribute [String, Symbol] the attribute of the date input
+          # @param govuk_date_input_options [Hash] options that will be used for the parts of the fieldset, form group, hint and date input
+          #
+          # @option govuk_date_input_options [String] :error_message (nil) the error message to be displayed
+          # @option govuk_date_input_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+          # @option govuk_date_input_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+          #                                                                           the date tag and find the error message
+          # @option govuk_date_input_options [Hash] :form_group see {govuk_fields}
+          # @option govuk_date_input_options [Hash] :fieldset see {govuk_fields}
+          # @option govuk_date_input_options [Hash] :hint see {govuk_field}
+          # @option govuk_date_input_options [Hash] :date_input_options ({}) the options that will be used when rendering the date input.
+          #                                                                  See {_govuk_date_input_fields} for more details.
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Date Input
+          #                                     which can then be rendered on the page
+
+          def govuk_date_input(attribute, **govuk_date_input_options)
+            set_govuk_date_input_fieldset_options(**govuk_date_input_options)
+
+            govuk_fields(:date_input, attribute, **govuk_date_input_options) do |govuk_field_options, error_message|
+              concat(_govuk_date_input_fields(attribute, error_message, **govuk_field_options) do |date_item_attribute, date_item_input_options|
+                govuk_input(
+                  date_item_attribute,
+                  model: govuk_date_input_options[:model],
+                  form: govuk_date_input_options[:form],
+                  **date_item_input_options
+                )
+              end)
+            end
+          end
+
+          private
+
+          # Sets the role for the fieldset to group
+          #
+          # @param govuk_date_input_options [Hash] options that will be used for the parts of the fieldset, form group, hint and date input
+
+          def set_govuk_date_input_fieldset_options(**govuk_date_input_options)
+            (govuk_date_input_options[:fieldset][:attributes] ||= {})[:role] = 'group'
+          end
+
+          # Wrapper method used by {govuk_date_input} to generate the date inputs HTML
+          #
+          # @param attribute [String, Symbol] the attribute of the date input
+          # @param any_errors [Boolean] flag to indicate if the inputs need the error class
+          # @param govuk_date_input_options [Hash] options that will be used in customising the HTML
+          #
+          # @option govuk_date_input_options [String] :classes additional CSS classes for the date inputs HTML
+          # @option govuk_date_input_options[Array] :date_items an array of the date items that will be rendered.
+          #                                                     Each date item hash must contain the +:name+ to add as suffix to attribute.
+          #                                                     Anything else in the hash will be used as options in a {govuk_input}.
+          # @option govuk_date_input_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+          #
+          # @yield the date input item HTML generated by the parent method
+          #
+          # @yieldparam date_item_attribute [String] the attribute for individual date input
+          # @yieldparam date_item_input_options [Hash] the HTML options used for the date input item
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the date inputs which is used in {govuk_date_input}
+
+          def _govuk_date_input_fields(attribute, any_errors, **govuk_date_input_options)
+            initialise_attributes_and_set_classes(govuk_date_input_options, 'govuk-date-input')
+
+            date_items = govuk_date_input_options[:date_items] || govuk_default_date_items
+
+            tag.div(**govuk_date_input_options[:attributes]) do
+              enumerate_and_set_date_input_options(date_items, any_errors) do |date_item_input_options|
+                concat(tag.div(class: 'govuk-date-input__item') do
+                  concat(yield("#{attribute}_#{date_item_input_options[:name]}", date_item_input_options))
+                end)
+              end
+            end
+          end
+
+          # rubocop:disable Metrics/CyclomaticComplexity
+
+          # Enumerates and inititalises the attributes of each date input item and is used by {_govuk_date_input_fields}
+          #
+          # @param date_items [Array] an array of the date item hashes that will be inititalised
+          # @param any_errors [Boolean] flag to indicate if the inputs need the error class
+          #
+          # @yield the date input item HTML generated by teach date input item
+          #
+          # @yieldparam date_item_input_options [Hash] the HTML options used for the date input item
+
+          def enumerate_and_set_date_input_options(date_items, any_errors)
+            date_items.each do |date_item_input_options|
+              (date_item_input_options[:input] ||= {})[:attributes] ||= {}
+
+              date_item_input_options[:input][:classes] = "govuk-date-input__input #{date_item_input_options[:input][:classes]} #{'govuk-input--error' if any_errors}".rstrip
+
+              date_item_input_options[:input][:attributes][:inputmode] ||= 'numeric'
+
+              date_item_input_options[:label] ||= {}
+              date_item_input_options[:label][:text] ||= date_item_input_options[:name].capitalize
+              date_item_input_options[:label][:classes] = 'govuk-date-input__label'
+
+              yield(date_item_input_options)
+            end
+          end
+          # rubocop:enable Metrics/CyclomaticComplexity
+
+          # The default date items used in {_govuk_date_input_fields} if no date items are provided
+
+          def govuk_default_date_items
+            [
+              {
+                name: 'day',
+                input: {
+                  classes: 'govuk-input--width-2'
+                }
+              },
+              {
+                name: 'month',
+                input: {
+                  classes: 'govuk-input--width-2'
+                }
+              },
+              {
+                name: 'year',
+                input: {
+                  classes: 'govuk-input--width-4'
+                }
+              }
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/frontend_helpers/govuk_frontend/field/file_upload.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      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 {CCS::FrontendHelpers::GovUKFrontend::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 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 [String] :error_message (nil) the error message to be displayed
+          # @option govuk_file_upload_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+          # @option govuk_file_upload_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+          #                                                                            the file upload input and find the error message
+          # @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_tag} 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, **govuk_file_upload_options)
+            govuk_field(:file_upload, attribute, **govuk_file_upload_options) do |govuk_field_options, error_message|
+              initialise_attributes_and_set_classes(govuk_field_options, "govuk-file-upload #{'govuk-file-upload--error' if error_message}".rstrip)
+
+              concat(
+                if govuk_file_upload_options[:form]
+                  govuk_file_upload_form(govuk_file_upload_options[:form], attribute, **govuk_field_options)
+                else
+                  govuk_file_upload_tag(attribute, **govuk_field_options)
+                end
+              )
+            end
+          end
+
+          private
+
+          # Generates the file upload HTML for {govuk_file_upload}
+          #
+          # @param attribute [String, Symbol] the attribute of the file upload
+          # @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 upload HTML
+          # @option govuk_file_upload_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the file upload field which is used in {govuk_file_upload}
+
+          def govuk_file_upload_tag(attribute, **govuk_file_upload_options)
+            file_field_tag(attribute, **govuk_file_upload_options[:attributes])
+          end
+
+          # Generates the file upload HTML for {govuk_file_upload} when there is a ActionView::Helpers::FormBuilder
+          #
+          # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the file upload input
+          # @param (see govuk_file_upload_tag)
+          #
+          # @option (see govuk_file_upload_tag)
+          #
+          # @return (see govuk_file_upload_tag)
+
+          def govuk_file_upload_form(form, attribute, **govuk_file_upload_options)
+            form.file_field(attribute, **govuk_file_upload_options[:attributes])
+          end
+        end
+      end
+    end
+  end
+end