govuk_navigation_helpers 9.0.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f8820828e39de3f4448cd51867ab33863f33171
-  data.tar.gz: ccc32400f50f9c8b52942861d56baea10cd5e745
+  metadata.gz: cfe90c1b0207936166968071bbe57c3b9b6e98dd
+  data.tar.gz: 9ad575a04047684089fafa8000807e1f242833ca
 SHA512:
-  metadata.gz: 8b81687bb032f4b4811572a6b2c52339acfd28f635faa49ecd327f1fc17a36dec0277383ce238ca04c4e330d32e7650eb5c29b9f5223f7dbc27c9cf9f1cb717a
-  data.tar.gz: 3bbc43ff6e987c2a4295d9f249ba8fae74a704363c2a7b9157aa8bc60dbc89e804ea22f0591abc87d13d5e529bda9a45d0636da0ca3d0ee1e3b27f9cf60ebf6d
+  metadata.gz: 6bbbceff78a86fef6711c84465bba37bcf8a676a14305f959e0de2cab8cbef5f07eb3310767a13040eb5c66fad6e843421e7dcd9d89b6d85eb2b3876c71fc41e
+  data.tar.gz: 61d239cd0fe9de022bb8c3a982f3be957c7017bc1463da20ba15d33966a96ab9d8ef2380b862333e42a9d382afab697da9cbb4ed29344262258f06b9cdfff13c

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## Unreleased
+## 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.
 
 ## 9.0.0
 * Task lists are now called "step by step navigation".  Things have been renamed to support this

data/Jenkinsfile

@@ -1,9 +1,10 @@
 #!/usr/bin/env groovy
 
+library("govuk")
+
 REPOSITORY = 'govuk_navigation_helpers'
 
 node {
-  def govuk = load '/var/lib/jenkins/groovy_scripts/govuk_jenkinslib.groovy'
 
   try {
     stage('Checkout') {

data/README.md

@@ -2,6 +2,11 @@
 
 This is a gem to share code between GOV.UK frontends.
 
+** It should not be used anymore ***
+
+This gem was a temporary solution to the problem of sharing code used to generate
+the input to components. Since the components can now be built into the [govuk_publishing_components gem](https://github.com/alphagov/govuk_publishing_components), it is no longer necessary.
+
 ## Nomenclature
 
 - **content item**: An object returned by the content store

data/lib/govuk_navigation_helpers/content_item.rb

@@ -5,18 +5,6 @@ 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)
@@ -38,11 +26,15 @@ module GovukNavigationHelpers
     def parent_taxons
       @_parent_taxons ||= begin
         taxon_links
-          .select { |t| descendent_from_whitelisted_root_taxon?(t) }
+          .select { |t| phase_is_live?(t) }
           .map { |taxon| ContentItem.new(taxon) }.sort_by(&:title)
       end
     end
 
+    def phase_is_live?(taxon)
+      taxon["phase"] == "live"
+    end
+
     def mainstream_browse_pages
       content_store_response.dig("links", "mainstream_browse_pages").to_a.map do |link|
         ContentItem.new(link)
@@ -153,21 +145,6 @@ module GovukNavigationHelpers
       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
-
     def filter_link_type(links, type)
       links.select do |link|
         link["document_type"] == type

data/lib/govuk_navigation_helpers/version.rb

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

data/spec/content_item_spec.rb

@@ -1,32 +1,14 @@
 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
+      context "with a parent taxon with phase set to 'live'" do
         let(:taxon) do
           {
             "content_id" => "cccc-dddd",
             "title" => "Taxon",
+            "phase" => "live",
             "links" => {
               "parent_taxons" => [
                 {
@@ -54,11 +36,12 @@ RSpec.describe GovukNavigationHelpers::ContentItem do
         end
       end
 
-      context "with a non-whitelisted parent taxon" do
+      context "with a parent taxon with phase not set to 'live'" do
         let(:taxon) do
           {
             "content_id" => "cccc-dddd",
             "title" => "Taxon",
+            "phase" => "beta",
             "links" => {
               "parent_taxons" => [
                 {
@@ -116,11 +99,12 @@ RSpec.describe GovukNavigationHelpers::ContentItem do
     end
 
     context "for a taxon content item with parent taxon links" do
-      context "with a whitelisted parent taxon" do
+      context "with a parent taxon with phase set to 'live'" do
         let(:taxon) do
           {
             "content_id" => "cccc-dddd",
             "title" => "Taxon",
+            "phase" => "live",
             "links" => {
               "parent_taxons" => [
                 {
@@ -148,11 +132,12 @@ RSpec.describe GovukNavigationHelpers::ContentItem do
         end
       end
 
-      context "with a non-whitelisted parent taxon" do
+      context "with a parent taxon with phase not set to 'live'" do
         let(:taxon) do
           {
             "content_id" => "cccc-dddd",
             "title" => "Taxon",
+            "phase" => "beta",
             "links" => {
               "parent_taxons" => [
                 {

data/spec/taxon_breadcrumbs_spec.rb

@@ -2,12 +2,6 @@ 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",
@@ -57,6 +51,7 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
           "base_path" => "/another-parent",
           "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
           "locale" => "en",
+          "phase" => "live",
         }
 
         parent = {
@@ -64,6 +59,7 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
           "locale" => "en",
           "title" => "A-parent",
           "base_path" => "/a-parent",
+          "phase" => "live",
           "links" => {
             "parent_taxons" => [grandparent]
           }
@@ -91,6 +87,7 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
           "locale" => "en",
           "title" => "A-parent",
           "base_path" => "/a-parent",
+          "phase" => "live",
           "links" => {
             "parent_taxons" => []
           }
@@ -116,6 +113,7 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
           "locale" => "en",
           "title" => "Parent A",
           "base_path" => "/parent-a",
+          "phase" => "live",
           "links" => {
             "parent_taxons" => []
           }
@@ -125,6 +123,7 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
           "locale" => "en",
           "title" => "Parent B",
           "base_path" => "/parent-b",
+          "phase" => "live",
           "links" => {
             "parent_taxons" => []
           }
@@ -174,6 +173,7 @@ RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
             "locale" => "en",
             "title" => "Taxon",
             "base_path" => "/taxon",
+            "phase" => "live",
             "links" => {
               "parent_taxons" => parents
             },

data/spec/taxonomy_sidebar_spec.rb

@@ -6,12 +6,6 @@ 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
 
@@ -95,7 +89,8 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
           "title" => "Taxon C",
           "base_path" => "/taxon-c",
           "content_id" => "taxon-c",
-          "description" => "The C taxon."
+          "description" => "The C taxon.",
+          "phase" => "live",
         }
 
         expect(sidebar_for(content_item)).to eq(
@@ -507,12 +502,14 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
             "base_path" => "/taxon-b",
             "content_id" => "taxon-b",
             "description" => "The B taxon.",
+            "phase" => "live",
           },
           {
             "title" => "Taxon A",
             "base_path" => "/taxon-a",
             "content_id" => "taxon-a",
             "description" => "The A taxon.",
+            "phase" => "live",
           },
         ],
       },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport