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

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

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    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 {CrownMarketplaceUtils::GovUkHelper::Field}
+
+      module Textarea
+        include Field
+
+        # Generates the HTML for the GOV.UK textarea component
+        #
+        # @param attribute [String, Symbol] the attribute of the textarea
+        # @param error_message [String] the error message to be displayed
+        # @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 [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 {govuk_textarea_field} 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, error_message = nil, **govuk_textarea_options)
+          govuk_field(:textarea, attribute, error_message, **govuk_textarea_options) do |govuk_field_options|
+            concat(govuk_textarea_field(attribute, error_message, **govuk_field_options))
+          end
+        end
+
+        # Generates the HTML for the GOV.UK textarea component using an ActiveModel.
+        # Unlike {#govuk_textarea}, 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 content of the textarea
+        # @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 (see govuk_textarea)
+        #
+        # @return (see govuk_textarea)
+
+        def govuk_textarea_with_model(model, attribute, **govuk_textarea_options)
+          (govuk_textarea_options[:textarea] ||= {})[:content] = model.send(attribute)
+
+          govuk_field_with_model(:textarea, model, attribute, **govuk_textarea_options) do |govuk_field_options, error_message|
+            concat(govuk_textarea_field(attribute, error_message, **govuk_field_options))
+          end
+        end
+
+        # 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] the form builder used to create the textarea
+        # @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 (see govuk_textarea)
+        #
+        # @return (see govuk_textarea)
+
+        def govuk_textarea_with_form(form, attribute, **govuk_textarea_options)
+          govuk_field_with_form(:textarea, form, attribute, **govuk_textarea_options) do |govuk_field_options, error_message|
+            concat(govuk_textarea_field_with_form(form, attribute, error_message, **govuk_field_options))
+          end
+        end
+
+        private
+
+        # Generates the textarea HTML for {govuk_textarea}
+        #
+        # @param attribute [String, Symbol] the attribute of the textarea
+        # @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 (see set_govuk_textarea_field_options)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the textarea field which is used in {govuk_textarea}
+
+        def govuk_textarea_field(attribute, error_message, **govuk_text_textarea_options)
+          set_govuk_textarea_field_options(error_message, govuk_text_textarea_options)
+
+          text_area_tag(
+            attribute,
+            govuk_text_textarea_options[:content],
+            class: govuk_text_textarea_options[:classes],
+            rows: govuk_text_textarea_options[:rows],
+            **govuk_text_textarea_options[:attributes]
+          )
+        end
+
+        # Generates the textarea HTML for {govuk_textarea_with_form}
+        #
+        # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the textarea
+        # @param attribute [String, Symbol] the attribute of the textarea
+        # @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 (see set_govuk_textarea_field_options)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the textarea field which is used in {govuk_textarea_with_form}
+
+        def govuk_textarea_field_with_form(form, attribute, error_message, **govuk_text_textarea_options)
+          set_govuk_textarea_field_options(error_message, govuk_text_textarea_options)
+
+          form.text_area(
+            attribute,
+            class: govuk_text_textarea_options[:classes],
+            rows: govuk_text_textarea_options[:rows],
+            **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)
+          govuk_text_textarea_options[:classes] = "govuk-textarea #{govuk_text_textarea_options[:classes]}".rstrip
+          govuk_text_textarea_options[:classes] << ' govuk-textarea--error' if error_message
+          govuk_text_textarea_options[:attributes] ||= {}
+          govuk_text_textarea_options[:rows] ||= 5
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/field.rb

