govuk_navigation_helpers 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d12b3bb1dd94ca92627a1eab3cf9fcf1fa393db0
-  data.tar.gz: 5137482b6cc5dc6bc5406541d8ba7605e506bd44
+  metadata.gz: 19f91260ea75a1db921c4b82de4aff1cceb0ed68
+  data.tar.gz: 28253a57bee243f566f2588bf70325a44134f76b
 SHA512:
-  metadata.gz: 398630f553c56a3a4a037051b8894adc827f88f5de217318f425c35b8bd28c624fb69ac956ccb176b2e3b4532922442dba2bcce1adea8430f9599c27b85fefc4
-  data.tar.gz: 0a076531e1979a9bbaef6144d0c4e29bec55117a4f76076e9e74c8a331bf7cc804accf7fa68662edb6e24bdce64d63bfa66b814c54fa041bec1d690f04efce68
+  metadata.gz: c2406adc6eb2b21a485c910f05fcb9c531a3b82b96c631bfea410e377e2df028c164ac5bf4b9ce6ac00744a540eee47aae9589e98d6edb25d1486dda5d97dea8
+  data.tar.gz: 00664e1d2ecce5b360899b158a1645d8c507519b2a1b80c2d5513ad4e81eefadbc4f91d64f856acc43655310e49888e18da5d39e5037f818fd704848e0a1e3bd

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.2.0
+
+* Alphabetically sort taxons and related links in the taxonomy sidebar.
+
 ## 3.1.1
 
 * Remove `notice` from list of guidance document types.

data/lib/govuk_navigation_helpers/content_item.rb

@@ -26,12 +26,12 @@ module GovukNavigationHelpers
     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) } if taxons.any?
+      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) }
+      parent_taxons.map { |taxon| ContentItem.new(taxon) }.sort_by(&:title)
     end
 
     def mainstream_browse_pages

data/lib/govuk_navigation_helpers/taxonomy_sidebar.rb

@@ -49,12 +49,9 @@ module GovukNavigationHelpers
 
           statsd.increment(:taxonomy_sidebar_searches)
 
-          results.map do |result|
-            {
-              title: result['title'],
-              link: result['link'],
-            }
-          end
+          results
+            .map { |result| { title: result['title'], link: result['link'], } }
+            .sort_by { |result| result[:title] }
         rescue StandardError => e
           GovukNavigationHelpers.configuration.error_handler.notify(e)
           []

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "3.1.1".freeze
+  VERSION = "3.2.0".freeze
 end

data/spec/taxonomy_sidebar_spec.rb

@@ -6,19 +6,7 @@ include GdsApi::TestHelpers::Rummager
 
 RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
   describe '#sidebar' do
-    before(:each) do
-      stub_any_rummager_search
-        .to_return(
-          body: {
-            'results': [
-              {
-                'title': 'Result Content',
-                'link': '/result-content',
-              },
-            ],
-          }.to_json
-        )
-    end
+    before { stub_any_rummager_search_to_return_no_results }
 
     it 'can handle any valid content item' do
       generator = GovukSchemas::RandomExample.for_schema(
@@ -39,8 +27,21 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
       end
     end
 
-    context 'given a content item tagged to taxons' do
-      it 'returns a sidebar hash containing a list of parent taxons and related content' do
+    context 'given a content item tagged to taxons and with related items' do
+      before do
+        stub_any_rummager_search
+          .to_return(
+            body: {
+              'results': [
+                { 'title': 'Related item C', 'link': '/related-item-c', },
+                { 'title': 'Related item B', 'link': '/related-item-b', },
+                { 'title': 'Related item A', 'link': '/related-item-a', },
+              ],
+            }.to_json
+          )
+      end
+
+      it 'returns a sidebar hash containing a sorted list of parent taxons and related content' do
         expect(GovukNavigationHelpers.configuration.statsd).to receive(
           :increment
         ).with(
@@ -52,25 +53,23 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
         expect(sidebar_for(content_item)).to eq(
           items: [
             {
-              title: "Taxon 1",
-              url: "/taxon-1",
-              description: "The 1st taxon.",
+              title: "Taxon A",
+              url: "/taxon-a",
+              description: "The A taxon.",
               related_content: [
-                {
-                  title: 'Result Content',
-                  link: '/result-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: "Taxon 2",
-              url: "/taxon-2",
-              description: "The 2nd taxon.",
+              title: "Taxon B",
+              url: "/taxon-b",
+              description: "The B taxon.",
               related_content: [
-                {
-                  title: 'Result Content',
-                  link: '/result-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', },
               ],
             },
           ]
@@ -122,16 +121,16 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
       "links" => {
         "taxons" => [
           {
-            "title" => "Taxon 1",
-            "base_path" => "/taxon-1",
-            "content_id" => "taxon1",
-            "description" => "The 1st taxon.",
+            "title" => "Taxon B",
+            "base_path" => "/taxon-b",
+            "content_id" => "taxon-b",
+            "description" => "The B taxon.",
           },
           {
-            "title" => "Taxon 2",
-            "base_path" => "/taxon-2",
-            "content_id" => "taxon2",
-            "description" => "The 2nd taxon.",
+            "title" => "Taxon A",
+            "base_path" => "/taxon-a",
+            "content_id" => "taxon-a",
+            "description" => "The A taxon.",
           },
         ],
       },

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - GOV.UK Dev