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

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

@@ -2,7 +2,7 @@
 
 require_relative '../field'
 
-module CrownMarketplaceUtils
+module CrownMarketplaceUtils::Helpers
   module GovUkHelper
     module Field
       # = GOV.UK Checkboxes
@@ -19,60 +19,35 @@ module CrownMarketplaceUtils
         #
         # @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 [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.
+        #                                                                  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(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
 
-        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))
+            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
 
@@ -88,30 +63,28 @@ module CrownMarketplaceUtils
         #
         # @return [ActiveSupport::SafeBuffer] the HTML for the checkbox buttons which is used in {govuk_checkboxes}
 
-        def govuk_checkboxes_fields(attribute, items, **govuk_checkboxes_options)
+        def govuk_checkbox_field_tag(attribute, items, **govuk_checkboxes_options)
           _govuk_checkboxes_fields(items, **govuk_checkboxes_options) do |checkbox_item|
-            govuk_checkbox_item(attribute, checkbox_item)
+            govuk_checkbox_item_tag(attribute, checkbox_item)
           end
         end
 
-        # Generates the checkboxes HTML for {govuk_checkboxes_with_form}
+        # 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 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
+        # @param (see govuk_checkbox_field_tag)
         #
         # @option (see _govuk_checkboxes_fields)
         #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the checkbox buttons which is used in {govuk_checkboxes_with_form}
+        # @return (see govuk_checkbox_field_tag)
 
-        def govuk_checkboxes_fields_with_form(form, attribute, items, **govuk_checkboxes_options)
+        def govuk_checkbox_field_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)
+            govuk_checkbox_item_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
+        # 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:
@@ -122,18 +95,18 @@ module CrownMarketplaceUtils
         # @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}
+        # @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_checkboxes_fields} or {govuk_checkboxes_fields_with_form}
+        # @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)
-          govuk_checkboxes_classes = ['govuk-checkboxes']
-          govuk_checkboxes_classes << govuk_checkboxes_options[:classes]
-          ((govuk_checkboxes_options[:attributes] ||= {})[:data] ||= {}).merge!({ module: 'govuk-checkboxes' })
+          govuk_checkboxes_options[:attributes] ||= {}
+          govuk_checkboxes_options[:attributes][:class] = "govuk-checkboxes #{govuk_checkboxes_options[:classes]}".rstrip
+          (govuk_checkboxes_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-checkboxes' })
 
-          tag.div(class: govuk_checkboxes_classes, **govuk_checkboxes_options[:attributes]) do
+          tag.div(**govuk_checkboxes_options[:attributes]) do
             capture do
               items.each do |checkbox_item|
                 concat(
@@ -150,7 +123,7 @@ module CrownMarketplaceUtils
           end
         end
 
-        # Generates the HTML for a checkbox button for {govuk_checkboxes_fields_with_form}
+        # Generates the HTML for a checkbox button for {govuk_checkbox_field_form}
         #
         # @param (see _govuk_checkbox_item)
         #
@@ -158,7 +131,7 @@ module CrownMarketplaceUtils
         #
         # @return (see _govuk_checkbox_item)
 
-        def govuk_checkbox_item(attribute, 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])}"
 
@@ -167,7 +140,7 @@ module CrownMarketplaceUtils
           end
         end
 
-        # Generates the HTML for a checkbox button for {govuk_checkboxes_fields}
+        # 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
@@ -176,17 +149,19 @@ module CrownMarketplaceUtils
         #
         # @return (see _govuk_checkbox_item)
 
-        def govuk_checkbox_item_with_form(form, attribute, 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({ 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]))
+            concat(govuk_label(attribute, checkbox_item[:label][:text], form: form, **checkbox_item[:label]))
           end
         end
 
-        # Wrapper method used by {govuk_checkbox_item} and {govuk_checkbox_item_with_form} to generate the checkboxes HTML
+        # 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
@@ -196,23 +171,32 @@ module CrownMarketplaceUtils
         # @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} and {govuk_checkbox_item_with_form}
+        #                                     which is used in {govuk_checkbox_item_tag} and {govuk_checkbox_item_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]
+          set_item_options_for_hint('checkboxes', attribute, checkbox_item)
+          set_conditional_item_options('checkboxes', attribute, checkbox_item)
 
           capture do
             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
         end
+
+        # rubocop:enable Metrics/AbcSize
       end
     end
   end

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

@@ -3,7 +3,7 @@
 require_relative '../field'
 require_relative 'input'
 
-module CrownMarketplaceUtils
+module CrownMarketplaceUtils::Helpers
   module GovUkHelper
     module Field
       # = GOV.UK Date Input
@@ -20,121 +20,38 @@ module CrownMarketplaceUtils
         # 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 [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.
+        #                                                                  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)
+        def govuk_date_input(attribute, **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))
+          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
 
-        # 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
@@ -143,8 +60,7 @@ module CrownMarketplaceUtils
           (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
+        # 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
@@ -161,36 +77,14 @@ module CrownMarketplaceUtils
         # @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}
+        # @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_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] ||= {}
+          govuk_date_input_options[:attributes][:class] = "govuk-date-input #{govuk_date_input_options[:classes]}".rstrip
+          date_items = govuk_date_input_options[:date_items] || govuk_default_date_items
 
-          tag.div(class: govuk_date_input_classes, **govuk_date_input_options[:attributes]) do
+          tag.div(**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
@@ -228,6 +122,31 @@ module CrownMarketplaceUtils
           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

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CrownMarketplaceUtils::Helpers
+  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 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 {set_file_upload_options} 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|
+            set_file_upload_options(error_message, govuk_field_options)
+
+            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 (see set_file_upload_options)
+        #
+        # @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 set_file_upload_options)
+        #
+        # @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
+
+        # 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[:attributes] ||= {}
+          govuk_file_upload_options[:attributes][:class] = "govuk-file-upload #{govuk_file_upload_options[:classes]}".rstrip
+          govuk_file_upload_options[:attributes][:class] << ' govuk-file-upload--error' if error_message
+        end
+      end
+    end
+  end
+end