ccs-frontend_helpers 0.1.0.rc.7 → 0.1.0

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

@@ -0,0 +1,201 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      module Field
+        # = GOV.UK Radios
+        #
+        # This helper is used for generating the radios component from the
+        # {https://design-system.service.gov.uk/components/radios GDS - Components - Radios}
+        #
+        # This is considered a Field module and so makes use of the methods in {CCS::FrontendHelpers::GovUKFrontend::Field}
+
+        module Radios
+          include Field
+
+          # Generates the HTML for the GOV.UK Radios component
+          #
+          # @param attribute [String, Symbol] the attribute of the raido buttons
+          # @param items [Array] array of radio items, see {_govuk_radios_fields}
+          # @param govuk_radios_options [Hash] options that will be used for the parts of the fieldset, form group, hint and radio buttons
+          #
+          # @option govuk_radios_options [String] :error_message (nil) the error message to be displayed
+          # @option govuk_radios_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+          # @option govuk_radios_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+          #                                                                       the radio tags and find the error message
+          # @option govuk_radios_options [Hash] :form_group see {govuk_fields}
+          # @option govuk_radios_options [Hash] :fieldset see {govuk_fields}
+          # @option govuk_radios_options [Hash] :hint see {govuk_field}
+          # @option govuk_radios_options [Hash] :radios ({}) the options that will be used when rendering the radio buttons.
+          #                                                  See {govuk_radio_fields_tag} for more details.
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Radios
+          #                                     which can then be rendered on the page
+
+          def govuk_radios(attribute, items, **govuk_radios_options)
+            govuk_fields(:radios, attribute, **govuk_radios_options) do |govuk_field_options|
+              if govuk_radios_options[:model] || govuk_radios_options[:form]
+                value = (govuk_radios_options[:model] || govuk_radios_options[:form].object).send(attribute)
+                items.each { |item| item[:checked] = item[:value] == value }
+              end
+
+              concat(
+                if govuk_radios_options[:form]
+                  govuk_radio_fields_form(govuk_radios_options[:form], attribute, items, **govuk_field_options)
+                else
+                  govuk_radio_fields_tag(attribute, items, **govuk_field_options)
+                end
+              )
+            end
+          end
+
+          private
+
+          # Generates the radios HTML for {govuk_radios}
+          #
+          # @param attribute [String, Symbol] the attribute of the raido buttons
+          # @param items [Array] array of radio items, see {_govuk_radios_fields}
+          # @param govuk_radios_options [Hash] options that will be used in customising the HTML
+          #
+          # @option (see _govuk_radios_fields)
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the radio buttons which is used in {govuk_radios}
+
+          def govuk_radio_fields_tag(attribute, items, **govuk_radios_options)
+            _govuk_radios_fields(items, **govuk_radios_options) do |radio_item|
+              govuk_radio_item_tag(attribute, radio_item)
+            end
+          end
+
+          # Generates the radios HTML for {govuk_radios} when there is a ActionView::Helpers::FormBuilder
+          #
+          # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the radio buttons
+          # @param (see govuk_radio_fields_tag)
+          #
+          # @option (see _govuk_radios_fields)
+          #
+          # @return (see govuk_radio_fields_tag)
+
+          def govuk_radio_fields_form(form, attribute, items, **govuk_radios_options)
+            _govuk_radios_fields(items, **govuk_radios_options) do |radio_item|
+              govuk_radio_item_form(form, attribute, radio_item)
+            end
+          end
+
+          # Wrapper method used by {govuk_radio_fields_tag} and {govuk_radio_fields_form} to generate the radios HTML
+          #
+          # @param items [Array] array of radio items.
+          #                      Each item is a hash which can be:
+          #                      - +:divider+ text to separate radio items
+          #                      - radio item, see {_govuk_radio_item}
+          # @param govuk_radios_options [Hash] options that will be used in customising the HTML
+          #
+          # @option govuk_radios_options [String] :classes additional CSS classes for the radios HTML
+          # @option govuk_radios_options [Hash] :attributes ({ module: 'govuk-radios' }) any additional attributes that will added as part of the HTML
+          #
+          # @yield the radio item HTML generated by {govuk_radio_fields_tag} or {govuk_radio_fields_form}
+          #
+          # @yieldparam radio_item [Hash] the current radio item to be rendered
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the radio buttons which is used in {govuk_radio_fields_tag} or {govuk_radio_fields_form}
+
+          def _govuk_radios_fields(items, **govuk_radios_options)
+            initialise_attributes_and_set_classes(govuk_radios_options, 'govuk-radios')
+            set_data_module(govuk_radios_options, 'govuk-radios')
+
+            tag.div(**govuk_radios_options[:attributes]) do
+              items.each do |radio_item|
+                concat(
+                  if radio_item[:divider]
+                    tag.div(radio_item[:divider], class: 'govuk-radios__divider')
+                  else
+                    tag.div(class: 'govuk-radios__item') do
+                      yield(radio_item)
+                    end
+                  end
+                )
+              end
+            end
+          end
+
+          # Generates the HTML for a radio button for {govuk_radio_fields_form}
+          #
+          # @param (see _govuk_radio_item)
+          #
+          # @option (see _govuk_radio_item)
+          #
+          # @return (see _govuk_radio_item)
+
+          def govuk_radio_item_tag(attribute, radio_item)
+            _govuk_radio_item(attribute, radio_item) do
+              label_attribute = radio_item[:attributes][:id] || "#{attribute}[#{radio_item[:value]}]"
+
+              concat(radio_button_tag(attribute, radio_item[:value], radio_item[:checked], **radio_item[:attributes]))
+              concat(govuk_label(label_attribute, radio_item[:label][:text], **radio_item[:label]))
+            end
+          end
+
+          # Generates the HTML for a radio button for {govuk_radio_fields_tag}
+          #
+          # @param (see _govuk_radio_item)
+          # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the radio buttons
+          #
+          # @option (see _govuk_radio_item)
+          #
+          # @return (see _govuk_radio_item)
+
+          def govuk_radio_item_form(form, attribute, radio_item)
+            _govuk_radio_item(attribute, radio_item) do
+              (radio_item[:label][:attributes] ||= {})[:value] = radio_item[:value]
+              radio_item[:label][:attributes][:for] = radio_item[:attributes][:id] if radio_item[:attributes][:id]
+
+              concat(form.radio_button(attribute, radio_item[:value], **radio_item[:attributes]))
+              concat(govuk_label(attribute, radio_item[:label][:text], form: form, **radio_item[:label]))
+            end
+          end
+
+          # rubocop:disable Metrics/AbcSize
+
+          # Wrapper method used by {govuk_radio_item_tag} and {govuk_radio_item_form} to generate the radios HTML
+          # including the label and hint, if there is one.
+          #
+          # @param attribute [String, Symbol] the attribute of the raido buttons
+          # @param radio_item [Hash] the options for the radio item
+          #
+          # @option radio_item [String] :classes additional CSS classes for the radio button HTML
+          # @option radio_item [Hash] :label the parameters that will be used to create the label for the radio button, see {govuk_label}
+          # @option radio_item [Hash] :hint (nil) the parameters that will be used to create the hint for the radio button, see {govuk_hint}.
+          #                                          If no hint is given then no hint will be rendered
+          # @option radio_item [Hash] :conditional (nil) content that will appear when the radio button 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 radio_item [Hash] :attributes ({}) any additional attributes that will be added as part of the radio button HTML
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the radio buttons, label and hint
+          #                                     which is used in {govuk_radio_item_tag} and {govuk_radio_item_form}
+
+          def _govuk_radio_item(attribute, radio_item)
+            (radio_item[:attributes] ||= {})[:class] = 'govuk-radios__input'
+
+            radio_item[:label] ||= {}
+            radio_item[:label][:classes] = "govuk-radios__label #{radio_item[:label][:classes]}".rstrip
+
+            set_item_options_for_hint('radios', attribute, radio_item)
+            set_conditional_item_options('radios', attribute, radio_item)
+
+            yield
+            concat(govuk_hint(radio_item[:hint][:text], **radio_item[:hint])) if radio_item[:hint]
+            concat(tag.div(radio_item[:conditional][:content], class: radio_item[:conditional][:attributes][:class], id: radio_item[:conditional][:attributes][:id])) if radio_item[:conditional]
+          end
+
+          # rubocop:enable Metrics/AbcSize
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require_relative '../field'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      module Field
+        # = GOV.UK Select
+        #
+        # This helper is used for generating the select component from the
+        # {https://design-system.service.gov.uk/components/select GDS - Components - Select}
+        #
+        # This is considered a Field module and so makes use of the methods in {CCS::FrontendHelpers::GovUKFrontend::Field}
+
+        module Select
+          include ActionView::Helpers::FormOptionsHelper
+          include Field
+
+          # Generates the HTML for the GOV.UK Select component
+          #
+          # @param attribute [String, Symbol] the attribute of the select field
+          # @param items [Array] array of option items for the select, see {govuk_map_select_items}
+          # @param govuk_select_options [Hash] options that will be used for the parts of the form group, label, hint and select
+          #
+          # @option govuk_select_options [String] :error_message (nil) the error message to be displayed
+          # @option govuk_select_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+          # @option govuk_select_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+          #                                                                       the select tag and find the error message
+          # @option govuk_select_options [Hash] :form_group see {govuk_field}
+          # @option govuk_select_options [Hash] :label see {govuk_field}
+          # @option govuk_select_options [Hash] :hint see {govuk_field}
+          # @option govuk_select_options [Hash] :select ({}) the options that will be used when rendering the select field.
+          #                                                  See {govuk_select_tag} for more details.
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Select
+          #                                     which can then be rendered on the page
+
+          def govuk_select(attribute, items, **govuk_select_options)
+            govuk_field(:select, attribute, **govuk_select_options) do |govuk_field_options, error_message|
+              initialise_attributes_and_set_classes(govuk_field_options, "govuk-select #{'govuk-select--error' if error_message}".rstrip)
+
+              (govuk_select_options[:select] ||= {})[:selected] = govuk_select_options[:model].send(attribute) if govuk_select_options[:model]
+
+              concat(
+                if govuk_select_options[:form]
+                  govuk_select_form(govuk_select_options[:form], attribute, items, **govuk_field_options)
+                else
+                  govuk_select_tag(attribute, items, **govuk_field_options)
+                end
+              )
+            end
+          end
+
+          private
+
+          # Generates the select HTML for {govuk_select}
+          #
+          # @param attribute [String, Symbol] the attribute of the select field
+          # @param items [Array] array of option items for the select, see {govuk_map_select_items}
+          # @param govuk_select_options [Hash] options that will be used in customising the HTML
+          #
+          # @option govuk_select_options [String] :classes additional CSS classes for the select HTML
+          # @option govuk_select_options [String] :selected (nil) the selected option
+          # @option govuk_select_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the select field which is used in {govuk_select}
+
+          def govuk_select_tag(attribute, items, **govuk_select_options)
+            select_tag(
+              attribute,
+              options_for_select(
+                govuk_map_select_items(items),
+                govuk_select_options[:selected]
+              ),
+              **govuk_select_options[:attributes]
+            )
+          end
+
+          # Generates the select HTML for {govuk_select} when there is a ActionView::Helpers::FormBuilder
+          #
+          # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the select field
+          # @param (see govuk_select_tag)
+          #
+          # @option (see govuk_select_tag)
+          #
+          # @return (see govuk_select_tag)
+
+          def govuk_select_form(form, attribute, items, **govuk_select_options)
+            form.select(
+              attribute,
+              govuk_map_select_items(items),
+              govuk_select_options[:select_options] || {},
+              **govuk_select_options[:attributes]
+            )
+          end
+
+          # Maps the items into an array that can be used to generate the options for
+          # {govuk_select_tag} and {govuk_select_form}
+          #
+          # @param items [Array] array of option items for the select
+          #
+          # @option items [String] :text the text of the option item.
+          #                              If this is blank the value is used
+          # @option items [String] :value the value of the option item
+          # @option items [Hash] :attributes ({}) any additional attributes that will added as part of the option HTML
+          #
+          # @return [Array] array of option params that are used in {govuk_select_tag} and {govuk_select_form}
+
+          def govuk_map_select_items(items)
+            items.map do |item|
+              [
+                item[:text] || item[:value],
+                item[:value],
+                (item[:attributes] || {})
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      module Field
+        # = GOV.UK Textarea
+        #
+        # This helper is used for generating the textarea component from the
+        # {https://design-system.service.gov.uk/components/textarea GDS - Components - Textarea}
+        #
+        # This is considered a Field module and so makes use of the methods in {CCS::FrontendHelpers::GovUKFrontend::Field}
+
+        module Textarea
+          include Field
+
+          # Generates the HTML for the GOV.UK textarea component
+          #
+          # @param attribute [String, Symbol] the attribute of the textarea
+          # @param govuk_textarea_options [Hash] options that will be used for the parts of the form group, label, hint and textarea
+          #
+          # @option govuk_textarea_options [String] :error_message (nil) the error message to be displayed
+          # @option govuk_textarea_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+          # @option govuk_textarea_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+          #                                                                         the textarea tag and find the error message
+          # @option govuk_textarea_options [Hash] :form_group see {govuk_field}
+          # @option govuk_textarea_options [Hash] :label see {govuk_field}
+          # @option govuk_textarea_options [Hash] :hint see {govuk_field}
+          # @option govuk_textarea_options [Hash] :textarea ({}) the options that will be used when rendering the textarea.
+          #                                                      See {set_govuk_textarea_field_options} for more details.
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK textarea
+          #                                     which can then be rendered on the page
+
+          def govuk_textarea(attribute, **govuk_textarea_options)
+            govuk_field(:textarea, attribute, **govuk_textarea_options) do |govuk_field_options, error_message|
+              set_govuk_textarea_field_options(error_message, govuk_field_options)
+              (govuk_textarea_options[:textarea] ||= {})[:content] = govuk_textarea_options[:model].send(attribute) if govuk_textarea_options[:model]
+
+              concat(
+                if govuk_textarea_options[:form]
+                  govuk_textarea_form(govuk_textarea_options[:form], attribute, **govuk_field_options)
+                else
+                  govuk_textarea_tag(attribute, **govuk_field_options)
+                end
+              )
+            end
+          end
+
+          private
+
+          # Generates the textarea HTML for {govuk_textarea}
+          #
+          # @param attribute [String, Symbol] the attribute of the textarea
+          # @param govuk_text_textarea_options [Hash] options that will be used in customising the HTML
+          #
+          # @option (see set_govuk_textarea_field_options)
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the textarea field which is used in {govuk_textarea}
+
+          def govuk_textarea_tag(attribute, **govuk_text_textarea_options)
+            text_area_tag(
+              attribute,
+              govuk_text_textarea_options[:content],
+              **govuk_text_textarea_options[:attributes]
+            )
+          end
+
+          # Generates the textarea HTML for {govuk_textarea} when there is a ActionView::Helpers::FormBuilder
+          #
+          # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the textarea
+          # @param (see govuk_textarea_tag)
+          #
+          # @option (see set_govuk_textarea_field_options)
+          #
+          # @return (see govuk_textarea_tag)
+
+          def govuk_textarea_form(form, attribute, **govuk_text_textarea_options)
+            form.text_area(
+              attribute,
+              **govuk_text_textarea_options[:attributes]
+            )
+          end
+
+          # Initialises the attributes for the textarea input
+          #
+          # @param error_message [String] used to indicate if there is an error which will add extra classes
+          # @param govuk_text_textarea_options [Hash] options that will be used in customising the HTML
+          #
+          # @option govuk_text_textarea_options [String] :classes additional CSS classes for the textarea HTML
+          # @option govuk_text_textarea_options [String] :content (nil) the content of the textarea
+          # @option govuk_text_textarea_options [String] :rows (5) the number of rows for the text area
+          # @option govuk_text_textarea_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+
+          def set_govuk_textarea_field_options(error_message, govuk_text_textarea_options)
+            initialise_attributes_and_set_classes(govuk_text_textarea_options, "govuk-textarea #{'govuk-textarea--error' if error_message}".rstrip)
+
+            govuk_text_textarea_options[:attributes][:rows] ||= govuk_text_textarea_options[:rows] || 5
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require_relative 'fieldset'
+require_relative 'form_group'
+require_relative 'hint'
+require_relative 'label'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Field
+      #
+      # This module contains methods to wrap the:
+      # - fieldset
+      # - form group
+      # - label
+      # - hint
+      # - error message
+      # around some kind of input.
+      #
+      # The wrapper functions in this module are used
+      # to create the fields using the structure of a GDS input field component.
+
+      module Field
+        include Fieldset
+        include FormGroup
+        include Hint
+        include Label
+
+        # Generates the HTML to wrap arround a GDS input field component.
+        #
+        # @param field [Symbol] the type of the field
+        # @param attribute [String, Symbol] the attribute of the field
+        # @param govuk_field_options [Hash] options that will be used for the parts of the form group, label, hint and field
+        #
+        # @option govuk_field_options [String] :error_message (nil) the error message to be displayed
+        # @option govuk_field_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+        # @option govuk_field_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+        #                                                                      the field and find the error message
+        # @option govuk_field_options [Hash] :form_group ({}) the options for govuk_form_group {govuk_form_group}
+        # @option govuk_field_options [Hash] :label the parameters that will be used to create the label for the field, see {govuk_label}
+        # @option govuk_field_options [Hash] :hint (nil) the parameters that will be used to create the hint for the field, see {govuk_hint}.
+        #                                                If no hint is given then no hint will be rendered
+        # @option govuk_field_options [Hash] :field_options ({}) the options that will be used when rendering the field.
+        #                                                        For more details look at the specific module that uses +Field+.
+        #
+        # @yield the field HTML
+        #
+        # @yieldparam govuk_field_options [Hash] the HTML options used when rendering the field
+        # @yieldparam error_message [String] flag to indicate if there are any erros
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML that wraps arround the field
+
+        def govuk_field(field, attribute, **govuk_field_options)
+          set_label_for_if_custom_id(field, govuk_field_options)
+          set_hint_id(attribute, govuk_field_options)
+          error_message = find_field_error_message(attribute, govuk_field_options)
+
+          govuk_form_group(attribute, error_message: error_message, **(govuk_field_options[:form_group] || {})) do |display_error_message|
+            set_field_described_by(field, attribute, error_message, govuk_field_options)
+
+            concat(govuk_label(attribute, govuk_field_options[:label][:text], form: govuk_field_options[:form], **govuk_field_options[:label]))
+            concat(govuk_hint(govuk_field_options[:hint][:text], **govuk_field_options[:hint])) if govuk_field_options[:hint]
+            concat(display_error_message)
+            yield(govuk_field_options[field], error_message)
+          end
+        end
+
+        # Generates the HTML to wrap arround a GDS input fields component.
+        # These are inputs that require being wrapped in a fieldset, for example radio buttons.
+        #
+        # @param field [Symbol] the type of the fields
+        # @param attribute [String, Symbol] the attribute of the fields
+        # @param govuk_fields_options [Hash] options that will be used for the parts of the fieldset, form group, hint and fields
+        #
+        # @option govuk_fields_options [String] :error_message (nil) the error message to be displayed
+        # @option govuk_fields_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+        # @option govuk_fields_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+        #                                                                       the field and find the error message
+        # @option govuk_fields_options [Hash] :form_group ({}) the options for govuk_form_group {govuk_form_group}
+        # @option govuk_fields_options [Hash] :fieldset ({}) the options for govuk_fieldset {govuk_fieldset}
+        # @option govuk_fields_options [Hash] :hint (nil) the parameters that will be used to create the hint for the field, see {govuk_hint}.
+        #                                                 If no hint is given then no hint will be rendered
+        # @option govuk_fields_options [Hash] :field_options ({}) the options that will be used when rendering the fields.
+        #                                                         For more details look at a module that uses +Field+.
+        #
+        # @yield the fields HTML
+        #
+        # @yieldparam govuk_fields_options [Hash] the HTML options used when rendering the fields
+        # @yieldparam error_message [String] flag to indicate if there are any erros
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML that wraps arround the fields
+
+        def govuk_fields(field, attribute, **govuk_fields_options)
+          set_hint_id(attribute, govuk_fields_options)
+          error_message = find_field_error_message(attribute, govuk_fields_options)
+
+          govuk_form_group(attribute, error_message: error_message, **(govuk_fields_options[:form_group] || {})) do |display_error_message|
+            set_field_described_by(:fieldset, attribute, error_message, govuk_fields_options)
+            (govuk_fields_options[field] ||= {})[:attributes] ||= {}
+
+            govuk_fieldset(**govuk_fields_options[:fieldset]) do
+              concat(govuk_hint(govuk_fields_options[:hint][:text], **govuk_fields_options[:hint])) if govuk_fields_options[:hint]
+              concat(display_error_message)
+              yield(govuk_fields_options[field], error_message)
+            end
+          end
+        end
+
+        private
+
+        # If present, will find the error message for the field
+        #
+        # @param attribute [String, Symbol] the attribute of the fields
+        #
+        # @option govuk_field_options [String] :error_message (nil) the error message to be displayed
+        # @option govuk_field_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+        # @option govuk_field_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+        #                                                                       the field and find the error message
+        #
+        # @return [String] the error message
+
+        def find_field_error_message(attribute, govuk_field_options)
+          if govuk_field_options[:model]
+            govuk_field_options[:model].errors[attribute].first
+          elsif govuk_field_options[:form]
+            govuk_field_options[:form].object.errors[attribute].first
+          else
+            govuk_field_options[:error_message]
+          end
+        end
+
+        # Sets the label +for+ if a custom ID has been given for the field.
+        #
+        # @param govuk_field_options [Hash] see {govuk_field} for details
+
+        def set_label_for_if_custom_id(field, govuk_field_options)
+          field_id = govuk_field_options.dig(field, :attributes, :id)
+
+          govuk_field_options[:label] ||= {}
+          (govuk_field_options[:label][:attributes] ||= {})[:for] = field_id if field_id
+        end
+
+        # Sets the hint ID if there is a hint, and the ID for the hint has not been sent
+        #
+        # @param attribute [String, Symbol] the attribute of the field
+        # @param govuk_field_options [Hash] see {govuk_field} for details
+
+        def set_hint_id(attribute, govuk_field_options)
+          return if !govuk_field_options[:hint] || govuk_field_options.dig(:hint, :attributes, :id)
+
+          govuk_field_options[:hint] ||= {}
+          (govuk_field_options[:hint][:attributes] ||= {})[:id] = "#{attribute}-hint"
+        end
+
+        # Adds the aira-describedby attribute for the field
+        # if there is a hint or an error message
+        #
+        # @param attribute [String, Symbol] the attribute of the input
+        # @param error_message [String] used to indicate if there is an error
+        # @param govuk_field_options [Hash] see {#govuk_field} for details
+
+        def set_field_described_by(field, attribute, error_message, govuk_field_options)
+          aria_described_by = []
+          aria_described_by << govuk_field_options.dig(field, :attributes, :aria, :describedby)
+          aria_described_by << govuk_field_options[:hint][:attributes][:id] if govuk_field_options[:hint]
+          aria_described_by << "#{attribute}-error" if error_message
+          aria_described_by.compact!
+
+          govuk_field_options[field] ||= {}
+          govuk_field_options[field][:attributes] ||= {}
+
+          return unless aria_described_by.any?
+
+          (govuk_field_options[field][:attributes][:aria] ||= {})[:describedby] = aria_described_by.join(' ')
+        end
+
+        # Sets the hint attributes and adds the aira-describedby attribute for a fields item
+        #
+        # @param type [String] the type of the item
+        # @param attribute [String, Symbol] the attribute of the item
+        # @param item [Hash] the options for that item
+
+        def set_item_options_for_hint(type, attribute, item)
+          return unless item[:hint]
+
+          (item[:hint] ||= {})[:attributes] ||= {}
+          item[:hint][:classes] = "govuk-#{type}__hint #{item[:hint][:classes]}".rstrip
+          item[:hint][:attributes][:id] ||= "#{attribute}_#{item[:value]}-item-hint"
+
+          (item[:attributes][:aria] ||= {})[:describedby] = item[:hint][:attributes][:id]
+        end
+
+        # Sets the conditional attributes and adds the data-aira-controls attribute for a fields item
+        #
+        # @param type [String] the type of the item
+        # @param attribute [String, Symbol] the attribute of the item
+        # @param item [Hash] the options for that item
+
+        def set_conditional_item_options(type, attribute, item)
+          return unless item[:conditional]
+
+          item[:conditional][:attributes] ||= {}
+          item[:conditional][:attributes][:class] = "govuk-#{type}__conditional #{"govuk-#{type}__conditional--hidden" unless item[:checked]}".rstrip
+          item[:conditional][:attributes][:id] ||= sanitize_to_id("#{attribute}_#{item[:value]}_conditional")
+          (item[:attributes][:data] ||= {})[:'aria-controls'] = item[:conditional][:attributes][:id]
+        end
+      end
+    end
+  end
+
+  ActionView::Base.field_error_proc = proc { |html_tag, _instance| html_tag }
+end