govuk_publishing_components 5.5.2 → 5.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbffa0f1c20e03207e8fb4483ea072b971524638ce9e8f0d484124712fe51aa8
-  data.tar.gz: '037786464913c7c60198ab795f0c464c828afb79b96d37f07d7ca3eaf8eb266f'
+  metadata.gz: 04c80df6888c6c4100549e5343d78349aef6050112323f2caf4368d3baab6a05
+  data.tar.gz: 17ec1aed143598ea755942bcb5d1f57d45291f51c1c662b8ec39a97234ba7082
 SHA512:
-  metadata.gz: 3f4a7adb16f3ab924319303569a2ab9c5a83e1a0f4c6d659c7f17c52dfb93bd088c3cb7bd789023c1e2e7cea3fac32dc8b5dfb2ee120ed4eda5f6581530dc357
-  data.tar.gz: 43b7689d69c77b3b7749ba441d2590ccdcdbf37e7064f5bc7fcfd1b557bef3157eab79bf3105f2bc4d73d0faa6544c9442103eb34837c4fc7ffe177b0e48f856
+  metadata.gz: 72eec3cbce81a2300714b390d4321008984f151c477bb84c35e3a1a60fe47a4052554ec958e08369d68f21db0dfa29046e362be73e435988f40e380a432558d7
+  data.tar.gz: a091a509f7e17c818c6e8ac1b3f6edfc826c7bbe3a2b018b0ba576bc070210a6594efd794b376dde4d85c59e308ecf159ac40dbb18625d2532bde8a3cb342552

data/README.md

@@ -1,6 +1,10 @@
 # GOV.UK Publishing Components
 
-A gem to 1) document components in GOV.UK frontend applications and 2) provide shared components to applications.
+This gem:
+
+- Provides shared components for applications
+- Provides helpers to generate component payloads
+- Provides an application to preview components
 
 Components should be added to this gem if they are required in more than one application, otherwise they should be added to that application.
 
@@ -15,6 +19,27 @@ Components should be added to this gem if they are required in more than one app
 - [Run the component guide](/docs/run-component-guide.md)
 - [Move a component from an application to the gem](/docs/moving-components-upstream-into-this-gem.md)
 
+## Architecture / structure
+
+![](https://docs.google.com/drawings/d/e/2PACX-1vRj6JM7cQvngDl3Gr_U9G4xga2gsU7Z-d2qHHQcsBdjsW4WaC9_eQdryBJIS69cLkrY7S0fK9BcrPSF/pub?w=960&h=720)
+
+[Source](https://docs.google.com/drawings/d/1N8-kbyCN_xOvvshN6d2HnQz5i5Bqed2WIatI3Nj9gNQ/edit)
+
+There are 2 types of helper classes in this app:
+
+- [AppHelpers](lib/govuk_publishing_components/app_helpers). Are exposed to the applications using this gem. They should be documented using RDoc.
+- [Component Presenters](lib/govuk_publishing_components/presenters). Anything in these classes is only for use within the components. They should be marked `@private`.
+
+## Documentation
+
+[See the rubydoc.info documentation](http://www.rubydoc.info/gems/govuk_publishing_components)
+
+Run the documentation locally with:
+
+```
+bundle exec yard server --reload
+```
+
 ## Running tests
 
 The default rake task runs all tests:

data/app/assets/stylesheets/govuk_publishing_components/components/_inverse-header.scss

@@ -1,10 +1,15 @@
 .gem-c-inverse-header {
   width: 100%;
   background-color: $govuk-blue;
+  color: $white;
   margin-bottom: $gutter;
   padding: $gutter-half;
 }
 
+.gem-c-inverse-header a {
+  color: $white;
+}
+
 .gem-c-inverse-header--full-width {
   padding-left: 0;
   padding-right: 0;

data/app/models/govuk_publishing_components/component_doc_resolver.rb

@@ -1,4 +1,5 @@
 module GovukPublishingComponents
+  # @private
   class ComponentDocResolver
     def initialize(gem_components: false)
       @documentation_directory = gem_components ? gem_documentation_directory : app_documentation_directory

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

@@ -1,4 +1,4 @@
-<% related_nav_helper = RelatedNavigationHelper.new(local_assigns) %>
+<% related_nav_helper = GovukPublishingComponents::Presenters::RelatedNavigationHelper.new(local_assigns) %>
 <% related_content = related_nav_helper.related_navigation %>
 <% if related_content.map(&:values).flatten.any? || related_nav_helper.other.flatten.any? %>
 <% random = SecureRandom.hex(4) %>

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

@@ -13,6 +13,8 @@
 
   step_count = 0
   step_number = 0
+
+  step_nav_helper = GovukPublishingComponents::Presenters::StepByStepNavHelper.new
 %>
 <% if steps %>
   <div
@@ -26,7 +28,7 @@
         <%
           step_is_active = step_index + 1 == highlight_step
           step_count += 1
-          id = StepNavHelper.new.generate_step_nav_id(step[:title])
+          id = step_nav_helper.generate_step_nav_id(step[:title])
 
           logic = false
           logic = step[:logic] if ["and", "or"].include? step[:logic]
@@ -71,7 +73,7 @@
               options[:link_index] = 0
             %>
             <% step[:contents].each do |element| %>
-              <%= StepNavHelper.new.render_step_nav_element(element, options) %>
+              <%= step_nav_helper.render_step_nav_element(element, options) %>
               <%
                 if element[:type] == 'list'
                   options[:link_index] += element[:contents].length

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

@@ -1,7 +1,7 @@
 name: Inverse header
 description: A wrapper to contain header content in white text
 body: |
-  This component can be passed a block of template code and will wrap it in a blue header. This is as light-touch as possible and doesn't attempt to deal with the margins and paddings of its content, neither does it enforce the white text it requires. Implemented to accomodate topic and list page headings and breadcrumbs but unopinionated about its contents.
+  This component can be passed a block of template code and will wrap it in a blue header. This is as light-touch as possible and doesn't attempt to deal with the margins and paddings of its content. White text is enforced on content and would need to be overriden where unwanted. Implemented to accomodate topic and list page headings and breadcrumbs but unopinionated about its contents.
 
 accessibility_criteria: |
   The component must:

data/lib/govuk_publishing_components.rb

@@ -1,10 +1,10 @@
 require "govuk_publishing_components/config"
 require "govuk_publishing_components/engine"
-require "govuk_publishing_components/components/step_by_step_nav_helper"
-require "govuk_publishing_components/components/related_navigation_helper"
+require "govuk_publishing_components/presenters/step_by_step_nav_helper"
+require "govuk_publishing_components/presenters/related_navigation_helper"
 
-require "govuk_publishing_components/step_nav"
-require "govuk_publishing_components/step_nav_helper"
+require "govuk_publishing_components/app_helpers/step_nav"
+require "govuk_publishing_components/app_helpers/step_nav_helper"
 
 module GovukPublishingComponents
 end

data/lib/govuk_publishing_components/app_helpers/step_nav.rb

@@ -0,0 +1,29 @@
+module GovukPublishingComponents
+  module AppHelpers
+    class StepNav
+      def initialize(content_item)
+        @content_item = content_item.deep_symbolize_keys
+      end
+
+      def title
+        content_item[:title]
+      end
+
+      def base_path
+        content_item[:base_path]
+      end
+
+      def content
+        content_item.dig(:details, :step_by_step_nav)
+      end
+
+      def steps
+        content_item.dig(:details, :step_by_step_nav, :steps)
+      end
+
+    private
+
+      attr_reader :content_item
+    end
+  end
+end

data/lib/govuk_publishing_components/app_helpers/step_nav_helper.rb

@@ -0,0 +1,91 @@
+module GovukPublishingComponents
+  module AppHelpers
+    class StepNavHelper
+      def initialize(content_store_response, current_path)
+        @content_item = content_store_response.to_h
+        @current_path = current_path
+      end
+
+      def step_navs
+        @step_navs ||= parsed_step_navs.map do |step_nav|
+          StepNav.new(step_nav)
+        end
+      end
+
+      def show_sidebar?
+        show_header? && first_step_nav.steps.present?
+      end
+
+      def show_header?
+        step_navs.count == 1
+      end
+
+      def show_related_links?
+        step_navs.any? && step_navs.count < 5
+      end
+
+      def related_links
+        step_navs.map do |step_nav|
+          {
+            href: step_nav.base_path,
+            text: step_nav.title
+          }
+        end
+      end
+
+      def sidebar
+        if show_sidebar?
+          @sidebar ||= first_step_nav.content.tap do |sb|
+            configure_for_sidebar(sb)
+            sb.merge!(small: true, heading_level: 3)
+          end
+        end
+      end
+
+      def header
+        if show_header?
+          {
+            title: first_step_nav.title,
+            path: first_step_nav.base_path
+          }
+        else
+          {}
+        end
+      end
+
+    private
+
+      attr_reader :content_item, :current_path
+
+      def first_step_nav
+        step_navs.first
+      end
+
+      def steps
+        @steps ||= step_nav[:steps]
+      end
+
+      def parsed_step_navs
+        content_item.dig("links", "part_of_step_navs").to_a
+      end
+
+      def configure_for_sidebar(step_nav_content)
+        step_nav_content[:steps].each_with_index do |step, step_index|
+          step[:contents].each do |content|
+            next unless content[:contents]
+
+            content[:contents].each do |link|
+              if link[:href] == current_path
+                link[:active] = true
+                step_nav_content[:show_step] = step_index + 1
+                step_nav_content[:highlight_step] = step_index + 1
+                return step_nav_content
+              end
+            end
+          end
+        end
+        step_nav_content
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/related_navigation_helper.rb

@@ -0,0 +1,247 @@
+module GovukPublishingComponents
+  module Presenters
+    # @private
+    # Only used by the related_navigation component
+    class RelatedNavigationHelper
+      MAX_SECTION_LENGTH = 5
+      DEFINED_SECTIONS = %w(
+        related_guides
+        topics
+        collections
+        policies
+        topical_events
+        world_locations
+        statistical_data_sets
+      ).freeze
+
+      def initialize(content_item)
+        @content_item = content_item
+      end
+
+      def related_navigation
+        @related_content ||= [
+          { "related_items" => related_items },
+          { "related_guides" => related_guides },
+          { "collections" => related_collections },
+          { "topics" => related_topics },
+          { "policies" => related_policies },
+          { "topical_events" => related_topical_events },
+          { "world_locations" => related_world_locations },
+          { "statistical_data_sets" => related_statistical_data_sets },
+        ]
+
+        other = [related_external_links, related_contacts] || []
+        other.each do |sections|
+          sections.each do |section|
+            @related_content.push(
+              section["title"].tr(' ', '_') => section["links"]
+            )
+          end
+        end
+
+        @related_content
+      end
+
+      def other
+        @other ||= []
+      end
+
+      def construct_section_heading(section_title)
+        unless section_title === "related_items"
+          I18n.t('components.related_navigation.' + section_title, default: section_title.tr('_', ' '))
+        end
+      end
+
+      def section_css_class(css_class, section_title, link = {})
+        unless DEFINED_SECTIONS.include?(section_title) || link.fetch(:finder, false)
+          css_class += "--other"
+        end
+        css_class
+      end
+
+      def calculate_section_link_limit(links)
+        links.length == MAX_SECTION_LENGTH + 1 ? MAX_SECTION_LENGTH + 1 : MAX_SECTION_LENGTH
+      end
+
+      def remaining_link_count(links)
+        links.length - MAX_SECTION_LENGTH
+      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
+        else
+          build_links_for_sidebar(related_ordered_items) + mainstream_links
+        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)
+      end
+
+      def related_collections
+        collections = filter_link_type("document_collections", "document_collection")
+        build_links_for_sidebar(collections)
+      end
+
+      def filter_link_type(group, type)
+        links = link_group(group)
+        links.select do |link|
+          link["document_type"] == type
+        end
+      end
+
+      def related_policies
+        policies = filter_link_type("related_policies", "policy")
+        build_links_for_sidebar(policies)
+      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)
+      end
+
+      def related_topics
+        topics = filter_link_type("topics", "topic")
+        links = build_links_for_sidebar(topics)
+        links << related_mainstream_topic << related_mainstream_parent_topic
+        deduplicate_topics_by_title(links.compact)
+      end
+
+      def related_topical_events
+        topical_events = filter_link_type("topical_events", "topical_event")
+        build_links_for_sidebar(topical_events)
+      end
+
+      def related_contacts
+        contacts = filter_link_type("related", "contact")
+        return [] unless contacts.any?
+        [
+          title: "Other contacts",
+          links: build_links_for_sidebar(contacts).map
+        ]
+      end
+
+      def related_external_links
+        external_links = @content_item.dig("details", "external_related_links").to_a
+        return [] unless external_links.any?
+        [
+          "title" => "Elsewhere on the web",
+          "links" => build_links_for_sidebar(external_links, "url", rel: 'external')
+        ]
+      end
+
+      def related_mainstream_topic
+        return unless tagged_to_same_mainstream_browse_page.any?
+        { text: parent["title"], path: parent["base_path"] }
+      end
+
+      def related_mainstream_parent_topic
+        return unless parents_tagged_to_same_mainstream_browse_page.any?
+        { text: grandparent["title"], path: grandparent["base_path"] }
+      end
+
+      def parent
+        link_group("parent").first
+      end
+
+      def grandparent
+        parent.dig("links", "parent", 0)
+      end
+
+      # This method post-processes the topics collated by the helper.
+      # We add mainstream browse page links if they are present, however
+      # if these have the same title as an existing topic we should prefer
+      # the mainstream version and remove the existing topic.
+      # @see spec/related_navigation_helper_spec.rb for test coverage.
+      def deduplicate_topics_by_title(topics)
+        is_dupe = lambda { |a, b| a && a != b && a[:text] == b[:text] }
+
+        topics.delete_if do |t|
+          is_dupe.call(related_mainstream_topic, t) ||
+            is_dupe.call(related_mainstream_parent_topic, t)
+        end
+
+        topics
+      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 tagged_to_same_mainstream_browse_page
+        return [] unless parent
+        @tagged_to_same_mainstream_browse_page ||= related_links.select do |related_item|
+          links = related_item.dig("links", "mainstream_browse_pages") || []
+          content_ids = links.any? ? links.map { |page| page["content_id"] } : []
+          content_ids.include?(parent["content_id"])
+        end
+      end
+
+      def parents_tagged_to_same_mainstream_browse_page
+        return [] unless parent && grandparent
+        common_parent_content_ids = tagged_to_same_mainstream_browse_page.map { |item| item["content_id"] }
+
+        @parents_tagged_to_same_mainstream_browse_page ||= related_links.select do |related_item|
+          next if common_parent_content_ids.include?(related_item["content_id"])
+          mainstream_browse_pages = related_item.dig("links", "mainstream_browse_pages") || []
+          parents = mainstream_browse_pages.map { |page| page["links"]["parent"][0] }
+          content_ids = parents.map { |parent| parent["content_id"] }
+          content_ids.include?(grandparent["content_id"])
+        end
+      end
+
+      def related_links
+        link_group("ordered_related_items")
+      end
+
+      def related_mainstream_content
+        return [] unless @content_item["document_type"] == "detailed_guide"
+        content = link_group("related_mainstream_content")
+        build_links_for_sidebar(content)
+      end
+
+      def related_guides
+        return [] unless @content_item["document_type"] == "detailed_guide"
+        guides = link_group("related_guides")
+        build_links_for_sidebar(guides)
+      end
+
+      def link_group(type)
+        @content_item.dig("links", type).to_a
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/step_by_step_nav_helper.rb

@@ -0,0 +1,113 @@
+module GovukPublishingComponents
+  module Presenters
+    # @private
+    # Only used by the step by step component
+    class StepByStepNavHelper
+      include ActionView::Helpers
+      include ActionView::Context
+
+      def render_step_nav_element(element, options)
+        @options = options
+        @link_index = options[:link_index]
+
+        case element[:type]
+        when "paragraph"
+          paragraph(element[:text])
+        when "heading"
+          heading(element[:text])
+        when "list"
+          list(element)
+        end
+      end
+
+      # id should be lowercase, contain only numbers and letters and replace spaces with dashes
+      def generate_step_nav_id(step_title)
+        step_title.downcase.tr(" ", "-").gsub(/[^a-z0-9\-\s]/i, '')
+      end
+
+    private
+
+      def paragraph(text)
+        content_tag(
+          :p,
+          text,
+          class: "gem-c-step-nav__paragraph"
+        )
+      end
+
+      def heading(text)
+        content_tag(
+          "h#{@options[:heading_level] + 1}",
+          text,
+          class: "gem-c-step-nav__heading"
+        )
+      end
+
+      def list(element)
+        content_tag(
+          get_list_element(element[:style]),
+          class: "gem-c-step-nav__links #{get_list_style(element[:style])}",
+          data: {
+            length: element[:contents].length
+          }
+        ) do
+          element[:contents].collect { |contents|
+            concat(
+              content_tag(
+                :li,
+                class: "gem-c-step-nav__link js-list-item #{link_active(contents[:active])}"
+              ) do
+                create_list_item_content(contents)
+              end
+            )
+          }
+        end
+      end
+
+      def create_list_item_content(link)
+        if link[:href]
+          @link_index += 1
+          href = link_href(link[:active], link[:href])
+          text = "#{link_text(link[:active], link[:text])} #{create_context(link[:context])}".html_safe
+
+          link_to(
+            href,
+            rel: ("external" if href.start_with?('http')),
+            data: {
+              position: "#{@options[:step_index] + 1}.#{@link_index}"
+            },
+            class: "gem-c-step-nav__link-item js-link"
+          ) do
+            text
+          end
+        else
+          link[:text]
+        end
+      end
+
+      def create_context(context)
+        content_tag(:span, context, class: "gem-c-step-nav__context") if context
+      end
+
+      def get_list_style(style)
+        "gem-c-step-nav__links--choice" if style == "choice"
+      end
+
+      def get_list_element(style)
+        style == "choice" ? "ul" : "ol"
+      end
+
+      def link_href(active, href)
+        active ? "#content" : href
+      end
+
+      def link_text(active, text)
+        active ? content_tag(:span, "You are currently viewing: ", class: "visuallyhidden") + text : text
+      end
+
+      def link_active(active)
+        "gem-c-step-nav__link--active" if active
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '5.5.2'.freeze
+  VERSION = '5.5.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 5.5.2
+  version: 5.5.3
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -262,6 +262,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A gem to document components in GOV.UK frontend applications
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -356,13 +370,13 @@ files:
 - lib/generators/govuk_publishing_components/templates/_component.scss
 - lib/generators/govuk_publishing_components/templates/component.yml.erb
 - lib/govuk_publishing_components.rb
-- lib/govuk_publishing_components/components/related_navigation_helper.rb
-- lib/govuk_publishing_components/components/step_by_step_nav_helper.rb
+- lib/govuk_publishing_components/app_helpers/step_nav.rb
+- lib/govuk_publishing_components/app_helpers/step_nav_helper.rb
 - lib/govuk_publishing_components/config.rb
 - lib/govuk_publishing_components/engine.rb
 - lib/govuk_publishing_components/minitest/component_guide_test.rb
-- lib/govuk_publishing_components/step_nav.rb
-- lib/govuk_publishing_components/step_nav_helper.rb
+- lib/govuk_publishing_components/presenters/related_navigation_helper.rb
+- lib/govuk_publishing_components/presenters/step_by_step_nav_helper.rb
 - lib/govuk_publishing_components/version.rb
 - lib/tasks/govuk_publishing_components_tasks.rake
 homepage: https://github.com/alphagov/govuk_publishing_components

data/lib/govuk_publishing_components/components/related_navigation_helper.rb

@@ -1,241 +0,0 @@
-class RelatedNavigationHelper
-  MAX_SECTION_LENGTH = 5
-  DEFINED_SECTIONS = %w(
-    related_guides
-    topics
-    collections
-    policies
-    topical_events
-    world_locations
-    statistical_data_sets
-  ).freeze
-
-  def initialize(content_item)
-    @content_item = content_item
-  end
-
-  def related_navigation
-    @related_content ||= [
-      { "related_items" => related_items },
-      { "related_guides" => related_guides },
-      { "collections" => related_collections },
-      { "topics" => related_topics },
-      { "policies" => related_policies },
-      { "topical_events" => related_topical_events },
-      { "world_locations" => related_world_locations },
-      { "statistical_data_sets" => related_statistical_data_sets },
-    ]
-
-    other = [related_external_links, related_contacts] || []
-    other.each do |sections|
-      sections.each do |section|
-        @related_content.push(
-          section["title"].tr(' ', '_') => section["links"]
-        )
-      end
-    end
-
-    @related_content
-  end
-
-  def other
-    @other ||= []
-  end
-
-  def construct_section_heading(section_title)
-    unless section_title === "related_items"
-      I18n.t('components.related_navigation.' + section_title, default: section_title.tr('_', ' '))
-    end
-  end
-
-  def section_css_class(css_class, section_title, link = {})
-    unless DEFINED_SECTIONS.include?(section_title) || link.fetch(:finder, false)
-      css_class += "--other"
-    end
-    css_class
-  end
-
-  def calculate_section_link_limit(links)
-    links.length == MAX_SECTION_LENGTH + 1 ? MAX_SECTION_LENGTH + 1 : MAX_SECTION_LENGTH
-  end
-
-  def remaining_link_count(links)
-    links.length - MAX_SECTION_LENGTH
-  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
-    else
-      build_links_for_sidebar(related_ordered_items) + mainstream_links
-    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)
-  end
-
-  def related_collections
-    collections = filter_link_type("document_collections", "document_collection")
-    build_links_for_sidebar(collections)
-  end
-
-  def filter_link_type(group, type)
-    links = link_group(group)
-    links.select do |link|
-      link["document_type"] == type
-    end
-  end
-
-  def related_policies
-    policies = filter_link_type("related_policies", "policy")
-    build_links_for_sidebar(policies)
-  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)
-  end
-
-  def related_topics
-    topics = filter_link_type("topics", "topic")
-    links = build_links_for_sidebar(topics)
-    links << related_mainstream_topic << related_mainstream_parent_topic
-    deduplicate_topics_by_title(links.compact)
-  end
-
-  def related_topical_events
-    topical_events = filter_link_type("topical_events", "topical_event")
-    build_links_for_sidebar(topical_events)
-  end
-
-  def related_contacts
-    contacts = filter_link_type("related", "contact")
-    return [] unless contacts.any?
-    [
-      title: "Other contacts",
-      links: build_links_for_sidebar(contacts).map
-    ]
-  end
-
-  def related_external_links
-    external_links = @content_item.dig("details", "external_related_links").to_a
-    return [] unless external_links.any?
-    [
-      "title" => "Elsewhere on the web",
-      "links" => build_links_for_sidebar(external_links, "url", rel: 'external')
-    ]
-  end
-
-  def related_mainstream_topic
-    return unless tagged_to_same_mainstream_browse_page.any?
-    { text: parent["title"], path: parent["base_path"] }
-  end
-
-  def related_mainstream_parent_topic
-    return unless parents_tagged_to_same_mainstream_browse_page.any?
-    { text: grandparent["title"], path: grandparent["base_path"] }
-  end
-
-  def parent
-    link_group("parent").first
-  end
-
-  def grandparent
-    parent.dig("links", "parent", 0)
-  end
-
-  # This method post-processes the topics collated by the helper.
-  # We add mainstream browse page links if they are present, however
-  # if these have the same title as an existing topic we should prefer
-  # the mainstream version and remove the existing topic.
-  # @see spec/related_navigation_helper_spec.rb for test coverage.
-  def deduplicate_topics_by_title(topics)
-    is_dupe = lambda { |a, b| a && a != b && a[:text] == b[:text] }
-
-    topics.delete_if do |t|
-      is_dupe.call(related_mainstream_topic, t) ||
-        is_dupe.call(related_mainstream_parent_topic, t)
-    end
-
-    topics
-  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 tagged_to_same_mainstream_browse_page
-    return [] unless parent
-    @tagged_to_same_mainstream_browse_page ||= related_links.select do |related_item|
-      links = related_item.dig("links", "mainstream_browse_pages") || []
-      content_ids = links.any? ? links.map { |page| page["content_id"] } : []
-      content_ids.include?(parent["content_id"])
-    end
-  end
-
-  def parents_tagged_to_same_mainstream_browse_page
-    return [] unless parent && grandparent
-    common_parent_content_ids = tagged_to_same_mainstream_browse_page.map { |item| item["content_id"] }
-
-    @parents_tagged_to_same_mainstream_browse_page ||= related_links.select do |related_item|
-      next if common_parent_content_ids.include?(related_item["content_id"])
-      mainstream_browse_pages = related_item.dig("links", "mainstream_browse_pages") || []
-      parents = mainstream_browse_pages.map { |page| page["links"]["parent"][0] }
-      content_ids = parents.map { |parent| parent["content_id"] }
-      content_ids.include?(grandparent["content_id"])
-    end
-  end
-
-  def related_links
-    link_group("ordered_related_items")
-  end
-
-  def related_mainstream_content
-    return [] unless @content_item["document_type"] == "detailed_guide"
-    content = link_group("related_mainstream_content")
-    build_links_for_sidebar(content)
-  end
-
-  def related_guides
-    return [] unless @content_item["document_type"] == "detailed_guide"
-    guides = link_group("related_guides")
-    build_links_for_sidebar(guides)
-  end
-
-  def link_group(type)
-    @content_item.dig("links", type).to_a
-  end
-end

data/lib/govuk_publishing_components/components/step_by_step_nav_helper.rb

@@ -1,107 +0,0 @@
-class StepNavHelper
-  include ActionView::Helpers
-  include ActionView::Context
-
-  def render_step_nav_element(element, options)
-    @options = options
-    @link_index = options[:link_index]
-
-    case element[:type]
-    when "paragraph"
-      paragraph(element[:text])
-    when "heading"
-      heading(element[:text])
-    when "list"
-      list(element)
-    end
-  end
-
-  # id should be lowercase, contain only numbers and letters and replace spaces with dashes
-  def generate_step_nav_id(step_title)
-    step_title.downcase.tr(" ", "-").gsub(/[^a-z0-9\-\s]/i, '')
-  end
-
-private
-
-  def paragraph(text)
-    content_tag(
-      :p,
-      text,
-      class: "gem-c-step-nav__paragraph"
-    )
-  end
-
-  def heading(text)
-    content_tag(
-      "h#{@options[:heading_level] + 1}",
-      text,
-      class: "gem-c-step-nav__heading"
-    )
-  end
-
-  def list(element)
-    content_tag(
-      get_list_element(element[:style]),
-      class: "gem-c-step-nav__links #{get_list_style(element[:style])}",
-      data: {
-        length: element[:contents].length
-      }
-    ) do
-      element[:contents].collect { |contents|
-        concat(
-          content_tag(
-            :li,
-            class: "gem-c-step-nav__link js-list-item #{link_active(contents[:active])}"
-          ) do
-            create_list_item_content(contents)
-          end
-        )
-      }
-    end
-  end
-
-  def create_list_item_content(link)
-    if link[:href]
-      @link_index += 1
-      href = link_href(link[:active], link[:href])
-      text = "#{link_text(link[:active], link[:text])} #{create_context(link[:context])}".html_safe
-
-      link_to(
-        href,
-        rel: ("external" if href.start_with?('http')),
-        data: {
-          position: "#{@options[:step_index] + 1}.#{@link_index}"
-        },
-        class: "gem-c-step-nav__link-item js-link"
-      ) do
-        text
-      end
-    else
-      link[:text]
-    end
-  end
-
-  def create_context(context)
-    content_tag(:span, context, class: "gem-c-step-nav__context") if context
-  end
-
-  def get_list_style(style)
-    "gem-c-step-nav__links--choice" if style == "choice"
-  end
-
-  def get_list_element(style)
-    style == "choice" ? "ul" : "ol"
-  end
-
-  def link_href(active, href)
-    active ? "#content" : href
-  end
-
-  def link_text(active, text)
-    active ? content_tag(:span, "You are currently viewing: ", class: "visuallyhidden") + text : text
-  end
-
-  def link_active(active)
-    "gem-c-step-nav__link--active" if active
-  end
-end

