govuk_publishing_components 21.52.1 → 21.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65eb0fccf1664b1adcf30dd55e74c36e06f066c820af124c0552d44ebbe78d31
-  data.tar.gz: e9b31f220f80191550b6e4674b29971dea1a1caf707ef586733cb13b42137642
+  metadata.gz: 9b75297c083a34e5136622cab23b3e1b393318cf789a15ba9c5deca7d96a4115
+  data.tar.gz: 6cf830ee77d6f2126b007ed24a55e905d42884b80cac984d29bd900b1d1dbb3f
 SHA512:
-  metadata.gz: a28ae072f25f52aa4c900228f8e12f0939de188df0d47aa74d594fc43eb57d4bf180413a7e902a82a9aacec8d5747dc2c4f124a762a39edd44684693ecad0b3a
-  data.tar.gz: b8501ea511d02c48db9b3fa4ffa27c7db8178caf5c427dcc6b74adedfaba54a006695df9cf13153fec95507ef10bf2be557cca4a2e089fdfbc4ae5c5c35bad75
+  metadata.gz: 365054c463d00d090f45861e6ce505a99c97b39e477759d94e1595254024c68bebaa02c329ec50b2635712d8a4fb7e1de34b17439473ee2136a0993a51fcdf97
+  data.tar.gz: f4a3fc8fc08f9e3e10840bcb8ef0bde1c94da69ef388ee6b5cf2be405ce4424bd35315a300c3e640af310a76e3c666c6ad2213bcfe9eaa47a084c9a1e314f6bf

data/app/views/govuk_publishing_components/components/_contextual_breadcrumbs.html.erb

@@ -1,47 +1,16 @@
-<% navigation = GovukPublishingComponents::Presenters::ContextualNavigation.new(content_item, request) %>
 <% prioritise_taxon_breadcrumbs ||= false %>
+<% breadcrumb_selector = GovukPublishingComponents::Presenters::BreadcrumbSelector.call(content_item, request, prioritise_taxon_breadcrumbs) %>
 <% inverse ||= false %>
 <% collapse_on_mobile ||= true unless local_assigns[:collapse_on_mobile].eql?(false) %>
 
 <div class='gem-c-contextual-breadcrumbs'>
-
-  <% if navigation.priority_taxon %>
-    <%= render 'govuk_publishing_components/components/step_by_step_nav_header',
-      {
-        title: navigation.priority_taxon['title'],
-        path: navigation.priority_taxon['base_path']
-      }
-    %>
-  <% elsif navigation.content_tagged_to_current_step_by_step? %>
-    <%# Rendering step by step nav breadcrumbs because there's 1 step by step %>
+  <% if breadcrumb_selector[:step_by_step] %>
     <%= render 'govuk_publishing_components/components/step_by_step_nav_header',
-      navigation.step_nav_helper.header %>
-  <% elsif navigation.content_tagged_to_a_finder? %>
-    <%# Rendering finder breadcrumbs because the page is tagged to a finder %>
-    <%= render 'govuk_publishing_components/components/breadcrumbs', breadcrumbs: navigation.breadcrumbs, inverse: inverse, collapse_on_mobile: collapse_on_mobile %>
-  <% elsif navigation.content_is_tagged_to_a_live_taxon? && prioritise_taxon_breadcrumbs %>
-    <%# Rendering taxonomy breadcrumbs because the page is tagged to live taxons
-          and we want to prioritise them over all other breadcrumbs %>
+               breadcrumb_selector[:breadcrumbs] %>
+  <% elsif breadcrumb_selector[:breadcrumbs] %>
     <%= render 'govuk_publishing_components/components/breadcrumbs',
-               breadcrumbs: navigation.taxon_breadcrumbs[:breadcrumbs],
+               breadcrumbs: breadcrumb_selector[:breadcrumbs],
                inverse: inverse,
                collapse_on_mobile: collapse_on_mobile %>
