ccs-frontend_helpers 0.1.2 → 0.2.0

data/lib/ccs/components/govuk/pagination/increment.rb

@@ -11,6 +11,8 @@ module CCS
         # @!attribute [r] type
         #   @return [Symbol] The type of pagination increment
         # @!attribute [r] text
+        #   @return [String] Default text for the pagination increment
+        # @!attribute [r] default_text
         #   @return [String] Text for the pagination increment
         # @!attribute [r] block_is_level
         #   @return [Boolean] Flag to indicate if previous and next blocks are level
@@ -20,11 +22,14 @@ module CCS
         class Increment < Base
           private
 
-          attr_reader :type, :text, :block_is_level, :label_text
+          attr_reader :type, :default_text, :text, :block_is_level, :label_text
 
           public
 
+          # rubocop:disable Metrics/ParameterLists
+
           # @param type [Symbol] the type of increment, either +:prev+ or +:next+
+          # @param default_text [String] the default text for the pagination increment
           # @param text [String] the text for the pagination increment
           # @param block_is_level [Boolean] when there are no items, this will be true and will add extra classes
           #                                 to the link to make the next and previous pagination links level
@@ -35,18 +40,21 @@ module CCS
           # @option options  [ActionView::Helpers::FormBuilder] :form optional form builder used to create the button
           # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
 
-          def initialize(type:, text:, block_is_level:, label_text: nil, **options)
+          def initialize(type:, default_text:, block_is_level:, text: nil, label_text: nil, **options)
             super(**options)
 
             @options[:attributes][:class] = "govuk-link govuk-pagination__link #{'pagination--button_as_link' if @options[:form]}".rstrip
             @options[:attributes][:rel] = type.to_s
 
             @type = type
-            @text = text
+            @default_text = default_text
+            @text = text || default_text
             @block_is_level = block_is_level
             @label_text = label_text
           end
 
+          # rubocop:enable Metrics/ParameterLists
+
           # Generates the HTML for the pagination increment link/button
           #
           # @yield the HTML for the increment button/link

data/lib/ccs/components/govuk/pagination/item.rb

@@ -24,7 +24,7 @@ module CCS
           # @param current [Boolean] flag to indicate if this item is the current page
           #
           # @option options [String] :classes additional CSS classes for the item HTML
-          # @option options [Symbol] :type the type of item. If the value is +:ellipsis+ then an ellipsis will be rendered
+          # @option options [Boolean] :ellipsis If the value is +true+ then an ellipsis will be rendered
           # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
 
           def initialize(number:, current: false, **options)

data/lib/ccs/components/govuk/pagination.rb

@@ -47,7 +47,7 @@ module CCS
 
           @options[:attributes][:class] << ' govuk-pagination--block' if block_is_level
           @options[:attributes][:role] = 'navigation'
-          (@options[:attributes][:aria] ||= {})[:label] ||= 'results'
+          (@options[:attributes][:aria] ||= {})[:label] ||= 'Pagination'
 
           @pagination_previous = Increment::Previous.new(block_is_level: block_is_level, form: @options[:form], context: @context, **pagination_previous) if pagination_previous
           @pagination_next = Increment::Next.new(block_is_level: block_is_level, form: @options[:form], context: @context, **pagination_next) if pagination_next
@@ -88,7 +88,7 @@ module CCS
 
           pagination_item_class = form ? Item::Form : Item::Tag
 
-          @pagination_items = pagination_items.map { |pagination_item| pagination_item[:type] == :ellipsis ? Item::Ellipsis : pagination_item_class.new(form: form, context: context, **pagination_item) }
+          @pagination_items = pagination_items.map { |pagination_item| pagination_item[:ellipsis] ? Item::Ellipsis : pagination_item_class.new(form: form, context: context, **pagination_item) }
         end
       end
     end

data/lib/ccs/components/govuk/summary_list/action/link.rb

