govuk_navigation_helpers 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3d18101e3d40e2584d480f3aa5690142e1114c2
-  data.tar.gz: bb33a4f50beebe2d1b20fcd0546032f2360da0fe
+  metadata.gz: c461bdaf7894d043e544c90c0a55847e2ef71aeb
+  data.tar.gz: b6faea824ddea2a36d627eec6a1f2f60d05fc009
 SHA512:
-  metadata.gz: f6b9748dec2db2e5206ee6d99a43da48ec8e0defdca905d792bc6e2e38170b2009468ca92603552f8093a0edb1c305ee0f7745ad05effcb6ccf822cdfc68fc5e
-  data.tar.gz: 92fe160a5c1860e2299b9760c1eb35cf248292fd449384ab345429f3b0edb65864604cbcb55ecc9bf0e54779674e3940af8e9f535a04e8b7836cc634f5c81a7b
+  metadata.gz: 729b456c6c589ea4cbed175c5fd5798a1e1c28f0be3c80f4a329235bf37af534cfa226b755ada6b4fd9a18462362ca1ae7ed65d58bc043290f1130f34f71f2e2
+  data.tar.gz: f96e665046a7619631bc8c1295c21385067ce5de8dcf06d0e66250f103f1207ae143a7fa651026358298fddd68f7fdfc766413f329ffdbd3260d61ef1abe18be

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 6.3.0
+
+* Allow curated related links to be shown on the new navigation sidebar. If the
+  link type `ordered_related_items_overrides` contains links to content items,
+  we will use those instead of the "more like this" links from search. These
+  links can be added in `content-tagger`.
+
 ## 6.2.0
 
 * Remove "Register to vote" section from related links data as deadline of

data/lib/govuk_navigation_helpers.rb

@@ -3,6 +3,8 @@ require "govuk_navigation_helpers/breadcrumbs"
 require "govuk_navigation_helpers/related_items"
 require "govuk_navigation_helpers/taxon_breadcrumbs"
 require "govuk_navigation_helpers/taxonomy_sidebar"
+require "govuk_navigation_helpers/rummager_taxonomy_sidebar_links"
+require "govuk_navigation_helpers/curated_taxonomy_sidebar_links"
 
 module GovukNavigationHelpers
   class NavigationHelper

data/lib/govuk_navigation_helpers/content_item.rb

@@ -62,8 +62,33 @@ module GovukNavigationHelpers
       end
     end
 
+    def curated_taxonomy_sidebar_links
+      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
+
+    def as_taxonomy_sidebar_link
+      {
+        title: title,
+        link: base_path,
+      }
+    end
+
+    def ==(other)
+      content_id == other.content_id
+    end
+
+    def hash
+      content_id.hash
+    end
+
+    def eql?(other)
+      self == other
+    end
   end
 end

data/lib/govuk_navigation_helpers/curated_taxonomy_sidebar_links.rb

