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

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

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

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

@@ -1,166 +0,0 @@
-# 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

@@ -1,127 +0,0 @@
-# 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 }