@@ -13,28 +13,32 @@ module CCS
           #   @return [String] The href for the action link
           # @!attribute [r] visually_hidden_text
           #   @return [String] Visually hidden text for the action link
+          # @!attribute [r] card_title
+          #   @return [String] Card title text for the action link
 
           class Link < Base
             private
 
-            attr_reader :text, :href, :visually_hidden_text
+            attr_reader :text, :href, :visually_hidden_text, :card_title
 
             public
 
             # @param text [String] the text for the action link
             # @param href [String] the href for the action link
             # @param visually_hidden_text [String] optional visually hidden text for the action link
+            # @param card_title [String] card title text for the action link
             # @param options [Hash] options that will be used in customising the HTML
             #
             # @option options [String] :classes additional CSS classes for the summary list action link HTML
             # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
 
-            def initialize(text:, href:, visually_hidden_text: nil, **options)
+            def initialize(text:, href:, visually_hidden_text: nil, card_title: nil, **options)
               super(**options)
 
               @text = text
               @href = href
               @visually_hidden_text = visually_hidden_text
+              @card_title = card_title
             end
 
             # Generates the HTML for the GOV.UK Summary list action link
@@ -44,7 +48,18 @@ module CCS
             def render
               link_to(href, **@options[:attributes]) do
                 concat(text)
-                concat(tag.span(visually_hidden_text, class: 'govuk-visually-hidden')) if visually_hidden_text
+                if visually_hidden_text.present? || card_title.present?
+                  concat(tag.span(class: 'govuk-visually-hidden') do
+                    if visually_hidden_text
+                      concat(' ')
+                      concat(visually_hidden_text)
+                    end
+                    if card_title
+                      concat(' ')
+                      concat("(#{card_title})")
+                    end
+                  end)
+                end
               end
             end
 

data/lib/ccs/components/govuk/summary_list/card/actions.rb

@@ -20,14 +20,15 @@ module CCS
 
             # @param items [Array<Hash>] An array of attributes for the action links.
             #                            See {Components::GovUK::SummaryList::Action::Link#initialize Action::Link#initialize} for details of the items in the array.
+            # @param card_title [String] the text for the card title
             # @param options [Hash] options that will be used in customising the HTML
             #
             # @option options [String] :classes additional CSS classes for the summary list card actions HTML
 
-            def initialize(items:, **options)
+            def initialize(items:, card_title:, **options)
               super(**options)
 
-              @action_links = items.map { |item| Action::Link.new(context: @context, **item) }
+              @action_links = items.map { |item| Action::Link.new(context: @context, card_title: card_title, **item) }
             end
 
             # Generates the HTML for the GOV.UK Summary list card actions

data/lib/ccs/components/govuk/summary_list/card.rb

@@ -34,7 +34,7 @@ module CCS
             super(**options)
 
             @title = Title.new(context: @context, **title) if title
-            @actions = Actions.new(context: @context, **actions) if actions
+            @actions = Actions.new(context: @context, card_title: title&.dig(:text), **actions) if actions
           end
 
           # Generates the HTML for the GOV.UK Summary card

data/lib/ccs/components/govuk/summary_list/row/actions.rb

@@ -20,14 +20,15 @@ module CCS
 
             # @param items [Array<Hash>] An array of attributes for the action links.
             #                            See {Components::GovUK::SummaryList::Action::Link#initialize Action::Link#initialize} for details of the items in the array.
+            # @param card_title [String] the text for the card title
             # @param options [Hash] options that will be used in customising the HTML
             #
             # @option options [String] :classes additional CSS classes for the summary list row actions HTML
 
-            def initialize(items:, **options)
+            def initialize(items:, card_title: nil, **options)
               super(**options)
 
-              @action_links = items.map { |item| Action::Link.new(context: @context, **item) }
+              @action_links = items.map { |item| Action::Link.new(card_title: card_title, context: @context, **item) }
             end
 
             # Generates the HTML for the GOV.UK Summary list row actions

