govuk_navigation_helpers 9.1.0 → 9.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfe90c1b0207936166968071bbe57c3b9b6e98dd
-  data.tar.gz: 9ad575a04047684089fafa8000807e1f242833ca
+  metadata.gz: f4b59802a5e4240cad012f8f71ead8a747d9c0c4
+  data.tar.gz: bcd0dc8d17c08421870f09ef71b4ebdac55a0966
 SHA512:
-  metadata.gz: 6bbbceff78a86fef6711c84465bba37bcf8a676a14305f959e0de2cab8cbef5f07eb3310767a13040eb5c66fad6e843421e7dcd9d89b6d85eb2b3876c71fc41e
-  data.tar.gz: 61d239cd0fe9de022bb8c3a982f3be957c7017bc1463da20ba15d33966a96ab9d8ef2380b862333e42a9d382afab697da9cbb4ed29344262258f06b9cdfff13c
+  metadata.gz: 82b6de3201c4ea05df44240791c324cc22ed57ef12eb079d9a53d3e620004e957d5661a0038c8dd859914a70bc2aa5af8c5a4d505a27fa4460e13530de7434a6
+  data.tar.gz: 171163b628d5b0bb4e52ef65b4602de53cb797a79736290e74549b66639d365edacb4ad944a85017f766c279aaacafc7d4f6d648481c802c2f9f5a0db8f33ed8

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## 9.1.0 
+## 9.2.0
+
+* Step by step navigation helpers have been removed from here.  They now live
+in govuk_publishing_components as they are closely coupled to components that
+also live there.  (All apps have been updated with this)
+* Remove Related Navigation Sidebar Helper as it has now been moved to govuk_publishing_components.
+* Enable Taxonomy Sidebar Helper to return collection links.
+
+## 9.1.0
 
 * Check if a taxon's phase is 'live' to determine if it should be passed to a navigation component to be displayed on a page.
 * Remove the old content_id whitelisting approach to filtering for taxons.

data/lib/govuk_navigation_helpers.rb

@@ -9,12 +9,9 @@ require_relative "govuk_navigation_helpers/breadcrumbs"
 require_relative "govuk_navigation_helpers/related_items"
 require_relative "govuk_navigation_helpers/taxon_breadcrumbs"
 require_relative "govuk_navigation_helpers/taxonomy_sidebar"
-require_relative "govuk_navigation_helpers/related_navigation_sidebar"
 require_relative "govuk_navigation_helpers/rummager_taxonomy_sidebar_links"
 require_relative "govuk_navigation_helpers/curated_taxonomy_sidebar_links"
 
-require_relative "govuk_navigation_helpers/step_nav_content"
-
 module GovukNavigationHelpers
   class NavigationHelper
     def initialize(content_item)
@@ -54,15 +51,6 @@ module GovukNavigationHelpers
       RelatedItems.new(content_item).related_items
     end
 
-    # Generate a payload containing related navigation sidebar data. Intended for use with
-    # the related navigation component
-    #
-    # @return [Hash] Payload for the GOV.UK related navigation component
-    # @see https://government-frontend.herokuapp.com/component-guide/related-navigation
-    def related_navigation_sidebar
-      RelatedNavigationSidebar.new(content_item).related_navigation_sidebar
-    end
-
   private
 
     attr_reader :content_item

data/lib/govuk_navigation_helpers/taxonomy_sidebar.rb

@@ -10,6 +10,7 @@ module GovukNavigationHelpers
     def sidebar
       {
         items: related_items,
+        collections: collections,
       }
     end
 
@@ -32,5 +33,15 @@ module GovukNavigationHelpers
         RummagerTaxonomySidebarLinks
       end
     end
+
+    def collections
+      links = @content_item.related_collections
+      links.map do |link|
+        {
+          path: link["base_path"],
+          text: link["title"]
+        }
+      end
+    end
   end
 end

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "9.1.0".freeze
+  VERSION = "9.2.0".freeze
 end

data/spec/taxonomy_sidebar_spec.rb

@@ -17,12 +17,13 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
       expect { sidebar_for(generator.payload) }.to_not raise_error
     end
 
-    context 'given a content item not tagged to any taxon' do
+    context 'given a content item not tagged to any taxon with no document collections' do
       it 'returns an empty sidebar hash' do
         content_item = { "links" => {} }
 
         expect(sidebar_for(content_item)).to eq(
-          items: []
+          items: [],
+          collections: []
         )
       end
     end
@@ -72,7 +73,8 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
                 { 'title': 'Related item C', 'link': '/related-item-c', },
               ],
             },
