govuk-components 3.0.5 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d5cf5d99c77bcfbd24e77252b855265660bc80e2496b75adda9cf10362c9ee1
-  data.tar.gz: c54839796cf802ebe85dddf875a269b67a423856d36c87cdc7e16a4f90ee830d
+  metadata.gz: bb212d5aeb799affbe885b0a386f4f012e29938efeb71c7f4931c8ba5d16eb15
+  data.tar.gz: 45cb8082ee1df09af0a0528d1fb6f05e3113b2bd958bc334065e1c651017bff2
 SHA512:
-  metadata.gz: 246a31f6ea734ae757f88bf92e0d2bf1ea15daa741fb87318f257b9d79926b189b8cf9312b492d6f82a9180608dec25344f7328f98c74f49d4ffd81fdda3540f
-  data.tar.gz: 61d94fc80d6e125d198eb388afd056b3edd612b6463adb06a17fb9fbfe8e37862b93f99ce45603a21cdf8c32a8a1cfe28edbd463b952ea73c08e003948d4175c
+  metadata.gz: 46fedf48b9bacd94e9c846cad6fbf7a1bcbb342aa01f6f2e06123131dcd1982c01b0420ad2a1b9f62a78298575b81fb6de8b2047ee1d75d43ad490837046e95a
+  data.tar.gz: 3913d6cadd186bf5d0c349e644bd27234a6a0aa94b7b45fe33ed30eec342addb6ef53e5b4d43ab5e89ae7bb361d1e2cecb1d7e10580db33ccb18d74ef19ad5df

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.1.0-brightgreen)](https://design-system.service.gov.uk)
+[![GOV.UK Design System Version](https://img.shields.io/badge/GOV.UK%20Design%20System-4.2.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.5%20%20%E2%95%B1%203.0.3%20%20%E2%95%B1%203.1.0-E16D6D)](https://www.ruby-lang.org/en/downloads/)
+[![Ruby](https://img.shields.io/badge/Ruby-2.7.5%20%20%E2%95%B1%203.0.3%20%20%E2%95%B1%203.1.2-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.
 
@@ -30,6 +30,7 @@ The provided components are:
 * [Inset text](https://govuk-components.netlify.app/components/inset-text)
 * [Notification banner](https://govuk-components.netlify.app/components/notification-banner)
 * [Panel](https://govuk-components.netlify.app/components/panel)
+* [Pagination](https://govuk-components.netlify.app/components/pagination)
 * [Phase banner](https://govuk-components.netlify.app/components/phase-banner)
 * [Section break](https://govuk-components.netlify.app/components/section-break)
 * [Start button](https://govuk-components.netlify.app/components/start-button)

data/app/components/govuk_component/base.rb

@@ -4,6 +4,11 @@ class GovukComponent::Base < ViewComponent::Base
   attr_reader :html_attributes
 
   def initialize(classes:, html_attributes:)
+    if classes.nil?
+      Rails.logger.warn("classes is nil, if no custom classes are needed omit the param")
+
+      classes = []
+    end
     # FIXME: remove first merge when we deprecate classes
     #
     # This step only needs to be here while we still accept classes:, now

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

@@ -32,7 +32,7 @@
     <% if service_name.present? || navigation_items.present? %>
       <div class="govuk-header__content">
         <% if service_name.present? %>
-          <%= link_to(service_name, service_url, class: %w(govuk-header__link govuk-header__link--service-name)) %>
+          <%= link_to(service_name, service_url, class: %w(govuk-header__link govuk-header__service-name)) %>
         <% end %>
 
         <% if navigation_items.any? %>

data/app/components/govuk_component/pagination_component/adjacent_page.rb

@@ -0,0 +1,60 @@
+class GovukComponent::PaginationComponent::AdjacentPage < GovukComponent::Base
+  attr_reader :href, :label_text, :text, :suffix, :block_mode, :visually_hidden_text
+  alias_method :block_mode?, :block_mode
+
+  def initialize(href:, suffix:, visually_hidden_text:, text:, block_mode: true, label_text: nil, classes: [], html_attributes: {})
+    @href                 = href
+    @label_text           = label_text
+    @text                 = text
+    @block_mode           = block_mode
+    @suffix               = suffix
+    @visually_hidden_text = visually_hidden_text
+
+    super(html_attributes: html_attributes, classes: classes)
+  end
+
+  def call
+    tag.div(**html_attributes) do
+      tag.a(href: href, class: %w(govuk-link govuk-pagination__link), rel: suffix, aria: { label: aria_label }) do
+        safe_join([body, divider, label_content])
+      end
+    end
+  end
+
+private
+
+  def default_attributes
+    { class: ["govuk-pagination__#{suffix}"] }
+  end
+
+  def body
+    [arrow, title_span]
+  end
+
+  def title_span
+    tag.span(text, class: title_classes)
+  end
+
+  def divider
+    return if label_text.blank?
+
+    tag.span(":", class: %w(govuk-visually-hidden))
+  end
+
+  def label_content
+    return if label_text.blank?
+
+    tag.span(label_text, class: label_classes)
+  end
+
+  def title_classes
+    class_names(
+      %(govuk-pagination__link-title),
+      %(govuk-pagination__link-title--decorated) => label_text.blank?
+    )
+  end
+
+  def label_classes
+    %w(govuk-pagination__link-label)
+  end
+end

data/app/components/govuk_component/pagination_component/item.rb

@@ -0,0 +1,77 @@
+class GovukComponent::PaginationComponent::Item < GovukComponent::Base
+  attr_reader :number, :href, :visually_hidden_text, :mode
+
+  def initialize(number: nil, href: nil, current: false, ellipsis: false, from_pagy: false, visually_hidden_text: nil, classes: [], html_attributes: {})
+    @number               = number
+    @href                 = href
+    @visually_hidden_text = visually_hidden_text
+
+    # We have three modes for rendering links:
+    #
+    #  * link    (a link to another page)
+    #  * current (a link to the current page)
+    #  * gap     (an ellipsis symbol)
+    #
+    # Pagy sets these by object type:
+    # Integer = link
+    # String  = current
+    # :gap    = gap
+    #
+    # The original Nunjucks component has two boolean settings instead,
+    # ellipsis and current. When ellipsis is true all other arguments are
+    # ignored
+    @mode = from_pagy ? pagy_mode(number) : manual_mode(ellipsis, current)
+
+    super(classes: classes, html_attributes: html_attributes)
+  end
+
+  def call
+    case mode
+    when :link
+      link(current: false)
+    when :current
+      link(current: true)
+    when :gap
+      ellipsis_item
+    end
+  end
+
+private
+
+  def pagy_mode(number)
+    return :link    if number.is_a?(Integer)
+    return :current if number.is_a?(String)
+
+    :gap
+  end
+
+  def manual_mode(ellipsis, current)
+    return :gap     if ellipsis
+    return :current if current
+
+    :link
+  end
+
+  def link(current: false)
+    attributes = html_attributes.tap { |ha| ha[:class] << "govuk-pagination__item--current" if current }
+
+    tag.li(**attributes) do
+      tag.a(href: href, class: %w(govuk-link govuk-pagination__link)) { number.to_s }
+    end
+  end
+
+  def ellipsis_item
+    tag.li("⋯", class: %w(govuk-pagination__item govuk-pagination__item--ellipses))
+  end
+
+  def default_attributes
+    {
+      class: %w(govuk-pagination__item),
+      aria: { label: aria_label }
+    }
+  end
+
+  def aria_label
+    visually_hidden_text || "Page #{number}"
+  end
+end

data/app/components/govuk_component/pagination_component/next_page.rb

@@ -0,0 +1,32 @@
+class GovukComponent::PaginationComponent::NextPage < GovukComponent::PaginationComponent::AdjacentPage
+  def initialize(href:, text:, label_text: nil, visually_hidden_text: nil, block_mode: true, classes: [], html_attributes: {})
+    super(
+      suffix: "next",
+      text: text,
+      href: href,
+      label_text: label_text,
+      block_mode: block_mode,
+      visually_hidden_text: visually_hidden_text,
+      classes: classes,
+      html_attributes: html_attributes
+    )
+  end
+
+  def body
+    return [arrow, title_span] if block_mode?
+
+    [title_span, arrow]
+  end
+
+private
+
+  def aria_label
+    @visually_hidden_text || "Next page"
+  end
+
+  def arrow
+    tag.svg(class: "govuk-pagination__icon govuk-pagination__icon--next", xmlns: "http://www.w3.org/2000/svg", height: "13", width: "15", focusable: "false", viewBox: "0 0 15 13", aria: { hidden: "true" }) do
+      tag.path(d: "m8.107-0.0078125-1.4136 1.414 4.2926 4.293h-12.986v2h12.896l-4.1855 3.9766 1.377 1.4492 6.7441-6.4062-6.7246-6.7266z")
+    end
+  end
+end

data/app/components/govuk_component/pagination_component/previous_page.rb

@@ -0,0 +1,26 @@
+class GovukComponent::PaginationComponent::PreviousPage < GovukComponent::PaginationComponent::AdjacentPage
+  def initialize(href:, text:, label_text: nil, visually_hidden_text: nil, block_mode: true, classes: [], html_attributes: {})
+    super(
+      suffix: "prev",
+      text: text,
+      href: href,
+      label_text: label_text,
+      block_mode: block_mode,
+      visually_hidden_text: visually_hidden_text,
+      classes: classes,
+      html_attributes: html_attributes
+    )
+  end
+
+private
+
+  def aria_label
+    @visually_hidden_text || "Previous page"
+  end
+
+  def arrow
+    tag.svg(class: "govuk-pagination__icon govuk-pagination__icon--prev", xmlns: "http://www.w3.org/2000/svg", height: "13", width: "15", focusable: "false", viewBox: "0 0 15 13", aria: { hidden: "true" }) do
+      tag.path(d: "m6.5938-0.0078125-6.7266 6.7266 6.7441 6.4062 1.377-1.449-4.1856-3.9768h12.896v-2h-12.984l4.2931-4.293-1.414-1.414z")
+    end
+  end
+end

data/app/components/govuk_component/pagination_component.rb

@@ -0,0 +1,126 @@
+class GovukComponent::PaginationComponent < GovukComponent::Base
+  include Pagy::UrlHelpers
+
+  attr_reader :pagy,
+              :next_text,
+              :previous_text,
+              :visually_hidden_next_text,
+              :visually_hidden_previous_text,
+              :page_items,
+              :previous_content,
+              :next_content,
+              :block_mode,
+              :landmark_label
+
+  alias_method :block_mode?, :block_mode
+
+  renders_many :items, "GovukComponent::PaginationComponent::Item"
+
+  renders_one :next_page, ->(href:, text: default_next_text, label_text: nil, visually_hidden_text: nil, classes: [], html_attributes: {}) do
+    GovukComponent::PaginationComponent::NextPage.new(
+      text: text,
+      href: href,
+      label_text: label_text,
+      block_mode: block_mode?,
+      visually_hidden_text: visually_hidden_text,
+      classes: classes,
+      html_attributes: html_attributes
+    )
+  end
+
+  renders_one :previous_page, ->(href:, text: default_previous_text, label_text: nil, visually_hidden_text: nil, classes: [], html_attributes: {}) do
+    GovukComponent::PaginationComponent::PreviousPage.new(
+      text: text,
+      href: href,
+      label_text: label_text,
+      block_mode: block_mode?,
+      visually_hidden_text: visually_hidden_text,
+      classes: classes,
+      html_attributes: html_attributes
+    )
+  end
+
+  def initialize(pagy: nil, next_text: nil, previous_text: nil, visually_hidden_next_text: nil, visually_hidden_previous_text: nil, block_mode: false, landmark_label: "results", classes: [], html_attributes: {})
+    @pagy                          = pagy
+    @next_text                     = next_text
+    @previous_text                 = previous_text
+    @visually_hidden_next_text     = visually_hidden_next_text
+    @visually_hidden_previous_text = visually_hidden_previous_text
+    @block_mode                    = block_mode
+    @landmark_label                = landmark_label
+
+    super(classes: classes, html_attributes: html_attributes)
+  end
+
+  def before_render
+    @page_items = if pagy.present?
+                    build_items
+                  elsif items.any?
+                    items
+                  else
+                    []
+                  end
+
+    @previous_content = previous_page || build_previous
+    @next_content     = next_page || build_next
+  end
+
+  def call
+    attributes = html_attributes.tap { |ha| (ha[:class] << "govuk-pagination--block") if items.empty? }
+
+    tag.nav(**attributes) do
+      safe_join([
+        previous_content,
+        tag.ul(class: "govuk-pagination__list") { safe_join(page_items) },
+        next_content
+      ])
+    end
+  end
+
+  def render?
+    # probably isn't any point rendering if there's only one page
+    (pagy.present? && pagy.series.size > 1) || @previous_content.present? || @next_content.present?
+  end
+
+private
+
+  def default_attributes
+    { role: "navigation", aria: { label: landmark_label }, class: %w(govuk-pagination) }
+  end
+
+  def build_previous
+    return unless pagy&.prev
+
+    kwargs = {
+      href: pagy_url_for(pagy, pagy.prev),
+      text: @previous_text,
+      visually_hidden_text: visually_hidden_previous_text,
+    }
+
+    previous_page(**kwargs.compact)
+  end
+
+  def build_next
+    return unless pagy&.next
+
+    kwargs = {
+      href: pagy_url_for(pagy, pagy.next),
+      text: @next_text,
+      visually_hidden_text: visually_hidden_next_text,
+    }
+
+    next_page(**kwargs.compact)
+  end
+
+  def build_items
+    pagy.series.map { |i| item(number: i, href: pagy_url_for(pagy, i), from_pagy: true) }
+  end
+
+  def default_next_text
+    safe_join(["Next", tag.span(class: "govuk-visually-hidden") { " page" }])
+  end
+
+  def default_previous_text
+    safe_join(["Previous", tag.span(class: "govuk-visually-hidden") { " page" }])
+  end
+end

data/app/helpers/govuk_components_helper.rb

@@ -9,6 +9,7 @@ module GovukComponentsHelper
     govuk_header: 'GovukComponent::HeaderComponent',
     govuk_inset_text: 'GovukComponent::InsetTextComponent',
     govuk_notification_banner: 'GovukComponent::NotificationBannerComponent',
+    govuk_pagination: 'GovukComponent::PaginationComponent',
     govuk_panel: 'GovukComponent::PanelComponent',
     govuk_phase_banner: 'GovukComponent::PhaseBannerComponent',
     govuk_section_break: 'GovukComponent::SectionBreakComponent',

data/lib/govuk/components/version.rb

@@ -1,5 +1,5 @@
 module Govuk
   module Components
-    VERSION = '3.0.5'.freeze
+    VERSION = '3.1.1'.freeze
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: govuk-components
 version: !ruby/object:Gem::Version
-  version: 3.0.5
+  version: 3.1.1
 platform: ruby
 authors:
 - DfE developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-08 00:00:00.000000000 Z
+date: 2022-06-27 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -44,28 +58,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.49.1
+        version: 2.56.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.49.1
+        version: 2.56.2
 - !ruby/object:Gem::Dependency
   name: deep_merge
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +226,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.11'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.10.1
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -348,6 +382,11 @@ files:
 - app/components/govuk_component/inset_text_component.rb
 - app/components/govuk_component/notification_banner_component.html.erb
 - app/components/govuk_component/notification_banner_component.rb
+- app/components/govuk_component/pagination_component.rb
+- app/components/govuk_component/pagination_component/adjacent_page.rb
+- app/components/govuk_component/pagination_component/item.rb
+- app/components/govuk_component/pagination_component/next_page.rb
+- app/components/govuk_component/pagination_component/previous_page.rb
 - app/components/govuk_component/panel_component.rb
 - app/components/govuk_component/phase_banner_component.html.erb
 - app/components/govuk_component/phase_banner_component.rb
@@ -373,7 +412,6 @@ files:
 - app/components/govuk_component/table_component/row_component.rb
 - app/components/govuk_component/tag_component.rb
 - app/components/govuk_component/traits.rb
-- app/components/govuk_component/traits/custom_classes.rb
 - app/components/govuk_component/traits/custom_html_attributes.rb
 - app/components/govuk_component/warning_text_component.rb
 - app/helpers/govuk_back_to_top_link_helper.rb

data/app/components/govuk_component/traits/custom_classes.rb

@@ -1,4 +0,0 @@
-module GovukComponent
-  module Traits
-  end
-end