crown_marketplace_utils 0.1.0.beta.6 → 0.1.0.beta.8

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

@@ -3,149 +3,151 @@
 require_relative '../field'
 require_relative 'input'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    module Field
-      # = GOV.UK Date Input
-      #
-      # This helper is used for generating the date input component from the
-      # {https://design-system.service.gov.uk/components/date-input GDS - Components -  Date Input}
-      #
-      # This is considered a Field module and so makes use of the methods in {CrownMarketplaceUtils::GovUkHelper::Field}
-
-      module DateInput
-        include Field
-        include Input
-
-        # Generates the HTML for the GOV.UK date input component
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      module Field
+        # = GOV.UK Date Input
         #
-        # @param attribute [String, Symbol] the attribute of the date input
-        # @param govuk_date_input_options [Hash] options that will be used for the parts of the fieldset, form group, hint and date input
+        # This helper is used for generating the date input component from the
+        # {https://design-system.service.gov.uk/components/date-input GDS - Components -  Date Input}
         #
-        # @option govuk_date_input_options [String] :error_message (nil) the error message to be displayed
-        # @option govuk_date_input_options [ActiveModel] :model (nil) optional model that can be used to find an error message
-        # @option govuk_date_input_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
-        #                                                                           the date tag and find the error message
-        # @option govuk_date_input_options [Hash] :form_group see {govuk_fields}
-        # @option govuk_date_input_options [Hash] :fieldset see {govuk_fields}
-        # @option govuk_date_input_options [Hash] :hint see {govuk_field}
-        # @option govuk_date_input_options [Hash] :date_input_options ({}) the options that will be used when rendering the date input.
-        #                                                                  See {_govuk_date_input_fields} for more details.
-        #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Date Input
-        #                                     which can then be rendered on the page
-
-        def govuk_date_input(attribute, **govuk_date_input_options)
-          set_govuk_date_input_fieldset_options(**govuk_date_input_options)
-
-          govuk_fields(:date_input, attribute, **govuk_date_input_options) do |govuk_field_options, error_message|
-            concat(_govuk_date_input_fields(attribute, error_message, **govuk_field_options) do |date_item_attribute, date_item_input_options|
-              govuk_input(
-                date_item_attribute,
-                model: govuk_date_input_options[:model],
-                form: govuk_date_input_options[:form],
-                **date_item_input_options
-              )
-            end)
+        # This is considered a Field module and so makes use of the methods in {CrownMarketplaceUtils::GovUkHelper::Field}
+
+        module DateInput
+          include Field
+          include Input
+
+          # Generates the HTML for the GOV.UK date input component
+          #
+          # @param attribute [String, Symbol] the attribute of the date input
+          # @param govuk_date_input_options [Hash] options that will be used for the parts of the fieldset, form group, hint and date input
+          #
+          # @option govuk_date_input_options [String] :error_message (nil) the error message to be displayed
+          # @option govuk_date_input_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+          # @option govuk_date_input_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+          #                                                                           the date tag and find the error message
+          # @option govuk_date_input_options [Hash] :form_group see {govuk_fields}
+          # @option govuk_date_input_options [Hash] :fieldset see {govuk_fields}
+          # @option govuk_date_input_options [Hash] :hint see {govuk_field}
+          # @option govuk_date_input_options [Hash] :date_input_options ({}) the options that will be used when rendering the date input.
+          #                                                                  See {_govuk_date_input_fields} for more details.
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Date Input
+          #                                     which can then be rendered on the page
+
+          def govuk_date_input(attribute, **govuk_date_input_options)
+            set_govuk_date_input_fieldset_options(**govuk_date_input_options)
+
+            govuk_fields(:date_input, attribute, **govuk_date_input_options) do |govuk_field_options, error_message|
+              concat(_govuk_date_input_fields(attribute, error_message, **govuk_field_options) do |date_item_attribute, date_item_input_options|
+                govuk_input(
+                  date_item_attribute,
+                  model: govuk_date_input_options[:model],
+                  form: govuk_date_input_options[:form],
+                  **date_item_input_options
+                )
+              end)
+            end
           end
