govuk-components 5.0.0 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48254d17c646e2b01105ded5e6e439027fc60ff451c1e33f01c03f9922f58975
-  data.tar.gz: e9502d4077f983dd0f4ca33fec2cf101c34a7f1973943c9b77f5f43eb2af3656
+  metadata.gz: 8ea92186b060054ebbab68352b115d86c1a051ac637fa6cb2baf16299a0e1c9e
+  data.tar.gz: 4e230e506c271f6c905ae11f1b9703449d9cff10385b9722643865b55e135377
 SHA512:
-  metadata.gz: 44e7aa296d43612ca4f31437239ce4445fc6ff4559a024e196b571cc3e4fb27db37ef785a3da3ba578b230caf6b3c4e859d0a654e71dce79fc344b5c95b07341
-  data.tar.gz: bdfb0aa85989f7453f71f956a9c27998d40a217cd3180d51263f69bd13d3feb5cdae1d64443779388d34088bc0d54b4da55c0a6c4cca7a14e24c1efd6d864b9a
+  metadata.gz: ad1b1774616a6345aacda5a61d92d7a11f4074d72eb00a86f055db0ad1d77f98485b843892d1f482fa231513f9a163b01bbb54e07b5be44e58e0c8884a6cf8a3
+  data.tar.gz: 773ab4a3aa83dc5eff40e946ceea1a9fda5d414cbabcaf8bd3838140cc0525ea97b151b3d7b98bca6e638be820ee7b133cd8a9089c8b7dce2485a9319866bcac

data/README.md