-          ]
+          ],
+          collections: [],
         )
       end
 
@@ -121,7 +123,8 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
               description: "The C taxon.",
               related_content: [],
             },
-          ]
+          ],
+          collections: [],
         )
       end
     end
@@ -182,7 +185,8 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
                 { 'title': 'Related item C', 'link': '/related-item-c', },
               ],
             }
-          ]
+          ],
+          collections: [],
         )
       end
     end
@@ -221,7 +225,8 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
                   { title: 'Related link override B', link: '/override-b' },
                 ],
               }
-            ]
+            ],
+            collections: [],
           )
         end
 
@@ -280,7 +285,8 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
                   { 'title': 'Related link override B', 'link': '/override-b' },
                 ],
               }
-            ]
+            ],
+            collections: [],
           )
         end
 
@@ -317,7 +323,8 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
                 description: "The B taxon.",
                 related_content: [],
               }
-            ]
+            ],
+            collections: [],
           )
         end
 
@@ -361,7 +368,8 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
                   { title: 'Related link override', link: '/override' }
                 ],
               },
-            ]
+            ],
+            collections: [],
           )
         end
 
@@ -397,7 +405,8 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
                   { title: 'Related link override', link: '/override' }
                 ],
               },
-            ]
+            ],
+            collections: [],
           )
         end
 
@@ -448,12 +457,32 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
                   { title: 'External related link', link: 'http://example.com' }
                 ],
               },
-            ]
+            ],
+            collections: [],
           )
         end
       end
     end
 
+    context 'given a content item with document collections' do
+      it 'returns a sidebar hash containing document collections' do
+        content_item = content_item_with_document_collections
+
+        expect(sidebar_for(content_item)).to eq(
+          items: [],
+          collections: [
+            {
+              path: "/collection-b",
+              text: "Collection B",
+            },
+            {
+              path: "/collection-a",
+              text: "Collection A",
+            },
+            ]
+        )
+      end
+    end
     context 'when Rummager raises an exception' do
       error_handler = nil
 
@@ -515,4 +544,27 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
       },
     }
   end
+
+  def content_item_with_document_collections
+    {
+      "title" => "A piece of content",
+      "base_path" => "/a-piece-of-content",
+      "links" => {
+        "document_collections" => [
+          {
+            "title" => "Collection B",
+            "base_path" => "/collection-b",
+            "content_id" => "collection-b",
+            "document_type" => "document_collection",
+          },
+          {
+            "title" => "Collection A",
+            "base_path" => "/collection-a",
+            "content_id" => "collection-a",
+            "document_type" => "document_collection",
+          },
+        ],
+      },
+    }
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 9.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -196,7 +196,6 @@ files:
 - LICENCE.txt
 - README.md
 - Rakefile
-- config/step_navs/learn-to-drive-a-car.json
 - govuk_navigation_helpers.gemspec
 - lib/govuk_navigation_helpers.rb
 - lib/govuk_navigation_helpers/breadcrumbs.rb
@@ -205,19 +204,15 @@ files:
 - lib/govuk_navigation_helpers/curated_taxonomy_sidebar_links.rb
 - lib/govuk_navigation_helpers/grouped_related_links.rb
 - lib/govuk_navigation_helpers/related_items.rb
-- lib/govuk_navigation_helpers/related_navigation_sidebar.rb
 - lib/govuk_navigation_helpers/rummager_taxonomy_sidebar_links.rb
 - lib/govuk_navigation_helpers/services.rb
-- lib/govuk_navigation_helpers/step_nav_content.rb
 - lib/govuk_navigation_helpers/taxon_breadcrumbs.rb
 - lib/govuk_navigation_helpers/taxonomy_sidebar.rb
 - lib/govuk_navigation_helpers/version.rb
 - spec/breadcrumbs_spec.rb
 - spec/content_item_spec.rb
 - spec/related_items_spec.rb
-- spec/related_navigation_sidebar_spec.rb
 - spec/spec_helper.rb
-- spec/step_nav_content_spec.rb
 - spec/taxon_breadcrumbs_spec.rb
 - spec/taxonomy_sidebar_spec.rb
 homepage: https://github.com/alphagov/govuk_navigation_helpers
@@ -248,8 +243,6 @@ test_files:
 - spec/breadcrumbs_spec.rb
 - spec/content_item_spec.rb
 - spec/related_items_spec.rb
-- spec/related_navigation_sidebar_spec.rb
 - spec/spec_helper.rb
-- spec/step_nav_content_spec.rb
 - spec/taxon_breadcrumbs_spec.rb
 - spec/taxonomy_sidebar_spec.rb

