govuk_navigation_helpers 6.0.0 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cdcea6379cf6d09c857f36769c16203d5d8b812
-  data.tar.gz: 0e118e185e0d05725753b9a8b2d1948a595fe84f
+  metadata.gz: 434be3c06278a7ab5026fb992df43a9f128c089a
+  data.tar.gz: 0a2d1c74c4f0c23fa99246c2bf77a8dda41b5de5
 SHA512:
-  metadata.gz: a4402b69ee51003193321c3ca76d7450238c99f62cfbc6b6a967862dee1237d21d3eb5bf8f0f811c2697b280e1c751f2fd27446558a1bdc55cc097f7039c3c6b
-  data.tar.gz: 45fa9631f380619fc91034ba55d8c40a7f072a3c6f05b4f69583fab9f37ed9d5c41d5daeaf863931d6b413f86bf4a966b99995ae19696a3588fe92e8eebf26af
+  metadata.gz: 7b1b8f7edf9bd7ea448378da790de77ec89275124afd01b9cc8da42f91507af886f9b2681b1651d75d08784868c4f5baec9c110895643b666cf46d636f140f9b
+  data.tar.gz: eb6fcd6a1a34a4c0136d7a5ffedb3e4799d2e6fae684c0e18e12b4ed3d2ebda134bc194ddab298c7e85e249fc3a5660a145737a386878852a9fc9ba2f9c3f2ad

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 6.0.1
+
+* Remove duplicate related links from search for the new taxonomy sidebar.
+
 ## 6.0.0
 
 * **BREAKING CHANGE**: Bump gds-api-adapters to 42.2, which makes `lgil`

data/lib/govuk_navigation_helpers/content_item.rb

@@ -62,12 +62,6 @@ module GovukNavigationHelpers
       end
     end
 
-    def related_overrides
-      content_store_response.dig("links", "ordered_related_items_overrides").to_a.map do |link|
-        ContentItem.new(link)
-      end
-    end
-
     def external_links
       content_store_response.dig("details", "external_related_links").to_a
     end

data/lib/govuk_navigation_helpers/taxonomy_sidebar.rb

@@ -9,7 +9,7 @@ module GovukNavigationHelpers
 
     def sidebar
       {
-        items: [taxons, elsewhere_on_govuk, elsewhere_on_the_web].flatten
+        items: taxons
       }
     end
 
@@ -21,9 +21,14 @@ module GovukNavigationHelpers
 
     def taxons
       parent_taxons = @content_item.parent_taxons
+      used_related_links = Set.new
 
       parent_taxons.each_with_index.map do |parent_taxon, index|
-        related_content = index < 2 ? content_related_to(parent_taxon) : []
+        related_content = index < 2 ? content_related_to(parent_taxon, used_related_links) : []
+
+        used_related_links.merge(
+          related_content.map { |content| content[:link] }
+        )
 
         {
           title: parent_taxon.title,
@@ -34,47 +39,10 @@ module GovukNavigationHelpers
       end
     end
 
-    def elsewhere_on_govuk
-      return [] if @content_item.related_overrides.empty?
-
-      related_content = @content_item.related_overrides.map do |override|
-        {
-          title: override.title,
-          link: override.base_path
-        }
-      end
-
-      [
-        {
-          title: "Elsewhere on GOV.UK",
-          related_content: related_content
-        }
-      ]
-    end
-
-    def elsewhere_on_the_web
-      return [] if @content_item.external_links.empty?
-
-      related_content = @content_item.external_links.map do |external_link|
-        {
-          title: external_link.fetch('title'),
-          link: external_link.fetch('url'),
-          rel: 'external'
-        }
-      end
-
-      [
-        {
-          title: "Elsewhere on the web",
-          related_content: related_content
-        }
-      ]
-    end
-
-    # This method will fetch content related to @content_item, and tagged to
-    # taxon. This is a temporary method that uses search to achieve this. This
-    # behaviour is to be moved into the content store.
-    def content_related_to(taxon)
+    # This method will fetch content related to @content_item, and tagged to taxon. This is a
+    # temporary method that uses search to achieve this. This behaviour is to be moved into
+    # the content store
+    def content_related_to(taxon, used_related_links)
       statsd.time(:taxonomy_sidebar_search_time) do
         begin
           results = Services.rummager.search(
@@ -83,6 +51,7 @@ module GovukNavigationHelpers
             count: 3,
             filter_taxons: [taxon.content_id],
             filter_navigation_document_supertype: 'guidance',
+            reject_link: used_related_links.to_a,
             fields: %w[title link],
           )['results']
 

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "6.0.0".freeze
+  VERSION = "6.0.1".freeze
 end

data/spec/taxonomy_sidebar_spec.rb

@@ -6,9 +6,9 @@ include GdsApi::TestHelpers::Rummager
 
 RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
   describe '#sidebar' do
-    before { stub_any_rummager_search_to_return_no_results }
-
     it 'can handle any valid content item' do
+      stub_any_rummager_search_to_return_no_results
+
       generator = GovukSchemas::RandomExample.for_schema(
         'placeholder',
         schema_type: 'frontend'
@@ -123,16 +123,44 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
           ]
         )
       end
