crown_marketplace_utils 0.1.0.beta.1 → 0.1.0.beta.3

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

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

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

@@ -0,0 +1,209 @@
+# 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_options see {govuk_fields}
+        # @option govuk_checkboxes_options [Hash] :fieldset_options see {govuk_fields}
+        # @option govuk_checkboxes_options [Hash] :hint see {govuk_field}
+        # @option govuk_checkboxes_options [Hash] :checkboxes_options ({}) 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 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 govuk_checkboxes_options [Hash] :form_group_options see {govuk_fields_with_form}
+        # @option govuk_checkboxes_options [Hash] :fieldset_options see {govuk_fields_with_form}
+        # @option govuk_checkboxes_options [Hash] :hint see {govuk_fields_with_form}
+        # @option govuk_checkboxes_options [Hash] :checkboxes_options ({}) the options that will be used when rendering the checkbox buttons.
+        #                                                                  See {govuk_checkboxes_fields_with_form} for more details.
+        #
+        # @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] :form 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][:options]))
+          end
+        end
+
+        # rubocop:disable Metrics/AbcSize
+
+        # 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][:options][:attributes] ||= {})[:value] = checkbox_item[:value]
+            checkbox_item[:label][:options][: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][:options]))
+          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:
+        #                                     - +:text+ (required) - the label text
+        #                                     - +:options+ - default: { } - the options for govuk_label {govuk_label}
+        # @option checkbox_item [Hash] :hint (nil) the parameters that will be used to create the hint for the field
+        #                                          - +:text+ (required) - the hint text
+        #                                          - +:options+ - default: { } - the options for govuk_hint {govuk_hint}
+        # @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}
+
+        # rubocop:enable Metrics/AbcSize
+
+        def _govuk_checkbox_item(attribute, checkbox_item)
+          checkbox_item[:attributes] ||= {}
+          checkbox_item[:label][:options] ||= {}
+          checkbox_item[:label][:options][:classes] = "govuk-checkboxes__label #{checkbox_item[:label][:options][: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][:options])) if checkbox_item[:hint]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    module Field
+      # = GOV.UK Input
+      #
+      # This helper is used for generating the input component from the
+      # {https://design-system.service.gov.uk/components/text-input GDS - Components - Text Input}
+      #
+      # This is considered a Field module and so makes use of the methods in {CrownMarketplaceUtils::GovUkHelper::Field}
+
+      module Input
+        include Field
+
+        # Generates the HTML for the GOV.UK input component
+        #
+        # @param attribute [String, Symbol] the attribute of the input
+        # @param error_message [String] the error message to be displayed
+        # @param govuk_input_options [Hash] options that will be used for the parts of the form group, label, hint and input
+        #
+        # @option govuk_input_options [Hash] :form_group_options see {govuk_field}
+        # @option govuk_input_options [Hash] :label see {govuk_field}
+        # @option govuk_input_options [Hash] :hint see {govuk_field}
+        # @option govuk_input_options [Hash] :input_options ({}) the options that will be used when rendering the input.
+        #                                                              See {govuk_input_field} for more details.
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Input
+        #                                     which can then be rendered on the page
+
+        def govuk_input(attribute, error_message = nil, **govuk_input_options)
+          govuk_field(:input, attribute, error_message, **govuk_input_options) do |govuk_field_options|
+            concat(govuk_input_field(attribute, error_message, **govuk_field_options))
+          end
+        end
+
+        # Generates the HTML for the GOV.UK input component using an ActionView::Helpers::FormBuilder.
+        # Unlike {govuk_input}, the method will be able to automatically determine if the error message needs to be shown.
+        #
+        # @param form [ActionView::Helpers::FormBuilder] :form the form builder used to create the input
+        # @param attribute [String, Symbol] the attribute of the input
+        # @param govuk_input_options [Hash] options that will be used for the parts of the form group, label, hint and input
+        #
+        # @option govuk_input_options [Hash] :form_group_options see {govuk_field_with_form}
+        # @option govuk_input_options [Hash] :label see {govuk_field_with_form}
+        # @option govuk_input_options [Hash] :hint see {govuk_field_with_form}
+        # @option govuk_input_options [Hash] :input_options ({}) the options that will be used when rendering the input.
+        #                                                        See {govuk_input_field_with_form} for more details.
+        #
+        # @return (see govuk_input)
+
+        def govuk_input_with_form(form, attribute, **govuk_input_options)
+          govuk_field_with_form(:input, form, attribute, **govuk_input_options) do |govuk_field_options, error_message|
+            concat(govuk_input_field_with_form(form, attribute, error_message, **govuk_field_options))
+          end
+        end
+
+        private
+
+        # Generates the input HTML for {govuk_input}
+        #
+        # @param attribute [String, Symbol] the attribute of the input
+        # @param error_message [String] used to indicate if there is an error which will add extra classes
+        # @param govuk_text_input_options [Hash] options that will be used in customising the HTML
+        #
+        # @option (see _govuk_input_field)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the input field which is used in {govuk_input}
+
+        def govuk_input_field(attribute, error_message, **govuk_text_input_options)
+          _govuk_input_field(error_message, **govuk_text_input_options) do |govuk_text_input_classes, govuk_text_input_attributes|
+            text_field_tag(attribute, govuk_text_input_options[:value], class: govuk_text_input_classes, **govuk_text_input_attributes)
+          end
+        end
+
+        # Generates the input HTML for {govuk_input_with_form}
+        #
+        # @param form [ActionView::Helpers::FormBuilder] :form the form builder used to create the input
+        # @param attribute [String, Symbol] the attribute of the input
+        # @param error_message [String] used to indicate if there is an error which will add extra classes
+        # @param govuk_text_input_options [Hash] options that will be used in customising the HTML
+        #
+        # @option (see _govuk_input_field)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the input field which is used in {govuk_input_with_form}
+
+        def govuk_input_field_with_form(form, attribute, error_message, **govuk_text_input_options)
+          _govuk_input_field(error_message, **govuk_text_input_options) do |govuk_text_input_classes, govuk_text_input_attributes|
+            form.text_field(attribute, class: govuk_text_input_classes, **govuk_text_input_attributes)
+          end
+        end
+
+        # Wrapper method used by {govuk_input_field} and {govuk_input_field_with_form} to generate the Input HTML
+        #
+        # @param error_message [String] used to indicate if there is an error which will add extra classes
+        # @param govuk_text_input_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_text_input_options [String] :classes additional CSS classes for the input HTML
+        # @option govuk_text_input_options [String] :value (nil) the value of the input
+        # @option govuk_text_input_options [Hash] :prefix (nil) optional prefix for the input field. See {govuk_fix} for more details.
+        # @option govuk_text_input_options [Hash] :suffix (nil) optional suffix for the input field. See {govuk_fix} for more details.
+        # @option govuk_text_input_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        #
+        # @yield the input HTML generated by {govuk_input_field} or {govuk_input_field_with_form}
+        #
+        # @yieldparam govuk_text_input_classes [Array] the classes for the input HTML
+        # @yieldparam govuk_text_input_attributes [Hash] additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the input field which is used in {govuk_input_field} or {govuk_input_field_with_form}
+
+        def _govuk_input_field(error_message, **govuk_text_input_options)
+          govuk_text_input_classes = ['govuk-input']
+          govuk_text_input_classes += ['govuk-input--error'] if error_message
+          govuk_text_input_classes << govuk_text_input_options[:classes]
+          govuk_text_input_options[:attributes] ||= {}
+
+          input_html = yield(govuk_text_input_classes, govuk_text_input_options[:attributes])
+
+          prefix = govuk_text_input_options[:prefix]
+          suffix = govuk_text_input_options[:suffix]
+
+          if prefix || suffix
+            tag.div(class: 'govuk-input__wrapper') do
+              capture do
+                concat(govuk_fix('pre', prefix)) if prefix
+                concat(input_html)
+                concat(govuk_fix('suf', suffix)) if suffix
+              end
+            end
+          else
+            input_html
+          end
+        end
+
+        # Generates the prefix and suffix HTML for {_govuk_input_field}
+        #
+        # @param fix [String] either +"pre"+ or +"suf"+
+        # @param govuk_fix_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_fix_options [String] :classes additional CSS classes for the input HTML
+        # @option govuk_text_input_options [Hash] :attributes ({ aria: { hidden: true } }) any additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the input field which is used in {govuk_input_field} or {govuk_input_field_with_form}
+
+        def govuk_fix(fix, govuk_fix_options)
+          govuk_fix_classes = ["govuk-input__#{fix}fix"]
+          govuk_fix_classes << govuk_fix_options[:classes]
+          govuk_fix_options[:attributes] ||= {}
+          (govuk_fix_options[:attributes][:aria] ||= {}).merge!({ hidden: true })
+
+          tag.div(govuk_fix_options[:text], class: govuk_fix_classes, **govuk_fix_options[:attributes])
+        end
+      end
+    end
+  end
+end
+
+ActionView::Base.field_error_proc = proc { |html_tag, _instance| html_tag }