ccs-frontend_helpers 0.1.0 → 0.1.1.rc.1

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'action_view'
-
-require_relative '../shared_methods'
+require_relative '../../components/govuk/back_link'
 
 module CCS
   module FrontendHelpers
@@ -13,53 +11,34 @@ module CCS
       # {https://design-system.service.gov.uk/components/error-message GDS - Components - Error message}
 
       module ErrorMessage
-        include SharedMethods
-        include ActionView::Context
-        include ActionView::Helpers::TagHelper
-        include ActionView::Helpers::TextHelper
-
         # Generates the HTML for the GOV.UK Error message component
         #
-        # @param message [String] the message to be displayed
-        # @param attribute [String, Symbol] the attribute that has an error
-        # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
+        # @param (see CCS::Components::GovUK::ErrorMessage#initialize)
         #
-        # @option govuk_error_message_options [String] :classes additional CSS classes for the error message HTML
-        # @option govuk_error_message_options [String] :visually_hidden_text ('Error') visualy hidden text before the error message
-        # @option govuk_error_message_options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
+        # @option (see CCS::Components::GovUK::ErrorMessage#initialize)
         #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Error message
-        #                                     which can then be rendered on the page
-
-        def govuk_error_message(message, attribute, **govuk_error_message_options)
-          initialise_attributes_and_set_classes(govuk_error_message_options, 'govuk-error-message')
-
-          govuk_error_message_options[:attributes][:id] ||= "#{attribute}-error"
-          visually_hidden_text = govuk_error_message_options[:visually_hidden_text] || 'Error'
+        # @return (see CCS::Components::GovUK::ErrorMessage#render)
 
-          tag.p(**govuk_error_message_options[:attributes]) do
-            concat(tag.span("#{visually_hidden_text}: ", class: 'govuk-visually-hidden')) if visually_hidden_text.present?
-            concat(message)
-          end
+        def govuk_error_message(error_message, attribute, **options)
+          Components::GovUK::ErrorMessage.new(context: self, message: error_message, attribute: attribute, **options).render
         end
 
         # Generates the HTML for the GOV.UK Error message component using the error messages in an ActiveModel
         #
         # @param model [ActiveModel] model that will be used to find the error message
         # @param attribute [String, Symbol] the attribute that has an error
-        # @param govuk_error_message_options [Hash] options that will be used in customising the HTML
+        # @param options [Hash] options that will be used in customising the HTML
         #
-        # @option (see #govuk_error_message)
+        # @option (see CCS::Components::GovUK::ErrorMessage#initialize)
         #
         # @return [NilClass, ActiveSupport::SafeBuffer] if the error message is not on the model it will return nil,
-        #                                               otherwise the HTML for the GOV.UK Error message
-        #                                               which can then be rendered on the page is returned
+        #                                               otherwise it returns the error message HTML
 
-        def govuk_error_message_with_model(model, attribute, **govuk_error_message_options)
+        def govuk_error_message_with_model(model, attribute, **options)
           error_message = model.errors[attribute].first
           return unless error_message
 
-          govuk_error_message(error_message, attribute, **govuk_error_message_options)
+          Components::GovUK::ErrorMessage.new(context: self, message: error_message, attribute: attribute, **options).render
         end
       end
     end

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'action_view'
-
-require_relative '../shared_methods'
+require_relative '../../components/govuk/error_summary'
 
 module CCS
   module FrontendHelpers
@@ -13,38 +11,16 @@ module CCS
       # {https://design-system.service.gov.uk/components/error-summary GDS - Components - Error summary}
 
       module ErrorSummary
-        include SharedMethods
-        include ActionView::Context
-        include ActionView::Helpers::TagHelper
-        include ActionView::Helpers::TextHelper
-        include ActionView::Helpers::UrlHelper
-
         # Generates the HTML for the GOV.UK Error summary component
         #
