govuk_navigation_helpers 8.2.0 → 8.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00d6196b7af9cb3f946c7619095daeb9926207c1
-  data.tar.gz: 594c10714eaf2c263878be7371f20a31a47b83a0
+  metadata.gz: 0aa11979bbf940f76afd57f51b64ae5a2d9764bf
+  data.tar.gz: 7be108482916def775713be20fee96d836a38a33
 SHA512:
-  metadata.gz: 2af437186445b73d36b31b6abe2528a9c0b70345534fb06679215334625d786a89b8cb8f324abc572753585da52cd69fe7a86ffa2ff106986c6b14bd11b74be7
-  data.tar.gz: ee8020c7eb9e6b53997df336fb8093e76895881408b377ef85ce7df9aac474b2b9592901483b3f10ec02f8d23644d7683804103c9c8569ba28585437ff301df8
+  metadata.gz: c36483f76f1239ffd68bf146af95e71df9f678713537b8e1e3cbf5a07a880ecdf79f4bb40b5e74c3569d1daab8d4a0d0f598daee8e115049ec3fffc239a11d56
+  data.tar.gz: 6ada73a40b0a8d621f2fce2f8f46fff09c113e42b920c95de0f8a456ab8f069ffa35e6d35b88a31144c54ab04519aa2eff187ee74f36feab751d37cba45b0600

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 8.2.1
+* Update related navigation sidebar helper to deduplicate mainstream topics with the same title as whithall topics.
+  Mainstream topics are preferred in the case of duplicates.
+* Update Yard dependency to 0.9.12
+
 ## 8.2.0
 * Update related navigation sidebar helper to return mainstream topics alongside whitehall topics
 * Update content in the /end-a-civil-partnership, /get-a-divorce tasklists

data/govuk_navigation_helpers.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "gem_publisher", "~> 1.5.0"
   spec.add_development_dependency "govuk-lint", "~> 1.2.1"
   spec.add_development_dependency "pry-byebug", "~> 3.4"
-  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "yard", "~> 0.9.12"
   spec.add_development_dependency "govuk_schemas", "~> 1.0"
   spec.add_development_dependency "webmock", "~> 2.3"
 

data/lib/govuk_navigation_helpers/related_navigation_sidebar.rb

@@ -72,7 +72,7 @@ module GovukNavigationHelpers
     def related_topics
       topics = build_links_for_sidebar(@content_item.related_topics)
       topics << related_mainstream_topic << related_mainstream_parent_topic
-      topics.compact
+      deduplicate_topics_by_title(topics.compact)
     end
 
     def related_topical_events
@@ -105,6 +105,22 @@ module GovukNavigationHelpers
       { 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?

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "8.2.0".freeze
+  VERSION = "8.2.1".freeze
 end

data/spec/related_navigation_sidebar_spec.rb

@@ -256,5 +256,57 @@ RSpec.describe GovukNavigationHelpers::RelatedNavigationSidebar do
 
       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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 8.2.0
+  version: 8.2.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-04 00:00:00.000000000 Z
+date: 2018-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.12
 - !ruby/object:Gem::Dependency
   name: govuk_schemas
   requirement: !ruby/object:Gem::Requirement