govuk-components 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc521c772f5513d62d1b8fd78e77a504c4c1eb913770ffc1dd5d2d3020946980
-  data.tar.gz: ee85598308825985ca7e84120562fbecb04c7b6f359aba0bc37386e2a33f8a9f
+  metadata.gz: 97d2ca8aa2e5c29f692f791ec5e91d98a8aea3ed49cb6d03071aca7ac19dfee5
+  data.tar.gz: 6afbe25f03a8ee9d053a1c563d821e8e82b6f5471fdf9b30549aa3bed582a22a
 SHA512:
-  metadata.gz: 0c20bba8e5c5b9457d2065edd6f496f8ad93f1baebc7206e5a89260629db9713b59385f61857312aff3947716bc2d1e14064843dd6543655a619e1a050a88f4c
-  data.tar.gz: 8f1c590b69e35bb0ba47840a7fc7f3b12eb6ec6ee30ef92e58cfb67852a1954633808911100160491a0fd1a1d8a1353603cdbcc2eae55fa0686782717a9aa250
+  metadata.gz: 2ea35b519c098911bdff24e526ed013baff28bd74a13a48661ff0531000e0f78274dad0c39bc99ebab2b8b2fb5643b19c021fa073ab805498edba1597c2697dd
+  data.tar.gz: 62ed085b07abb5321f15b9a72ce4df1f07129a7147757b657bfb7c70961fae263e1554cca61fcaca01daadfd0530f8bced219623e5b223ff7f638a0421d9e5da

data/README.md

@@ -44,7 +44,7 @@ All of the components can be rendered in two ways:
 * directly using Rails' `#render` method:
 
   ```erb
-    <%= render GovukComponent::GovukComponent::WarningTextComponent.new do %>
+    <%= render GovukComponent::WarningTextComponent.new do %>
       A serious warning
     <% end %>
   ```

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

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

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

@@ -0,0 +1,21 @@
+class GovukComponent::TableComponent::BodyComponent < GovukComponent::Base
+  renders_many :rows, GovukComponent::TableComponent::RowComponent
+
+  def initialize(rows: nil, first_cell_is_header: false, classes: [], html_attributes: {})
+    super(classes: classes, html_attributes: html_attributes)
+
+    build_rows_from_row_data(rows, first_cell_is_header)
+  end
+
+private
+
+  def build_rows_from_row_data(data, first_cell_is_header)
+    return if data.blank?
+
+    data.each { |d| row(cell_data: d, first_cell_is_header: first_cell_is_header) }
+  end
+
+  def default_classes
+    %w(govuk-table__body)
+  end
+end

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

