govuk_publishing_components 12.20.0 → 12.21.0

data/lib/govuk_publishing_components/presenters/contextual_navigation.rb

@@ -16,10 +16,6 @@ module GovukPublishingComponents
         content_item['document_type'] === "simple_smart_answer"
       end
 
-      def taxonomy_sidebar
-        @taxonomy_sidebar ||= TaxonomyNavigation.new(content_item).sidebar
-      end
-
       def taxon_breadcrumbs
         @taxon_breadcrumbs ||= ContentBreadcrumbsBasedOnTaxons.new(content_item).breadcrumbs
       end

data/lib/govuk_publishing_components/presenters/related_navigation_helper.rb

@@ -13,35 +13,69 @@ module GovukPublishingComponents
         statistical_data_sets
       ).freeze
 
-      def initialize(content_item)
+      def initialize(content_item:, context: nil)
         @content_item = content_item
+        @context = context
       end
 
       def related_navigation
-        {
-          "related_items" => related_items,
-          "related_guides" => related_guides,
-          "collections" => related_collections,
-          "topics" => related_topics,
-          "topical_events" => related_topical_events,
-          "world_locations" => related_world_locations,
-          "statistical_data_sets" => related_statistical_data_sets,
-          "related_external_links" => related_external_links,
-          "related_contacts" => related_contacts,
-        }
+        case @context.try(:to_sym)
+        when :sidebar
+          {
+            "related_items" => related_items,
+            "related_guides" => related_guides,
+            "collections" => related_document_collections,
+          }
+        when :footer
+          {
+            "topics" => related_topics,
+            "topical_events" => related_topical_events,
+            "world_locations" => related_world_locations,
+            "statistical_data_sets" => related_statistical_data_sets,
+            "related_external_links" => related_external_links,
+            "related_contacts" => related_contacts,
+          }
+        else
+          {
+            "related_items" => related_items,
+            "related_guides" => related_guides,
+            "collections" => related_document_collections,
+            "topics" => related_topics,
+            "topical_events" => related_topical_events,
+            "world_locations" => related_world_locations,
+            "statistical_data_sets" => related_statistical_data_sets,
+            "related_external_links" => related_external_links,
+            "related_contacts" => related_contacts,
+          }
+        end
       end
 
       def construct_section_heading(section_title)
         unless section_title === "related_items"
-          I18n.t('components.related_navigation.' + section_title, default: section_title.tr('_', ' '))
+          I18n.t("components.related_#{@context}_navigation." + section_title,
+                 default: [
+                   I18n.t('components.related_navigation.' + section_title),
+                   section_title.tr('_', ' '),
+                 ])
         end
       end
 
       def section_css_class(css_class, section_title, link = {})
+        css_classes = [css_class, "#{css_class}--#{@context}"]
+
         unless DEFINED_SECTIONS.include?(section_title) || link.fetch(:finder, false)
-          css_class += " #{css_class}--other"
+          css_classes << " #{css_class}--other"
         end
-        css_class
+
+        css_classes.join(' ')
+      end
+
+      def section_data_track_count(section_title)
+        String(@context || 'sidebar') + String(section_title).camelcase
+      end
+
+      def section_heading_level
+        @context == :footer ? 'h2' : 'h3'
       end
 
       def calculate_section_link_limit(links)
@@ -52,121 +86,105 @@ module GovukPublishingComponents
         links.length - MAX_SECTION_LENGTH
       end
 
-      def anything_to_show?
+      def related_navigation?
         related_navigation.flat_map(&:last).any?
       end
 
     private
 
-      def build_links_for_sidebar(collection, path_key = "base_path", additional_attr = {})
-        collection.map do |link|
-          {
-            path: link[path_key],
-            text: link["title"]
-          }.merge(additional_attr)
-        end
-      end
-
-      def world_location_base_path(title)
-        "/world/#{parameterise(title)}/news"
-      end
-
       def related_items
-        links = build_links_for_sidebar(quick_links, "url")
-        mainstream_links = related_mainstream_content
-        related_ordered_items = link_group("ordered_related_items")
-        if links.any?
-          links + mainstream_links
+        related_quick_links = content_item_details_for('quick_links')
+
+        if related_quick_links.any?
+          related_quick_links + related_mainstream_content
         else
-          build_links_for_sidebar(related_ordered_items) + mainstream_links
+          content_item_links_for('ordered_related_items') + related_mainstream_content
         end
       end
 
-      def quick_links
-        @content_item.dig("details", "quick_links").to_a
-      end
-
       def related_world_locations
