govuk_navigation_helpers 2.4.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96733a7614897c0c7289e94d1b07b01854704614
-  data.tar.gz: 7f5b667aa01be69cc1d9324ebabb6db151090c71
+  metadata.gz: f0da568d8966938138a71bd542f1c3dbd4bd5435
+  data.tar.gz: dede7b2b009fbee5525533674a15331885632529
 SHA512:
-  metadata.gz: e74bf5f3785e7017722fc3e540626de37c983e2124589a9d595539f3b50bf78f18a80ee17a20c6c52411db26049d1d40fd02b343f5be6530d3708a9c655358a7
-  data.tar.gz: 9e55565a8216e3bd4a9f95c52e15aeda80e1ed2d73d82dc1d3e566937c3aa393f02958d574532dd5f7ddfc1412186784c724f668664471e0ca73a77ad984e027
+  metadata.gz: e2224955a506f0d2d66ba807c4321ed8a866b2160a5cc769785dde0b95fe57efe1168fe5b96d43fa8285d94d0f48d28f51ec2729f5b970da1722a933dc08823a
+  data.tar.gz: 959ea2dc26fb29cdf9cd99c509091af5abeb776d0a0cbe27d2b7798e629b74a8bd26d1f081eb8fa6750564bf78b8f1cb71632d71a0c8eb3d687347570af10b5f

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## 3.0.0
+
+* **BREAKING CHANGE**: remove unnecessary nesting from taxonomy sidebar helper.
+  The schema has changed from:
+  
+  ```json
+  {
+    "sections": [
+      {
+        "title": "String",
+        "items": []
+      }
+    ]
+  }
+  ```
+  
+  to:
+  
+  ```json
+  {
+    "items": []
+  }
+  ```
+
+* The taxonomy sidebar helper returns an object whose keys are all symbols, as
+  required by Govuk Components
+
 ## 2.4.1
 
 * Add related content to the taxonomy sidebar helper

data/lib/govuk_navigation_helpers/taxonomy_sidebar.rb

@@ -10,7 +10,7 @@ module GovukNavigationHelpers
 
     def sidebar
       {
-        sections: taxons.any? ? [{ title: "More about #{@content_item.title}", items: taxons }] : []
+        items: taxons
       }
     end
 
@@ -33,7 +33,7 @@ module GovukNavigationHelpers
     # the content store
     def content_related_to(taxon)
       begin
-        Services.rummager.search(
+        results = Services.rummager.search(
           similar_to: @content_item.base_path,
           start: 0,
           count: 5,
@@ -41,6 +41,13 @@ module GovukNavigationHelpers
           filter_content_store_document_type: Guidance::DOCUMENT_TYPES,
           fields: %w[title link],
         )['results']
+
+        results.map do |result|
+          {
+            title: result['title'],
+            link: result['link'],
+          }
+        end
       rescue StandardError => e
         GovukNavigationHelpers.configuration.error_handler.notify(e)
         []

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "2.4.1".freeze
+  VERSION = "3.0.0".freeze
 end

data/spec/taxonomy_sidebar_spec.rb

@@ -34,7 +34,7 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
         content_item = { "links" => {} }
 
         expect(sidebar_for(content_item)).to eq(
-          sections: []
+          items: []
         )
       end
     end
@@ -44,34 +44,29 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
         content_item = content_item_tagged_to_taxon
 
         expect(sidebar_for(content_item)).to eq(
-          sections: [
+          items: [
             {
-              title: "More about A piece of content",
-              items: [
+              title: "Taxon 1",
+              url: "/taxon-1",
+              description: "The 1st taxon.",
+              related_content: [
                 {
-                  title: "Taxon 1",
-                  url: "/taxon-1",
-                  description: "The 1st taxon.",
-                  related_content: [
-                    {
-                      "title" => 'Result Content',
-                      "link" => '/result-content',
-                    },
-                  ],
+                  title: 'Result Content',
+                  link: '/result-content',
                 },
+              ],
+            },
+            {
+              title: "Taxon 2",
+              url: "/taxon-2",
+              description: "The 2nd taxon.",
+              related_content: [
                 {
-                  title: "Taxon 2",
-                  url: "/taxon-2",
-                  description: "The 2nd taxon.",
-                  related_content: [
-                    {
-                      "title" => 'Result Content',
-                      "link" => '/result-content',
-                    },
-                  ],
+                  title: 'Result Content',
+                  link: '/result-content',
                 },
               ],
-            }
+            },
           ]
         )
       end

metadata

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