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

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

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    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 {CrownMarketplaceUtils::GovUkHelper::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 error_message [String] the error message to be displayed
+        # @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 [Hash] :form_group_options see {govuk_fields}
+        # @option govuk_radios_options [Hash] :fieldset_options see {govuk_fields}
+        # @option govuk_radios_options [Hash] :hint see {govuk_field}
+        # @option govuk_radios_options [Hash] :radios_options ({}) the options that will be used when rendering the radio buttons.
+        #                                                          See {govuk_radios_fields} 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, error_message = nil, **govuk_radios_options)
+          govuk_fields(:radios, attribute, error_message, **govuk_radios_options) do |govuk_field_options|
+            concat(govuk_radios_fields(attribute, items, **govuk_field_options))
+          end
+        end
+
+        # Generates the HTML for the GOV.UK Radios component using an ActionView::Helpers::FormBuilder.
+        # Unlike {govuk_radios}, 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 radio buttons
+        # @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 [Hash] :form_group_options see {govuk_fields_with_form}
+        # @option govuk_radios_options [Hash] :fieldset_options see {govuk_fields_with_form}
+        # @option govuk_radios_options [Hash] :hint see {govuk_fields_with_form}
+        # @option govuk_radios_options [Hash] :radios_options ({}) the options that will be used when rendering the radio buttons.
+        #                                                          See {govuk_radios_fields_with_form} for more details.
+        #
+        # @return (see govuk_radios)
+
+        def govuk_radios_with_form(form, attribute, items, **govuk_radios_options)
+          govuk_fields_with_form(:radios, form, attribute, **govuk_radios_options) do |govuk_field_options|
+            concat(govuk_radios_fields_with_form(form, attribute, items, **govuk_field_options))
+          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_radios_fields(attribute, items, **govuk_radios_options)
+          _govuk_radios_fields(items, **govuk_radios_options) do |radio_item|
+            govuk_radio_item(attribute, radio_item)
+          end
+        end
+
+        # Generates the radios HTML for {govuk_radios_with_form}
+        #
+        # @param form [ActionView::Helpers::FormBuilder] :form the form builder used to create the radio buttons
+        # @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_with_form}
+
+        def govuk_radios_fields_with_form(form, attribute, items, **govuk_radios_options)
+          _govuk_radios_fields(items, **govuk_radios_options) do |radio_item|
+            govuk_radio_item_with_form(form, attribute, radio_item)
+          end
+        end
+
+        # Wrapper method used by {govuk_radios_fields} and {govuk_radios_fields_with_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_radios_fields} or {govuk_radios_fields_with_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_radios_fields} or {govuk_radios_fields_with_form}
+
+        def _govuk_radios_fields(items, **govuk_radios_options)
+          govuk_radios_classes = ['govuk-radios']
+          govuk_radios_classes << govuk_radios_options[:classes]
+          ((govuk_radios_options[:attributes] ||= {})[:data] ||= {}).merge!({ module: 'govuk-radios' })
+
+          tag.div(class: govuk_radios_classes, **govuk_radios_options[:attributes]) do
+            capture 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
+        end
+
+        # Generates the HTML for a radio button for {govuk_radios_fields_with_form}
+        #
+        # @param (see _govuk_radio_item)
+        #
+        # @option (see _govuk_radio_item)
+        #
+        # @return (see _govuk_radio_item)
+
+        def govuk_radio_item(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], class: 'govuk-radios__input', **radio_item[:attributes]))
+            concat(govuk_label(label_attribute, radio_item[:label][:text], **radio_item[:label][:options]))
+          end
+        end
+
+        # Generates the HTML for a radio button for {govuk_radios_fields}
+        #
+        # @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_with_form(form, attribute, radio_item)
+          _govuk_radio_item(attribute, radio_item) do
+            (radio_item[:label][:options][:attributes] ||= {})[:value] = radio_item[:value]
+            radio_item[:label][:options][:attributes][:for] = radio_item[:attributes][:id] if radio_item[:attributes][:id]
+
+            concat(form.radio_button(attribute, radio_item[:value], class: 'govuk-radios__input', **radio_item[:attributes]))
+            concat(govuk_label_with_form(form, attribute, radio_item[:label][:text], **radio_item[:label][:options]))
+          end
+        end
+
+        # Wrapper method used by {govuk_radio_item} and {govuk_radio_item_with_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:
+        #                                  - +:text+ (required) - the label text
+        #                                  - +:options+ - default: { } - the options for govuk_label {govuk_label}
+        # @option radio_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 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} and {govuk_radio_item_with_form}
+
+        def _govuk_radio_item(attribute, radio_item)
+          radio_item[:attributes] ||= {}
+          radio_item[:label][:options] ||= {}
+          radio_item[:label][:options][:classes] = "govuk-radios__label #{radio_item[:label][:options][:classes]}".rstrip
+
+          set_item_options_for_hint('radios', attribute, radio_item) if radio_item[:hint]
+
+          capture do
+            yield
+            concat(govuk_hint(radio_item[:hint][:text], **radio_item[:hint][:options])) if radio_item[:hint]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require_relative '../field'
+
+module CrownMarketplaceUtils
+  module GovUkHelper
+    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 {CrownMarketplaceUtils::GovUkHelper::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 error_message [String] the error message to be displayed
+        # @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 [Hash] :form_group_options 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_options ({}) the options that will be used when rendering the select field.
+        #                                                          See {govuk_select_field} 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, error_message = nil, **govuk_select_options)
+          govuk_field(:select, attribute, error_message, **govuk_select_options) do |govuk_field_options|
+            concat(govuk_select_field(attribute, items, error_message, **govuk_field_options))
+          end
+        end
+
+        # Generates the HTML for the GOV.UK Select component using an ActionView::Helpers::FormBuilder.
+        # Unlike {govuk_select}, 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 select field
+        # @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 [Hash] :form_group_options see {govuk_field_with_form}
+        # @option govuk_select_options [Hash] :label see {govuk_field_with_form}
+        # @option govuk_select_options [Hash] :hint see {govuk_field_with_form}
+        # @option govuk_select_options [Hash] :select_options ({}) the options that will be used when rendering the select field.
+        #                                                          See {govuk_select_field_with_form} for more details.
+        #
+        # @return (see govuk_select)
+
+        def govuk_select_with_form(form, attribute, items, **govuk_select_options)
+          govuk_field_with_form(:select, form, attribute, **govuk_select_options) do |govuk_field_options, error_message|
+            concat(govuk_select_field_with_form(form, attribute, items, error_message, **govuk_field_options))
+          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 error_message [String] used to indicate if there is an error which will add extra classes
+        # @param govuk_select_options [Hash] options that will be used in customising the HTML
+        #
+        # @option (see _govuk_select_field)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the select field which is used in {govuk_select}
+
+        def govuk_select_field(attribute, items, error_message, **govuk_select_options)
+          _govuk_select_field(error_message, **govuk_select_options) do |govuk_select_classes, govuk_select_attributes|
+            select_tag(
+              attribute,
+              options_for_select(
+                govuk_map_select_items(items),
+                govuk_select_options[:selected]
+              ),
+              class: govuk_select_classes,
+              **govuk_select_attributes
+            )
+          end
+        end
+
+        # Generates the select HTML for {govuk_select_with_form}
+        #
+        # @param form [ActionView::Helpers::FormBuilder] :form the form builder used to create the select field
+        # @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 error_message [String] used to indicate if there is an error which will add extra classes
+        # @param govuk_select_options [Hash] options that will be used in customising the HTML
+        #
+        # @option (see _govuk_select_field)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the select field which is used in {govuk_select_with_form}
+
+        def govuk_select_field_with_form(form, attribute, items, error_message, **govuk_select_options)
+          _govuk_select_field(error_message, **govuk_select_options) do |govuk_select_classes, govuk_select_attributes|
+            form.select(
+              attribute,
+              govuk_map_select_items(items),
+              govuk_select_options[:select_options] || {},
+              class: govuk_select_classes,
+              **govuk_select_attributes
+            )
+          end
+        end
+
+        # Wrapper method used by {govuk_select_field} and {govuk_select_field_with_form} to generate the select HTML
+        #
+        # @param error_message [String] used to indicate if there is an error which will add extra classes
+        # @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
+        #
+        # @yield the select HTML generated by {govuk_select_field} or {govuk_select_field_with_form}
+        #
+        # @yieldparam govuk_select_classes [Array] the classes for the select HTML
+        # @yieldparam govuk_select_attributes [Hash] 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_field} or {govuk_select_field_with_form}
+
+        def _govuk_select_field(error_message, **govuk_select_options)
+          govuk_select_classes = ['govuk-select']
+          govuk_select_classes += ['govuk-select--error'] if error_message
+          govuk_select_classes << govuk_select_options[:classes]
+          govuk_select_options[:attributes] ||= {}
+
+          yield(govuk_select_classes, govuk_select_options[:attributes])
+        end
+
+        # Maps the items into an array that can be used to generate the options for
+        # {govuk_select_field} and {govuk_select_field_with_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_field} and {govuk_select_field_with_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
+
+ActionView::Base.field_error_proc = proc { |html_tag, _instance| html_tag }

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

@@ -0,0 +1,127 @@
+# 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_options 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_options ({}) 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 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 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 govuk_textarea_options [Hash] :form_group_options see {govuk_field_with_form}
+        # @option govuk_textarea_options [Hash] :label see {govuk_field_with_form}
+        # @option govuk_textarea_options [Hash] :hint see {govuk_field_with_form}
+        # @option govuk_textarea_options [Hash] :textarea_options ({}) the options that will be used when rendering the textarea.
+        #                                                              See {govuk_textarea_field_with_form} for more details.
+        #
+        # @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 _govuk_textarea_field)
+        #
+        # @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)
+          _govuk_textarea_field(error_message, **govuk_text_textarea_options) do |govuk_text_textarea_classes, govuk_text_textarea_rows, govuk_text_textarea_attributes|
+            text_area_tag(attribute, govuk_text_textarea_options[:content], class: govuk_text_textarea_classes, rows: govuk_text_textarea_rows, **govuk_text_textarea_attributes)
+          end
+        end
+
+        # Generates the textarea HTML for {govuk_textarea_with_form}
+        #
+        # @param form [ActionView::Helpers::FormBuilder] :form 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 _govuk_textarea_field)
+        #
+        # @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)
+          _govuk_textarea_field(error_message, **govuk_text_textarea_options) do |govuk_text_textarea_classes, govuk_text_textarea_rows, govuk_text_textarea_attributes|
+            form.text_area(attribute, class: govuk_text_textarea_classes, rows: govuk_text_textarea_rows, **govuk_text_textarea_attributes)
+          end
+        end
+
+        # Wrapper method used by {govuk_textarea_field} and {govuk_textarea_field_with_form} to generate the textarea HTML
+        #
+        # @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
+        #
+        # @yield the textarea HTML generated by {govuk_textarea_field} or {govuk_textarea_field_with_form}
+        #
+        # @yieldparam govuk_text_textarea_classes [Array] the classes for the label HTML
+        # @yieldparam govuk_text_textarea_rows [Integer, String] (5) the number of rows for the text area
+        # @yieldparam govuk_text_textarea_attributes [Hash] additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the textarea field which is used in {govuk_textarea_field} or {govuk_textarea_field_with_form}
+
+        def _govuk_textarea_field(error_message, **govuk_text_textarea_options)
+          govuk_text_textarea_classes = ['govuk-textarea']
+          govuk_text_textarea_classes += ['govuk-textarea--error'] if error_message
+          govuk_text_textarea_classes << govuk_text_textarea_options[:classes]
+          govuk_text_textarea_options[:attributes] ||= {}
+          govuk_text_textarea_options[:rows] ||= 5
+
+          yield(govuk_text_textarea_classes, govuk_text_textarea_options[:rows], govuk_text_textarea_options[:attributes])
+        end
+      end
+    end
+  end
+end
+
+ActionView::Base.field_error_proc = proc { |html_tag, _instance| html_tag }