crown_marketplace_utils 0.1.0.beta.3 → 0.1.0.beta.5

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

@@ -2,7 +2,7 @@
 
 require_relative '../field'
 
-module CrownMarketplaceUtils
+module CrownMarketplaceUtils::Helpers
   module GovUkHelper
     module Field
       # = GOV.UK Radios
@@ -19,43 +19,35 @@ module CrownMarketplaceUtils
         #
         # @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 [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_options ({}) the options that will be used when rendering the radio buttons.
-        #                                                          See {govuk_radios_fields} for more details.
+        # @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, 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(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
 
-        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))
+            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
 
@@ -71,30 +63,28 @@ module CrownMarketplaceUtils
         #
         # @return [ActiveSupport::SafeBuffer] the HTML for the radio buttons which is used in {govuk_radios}
 
-        def govuk_radios_fields(attribute, items, **govuk_radios_options)
+        def govuk_radio_fields_tag(attribute, items, **govuk_radios_options)
           _govuk_radios_fields(items, **govuk_radios_options) do |radio_item|
-            govuk_radio_item(attribute, radio_item)
+            govuk_radio_item_tag(attribute, radio_item)
           end
         end
 
-        # Generates the radios HTML for {govuk_radios_with_form}
+        # Generates the radios HTML for {govuk_radios} when there is a ActionView::Helpers::FormBuilder
         #
-        # @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
+        # @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 [ActiveSupport::SafeBuffer] the HTML for the radio buttons which is used in {govuk_radios_with_form}
+        # @return (see govuk_radio_fields_tag)
 
-        def govuk_radios_fields_with_form(form, attribute, items, **govuk_radios_options)
+        def govuk_radio_fields_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)
+            govuk_radio_item_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
+        # 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:
@@ -105,18 +95,18 @@ module CrownMarketplaceUtils
         # @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}
+        # @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_radios_fields} or {govuk_radios_fields_with_form}
+        # @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)
-          govuk_radios_classes = ['govuk-radios']
-          govuk_radios_classes << govuk_radios_options[:classes]
-          ((govuk_radios_options[:attributes] ||= {})[:data] ||= {}).merge!({ module: 'govuk-radios' })
+          govuk_radios_options[:attributes] ||= {}
+          govuk_radios_options[:attributes][:class] = "govuk-radios #{govuk_radios_options[:classes]}".rstrip
+          (govuk_radios_options[:attributes][:data] ||= {}).merge!({ module: 'govuk-radios' })
 
-          tag.div(class: govuk_radios_classes, **govuk_radios_options[:attributes]) do
+          tag.div(**govuk_radios_options[:attributes]) do
             capture do
               items.each do |radio_item|
                 concat(
@@ -133,7 +123,7 @@ module CrownMarketplaceUtils
           end
         end
 
-        # Generates the HTML for a radio button for {govuk_radios_fields_with_form}
+        # Generates the HTML for a radio button for {govuk_radio_fields_form}
         #
         # @param (see _govuk_radio_item)
         #
@@ -141,16 +131,16 @@ module CrownMarketplaceUtils
         #
         # @return (see _govuk_radio_item)
 
-        def govuk_radio_item(attribute, 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], class: 'govuk-radios__input', **radio_item[:attributes]))
-            concat(govuk_label(label_attribute, radio_item[:label][:text], **radio_item[:label][:options]))
+            concat(govuk_label(label_attribute, radio_item[:label][:text], **radio_item[:label]))
           end
         end
 
-        # Generates the HTML for a radio button for {govuk_radios_fields}
+        # 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
@@ -159,46 +149,54 @@ module CrownMarketplaceUtils
         #
         # @return (see _govuk_radio_item)
 
-        def govuk_radio_item_with_form(form, attribute, radio_item)
+        def govuk_radio_item_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]
+            (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], class: 'govuk-radios__input', **radio_item[:attributes]))
-            concat(govuk_label_with_form(form, attribute, radio_item[:label][:text], **radio_item[:label][:options]))
+            concat(govuk_label(attribute, radio_item[:label][:text], form: form, **radio_item[:label]))
           end
         end
 
-        # Wrapper method used by {govuk_radio_item} and {govuk_radio_item_with_form} to generate the radios HTML
+        # 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:
-        #                                  - +: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] :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} and {govuk_radio_item_with_form}
+        #                                     which is used in {govuk_radio_item_tag} and {govuk_radio_item_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
+          radio_item[:label] ||= {}
+          radio_item[:label][:classes] = "govuk-radios__label #{radio_item[:label][:classes]}".rstrip
 
-          set_item_options_for_hint('radios', attribute, radio_item) if radio_item[:hint]
+          set_item_options_for_hint('radios', attribute, radio_item)
+          set_conditional_item_options('radios', attribute, radio_item)
 
           capture do
             yield
-            concat(govuk_hint(radio_item[:hint][:text], **radio_item[:hint][:options])) if radio_item[:hint]
+            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
         end
+
+        # rubocop:enable Metrics/AbcSize
       end
     end
   end

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

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+require 'action_view'
+require_relative '../field'
+
+module CrownMarketplaceUtils::Helpers
+  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 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 {set_govuk_select_field_options} 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|
+            set_govuk_select_field_options(error_message, govuk_field_options)
+            (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 (see set_govuk_select_field_options)
+        #
+        # @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 set_govuk_select_field_options)
+        #
+        # @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
+
+        # Initialises the attributes for the select input
+        #
+        # @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
+
+        def set_govuk_select_field_options(error_message, govuk_select_options)
+          govuk_select_options[:attributes] ||= {}
+          govuk_select_options[:attributes][:class] = "govuk-select #{govuk_select_options[:classes]}".rstrip
+          govuk_select_options[:attributes][:class] << ' govuk-select--error' if error_message
+        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

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative '../field'
+
+module CrownMarketplaceUtils::Helpers
+  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 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)
+          govuk_text_textarea_options[:attributes] ||= {}
+          govuk_text_textarea_options[:attributes][:class] = "govuk-textarea #{govuk_text_textarea_options[:classes]}".rstrip
+          govuk_text_textarea_options[:attributes][:class] << ' govuk-textarea--error' if error_message
+          govuk_text_textarea_options[:attributes][:rows] ||= govuk_text_textarea_options[:rows] || 5
+        end
+      end
+    end
+  end
+end