crown_marketplace_utils 0.1.0.beta.2 → 0.1.0.beta.4

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

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    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 {CrownMarketplaceUtils::GovUkHelper::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 error_message [String] the error message to be displayed
+        # @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 [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, error_message = nil, **govuk_checkboxes_options)
+          govuk_fields(:checkboxes, attribute, error_message, **govuk_checkboxes_options) do |govuk_field_options|
+            concat(govuk_checkboxes_fields(attribute, items, **govuk_field_options))
+          end
+        end
+
+        # Generates the HTML for the GOV.UK Checkboxes component using an ActiveModel.
+        # Unlike {govuk_checkboxes}, 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 and the checked 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 for the parts of the fieldset, form group, hint and checkbox buttons
+        #
+        # @option (see govuk_checkboxes)
+        #
+        # @return (see govuk_checkboxes)
+
+        def govuk_checkboxes_with_model(model, attribute, items, **govuk_checkboxes_options)
+          values = model.send(attribute) || []
+          items.each { |item| item[:checked] = values.include?(item[:value]) }
+
+          govuk_fields_with_model(:checkboxes, model, attribute, **govuk_checkboxes_options) do |govuk_field_options|
+            concat(govuk_checkboxes_fields(attribute, items, **govuk_field_options))
+          end
+        end
+
+        # Generates the HTML for the GOV.UK Checkboxes component using an ActionView::Helpers::FormBuilder.
+        # Unlike {govuk_checkboxes}, 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 checkbox buttons
+        # @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 (see govuk_checkboxes)
+        #
+        # @return (see govuk_checkboxes)
+
+        def govuk_checkboxes_with_form(form, attribute, items, **govuk_checkboxes_options)
+          govuk_fields_with_form(:checkboxes, form, attribute, **govuk_checkboxes_options) do |govuk_field_options|
+            concat(govuk_checkboxes_fields_with_form(form, attribute, items, **govuk_field_options))
+          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_checkboxes_fields(attribute, items, **govuk_checkboxes_options)
+          _govuk_checkboxes_fields(items, **govuk_checkboxes_options) do |checkbox_item|
+            govuk_checkbox_item(attribute, checkbox_item)
+          end
+        end
+
+        # Generates the checkboxes HTML for {govuk_checkboxes_with_form}
+        #
+        # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the checkbox buttons
+        # @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_with_form}
+
+        def govuk_checkboxes_fields_with_form(form, attribute, items, **govuk_checkboxes_options)
+          _govuk_checkboxes_fields(items, **govuk_checkboxes_options) do |checkbox_item|
+            govuk_checkbox_item_with_form(form, attribute, checkbox_item)
+          end
+        end
+
+        # Wrapper method used by {govuk_checkboxes_fields} and {govuk_checkboxes_fields_with_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_checkboxes_fields} or {govuk_checkboxes_fields_with_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_checkboxes_fields} or {govuk_checkboxes_fields_with_form}
+
+        def _govuk_checkboxes_fields(items, **govuk_checkboxes_options)
+          govuk_checkboxes_classes = ['govuk-checkboxes']
+          govuk_checkboxes_classes << govuk_checkboxes_options[:classes]
+          ((govuk_checkboxes_options[:attributes] ||= {})[:data] ||= {}).merge!({ module: 'govuk-checkboxes' })
+
+          tag.div(class: govuk_checkboxes_classes, **govuk_checkboxes_options[:attributes]) do
+            capture 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
+        end
+
+        # Generates the HTML for a checkbox button for {govuk_checkboxes_fields_with_form}
+        #
+        # @param (see _govuk_checkbox_item)
+        #
+        # @option (see _govuk_checkbox_item)
+        #
+        # @return (see _govuk_checkbox_item)
+
+        def govuk_checkbox_item(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], class: 'govuk-checkboxes__input', **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_checkboxes_fields}
+        #
+        # @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_with_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({ class: 'govuk-checkboxes__input', multiple: true, include_hidden: false }), checkbox_item[:value]))
+            concat(govuk_label_with_form(form, attribute, checkbox_item[:label][:text], **checkbox_item[:label]))
+          end
+        end
+
+        # Wrapper method used by {govuk_checkbox_item} and {govuk_checkbox_item_with_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] :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} and {govuk_checkbox_item_with_form}
+
+        def _govuk_checkbox_item(attribute, checkbox_item)
+          checkbox_item[:attributes] ||= {}
+          checkbox_item[:label] ||= {}
+          checkbox_item[:label][:classes] = "govuk-checkboxes__label #{checkbox_item[:label][:classes]}".rstrip
+
+          set_item_options_for_hint('checkboxes', attribute, checkbox_item) if checkbox_item[:hint]
+
+          capture do
+            yield
+            concat(govuk_hint(checkbox_item[:hint][:text], **checkbox_item[:hint])) if checkbox_item[:hint]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,234 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+require_relative 'input'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    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 {CrownMarketplaceUtils::GovUkHelper::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 error_message [String] the error message to be displayed
+        # @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 [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, error_message = nil, **govuk_date_input_options)
+          set_govuk_date_input_fieldset_options(**govuk_date_input_options)
+
+          govuk_fields(:date_input, attribute, error_message, **govuk_date_input_options) do |govuk_field_options|
+            concat(govuk_date_input_fields(attribute, error_message, **govuk_field_options))
+          end
+        end
+
+        # Generates the HTML for the GOV.UK date input component using an ActiveModel.
+        # Unlike {govuk_date_input_with_model}, 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 and the value of the date inputs
+        # @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 (see govuk_date_input)
+        #
+        # @return (see govuk_date_input)
+
+        def govuk_date_input_with_model(model, attribute, **govuk_date_input_options)
+          set_govuk_date_input_fieldset_options(**govuk_date_input_options)
+
+          govuk_fields_with_model(:date_input, model, attribute, **govuk_date_input_options) do |govuk_field_options, any_errors|
+            concat(govuk_date_input_fields_with_model(model, attribute, any_errors, **govuk_field_options))
+          end
+        end
+
+        # Generates the HTML for the GOV.UK date input component using an ActionView::Helpers::FormBuilder.
+        # Unlike {govuk_date_input_with_model}, 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 date inputs
+        # @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 (see govuk_date_input)
+        #
+        # @return (see govuk_date_input)
+
+        def govuk_date_input_with_form(form, attribute, **govuk_date_input_options)
+          set_govuk_date_input_fieldset_options(**govuk_date_input_options)
+
+          govuk_fields_with_form(:date_input, form, attribute, **govuk_date_input_options) do |govuk_field_options, any_errors|
+            concat(govuk_date_input_fields_with_form(form, attribute, any_errors, **govuk_field_options))
+          end
+        end
+
+        private
+
+        # Generates the date inputs HTML for {govuk_date_input}
+        #
+        # @param (see _govuk_date_input_fields)
+        #
+        # @option (see _govuk_date_input_fields)
+        #
+        # @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)
+          _govuk_date_input_fields(attribute, any_errors, **govuk_date_input_options) do |date_item_attribute, date_item_input_options|
+            govuk_input(
+              date_item_attribute,
+              **date_item_input_options
+            )
+          end
+        end
+
+        # Generates the date inputs HTML for {govuk_date_input_with_model}
+        #
+        # @param model [ActiveModel] model that will be used to find an error message and the value of the date inputs
+        # @param (see _govuk_date_input_fields)
+        #
+        # @option (see _govuk_date_input_fields)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the date inputs which is used in {govuk_date_input_with_model}
+
+        def govuk_date_input_fields_with_model(model, attribute, any_errors, **govuk_date_input_options)
+          _govuk_date_input_fields(attribute, any_errors, **govuk_date_input_options) do |date_item_attribute, date_item_input_options|
+            govuk_input_with_model(
+              model,
+              date_item_attribute,
+              **date_item_input_options
+            )
+          end
+        end
+
+        # Generates the date inputs HTML for {govuk_date_input_with_form}
+        #
+        # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the date inputs
+        # @param (see _govuk_date_input_fields)
+        #
+        # @option (see _govuk_date_input_fields)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the date inputs which is used in {govuk_date_input_with_form}
+
+        def govuk_date_input_fields_with_form(form, attribute, any_errors, **govuk_date_input_options)
+          _govuk_date_input_fields(attribute, any_errors, **govuk_date_input_options) do |date_item_attribute, date_item_input_options|
+            govuk_input_with_form(
+              form,
+              date_item_attribute,
+              **date_item_input_options
+            )
+          end
+        end
+
+        # 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_fields}, {govuk_date_input_fields_with_model} and {govuk_date_input_fields_with_form}
+        # 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_fields}, {govuk_date_input_fields_with_model} and {govuk_date_input_fields_with_form}
+
+        def _govuk_date_input_fields(attribute, any_errors, **govuk_date_input_options)
+          govuk_date_input_classes = ['govuk-date-input']
+          govuk_date_input_classes << govuk_date_input_options[:classes]
+          date_items = govuk_date_input_options[: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'
+              }
+            }
+          ]
+
+          govuk_date_input_options[:attributes] ||= {}
+
+          tag.div(class: govuk_date_input_classes, **govuk_date_input_options[:attributes]) do
+            capture 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
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,125 @@
+# 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