-        # @param title [String] text to use for the heading of the error summary block
-        # @param error_list [Array] the list of errors to include in the summary. See {govuk_error_summary_list}
-        # @param description [String] optional text to use for the description of the errors
-        # @param govuk_error_summary_options [Hash] options that will be used in customising the HTML
+        # @param (see CCS::Components::GovUK::ErrorSummary#initialize)
         #
-        # @option govuk_error_summary_options [String] :classes additional CSS classes for the error summary HTML
-        # @option govuk_error_summary_options [Hash] :attributes ({}) any additional attributes that will be added as part of the HTML
+        # @option (see CCS::Components::GovUK::ErrorSummary#initialize)
         #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Error summary
-        #                                     which can then be rendered on the page
+        # @return (see CCS::Components::GovUK::ErrorSummary#render)
 
-        def govuk_error_summary(title, error_list, description = nil, **govuk_error_summary_options)
-          initialise_attributes_and_set_classes(govuk_error_summary_options, 'govuk-error-summary')
-          set_data_module(govuk_error_summary_options, 'govuk-error-summary')
-
-          tag.div(**govuk_error_summary_options[:attributes]) do
-            tag.div(role: 'alert') do
-              concat(tag.h2(title, class: 'govuk-error-summary__title'))
-              concat(tag.div(class: 'govuk-error-summary__body') do
-                concat(tag.p(description)) if description
-                concat(govuk_error_summary_list(error_list))
-              end)
-            end
-          end
+        def govuk_error_summary(title, error_summary_items, description = nil, **options)
+          Components::GovUK::ErrorSummary.new(context: self, title: title, error_summary_items: error_summary_items, description: description, **options).render
         end
 
         # Generates the HTML for the GOV.UK Error summary component using the error messages in an ActiveModel
@@ -52,47 +28,19 @@ module CCS
         # @param model [ActiveModel] model that will be used to find the error messages to list
         # @param title [String] text to use for the heading of the error summary block
         # @param description [String] (nil) optional text to use for the description of the errors
-        # @param govuk_error_summary_options [Hash] options that will be used in customising the HTML
+        # @param options [Hash] options that will be used in customising the HTML
         #
-        # @option (see #govuk_error_summary)
+        # @option (see CCS::Components::GovUK::ErrorSummary#initialize)
         #
-        # @return [NilClass, ActiveSupport::SafeBuffer] if there are no errors on the model it will return nil,
-        #                                               otherwise the HTML for the GOV.UK Error summary
-        #                                               which can then be rendered on the page is returned
+        # @return [NilClass, ActiveSupport::SafeBuffer] if error messages are not on the model it will return nil,
+        #                                               otherwise it returns the error summary HTML.
 
-        def govuk_error_summary_with_model(model, title, description = nil, **govuk_error_summary_options)
+        def govuk_error_summary_with_model(model, title, description = nil, **options)
           return if model.errors.blank?
 
-          error_list = model.errors.map { |error| { text: error.message, href: "##{error.attribute}-error" } }
-
-          govuk_error_summary(title, error_list, description, **govuk_error_summary_options)
-        end
-
-        private
-
-        # Generates the HTML for the error list in {govuk_error_summary}
-        #
-        # @param error_list [Array] The list of errors to include in the summary. See {#govuk_error_summary_list}
-        #
-        # @option error_list [String] :href href for the error link item. If provided item will be a link
-        # @option error_list [String] :text Text for the error link item
-        # @option error_list [Hash] :attributes ({}) any additional attributes that will be added as part of the link item
-        #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the error list
-        #                                     which is used in {govuk_error_summary}
+          error_summary_items = model.errors.map { |error| { text: error.message, href: "##{error.attribute}-error" } }
 