data/lib/govuk_publishing_components/step_nav.rb

@@ -1,27 +0,0 @@
-module GovukPublishingComponents
-  class StepNav
-    def initialize(content_item)
-      @content_item = content_item.deep_symbolize_keys
-    end
-
-    def title
-      content_item[:title]
-    end
-
-    def base_path
-      content_item[:base_path]
-    end
-
-    def content
-      content_item.dig(:details, :step_by_step_nav)
-    end
-
-    def steps
-      content_item.dig(:details, :step_by_step_nav, :steps)
-    end
-
-  private
-
-    attr_reader :content_item
-  end
-end

data/lib/govuk_publishing_components/step_nav_helper.rb

@@ -1,89 +0,0 @@
-module GovukPublishingComponents
-  class StepNavHelper
-    def initialize(content_store_response, current_path)
-      @content_item = content_store_response.to_h
-      @current_path = current_path
-    end
-
-    def step_navs
-      @step_navs ||= parsed_step_navs.map do |step_nav|
-        StepNav.new(step_nav)
-      end
-    end
-
-    def show_sidebar?
-      show_header? && first_step_nav.steps.present?
-    end
-
-    def show_header?
-      step_navs.count == 1
-    end
-
-    def show_related_links?
-      step_navs.any? && step_navs.count < 5
-    end
-
-    def related_links
-      step_navs.map do |step_nav|
-        {
-          href: step_nav.base_path,
-          text: step_nav.title
-        }
-      end
-    end
-
-    def sidebar
-      if show_sidebar?
-        @sidebar ||= first_step_nav.content.tap do |sb|
-          configure_for_sidebar(sb)
-          sb.merge!(small: true, heading_level: 3)
-        end
-      end
-    end
-
-    def header
-      if show_header?
-        {
-          title: first_step_nav.title,
-          path: first_step_nav.base_path
-        }
-      else
-        {}
-      end
-    end
-
-  private
-
-    attr_reader :content_item, :current_path
-
-    def first_step_nav
-      step_navs.first
-    end
-
-    def steps
-      @steps ||= step_nav[:steps]
-    end
-
-    def parsed_step_navs
-      content_item.dig("links", "part_of_step_navs").to_a
-    end
-
-    def configure_for_sidebar(step_nav_content)
-      step_nav_content[:steps].each_with_index do |step, step_index|
-        step[:contents].each do |content|
-          next unless content[:contents]
-
-          content[:contents].each do |link|
-            if link[:href] == current_path
-              link[:active] = true
-              step_nav_content[:show_step] = step_index + 1
-              step_nav_content[:highlight_step] = step_index + 1
-              return step_nav_content
-            end
-          end
-        end
-      end
-      step_nav_content
-    end
-  end
-end