ccs-frontend_helpers 0.1.0.rc.1

data/lib/ccs/frontend_helpers/govuk_frontend/field.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+require_relative 'fieldset'
+require_relative 'form_group'
+require_relative 'hint'
+require_relative 'label'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Field
+      #
+      # This module contains methods to wrap the:
+      # - fieldset
+      # - form group
+      # - label
+      # - hint
+      # - error message
+      # around some kind of input.
+      #
+      # The wrapper functions in this module are used
+      # to create the fields using the structure of a GDS input field component.
+
+      module Field
+        include Fieldset
+        include FormGroup
+        include Hint
+        include Label
+
+        # Generates the HTML to wrap arround a GDS input field component.
+        #
+        # @param field [Symbol] the type of the field
+        # @param attribute [String, Symbol] the attribute of the field
+        # @param govuk_field_options [Hash] options that will be used for the parts of the form group, label, hint and field
+        #
+        # @option govuk_field_options [String] :error_message (nil) the error message to be displayed
+        # @option govuk_field_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+        # @option govuk_field_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+        #                                                                      the field and find the error message
+        # @option govuk_field_options [Hash] :form_group ({}) the options for govuk_form_group {govuk_form_group}
+        # @option govuk_field_options [Hash] :label the parameters that will be used to create the label for the field, see {govuk_label}
+        # @option govuk_field_options [Hash] :hint (nil) the parameters that will be used to create the hint for the field, see {govuk_hint}.
+        #                                                If no hint is given then no hint will be rendered
+        # @option govuk_field_options [Hash] :field_options ({}) the options that will be used when rendering the field.
+        #                                                        For more details look at the specific module that uses +Field+.
+        #
+        # @yield the field HTML
+        #
+        # @yieldparam govuk_field_options [Hash] the HTML options used when rendering the field
+        # @yieldparam error_message [String] flag to indicate if there are any erros
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML that wraps arround the field
+
+        def govuk_field(field, attribute, **govuk_field_options)
+          set_label_for_if_custom_id(field, govuk_field_options)
+          set_hint_id(attribute, govuk_field_options)
+          error_message = find_field_error_message(attribute, govuk_field_options)
+
+          govuk_form_group(attribute, error_message: error_message, **(govuk_field_options[:form_group] || {})) do |display_error_message|
+            set_field_described_by(field, attribute, error_message, govuk_field_options)
+
+            concat(govuk_label(attribute, govuk_field_options[:label][:text], form: govuk_field_options[:form], **govuk_field_options[:label]))
+            concat(govuk_hint(govuk_field_options[:hint][:text], **govuk_field_options[:hint])) if govuk_field_options[:hint]
+            concat(display_error_message)
+            yield(govuk_field_options[field], error_message)
+          end
+        end
+
+        # Generates the HTML to wrap arround a GDS input fields component.
+        # These are inputs that require being wrapped in a fieldset, for example radio buttons.
+        #
+        # @param field [Symbol] the type of the fields
+        # @param attribute [String, Symbol] the attribute of the fields
+        # @param govuk_fields_options [Hash] options that will be used for the parts of the fieldset, form group, hint and fields
+        #
+        # @option govuk_fields_options [String] :error_message (nil) the error message to be displayed
+        # @option govuk_fields_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+        # @option govuk_fields_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+        #                                                                       the field and find the error message
+        # @option govuk_fields_options [Hash] :form_group ({}) the options for govuk_form_group {govuk_form_group}
+        # @option govuk_fields_options [Hash] :fieldset ({}) the options for govuk_fieldset {govuk_fieldset}
+        # @option govuk_fields_options [Hash] :hint (nil) the parameters that will be used to create the hint for the field, see {govuk_hint}.
+        #                                                 If no hint is given then no hint will be rendered
+        # @option govuk_fields_options [Hash] :field_options ({}) the options that will be used when rendering the fields.
+        #                                                         For more details look at a module that uses +Field+.
+        #
+        # @yield the fields HTML
+        #
+        # @yieldparam govuk_fields_options [Hash] the HTML options used when rendering the fields
+        # @yieldparam error_message [String] flag to indicate if there are any erros
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML that wraps arround the fields
+
+        def govuk_fields(field, attribute, **govuk_fields_options)
+          set_hint_id(attribute, govuk_fields_options)
+          error_message = find_field_error_message(attribute, govuk_fields_options)
+
+          govuk_form_group(attribute, error_message: error_message, **(govuk_fields_options[:form_group] || {})) do |display_error_message|
+            set_field_described_by(:fieldset, attribute, error_message, govuk_fields_options)
+            (govuk_fields_options[field] ||= {})[:attributes] ||= {}
+
+            govuk_fieldset(**govuk_fields_options[:fieldset]) do
+              concat(govuk_hint(govuk_fields_options[:hint][:text], **govuk_fields_options[:hint])) if govuk_fields_options[:hint]
+              concat(display_error_message)
+              yield(govuk_fields_options[field], error_message)
+            end
+          end
+        end
+
+        private
+
+        # If present, will find the error message for the field
+        #
+        # @param attribute [String, Symbol] the attribute of the fields
+        #
+        # @option govuk_field_options [String] :error_message (nil) the error message to be displayed
+        # @option govuk_field_options [ActiveModel] :model (nil) optional model that can be used to find an error message
+        # @option govuk_field_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
+        #                                                                       the field and find the error message
+        #
+        # @return [String] the error message
+
+        def find_field_error_message(attribute, govuk_field_options)
+          if govuk_field_options[:model]
+            govuk_field_options[:model].errors[attribute].first
+          elsif govuk_field_options[:form]
+            govuk_field_options[:form].object.errors[attribute].first
+          else
+            govuk_field_options[:error_message]
+          end
+        end
+
+        # Sets the label +for+ if a custom ID has been given for the field.
+        #
+        # @param govuk_field_options [Hash] see {govuk_field} for details
+
+        def set_label_for_if_custom_id(field, govuk_field_options)
+          field_id = govuk_field_options.dig(field, :attributes, :id)
+
+          govuk_field_options[:label] ||= {}
+          (govuk_field_options[:label][:attributes] ||= {})[:for] = field_id if field_id
+        end
+
+        # Sets the hint ID if there is a hint, and the ID for the hint has not been sent
+        #
+        # @param attribute [String, Symbol] the attribute of the field
+        # @param govuk_field_options [Hash] see {govuk_field} for details
+
+        def set_hint_id(attribute, govuk_field_options)
+          return if !govuk_field_options[:hint] || govuk_field_options.dig(:hint, :attributes, :id)
+
+          govuk_field_options[:hint] ||= {}
+          (govuk_field_options[:hint][:attributes] ||= {})[:id] = "#{attribute}-hint"
+        end
+
+        # Adds the aira-describedby attribute for the field
+        # if there is a hint or an error message
+        #
+        # @param attribute [String, Symbol] the attribute of the input
+        # @param error_message [String] used to indicate if there is an error
+        # @param govuk_field_options [Hash] see {#govuk_field} for details
+
+        def set_field_described_by(field, attribute, error_message, govuk_field_options)
+          aria_described_by = []
+          aria_described_by << govuk_field_options.dig(field, :attributes, :aria, :describedby)
+          aria_described_by << govuk_field_options[:hint][:attributes][:id] if govuk_field_options[:hint]
+          aria_described_by << "#{attribute}-error" if error_message
+          aria_described_by.compact!
+
+          govuk_field_options[field] ||= {}
+          govuk_field_options[field][:attributes] ||= {}
+
+          return unless aria_described_by.any?
+
+          (govuk_field_options[field][:attributes][:aria] ||= {})[:describedby] = aria_described_by.join(' ')
+        end
+
+        # Sets the hint attributes and adds the aira-describedby attribute for a fields item
+        #
+        # @param type [String] the type of the item
+        # @param attribute [String, Symbol] the attribute of the item
+        # @param item [Hash] the options for that item
+
+        def set_item_options_for_hint(type, attribute, item)
+          return unless item[:hint]
+
+          (item[:hint] ||= {})[:attributes] ||= {}
+          item[:hint][:classes] = "govuk-#{type}__hint #{item[:hint][:classes]}".rstrip
+          item[:hint][:attributes][:id] ||= "#{attribute}_#{item[:value]}-item-hint"
+
+          (item[:attributes][:aria] ||= {})[:describedby] = item[:hint][:attributes][:id]
+        end
+
+        # Sets the conditional attributes and adds the data-aira-controls attribute for a fields item
+        #
+        # @param type [String] the type of the item
+        # @param attribute [String, Symbol] the attribute of the item
+        # @param item [Hash] the options for that item
+
+        def set_conditional_item_options(type, attribute, item)
+          return unless item[:conditional]
+
+          item[:conditional][:attributes] ||= {}
+          item[:conditional][:attributes][:class] = "govuk-#{type}__conditional #{"govuk-#{type}__conditional--hidden" unless item[:checked]}".rstrip
+          item[:conditional][:attributes][:id] ||= sanitize_to_id("#{attribute}_#{item[:value]}_conditional")
+          (item[:attributes][:data] ||= {})[:'aria-controls'] = item[:conditional][:attributes][:id]
+        end
+      end
+    end
+  end
+
+  ActionView::Base.field_error_proc = proc { |html_tag, _instance| html_tag }
+end