data/lib/ccs/components/govuk/summary_list/row.rb

@@ -25,15 +25,18 @@ module CCS
 
           public
 
+          # rubocop:disable Metrics/ParameterLists
+
           # @param any_row_has_actions [Boolean] flag to indicate if any rows have actions
           # @param key [Hash] attributes for the key, see {CCS::Components::GovUK::SummaryList::Row::Key#initialize Key#initialize} for more details.
           # @param value [Hash] attributes for the value, see {CCS::Components::GovUK::SummaryList::Row::Value#initialize Value#initialize} for more details.
           # @param actions [Hash] attributes for the actions, see {CCS::Components::GovUK::SummaryList::Row::Actions#initialize Actions#initialize} for more details.
+          # @param card_title [String] the text for the card title
           # @param options [Hash] options that will be used in customising the HTML
           #
           # @option options [String] :classes additional CSS classes for the summary list row HTML
 
-          def initialize(any_row_has_actions:, key:, value:, actions: nil, **options)
+          def initialize(any_row_has_actions:, key:, value:, actions: nil, card_title: nil, **options)
             super(**options)
 
             actions_present = actions && actions[:items].present?
@@ -42,9 +45,11 @@ module CCS
 
             @key = Key.new(context: @context, **key)
             @value = Value.new(context: @context, **value)
-            @actions = Actions.new(context: @context, **actions) if actions_present
+            @actions = Actions.new(context: @context, card_title: card_title, **actions) if actions_present
           end
 
+          # rubocop:enable Metrics/ParameterLists
+
           # Generates the HTML for the GOV.UK Summary list row
           #
           # @return [ActiveSupport::SafeBuffer]

data/lib/ccs/components/govuk/summary_list.rb

@@ -35,7 +35,7 @@ module CCS
 
           any_row_has_actions = summary_list_items.any? { |summary_list_item| summary_list_item.dig(:actions, :items).present? }
 
-          @summary_list_rows = summary_list_items.map { |summary_list_item| Row.new(any_row_has_actions: any_row_has_actions, context: @context, **summary_list_item) }
+          @summary_list_rows = summary_list_items.map { |summary_list_item| Row.new(any_row_has_actions: any_row_has_actions, card_title: card&.dig(:title, :text), context: @context, **summary_list_item) }
           @card = Card.new(context: @context, **card) if card
         end
 

data/lib/ccs/components/govuk/tabs.rb

@@ -50,9 +50,11 @@ module CCS
         def render
           tag.div(**options[:attributes]) do
             concat(tag.h2(title, class: 'govuk-tabs__title'))
-            concat(tag.ul(class: 'govuk-tabs__list') do
-              @tabs.each { |tab| concat(tab.render) }
-            end)
+            if @tabs.present?
+              concat(tag.ul(class: 'govuk-tabs__list') do
+                @tabs.each { |tab| concat(tab.render) }
+              end)
+            end
             @panels.each { |panel| concat(panel.render) }
           end
         end

data/lib/ccs/components/govuk/task_list/item/status.rb

@@ -0,0 +1,64 @@
+require_relative '../../../base'
+require_relative '../../tag'
+
+module CCS
+  module Components
+    module GovUK
+      class TaskList < Base
+        class Item < Base
+          # = GOV.UK Task list item status
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the status
+          # @!attribute [r] tag_component
+          #   @return [Tag] Tag for the status
+
+          class Status < Base
+            private
+
+            attr_reader :tag_component, :text
+
+            public
+
+            # @param id_prefix [String] the id prefix for the task list item
+            # @param tag_options [Hash] paramters for the govuk tag (see {Components::GovUK::Tag Tag}).
+            #                   options are:
+            #                   - +text+
+            #                   - +colour+
+            #                   - +options+
+            # @param text [String] the text for the status. If tag is nil then this is used
+            # @param options [Hash] options that will be used in customising the HTML
+            #
+            # @option options [String] :classes additional CSS classes for the task list row status HTML
+
+            def initialize(id_prefix:, tag_options: nil, text: nil, **options)
+              super(**options)
+              @options[:attributes][:id] = "#{id_prefix}-status"
+
+              @text = text
+              @tag_component = Tag.new(context: @context, **tag_options) if tag_options
+            end
+
+            # Generates the HTML for the GOV.UK Task list item status
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              tag.div(class: @options[:attributes][:class], id: @options[:attributes][:id]) do
+                if tag_component
+                  tag_component.render
+                else
+                  text
+                end
+              end
+            end
+
+            # The default attributes for the task list item status
+
+            DEFAULT_ATTRIBUTES = { class: 'govuk-task-list__status' }.freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/task_list/item/title.rb