-        locations = link_group("world_locations")
-        locations.map! { |link| link.merge("base_path" => world_location_base_path(link["title"])) }
-        build_links_for_sidebar(locations)
+        content_item_links_for('world_locations')
+          .map { |link| link.merge(path: "/world/#{link[:text].parameterize}/news") }
       end
 
-      def related_collections
-        collections = filter_link_type("document_collections", "document_collection")
-        build_links_for_sidebar(collections)
+      def related_statistical_data_sets
+        content_item_links_for('related_statistical_data_sets', only: 'statistical_data_set')
       end
 
-      def filter_link_type(group, type)
-        links = link_group(group)
-        links.select do |link|
-          link["document_type"] == type
-        end
+      def related_taxons
+        content_item_links_for('taxons', only: 'taxon')
       end
 
-      def related_statistical_data_sets
-        statistical_data_sets = filter_link_type("related_statistical_data_sets", "statistical_data_set")
-        build_links_for_sidebar(statistical_data_sets)
+      def related_topics
+        if related_legacy_topics.any?
+          related_legacy_topics
+        elsif related_taxons.any?
+          related_taxons
+        else
+          []
+        end
       end
 
-      def related_topics
-        mainstream_browse_pages = filter_link_type("mainstream_browse_pages", "mainstream_browse_page")
+      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')
 
-        topics_that_dont_duplicate_browse = filter_link_type("topics", "topic").select do |topic|
-          mainstream_browse_pages.none? { |browse_page| browse_page["title"] == topic["title"] }
+        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
-
-        links = build_links_for_sidebar(mainstream_browse_pages + topics_that_dont_duplicate_browse)
-        links.compact
       end
 
       def related_topical_events
-        topical_events = filter_link_type("topical_events", "topical_event")
-        build_links_for_sidebar(topical_events)
+        content_item_links_for('topical_events', only: 'topical_event')
       end
 
       def related_contacts
-        contacts = filter_link_type("related", "contact")
-        build_links_for_sidebar(contacts)
+        content_item_links_for('related', only: 'contact')
       end
 
       def related_external_links