-        def govuk_error_summary_list(error_list)
-          tag.ul(class: 'govuk-list govuk-error-summary__list') do
-            error_list.each do |error|
-              concat(tag.li do
-                if error[:href]
-                  link_to(error[:text], error[:href], **(error[:attributes] || {}))
-                else
-                  error[:text]
-                end
-              end)
-            end
-          end
+          Components::GovUK::ErrorSummary.new(context: self, title: title, error_summary_items: error_summary_items, description: description, **options).render
         end
       end
     end

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'action_view'
-
-require_relative '../shared_methods'
+require_relative '../../components/govuk/fieldset'
 
 module CCS
   module FrontendHelpers
@@ -13,57 +11,18 @@ module CCS
       # {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 (see CCS::Components::GovUK::Fieldset#initialize)
         #
-        # @param govuk_legend_options [Hash] options that will be used in the legend
+        # @option (see CCS::Components::GovUK::Fieldset#initialize)
         #
-        # @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
+        # @yield (see CCS::Components::GovUK::Fieldset#render)
         #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Fieldset
-        #                                     which can then be rendered on the page
+        # @return (see CCS::Components::GovUK::Fieldset#render)
 
-        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
+        def govuk_fieldset(**options, &block)
+          Components::GovUK::Fieldset.new(context: self, **options).render(&block)
         end
       end
     end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../../components/govuk/field/input/file_upload'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      # = 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}
+
+      module FileUpload
+        # Generates the HTML for the GOV.UK File Upload component
+        #
+        # @param (see CCS::Components::GovUK::Input::FileUpload#initialize)
+        #
+        # @option (see CCS::Components::GovUK::Input::FileUpload#initialize)
+        #
+        # @return (see CCS::Components::GovUK::Input::FileUpload#render)
+
+        def govuk_file_upload(attribute, **options)
+          Components::GovUK::Field::Input::FileUpload.new(context: self, attribute: attribute, **options).render
+        end
+      end
+    end
+  end
+end

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'action_view'
-
-require_relative '../shared_methods'
+require_relative '../../components/govuk/footer'
 
 module CCS
   module FrontendHelpers
@@ -13,169 +11,16 @@ module CCS
       # {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 (see CCS::Components::GovUK::Footer#initialize)
         #
-        # @param copyright [ActiveSupport::SafeBuffer,String] the copyright information, this defaults to Crown Copyright
+        # @option (see CCS::Components::GovUK::Footer#initialize)
         #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the copyright used in {govuk_footer}
+        # @return (see CCS::Components::GovUK::Footer#render)
 
-        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
+        def govuk_footer(**options)
+          Components::GovUK::Footer.new(context: self, **options).render
         end
       end
     end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative 'error_message'
+require_relative '../../components/govuk/form_group'
 
 module CCS
   module FrontendHelpers
@@ -10,39 +10,28 @@ module CCS
       # 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
+        # Generates the HTML for the GOV.UK Warning text 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
+        # @param (see CCS::Components::GovUK::FormGroup#initialize)
         #
-        # @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
+        # @option options [String] :classes additional CSS classes for the form group HTML
+        # @option options  [ActiveModel] :model (nil) model that will be used to find an error message
+        # @option 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
+        # @yield (see CCS::Components::GovUK::FormGroup#render)
         #
-        # @yieldparam displayed_error_message [ActiveSupport::SafeBuffer] the HTML for the error message (if there is one)
+        # @yieldparam (see CCS::Components::GovUK::FormGroup#render)
         #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Form Group
-        #                                     which can then be rendered on the page
+        # @return (see CCS::Components::GovUK::FormGroup#render)
 
-        def govuk_form_group(attribute, **govuk_form_group_options)
-          error_message = if govuk_form_group_options[:model]
+        def govuk_form_group(attribute, **options, &block)
+          error_message = if options[:model]
                             model.errors[attribute].first
                           else
-                            govuk_form_group_options[:error_message]
+                            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
+          Components::GovUK::FormGroup.new(context: self, attribute: attribute, error_message: error_message, **options).render(&block)
         end
       end
     end