-  <% elsif navigation.content_tagged_to_mainstream_browse_pages? %>
-    <%# Rendering parent-based breadcrumbs because the page is tagged to mainstream browse %>
-    <%= render 'govuk_publishing_components/components/breadcrumbs', breadcrumbs: navigation.breadcrumbs, inverse: inverse, collapse_on_mobile: collapse_on_mobile %>
-  <% elsif navigation.content_has_curated_related_items? %>
-    <%# Rendering parent-based breadcrumbs because the page has curated related links %>
-    <%= render 'govuk_publishing_components/components/breadcrumbs', breadcrumbs: navigation.breadcrumbs, inverse: inverse, collapse_on_mobile: collapse_on_mobile %>
-  <% elsif navigation.content_is_tagged_to_a_live_taxon? && !navigation.content_is_a_specialist_document? %>
-    <%# Rendering taxonomy breadcrumbs because the page is tagged to live taxons %>
-    <%= render 'govuk_publishing_components/components/breadcrumbs',
-      breadcrumbs: navigation.taxon_breadcrumbs[:breadcrumbs],
-      inverse: inverse,
-      collapse_on_mobile: collapse_on_mobile %>
-  <% elsif navigation.breadcrumbs.any? %>
-    <%# Rendering parent-based breadcrumbs because no browse, no related links, no live taxons %>
-    <%= render 'govuk_publishing_components/components/breadcrumbs', breadcrumbs: navigation.breadcrumbs, inverse: inverse, collapse_on_mobile: collapse_on_mobile %>
-  <% else %>
-    <%# Not rendering any breadcrumbs because there aren't any %>
   <% end %>
 </div>

data/lib/govuk_publishing_components.rb

@@ -6,6 +6,7 @@ require "govuk_publishing_components/engine"
 require "govuk_publishing_components/presenters/shared_helper"
 require "govuk_publishing_components/presenters/attachment"
 require "govuk_publishing_components/presenters/breadcrumbs"
+require "govuk_publishing_components/presenters/breadcrumb_selector"
 require "govuk_publishing_components/presenters/button_helper"
 require "govuk_publishing_components/presenters/contextual_navigation"
 require "govuk_publishing_components/presenters/related_navigation_helper"

data/lib/govuk_publishing_components/presenters/breadcrumb_selector.rb

@@ -0,0 +1,105 @@
+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)
+        @content_item = content_item
+        @request = request
+        @prioritise_taxon_breadcrumbs = prioritise_taxon_breadcrumbs
+      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 output
+        return content_item_options unless content_item_navigation.html_document_with_parent?
+        return parent_item_options if parent_item_navigation.priority_breadcrumbs
+
+        {
+          step_by_step: parent_item_options[:step_by_step],
+          breadcrumbs: parent_breadcrumbs,
+        }
+      end
+
+      def options(navigation)
+        if navigation.priority_breadcrumbs
+          {
+            step_by_step: true,
+            breadcrumbs: navigation.priority_breadcrumbs,
+          }
+        elsif navigation.content_tagged_to_current_step_by_step?
+          {
+            step_by_step: true,
+            breadcrumbs: navigation.step_nav_helper.header,
+          }
+        elsif navigation.content_tagged_to_a_finder?
+          {
+            step_by_step: false,
+            breadcrumbs: navigation.breadcrumbs,
+          }
+        elsif navigation.content_is_tagged_to_a_live_taxon? && prioritise_taxon_breadcrumbs
+          {
+            step_by_step: false,
+            breadcrumbs: navigation.taxon_breadcrumbs,
+          }
+        elsif navigation.content_tagged_to_mainstream_browse_pages?
+          {
+            step_by_step: false,
+            breadcrumbs: navigation.breadcrumbs,
+          }
+        elsif navigation.content_has_curated_related_items?
+          {
+            step_by_step: false,
+            breadcrumbs: navigation.breadcrumbs,
+          }
+        elsif navigation.use_taxon_breadcrumbs?
+          {
+            step_by_step: false,
+            breadcrumbs: navigation.taxon_breadcrumbs,
+          }
+        elsif navigation.breadcrumbs.any?
+          {
+            step_by_step: false,
+            breadcrumbs: navigation.breadcrumbs,
+          }
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_priority.rb

@@ -11,7 +11,7 @@ module GovukPublishingComponents
 
       # Returns the highest priority taxon that has a content_id matching those in PRIORITY_TAXONS
       def self.call(content_item)
-        new(content_item).taxon
+        new(content_item).breadcrumbs
       end
 
       attr_reader :content_item
@@ -24,9 +24,15 @@ module GovukPublishingComponents
         @taxon ||= priority_taxons.min_by { |t| PRIORITY_TAXONS.values.index(t["content_id"]) }
       end
 