-        external_links = @content_item.dig("details", "external_related_links").to_a
-        build_links_for_sidebar(external_links, "url", rel: "external")
-      end
-
-      def parameterise(str, sep = "-")
-        parameterised_str = str.gsub(/[^\w\-]+/, sep)
-        unless sep.nil? || sep.empty?
-          re_sep = Regexp.escape(sep)
-          # No more than one of the separator in a row.
-          parameterised_str.gsub!(/#{re_sep}{2,}/, sep)
-          # Remove leading/trailing separator.
-          parameterised_str.gsub!(/^#{re_sep}|#{re_sep}$/, '')
-        end
-        parameterised_str.downcase
-      end
-
-      def related_links
-        link_group("ordered_related_items")
+        content_item_details_for('external_related_links')
       end
 
       def related_mainstream_content
-        return [] unless @content_item["document_type"] == "detailed_guide"
+        return [] unless detailed_guide?
 
-        content = link_group("related_mainstream_content")
-        build_links_for_sidebar(content)
+        content_item_links_for('related_mainstream_content')
       end
 
       def related_guides
-        return [] unless @content_item["document_type"] == "detailed_guide"
+        return [] unless detailed_guide?
 
-        guides = link_group("related_guides")
-        build_links_for_sidebar(guides)
+        content_item_links_for('related_guides')
       end
 
-      def link_group(type)
-        @content_item.dig("links", type).to_a
+      def related_document_collections
+        content_item_links_for('document_collections', only: 'document_collection')
+      end
+
+      def detailed_guide?
+        @content_item['document_type'] == 'detailed_guide'
+      end
+
+      def content_item_details_for(key)
+        Array(@content_item.dig('details', key))
+          .map { |link| { path: link['url'], text: link['title'], rel: 'external' } }
+      end
+
+      def content_item_links_for(key, only: nil)
+        links = Array(@content_item.dig('links', key))
+
+        if key == 'taxons'
+          links = links.find_all { |link| link['phase'] == 'live' }
+        end
+
+        if only.present?
+          links = links.find_all { |link| link['document_type'] == only }
+        end
+
+        links.map { |link| { path: link['base_path'], text: link['title'] } }
       end
     end
   end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '12.20.0'.freeze
+  VERSION = '12.21.0'.freeze
 end

data/node_modules/govuk-frontend/components/back-link/README.md

@@ -1,84 +1,15 @@
 # Back link
 
-## Introduction
+## Installation
 
-Link back component, to go back a page.
+See the [main README quick start guide](https://github.com/alphagov/govuk-frontend#quick-start) for how to install this component.
 
-## Guidance
+## Guidance and Examples
 
 Find out when to use the back link component in your service in the [GOV.UK Design System](https://design-system.service.gov.uk/components/back-link).
 
-## Quick start examples
-
-### Back link
-
-[Preview this example in the Frontend review app](http://govuk-frontend-review.herokuapp.com/components/back-link/preview)
-
-#### Markup
-
-    <a href="#" class="govuk-back-link">Back</a>
-
-#### Macro
-
-    {% from "back-link/macro.njk" import govukBackLink %}
-
-    {{ govukBackLink({
-      "href": "#"
-    }) }}
-
-### Back link with custom text
-
-[Preview this example in the Frontend review app](http://govuk-frontend-review.herokuapp.com/components/back-link/with-custom-text/preview)
-
-#### Markup
-
-    <a href="#" class="govuk-back-link">Back to home</a>
-
-#### Macro
-
-    {% from "back-link/macro.njk" import govukBackLink %}
-
-    {{ govukBackLink({
-      "href": "#",
-      "text": "Back to home"
-    }) }}
-
-## Requirements
-
-### Build tool configuration
-
-When compiling the Sass files you'll need to define includePaths to reference the node_modules directory. Below is a sample configuration using gulp
-
-    .pipe(sass({
-      includePaths: 'node_modules/'
-    }))
-
-### Static asset path configuration
-
-In order to include the images used in the components, you need to configure your app to show these assets. Below is a sample configuration using Express js:
-
-    app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/assets')))
-
 ## Component options
 
 Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.
 
-See [options table](https://design-system.service.gov.uk/components/back-link/#options-example-default) for details.
-
-### Setting up Nunjucks views and paths
-
-Below is an example setup using express configure views:
-
-    nunjucks.configure('node_modules/govuk-frontend/components', {
-      autoescape: true,
-      cache: false,
-      express: app
-    })
-
-## Contribution
-
-Guidelines can be found at [on our Github repository.](https://github.com/alphagov/govuk-frontend/blob/master/CONTRIBUTING.md "link to contributing guidelines on our github repository")
-
-## License
-
-MIT
+See [options table](https://design-system.service.gov.uk/components/back-link/#options-example-default) for details.

data/node_modules/govuk-frontend/components/breadcrumbs/README.md

@@ -1,249 +1,15 @@
 # Breadcrumbs
 
-## Introduction
+## Installation
 
-The Breadcrumbs component helps users to understand where they are within a website’s structure and move between levels.
+See the [main README quick start guide](https://github.com/alphagov/govuk-frontend#quick-start) for how to install this component.
 
-## Guidance
+## Guidance and Examples
 
 Find out when to use the breadcrumbs component in your service in the [GOV.UK Design System](https://design-system.service.gov.uk/components/breadcrumbs).
 
-## Quick start examples
-
-### Breadcrumbs
-
-[Preview this example in the Frontend review app](http://govuk-frontend-review.herokuapp.com/components/breadcrumbs/preview)
-
-#### Markup
-
-    <div class="govuk-breadcrumbs">
-      <ol class="govuk-breadcrumbs__list">
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/section">Section</a>
-        </li>
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/section/sub-section">Sub-section</a>
-        </li>
-
-      </ol>
-    </div>
-
-#### Macro
-
-    {% from "breadcrumbs/macro.njk" import govukBreadcrumbs %}
-
-    {{ govukBreadcrumbs({
-      "items": [
-        {
-          "text": "Section",
-          "href": "/section"
-        },
-        {
-          "text": "Sub-section",
-          "href": "/section/sub-section"
-        }
-      ]
-    }) }}
-
-### Breadcrumbs with one level
-
-[Preview this example in the Frontend review app](http://govuk-frontend-review.herokuapp.com/components/breadcrumbs/with-one-level/preview)
-
-#### Markup
-
-    <div class="govuk-breadcrumbs">
-      <ol class="govuk-breadcrumbs__list">
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/section">Section</a>
-        </li>
-
-      </ol>
-    </div>
-
-#### Macro
-
-    {% from "breadcrumbs/macro.njk" import govukBreadcrumbs %}
-
-    {{ govukBreadcrumbs({
-      "items": [
-        {
-          "text": "Section",
-          "href": "/section"
-        }
-      ]
-    }) }}
-
-### Breadcrumbs with multiple levels
-
-[Preview this example in the Frontend review app](http://govuk-frontend-review.herokuapp.com/components/breadcrumbs/with-multiple-levels/preview)
-
-#### Markup
-
-    <div class="govuk-breadcrumbs">
-      <ol class="govuk-breadcrumbs__list">
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/">Home</a>
-        </li>
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/section">Section</a>
-        </li>
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/section/sub-section">Sub-section</a>
-        </li>
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/section/sub-section/sub-sub-section">Sub Sub-section</a>
-        </li>
-
-      </ol>
-    </div>
-
-#### Macro
-
-    {% from "breadcrumbs/macro.njk" import govukBreadcrumbs %}
-
-    {{ govukBreadcrumbs({
-      "items": [
-        {
-          "text": "Home",
-          "href": "/"
-        },
-        {
-          "text": "Section",
-          "href": "/section"
-        },
-        {
-          "text": "Sub-section",
-          "href": "/section/sub-section"
-        },
-        {
-          "text": "Sub Sub-section",
-          "href": "/section/sub-section/sub-sub-section"
-        }
-      ]
-    }) }}
-
-### Breadcrumbs without the home section
-
-[Preview this example in the Frontend review app](http://govuk-frontend-review.herokuapp.com/components/breadcrumbs/without-the-home-section/preview)
-
-#### Markup
-
-    <div class="govuk-breadcrumbs">
-      <ol class="govuk-breadcrumbs__list">
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/service-manual">Service Manual</a>
-        </li>
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/service-manual/agile-delivery">Agile Delivery</a>
-        </li>
-
-      </ol>
-    </div>
-
-#### Macro
-
-    {% from "breadcrumbs/macro.njk" import govukBreadcrumbs %}
-
-    {{ govukBreadcrumbs({
-      "items": [
-        {
-          "text": "Service Manual",
-          "href": "/service-manual"
-        },
-        {
-          "text": "Agile Delivery",
-          "href": "/service-manual/agile-delivery"
-        }
-      ]
-    }) }}
-
-### Breadcrumbs with last breadcrumb as current page
-
-[Preview this example in the Frontend review app](http://govuk-frontend-review.herokuapp.com/components/breadcrumbs/with-last-breadcrumb-as-current-page/preview)
-
-#### Markup
-
-    <div class="govuk-breadcrumbs">
-      <ol class="govuk-breadcrumbs__list">
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/">Home</a>
-        </li>
-
-        <li class="govuk-breadcrumbs__list-item">
-          <a class="govuk-breadcrumbs__link" href="/browse/abroad">Passports, travel and living abroad</a>
-        </li>
-
-        <li class="govuk-breadcrumbs__list-item" aria-current="page">Travel abroad</li>
-
-      </ol>
-    </div>
-
-#### Macro
-
-    {% from "breadcrumbs/macro.njk" import govukBreadcrumbs %}
-
-    {{ govukBreadcrumbs({
-      "items": [
-        {
-          "text": "Home",
-          "href": "/"
-        },
-        {
-          "text": "Passports, travel and living abroad",
-          "href": "/browse/abroad"
-        },
-        {
-          "text": "Travel abroad"
-        }
-      ]
-    }) }}
-
-## Requirements
-
-### Build tool configuration
-
-When compiling the Sass files you'll need to define includePaths to reference the node_modules directory. Below is a sample configuration using gulp
-
-    .pipe(sass({
-      includePaths: 'node_modules/'
-    }))
-
-### Static asset path configuration
-
-In order to include the images used in the components, you need to configure your app to show these assets. Below is a sample configuration using Express js:
-
-    app.use('/assets', express.static(path.join(__dirname, '/node_modules/govuk-frontend/assets')))
-
 ## Component options
 
 Use options to customise the appearance, content and behaviour of a component when using a macro, for example, changing the text.
 
-See [options table](https://design-system.service.gov.uk/components/breadcrumbs/#options-example-default) for details.
-
-### Setting up Nunjucks views and paths
-
-Below is an example setup using express configure views:
-
-    nunjucks.configure('node_modules/govuk-frontend/components', {
-      autoescape: true,
-      cache: false,
-      express: app
-    })
-
-## Contribution
-
-Guidelines can be found at [on our Github repository.](https://github.com/alphagov/govuk-frontend/blob/master/CONTRIBUTING.md "link to contributing guidelines on our github repository")
-
-## License
-
-MIT
+See [options table](https://design-system.service.gov.uk/components/breadcrumbs/#options-example-default) for details.