data/lib/ccs/frontend_helpers/govuk_frontend/fieldset.rb

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

data/lib/ccs/frontend_helpers/govuk_frontend/footer.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+require 'action_view'
+
+require_relative '../shared_methods'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Footer
+      #
+      # This helper is used for generating the footer component from the
+      # {https://design-system.service.gov.uk/components/footer GDS - Components - Footer}
+
+      module Footer
+        include SharedMethods
+        include ActionView::Context
+        include ActionView::Helpers::FormTagHelper
+        include ActionView::Helpers::TagHelper
+        include ActionView::Helpers::TextHelper
+        include ActionView::Helpers::UrlHelper
+
+        # rubocop:disable Metrics/AbcSize
+
+        # Generates the HTML for the GOV.UK Footer component
+        #
+        # @param govuk_footer_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_footer_options [String] :classes additional CSS classes for the footer HTML
+        # @option govuk_footer_options [String] :container_class classes that can be added to the inner container
+        # @option govuk_footer_options [Array] :navigation (see: {govuk_footer_navigation})
+        # @option govuk_footer_options [Hash] :meta (see: {govuk_footer_meta})
+        # @option govuk_footer_options [ActiveSupport::SafeBuffer,String] :content_licence The content licence information. See {govuk_footer_content_licence}
+        # @option govuk_footer_options [ActiveSupport::SafeBuffer,String] :copyright The copyright information. See {govuk_footer_copyright}
+        # @option govuk_footer_options [Hash] :attributes additional attributes that will added as part of the HTML
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Footer
+        #                                     which can then be rendered on the page
+
+        def govuk_footer(**govuk_footer_options)
+          initialise_attributes_and_set_classes(govuk_footer_options, 'govuk-footer')
+
+          govuk_footer_options[:attributes][:role] = 'contentinfo'
+
+          tag.footer(**govuk_footer_options[:attributes]) do
+            tag.div(class: "govuk-width-container #{govuk_footer_options[:container_classes]}".rstrip) do
+              if govuk_footer_options[:navigation]
+                concat(tag.div(class: 'govuk-footer__navigation') do
+                  govuk_footer_options[:navigation].each { |navigation_item| concat(govuk_footer_navigation(navigation_item)) }
+                end)
+                concat(tag.hr(class: 'govuk-footer__section-break'))
+              end
+              concat(tag.div(class: 'govuk-footer__meta') do
+                concat(tag.div(class: 'govuk-footer__meta-item govuk-footer__meta-item--grow') do
+                  concat(govuk_footer_meta(govuk_footer_options[:meta])) if govuk_footer_options[:meta]
+                  concat(govuk_footer_logo)
+                  concat(govuk_footer_content_licence(govuk_footer_options[:content_licence]))
+                end)
+                concat(govuk_footer_copyright(govuk_footer_options[:copyright]))
+              end)
+            end
+          end
+        end
+
+        private
+
+        # Generates the HTML for the navigation section in {govuk_footer}
+        #
+        # @param navigation_item [Hash] options that will be used for the navigation section
+        #
+        # @option navigation_item [String] :title title for a section
+        # @option navigation_item [String] :width (default: 'fall') width of each navigation section in the footer
+        # @option navigation_item [Integer] :columns amount of columns to display items in navigation section of the footer
+        # @option navigation_item [Array] :items array of items to display in the list in navigation section of the footer.
+        #                                        Each item can have the following options:
+        #                                        - +:text+ list item text
+        #                                        - +:href+ list item href
+        #                                        - +:attributes+ HTML attributes to add to the link
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the navigation section in {govuk_footer}
+
+        def govuk_footer_navigation(navigation_item)
+          tag.div(class: "govuk-footer__section govuk-grid-column-#{navigation_item[:width] || 'full'}") do
+            concat(tag.h2(navigation_item[:title], class: 'govuk-footer__heading govuk-heading-m'))
+            concat(tag.ul(class: "govuk-footer__list #{"govuk-footer__list--columns-#{navigation_item[:columns]}" if navigation_item[:columns]}".rstrip) do
+              navigation_item[:items].each do |item|
+                concat(tag.li(class: 'govuk-footer__list-item') do
+                  (item[:attributes] ||= {})[:class] = 'govuk-footer__link'
+
+                  link_to(item[:text], item[:href], **item[:attributes])
+                end)
+              end
+            end)
+          end
+        end
+
+        # Generates the HTML for the meta section in {govuk_footer}
+        #
+        # @param meta [Hash] options that will be used for the meta section
+        #
+        # @option meta [String] :visually_hidden_title (default: 'Support links') title for a meta item section
+        # @option meta [ActiveSupport::SafeBuffer,String] :text text to add to the meta section of the footer,
+        #                                                       which will appear below any links specified using meta.items
+        # @option meta [Array] :items array of items to display in the list in meta section of the footer.
+        #                                        Each item can have the following options:
+        #                                        - +:text+ list item text
+        #                                        - +:href+ list item href
+        #                                        - +:attributes+ HTML attributes to add to the link
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the meta section in {govuk_footer}
+
+        def govuk_footer_meta(meta)
+          concat(tag.h2(meta[:visually_hidden_title] || 'Support links', class: 'govuk-visually-hidden'))
+          if meta[:items]
+            concat(tag.ul(class: 'govuk-footer__inline-list') do
+              meta[:items].each do |meta_item|
+                concat(tag.li(class: 'govuk-footer__inline-list-item') do
+                  (meta_item[:attributes] ||= {})[:class] = 'govuk-footer__link'
+
+                  link_to(meta_item[:text], meta_item[:href], **meta_item[:attributes])
+                end)
+              end
+            end)
+          end
+          concat(tag.div(meta[:text], class: 'govuk-footer__meta-custom')) if meta[:text]
+        end
+
+        # rubocop:enable Metrics/AbcSize
+
+        # Generates the logo used in {govuk_footer}
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def govuk_footer_logo
+          tag.svg(
+            class: 'govuk-footer__licence-logo',
+            aria: { hidden: 'true' },
+            focusable: 'false',
+            xmlns: 'http://www.w3.org/2000/svg',
+            viewBox: '0 0 483.2 195.7',
+            height: '17',
+            width: '41'
+          ) do
+            tag.path(
+              fill: 'currentColor',
+              d: 'M421.5 142.8V.1l-50.7 32.3v161.1h112.4v-50.7zm-122.3-9.6A47.12 47.12 0 0 1 221 97.8c0-26 21.1-47.1 47.1-47.1 16.7 0 31.4 8.7 39.7 21.8l42.7-27.2A97.63 97.63 0 0 0 268.1 0c-36.5 0-68.3 20.1-85.1 49.7A98 98 0 0 0 97.8 0C43.9 0 0 43.9 0 97.8s43.9 97.8 97.8 97.8c36.5 0 68.3-20.1 85.1-49.7a97.76 97.76 0 0 0 149.6 25.4l19.4 22.2h3v-87.8h-80l24.3 27.5zM97.8 145c-26 0-47.1-21.1-47.1-47.1s21.1-47.1 47.1-47.1 47.2 21 47.2 47S123.8 145 97.8 145'
+            )
+          end
+        end
+
+        # Generates the content licence used in {govuk_footer}
+        #
+        # @param content_licence [ActiveSupport::SafeBuffer,String] the content licence information. Defaults to Open Government Licence (OGL) v3 licence
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the content licence used in {govuk_footer}
+
+        def govuk_footer_content_licence(content_licence)
+          tag.span(class: 'govuk-footer__licence-description') do
+            if content_licence
+              concat(content_licence)
+            else
+              concat('All content is available under the')
+              concat(link_to('Open Government Licence v3.0', 'https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/', class: 'govuk-footer__link', rel: 'license'))
+              concat(', except where otherwise stated')
+            end
+          end
+        end
+
+        # Generates the copyright used in {govuk_footer}
+        #
+        # @param copyright [ActiveSupport::SafeBuffer,String] the copyright information, this defaults to Crown Copyright
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the copyright used in {govuk_footer}
+
+        def govuk_footer_copyright(copyright)
+          tag.div(class: 'govuk-footer__meta-item') do
+            link_to(copyright || '© Crown copyright', 'https://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/uk-government-licensing-framework/crown-copyright/', class: 'govuk-footer__link govuk-footer__copyright-logo')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/frontend_helpers/govuk_frontend/form_group.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'error_message'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK FormGroup
+      #
+      # This helper is used for generating the form group component from the Government Design Systems
+
+      module FormGroup
+        include ErrorMessage
+
+        # Generates the HTML for the GOV.UK Form Group component
+        #
+        # @param attribute [String, Symbol] the attribute that the form group is for
+        # @param govuk_form_group_options [Hash] options that will be used in customising the HTML
+        #
+        # @option govuk_form_group_options [String] :classes additional CSS classes for the form group HTML
+        # @option govuk_form_group_options [String] :error_message (nil) the error message to be displayed
+        # @option govuk_form_group_options [ActiveModel] :model (nil) model that will be used to find an error message
+        # @option govuk_form_group_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        #
+        # @yield HTML that will be contained within the 'govuk-form-group' div
+        #
+        # @yieldparam displayed_error_message [ActiveSupport::SafeBuffer] the HTML for the error message (if there is one)
+        #
+        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Form Group
+        #                                     which can then be rendered on the page
+
+        def govuk_form_group(attribute, **govuk_form_group_options)
+          error_message = if govuk_form_group_options[:model]
+                            model.errors[attribute].first
+                          else
+                            govuk_form_group_options[:error_message]
+                          end
+
+          initialise_attributes_and_set_classes(govuk_form_group_options, "govuk-form-group #{'govuk-form-group--error' if error_message}".rstrip)
+
+          govuk_form_group_options[:attributes][:id] ||= "#{attribute}-form-group"
+
+          tag.div(**govuk_form_group_options[:attributes]) do
+            yield((govuk_error_message(error_message, attribute) if error_message))
+          end
+        end
+      end
+    end
+  end
+end