@@ -0,0 +1,54 @@
+require_relative '../../../base'
+
+module CCS
+  module Components
+    module GovUK
+      class TaskList < Base
+        class Item < Base
+          # = GOV.UK Task list item title
+          #
+          # @!attribute [r] text
+          #   @return [String] Text for the title
+          # @!attribute [r] href
+          #   @return [String] Optional link for the title
+
+          class Title < Base
+            private
+
+            attr_reader :text, :href
+
+            public
+
+            # @param text [String] the text for the title
+            # @param id_prefix [String] the id prefix for the task list item
+            # @param href [String] optional link for the title
+            # @param hint_text [String] flag to indicate if there is a hint
+            # @param options [Hash] options that will be used in customising the HTML
+            #
+            # @option options [String] :classes additional CSS classes for the task list item title HTML
+
+            def initialize(text:, id_prefix:, href: nil, hint_text: nil, **options)
+              super(**options)
+              @options[:attributes][:aria] = { describedby: (hint_text ? "#{id_prefix}-hint " : '') + "#{id_prefix}-status" } if href
+
+              @text = text
+              @href = href
+            end
+
+            # Generates the HTML for the GOV.UK Task list item title
+            #
+            # @return [ActiveSupport::SafeBuffer]
+
+            def render
+              if href
+                link_to(text, href, class: "govuk-link govuk-task-list__link #{@options[:attributes][:class]}".rstrip, aria: { describedby: @options[:attributes][:aria][:describedby] })
+              else
+                tag.div(text, class: @options[:attributes][:class])
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/task_list/item.rb

@@ -0,0 +1,75 @@
+require_relative '../../base'
+require_relative 'item/title'
+require_relative 'item/status'
+
+module CCS
+  module Components
+    module GovUK
+      class TaskList < Base
+        # = GOV.UK Task list item
+        #
+        # The individual list item for the task list
+        #
+        # @!attribute [r] title
+        #   @return [Title] Initialised task list item title
+        # @!attribute [r] status
+        #   @return [Status] Initialised task list item status
+        # @!attribute [r] hint_text
+        #   @return [String] optional hint text for the item
+        # @!attribute [r] id_prefix
+        #   @return [String] ID prefix for the task list item
+
+        class Item < Base
+          private
+
+          attr_reader :id_prefix, :title, :hint_text, :status
+
+          public
+
+          # rubocop:disable Metrics/ParameterLists
+
+          # @param title [Hash] options for the item title.
+          #                     See {Components::GovUK::TaskList::Item::Title#initialize Title#initialize} for details of title.
+          # @param status [Hash] options for the item status.
+          #                     See {Components::GovUK::TaskList::Item::Status#initialize Status#initialize} for details of status.
+          # @param index [Integer] the index of the item
+          # @param id_prefix [String] the id prefix for the task list
+          # @param hint_text [String] optional hint text for the item
+          # @param options [Hash] options that will be used in customising the HTML
+          #
+          # @option options [String] :classes additional CSS classes for the task list item HTML
+
+          def initialize(title:, status:, index:, id_prefix:, hint_text: nil, **options)
+            super(**options)
+            @options[:attributes][:class] << ' govuk-task-list__item--with-link' if title[:href]
+
+            @id_prefix = "#{id_prefix}-#{index}"
+            @title = Title.new(context: @context, id_prefix: @id_prefix, hint_text: hint_text, **title)
+            @hint_text = hint_text
+            @status = Status.new(context: @context, id_prefix: @id_prefix, **status)
+          end
+
+          # rubocop:enable Metrics/ParameterLists
+
+          # Generates the HTML for the GOV.UK Task list item
+          #
+          # @return [ActiveSupport::SafeBuffer]
+
+          def render
+            tag.li(class: options[:attributes][:class]) do
+              concat(tag.div(class: 'govuk-task-list__name-and-hint') do
+                concat(title.render)
+                concat(tag.div(hint_text, class: 'govuk-task-list__hint', id: "#{id_prefix}-hint")) if hint_text
+              end)
+              concat(status.render)
+            end
+          end
+
+          # The default attributes for the task list item
+
+          DEFAULT_ATTRIBUTES = { class: 'govuk-task-list__item' }.freeze
+        end
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/task_list.rb