@@ -0,0 +1,96 @@
+require 'set'
+
+module GovukNavigationHelpers
+  class CuratedTaxonomySidebarLinks
+    def initialize(content_item)
+      @content_item = content_item
+    end
+
+    def related_items
+      @related_items ||=
+        taxon_links +
+        elsewhere_on_gov_uk_links +
+        elsewhere_on_the_web_links
+    end
+
+  private
+
+    def taxon_links
+      @content_item.parent_taxons.map do |taxon|
+        {
+          title: taxon.title,
+          url: taxon.base_path,
+          description: taxon.description,
+          related_content: format_for_sidebar(related_content_by_taxon[taxon]),
+        }
+      end
+    end
+
+    def elsewhere_on_gov_uk_links
+      elsewhere_items = related_content_elsewhere_on_govuk
+      return [] if elsewhere_items.empty?
+
+      [
+        {
+          title: 'Elsewhere on GOV.UK',
+          related_content: format_for_sidebar(elsewhere_items),
+        },
+      ]
+    end
+
+    def elsewhere_on_the_web_links
+      return [] if @content_item.external_links.empty?
+
+      external_links = @content_item.external_links.map do |link|
+        {
+          title: link['title'],
+          link: link['url'],
+        }
+      end
+
+      [
+        {
+          title: 'Elsewhere on the web',
+          related_content: external_links,
+        },
+      ]
+    end
+
+    def related_content_by_taxon
+      @related_items_by_taxon ||= begin
+        curated_related_items = @content_item.curated_taxonomy_sidebar_links.to_set
+
+        @content_item.parent_taxons.each_with_object({}) do |taxon, items_by_taxon|
+          items_related_to_taxon = filter_items_by_taxon(curated_related_items, taxon)
+          items_by_taxon[taxon] = items_related_to_taxon
+          curated_related_items = undisplayed_items(curated_related_items, items_related_to_taxon)
+        end
+      end
+    end
+
+    def related_content_elsewhere_on_govuk
+      @related_content_elsewhere_on_govuk ||= begin
+        related_content = @content_item.curated_taxonomy_sidebar_links.to_set
+        related_taxon_content = related_content_by_taxon.values.flatten.to_set
+        related_content - related_taxon_content
+      end
+    end
+
+    def filter_items_by_taxon(items, taxon)
+      items.select do |item|
+        item.parent_taxons.include?(taxon)
+      end
+    end
+
+    def undisplayed_items(all_items, displayed_items)
+      all_items - displayed_items
+    end
+
+    def format_for_sidebar(collection)
+      collection
+        .to_a
+        .sort_by(&:title)
+        .map(&:as_taxonomy_sidebar_link)
+    end
+  end
+end

data/lib/govuk_navigation_helpers/rummager_taxonomy_sidebar_links.rb

@@ -0,0 +1,61 @@
+module GovukNavigationHelpers
+  class RummagerTaxonomySidebarLinks
+    def initialize(content_item)
+      @content_item = content_item
+    end
+
+    def related_items
+      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, used_related_links) : []
+
+        used_related_links.merge(
+          related_content.map { |content| content[:link] }
+        )
+
+        {
+          title: parent_taxon.title,
+          url: parent_taxon.base_path,
+          description: parent_taxon.description,
+          related_content: related_content,
+        }
+      end
+    end
+
+  private
+
+    # 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(
+            similar_to: @content_item.base_path,
+            start: 0,
+            count: 3,
+            filter_taxons: [taxon.content_id],
+            filter_navigation_document_supertype: 'guidance',
+            reject_link: used_related_links.to_a,
+            fields: %w[title link],
+          )['results']
+
+          statsd.increment(:taxonomy_sidebar_searches)
+
+          results
+            .map { |result| { title: result['title'], link: result['link'], } }
+            .sort_by { |result| result[:title] }
+        rescue StandardError => e
+          GovukNavigationHelpers.configuration.error_handler.notify(e)
+          []
+        end
+      end
+    end
+
+    def statsd
+      GovukNavigationHelpers.configuration.statsd
+    end
+  end
+end

data/lib/govuk_navigation_helpers/taxonomy_sidebar.rb

@@ -9,61 +9,27 @@ module GovukNavigationHelpers
 
     def sidebar
       {
-        items: taxons
+        items: related_items,
       }
     end
 
   private
 
-    def statsd
-      GovukNavigationHelpers.configuration.statsd
+    def there_are_related_item_overrides?
+      # TODO: We should check for any external links when we have "new"
+      # external links being curated in Content Tagger
+      @content_item.curated_taxonomy_sidebar_links.any?
     end
 
-    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, used_related_links) : []
-
-        used_related_links.merge(
-          related_content.map { |content| content[:link] }
-        )
-
-        {
-          title: parent_taxon.title,
-          url: parent_taxon.base_path,
-          description: parent_taxon.description,
-          related_content: related_content,
-        }
-      end
+    def related_items
+      related_items_factory.new(@content_item).related_items
     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, used_related_links)