@@ -0,0 +1,39 @@
+class GovukComponent::TableComponent::CaptionComponent < GovukComponent::Base
+  attr_reader :text, :size
+
+  SIZES = %w(s m l xl).freeze
+
+  def initialize(text: nil, id: nil, size: 'm', classes: [], html_attributes: {})
+    super(classes: classes, html_attributes: html_attributes)
+
+    @id   = id
+    @text = text
+    @size = size
+  end
+
+  def call
+    tag.caption(caption_content, class: classes, **html_attributes)
+  end
+
+  def render?
+    caption_content.present?
+  end
+
+private
+
+  def caption_content
+    @caption_content ||= (content || text)
+  end
+
+  def default_classes
+    %w(govuk-table__caption).tap do |c|
+      c << caption_size_class if @size
+    end
+  end
+
+  def caption_size_class
+    fail(ArgumentError, "bad size #{size}, must be in #{SIZES}") unless size.in?(SIZES)
+
+    %(govuk-table__caption--#{size})
+  end
+end

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

@@ -0,0 +1 @@
+<%= content_tag(cell_element, cell_content, class: classes, **html_attributes) %>

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

@@ -0,0 +1,55 @@
+class GovukComponent::TableComponent::CellComponent < GovukComponent::Base
+  attr_reader :text, :header, :numeric, :width
+
+  alias_method :numeric?, :numeric
+
+  WIDTHS = {
+    "full"           => "govuk-input govuk-!-width-full",
+    "three-quarters" => "govuk-input govuk-!-width-three-quarters",
+    "two-thirds"     => "govuk-input govuk-!-width-two-thirds",
+    "one-half"       => "govuk-input govuk-!-width-one-half",
+    "one-third"      => "govuk-input govuk-!-width-one-third",
+    "one-quarter"    => "govuk-input govuk-!-width-one-quarter",
+  }.freeze
+
+  def initialize(header: false, text: nil, numeric: false, width: nil, classes: [], html_attributes: {})
+    super(classes: classes, html_attributes: html_attributes)
+
+    @header  = header
+    @text    = text
+    @numeric = numeric
+    @width   = width
+  end
+
+private
+
+  def width?
+    width.present?
+  end
+
+  def cell_content
+    content || text
+  end
+
+  def cell_element
+    header ? :th : :td
+  end
+
+  def default_classes
+    if header
+      %w(govuk-table__header).tap do |c|
+        c << "govuk-table__header--numeric" if numeric?
+        c << width_class if width?
+      end
+    else
+      %w(govuk-table__cell).tap do |c|
+        c << "govuk-table__cell--numeric" if numeric?
+        c << width_class if width?
+      end
+    end
+  end
+
+  def width_class
+    WIDTHS.fetch(width)
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+class GovukComponent::TableComponent::HeadComponent < GovukComponent::Base
+  renders_many :rows, GovukComponent::TableComponent::RowComponent
+
+  attr_reader :row_data
+
+  def initialize(rows: nil, classes: [], html_attributes: {})
+    super(classes: classes, html_attributes: html_attributes)
+
+    build_rows_from_row_data(rows)
+  end
+
+private
+
+  def build_rows_from_row_data(data)
+    return if data.blank?
+
+    data.each { |d| row(cell_data: d, header: true) }
+  end
+
+  def default_classes
+    %w(govuk-table__head)
+  end
+end

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

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

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

@@ -0,0 +1,30 @@
+class GovukComponent::TableComponent::RowComponent < GovukComponent::Base
+  renders_many :cells, GovukComponent::TableComponent::CellComponent
+
+  attr_reader :header, :first_cell_is_header
+
+  def initialize(cell_data: nil, first_cell_is_header: false, header: false, classes: [], html_attributes: {})
+    super(classes: classes, html_attributes: html_attributes)
+
+    @header = header
+    @first_cell_is_header = first_cell_is_header
+
+    build_cells_from_cell_data(cell_data)
+  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) }
+  end
+
+  def cell_is_header?(count)
+    header || (first_cell_is_header && count.zero?)
+  end
+
+  def default_classes
+    %w(govuk-table__row)
+  end
+end

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

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

data/app/components/govuk_component/table_component.rb

@@ -0,0 +1,33 @@
+class GovukComponent::TableComponent < GovukComponent::Base
+  renders_one :caption, GovukComponent::TableComponent::CaptionComponent
+  renders_one :head, GovukComponent::TableComponent::HeadComponent
+  renders_many :bodies, GovukComponent::TableComponent::BodyComponent
+
+  attr_accessor :id, :first_cell_is_header, :caption_text
+
+  def initialize(id: nil, rows: nil, head: nil, caption: nil, first_cell_is_header: false, classes: [], html_attributes: {})
+    super(classes: classes, html_attributes: html_attributes)
+
+    @id                   = id
+    @first_cell_is_header = first_cell_is_header
+    @caption_text         = caption
+
+    # when no rows are passed in it's likely we're taking the slot approach
+    return unless rows.presence
+
+    # if no head is passed in,use the first row for headers
+    build(*(head ? [head, rows] : [rows[0], rows[1..]]), caption_text)
+  end
+
+private
+
+  def build(head_data, body_data, caption_text)
+    caption(text: caption_text)
+    head(rows: [head_data])
+    body(rows: body_data, first_cell_is_header: first_cell_is_header)
+  end
+
+  def default_classes
+    %w(govuk-table)
+  end
+end

data/app/helpers/govuk_components_helper.rb

@@ -13,6 +13,7 @@ module GovukComponentsHelper
     govuk_phase_banner: 'GovukComponent::PhaseBannerComponent',
     govuk_start_button: 'GovukComponent::StartButtonComponent',
     govuk_summary_list: 'GovukComponent::SummaryListComponent',
+    govuk_table: 'GovukComponent::TableComponent',
     govuk_tabs: 'GovukComponent::TabComponent',
     govuk_tag: 'GovukComponent::TagComponent',
     govuk_warning_text: 'GovukComponent::WarningTextComponent',

data/lib/govuk/components/version.rb

@@ -1,5 +1,5 @@
 module Govuk
   module Components
-    VERSION = '2.0.1'.freeze
+    VERSION = '2.1.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk-components
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - DfE developers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.36.0
+        version: 2.39.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.36.0
+        version: 2.39.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -191,6 +191,17 @@ 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.html.erb
+- 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/custom_classes.rb
 - app/components/govuk_component/traits/custom_html_attributes.rb
@@ -209,7 +220,7 @@ homepage: https://github.com/DFE-Digital/govuk-components
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Lightweight set of reusable GOV.UK Design System components
 test_files: []