+      def breadcrumbs
+        taxon && { title: taxon["title"], path: taxon["base_path"] }
+      end
+
     private
 
       def priority_taxons
+        return [] unless content_item["links"].is_a?(Hash)
+
         taxons = content_item.dig("links", "taxons")
         taxon_tree(taxons).select do |taxon|
           priority_taxon?(taxon)

data/lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons.rb

@@ -21,9 +21,7 @@ module GovukPublishingComponents
           is_page_parent: ordered_parents.empty?,
         }
 
-        {
-          breadcrumbs: ordered_parents.reverse,
-        }
+        ordered_parents.reverse
       end
 
     private

data/lib/govuk_publishing_components/presenters/contextual_navigation.rb

@@ -16,32 +16,41 @@ module GovukPublishingComponents
         content_item["document_type"] == "simple_smart_answer"
       end
 
+      def html_document_with_parent?
+        (content_item["document_type"] == "html_publication") && parent_api_path
+      end
+
+      def parent_api_path
+        parent = content_item.dig("links", "parent")&.first
+        parent["base_path"] if parent
+      end
+
       def taxon_breadcrumbs
         @taxon_breadcrumbs ||= ContentBreadcrumbsBasedOnTaxons.new(content_item).breadcrumbs
       end
 
-      def priority_taxon
-        @priority_taxon ||= ContentBreadcrumbsBasedOnPriority.call(content_item)
+      def priority_breadcrumbs
+        @priority_breadcrumbs ||= ContentBreadcrumbsBasedOnPriority.call(content_item)
       end
 
       def breadcrumbs
-        if content_tagged_to_a_finder?
-          parent_finder = content_item.dig("links", "finder", 0)
-          return [] unless parent_finder
-
-          [
-            {
-              title: "Home",
-              url: "/",
-            },
-            {
-              title: parent_finder["title"],
-              url: parent_finder["base_path"],
-            },
-          ]
-        else
-          ContentBreadcrumbsBasedOnParent.new(content_item).breadcrumbs[:breadcrumbs]
-        end
+        return breadcrumbs_based_on_parent unless content_tagged_to_a_finder?
+        return [] unless parent_finder
+
+        [
+          {
+            title: "Home",
+            url: "/",
+          },
+          {
+            title: parent_finder["title"],
+            url: parent_finder["base_path"],
+          },
+        ]
+      end
+
+      def use_taxon_breadcrumbs?
+        content_is_tagged_to_a_live_taxon? && !content_is_a_specialist_document?
       end
 
       def content_tagged_to_a_finder?
@@ -64,6 +73,10 @@ module GovukPublishingComponents
         content_item["schema_name"] == "specialist_document"
       end
 
+      def content_is_a_html_publication?
+        content_item["document_type"] == "html_publication"
+      end
+
       def tagged_to_brexit?
         taxons = content_item.dig("links", "taxons").to_a
         brexit_taxon = "d6c2de5d-ef90-45d1-82d4-5f2438369eea"
@@ -106,9 +119,17 @@ module GovukPublishingComponents
         step_nav_helper.show_also_part_of_step_nav?
       end
 
+      def breadcrumbs_based_on_parent
+        ContentBreadcrumbsBasedOnParent.new(content_item).breadcrumbs[:breadcrumbs]
+      end
+
       def step_nav_helper
         @step_nav_helper ||= PageWithStepByStepNavigation.new(content_item, request_path, query_parameters)
       end
+
+      def parent_finder
+        @parent_finder ||= content_item.dig("links", "finder", 0)
+      end
     end
   end
 end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = "21.52.1".freeze
+  VERSION = "21.53.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 21.52.1
+  version: 21.53.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -748,6 +748,7 @@ files:
 - lib/govuk_publishing_components/engine.rb
 - lib/govuk_publishing_components/minitest/component_guide_test.rb
 - lib/govuk_publishing_components/presenters/attachment.rb
+- lib/govuk_publishing_components/presenters/breadcrumb_selector.rb
 - lib/govuk_publishing_components/presenters/breadcrumbs.rb
 - lib/govuk_publishing_components/presenters/button_helper.rb
 - lib/govuk_publishing_components/presenters/checkboxes_helper.rb