-        end
 
-        private
+          private
 
-        # Sets the role for the fieldset to group
-        #
-        # @param govuk_date_input_options [Hash] options that will be used for the parts of the fieldset, form group, hint and date input
+          # Sets the role for the fieldset to group
+          #
+          # @param govuk_date_input_options [Hash] options that will be used for the parts of the fieldset, form group, hint and date input
 
-        def set_govuk_date_input_fieldset_options(**govuk_date_input_options)
-          (govuk_date_input_options[:fieldset][:attributes] ||= {})[:role] = 'group'
-        end
+          def set_govuk_date_input_fieldset_options(**govuk_date_input_options)
+            (govuk_date_input_options[:fieldset][:attributes] ||= {})[:role] = 'group'
+          end
 
-        # Wrapper method used by {govuk_date_input} to generate the date inputs HTML
-        #
-        # @param attribute [String, Symbol] the attribute of the date input
-        # @param any_errors [Boolean] flag to indicate if the inputs need the error class
-        # @param govuk_date_input_options [Hash] options that will be used in customising the HTML
-        #
-        # @option govuk_date_input_options [String] :classes additional CSS classes for the date inputs HTML
-        # @option govuk_date_input_options[Array] :date_items an array of the date items that will be rendered.
-        #                                                     Each date item hash must contain the +:name+ to add as suffix to attribute.
-        #                                                     Anything else in the hash will be used as options in a {govuk_input}.
-        # @option govuk_date_input_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
-        #
-        # @yield the date input item HTML generated by the parent method
-        #
-        # @yieldparam date_item_attribute [String] the attribute for individual date input
-        # @yieldparam date_item_input_options [Hash] the HTML options used for the date input item
-        #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the date inputs which is used in {govuk_date_input}
-
-        def _govuk_date_input_fields(attribute, any_errors, **govuk_date_input_options)
-          govuk_date_input_options[:attributes] ||= {}
-          govuk_date_input_options[:attributes][:class] = "govuk-date-input #{govuk_date_input_options[:classes]}".rstrip
-          date_items = govuk_date_input_options[:date_items] || govuk_default_date_items
-
-          tag.div(**govuk_date_input_options[:attributes]) do
-            capture do
-              enumerate_and_set_date_input_options(date_items, any_errors) do |date_item_input_options|
-                concat(tag.div(class: 'govuk-date-input__item') do
-                  concat(yield("#{attribute}_#{date_item_input_options[:name]}", date_item_input_options))
-                end)
+          # Wrapper method used by {govuk_date_input} to generate the date inputs HTML
+          #
+          # @param attribute [String, Symbol] the attribute of the date input
+          # @param any_errors [Boolean] flag to indicate if the inputs need the error class
+          # @param govuk_date_input_options [Hash] options that will be used in customising the HTML
+          #
+          # @option govuk_date_input_options [String] :classes additional CSS classes for the date inputs HTML
+          # @option govuk_date_input_options[Array] :date_items an array of the date items that will be rendered.
+          #                                                     Each date item hash must contain the +:name+ to add as suffix to attribute.
+          #                                                     Anything else in the hash will be used as options in a {govuk_input}.
+          # @option govuk_date_input_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+          #
+          # @yield the date input item HTML generated by the parent method
+          #
+          # @yieldparam date_item_attribute [String] the attribute for individual date input
+          # @yieldparam date_item_input_options [Hash] the HTML options used for the date input item
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the date inputs which is used in {govuk_date_input}
+
+          def _govuk_date_input_fields(attribute, any_errors, **govuk_date_input_options)
+            govuk_date_input_options[:attributes] ||= {}
+            govuk_date_input_options[:attributes][:class] = "govuk-date-input #{govuk_date_input_options[:classes]}".rstrip
+            date_items = govuk_date_input_options[:date_items] || govuk_default_date_items
+
+            tag.div(**govuk_date_input_options[:attributes]) do
+              capture do
+                enumerate_and_set_date_input_options(date_items, any_errors) do |date_item_input_options|
+                  concat(tag.div(class: 'govuk-date-input__item') do
+                    concat(yield("#{attribute}_#{date_item_input_options[:name]}", date_item_input_options))
+                  end)
+                end
               end
             end
           end