+    end
+
+    context 'given there are repeated related links across different parent taxons' do
+      before do
+        # First taxon should have links A and B
+        stub_request(
+          :get,
+          %r{.*search.json?.*\&filter_taxons%5B%5D=taxon-a.*}
+        ).to_return(
+          body: {
+            'results': [
+              { 'title': 'Related item A', 'link': '/related-item-a', },
+              { 'title': 'Related item B', 'link': '/related-item-b', },
+            ],
+          }.to_json
+        )
+
+        # Second taxon should only return link C, and reject the other 2
+        stub_request(
+          :get,
+          %r{.*search.json?.*\&filter_taxons%5B%5D=taxon-b.*&reject_link%5B%5D=/related-item-a&reject_link%5B%5D=/related-item-b.*}
+        ).to_return(
+          body: {
+            'results': [
+              { 'title': 'Related item C', 'link': '/related-item-c', },
+            ],
+          }.to_json
+        )
+      end
 
-      it "includes curated and external links when available" do
+      it 'does not duplicate the related links across each taxon' do
         expect(GovukNavigationHelpers.configuration.statsd).to receive(
           :increment
         ).with(
           :taxonomy_sidebar_searches
-        ).once
+        ).twice
 
-        content_item =
-          content_item_tagged_to_taxon_with_curated_and_external_links
+        content_item = content_item_tagged_to_taxon
 
         expect(sidebar_for(content_item)).to eq(
           items: [
@@ -143,24 +171,15 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
               related_content: [
                 { 'title': 'Related item A', 'link': '/related-item-a', },
                 { 'title': 'Related item B', 'link': '/related-item-b', },
-                { 'title': 'Related item C', 'link': '/related-item-c', },
               ],
             },
             {
-              title: "Elsewhere on GOV.UK",
-              related_content: [
-                { title: "Curated link 1", link: "/curated-link-1" }
-              ]
-            },
-            {
-              title: "Elsewhere on the web",
+              title: "Taxon B",
+              url: "/taxon-b",
+              description: "The B taxon.",
               related_content: [
-                {
-                  title: "An external link",
-                  link: "www.external-link.com",
-                  rel: "external"
-                }
-              ]
+                { 'title': 'Related item C', 'link': '/related-item-c', },
+              ],
             }
           ]
         )
@@ -226,32 +245,4 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
       },
     }
   end
-
-  def content_item_tagged_to_taxon_with_curated_and_external_links
-    {
-      "title" => "A piece of content",
-      "base_path" => "/a-piece-of-content",
-      "links" => {
-        "taxons" => [
-          {
-            "title" => "Taxon A",
-            "base_path" => "/taxon-a",
-            "content_id" => "taxon-a",
-            "description" => "The A taxon.",
-          }
-        ],
-        "ordered_related_items_overrides" => [
-          "title" => "Curated link 1",
-          "base_path" => "/curated-link-1",
-          "content_id" => "curated-link-1",
-        ]
-      },
-      "details" => {
-        "external_related_links" => [
-          "url" => "www.external-link.com",
-          "title" => "An external link"
-        ]
-      }
-    }
-  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.0.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-24 00:00:00.000000000 Z
+date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters