govuk_publishing_components 21.52.0 → 21.55.1

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

@@ -20,9 +20,32 @@ examples:
     data:
       title: 'Coronavirus: businesses and self-employed people'
       path: /childcare-parenting/pregnancy-and-birth
+  with_margin_bottom:
+    description: |
+      The component accepts a number for margin bottom from 0 to 9 (0px to 60px) using the [GOV.UK Frontend spacing scale](https://design-system.service.gov.uk/styles/spacing/#the-responsive-spacing-scale). It defaults to having a margin bottom of 30px.
+    data:
+      title: 'Learn to practice flexible spacing: step by step'
+      margin_bottom: 9
   with_unique_tracking:
     description: In order to identify the step by step navigation the component is part of, we need to track a unique ID of the navigation in Google Analytics. This ID should be the same across all pages that are linked from and are part of that navigation. Its value is included in any tracking events, specifically in dimension96. It refers to the ID of the step nav that the component links to.
     data:
       title: 'With a tracking id'
       path: '#'
       tracking_id: 'this-is-the-tracking-id'
+  with_custom_tracking:
+    data:
+      title: 'With a custom tracking'
+      path: '#'
+      tracking_category: "customTrackingCategoryClicked"
+      tracking_action: "customTrackingAction"
+      tracking_label: "customTrackingLabel"
+      tracking_dimension: "customTrackingDimension"
+      tracking_dimension_index: "23"
+  without_custom_dimension:
+    data:
+      title: 'Without custom dimensions'
+      path: '#'
+      tracking_category: "customTrackingCategoryClicked"
+      tracking_action: "customTrackingAction"
+      tracking_label: "customTrackingLabel"
+      tracking_dimension_enabled: false

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,107 @@
+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_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,
+        }
+      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,22 @@ 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"],
+          tracking_category: "breadcrumbClicked",
+          tracking_action: "superBreadcrumb",
+          tracking_label: content_item["base_path"],
+          tracking_dimension_enabled: false,
+        }
+      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_publication_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/presenters/machine_readable/faq_page_schema.rb

@@ -24,9 +24,8 @@ module GovukPublishingComponents
       end
 
       def questions_and_answers_markup
-        question_and_answers(page.body)
-          .select { |_, value| value[:answer].present? }
-          .map do |question, value|
+        question_and_answers.select { |_, value| value[:answer].present? }
+                            .map do |question, value|
           q_and_a_url = section_url(value[:anchor])
 
           {
@@ -52,9 +51,7 @@ module GovukPublishingComponents
       #
       # - :anchor: the id of the h2 (autogenerated by the markdown converter).
       #            This is used to build links directly to the section in question
-      def question_and_answers(html)
-        doc = Nokogiri::HTML(html)
-
+      def question_and_answers
         question = page.title
 
         doc.xpath("html/body").children.each_with_object({}) do |element, q_and_as|
@@ -71,6 +68,10 @@ module GovukPublishingComponents
         end
       end
 
+      def doc
+        @doc ||= Nokogiri::HTML(page.body)
+      end
+
       def question_hash_is_unset?(q_and_as, question)
         q_and_as[question].nil?
       end

data/lib/govuk_publishing_components/presenters/machine_readable/html_publication_schema.rb

@@ -0,0 +1,77 @@
+module GovukPublishingComponents
+  module Presenters
+    class HtmlPublicationSchema < FaqPageSchema
+      attr_reader :page
+
+      def initialize(page)
+        @page = page
+      end
+
+      def structured_data
+        return ArticleSchema.new(page).structured_data if less_than_two_headings_of_any_one_type?
+
+        super
+      end
+
+      def heading_counts
+        @heading_counts ||= (1..5).each_with_object({}) do |n, hash|
+          heading = "h#{n}"
+          hash[heading] = doc.xpath("//*[@class=\"govspeak\"]//#{heading}").count
+        end
+      end
+
+      def less_than_two_headings_of_any_one_type?
+        heading_counts.values.max < 2
+      end
+
+      def question_and_answers
+        headings.each_with_object({}) do |heading, hash|
+          question = heading.text
+
+          next_heading = heading_pairs[heading]
+          next_heading_path = next_heading && next_heading.path
+          answer = content_between(heading.path, next_heading_path)
+
+          hash[question] = {
+            answer: answer.map(&:to_s).join,
+            anchor: heading.attr(:id),
+          }
+        end
+      end
+
+      def headings
+        @headings ||= doc.xpath("//*[@class=\"govspeak\"]//#{first_heading_type_with_more_than_one_occurance}")
+      end
+
+      def first_heading_type_with_more_than_one_occurance
+        heading_counts.detect { |_k, v| v > 1 }.first
+      end
+
+      def heading_pairs
+        @heading_pairs ||= pairs_hash(headings)
+      end
+
+      # Converts [:a, :b, :c] into
+      # {:a => :b, :b => :c}
+      def pairs_hash(array)
+        all_but_last = array[0..-2]
+        all_but_first = array[1..-1]
+        pairs = [all_but_last, all_but_first].transpose
+        Hash[pairs]
+      end
+
+      # From: https://stackoverflow.com/a/7816046/1014251
+      # If `stop_xpath` is `nil` gets text to end of content
+      def content_between(start_xpath, stop_xpath = nil)
+        node = doc.at_xpath(start_xpath).next_element
+        stop = stop_xpath && doc.at_xpath(stop_xpath)
+        [].tap do |content|
+          while node && node != stop
+            content << node
+            node = node.next_element
+          end
+        end
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/schema_org.rb

@@ -4,6 +4,7 @@ require "govuk_publishing_components/presenters/machine_readable/creative_work_s
 require "govuk_publishing_components/presenters/machine_readable/faq_page_schema"
 require "govuk_publishing_components/presenters/machine_readable/government_service_schema"
 require "govuk_publishing_components/presenters/machine_readable/has_part_schema"
+require "govuk_publishing_components/presenters/machine_readable/html_publication_schema"
 require "govuk_publishing_components/presenters/machine_readable/is_part_of_schema"
 require "govuk_publishing_components/presenters/machine_readable/news_article_schema"
 require "govuk_publishing_components/presenters/machine_readable/organisation_schema"
@@ -22,22 +23,29 @@ module GovukPublishingComponents
       end
 
       def structured_data
-        if page.schema == :faq
-          FaqPageSchema.new(page).structured_data
-        elsif page.schema == :article
-          ArticleSchema.new(page).structured_data
-        elsif page.schema == :government_service
-          GovernmentServiceSchema.new(page).structured_data
-        elsif page.schema == :news_article
-          NewsArticleSchema.new(page).structured_data
-        elsif page.schema == :person
-          PersonSchema.new(page).structured_data
-        elsif page.schema == :organisation
-          OrganisationSchema.new(page).structured_data
-        elsif page.schema == :search_results_page
-          SearchResultsPageSchema.new(page).structured_data
-        elsif page.schema == :dataset
-          DatasetSchema.new(page).structured_data
+        schema_for_page.new(page).structured_data
+      end
+
+      def schema_for_page
+        case page.schema
+        when :faq
+          FaqPageSchema
+        when :article
+          ArticleSchema
+        when :government_service
+          GovernmentServiceSchema
+        when :news_article
+          NewsArticleSchema
+        when :person
+          PersonSchema
+        when :organisation
+          OrganisationSchema
+        when :search_results_page
+          SearchResultsPageSchema
+        when :dataset
+          DatasetSchema
+        when :html_publication
+          HtmlPublicationSchema
         else
           raise "#{page.schema} is not supported"
         end