-        end
 
-        # rubocop:disable Metrics/CyclomaticComplexity
+          # rubocop:disable Metrics/CyclomaticComplexity
 
-        # Enumerates and inititalises the attributes of each date input item and is used by {_govuk_date_input_fields}
-        #
-        # @param date_items [Array] an array of the date item hashes that will be inititalised
-        # @param any_errors [Boolean] flag to indicate if the inputs need the error class
-        #
-        # @yield the date input item HTML generated by teach date input item
-        #
-        # @yieldparam date_item_input_options [Hash] the HTML options used for the date input item
+          # Enumerates and inititalises the attributes of each date input item and is used by {_govuk_date_input_fields}
+          #
+          # @param date_items [Array] an array of the date item hashes that will be inititalised
+          # @param any_errors [Boolean] flag to indicate if the inputs need the error class
+          #
+          # @yield the date input item HTML generated by teach date input item
+          #
+          # @yieldparam date_item_input_options [Hash] the HTML options used for the date input item
 
-        def enumerate_and_set_date_input_options(date_items, any_errors)
-          date_items.each do |date_item_input_options|
-            (date_item_input_options[:input] ||= {})[:attributes] ||= {}
+          def enumerate_and_set_date_input_options(date_items, any_errors)
+            date_items.each do |date_item_input_options|
+              (date_item_input_options[:input] ||= {})[:attributes] ||= {}
 
-            date_item_input_options[:input][:classes] = "govuk-date-input__input #{date_item_input_options[:input][:classes]} #{'govuk-input--error' if any_errors}".rstrip
+              date_item_input_options[:input][:classes] = "govuk-date-input__input #{date_item_input_options[:input][:classes]} #{'govuk-input--error' if any_errors}".rstrip
 
-            date_item_input_options[:input][:attributes][:inputmode] ||= 'numeric'
+              date_item_input_options[:input][:attributes][:inputmode] ||= 'numeric'
 
-            date_item_input_options[:label] ||= {}
-            date_item_input_options[:label][:text] ||= date_item_input_options[:name].capitalize
-            date_item_input_options[:label][:classes] = 'govuk-date-input__label'
+              date_item_input_options[:label] ||= {}
+              date_item_input_options[:label][:text] ||= date_item_input_options[:name].capitalize
+              date_item_input_options[:label][:classes] = 'govuk-date-input__label'
 
-            yield(date_item_input_options)
+              yield(date_item_input_options)
+            end
           end