@@ -0,0 +1,305 @@
+# frozen_string_literal: true
+
+require_relative 'fieldset'
+require_relative 'form_group'
+require_relative 'hint'
+require_relative 'label'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # rubocop:disable Metrics/ModuleLength
+
+    # = 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 error_message [String] the error message to be displayed
+      # @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 [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
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML that wraps arround the field
+
+      def govuk_field(field, attribute, error_message = nil, **govuk_field_options)
+        set_label_for_if_custom_id(field, govuk_field_options)
+        set_hint_id(attribute, govuk_field_options)
+
+        govuk_form_group(attribute, error_message, **(govuk_field_options[:form_group] || {})) do |display_error_message|
+          set_field_described_by(field, attribute, error_message, govuk_field_options)
+
+          capture do
+            concat(govuk_label(attribute, govuk_field_options[:label][:text], **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])
+          end
+        end
+      end
+
+      # Generates the HTML to wrap arround a GDS input field component using an ActiveModel.
+      # Unlike {govuk_field}, the method will be able to automatically determine if the error message needs to be shown.
+      #
+      # @param field [Symbol] the type of the field
+      # @param model [ActiveModel] model that will be used to find an error message
+      # @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 (see govuk_field)
+      #
+      # @yield (see govuk_field)
+      #
+      # @yieldparam (see govuk_field)
+      # @yieldparam error_message [ActiveSupport::SafeBuffer] used by the field to indicate if there is an error
+      #
+      # @return (see govuk_field)
+
+      def govuk_field_with_model(field, model, attribute, **govuk_field_options)
+        set_label_for_if_custom_id(field, govuk_field_options)
+        set_hint_id(attribute, govuk_field_options)
+
+        govuk_form_group_with_model(model, attribute, **(govuk_field_options[:form_group] || {})) do |display_error_message|
+          set_field_described_by(field, attribute, display_error_message, govuk_field_options)
+
+          capture do
+            concat(govuk_label(attribute, govuk_field_options[:label][:text], **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], display_error_message)
+          end
+        end
+      end
+
+      # Generates the HTML to wrap arround a GDS input field component using an ActionView::Helpers::FormBuilder.
+      # Unlike {govuk_field}, the method will be able to automatically determine if the error message needs to be shown.
+      #
+      # @param field [Symbol] the type of the field
+      # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the label
+      # @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 (see govuk_field)
+      #
+      # @yield (see govuk_field)
+      #
+      # @yieldparam (see govuk_field)
+      # @yieldparam error_message [ActiveSupport::SafeBuffer] used by the field to indicate if there is an error
+      #
+      # @return (see govuk_field)
+
+      def govuk_field_with_form(field, form, attribute, **govuk_field_options)
+        set_label_for_if_custom_id(field, govuk_field_options)
+        set_hint_id(attribute, govuk_field_options)
+
+        govuk_form_group_with_model(form.object, attribute, **(govuk_field_options[:form_group] || {})) do |display_error_message|
+          set_field_described_by(field, attribute, display_error_message, govuk_field_options)
+
+          capture do
+            concat(govuk_label_with_form(form, attribute, govuk_field_options[:label][:text], **(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], display_error_message)
+          end
+        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 error_message [String] the error message to be displayed
+      # @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 [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
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML that wraps arround the fields
+
+      def govuk_fields(field, attribute, error_message = nil, **govuk_fields_options)
+        set_hint_id(attribute, govuk_fields_options)
+
+        govuk_form_group(attribute, 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(capture 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])
+            end)
+          end
+        end
+      end
+
+      # Generates the HTML to wrap arround a GDS input fields component using an ActiveModel.
+      # These are inputs that require being wrapped in a fieldset, for example radio buttons.
+      #
+      # @param field [Symbol] the type of the fields
+      # @param model [ActiveModel] model that will be used to find an error message
+      # @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 (see govuk_fields)
+      #
+      # @yield (see govuk_fields)
+      #
+      # @yieldparam (see govuk_fields)
+      # @yieldparam any_errors flag to indicate if there are errors present
+      #
+      # @return (see govuk_fields)
+
+      def govuk_fields_with_model(field, model, attribute, **govuk_fields_options)
+        set_hint_id(attribute, govuk_fields_options)
+
+        govuk_form_group_with_model(model, attribute, **(govuk_fields_options[:form_group] || {})) do |display_error_message|
+          set_field_described_by(:fieldset, attribute, display_error_message, govuk_fields_options)
+          (govuk_fields_options[field] ||= {})[:attributes] ||= {}
+
+          govuk_fieldset(**govuk_fields_options[:fieldset]) do
+            concat(capture 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], display_error_message)
+            end)
+          end
+        end
+      end
+
+      # Generates the HTML to wrap arround a GDS input fields component using an ActionView::Helpers::FormBuilder.
+      # These are inputs that require being wrapped in a fieldset, for example radio buttons.
+      #
+      # Unlike {govuk_fields}, the method will be able to automatically determine if the error message needs to be shown.
+      #
+      # @param field [Symbol] the type of the fields
+      # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the label
+      # @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 (see govuk_fields)
+      #
+      # @yield (see govuk_fields)
+      #
+      # @yieldparam (see govuk_fields_with_model)
+      #
+      # @return (see govuk_fields)
+
+      def govuk_fields_with_form(field, form, attribute, **govuk_fields_options)
+        set_hint_id(attribute, govuk_fields_options)
+
+        govuk_form_group_with_model(form.object, attribute, **(govuk_fields_options[:form_group] || {})) do |display_error_message|
+          set_field_described_by(:fieldset, attribute, display_error_message, govuk_fields_options)
+          (govuk_fields_options[field] ||= {})[:attributes] ||= {}
+
+          govuk_fieldset(**govuk_fields_options[:fieldset]) do
+            concat(capture 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], display_error_message)
+            end)
+          end
+        end
+      end
+
+      private
+
+      # 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] ||= {}).merge!({ 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] ||= {}).merge!({ 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] ||= {}).merge!({ describedby: aria_described_by.join(' ') })
+      end
+
+      # Sets the hint classes 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)
+        (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
+    end
+    # rubocop:enable Metrics/ModuleLength
+  end
+end
+
+ActionView::Base.field_error_proc = proc { |html_tag, _instance| html_tag }

data/lib/crown_marketplace_utils/gov_uk_helper/fieldset.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    # = GOV.UK Fieldset
+    #
+    # This helper is used for generating the fieldset component from the
+    # {https://design-system.service.gov.uk/components/fieldset GDS - Components - Fieldset}
+
+    module Fieldset
+      include ActionView::Context
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::TextHelper
+
+      # Generates the HTML for the GOV.UK Fieldset component
+      #
+      # @param govuk_fieldset_options [Hash] options that will be used in customising the HTML
+      #
+      # @option govuk_fieldset_options [String] :classes additional CSS classes for the fieldset HTML
+      # @option govuk_fieldset_options [Hash] :legend options for the legend which are used in {#govuk_legend}
+      # @option govuk_fieldset_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+      #
+      # @yield HTML that will be contained within the 'govuk-fieldset' div and under the legend
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Fieldset
+      #                                     which can then be rendered on the page
+
+      def govuk_fieldset(**govuk_fieldset_options)
+        govuk_fieldset_classes = ['govuk-fieldset']
+        govuk_fieldset_classes << govuk_fieldset_options[:classes]
+        govuk_fieldset_options[:attributes] ||= {}
+
+        tag.fieldset(class: govuk_fieldset_classes, **govuk_fieldset_options[:attributes]) do
+          capture do
+            concat(govuk_legend(govuk_fieldset_options[:legend])) if govuk_fieldset_options[:legend]
+            yield
+          end
+        end
+      end
+
+      private
+
+      # Generates the HTML for the Legend as part of {#govuk_fieldset}
+      #
+      # @param govuk_legend_options [Hash] options that will be used in the legend
+      #
+      # @option govuk_legend_options [String] :classes additional CSS classes for the legend HTML
+      # @option govuk_legend_options [String] :text the text for the legend
+      # @option govuk_legend_options [boolean] :is_page_heading (false) if the legend is also the heading it will rendered in a h1
+      # @option govuk_legend_options [Hash] :caption an optional hash with the +text+ and +classes+ that will be used
+      #                                              to render a caption before the h1 if the legend is a page heading
+      #
+      # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Fieldset
+      #                                     which can then be rendered on the page
+
+      def govuk_legend(govuk_legend_options)
+        govuk_legend_classes = ['govuk-fieldset__legend']
+        govuk_legend_classes << govuk_legend_options[:classes]
+
+        tag.legend(class: govuk_legend_classes) do
+          if govuk_legend_options[:is_page_heading]
+            capture do
+              concat(tag.span(govuk_legend_options[:caption][:text], class: govuk_legend_options[:caption][:classes])) if govuk_legend_options[:caption]
+              concat(tag.h1(govuk_legend_options[:text], class: 'govuk-fieldset__heading'))
+            end
+          else
+            govuk_legend_options[:text]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/crown_marketplace_utils/gov_uk_helper/form_group.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'action_view'
 require_relative 'error_message'
 
 module CrownMarketplaceUtils
@@ -10,8 +9,6 @@ module CrownMarketplaceUtils
     # This helper is used for generating the form group component from the Government Design Systems
 
     module FormGroup
-      include ActionView::Context
-      include ActionView::Helpers::TagHelper
       include ErrorMessage
 
       # Generates the HTML for the GOV.UK Form Group component