@@ -6,7 +6,7 @@
 [![Gem](https://img.shields.io/gem/dt/govuk-components?logo=rubygems)](https://rubygems.org/gems/govuk-components)
 [![Test coverage](https://api.codeclimate.com/v1/badges/cbcbc140f300b920d833/test_coverage)](https://codeclimate.com/github/x-govuk/govuk-components/test_coverage)
 [![Licence](https://img.shields.io/github/license/x-govuk/govuk-components)](https://github.com/x-govuk/govuk-components/blob/main/LICENSE.txt)
-[![GOV.UK Design System version](https://img.shields.io/badge/GOV.UK%20Design%20System-4.7.0-brightgreen)](https://design-system.service.gov.uk)
+[![GOV.UK Design System version](https://img.shields.io/badge/GOV.UK%20Design%20System-5.0.0-brightgreen)](https://design-system.service.gov.uk)
 [![ViewComponent](https://img.shields.io/badge/ViewComponent-3.3.0-brightgreen)](https://viewcomponent.org/)
 [![Rails](https://img.shields.io/badge/Rails-7.0.8%20%E2%95%B1%207.1.0-E16D6D)](https://weblog.rubyonrails.org/releases/)
 [![Ruby](https://img.shields.io/badge/Ruby-3.0.6%20%20%E2%95%B1%203.1.4%20%20%E2%95%B1%203.2.2-E16D6D)](https://www.ruby-lang.org/en/downloads/)

data/app/components/govuk_component/accordion_component.rb

@@ -3,7 +3,7 @@ class GovukComponent::AccordionComponent < GovukComponent::Base
     GovukComponent::AccordionComponent::SectionComponent.new(
       classes: classes,
       expanded: expanded,
-      heading_level: heading_level,      # set once at parent level, passed to all children
+      heading_level: heading_level, # set once at parent level, passed to all children
       html_attributes: html_attributes,
       summary_text: summary_text,
       heading_text: heading_text,

data/app/components/govuk_component/summary_list_component/action_component.rb

@@ -1,7 +1,7 @@
 class GovukComponent::SummaryListComponent::ActionComponent < GovukComponent::Base
-  attr_reader :href, :text, :visually_hidden_text, :attributes, :classes
+  attr_reader :href, :text, :visually_hidden_text, :visually_hidden_action_suffix, :attributes, :classes
 
-  def initialize(href: nil, text: 'Change', visually_hidden_text: false, classes: [], html_attributes: {})
+  def initialize(href: nil, text: 'Change', visually_hidden_text: false, visually_hidden_action_suffix: nil, classes: [], html_attributes: {})
     @visually_hidden_text = visually_hidden_text
 
     if config.require_summary_list_action_visually_hidden_text && visually_hidden_text == false
@@ -9,9 +9,9 @@ class GovukComponent::SummaryListComponent::ActionComponent < GovukComponent::Ba
     end
 
     super(classes: classes, html_attributes: html_attributes)
-
     @href = href
     @text = text
+    @visually_hidden_action_suffix = visually_hidden_action_suffix
   end
 
   def render?
@@ -36,7 +36,13 @@ private
     content || text || fail(ArgumentError, "no text or content")
   end
 
+  def visually_hidden_content
+    return "#{visually_hidden_text} (#{visually_hidden_action_suffix})" if visually_hidden_action_suffix
+
+    visually_hidden_text
+  end
+
   def visually_hidden_span
-    tag.span(%( #{visually_hidden_text}), class: "#{brand}-visually-hidden") if visually_hidden_text.present?
+    tag.span(%( #{visually_hidden_content}), class: "#{brand}-visually-hidden") if visually_hidden_text.present?
   end
 end

data/app/components/govuk_component/summary_list_component/card_component.html.erb

@@ -5,7 +5,7 @@
     <% if actions.any? %>
       <ul class="<%= brand %>-summary-card__actions">
         <% actions.each do |action| %>
-          <%= tag.li(action, class: "#{brand}-summary-card__action") %>
+          <%= tag.li(action_text(action), class: "#{brand}-summary-card__action") %>
         <% end %>
       </ul>
     <% end %>

data/app/components/govuk_component/summary_list_component/card_component.rb

@@ -16,4 +16,8 @@ private
   def default_attributes
     { class: "#{brand}-summary-card" }
   end
+
+  def action_text(action)
+    safe_join([action, tag.span(" (" + title + ")", class: "#{brand}-visually-hidden")])
+  end
 end

data/app/components/govuk_component/summary_list_component/row_component.rb

@@ -1,12 +1,23 @@
 class GovukComponent::SummaryListComponent::RowComponent < GovukComponent::Base
-  attr_reader :href, :visually_hidden_text, :show_actions_column
+  attr_reader :href, :visually_hidden_text, :show_actions_column, :visually_hidden_action_suffix
 
   renders_one :key, GovukComponent::SummaryListComponent::KeyComponent
   renders_one :value, GovukComponent::SummaryListComponent::ValueComponent
-  renders_many :actions, GovukComponent::SummaryListComponent::ActionComponent
+  renders_many :actions, ->(href: nil, text: 'Change', visually_hidden_text: false, classes: [], html_attributes: {}, &block) do
+    GovukComponent::SummaryListComponent::ActionComponent.new(
+      href: href,
+      text: text,
+      visually_hidden_text: visually_hidden_text,
+      visually_hidden_action_suffix: visually_hidden_action_suffix,
+      classes: classes,
+      html_attributes: html_attributes,
+      &block
+    )
+  end
 
-  def initialize(show_actions_column: nil, classes: [], html_attributes: {})
+  def initialize(show_actions_column: nil, visually_hidden_action_suffix: nil, classes: [], html_attributes: {})
     @show_actions_column = show_actions_column
+    @visually_hidden_action_suffix = visually_hidden_action_suffix
 
     super(classes: classes, html_attributes: html_attributes)
   end

data/app/components/govuk_component/summary_list_component.rb

@@ -1,20 +1,22 @@
 module GovukComponent
   class SummaryListComponent < GovukComponent::Base
-    attr_reader :borders, :actions, :card
+    attr_reader :borders, :actions, :card, :visually_hidden_action_suffix
 
     renders_many :rows, ->(classes: [], html_attributes: {}, &block) do
       GovukComponent::SummaryListComponent::RowComponent.new(
         show_actions_column: @show_actions_column,
+        visually_hidden_action_suffix: visually_hidden_action_suffix || card&.title,
         classes: classes,
         html_attributes: html_attributes,
         &block
       )
     end
 
-    def initialize(rows: nil, actions: true, borders: config.default_summary_list_borders, card: nil, classes: [], html_attributes: {})
-      @borders             = borders
-      @show_actions_column = actions
-      @card                = card
+    def initialize(rows: nil, actions: true, borders: config.default_summary_list_borders, card: {}, visually_hidden_action_suffix: nil, classes: [], html_attributes: {})
+      @borders                       = borders
+      @show_actions_column           = actions
+      @card                          = GovukComponent::SummaryListComponent::CardComponent.new(**card) if card.present?
+      @visually_hidden_action_suffix = visually_hidden_action_suffix
 
       super(classes: classes, html_attributes: html_attributes)
 
@@ -26,16 +28,20 @@ module GovukComponent
     def call
       summary_list = tag.dl(**html_attributes) { safe_join(rows) }
 
-      (card.nil?) ? summary_list : card_with(summary_list)
+      (card?) ? card_with(summary_list) : summary_list
     end
 
   private
 
+    def card?
+      @card.present?
+    end
+
     # we're not using `renders_one` here because we always want the card to render
     # outside of the summary list. when manually building use
     # govuk_summary_list_card { govuk_summary_list }
     def card_with(summary_list)
-      render(GovukComponent::SummaryListComponent::CardComponent.new(**card)) { summary_list }
+      render(@card) { summary_list }
     end
 
     def borders_class

data/app/components/govuk_component/tab_component.rb

@@ -23,7 +23,7 @@ private
 
     def initialize(label:, text: nil, classes: [], html_attributes: {})
       @label = label
-      @text  = text
+      @text  = h(text)
 
       super(classes: classes, html_attributes: html_attributes)
     end

data/app/components/govuk_component/task_list_component/item_component.rb

@@ -1,10 +1,11 @@
 module GovukComponent
   class TaskListComponent::ItemComponent < GovukComponent::Base
-    renders_one :status, ->(text: nil, classes: [], html_attributes: {}, &block) do
+    renders_one :status, ->(text: nil, cannot_start_yet: false, classes: [], html_attributes: {}, &block) do
       GovukComponent::TaskListComponent::StatusComponent.new(
         id_prefix: @id_prefix,
         count: @count,
         text: text,
+        cannot_start_yet: cannot_start_yet,
         classes: classes,
         html_attributes: html_attributes,
         &block
@@ -39,6 +40,10 @@ module GovukComponent
     end
 
     def call
+      if href.presence && status_content.cannot_start_yet
+        fail(ArgumentError, "item cannot have a href with status where cannot_start_yet: true")
+      end
+
       adjusted_html_attributes = if href.present? || title&.href.present?
                                    html_attributes_with_link_class
                                  else

data/app/components/govuk_component/task_list_component/status_component.rb

@@ -1,11 +1,12 @@
 module GovukComponent
   class TaskListComponent::StatusComponent < GovukComponent::Base
-    attr_reader :id_prefix, :text, :count
+    attr_reader :id_prefix, :text, :cannot_start_yet, :count
 
-    def initialize(text: nil, id_prefix: nil, count: nil, classes: [], html_attributes: {})
-      @text      = text
-      @count     = count
-      @id_prefix = id_prefix
+    def initialize(text: nil, id_prefix: nil, count: nil, cannot_start_yet: false, classes: [], html_attributes: {})
+      @text             = text
+      @count            = count
+      @id_prefix        = id_prefix
+      @cannot_start_yet = cannot_start_yet
 
       super(classes: classes, html_attributes: html_attributes)
     end
@@ -21,7 +22,13 @@ module GovukComponent
   private
 
     def default_attributes
-      { class: %w(govuk-task-list__status), id: [id_prefix, count, "status"].compact.join("-") }
+      {
+        class: class_names(
+          "govuk-task-list__status",
+          "govuk-task-list__status--cannot-start-yet" => cannot_start_yet,
+        ),
+        id: [id_prefix, count, "status"].compact.join("-"),
+      }
     end
 
     def status_text

data/app/helpers/govuk_link_helper.rb

@@ -44,7 +44,7 @@ module GovukLinkHelper
   end
 
   def govuk_breadcrumb_link_to(name, href = nil, **kwargs, &block)
-    link_args = { class: "#{brand}-breadcrumbs--link" }.deep_merge_html_attributes(kwargs)
+    link_args = { class: "#{brand}-breadcrumbs__link" }.deep_merge_html_attributes(kwargs)
 
     link_to(name, href, **link_args, &block)
   end
@@ -88,12 +88,18 @@ private
   end
 
   def extract_link_args(new_tab: false, inverse: false, muted: false, no_underline: false, no_visited_state: false, text_colour: false, **kwargs)
+    Rails.logger.warn(actions_warning_message(kwargs.fetch(:action))) if kwargs.key?(:action)
+    Rails.logger.warn(controller_warning_message(kwargs.fetch(:controller))) if kwargs.key?(:controller)
+
     link_classes = extract_link_classes(inverse: inverse, muted: muted, no_underline: no_underline, no_visited_state: no_visited_state, text_colour: text_colour)
 
     { **link_classes, **new_tab_args(new_tab) }.deep_merge_html_attributes(kwargs)
   end
 
   def extract_button_link_args(new_tab: false, disabled: false, inverse: false, secondary: false, warning: false, **kwargs)
+    Rails.logger.warn(actions_warning_message(kwargs.fetch(:action))) if kwargs.key?(:action)
+    Rails.logger.warn(controller_warning_message(kwargs.fetch(:controller))) if kwargs.key?(:controller)
+
     button_classes = extract_button_classes(inverse: inverse, secondary: secondary, warning: warning)
 
     { **button_classes, **button_attributes(disabled), **new_tab_args(new_tab) }.deep_merge_html_attributes(kwargs)
@@ -139,6 +145,14 @@ private
 
     safe_join([govuk_visually_hidden(prefix), text, govuk_visually_hidden(suffix)].compact)
   end
+
+  def actions_warning_message(value)
+    "action: '#{value}' parameter detected Support for old style controller/action links has been removed. See https://github.com/x-govuk/govuk-components/releases/tag/v5.0.0"
+  end
+
+  def controller_warning_message(value)
+    "controller: '#{value}' parameter detected. Support for old style controller/action links has been removed. See https://github.com/x-govuk/govuk-components/releases/tag/v5.0.0"
+  end
 end
 
 ActiveSupport.on_load(:action_view) { include GovukLinkHelper }

data/lib/govuk/components/version.rb

@@ -1,5 +1,5 @@
 module Govuk
   module Components
-    VERSION = '5.0.0'.freeze
+    VERSION = '5.0.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk-components
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.2
 platform: ruby
 authors:
 - DfE developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-08 00:00:00.000000000 Z
+date: 2024-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-attributes-utils
@@ -50,20 +50,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '3.9'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +126,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.12.0
+        version: 4.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.12.0
+        version: 4.13.0
 - !ruby/object:Gem::Dependency
   name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
@@ -280,14 +280,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: slim_lint
   requirement: !ruby/object:Gem::Requirement