govuk-components 3.3.0 → 4.0.0a1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1df60620e63644cfc2a2007fb73966c65701a0034787a34a504e309f8c2666f9
-  data.tar.gz: f0c1980dde2b151960efc9a56bf6b1e443459a47f36137346e8e6336cd31ef52
+  metadata.gz: e5498c871090fc7b01a2bf8b6caf80a29a00d713917173e6c7350d47e99b3f56
+  data.tar.gz: 86369759dd515ef9fd7a9826be8c95ce3dacbcd987c59cdcc253cdb1e32648b5
 SHA512:
-  metadata.gz: cdf8542481bbae72b25a5a16775c2bbad8d1ed51fce15f03997e5b6f24f2e18b1c03312d04a176b8cb90ba857909bd06f464a302502d1cf316b3947b81f5c4a2
-  data.tar.gz: ae8afa05dc72db60956893985d0c0b2cab9d81573f24bf513ec0276b1d38a0472e1ae26f36bc9fd923a43a6512c7af06225de1b67cf09bb3e1cc4c828424ee61
+  metadata.gz: ec79d90aeab7f907b61a3105ac2a05595846d05d5af481489160aa3da47020459044c77dec97e9734a742faf1cbc86eedc46ec486899ed8f60b8fdbf85b491dc
+  data.tar.gz: f8b7225906230461f099835e91799117f6f6528a93e1311b01109b4210a0003e532201877377166d3cadf4ba841306e886ca41164aaeb7497b53340da530ff62

data/README.md

