govuk_navigation_helpers 6.3.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c461bdaf7894d043e544c90c0a55847e2ef71aeb
-  data.tar.gz: b6faea824ddea2a36d627eec6a1f2f60d05fc009
+  metadata.gz: ec1764a33f8094c760cd5a83e47ae8a51277b119
+  data.tar.gz: f28cae4e16260780344f7f77c5d0043f569d628e
 SHA512:
-  metadata.gz: 729b456c6c589ea4cbed175c5fd5798a1e1c28f0be3c80f4a329235bf37af534cfa226b755ada6b4fd9a18462362ca1ae7ed65d58bc043290f1130f34f71f2e2
-  data.tar.gz: f96e665046a7619631bc8c1295c21385067ce5de8dcf06d0e66250f103f1207ae143a7fa651026358298fddd68f7fdfc766413f329ffdbd3260d61ef1abe18be
+  metadata.gz: 91bade4008ffcbbaf9c51dbd2a86a93ab474b0b5fc8c9038113016e7ffc6d9de9b59e227629d000e1ded82944779534f58c3aefe72b6acd7c746fda3ce00e4d6
+  data.tar.gz: 865b85c47eeed422b1960e5874b391f8f298d8a01a686ddbb8699fec6ab35246ecfd89750a9534f9f227a13e9661ca6c4143d0483946406fd8093de665724592

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 7.0.0
+
+* Root taxons are now whitelisted, so that only taxons descendant from one of
+  the three published root taxons (education, childcare-parenting and world)
+  will appear in breadcrumbs and the side bar. See the [PR](https://github.com/alphagov/govuk_navigation_helpers/pull/82) for more information
+
 ## 6.3.0
 
 * Allow curated related links to be shown on the new navigation sidebar. If the

data/lib/govuk_navigation_helpers/content_item.rb

@@ -5,6 +5,18 @@ module GovukNavigationHelpers
   #
   # @private
   class ContentItem
+    WORLD_TAXON_CONTENT_ID = "91b8ef20-74e7-4552-880c-50e6d73c2ff9".freeze
+    EDUCATION_TAXON_CONTENT_ID = "c58fdadd-7743-46d6-9629-90bb3ccc4ef0".freeze
+    CHILDCARE_PARENTING_TAXON_CONTENT_ID = "206b7f3a-49b5-476f-af0f-fd27e2a68473".freeze
+
+    def self.whitelisted_root_taxon_content_ids
+      [
+        WORLD_TAXON_CONTENT_ID,
+        EDUCATION_TAXON_CONTENT_ID,
+        CHILDCARE_PARENTING_TAXON_CONTENT_ID,
+      ]
+    end
+
     attr_reader :content_store_response
 
     def initialize(content_store_response)
@@ -24,14 +36,11 @@ module GovukNavigationHelpers
     end
 
     def parent_taxons
-      # First handle the case for content items tagged to the taxonomy.
-      taxons = Array(content_store_response.dig("links", "taxons"))
-      return taxons.map { |taxon| ContentItem.new(taxon) }.sort_by(&:title) if taxons.any?
-
-      # If that link isn't present, assume we're dealing with a taxon and check
-      # for its parents in the taxonomy.
-      parent_taxons = Array(content_store_response.dig("links", "parent_taxons"))
-      parent_taxons.map { |taxon| ContentItem.new(taxon) }.sort_by(&:title)
+      @_parent_taxons ||= begin
+        taxon_links
+          .select { |t| descendent_from_whitelisted_root_taxon?(t) }
+          .map { |taxon| ContentItem.new(taxon) }.sort_by(&:title)
+      end
     end
 
     def mainstream_browse_pages
@@ -90,5 +99,29 @@ module GovukNavigationHelpers
     def eql?(other)
       self == other
     end
+
+  private
+
+    def taxon_links
+      # A normal content item's taxon links are stored in ["links"]["taxons"]
+      # whereas a Taxon content item's taxon links are stored in ["links"]["parent_taxons"]
+      # so here we cater for both possibilities
+      content_store_response.dig("links", "taxons") || content_store_response.dig("links", "parent_taxons") || []
+    end
+
+    def descendent_from_whitelisted_root_taxon?(taxon)
+      root_taxon = get_root_taxon(taxon)
+      ContentItem.whitelisted_root_taxon_content_ids.include?(root_taxon["content_id"])
+    end
+
+    def get_root_taxon(taxon)
+      parent_taxons = taxon.dig("links", "parent_taxons")
+
+      if parent_taxons.nil? || parent_taxons.empty?
+        taxon
+      else
+        get_root_taxon(parent_taxons.first)
+      end
+    end
   end
 end

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "6.3.0".freeze
+  VERSION = "7.0.0".freeze
 end

data/spec/content_item_spec.rb

@@ -0,0 +1,212 @@
+require "spec_helper"
+
+RSpec.describe GovukNavigationHelpers::ContentItem do
+  describe ".whitelisted_root_taxon_content_ids" do
+    it "returns the whitelisted content_ids" do
+      expected_content_ids = [
+        "91b8ef20-74e7-4552-880c-50e6d73c2ff9",
+        "c58fdadd-7743-46d6-9629-90bb3ccc4ef0",
+        "206b7f3a-49b5-476f-af0f-fd27e2a68473",
+      ]
+
+      content_ids = described_class.whitelisted_root_taxon_content_ids
+      expect(content_ids).to eq(expected_content_ids)
+    end
+  end
+
+  describe "#parent_taxons" do
+    before do
+      allow(described_class)
+        .to receive(:whitelisted_root_taxon_content_ids)
+        .and_return(["aaaa-bbbb"])
+    end
+
+    context "for a content item with taxons links" do
+      context "with a whitelisted parent taxon" do
+        let(:taxon) do
+          {
+            "content_id" => "cccc-dddd",
+            "title" => "Taxon",
+            "links" => {
+              "parent_taxons" => [
+                {
+                  "content_id" => "aaaa-bbbb",
+                  "title" => "Taxon",
+                }
+              ]
+            }
+          }
+        end
+
+        let(:content_item_response) do
+          {
+            "title" => "Some Answer Content Item",
+            "document_type" => "answer",
+            "links" => {
+              "taxons" => [taxon],
+            }
+          }
+        end
+
+        it "returns the parent taxons" do
+          expected_parent_taxon = described_class.new(taxon)
+          expect(described_class.new(content_item_response).parent_taxons).to contain_exactly(expected_parent_taxon)
+        end
+      end
+
+      context "with a non-whitelisted parent taxon" do
+        let(:taxon) do
+          {
+            "content_id" => "cccc-dddd",
+            "title" => "Taxon",
+            "links" => {
+              "parent_taxons" => [
+                {
+                  "content_id" => "xxxx-xxxx",
+                  "title" => "Non Whitelisted Taxon",
+                }
+              ]
+            }
+          }
+        end
+
+        let(:content_item_response) do
+          {
+            "title" => "Some Answer Content Item",
+            "document_type" => "answer",
+            "links" => {
+              "taxons" => [taxon],
+            }
+          }
+        end
+
+        it "returns an empty array" do
+          expect(described_class.new(content_item_response).parent_taxons).to eq([])
+        end
+      end
+    end
+
+    context "for a content item with no taxons links" do
+      context "with missing links hash" do
+        let(:content_item_response) do
+          {
+            "title" => "Some Answer Content Item",
+            "document_type" => "answer",
+          }
+        end
+
+        it "returns an empty array" do
+          expect(described_class.new(content_item_response).parent_taxons).to eq([])
+        end
+      end
+
+      context "with missing taxons links hash" do
+        let(:content_item_response) do
+          {
+            "title" => "Some Answer Content Item",
+            "document_type" => "answer",
+            "links" => {},
+          }
+        end
+
+        it "returns an empty array" do
+          expect(described_class.new(content_item_response).parent_taxons).to eq([])
+        end
+      end
+    end
+
+    context "for a taxon content item with parent taxon links" do
+      context "with a whitelisted parent taxon" do
+        let(:taxon) do
+          {
+            "content_id" => "cccc-dddd",
+            "title" => "Taxon",
+            "links" => {
+              "parent_taxons" => [
+                {
+                  "content_id" => "aaaa-bbbb",
+                  "title" => "Taxon",
+                }
+              ]
+            }
+          }
+        end
+
+        let(:content_item_response) do
+          {
+            "title" => "Some Taxon Content Item",
+            "document_type" => "taxon",
+            "links" => {
+              "parent_taxons" => [taxon],
+            }
+          }
+        end
+
+        it "returns the parent taxons" do
+          expected_parent_taxon = described_class.new(taxon)
+          expect(described_class.new(content_item_response).parent_taxons).to contain_exactly(expected_parent_taxon)
+        end
+      end
+
+      context "with a non-whitelisted parent taxon" do
+        let(:taxon) do
+          {
+            "content_id" => "cccc-dddd",
+            "title" => "Taxon",
+            "links" => {
+              "parent_taxons" => [
+                {
+                  "content_id" => "xxxx-xxxx",
+                  "title" => "Non Whitelisted Taxon",
+                }
+              ]
+            }
+          }
+        end
+
+        let(:content_item_response) do
+          {
+            "title" => "Some Taxon Content Item",
+            "document_type" => "taxon",
+            "links" => {
+              "parent_taxons" => [taxon],
+            }
+          }
+        end
+
+        it "returns an empty array" do
+          expect(described_class.new(content_item_response).parent_taxons).to eq([])
+        end
+      end
+    end
+
+    context "for a taxon content item with no parent taxons links" do
+      context "with missing links hash" do
+        let(:content_item_response) do
+          {
+            "title" => "Some Taxon Content Item",
+            "document_type" => "taxon",
+          }
+        end
+
+        it "returns an empty array" do
+          expect(described_class.new(content_item_response).parent_taxons).to eq([])
+        end
+      end
+
+      context "with missing parent taxons links hash" do
+        let(:content_item_response) do
+          {
+            "title" => "Some Taxon Content Item",
+            "document_type" => "taxon",
+            "links" => {},
+          }
+        end
+
+        it "returns an empty array" do
+          expect(described_class.new(content_item_response).parent_taxons).to eq([])
+        end
+      end
+    end
+  end
+end

data/spec/taxon_breadcrumbs_spec.rb

@@ -2,6 +2,12 @@ require 'spec_helper'
 
 RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
   describe "Taxon breadcrumbs" do
+    before do
+      allow(GovukNavigationHelpers::ContentItem)
+        .to receive(:whitelisted_root_taxon_content_ids)
+        .and_return(['30c1b93d-2553-47c9-bc3c-fc5b513ecc32'])
+    end
+
     it "can handle any valid content item" do
       generator = GovukSchemas::RandomExample.for_schema(
         "taxon",
@@ -16,7 +22,11 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
     end
 
     it "returns the root when taxon is not specified" do
-      content_item = { "title" => "Some Content", "links" => {} }
+      content_item = {
+        "title" => "Some Content",
+        "document_type" => "answer",
+        "links" => {},
+      }
       breadcrumbs = breadcrumbs_for(content_item)
 
       expect(breadcrumbs).to eq(
@@ -40,23 +50,23 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
       )
     end
 
-    context 'with a taxon content item with taxon parents' do
+    context 'with a taxon with taxon parents' do
       it "includes parents and grandparents when available" do
         grandparent = {
-            "title" => "Another-parent",
-            "base_path" => "/another-parent",
-            "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-            "locale" => "en",
+          "title" => "Another-parent",
+          "base_path" => "/another-parent",
+          "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+          "locale" => "en",
         }
 
         parent = {
-            "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-            "locale" => "en",
-            "title" => "A-parent",
-            "base_path" => "/a-parent",
-            "links" => {
-                "parent_taxons" => [grandparent]
-            }
+          "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+          "locale" => "en",
+          "title" => "A-parent",
+          "base_path" => "/a-parent",
+          "links" => {
+            "parent_taxons" => [grandparent]
+          }
         }
 
         content_item = content_item_tagged_to_taxon([parent])
@@ -74,16 +84,16 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
       end
     end
 
-    context 'with a taxon with parent taxons' do
+    context 'with a taxon content item with parent taxons' do
       it "includes parents and grandparents when available" do
         parent = {
-            "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-            "locale" => "en",
-            "title" => "A-parent",
-            "base_path" => "/a-parent",
-            "links" => {
-                "parent_taxons" => []
-            }
+          "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+          "locale" => "en",
+          "title" => "A-parent",
+          "base_path" => "/a-parent",
+          "links" => {
+            "parent_taxons" => []
+          }
         }
 
         content_item = taxon_with_parent_taxons([parent])
@@ -102,22 +112,22 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
     context 'with multiple parents' do
       it "selects the first parent taxon in alphabetical order by title" do
         parent_1 = {
-            "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-            "locale" => "en",
-            "title" => "Parent A",
-            "base_path" => "/parent-a",
-            "links" => {
-                "parent_taxons" => []
-            }
+          "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+          "locale" => "en",
+          "title" => "Parent A",
+          "base_path" => "/parent-a",
+          "links" => {
+            "parent_taxons" => []
+          }
         }
         parent_2 = {
-            "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
-            "locale" => "en",
-            "title" => "Parent B",
-            "base_path" => "/parent-b",
-            "links" => {
-                "parent_taxons" => []
-            }
+          "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+          "locale" => "en",
+          "title" => "Parent B",
+          "base_path" => "/parent-b",
+          "links" => {
+            "parent_taxons" => []
+          }
         }
 
         content_item = taxon_with_parent_taxons([parent_2, parent_1])
@@ -135,7 +145,7 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
   end
 
   def breadcrumbs_for(content_item)
-    generator = GovukSchemas::RandomExample.for_schema("taxon", schema_type: "frontend")
+    generator = GovukSchemas::RandomExample.for_schema(content_item["document_type"], schema_type: "frontend")
     fully_valid_content_item = generator.merge_and_validate(content_item)
 
     # Use the main class instead of GovukNavigationHelpers::Breadcrumbs, so that
@@ -156,7 +166,7 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
   def content_item_tagged_to_taxon(parents)
     {
       "title" => "Some Content",
-      "document_type" => "guidance",
+      "document_type" => "answer",
       "links" => {
         "taxons" => [
           {

data/spec/taxonomy_sidebar_spec.rb

@@ -6,6 +6,12 @@ include GdsApi::TestHelpers::Rummager
 
 RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
   describe '#sidebar' do
+    before do
+      allow(GovukNavigationHelpers::ContentItem)
+        .to receive(:whitelisted_root_taxon_content_ids)
+        .and_return(['taxon-a', 'taxon-b', 'taxon-c'])
+    end
+
     it 'can handle any valid content item' do
       stub_any_rummager_search_to_return_no_results
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 7.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-05 00:00:00.000000000 Z
+date: 2017-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
@@ -182,6 +182,7 @@ files:
 - 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/spec_helper.rb
 - spec/taxon_breadcrumbs_spec.rb
@@ -212,6 +213,7 @@ specification_version: 4
 summary: Gem to transform items from the content-store into payloads for GOV.UK components
 test_files:
 - spec/breadcrumbs_spec.rb
+- spec/content_item_spec.rb
 - spec/related_items_spec.rb
 - spec/spec_helper.rb
 - spec/taxon_breadcrumbs_spec.rb