@@ -0,0 +1,52 @@
+require_relative '../base'
+require_relative 'task_list/item'
+
+module CCS
+  module Components
+    module GovUK
+      # = GOV.UK Task list
+      #
+      # This is used to generate the task list component from the
+      # {https://design-system.service.gov.uk/components/task-list GDS - Components - Task list}
+      #
+      # @!attribute [r] task_list_items
+      #   @return [Array<Link>] An array of the initialised task list items
+
+      class TaskList < Base
+        private
+
+        attr_reader :task_list_items
+
+        public
+
+        # @param task_list_items [Array<Hash>] An array of task list items.
+        #                                      See {Components::GovUK::TaskList::Item#initialize Item#initialize} for details of the items in the array.
+        # @param options [Hash] options that will be used in customising the HTML
+        #
+        # @option options [String] :classes additional CSS classes for the task list HTML
+        # @option options [Sting] :id_prefix id prefix for the task list, defaults to +'task-list'+
+        # @option options [Hash] :attributes any additional attributes that will added as part of the HTML
+
+        def initialize(task_list_items:, id_prefix: nil, **options)
+          super(**options)
+
+          @task_list_items = task_list_items.map.with_index(1) { |task_list_item, index| Item.new(context: @context, index: index, id_prefix: id_prefix || 'task-list', **task_list_item) }
+        end
+
+        # Generates the HTML for the GOV.UK task list component
+        #
+        # @return [ActiveSupport::SafeBuffer]
+
+        def render
+          tag.ul(**options[:attributes]) do
+            task_list_items.each { |task_list_item| concat(task_list_item.render) }
+          end
+        end
+
+        # The default attributes for the task list
+
+        DEFAULT_ATTRIBUTES = { class: 'govuk-task-list' }.freeze
+      end
+    end
+  end
+end

data/lib/ccs/components/govuk/warning_text.rb

