ccs-frontend_helpers 0.1.0.rc.1 → 0.1.0.rc.3

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'action_view'
-
-require_relative '../shared_methods'
+require_relative '../../components/govuk/tag'
 
 module CCS
   module FrontendHelpers
@@ -13,28 +11,16 @@ module CCS
       # {https://design-system.service.gov.uk/components/tag GDS - Components - Tag}
 
       module Tag
-        include SharedMethods
-        include ActionView::Context
-        include ActionView::Helpers::TagHelper
-
-        # Generates the HTML for the GOV.UK Tag component
+        # Generates the HTML for the GOV.UK Back link component
         #
-        # @param text [String] the text for the tag
-        # @param colour [String] optional colour for the tag,
-        #                        see {https://design-system.service.gov.uk/components/tag/#additional-colours Tag - Additional colours}
-        #                        for available colours in GOV.UK Frontend
-        # @param govuk_tag_options [Hash] options that will be used in customising the HTML
+        # @param (see CCS::Components::GovUK::Tag#initialize)
         #
-        # @option govuk_tag_options [String] :classes additional CSS classes for the tag HTML
-        # @option govuk_tag_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        # @option (see CCS::Components::GovUK::Tag#initialize)
         #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Tag
-        #                                     which can then be rendered on the page
-
-        def govuk_tag(text, colour = nil, **govuk_tag_options)
-          initialise_attributes_and_set_classes(govuk_tag_options, "govuk-tag #{"govuk-tag--#{colour}" if colour}".rstrip)
+        # @return (see CCS::Components::GovUK::Tag#render)
 
-          tag.strong(text, **govuk_tag_options[:attributes])
+        def govuk_tag(text, colour = nil, **options)
+          Components::GovUK::Tag.new(context: self, text: text, colour: colour, **options).render
         end
       end
     end

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

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

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require 'action_view'
-
-require_relative '../shared_methods'
+require_relative '../../components/govuk/warning_text'
 
 module CCS
   module FrontendHelpers
@@ -13,39 +11,18 @@ module CCS
       # {https://design-system.service.gov.uk/components/warning-text GDS - Components - Warning text}
 
       module WarningText
-        include SharedMethods
-        include ActionView::Context
-        include ActionView::Helpers::TagHelper
-        include ActionView::Helpers::TextHelper
-
         # Generates the HTML for the GOV.UK Warning text component
         #
-        # @param text [String] (nil) the text for the warning
-        # @param govuk_warning_text_options [Hash] options that will be used in customising the HTML
+        # @param (see CCS::Components::GovUK::WarningText#initialize)
         #
-        # @option govuk_warning_text_options [String] :classes additional CSS classes for the tag HTML
-        # @option govuk_warning_text_options [String] :icon_fallback_text the fallback text for the icon (default: +'Warning'+)
-        # @option govuk_warning_text_options [Hash] :attributes ({}) any additional attributes that will added as part of the HTML
+        # @option (see CCS::Components::GovUK::WarningText#initialize)
         #
-        # @yield HTML that will be used in the warning text. Ignored if text is passed.
+        # @yield (see CCS::Components::GovUK::WarningText#render)
         #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK Warning text
-        #                                     which can then be rendered on the page
-
-        def govuk_warning_text(text = nil, **govuk_warning_text_options)
-          initialise_attributes_and_set_classes(govuk_warning_text_options, 'govuk-warning-text')
+        # @return (see CCS::Components::GovUK::WarningText#render)
 
-          tag.div(**govuk_warning_text_options[:attributes]) do
-            concat(tag.span('!', class: 'govuk-warning-text__icon'))
-            concat(tag.strong(class: 'govuk-warning-text__text') do
-              concat(tag.span(govuk_warning_text_options[:icon_fallback_text] || 'Warning', class: 'govuk-warning-text__assistive'))
-              if text
-                concat(text)
-              else
-                yield
-              end
-            end)
-          end
+        def govuk_warning_text(text = nil, **options, &block)
+          Components::GovUK::WarningText.new(context: self, text: text, **options).render(&block)
         end
       end
     end

data/lib/ccs/frontend_helpers/govuk_frontend.rb

@@ -4,78 +4,76 @@ require_relative 'govuk_frontend/accordion'
 require_relative 'govuk_frontend/back_link'
 require_relative 'govuk_frontend/breadcrumbs'
 require_relative 'govuk_frontend/button'
+require_relative 'govuk_frontend/character_count'
+require_relative 'govuk_frontend/checkboxes'
 require_relative 'govuk_frontend/cookie_banner'
+require_relative 'govuk_frontend/date_input'
 require_relative 'govuk_frontend/details'
 require_relative 'govuk_frontend/error_message'
 require_relative 'govuk_frontend/error_summary'
-require_relative 'govuk_frontend/field'
-require_relative 'govuk_frontend/field/character_count'
-require_relative 'govuk_frontend/field/checkboxes'
-require_relative 'govuk_frontend/field/date_input'
-require_relative 'govuk_frontend/field/file_upload'
-require_relative 'govuk_frontend/field/input'
-require_relative 'govuk_frontend/field/select'
-require_relative 'govuk_frontend/field/textarea'
-require_relative 'govuk_frontend/field/radios'
 require_relative 'govuk_frontend/fieldset'
+require_relative 'govuk_frontend/file_upload'
 require_relative 'govuk_frontend/footer'
 require_relative 'govuk_frontend/form_group'
 require_relative 'govuk_frontend/header'
 require_relative 'govuk_frontend/hint'
+require_relative 'govuk_frontend/input'
 require_relative 'govuk_frontend/inset_text'
 require_relative 'govuk_frontend/label'
 require_relative 'govuk_frontend/notification_banner'
 require_relative 'govuk_frontend/pagination'
 require_relative 'govuk_frontend/panel'
 require_relative 'govuk_frontend/phase_banner'
+require_relative 'govuk_frontend/radios'
+require_relative 'govuk_frontend/select'
 require_relative 'govuk_frontend/skip_link'
 require_relative 'govuk_frontend/step_by_step_navigation'
 require_relative 'govuk_frontend/summary_list'
 require_relative 'govuk_frontend/table'
 require_relative 'govuk_frontend/tabs'
 require_relative 'govuk_frontend/tag'
+require_relative 'govuk_frontend/textarea'
 require_relative 'govuk_frontend/warning_text'
 
 module CCS
   module FrontendHelpers
     # This module loads in all the GOV.UK Frontend Helper methods.
-    # These are a collection of view helpers to help render GOV.UK components
+    # These are a collection of view  to help render GOV.UK components
 
     module GovUKFrontend
       include Accordion
       include BackLink
       include Breadcrumbs
       include Button
+      include CharacterCount
+      include Checkboxes
       include CookieBanner
+      include DateInput
       include Details
       include ErrorMessage
       include ErrorSummary
-      include Field
-      include Field::CharacterCount
-      include Field::Checkboxes
-      include Field::DateInput
-      include Field::FileUpload
-      include Field::Input
-      include Field::Radios
-      include Field::Select
-      include Field::Textarea
+      include FileUpload
       include Fieldset
       include Footer
       include FormGroup
       include Header
       include Hint
+      include Input
       include InsetText
       include Label
       include NotificationBanner
       include Pagination
       include Panel
       include PhaseBanner
+      include Radios
+      include Select
       include SkipLink
       include StepByStepNavigation
       include SummaryList
       include Table
       include Tabs
       include Tag
+      include Textarea
       include WarningText
     end
   end

data/lib/ccs/frontend_helpers/version.rb

@@ -2,6 +2,6 @@
 
 module CCS
   module FrontendHelpers
-    VERSION = '0.1.0.rc.1'
+    VERSION = '0.1.0.rc.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ccs-frontend_helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.0.rc.1
+  version: 0.1.0.rc.3
 platform: ruby
 authors:
 - tim-s-ccs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -159,6 +159,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -166,49 +167,144 @@ files:
 - README.md
 - Rakefile
 - ccs-frontend_helpers.gemspec
+- lib/ccs/components/base.rb
+- lib/ccs/components/ccs/dashboard_section.rb
+- lib/ccs/components/ccs/dashboard_section/panel.rb
+- lib/ccs/components/ccs/footer.rb
+- lib/ccs/components/ccs/footer/link.rb
+- lib/ccs/components/ccs/footer/meta.rb
+- lib/ccs/components/ccs/footer/navigation.rb
+- lib/ccs/components/ccs/header.rb
+- lib/ccs/components/ccs/header/link.rb
+- lib/ccs/components/ccs/header/navigation.rb
+- lib/ccs/components/ccs/header/service_authentication.rb
+- lib/ccs/components/ccs/logo.rb
+- lib/ccs/components/govuk/accordion.rb
+- lib/ccs/components/govuk/accordion/section.rb
+- lib/ccs/components/govuk/accordion/section/content.rb
+- lib/ccs/components/govuk/accordion/section/header.rb
+- lib/ccs/components/govuk/back_link.rb
+- lib/ccs/components/govuk/breadcrumbs.rb
+- lib/ccs/components/govuk/breadcrumbs/link.rb
+- lib/ccs/components/govuk/button.rb
+- lib/ccs/components/govuk/cookie_banner.rb
+- lib/ccs/components/govuk/cookie_banner/action.rb
+- lib/ccs/components/govuk/cookie_banner/message.rb
+- lib/ccs/components/govuk/details.rb
+- lib/ccs/components/govuk/error_message.rb
+- lib/ccs/components/govuk/error_summary.rb
+- lib/ccs/components/govuk/error_summary/item.rb
+- lib/ccs/components/govuk/field.rb
+- lib/ccs/components/govuk/field/input.rb
+- lib/ccs/components/govuk/field/input/character_count.rb
+- lib/ccs/components/govuk/field/input/file_upload.rb
+- lib/ccs/components/govuk/field/input/select.rb
+- lib/ccs/components/govuk/field/input/text_input.rb
+- lib/ccs/components/govuk/field/input/text_input/fix.rb
+- lib/ccs/components/govuk/field/input/textarea.rb
+- lib/ccs/components/govuk/field/inputs.rb
+- lib/ccs/components/govuk/field/inputs/checkboxes.rb
+- lib/ccs/components/govuk/field/inputs/date_input.rb
+- lib/ccs/components/govuk/field/inputs/date_input/item.rb
+- lib/ccs/components/govuk/field/inputs/item.rb
+- lib/ccs/components/govuk/field/inputs/item/checkbox.rb
+- lib/ccs/components/govuk/field/inputs/item/checkbox/form.rb
+- lib/ccs/components/govuk/field/inputs/item/checkbox/tag.rb
+- lib/ccs/components/govuk/field/inputs/item/divider.rb
+- lib/ccs/components/govuk/field/inputs/item/radio.rb
+- lib/ccs/components/govuk/field/inputs/item/radio/form.rb
+- lib/ccs/components/govuk/field/inputs/item/radio/tag.rb
+- lib/ccs/components/govuk/field/inputs/radios.rb
+- lib/ccs/components/govuk/fieldset.rb
+- lib/ccs/components/govuk/fieldset/legend.rb
+- lib/ccs/components/govuk/footer.rb
+- lib/ccs/components/govuk/footer/link.rb
+- lib/ccs/components/govuk/footer/meta.rb
+- lib/ccs/components/govuk/footer/navigation.rb
+- lib/ccs/components/govuk/form_group.rb
+- lib/ccs/components/govuk/header.rb
+- lib/ccs/components/govuk/header/link.rb
+- lib/ccs/components/govuk/header/navigation.rb
+- lib/ccs/components/govuk/hint.rb
+- lib/ccs/components/govuk/inset_text.rb
+- lib/ccs/components/govuk/label.rb
+- lib/ccs/components/govuk/notification_banner.rb
+- lib/ccs/components/govuk/pagination.rb
+- lib/ccs/components/govuk/pagination/increment.rb
+- lib/ccs/components/govuk/pagination/increment/next.rb
+- lib/ccs/components/govuk/pagination/increment/previous.rb
+- lib/ccs/components/govuk/pagination/item.rb
+- lib/ccs/components/govuk/pagination/item/ellipsis.rb
+- lib/ccs/components/govuk/pagination/item/form.rb
+- lib/ccs/components/govuk/pagination/item/tag.rb
+- lib/ccs/components/govuk/panel.rb
+- lib/ccs/components/govuk/phase_banner.rb
+- lib/ccs/components/govuk/skip_link.rb
+- lib/ccs/components/govuk/step_by_step_navigation.rb
+- lib/ccs/components/govuk/step_by_step_navigation/section.rb
+- lib/ccs/components/govuk/step_by_step_navigation/section/content.rb
+- lib/ccs/components/govuk/step_by_step_navigation/section/content/list.rb
+- lib/ccs/components/govuk/step_by_step_navigation/section/content/list/item.rb
+- lib/ccs/components/govuk/step_by_step_navigation/section/content/paragraph.rb
+- lib/ccs/components/govuk/step_by_step_navigation/section/heading.rb
+- lib/ccs/components/govuk/summary_list.rb
+- lib/ccs/components/govuk/summary_list/action/link.rb
+- lib/ccs/components/govuk/summary_list/card.rb
+- lib/ccs/components/govuk/summary_list/card/actions.rb
+- lib/ccs/components/govuk/summary_list/card/title.rb
+- lib/ccs/components/govuk/summary_list/row.rb
+- lib/ccs/components/govuk/summary_list/row/actions.rb
+- lib/ccs/components/govuk/summary_list/row/key.rb
+- lib/ccs/components/govuk/summary_list/row/value.rb
+- lib/ccs/components/govuk/table.rb
+- lib/ccs/components/govuk/table/body/data_cell.rb
+- lib/ccs/components/govuk/table/body/head_cell.rb
+- lib/ccs/components/govuk/table/header/head_cell.rb
+- lib/ccs/components/govuk/tabs.rb
+- lib/ccs/components/govuk/tabs/panel.rb
+- lib/ccs/components/govuk/tabs/tab.rb
+- lib/ccs/components/govuk/tag.rb
+- lib/ccs/components/govuk/warning_text.rb
 - lib/ccs/frontend_helpers.rb
 - lib/ccs/frontend_helpers/ccs_frontend.rb
-- lib/ccs/frontend_helpers/ccs_frontend/dashboard_panels.rb
+- lib/ccs/frontend_helpers/ccs_frontend/dashboard_section.rb
 - lib/ccs/frontend_helpers/ccs_frontend/footer.rb
 - lib/ccs/frontend_helpers/ccs_frontend/header.rb
-- lib/ccs/frontend_helpers/ccs_frontend/logo.rb
 - lib/ccs/frontend_helpers/govuk_frontend.rb
 - lib/ccs/frontend_helpers/govuk_frontend/accordion.rb
 - lib/ccs/frontend_helpers/govuk_frontend/back_link.rb
 - lib/ccs/frontend_helpers/govuk_frontend/breadcrumbs.rb
 - lib/ccs/frontend_helpers/govuk_frontend/button.rb
+- lib/ccs/frontend_helpers/govuk_frontend/character_count.rb
+- lib/ccs/frontend_helpers/govuk_frontend/checkboxes.rb
 - lib/ccs/frontend_helpers/govuk_frontend/cookie_banner.rb
+- lib/ccs/frontend_helpers/govuk_frontend/date_input.rb
 - lib/ccs/frontend_helpers/govuk_frontend/details.rb
 - lib/ccs/frontend_helpers/govuk_frontend/error_message.rb
 - lib/ccs/frontend_helpers/govuk_frontend/error_summary.rb
-- lib/ccs/frontend_helpers/govuk_frontend/field.rb
-- lib/ccs/frontend_helpers/govuk_frontend/field/character_count.rb
-- lib/ccs/frontend_helpers/govuk_frontend/field/checkboxes.rb
-- lib/ccs/frontend_helpers/govuk_frontend/field/date_input.rb
-- lib/ccs/frontend_helpers/govuk_frontend/field/file_upload.rb
-- lib/ccs/frontend_helpers/govuk_frontend/field/input.rb
-- lib/ccs/frontend_helpers/govuk_frontend/field/radios.rb
-- lib/ccs/frontend_helpers/govuk_frontend/field/select.rb
-- lib/ccs/frontend_helpers/govuk_frontend/field/textarea.rb
 - lib/ccs/frontend_helpers/govuk_frontend/fieldset.rb
+- lib/ccs/frontend_helpers/govuk_frontend/file_upload.rb
 - lib/ccs/frontend_helpers/govuk_frontend/footer.rb
 - lib/ccs/frontend_helpers/govuk_frontend/form_group.rb
 - lib/ccs/frontend_helpers/govuk_frontend/header.rb
 - lib/ccs/frontend_helpers/govuk_frontend/hint.rb
+- lib/ccs/frontend_helpers/govuk_frontend/input.rb
 - lib/ccs/frontend_helpers/govuk_frontend/inset_text.rb
 - lib/ccs/frontend_helpers/govuk_frontend/label.rb
 - lib/ccs/frontend_helpers/govuk_frontend/notification_banner.rb
 - lib/ccs/frontend_helpers/govuk_frontend/pagination.rb
 - lib/ccs/frontend_helpers/govuk_frontend/panel.rb
 - lib/ccs/frontend_helpers/govuk_frontend/phase_banner.rb
+- lib/ccs/frontend_helpers/govuk_frontend/radios.rb
+- lib/ccs/frontend_helpers/govuk_frontend/select.rb
 - lib/ccs/frontend_helpers/govuk_frontend/skip_link.rb
 - lib/ccs/frontend_helpers/govuk_frontend/step_by_step_navigation.rb
 - lib/ccs/frontend_helpers/govuk_frontend/summary_list.rb
 - lib/ccs/frontend_helpers/govuk_frontend/table.rb
 - lib/ccs/frontend_helpers/govuk_frontend/tabs.rb
 - lib/ccs/frontend_helpers/govuk_frontend/tag.rb
+- lib/ccs/frontend_helpers/govuk_frontend/textarea.rb
 - lib/ccs/frontend_helpers/govuk_frontend/warning_text.rb
-- lib/ccs/frontend_helpers/shared_methods.rb
 - lib/ccs/frontend_helpers/version.rb
 - sig/ccs/frontend_helpers.rbs
 homepage: https://github.com/tim-s-ccs/ccs-frontend_helpers

data/lib/ccs/frontend_helpers/ccs_frontend/dashboard_panels.rb

@@ -1,79 +0,0 @@
-# frozen_string_literal: true
-
-require 'action_view'
-
-require_relative '../shared_methods'
-
-module CCS
-  module FrontendHelpers
-    module CCSFrontend
-      # = CCS Dashboard Panels
-      #
-      # This helper is used for generating the dashboard panels component
-
-      module DashboardPanels
-        include SharedMethods
-        include ActionView::Context
-        include ActionView::Helpers::TagHelper
-        include ActionView::Helpers::TextHelper
-        include ActionView::Helpers::UrlHelper
-
-        # Generates the HTML for the CCS Dashboard Panels component
-        #
-        # @param panel_items [Array] the panel items, see {ccs_dashboard_panels_item}
-        # @param title_text [String] text for the title of a dashboard panels section
-        # @param ccs_dashboard_panels_options [Hash] options that will be used in customising the HTML
-        #
-        # @option ccs_dashboard_panels_options [String] :classes additional CSS classes for the dashboard panels HTML
-        # @option ccs_dashboard_panels_options [String] :width (default: 'full') the width of the dashbaord panel section
-        # @option ccs_dashboard_panels_options [Hash] :attributes additional attributes that will added as part of the HTML
-        #
-        # @return [ActiveSupport::SafeBuffer] the HTML for the CCS Dashboard Panels
-        #                                     which can then be rendered on the page
-
-        def ccs_dashboard_panels(panel_items, title_text = nil, **ccs_dashboard_panels_options)
-          initialise_attributes_and_set_classes(ccs_dashboard_panels_options, 'ccs-dashboard-panels')
-
-          tag.div(**ccs_dashboard_panels_options[:attributes]) do
-            tag.div(class: 'govuk-grid-row') do
-              tag.div(class: "govuk-grid-column-#{ccs_dashboard_panels_options[:width] || 'full'}") do
-                if title_text
-                  concat(tag.h2(title_text, class: 'ccs-dashboard-panels__heading govuk-heading-m'))
-                  concat(tag.hr(class: 'ccs-dashboard-panels__heading-section-break govuk-section-break govuk-section-break--visible'))
-                end
-                concat(tag.div(class: 'ccs-dashboard-panels__container') do
-                  tag.div(class: 'govuk-grid-row') do
-                    panel_items.each { |panel_item| concat(ccs_dashboard_panels_item(panel_item)) }
-                  end
-                end)
-              end
-            end
-          end
-        end
-
-        private
-
-        # Generates the HTML for the a dashboard panel item in {ccs_dashboard_panels}
-        #
-        # @param panel_item [Hash] options for the dashboard panel item
-        #
-        # @option panel_item [String] :title the title for the dashboard panel
-        # @option panel_item [String] :href the href for the dashboard panel
-        # @option panel_item [String] :description the description text for the dashboard panel
-        # @option panel_item [String] :width (default: 'one-third') the width of the dashboard panel item
-        # @option panel_item [Hash] :attributes additional attributes that will added as part of the HTML
-        #
-        # @return [ActiveSupport::SafeBuffer] the HTML for a panel item in {ccs_dashboard_panels}
-
-        def ccs_dashboard_panels_item(panel_item)
-          (panel_item[:attributes] ||= {})[:class] = "ccs-dashboard-panels__item govuk-grid-column-#{panel_item[:width] || 'one-third'}"
-
-          tag.div(**panel_item[:attributes]) do
-            concat(link_to(panel_item[:title], panel_item[:href], class: 'ccs-dashboard-panels__item-title'))
-            concat(tag.p(panel_item[:description], class: 'ccs-dashboard-panels__item-description'))
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,165 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'textarea'
-
-module CCS
-  module FrontendHelpers
-    module GovUKFrontend
-      module Field
-        # = GOV.UK Character count
-        #
-        # This helper is used for generating the character count component from the
-        # {https://design-system.service.gov.uk/components/character-count GDS - Components - Character count}
-        #
-        # This is a wrapper around a Textarea module and so makes use of the methods in {Textarea}
-
-        module CharacterCount
-          include Textarea
-
-          # Generates the HTML for the GOV.UK character count component.
-          # It works by warpping the govuk_textarea in HTML which will trigger the JavaScript to do the character count.
-          #
-          # @param attribute [String, Symbol] the attribute of the character count text area
-          # @param govuk_character_count_options [Hash] options that will be used for the parts of the form group, label, hint, textarea and the character count
-          #
-          # @option govuk_character_count_options [String] :error_message (nil) the error message to be displayed
-          # @option govuk_character_count_options [ActiveModel] :model (nil) optional model that can be used to find an error message
-          # @option govuk_character_count_options [ActionView::Helpers::FormBuilder] :form (nil) optional form builder used to create
-          #                                                                                 the textarea tag and find the error message
-          # @option govuk_character_count_options [Hash] :form_group see {govuk_field}
-          # @option govuk_character_count_options [Hash] :label see {govuk_field}
-          # @option govuk_character_count_options [Hash] :hint see {govuk_field}
-          # @option govuk_character_count_options [Hash] :textarea see {govuk_textarea}
-          # @option govuk_character_count_options [Hash] :character_count ({}) the options that will be used when rendering the textarea.
-          #                                                                    See {_govuk_character_count} for more details.
-          #
-          # @return [ActiveSupport::SafeBuffer] the HTML for the GOV.UK chracter count
-          #                                     which can then be rendered on the page
-
-          def govuk_character_count(attribute, **govuk_character_count_options)
-            character_count_attribute = govuk_character_count_options[:form] ? "#{form.object_name}_#{attribute}" : attribute
-
-            _govuk_character_count(character_count_attribute, **govuk_character_count_options) do |govuk_textarea_options|
-              govuk_textarea(
-                attribute,
-                error_message: govuk_character_count_options[:error_message],
-                model: govuk_character_count_options[:model],
-                form: govuk_character_count_options[:form],
-                **govuk_textarea_options
-              )
-            end
-          end
-
-          private
-
-          # Wrapper method used by {govuk_character_count} to generate the character count HTML
-          #
-          # @param attribute [String, Symbol] the attribute of the character count
-          # @param govuk_character_count_options [Hash] options that will be used in customising the HTML.
-          #                                             This includes everything described in {govuk_character_count}
-          #                                             with the addition of the +:character_count+ which are described below
-          #
-          # @option govuk_character_count_options [String] :maxlength (required) - if +maxwords+ is set, this is not required.
-          #                                                           The maximum number of characters.
-          #                                                           If +maxwords+ is provided, the +maxlength+ option will be ignored.
-          # @option govuk_character_count_options [String] :maxwords (required) - if maxlength is set, this is not required.
-          #                                                          The maximum number of words.
-          #                                                          If +maxwords+ is provided, the +maxlength+ option will be ignored.
-          # @option govuk_character_count_options [String] :threshold the percentage value of the limit at which point the count message is displayed.
-          #                                                           If this attribute is set, the count message will be hidden by default.
-          # @option govuk_textarea_options [Hash] :fallback_hint ({}) additional parameters that will be used to create the hint containing the character count text.
-          #                                                                This includes all the options in {govuk_hint} plus +:count_message+.
-          #                                                                This will replace the default text for the count message.
-          #                                                                If you want the count number to appear, put %<count>s in the string and it will be replaced with the number
-          #
-          # @yield the textarea HTML generated by {govuk_character_count}
-          #
-          # @yieldparam govuk_textarea_options [Hash] the options used in the textarea called by {govuk_character_count}
-          #
-          # @return [ActiveSupport::SafeBuffer] the HTML for the chracter count which wrpas arround {govuk_character_count}
-
-          def _govuk_character_count(attribute, **govuk_character_count_options)
-            deep_init_hash(govuk_character_count_options, :textarea, :attributes, :aria)
-            govuk_character_count_options[:textarea][:attributes][:aria][:describedby] = [govuk_character_count_options.dig(:textarea, :attributes, :aria, :describedby), "#{attribute}-info"].compact.join(' ')
-
-            govuk_character_count_options[:textarea][:classes] = "#{govuk_character_count_options[:textarea][:classes]} govuk-js-character-count".lstrip
-
-            tag.div(**get_character_count_attributes(**govuk_character_count_options)) do
-              concat(yield(govuk_character_count_options))
-              concat(character_count_hint(attribute, **govuk_character_count_options))
-            end
-          end
-
-          # Generates the fallback hint HTML for {_govuk_character_count}
-          #
-          # @param (see _govuk_character_count)
-          #
-          # @option (see _govuk_character_count)
-          #
-          # @return [ActiveSupport::SafeBuffer] the HTML for the fullback hint used in {_govuk_character_count}
-
-          def character_count_hint(attribute, **govuk_character_count_options)
-            fallback_hint_length = govuk_character_count_options[:character_count][:maxwords] || govuk_character_count_options[:character_count][:maxlength]
-            fallback_hint_default = "You can enter up to %<count>s #{govuk_character_count_options[:character_count][:maxwords] ? 'words' : 'characters'}"
-
-            deep_init_hash(govuk_character_count_options, :character_count, :fallback_hint, :attributes)
-
-            fallback_hint_text = format(govuk_character_count_options[:character_count][:fallback_hint][:count_message] || fallback_hint_default, count: fallback_hint_length)
-
-            govuk_character_count_options[:character_count][:fallback_hint][:classes] = "#{govuk_character_count_options.dig(:character_count, :fallback_hint, :classes)} govuk-character-count__message".lstrip
-            govuk_character_count_options[:character_count][:fallback_hint][:attributes].merge!(id: "#{attribute}-info")
-
-            govuk_hint(fallback_hint_text, **govuk_character_count_options[:character_count][:fallback_hint])
-          end
-
-          # Generates a hash with the character count attributes used in {_govuk_character_count}
-          #
-          # @param govuk_character_count_options [Hash] options that will be used in customising the HTML.
-          #                                             This includes everything described in {govuk_character_count}
-          #                                             with the addition of the +:character_count+ which are described below
-          #
-          # @option (see _govuk_character_count)
-          #
-          # @return [Hash] contains the HTMl attributes used in {_govuk_character_count}
-
-          def get_character_count_attributes(**govuk_character_count_options)
-            govuk_character_count_attributes = { class: 'govuk-character-count', data: { module: 'govuk-character-count' } }
-
-            %i[maxlength threshold maxwords].each do |data_attribute|
-              govuk_character_count_attributes[:data][data_attribute] = govuk_character_count_options[:character_count][data_attribute].to_s if govuk_character_count_options[:character_count][data_attribute]
-            end
-
-            govuk_character_count_attributes
-          end
-
-          # Method to initialise hashes within hashes if it is not already initialised
-          #
-          # @param hash [Hash] the hash that is going to be initialised
-          # @param keys [Array] the keys that are going to be initialised in the hash
-          #
-          # @example When the hash is completely empty
-          #   hash = { }
-          #   keys = [:a, :b, :c]
-          #
-          #   deep_init_hash(hash, *keys)
-          #
-          #   hash = { a: { b: { c: { } } } }
-          #
-          # @example When the hash has already been initialised
-          #   hash = { a: { b: { d: 'hello' } } }
-          #   keys = [:a, :b, :c]
-          #
-          #   deep_init_hash(hash, *keys)
-          #
-          #   hash = { a: { b: { d: 'hello', c: { } } } }
-
-          def deep_init_hash(hash, *keys)
-            current_hash = hash
-
-            keys.each { |key| current_hash = (current_hash[key] ||= {}) }
-          end
-        end
-      end
-    end
-  end
-end