govuk_publishing_components 21.56.0 → 21.58.0

data/app/views/govuk_publishing_components/components/docs/list.yml

@@ -0,0 +1,64 @@
+name: List
+description: A list - unordered or ordered, with or without counters / bullet points.
+body: |
+  This is an ordered or unordered list, with or without visible bullets / numbers.
+
+  The `items` parameter can include HTML to display - such as links or another
+  list. This HTML can either be directly coded or come from another component.
+accessibility_criteria: |
+  The list must:
+
+  - inform the user how many items are in the list
+  - convey the content structure
+  - indicate the current page when contents span different pages, and not link to itself
+
+  The list may:
+
+  - include an `aria-label` to contextualise the list if helpful
+govuk_frontend_components:
+  - list
+examples:
+  default:
+    description: "The default is an unordered list with no bullet points or numbers."
+    data: &default-example-data
+      items:
+      - "Tony’s Chocolonely"
+      - '<a href="https://en.wikipedia.org/wiki/Cherry_Ripe_(chocolate_bar)" rel="noopener" class="govuk-link">Cherry Ripe</a>'
+      - "Snickers"
+      - "Chomp"
+      - "Penguin"
+      - "Boost"
+  unordered_list_with_aria-label:
+    description: "A list with an aria-label"
+    data:
+      aria_label: "A list of delicious chocolate bars."
+      <<: *default-example-data
+  unordered_list_with_bullet_points:
+    description: "An unordered list with visible bullet points."
+    data:
+      visible_counters: true
+      <<: *default-example-data
+  ordered_list_without_numbers:
+    description: "This is an ordered list where the numbers aren't visible."
+    data:
+      list_type: "number"
+      <<: *default-example-data
+  ordered_list_with_numbers:
+    description: |
+      This is an ordered list with the numbers visible.
+    data:
+      list_type: "number"
+      visible_counters: true
+      <<: *default-example-data
+  with_extra_spacing:
+    description: |
+      Increases the amount of spacing between the list items.
+    data:
+      extra_spacing: true
+      <<: *default-example-data
+  with_id_attribute:
+    description: |
+      Sets the `id` on the `ul` or `ol` element.
+    data:
+      id: 'super-fantastic-chocolate-list'
+      <<: *default-example-data

data/app/views/govuk_publishing_components/components/docs/print_link.yml

@@ -0,0 +1,24 @@
+name: Print link
+description: A link with a print icon to help users print the current page
+body: |
+  This component renders two different outputs depending on whether a `href` is specified. By default, when no `href` is given, the component renders as a button and triggers a print action via JavaScript. In this case the component is hidden in environments where JavaScript is disabled and can be used as a progressive enhancement. When a `href` is specified the component renders as an anchor tag and navigates to that `href` without JavaScript, suitable for applications which have paths that trigger a print event on load.
+accessibility_criteria: |
+  - The print icon must be presentational and ignored by screen readers.
+shared_accessibility_criteria:
+  - link
+examples:
+  default:
+    description: This component calls `print()` via the browser's DOM API. By default it relies on JavaScript and is not shown in environments where JavaScript is disabled. The \"link\" here is actually a button tag because this is not a navigation event. 
+  with_different_text:
+    data:
+      text: "Print this manual"
+  with_different_href:
+    description: You can specify a alternative `href` URL that will override the default behaviour. When a `href` is specified the print link will render as an anchor tag and be displayed even when JavaScript is disabled.
+    data:
+      href: "/print"
+  with_data_attributes:
+    data:
+      data_attributes:
+        track-category: "printButton"
+        track-action: "clicked"
+        track-label: "Print this page"

data/config/locales/en.yml

@@ -58,6 +58,8 @@ en:
       policies: "Policies"
       statistical_data_sets: "Statistical data sets"
       topical_events: "Topical events"
+    print_link:
+      text: "Print this page"
     skip_link:
       text: "Skip to main content"
     step_by_step_nav:

data/lib/govuk_publishing_components.rb

@@ -12,9 +12,10 @@ require "govuk_publishing_components/presenters/contextual_navigation"
 require "govuk_publishing_components/presenters/related_navigation_helper"
 require "govuk_publishing_components/presenters/step_by_step_nav_helper"
 require "govuk_publishing_components/presenters/page_with_step_by_step_navigation"
-require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_parent"
+require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_ancestors"
 require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_priority"
 require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons"