@@ -6,9 +6,9 @@
 [![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/DFE-Digital/govuk-components/test_coverage)
 [![GitHub license](https://img.shields.io/github/license/DFE-Digital/govuk-components)](https://github.com/DFE-Digital/govuk-components/blob/main/LICENSE)
-[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-4.4.0-brightgreen)](https://design-system.service.gov.uk)
-[![Rails](https://img.shields.io/badge/Rails-6.1.5%20%E2%95%B1%207.0.3-E16D6D)](https://weblog.rubyonrails.org/releases/)
-[![Ruby](https://img.shields.io/badge/Ruby-2.7.6%20%20%E2%95%B1%203.0.3%20%20%E2%95%B1%203.1.2-E16D6D)](https://www.ruby-lang.org/en/downloads/)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-4.4.1-brightgreen)](https://design-system.service.gov.uk)
+[![Rails](https://img.shields.io/badge/Rails-6.1.7%20%E2%95%B1%207.0.3-E16D6D)](https://weblog.rubyonrails.org/releases/)
+[![Ruby](https://img.shields.io/badge/Ruby-3.0.5%20%20%E2%95%B1%203.1.3%20%20%E2%95%B1%203.2.0-E16D6D)](https://www.ruby-lang.org/en/downloads/)
 
 This gem provides a suite of reusable components for the [GOV.UK Design System](https://design-system.service.gov.uk/). It is intended to provide a lightweight alternative to the [GOV.UK Publishing Components](https://github.com/alphagov/govuk_publishing_components) library and is built with GitHub’s [ViewComponent](https://github.com/github/view_component) framework.
 

data/app/components/govuk_component/table_component/body_component.rb

@@ -1,5 +1,13 @@
 class GovukComponent::TableComponent::BodyComponent < GovukComponent::Base
-  renders_many :rows, "GovukComponent::TableComponent::RowComponent"
+  renders_many :rows, ->(cell_data: nil, first_cell_is_header: false, classes: [], html_attributes: {}, &block) do
+    GovukComponent::TableComponent::RowComponent.from_body(
+      cell_data: cell_data,
+      first_cell_is_header: first_cell_is_header,
+      classes: classes,
+      html_attributes: html_attributes,
+      &block
+    )
+  end
 
   def initialize(rows: nil, first_cell_is_header: false, classes: [], html_attributes: {})
     super(classes: classes, html_attributes: html_attributes)
@@ -7,6 +15,10 @@ class GovukComponent::TableComponent::BodyComponent < GovukComponent::Base
     build_rows_from_row_data(rows, first_cell_is_header)
   end
 
+  def call
+    tag.tbody(**html_attributes) { safe_join(rows) }
+  end
+
 private
 
   def build_rows_from_row_data(data, first_cell_is_header)

data/app/components/govuk_component/table_component/cell_component.rb

@@ -1,7 +1,8 @@
 class GovukComponent::TableComponent::CellComponent < GovukComponent::Base
-  attr_reader :text, :header, :numeric, :width
+  attr_reader :text, :header, :numeric, :width, :scope, :parent
 
   alias_method :numeric?, :numeric
+  alias_method :header?, :header
 
   WIDTHS = {
     "full"           => "govuk-!-width-full",
@@ -12,11 +13,13 @@ class GovukComponent::TableComponent::CellComponent < GovukComponent::Base
     "one-quarter"    => "govuk-!-width-one-quarter",
   }.freeze
 
-  def initialize(header: false, text: nil, numeric: false, width: nil, classes: [], html_attributes: {})
-    @header  = header
+  def initialize(scope: nil, header: nil, numeric: false, text: nil, width: nil, parent: nil, classes: [], html_attributes: {})
     @text    = text
     @numeric = numeric
     @width   = width
+    @scope   = scope
+    @parent  = parent
+    @header  = (header.nil?) ? in_thead? : header
 
     super(classes: classes, html_attributes: html_attributes)
   end
@@ -36,22 +39,45 @@ private
   end
 
   def cell_element
-    header ? :th : :td
+    header ? 'th' : 'td'
   end
 
   def default_attributes
-    { class: default_classes }
+    { class: default_classes, scope: determine_scope }
+  end
+
+  def determine_scope
+    conditions = { scope: scope, parent: parent, header: header, auto_table_scopes: config.enable_auto_table_scopes }
+
+    case conditions
+    in { scope: String }
+      scope
+    in { scope: false } | { header: false } | { auto_table_scopes: false }
+      nil
+    in { auto_table_scopes: true, parent: 'thead' }
+      'col'
+    in { auto_table_scopes: true, parent: 'tbody' }
+      'row'
+    else
+      Rails.logger.warn("No scope pattern matched")
+
+      nil
+    end
   end
 
   def default_classes
     if header
-      class_names("govuk-table__header", "govuk-table__header--numeric" => numeric?, width_class => width?).split
+      class_names("govuk-table__header", "govuk-table__header--numeric" => numeric?, width_class => width?)
     else
-      class_names("govuk-table__cell", "govuk-table__cell--numeric" => numeric?, width_class => width?).split
+      class_names("govuk-table__cell", "govuk-table__cell--numeric" => numeric?, width_class => width?)
     end
   end
 
   def width_class
     WIDTHS.fetch(width, nil)
   end
+
+  def in_thead?
+    parent == "thead"
+  end
 end

data/app/components/govuk_component/table_component/head_component.rb

@@ -1,5 +1,12 @@
 class GovukComponent::TableComponent::HeadComponent < GovukComponent::Base
-  renders_many :rows, "GovukComponent::TableComponent::RowComponent"
+  renders_many :rows, ->(cell_data: nil, classes: [], html_attributes: {}, &block) do
+    GovukComponent::TableComponent::RowComponent.from_head(
+      cell_data: cell_data,
+      classes: classes,
+      html_attributes: html_attributes,
+      &block
+    )
+  end
 
   attr_reader :row_data
 
@@ -9,12 +16,16 @@ class GovukComponent::TableComponent::HeadComponent < GovukComponent::Base
     build_rows_from_row_data(rows)
   end
 
+  def call
+    tag.thead(**html_attributes) { safe_join(rows) }
+  end
+
 private
 
   def build_rows_from_row_data(data)
     return if data.blank?
 
-    data.each { |d| row(cell_data: d, header: true) }
+    data.each { |d| row(cell_data: d) }
   end
 
   def default_attributes

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

@@ -1,30 +1,64 @@
 class GovukComponent::TableComponent::RowComponent < GovukComponent::Base
-  renders_many :cells, "GovukComponent::TableComponent::CellComponent"
+  renders_many :cells, ->(scope: nil, header: nil, text: nil, numeric: false, width: nil, classes: [], html_attributes: {}, &block) do
+    GovukComponent::TableComponent::CellComponent.new(
+      scope: scope,
+      header: header,
+      text: text,
+      numeric: numeric,
+      width: width,
+      parent: parent,
+      classes: classes,
+      html_attributes: html_attributes,
+      &block
+    )
+  end
 
-  attr_reader :header, :first_cell_is_header
+  attr_reader :first_cell_is_header, :parent
 
-  def initialize(cell_data: nil, first_cell_is_header: false, header: false, classes: [], html_attributes: {})
-    @header = header
+  def initialize(cell_data: nil, first_cell_is_header: false, parent: nil, classes: [], html_attributes: {})
     @first_cell_is_header = first_cell_is_header
+    @parent = parent
 
     super(classes: classes, html_attributes: html_attributes)
 
     build_cells_from_cell_data(cell_data)
   end
 
+  def self.from_head(*args, **kwargs, &block)
+    new(*args, parent: 'thead', **kwargs, &block)
+  end
+
+  def self.from_body(*args, **kwargs, &block)
+    new(*args, parent: 'tbody', **kwargs, &block)
+  end
+
+  def call
+    tag.tr(**html_attributes) { safe_join(cells) }
+  end
+
 private
 
   def build_cells_from_cell_data(cell_data)
     return if cell_data.blank?
 
-    cell_data.map.with_index { |cd, i| cell(header: cell_is_header?(i), text: cd) }
+    cell_data.each.with_index { |data, i| cell(text: data, **cell_attributes(i)) }
+  end
+
+  def cell_attributes(count)
+    cell_is_header?(count).then do |cell_is_header|
+      { header: cell_is_header }
+    end
   end
 
   def cell_is_header?(count)
-    header || (first_cell_is_header && count.zero?)
+    in_thead? || (first_cell_is_header && count.zero?)
   end
 
   def default_attributes
     { class: %w(govuk-table__row) }
   end
+
+  def in_thead?
+    parent == "thead"
+  end
 end

data/app/components/govuk_component/table_component.rb

@@ -20,6 +20,10 @@ module GovukComponent
       build(*(head ? [head, rows] : [rows[0], rows[1..]]), caption_text)
     end
 
+    def call
+      tag.table(**html_attributes) { safe_join([caption, head, bodies]) }
+    end
+
   private
 
     def build(head_data, body_data, caption_text)

data/app/helpers/govuk_link_helper.rb

@@ -1,4 +1,8 @@
+require "html_attributes_utils"
+
 module GovukLinkHelper
+  using HTMLAttributesUtils
+
   LINK_STYLES = {
     inverse:          "govuk-link--inverse",
     muted:            "govuk-link--muted",
@@ -13,6 +17,11 @@ module GovukLinkHelper
     warning:   "govuk-button--warning",
   }.freeze
 
+  NEW_TAB_ATTRIBUTES = {
+    target: "_blank",
+    rel: "noreferrer noopener"
+  }.freeze
+
   def govuk_link_classes(*styles, default_class: 'govuk-link')
     if (invalid_styles = (styles - LINK_STYLES.keys)) && invalid_styles.any?
       fail(ArgumentError, "invalid styles #{invalid_styles.to_sentence}. Valid styles are #{LINK_STYLES.keys.to_sentence}")
@@ -29,14 +38,14 @@ module GovukLinkHelper
     [default_class] + BUTTON_STYLES.values_at(*styles).compact
   end
 
-  def govuk_link_to(name = nil, options = nil, extra_options = {}, &block)
+  def govuk_link_to(name = nil, options = nil, extra_options = {}, new_tab: false, &block)
     extra_options = options if block_given?
-    html_options = build_html_options(extra_options)
+    html_options = build_html_options(extra_options, new_tab: new_tab)
 
     if block_given?
       link_to(name, html_options, &block)
     else
-      link_to(name, options, html_options)
+      link_to(prepare_link_text(name, new_tab), options, html_options)
     end
   end
 
@@ -62,15 +71,15 @@ module GovukLinkHelper
     end
   end
 
-  def govuk_button_link_to(name = nil, options = nil, extra_options = {}, &block)
+  def govuk_button_link_to(name = nil, options = nil, extra_options = {}, new_tab: false, &block)
     extra_options = options if block_given?
     html_options = GovukComponent::StartButtonComponent::LINK_ATTRIBUTES
-      .merge build_html_options(extra_options, style: :button)
+      .merge build_html_options(extra_options, style: :button, new_tab: new_tab)
 
     if block_given?
       link_to(name, html_options, &block)
     else
-      link_to(name, options, html_options)
+      link_to(prepare_link_text(name, new_tab), options, html_options)
     end
   end
 
@@ -87,18 +96,22 @@ module GovukLinkHelper
 
 private
 
-  def build_html_options(provided_options, style: :link)
-    styles = case style
-             when :link       then LINK_STYLES
-             when :button     then BUTTON_STYLES
-             else {}
-             end
+  def build_html_options(provided_options, style: :link, new_tab: false)
+    element_styles = { link: LINK_STYLES, button: BUTTON_STYLES }.fetch(style, {})
+
+    # we need to take a couple of extra steps here because we don't want the style
+    # params (inverse, muted, etc) to end up as extra attributes on the link.
 
-    remaining_options = provided_options&.slice!(*styles.keys)
+    remaining_options = new_tab_options(new_tab)
+      .deep_merge_html_attributes(remove_styles_from_provided_options(element_styles, provided_options))
 
-    return {} unless (style_classes = build_style_classes(style, provided_options))
+    style_classes = build_style_classes(style, extract_styles_from_provided_options(element_styles, provided_options))
 
-    inject_class(remaining_options, class_name: style_classes)
+    combine_attributes(remaining_options, class_name: style_classes)
+  end
+
+  def new_tab_options(new_tab)
+    new_tab ? NEW_TAB_ATTRIBUTES : {}
   end
 
   def build_style_classes(style, provided_options)
@@ -111,13 +124,35 @@ private
     end
   end
 
-  def inject_class(attributes, class_name:)
+  def combine_attributes(attributes, class_name:)
     attributes ||= {}
 
     attributes.with_indifferent_access.tap do |attrs|
       attrs[:class] = Array.wrap(attrs[:class]).prepend(class_name).flatten.join(" ")
     end
   end
+
+  def extract_styles_from_provided_options(styles, provided_options)
+    return {} if provided_options.blank?
+
+    provided_options.slice(*styles.keys)
+  end
+
+  def remove_styles_from_provided_options(styles, provided_options)
+    return {} if provided_options.blank?
+
+    provided_options&.except(*styles.keys)
+  end
+
+  def prepare_link_text(text, new_tab)
+    return text unless new_tab
+
+    new_tab_text = new_tab.is_a?(String) ? new_tab : Govuk::Components.config.default_link_new_tab_text
+
+    return text if new_tab_text.blank?
+
+    %(#{text} #{new_tab_text})
+  end
 end
 
 ActiveSupport.on_load(:action_view) { include GovukLinkHelper }

data/lib/govuk/components/engine.rb

@@ -64,6 +64,7 @@ module Govuk
     # +:default_warning_text_icon+ "!"
     #
     # +:require_summary_list_action_visually_hidden_text+ when true forces visually hidden text to be set for every action. It can still be explicitly skipped by passing in +nil+. Defaults to +false+
+    # +:enable_auto_table_scopes+ automatically adds a scope of 'col' to th elements in thead and 'row' to th elements in tbody.
     DEFAULTS = {
       default_back_link_text: 'Back',
       default_breadcrumbs_collapse_on_mobile: false,
@@ -96,7 +97,10 @@ module Govuk
       default_warning_text_icon_fallback_text: "Warning",
       default_warning_text_icon: "!",
 
+      default_link_new_tab_text: "(opens in new tab)",
+
       require_summary_list_action_visually_hidden_text: false,
+      enable_auto_table_scopes: true,
     }.freeze
 
     DEFAULTS.each_key { |k| config_accessor(k) { DEFAULTS[k] } }

data/lib/govuk/components/version.rb

@@ -1,5 +1,5 @@
 module Govuk
   module Components
-    VERSION = '3.3.0'.freeze
+    VERSION = '4.0.0a1'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk-components
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 4.0.0a1
 platform: ruby
 authors:
 - DfE developers
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-16 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: html-attributes-utils
@@ -16,48 +16,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: pagy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.1
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.10.1
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.74.1
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.74.1
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
@@ -120,14 +120,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.9.0
 - !ruby/object:Gem::Dependency
   name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
@@ -357,15 +357,11 @@ files:
 - app/components/govuk_component/summary_list_component/value_component.rb
 - app/components/govuk_component/tab_component.html.erb
 - app/components/govuk_component/tab_component.rb
-- app/components/govuk_component/table_component.html.erb
 - app/components/govuk_component/table_component.rb
-- app/components/govuk_component/table_component/body_component.html.erb
 - app/components/govuk_component/table_component/body_component.rb
 - app/components/govuk_component/table_component/caption_component.rb
 - app/components/govuk_component/table_component/cell_component.rb
-- app/components/govuk_component/table_component/head_component.html.erb
 - app/components/govuk_component/table_component/head_component.rb
-- app/components/govuk_component/table_component/row_component.html.erb
 - app/components/govuk_component/table_component/row_component.rb
 - app/components/govuk_component/tag_component.rb
 - app/components/govuk_component/traits.rb
@@ -385,7 +381,7 @@ homepage: https://github.com/DFE-Digital/govuk-components
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -396,12 +392,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: Lightweight set of reusable GOV.UK Design System components
 test_files: []

data/app/components/govuk_component/table_component/body_component.html.erb

@@ -1,5 +0,0 @@
-<%= tag.tbody(**html_attributes) do %>
-  <% rows.each do |row| %>
-    <%= row %>
-  <% end %>
-<% end %>

data/app/components/govuk_component/table_component/head_component.html.erb

@@ -1,5 +0,0 @@
-<%= tag.thead(**html_attributes) do %>
-  <% rows.each do |row| %>
-    <%= row %>
-  <% end %>
-<% end %>

data/app/components/govuk_component/table_component/row_component.html.erb

@@ -1,5 +0,0 @@
-<%= tag.tr(**html_attributes) do %>
-  <% cells.each do |cell| %>
-    <%= cell %>
-  <% end %>
-<% end %>

data/app/components/govuk_component/table_component.html.erb

@@ -1,7 +0,0 @@
-<%= tag.table(**html_attributes) do %>
-  <%= caption %>
-  <%= head %>
-  <% bodies.each do |body| %>
-    <%= body %>
-  <% end %>
-<% end %>