@@ -42,7 +42,7 @@ module CCS
           tag.div(**options[:attributes]) do
             concat(tag.span('!', class: 'govuk-warning-text__icon', aria: { hidden: true }))
             concat(tag.strong(class: 'govuk-warning-text__text') do
-              concat(tag.span(options[:icon_fallback_text] || 'Warning', class: 'govuk-warning-text__assistive'))
+              concat(tag.span(options[:icon_fallback_text] || 'Warning', class: 'govuk-visually-hidden'))
               if text
                 concat(text)
               else

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

@@ -19,7 +19,7 @@ module CCS
         #
         # @return (see CCS::Components::GovUK::Input::CharacterCount#render)
 
-        def govuk_character_count(attribute, character_count_options, **options)
+        def govuk_character_count(attribute, character_count_options = {}, **options)
           Components::GovUK::Field::Input::CharacterCount.new(context: self, attribute: attribute, character_count_options: character_count_options, **options).render
         end
       end

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

@@ -19,7 +19,7 @@ module CCS
         #
         # @return (see CCS::Components::GovUK::ErrorMessage#render)
 
-        def govuk_error_message(error_message, attribute, **options)
+        def govuk_error_message(error_message, attribute = nil, **options)
           Components::GovUK::ErrorMessage.new(context: self, message: error_message, attribute: attribute, **options).render
         end
 

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../../components/govuk/exit_this_page'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Exit this page
+      #
+      # This is used to generate the exit this page component from the
+      # {https://design-system.service.gov.uk/components/exit-this-page GDS - Components - Exit this page}
+
+      module ExitThisPage
+        # Generates the HTML for the GOV.UK Exit this page component
+        #
+        # @param (see CCS::Components::GovUK::ExitThisPage#initialize)
+        #
+        # @option (see CCS::Components::GovUK::ExitThisPage#initialize)
+        #
+        # @return (see CCS::Components::GovUK::ExitThisPage#render)
+
+        def govuk_exit_this_page(text = nil, redirect_url = nil, **options)
+          Components::GovUK::ExitThisPage.new(context: self, text: text, redirect_url: redirect_url, **options).render
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../../components/govuk/task_list'
+
+module CCS
+  module FrontendHelpers
+    module GovUKFrontend
+      # = GOV.UK Task list
+      #
+      # This helper is used for generating the task list component from the
+      # {https://design-system.service.gov.uk/components/task-list GDS - Components - Task list}
+
+      module TaskList
+        # Generates the HTML for the GOV.UK Task list component
+        #
+        # @param (see CCS::Components::GovUK::TaskList#initialize)
+        #
+        # @option (see CCS::Components::GovUK::TaskList#initialize)
+        #
+        # @return (see CCS::Components::GovUK::TaskList#render)
+
+        def govuk_task_list(task_list_items, **options)
+          Components::GovUK::TaskList.new(context: self, task_list_items: task_list_items, **options).render
+        end
+      end
+    end
+  end
+end

data/lib/ccs/frontend_helpers/govuk_frontend.rb

@@ -11,6 +11,7 @@ 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/exit_this_page'
 require_relative 'govuk_frontend/fieldset'
 require_relative 'govuk_frontend/file_upload'
 require_relative 'govuk_frontend/footer'
@@ -32,6 +33,7 @@ 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/task_list'
 require_relative 'govuk_frontend/textarea'
 require_relative 'govuk_frontend/warning_text'
 
@@ -52,6 +54,7 @@ module CCS
       include Details
       include ErrorMessage
       include ErrorSummary
+      include ExitThisPage
       include FileUpload
       include Fieldset
       include Footer
@@ -73,6 +76,7 @@ module CCS
       include Table
       include Tabs
       include Tag
+      include TaskList
       include Textarea
       include WarningText
     end

data/lib/ccs/frontend_helpers/version.rb

@@ -2,6 +2,6 @@
 
 module CCS
   module FrontendHelpers
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

data/package.json

@@ -0,0 +1,10 @@
+{
+  "private": true,
+  "name": "ccs-frontend_helpers",
+  "version": "0.0.0",
+  "author": "CCS",
+  "license": "MIT",
+  "devDependencies": {
+    "govuk-frontend": "^5.2.0"
+  }
+}

data/yarn.lock

@@ -0,0 +1,8 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+govuk-frontend@^5.2.0:
+  version "5.2.0"
+  resolved "https://registry.yarnpkg.com/govuk-frontend/-/govuk-frontend-5.2.0.tgz#f8e0bf98b771b8ee1501fd45bbba24a091f3846d"
+  integrity sha512-beD3wztHpkKz6JUpPwnwop1ejb4rTFMPLCutKLCIDmUS4BPpW59ggVUfctsRqHd2Zjw9wxljdRdeIJ8AZFyyTw==