+require "govuk_publishing_components/presenters/content_breadcrumbs_based_on_topic"
 require "govuk_publishing_components/presenters/checkboxes_helper"
 require "govuk_publishing_components/presenters/select"
 require "govuk_publishing_components/presenters/meta_tags"

data/lib/govuk_publishing_components/presenters/breadcrumb_selector.rb

@@ -1,10 +1,6 @@
 module GovukPublishingComponents
   module Presenters
     class BreadcrumbSelector
-      def self.call(*args)
-        new(*args).output
-      end
-
       attr_reader :content_item, :request, :prioritise_taxon_breadcrumbs
 
       def initialize(content_item, request, prioritise_taxon_breadcrumbs)
@@ -13,47 +9,28 @@ module GovukPublishingComponents
         @prioritise_taxon_breadcrumbs = prioritise_taxon_breadcrumbs
       end
 
-      def content_item_navigation
-        @content_item_navigation ||= ContextualNavigation.new(content_item, request)
+      def breadcrumbs
+        best_match_option[:breadcrumbs]
       end
 
-      def parent_item_navigation
-        @parent_item_navigation ||= ContextualNavigation.new(parent_item, request)
+      def step_by_step
+        best_match_option[:step_by_step]
       end
 
-      def parent_item
-        @parent_item ||= Services.content_store.content_item(content_item_navigation.parent_api_path)
-      rescue GdsApi::ContentStore::ItemNotFound
-        # Do nothing
-      end
+      def priority_breadcrumbs
+        return parent_item_navigation.priority_breadcrumbs if content_item_navigation.html_publication_with_parent?
 
-      def parent_item_options
-        @parent_item_options ||= options(parent_item_navigation)
+        content_item_navigation.priority_breadcrumbs
       end
 
-      def content_item_options
-        @content_item_options ||= options(content_item_navigation)
-      end
+    private
 
-      def parent_breadcrumbs
-        breadcrumbs = [parent_item_options[:breadcrumbs]].flatten # to ensure breadcrumbs always an array
-        breadcrumbs.last[:is_page_parent] = false
-        breadcrumbs << {
-          title: parent_item["title"],
-          url: parent_item["base_path"],
-          is_page_parent: true,
-        }
-      end
-
-      def output
+      def best_match_option
         return content_item_options unless content_item_navigation.html_publication_with_parent?
-        return parent_item_options if parent_item_navigation.priority_breadcrumbs
-
-        step_by_step_header = parent_item_options[:step_by_step]
 
         {
-          step_by_step: step_by_step_header,
-          breadcrumbs: step_by_step_header ? parent_breadcrumbs.first : parent_breadcrumbs,
+          step_by_step: parent_is_step_by_step?,
+          breadcrumbs: parent_is_step_by_step? ? parent_breadcrumbs.first : parent_breadcrumbs,
         }
       end
 
@@ -61,18 +38,13 @@ module GovukPublishingComponents
         if navigation.content_tagged_to_a_finder?
           {
             step_by_step: false,
-            breadcrumbs: navigation.breadcrumbs,
+            breadcrumbs: navigation.finder_breadcrumbs,
           }
         elsif navigation.content_tagged_to_current_step_by_step?
           {
             step_by_step: true,
             breadcrumbs: navigation.step_nav_helper.header,
           }
-        elsif navigation.priority_breadcrumbs
-          {
-            step_by_step: true,
-            breadcrumbs: navigation.priority_breadcrumbs,
-          }
         elsif navigation.content_is_tagged_to_a_live_taxon? && prioritise_taxon_breadcrumbs
           {
             step_by_step: false,
@@ -83,10 +55,10 @@ module GovukPublishingComponents
             step_by_step: false,
             breadcrumbs: navigation.breadcrumbs,
           }