data/config/step_navs/learn-to-drive-a-car.json

@@ -1,248 +0,0 @@
-{
-  "title": "Learn to drive a car: step by step",
-  "base_path": "/learn-to-drive-a-car",
-  "description": "<p>Check what you need to do to learn to drive.</p>",
-  "links": {
-    "breadcrumbs": [
-      { "title": "Home", "url": "/" },
-      { "title": "Driving and transport", "url": "/browse/driving"},
-      { "title": "Learning to drive", "url": "/browse/driving/learning-to-drive"}
-    ]
-  },
-  "related_paths": [
-    "/apply-for-your-full-driving-licence",
-    "/automatic-driving-licence-to-manual",
-    "/complain-about-a-driving-instructor",
-    "/driving-licence-fees",
-    "/driving-test-cost",
-    "/dvlaforms",
-    "/find-theory-test-pass-number",
-    "/government/publications/application-for-refunding-out-of-pocket-expenses",
-    "/government/publications/drivers-record-for-learner-drivers",
-    "/government/publications/driving-instructor-grades-explained",
-    "/government/publications/know-your-traffic-signs",
-    "/government/publications/l-plate-size-rules",
-    "/guidance/rules-for-observing-driving-tests",
-    "/report-an-illegal-driving-instructor",
-    "/report-driving-test-impersonation",
-    "/track-your-driving-licence-application",
-    "/driving-lessons-learning-to-drive/practising-with-family-or-friends",
-    "/driving-lessons-learning-to-drive/taking-driving-lessons",
-    "/driving-lessons-learning-to-drive/using-l-and-p-plates",
-    "/driving-test",
-    "/driving-test/changes-december-2017",
-    "/driving-test/disability-health-condition-or-learning-difficulty",
-    "/driving-test/driving-test-faults-result",
-    "/driving-test/test-cancelled-bad-weather",
-    "/driving-test/using-your-own-car",
-    "/driving-test/what-happens-during-test",
-    "/pass-plus/apply-for-a-pass-plus-certificate",
-    "/pass-plus/booking-pass-plus",
-    "/pass-plus/car-insurance-discounts",
-    "/pass-plus/local-councils-offering-discounts",
-    "/pass-plus/how-pass-plus-training-works",
-    "/theory-test",
-    "/theory-test/hazard-perception-test",
-    "/theory-test/if-you-have-safe-road-user-award",
-    "/theory-test/multiple-choice-questions",
-    "/theory-test/pass-mark-and-result",
-    "/theory-test/reading-difficulty-disability-or-health-condition"
-  ],
-  "step_by_step_nav": {
-    "steps": [
-      {
-        "title": "Check you're allowed to drive",
-        "contents": [
-          {
-            "type": "paragraph",
-            "text": "Most people can start learning to drive when they’re 17."
-          },
-          {
-            "type": "list",
-            "style": "required",
-            "contents": [
-              {
-                "href": "/vehicles-can-drive",
-                "text": "Check what age you can drive"
-              },
-              {
-                "href": "/legal-obligations-drivers-riders",
-                "text": "Requirements for driving legally"
-              },
-              {
-                "href": "/driving-eyesight-rules",
-                "text": "Driving eyesight rules"
-              }
-            ]
-          }
-        ]
-      },
-      {
-        "title": "Get a provisional driving licence",
-        "contents": [
-          {
-            "type": "list",
-            "style": "required",
-            "contents": [
-              {
-                "href": "/apply-first-provisional-driving-licence",
-                "text": "Apply for your first provisional driving licence",
-                "context": "£34"
-              }
-            ]
-          }
-        ]
-      },
-      {
-        "title": "Driving lessons and practice",
-        "contents": [
-          {
-            "type": "paragraph",
-            "text": "You need a provisional driving licence to take lessons or practice."
-          },
-          {
-            "type": "list",
-            "style": "required",
-            "contents": [
-              {
-                "href": "/guidance/the-highway-code",
-                "text": "The Highway Code"
-              },
-              {
-                "href": "/driving-lessons-learning-to-drive",
-                "text": "Taking driving lessons"
-              },
-              {
-                "href": "/find-driving-schools-and-lessons",
-                "text": "Find driving schools, lessons and instructors"
-              },
-              {
-                "href": "/government/publications/car-show-me-tell-me-vehicle-safety-questions",
-                "text": "Practise vehicle safety questions"
-              }
-            ]
-          }
-        ]
-      },
-      {
-        "title": "Prepare for your theory test",
-        "logic": "and",
-        "contents": [
-          {
-            "type": "list",
-            "style": "required",
-            "contents": [
-              {
-                "href": "/theory-test/revision-and-practice",
-                "text": "Theory test revision and practice"
-              },
-              {
-                "href": "/take-practice-theory-test",
-                "text": "Take a practice theory test"
-              },
-              {
-                "href": "https://www.safedrivingforlife.info/shop/product/official-dvsa-theory-test-kit-app-app",
-                "text": "Theory and hazard perception test app"
-              }
-            ]
-          }
-        ]
-      },
-      {
-        "title": "Book and manage your theory test",
-        "contents": [
-          {
-            "type": "paragraph",
-            "text": "You need a provisional driving licence to book your theory test."
-          },
-          {
-            "type": "list",
-            "style": "required",
-            "contents": [
-              {
-                "href": "/book-theory-test",
-                "text": "Book your theory test",
-                "context": "£23"
-              },
-              {
-                "href": "/theory-test/what-to-take",
-                "text": "What to take to your test"
-              },
-              {
-                "href": "/change-theory-test",
-                "text": "Change your theory test appointment"
-              },
-              {
-                "href": "/check-theory-test",
-                "text": "Check your theory test appointment details"
-              },
-              {
-                "href": "/cancel-theory-test",
-                "text": "Cancel your theory test"
-              }
-            ]
-          }
-        ]
-      },
-      {
-        "title": "Book and manage your driving test",
-        "contents": [
-          {
-            "type": "paragraph",
-            "text": "You must pass your theory test before you can book your driving test."
-          },
-          {
-            "type": "list",
-            "style": "required",
-            "contents": [
-              {
-                "href": "/book-driving-test",
-                "text": "Book your driving test",
-                "context": "£62"
-              },
-              {
-                "href": "/driving-test/what-to-take",
-                "text": "What to take to your test"
-              },
-              {
-                "href": "/change-driving-test",
-                "text": "Change your driving test appointment"
-              },
-              {
-                "href": "/check-driving-test",
-                "text": "Check your driving test appointment details"
-              },
-              {
-                "href": "/cancel-driving-test",
-                "text": "Cancel your driving test"
-              }
-            ]
-          }
-        ]
-      },
-      {
-        "title": "When you pass",
-        "contents": [
-          {
-            "type": "paragraph",
-            "text": "You can start driving as soon as you pass your driving test."
-          },
-          {
-            "type": "paragraph",
-            "text": "You must have an insurance policy that allows you to drive without supervision."
-          },
-          {
-            "type": "list",
-            "style": "required",
-            "contents": [
-              {
-                "href": "/pass-plus",
-                "text": "Find out about Pass Plus training courses"
-              }
-            ]
-          }
-        ]
-      }
-    ]
-  }
-}