-        end
-        # rubocop:enable Metrics/CyclomaticComplexity
-
-        # The default date items used in {_govuk_date_input_fields} if no date items are provided
-
-        def govuk_default_date_items
-          [
-            {
-              name: 'day',
-              input: {
-                classes: 'govuk-input--width-2'
-              }
-            },
-            {
-              name: 'month',
-              input: {
-                classes: 'govuk-input--width-2'
+          # rubocop:enable Metrics/CyclomaticComplexity
+
+          # The default date items used in {_govuk_date_input_fields} if no date items are provided
+
+          def govuk_default_date_items
+            [
+              {
+                name: 'day',
+                input: {
+                  classes: 'govuk-input--width-2'
+                }
+              },
+              {
+                name: 'month',
+                input: {
+                  classes: 'govuk-input--width-2'
+                }
+              },
+              {
+                name: 'year',
+                input: {
+                  classes: 'govuk-input--width-4'
+                }
               }
-            },
-            {
-              name: 'year',
-              input: {
-                classes: 'govuk-input--width-4'
-              }
-            }
-          ]
+            ]
+          end
         end
       end
     end

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

@@ -2,91 +2,93 @@
 
 require_relative '../field'
 
-module CrownMarketplaceUtils::Helpers
-  module GovUkHelper
-    module Field
-      # = GOV.UK File Upload
-      #
-      # This helper is used for generating the file upload component from the
-      # {https://design-system.service.gov.uk/components/file-upload GDS - Components - File Upload}
-      #
-      # This is considered a Field module and so makes use of the methods in {CrownMarketplaceUtils::GovUkHelper::Field}
-
-      module FileUpload
-        include Field
-
-        # Generates the HTML for the GOV.UK file upload component
-        #
-        # @param attribute [String, Symbol] the attribute of the file upload
-        # @param govuk_file_upload_options [Hash] options that will be used for the parts of the form group, label, hint and file upload
+module CrownMarketplaceUtils
+  module Helpers
+    module GovUkHelper
+      module Field
+        # = GOV.UK File Upload
         #
-        # @option govuk_file_upload_options [String] :error_message (nil) the error message to be displayed
-        # @option govuk_file_upload_options [ActiveModel] :model (nil) optional model that can be used to find an error message
-        # @option govuk_file_upload_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
-        #                                                                            the file upload input and find the error message
-        # @option govuk_file_upload_options [Hash] :form_group see {govuk_field}
-        # @option govuk_file_upload_options [Hash] :label see {govuk_field}
-        # @option govuk_file_upload_options [Hash] :hint see {govuk_field}
-        # @option govuk_file_upload_options [Hash] :file_upload ({}) the options that will be used when rendering the file upload.
-        #                                                            See {set_file_upload_options} for more details.
+        # This helper is used for generating the file upload component from the
+        # {https://design-system.service.gov.uk/components/file-upload GDS - Components - File Upload}
         #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK File Upload
-        #                                     which can then be rendered on the page
+        # This is considered a Field module and so makes use of the methods in {CrownMarketplaceUtils::GovUkHelper::Field}
+
+        module FileUpload
+          include Field
+
+          # Generates the HTML for the GOV.UK file upload component
+          #
+          # @param attribute [String, Symbol] the attribute of the file upload
+          # @param govuk_file_upload_options [Hash] options that will be used for the parts of the form group, label, hint and file upload
+          #
+          # @option govuk_file_upload_options [String] :error_message (nil) the error message to be displayed
+          # @option govuk_file_upload_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+          # @option govuk_file_upload_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+          #                                                                            the file upload input and find the error message
+          # @option govuk_file_upload_options [Hash] :form_group see {govuk_field}
+          # @option govuk_file_upload_options [Hash] :label see {govuk_field}
+          # @option govuk_file_upload_options [Hash] :hint see {govuk_field}
+          # @option govuk_file_upload_options [Hash] :file_upload ({}) the options that will be used when rendering the file upload.
+          #                                                            See {set_file_upload_options} for more details.
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK File Upload
+          #                                     which can then be rendered on the page
 
-        def govuk_file_upload(attribute, **govuk_file_upload_options)
-          govuk_field(:file_upload, attribute, **govuk_file_upload_options) do |govuk_field_options, error_message|
-            set_file_upload_options(error_message, govuk_field_options)
+          def govuk_file_upload(attribute, **govuk_file_upload_options)
+            govuk_field(:file_upload, attribute, **govuk_file_upload_options) do |govuk_field_options, error_message|
+              set_file_upload_options(error_message, govuk_field_options)
 
-            concat(
-              if govuk_file_upload_options[:form]
-                govuk_file_upload_form(govuk_file_upload_options[:form], attribute, **govuk_field_options)
-              else
-                govuk_file_upload_tag(attribute, **govuk_field_options)
-              end
-            )
+              concat(
+                if govuk_file_upload_options[:form]
+                  govuk_file_upload_form(govuk_file_upload_options[:form], attribute, **govuk_field_options)
+                else
+                  govuk_file_upload_tag(attribute, **govuk_field_options)
+                end
+              )
+            end
           end
-        end
 
-        private
+          private
 
-        # Generates the file upload HTML for {govuk_file_upload}
-        #
-        # @param attribute [String, Symbol] the attribute of the file upload
-        # @param govuk_file_upload_options [Hash] options that will be used in customising the HTML
-        #
-        # @option (see set_file_upload_options)
-        #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the file upload field which is used in {govuk_file_upload}
+          # Generates the file upload HTML for {govuk_file_upload}
+          #
+          # @param attribute [String, Symbol] the attribute of the file upload
+          # @param govuk_file_upload_options [Hash] options that will be used in customising the HTML
+          #
+          # @option (see set_file_upload_options)
+          #
+          # @return [ActiveSupport::SafeBuffer] the HTML for the file upload field which is used in {govuk_file_upload}
 
-        def govuk_file_upload_tag(attribute, **govuk_file_upload_options)
-          file_field_tag(attribute, **govuk_file_upload_options[:attributes])
-        end
+          def govuk_file_upload_tag(attribute, **govuk_file_upload_options)
+            file_field_tag(attribute, **govuk_file_upload_options[:attributes])
+          end
 
-        # Generates the file upload HTML for {govuk_file_upload} when there is a ActionView::Helpers::FormBuilder
-        #
-        # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the file upload input
-        # @param (see govuk_file_upload_tag)
-        #
-        # @option (see set_file_upload_options)
-        #
-        # @return (see govuk_file_upload_tag)
+          # Generates the file upload HTML for {govuk_file_upload} when there is a ActionView::Helpers::FormBuilder
+          #
+          # @param form [ActionView::Helpers::FormBuilder] the form builder used to create the file upload input
+          # @param (see govuk_file_upload_tag)
+          #
+          # @option (see set_file_upload_options)
+          #
+          # @return (see govuk_file_upload_tag)
 
-        def govuk_file_upload_form(form, attribute, **govuk_file_upload_options)
-          form.file_field(attribute, **govuk_file_upload_options[:attributes])
-        end
+          def govuk_file_upload_form(form, attribute, **govuk_file_upload_options)
+            form.file_field(attribute, **govuk_file_upload_options[:attributes])
+          end
 
-        # Initialises the attributes for the file upload input
-        #
-        # @param error_message [String] used to indicate if there is an error which will add extra classes
-        # @param govuk_file_upload_options [Hash] options that will be used in customising the HTML
-        #
-        # @option govuk_file_upload_options [String] :classes additional CSS classes for the file iupload HTML
-        # @option govuk_file_upload_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+          # Initialises the attributes for the file upload input
+          #
+          # @param error_message [String] used to indicate if there is an error which will add extra classes
+          # @param govuk_file_upload_options [Hash] options that will be used in customising the HTML
+          #
+          # @option govuk_file_upload_options [String] :classes additional CSS classes for the file iupload HTML
+          # @option govuk_file_upload_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
 
-        def set_file_upload_options(error_message, govuk_file_upload_options)
-          govuk_file_upload_options[:attributes] ||= {}
-          govuk_file_upload_options[:attributes][:class] = "govuk-file-upload #{govuk_file_upload_options[:classes]}".rstrip
-          govuk_file_upload_options[:attributes][:class] << ' govuk-file-upload--error' if error_message
+          def set_file_upload_options(error_message, govuk_file_upload_options)
+            govuk_file_upload_options[:attributes] ||= {}
+            govuk_file_upload_options[:attributes][:class] = "govuk-file-upload #{govuk_file_upload_options[:classes]}".rstrip
+            govuk_file_upload_options[:attributes][:class] << ' govuk-file-upload--error' if error_message
+          end
         end
       end
     end