-        elsif navigation.content_has_curated_related_items?
+        elsif navigation.content_has_a_topic?
           {
             step_by_step: false,
-            breadcrumbs: navigation.breadcrumbs,
+            breadcrumbs: navigation.topic_breadcrumbs,
           }
         elsif navigation.use_taxon_breadcrumbs?
           {
@@ -102,6 +74,42 @@ module GovukPublishingComponents
           {}
         end
       end
+
+      def content_item_navigation
+        @content_item_navigation ||= ContextualNavigation.new(content_item, request)
+      end
+
+      def parent_item_navigation
+        @parent_item_navigation ||= ContextualNavigation.new(parent_item, request)
+      end
+
+      def parent_item
+        @parent_item ||= Services.content_store.content_item(content_item_navigation.parent_api_path)
+      rescue GdsApi::ContentStore::ItemNotFound
+        # Do nothing
+      end
+
+      def parent_item_options
+        @parent_item_options ||= options(parent_item_navigation)
+      end
+
+      def content_item_options
+        @content_item_options ||= options(content_item_navigation)
+      end
+
+      def parent_breadcrumbs
+        breadcrumbs = [parent_item_options[:breadcrumbs]].flatten # to ensure breadcrumbs always an array
+        breadcrumbs.last[:is_page_parent] = false
+        breadcrumbs << {
+          title: parent_item["title"],
+          url: parent_item["base_path"],
+          is_page_parent: true,
+        }
+      end
+
+      def parent_is_step_by_step?
+        parent_item_options[:step_by_step]
+      end
     end
   end
 end

data/lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_ancestors.rb

@@ -0,0 +1,41 @@
+module GovukPublishingComponents
+  module Presenters
+    # @private
+    class ContentBreadcrumbsBasedOnAncestors
+      def self.call(content_item)
+        new(content_item).breadcrumbs
+      end
+
+      def initialize(content_item)
+        @content_item = ContentItem.new(content_item)
+      end
+
+      def breadcrumbs
+        ordered_ancestors = all_ancestors.map do |ancestor|
+          { title: ancestor.title, url: ancestor.base_path }
+        end
+
+        ordered_ancestors << { title: "Home", url: "/" }
+        ordered_ancestors.reverse!
+        ordered_ancestors
+      end
+
+    private
+
+      attr_reader :content_item
+
+      def all_ancestors
+        ancestors = []
+
+        parent = content_item.parent
+        while parent
+          ancestors << parent
+
+          parent = parent.parent
+        end
+
+        ancestors
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_priority.rb

@@ -6,6 +6,7 @@ module GovukPublishingComponents
       #   and the bottom one the lowest priority
       PRIORITY_TAXONS = {
         education_coronavirus: "272308f4-05c8-4d0d-abc7-b7c2e3ccd249",
+        worker_coronavirus: "b7f57213-4b16-446d-8ded-81955d782680",
         business_coronavirus: "65666cdf-b177-4d79-9687-b9c32805e450",
       }.freeze
 

data/lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons.rb

@@ -2,6 +2,10 @@ module GovukPublishingComponents
   module Presenters
     # @private
     class ContentBreadcrumbsBasedOnTaxons
+      def self.call(content_item)
+        new(content_item).breadcrumbs
+      end
+
       def initialize(content_item)
         @content_item = ContentItem.new(content_item)
       end

data/lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_topic.rb

@@ -0,0 +1,38 @@
+module GovukPublishingComponents
+  module Presenters
+    class ContentBreadcrumbsBasedOnTopic
+      def self.call(content_item)
+        new(content_item).breadcrumbs
+      end
+
+      attr_reader :content_item
+
+      def initialize(content_item)
+        @content_item = content_item
+      end
+
+      def breadcrumbs
+        breadcrumbs = [{ title: "Home", url: "/" }]
+        return breadcrumbs unless topics.present?
+
+        breadcrumbs << topic_breadcrumb
+        breadcrumbs
+      end
+
+      def topic_breadcrumb
+        {
+          title: first_topic["title"],
+          url: first_topic["base_path"],
+        }
+      end
+
+      def first_topic
+        topics.first
+      end
+
+      def topics
+        @topics ||= content_item.dig("links", "topics")
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/contextual_navigation.rb

@@ -26,15 +26,22 @@ module GovukPublishingComponents
       end
 
       def taxon_breadcrumbs
-        @taxon_breadcrumbs ||= ContentBreadcrumbsBasedOnTaxons.new(content_item).breadcrumbs
+        @taxon_breadcrumbs ||= ContentBreadcrumbsBasedOnTaxons.call(content_item)
       end
 
       def priority_breadcrumbs
         @priority_breadcrumbs ||= ContentBreadcrumbsBasedOnPriority.call(content_item)
       end
 
+      def topic_breadcrumbs
+        @topic_breadcrumbs ||= ContentBreadcrumbsBasedOnTopic.call(content_item)
+      end
+
       def breadcrumbs
-        return breadcrumbs_based_on_parent unless content_tagged_to_a_finder?
+        breadcrumbs_based_on_ancestors
+      end
+
+      def finder_breadcrumbs
         return [] unless parent_finder
 
         [
@@ -77,6 +84,10 @@ module GovukPublishingComponents
         content_item["document_type"] == "html_publication"
       end
 
+      def content_has_a_topic?
+        content_item.dig("links", "topics").present?
+      end
+
       def tagged_to_brexit?
         taxons = content_item.dig("links", "taxons").to_a
         brexit_taxon = "d6c2de5d-ef90-45d1-82d4-5f2438369eea"
@@ -119,8 +130,8 @@ module GovukPublishingComponents
         step_nav_helper.show_also_part_of_step_nav?
       end
 
-      def breadcrumbs_based_on_parent
-        ContentBreadcrumbsBasedOnParent.new(content_item).breadcrumbs[:breadcrumbs]
+      def breadcrumbs_based_on_ancestors
+        ContentBreadcrumbsBasedOnAncestors.call(content_item)
       end
 
       def step_nav_helper

data/lib/govuk_publishing_components/presenters/page_with_step_by_step_navigation.rb

@@ -3,6 +3,8 @@ module GovukPublishingComponents
     # @private
     # Only used by the step by step component
     class PageWithStepByStepNavigation
+      MAX_SECTION_LENGTH = RelatedNavigationHelper::MAX_SECTION_LENGTH
+
       def initialize(content_store_response, current_path, query_parameters = {})
         @content_item = content_store_response.to_h.deep_symbolize_keys
         @current_path = current_path
@@ -48,7 +50,7 @@ module GovukPublishingComponents
       end
 
       def show_also_part_of_step_nav?
-        active_step_by_step? && also_part_of_step_nav.any? && step_navs_combined_list.count < 5
+        active_step_by_step? && also_part_of_step_nav.any? && step_navs_combined_list.count < MAX_SECTION_LENGTH
       end
 
       def related_links

data/lib/govuk_publishing_components/presenters/related_navigation_helper.rb

@@ -31,7 +31,7 @@ module GovukPublishingComponents
           }
         when :footer
           {
-            "topics" => related_topics,
+            "topics" => related_topics_or_taxons,
             "topical_events" => related_topical_events,
             "world_locations" => related_world_locations,
             "statistical_data_sets" => related_statistical_data_sets,
@@ -43,7 +43,7 @@ module GovukPublishingComponents
             "related_items" => related_items,
             "related_guides" => related_guides,
             "collections" => related_document_collections,
-            "topics" => related_topics,
+            "topics" => related_topics_or_taxons,
             "topical_events" => related_topical_events,
             "world_locations" => related_world_locations,
             "statistical_data_sets" => related_statistical_data_sets,
@@ -162,26 +162,27 @@ module GovukPublishingComponents
       end
 
       def related_taxons
-        content_item_links_for("taxons", only: "taxon")
+        @related_taxons ||= content_item_links_for("taxons", only: "taxon")
       end
 
-      def related_topics
-        if related_legacy_topics.any?
-          related_legacy_topics
-        elsif related_taxons.any?
-          related_taxons
-        else
-          []
-        end
+      def related_topics_or_taxons
+        return related_topics if related_topics.any?
+        return related_taxons if related_taxons.any?
+
+        []
       end
 
-      def related_legacy_topics
-        mainstream_browse_page_links = content_item_links_for("mainstream_browse_pages", only: "mainstream_browse_page")
-        topic_links = content_item_links_for("topics", only: "topic")
+      def related_topics
+        @related_topics ||= begin
+          mainstream_browse_page_links = content_item_links_for("mainstream_browse_pages", only: "mainstream_browse_page")
+          topic_links = content_item_links_for("topics", only: "topic")
+
+          return topic_links if topic_links.present? && mainstream_browse_page_links.empty?
 
-        mainstream_browse_page_links + topic_links.find_all do |topic_link|
-          mainstream_browse_page_links.none? do |mainstream_browse_page_link|
-            mainstream_browse_page_link[:text] == topic_link[:text]
+          mainstream_browse_page_links + topic_links.find_all do |topic_link|
+            mainstream_browse_page_links.none? do |mainstream_browse_page_link|
+              mainstream_browse_page_link[:text] == topic_link[:text]
+            end
           end
         end
       end