data/lib/govuk_navigation_helpers/related_navigation_sidebar.rb

@@ -1,140 +0,0 @@
-require 'govuk_navigation_helpers/services'
-require 'govuk_navigation_helpers/configuration'
-
-module GovukNavigationHelpers
-  class RelatedNavigationSidebar
-    def initialize(content_item)
-      @content_item = ContentItem.new content_item
-    end
-
-    def related_navigation_sidebar
-      {
-        related_items: related_items,
-        collections: related_collections,
-        statistical_data_sets: related_statistical_data_sets,
-        topics: related_topics,
-        topical_events: related_topical_events,
-        policies: related_policies,
-        publishers: related_organisations,
-        world_locations: related_world_locations,
-        worldwide_organisations: related_worldwide_organisations,
-        other: [related_external_links, related_contacts]
-      }
-    end
-
-  private
-
-    def build_links_for_sidebar(collection, path_key = "base_path", additional_attr = {})
-      collection.map do |link|
-        {
-          text: link["title"],
-          path: link[path_key]
-        }.merge(additional_attr)
-      end
-    end
-
-    def world_location_base_path(title)
-      "/world/#{parameterise(title)}/news"
-    end
-
-    def related_items
-      quick_links = build_links_for_sidebar(@content_item.quick_links, "url")
-
-      quick_links.any? ? quick_links : build_links_for_sidebar(@content_item.related_ordered_items)
-    end
-
-    def related_organisations
-      build_links_for_sidebar(@content_item.related_organisations)
-    end
-
-    def related_world_locations
-      locations = @content_item.related_world_locations
-      locations.map! { |link| link.merge("base_path" => world_location_base_path(link["title"])) }
-      build_links_for_sidebar(locations)
-    end
-
-    def related_worldwide_organisations
-      build_links_for_sidebar(@content_item.related_worldwide_organisations)
-    end
-
-    def related_collections
-      build_links_for_sidebar(@content_item.related_collections)
-    end
-
-    def related_policies
-      build_links_for_sidebar(@content_item.related_policies)
-    end
-
-    def related_statistical_data_sets
-      build_links_for_sidebar(@content_item.related_statistical_data_sets)
-    end
-
-    def related_topics
-      topics = build_links_for_sidebar(@content_item.related_topics)
-      topics << related_mainstream_topic << related_mainstream_parent_topic
-      deduplicate_topics_by_title(topics.compact)
-    end
-
-    def related_topical_events
-      build_links_for_sidebar(@content_item.related_topical_events)
-    end
-
-    def related_contacts
-      return [] unless @content_item.related_other_contacts.any?
-      [
-        title: "Other contacts",
-        links: build_links_for_sidebar(@content_item.related_other_contacts).map
-      ]
-    end
-
-    def related_external_links
-      return [] unless @content_item.external_links.any?
-      [
-        title: "Elsewhere on the web",
-        links: build_links_for_sidebar(@content_item.external_links, "url", rel: 'external')
-      ]
-    end
-
-    def related_mainstream_topic
-      return unless grouped.tagged_to_same_mainstream_browse_page.any?
-      { text: @content_item.parent.title, path: @content_item.parent.base_path }
-    end
-
-    def related_mainstream_parent_topic
-      return unless grouped.parents_tagged_to_same_mainstream_browse_page.any?
-      { text: @content_item.parent.parent.title, path: @content_item.parent.parent.base_path }
-    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_sidebar_spec.rb:260 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 grouped
-      @grouped ||= GroupedRelatedLinks.new(@content_item)
-    end
-  end
-end