-      statsd.time(:taxonomy_sidebar_search_time) do
-        begin
-          results = Services.rummager.search(
-            similar_to: @content_item.base_path,
-            start: 0,
-            count: 3,
-            filter_taxons: [taxon.content_id],
-            filter_navigation_document_supertype: 'guidance',
-            reject_link: used_related_links.to_a,
-            fields: %w[title link],
-          )['results']
-
-          statsd.increment(:taxonomy_sidebar_searches)
-
-          results
-            .map { |result| { title: result['title'], link: result['link'], } }
-            .sort_by { |result| result[:title] }
-        rescue StandardError => e
-          GovukNavigationHelpers.configuration.error_handler.notify(e)
-          []
-        end
+    def related_items_factory
+      if there_are_related_item_overrides?
+        CuratedTaxonomySidebarLinks
+      else
+        RummagerTaxonomySidebarLinks
       end
     end
   end

data/lib/govuk_navigation_helpers/version.rb

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

data/spec/taxonomy_sidebar_spec.rb

@@ -186,6 +186,273 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
       end
     end
 
+    context 'when there are related link overrides' do
+      context 'belonging to the same taxon' do
+        it 'displays the related link overrides under a single taxon' do
+          content_item = content_item_tagged_to_taxon
+
+          content_item['links']['ordered_related_items_overrides'] = [
+            {
+              'title' => 'Related link override B',
+              'base_path' => '/override-b',
+              'content_id' => 'override-b',
+              'links' => {
+                'taxons' => [
+                  content_item['links']['taxons'][0],
+                ],
+              },
+            },
+          ]
+
+          expect(sidebar_for(content_item)).to eq(
+            items: [
+              {
+                title: "Taxon A",
+                url: "/taxon-a",
+                description: "The A taxon.",
+                related_content: [],
+              },
+              {
+                title: "Taxon B",
+                url: "/taxon-b",
+                description: "The B taxon.",
+                related_content: [
+                  { title: 'Related link override B', link: '/override-b' },
+                ],
+              }
+            ]
+          )
+        end
+
+        it 'displays the related link overrides under a multiple taxons' do
+          content_item = content_item_tagged_to_taxon
+
+          content_item['links']['ordered_related_items_overrides'] = [
+            {
+              'title' => 'Related link override B',
+              'base_path' => '/override-b',
+              'content_id' => 'override-b',
+              'links' => {
+                'taxons' => [
+                  content_item['links']['taxons'][0],
+                ],
+              },
+            },
+            {
+              'title' => 'Related link override A-2',
+              'base_path' => '/override-a-2',
+              'content_id' => 'override-a-2',
+              'links' => {
+                'taxons' => [
+                  content_item['links']['taxons'][1],
+                ],
+              },
+            },
+            {
+              'title' => 'Related link override A-1',
+              'base_path' => '/override-a-1',
+              'content_id' => 'override-a-1',
+              'links' => {
+                'taxons' => [
+                  content_item['links']['taxons'][1],
+                ],
+              },
+            },
+          ]
+
+          expect(sidebar_for(content_item)).to eq(
+            items: [
+              {
+                title: "Taxon A",
+                url: "/taxon-a",
+                description: "The A taxon.",
+                related_content: [
+                  { 'title': 'Related link override A-1', 'link': '/override-a-1' },
+                  { 'title': 'Related link override A-2', 'link': '/override-a-2' },
+                ],
+              },
+              {
+                title: "Taxon B",
+                url: "/taxon-b",
+                description: "The B taxon.",
+                related_content: [
+                  { 'title': 'Related link override B', 'link': '/override-b' },
+                ],
+              }
+            ]
+          )
+        end
+
+        it 'displays a related link tagged to multiple taxons under a single taxon' do
+          content_item = content_item_tagged_to_taxon
+
+          content_item['links']['ordered_related_items_overrides'] = [
+            {
+              'title' => 'Related link override',
+              'base_path' => '/override',
+              'content_id' => 'override',
+              'links' => {
+                'taxons' => [
+                  content_item['links']['taxons'][0],
+                  content_item['links']['taxons'][1],
+                ],
+              },
+            },
+          ]
+
+          expect(sidebar_for(content_item)).to eq(
+            items: [
+              {
+                title: "Taxon A",
+                url: "/taxon-a",
+                description: "The A taxon.",
+                related_content: [
+                  { 'title': 'Related link override', 'link': '/override' },
+                ],
+              },
+              {
+                title: "Taxon B",
+                url: "/taxon-b",
+                description: "The B taxon.",
+                related_content: [],
+              }
+            ]
+          )
+        end
+
+        it 'displays a related link tagged to another taxon under "Elsewhere"' do
+          content_item = content_item_tagged_to_taxon
+
+          content_item['links']['ordered_related_items_overrides'] = [
+            {
+              'title' => 'Related link override',
+              'base_path' => '/override',
+              'content_id' => 'override',
+              'links' => {
+                'taxons' => [
+                  {
+                    'title' => 'Some other taxon',
+                    'content_id' => 'some-other-taxon',
+                    'base_path' => '/some-other-taxon',
+                  }
+                ],
+              },
+            },
+          ]
+
+          expect(sidebar_for(content_item)).to eq(
+            items: [
+              {
+                title: "Taxon A",
+                url: "/taxon-a",
+                description: "The A taxon.",
+                related_content: [],
+              },
+              {
+                title: "Taxon B",
+                url: "/taxon-b",
+                description: "The B taxon.",
+                related_content: [],
+              },
+              {
+                title: "Elsewhere on GOV.UK",
+                related_content: [
+                  { title: 'Related link override', link: '/override' }
+                ],
+              },
+            ]
+          )
+        end
+
+        it 'displays a related link not tagged to any taxons under "Elsewhere"' do
+          content_item = content_item_tagged_to_taxon
+
+          content_item['links']['ordered_related_items_overrides'] = [
+            {
+              'title' => 'Related link override',
+              'base_path' => '/override',
+              'content_id' => 'override',
+              'links' => {},
+            },
+          ]
+
+          expect(sidebar_for(content_item)).to eq(
+            items: [
+              {
+                title: "Taxon A",
+                url: "/taxon-a",
+                description: "The A taxon.",
+                related_content: [],
+              },
+              {
+                title: "Taxon B",
+                url: "/taxon-b",
+                description: "The B taxon.",
+                related_content: [],
+              },
+              {
+                title: "Elsewhere on GOV.UK",
+                related_content: [
+                  { title: 'Related link override', link: '/override' }
+                ],
+              },
+            ]
+          )
+        end
+
+        it 'displays an external related link under "Elsewhere"' do
+          content_item = content_item_tagged_to_taxon
+
+          content_item['links']['ordered_related_items_overrides'] = [
+            {
+              'title' => 'Related link override',
+              'base_path' => '/override',
+              'content_id' => 'override',
+              'links' => {},
+            },
+          ]
+
+          content_item['details'] = {
+            'external_related_links' => [
+              {
+                'title' => 'External related link',
+                'url' => 'http://example.com',
+              },
+            ]
+          }
+
+          expect(sidebar_for(content_item)).to eq(
+            items: [
+              {
+                title: "Taxon A",
+                url: "/taxon-a",
+                description: "The A taxon.",
+                related_content: [],
+              },
+              {
+                title: "Taxon B",
+                url: "/taxon-b",
+                description: "The B taxon.",
+                related_content: [],
+              },
+              {
+                title: "Elsewhere on GOV.UK",
+                related_content: [
+                  { title: 'Related link override', link: '/override' }
+                ],
+              },
+              {
+                title: "Elsewhere on the web",
+                related_content: [
+                  { title: 'External related link', link: 'http://example.com' }
+                ],
+              },
+            ]
+          )
+        end
+      end
+    end
+
     context 'when Rummager raises an exception' do
       error_handler = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
@@ -173,8 +173,10 @@ files:
 - lib/govuk_navigation_helpers/breadcrumbs.rb
 - lib/govuk_navigation_helpers/configuration.rb
 - lib/govuk_navigation_helpers/content_item.rb
+- 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/rummager_taxonomy_sidebar_links.rb
 - lib/govuk_navigation_helpers/services.rb
 - lib/govuk_navigation_helpers/taxon_breadcrumbs.rb
 - lib/govuk_navigation_helpers/taxonomy_sidebar.rb