data/lib/govuk_navigation_helpers/step_nav_content.rb

@@ -1,107 +0,0 @@
-module GovukNavigationHelpers
-  class StepNavContent
-    STEP_NAV_NAMES = %w(
-      learn-to-drive-a-car
-    ).freeze
-
-    def self.current_step_nav(path)
-      STEP_NAV_NAMES.each do |step_nav_name|
-        step_nav = new(file_name: step_nav_name, path: path)
-        return step_nav if step_nav.current?
-      end
-      nil
-    end
-
-    def initialize(file_name: nil, path: nil)
-      @file_name = file_name
-      @path = path
-    end
-
-    def title
-      parsed_file.dig(:title)
-    end
-
-    def base_path
-      parsed_file.dig(:base_path)
-    end
-
-    def step_nav
-      parsed_file.dig(:step_by_step_nav)
-    end
-
-    def skip_link
-      "##{steps.first[:title].downcase.tr(' ', '-')}"
-    end
-
-    def primary_paths
-      primary_content.reject { |href|
-        href.start_with?('http')
-      }.select(&:present?)
-    end
-
-    def steps
-      step_nav.dig(:steps)
-    end
-
-    def related_paths
-      parsed_file.dig(:related_paths)
-    end
-
-    def set_current_step
-      set_step_as_active_if_current_page
-    end
-
-    def show_step_nav?
-      primary_paths.include?(path) ||
-        related_paths.include?(path)
-    end
-
-    def current?
-      primary_paths.include?(path) ||
-        related_paths.include?(path)
-    end
-
-  private
-
-    attr_reader :file_name, :file, :path
-
-    def set_step_as_active_if_current_page
-      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] == path
-              link[:active] = true
-              step_nav[:show_step] = step_index + 1
-              step_nav[:highlight_step] = step_index + 1
-              return step_nav
-            end
-          end
-        end
-      end
-
-      step_nav
-    end
-
-    def primary_content
-      list_content = steps.flat_map do |step|
-        step[:contents].select { |item| item[:type] == "list" }
-        .flat_map { |item| item[:contents] }
-      end
-
-      list_content.map { |list_item| list_item[:href] }
-    end
-
-    def parsed_file
-      @parsed_file ||=
-        JSON.parse(
-          File.read(
-            File.join(File.dirname(__FILE__), "../../", "config", "step_navs", "#{file_name}.json")
-          )
-        ).deep_symbolize_keys.tap do |json_file|
-          json_file[:step_by_step_nav].merge!(small: true, heading_level: 3)
-        end
-    end
-  end
-end

data/spec/related_navigation_sidebar_spec.rb

@@ -1,306 +0,0 @@
-require "spec_helper"
-
-RSpec.describe GovukNavigationHelpers::RelatedNavigationSidebar do
-  def payload_for(schema, content_item)
-    generator = GovukSchemas::RandomExample.for_schema(schema, schema_type: "frontend")
-    fully_valid_content_item = generator.merge_and_validate(content_item)
-    GovukNavigationHelpers::NavigationHelper.new(fully_valid_content_item).related_navigation_sidebar
-  end
-
-  describe "#related-navigation-sidebar" do
-    it "can handle randomly generated content" do
-      generator = GovukSchemas::RandomExample.for_schema("placeholder", schema_type: "frontend")
-
-      expect { payload_for("placeholder", generator.payload) }.to_not raise_error
-    end
-
-    it "returns empty arrays if there are no related navigation sidebar links" do
-      nothing = payload_for("placeholder",
-        "details" => {
-          "external_related_links" => []
-        },
-        "links" => {
-        })
-
-      expected = {
-        related_items: [],
-        collections: [],
-        statistical_data_sets: [],
-        topics: [],
-        topical_events: [],
-        policies: [],
-        publishers: [],
-        world_locations: [],
-        worldwide_organisations: [],
-        other: [[], []]
-      }
-
-      expect(nothing).to eql(expected)
-    end
-
-    it "extracts and returns the appropriate related links" do
-      payload = payload_for("speech",
-        "details" => {
-          "body" => "body",
-          "government" => {
-            "title" => "government",
-            "slug" => "government",
-            "current" => true
-            },
-          "political" => true,
-          "delivered_on" => "2017-09-22T14:30:00+01:00"
-        },
-        "links" => {
-          "parent" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "locale" => "en",
-              "base_path" => "/mainstream-topic",
-              "title" => "mainstream topic"
-            }
-          ],
-          "ordered_related_items" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "locale" => "en",
-              "base_path" => "/related-item",
-              "title" => "related item",
-              "links" => {
-                "mainstream_browse_pages" => [
-                  {
-                    "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-                    "locale" => "en",
-                    "base_path" => "/mainstream-topic",
-                    "title" => "mainstream topic"
-                  }
-                ]
-              }
-            }
-          ],
-          "document_collections" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "locale" => "en",
-              "base_path" => "/related-collection",
-              "title" => "related collection",
-              "document_type" => "document_collection"
-            }
-          ],
-          "topics" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "locale" => "en",
-              "base_path" => "/related-topic",
-              "title" => "related topic",
-              "document_type" => "topic"
-            }
-          ],
-          "topical_events" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "locale" => "en",
-              "base_path" => "/related-topical-event",
-              "title" => "related topical event",
-              "document_type" => "topical_event"
-            }
-          ],
-          "organisations" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "locale" => "en",
-              "base_path" => "/related-organisation",
-              "title" => "related organisation",
-              "document_type" => "organisation"
-            }
-          ],
-          "related_policies" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "locale" => "en",
-              "base_path" => "/related-policy",
-              "title" => "related policy",
-              "document_type" => "policy"
-            }
-          ],
-          "world_locations" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "title" => "World, ~ (@Location)",
-              "locale" => "en"
-            }
-          ],
-        })
-
-      expected = {
-        related_items: [{ path: "/related-item", text: "related item" }],
-        collections: [{ path: "/related-collection", text: "related collection" }],
-        topics: [{ path: "/related-topic", text: "related topic" }, { path: "/mainstream-topic", text: "mainstream topic" }],
-        topical_events: [{ path: "/related-topical-event", text: "related topical event" }],
-        policies: [{ path: "/related-policy", text: "related policy" }],
-        publishers: [{ path: "/related-organisation", text: "related organisation" }],
-        world_locations: [{ path: "/world/world-location/news", text: "World, ~ (@Location)" }],
-        worldwide_organisations: [],
-        statistical_data_sets: [],
-        other: [[], []]
-      }
-
-      expect(payload).to eql(expected)
-    end
-
-    it "returns worldwide organisations" do
-      payload = payload_for("world_location_news_article",
-        "details" => {
-          "body" => "body",
-          "government" => {
-            "title" => "government",
-            "slug" => "government",
-            "current" => true
-          },
-          "political" => true,
-          "first_public_at" => "2016-01-01T19:00:00Z",
-        },
-        "links" => {
-          "worldwide_organisations" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "title" => "related worldwide organisation",
-              "base_path" => "/related-worldwide-organisation",
-              "document_type" => "worldwide_organisation",
-              "locale" => "en"
-            }
-          ],
-        })
-      expected = {
-        related_items: [],
-        collections: [],
-        statistical_data_sets: [],
-        topics: [],
-        topical_events: [],
-        policies: [],
-        publishers: [],
-        world_locations: [],
-        worldwide_organisations: [{ path: "/related-worldwide-organisation", text: "related worldwide organisation" }],
-        other: [[], []]
-      }
-      expect(payload).to eql(expected)
-    end
-
-    it "returns statistical data sets" do
-      payload = payload_for("publication",
-        "details" => {
-          "body" => "body",
-          "government" => {
-            "title" => "government",
-            "slug" => "government",
-            "current" => true
-          },
-          "political" => false,
-          "documents" => [],
-          "first_public_at" => "2016-01-01T19:00:00Z",
-        },
-        "links" => {
-          "related_statistical_data_sets" => [
-            {
-              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-              "title" => "related statistical data set",
-              "base_path" => "/related-statistical-data-set",
-              "document_type" => "statistical_data_set",
-              "locale" => "en"
-            }
-          ],
-        })
-      expected = {
-        related_items: [],
-        collections: [],
-        statistical_data_sets: [{ path: "/related-statistical-data-set", text: "related statistical data set" }],
-        topics: [],
-        topical_events: [],
-        policies: [],
-        publishers: [],
-        world_locations: [],
-        worldwide_organisations: [],
-        other: [[], []]
-      }
-      expect(payload).to eql(expected)
-    end
-
-    it "returns an Elsewhere on the web section for external related links" do
-      payload = payload_for("placeholder",
-        "details" => {
-          "external_related_links" => [
-            {
-              "title" => "external-link",
-              "url" => "https://external"
-            }
-          ]
-        },)
-
-      expected = [
-        [
-          {
-            title: "Elsewhere on the web",
-            links: [{
-                text: "external-link",
-                path: "https://external",
-                rel: "external"
-              }]
-          }
-        ],
-        []
-      ]
-
-      expect(payload[:other]).to eql(expected)
-    end
-
-    it "deduplicates topics for mainstream content" do
-      mainstream_browse_link = {
-        "content_id" => "fecdc8c8-4006-4f8e-95d5-fe40ca49c7a8",
-        "locale" => "en",
-        "title" => "Self Assessment",
-        "base_path" => "/browse/tax/self-assessment",
-        "document_type" => "mainstream_browse_page",
-      }
-      payload = payload_for("answer",
-        "details" => {
-          "external_related_links" => []
-        },
-        "links" => {
-          "mainstream_browse_pages" => [mainstream_browse_link],
-          "ordered_related_items" => [
-            {
-              "content_id" => "f29ca4a8-8ed9-4b0f-bb6a-11e373095dee",
-              "locale" => "en",
-              "title" => "Self Assessment tax returns",
-              "base_path" => "/self-assessment-tax-returns",
-              "document_type" => "guide",
-              "links" => { "mainstream_browse_pages" => [mainstream_browse_link] },
-            }
-          ],
-          "parent" => [mainstream_browse_link],
-          "topics" => [
-            {
-              "content_id" => "7beb97b6-75c9-4aa7-86be-a733ab3a21aa",
-              "locale" => "en",
-              "base_path" => "/topic/personal-tax/self-assessment",
-              "title" => "Self Assessment",
-              "document_type" => "topic",
-            }
-          ],
-        })
-      expected = {
-        related_items: [{ text: "Self Assessment tax returns", path: "/self-assessment-tax-returns" }],
-        collections: [],
-        statistical_data_sets: [],
-        topics: [{ text: "Self Assessment", path: "/browse/tax/self-assessment" }],
-        topical_events: [],
-        policies: [],
-        publishers: [],
-        world_locations: [],
-        worldwide_organisations: [],
-        other: [[], []]
-      }
-
-      expect(payload).to eql(expected)
-    end
-  end
-end

data/spec/step_nav_content_spec.rb

@@ -1,163 +0,0 @@
-require 'spec_helper'
-
-module GovukNavigationHelpers
-  RSpec.describe StepNavContent do
-    let(:path) { '/pass-plus' }
-    let(:step_nav_content) { described_class.new(file_name: "learn-to-drive-a-car", path: path) }
-
-    context '.current_step_nav' do
-      context 'based on the request' do
-        context 'when the path is /pass-plus' do
-          it 'returns "Learn to Drive" step nav' do
-            current_step_nav = described_class.current_step_nav(path)
-
-            expect(
-              current_step_nav.title
-            ).to eql('Learn to drive a car: step by step')
-          end
-        end
-      end
-    end
-
-    context '#show_step_nav?' do
-      context 'when the requested path is part of the current step nav' do
-        it 'returns true' do
-          expect(
-            step_nav_content.show_step_nav?
-          ).to be true
-        end
-      end
-
-      context 'when the requested path is not part of the current step nav' do
-        let(:path) { '/pink-plus' }
-
-        it 'returns false' do
-          expect(
-            step_nav_content.show_step_nav?
-          ).to be false
-        end
-      end
-    end
-
-    context '#set_current_step' do
-      it 'sets /pass-plus as active' do
-        step_nav_content.set_current_step
-
-        expect(
-          step_nav_content.steps.last[:contents].last[:contents][0][:href]
-        ).to eql('/pass-plus')
-
-        expect(
-          step_nav_content.step_nav[:show_step]
-        ).to eql(7)
-
-        expect(
-          step_nav_content.steps.last[:contents].last[:contents][0][:active]
-        ).to be true
-      end
-    end
-
-    context "learning to drive a car step nav content" do
-      it "has symbolized keys" do
-        step_nav_content.step_nav.each_key do |key|
-          expect(key.is_a?(Symbol)).to be true
-        end
-      end
-
-      it "has a title" do
-        expect(step_nav_content.title).to eql("Learn to drive a car: step by step")
-      end
-
-      it "has a base_path" do
-        expect(step_nav_content.base_path).to eql("/learn-to-drive-a-car")
-      end
-
-      it "configures a sidebar" do
-        expect(step_nav_content.step_nav[:heading_level]).to eql(3)
-        expect(step_nav_content.step_nav[:small]).to be true
-      end
-
-      it "has a link in the correct structure" do
-        first_link = step_nav_content.step_nav[:steps][0][:contents][1][:contents][0]
-        expect(first_link[:href]).to eql("/vehicles-can-drive")
-        expect(first_link[:text]).to eql("Check what age you can drive")
-      end
-
-      it 'has all the primary paths' do
-        primary_paths = %w(
-          /apply-first-provisional-driving-licence
-          /book-driving-test
-          /book-theory-test
-          /cancel-driving-test
-          /cancel-theory-test
-          /change-driving-test
-          /change-theory-test
-          /check-driving-test
-          /check-theory-test
-          /driving-eyesight-rules
-          /driving-lessons-learning-to-drive
-          /driving-test/what-to-take
-          /find-driving-schools-and-lessons
-          /government/publications/car-show-me-tell-me-vehicle-safety-questions
-          /guidance/the-highway-code
-          /legal-obligations-drivers-riders
-          /pass-plus
-          /take-practice-theory-test
-          /theory-test/revision-and-practice
-          /theory-test/what-to-take
-          /vehicles-can-drive
-        ).sort
-
-        expect(
-          step_nav_content.primary_paths.sort
-        ).to match_array(primary_paths)
-      end
-
-      it 'has related paths' do
-        related_paths = %w(
-          /apply-for-your-full-driving-licence
-          /automatic-driving-licence-to-manual
-          /complain-about-a-driving-instructor
-          /driving-licence-fees
-          /driving-test-cost
-          /dvlaforms
-          /find-theory-test-pass-number
-          /government/publications/application-for-refunding-out-of-pocket-expenses
-          /government/publications/drivers-record-for-learner-drivers
-          /government/publications/driving-instructor-grades-explained
-          /government/publications/know-your-traffic-signs
-          /government/publications/l-plate-size-rules
-          /guidance/rules-for-observing-driving-tests
-          /report-an-illegal-driving-instructor
-          /report-driving-test-impersonation
-          /track-your-driving-licence-application
-          /driving-lessons-learning-to-drive/practising-with-family-or-friends
-          /driving-lessons-learning-to-drive/taking-driving-lessons
-          /driving-lessons-learning-to-drive/using-l-and-p-plates
-          /driving-test
-          /driving-test/changes-december-2017
-          /driving-test/disability-health-condition-or-learning-difficulty
-          /driving-test/driving-test-faults-result
-          /driving-test/test-cancelled-bad-weather
-          /driving-test/using-your-own-car
-          /driving-test/what-happens-during-test
-          /pass-plus/apply-for-a-pass-plus-certificate
-          /pass-plus/booking-pass-plus
-          /pass-plus/car-insurance-discounts
-          /pass-plus/local-councils-offering-discounts
-          /pass-plus/how-pass-plus-training-works
-          /theory-test
-          /theory-test/hazard-perception-test
-          /theory-test/if-you-have-safe-road-user-award
-          /theory-test/multiple-choice-questions
-          /theory-test/pass-mark-and-result
-          /theory-test/reading-difficulty-disability-or-health-condition
-        ).sort
-
-        expect(
-          step_nav_content.related_paths.sort
-        ).to match_array(related_paths)
-      end
-    end
-  end
-end