govuk_navigation_helpers 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec1764a33f8094c760cd5a83e47ae8a51277b119
-  data.tar.gz: f28cae4e16260780344f7f77c5d0043f569d628e
+  metadata.gz: 3017d40e8156702b7e7af8aa4872cf2e34257772
+  data.tar.gz: 1ecf2847c2c9b062423c3edd50ab2eec59483d8e
 SHA512:
-  metadata.gz: 91bade4008ffcbbaf9c51dbd2a86a93ab474b0b5fc8c9038113016e7ffc6d9de9b59e227629d000e1ded82944779534f58c3aefe72b6acd7c746fda3ce00e4d6
-  data.tar.gz: 865b85c47eeed422b1960e5874b391f8f298d8a01a686ddbb8699fec6ab35246ecfd89750a9534f9f227a13e9661ca6c4143d0483946406fd8093de665724592
+  metadata.gz: faad2926bd20b3c53af19202469eecc0af10088292226e2bfb9dffc9b9620fe1fb0b36f6c9fcfcef93e6b9aa3c0f3885de823e8cc3abb3e9afcc09782275497f
+  data.tar.gz: cdf11771a20dc7711c69414bd4a88cf3a8a736ffa16fcbb3c3e6196fd13fde836591569c3432e281570f747f570a90c31d2aace8fe648f4389ebbf3fedf50a90

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 7.1.0
+
+* Add helper for rendering related navigation sidebar on content pages with universal layout
+
 ## 7.0.0
 
 * Root taxons are now whitelisted, so that only taxons descendant from one of

data/lib/govuk_navigation_helpers.rb

@@ -3,6 +3,7 @@ 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/related_navigation_sidebar"
 require "govuk_navigation_helpers/rummager_taxonomy_sidebar_links"
 require "govuk_navigation_helpers/curated_taxonomy_sidebar_links"
 
@@ -45,6 +46,15 @@ module GovukNavigationHelpers
       RelatedItems.new(content_item).related_items
     end
 
+    # Generate a payload containing related navigation sidebar data. Intended for use with
+    # the related navigation sidebar component
+    #
+    # @return [Hash] Payload for the GOV.UK related navigation sidebar component
+    # @see https://government-frontend.herokuapp.com/component-guide/related-navigation-sidebar
+    def related_navigation_sidebar
+      RelatedNavigationSidebar.new(content_item).related_navigation_sidebar
+    end
+
   private
 
     attr_reader :content_item

data/lib/govuk_navigation_helpers/content_item.rb

@@ -77,6 +77,34 @@ module GovukNavigationHelpers
       end
     end
 
+    def related_ordered_items
+      content_store_response.dig("links", "ordered_related_items").to_a
+    end
+
+    def quick_links
+      content_store_response.dig("details", "quick_links").to_a
+    end
+
+    def related_collections
+      filter_link_type(content_store_response.dig("links", "document_collections").to_a, "document_collection")
+    end
+
+    def related_other_contacts
+      filter_link_type(content_store_response.dig("links", "related").to_a, "contact")
+    end
+
+    def related_organisations
+      filter_link_type(content_store_response.dig("links", "organisations").to_a, "organisation")
+    end
+
+    def related_policies
+      filter_link_type(content_store_response.dig("links", "related_policies").to_a, "policy")
+    end
+
+    def related_topics
+      filter_link_type(content_store_response.dig("links", "topics").to_a, "topic")
+    end
+
     def external_links
       content_store_response.dig("details", "external_related_links").to_a
     end
@@ -123,5 +151,11 @@ module GovukNavigationHelpers
         get_root_taxon(parent_taxons.first)
       end
     end
+
+    def filter_link_type(links, type)
+      links.select do |link|
+        link["document_type"] == type
+      end
+    end
   end
 end

data/lib/govuk_navigation_helpers/related_navigation_sidebar.rb

@@ -0,0 +1,70 @@
+require 'govuk_navigation_helpers/services'
+require 'govuk_navigation_helpers/configuration'
+
+module GovukNavigationHelpers
+  class RelatedNavigationSidebar
+    def initialize(content_item)
+      @content_item = ContentItem.new content_item
+    end
+
+    def related_navigation_sidebar
+      {
+        related_items: related_items,
+        collections: related_collections,
+        topics: related_topics,
+        policies: related_policies,
+        publishers: related_organisations,
+        other: [related_external_links, related_contacts]
+      }
+    end
+
+  private
+
+    def build_links_for_sidebar(collection, path_key = "base_path", additional_attr = {})
+      collection.map do |link|
+        {
+          text: link["title"],
+          path: link[path_key]
+        }.merge(additional_attr)
+      end
+    end
+
+    def related_items
+      quick_links = build_links_for_sidebar(@content_item.quick_links, "url")
+
+      quick_links.any? ? quick_links : build_links_for_sidebar(@content_item.related_ordered_items)
+    end
+
+    def related_organisations
+      build_links_for_sidebar(@content_item.related_organisations)
+    end
+
+    def related_collections
+      build_links_for_sidebar(@content_item.related_collections)
+    end
+
+    def related_policies
+      build_links_for_sidebar(@content_item.related_policies)
+    end
+
+    def related_topics
+      build_links_for_sidebar(@content_item.related_topics)
+    end
+
+    def related_contacts
+      return [] unless @content_item.related_other_contacts.any?
+      [
+        title: "Other contacts",
+        links: build_links_for_sidebar(@content_item.related_other_contacts).map
+      ]
+    end
+
+    def related_external_links
+      return [] unless @content_item.external_links.any?
+      [
+        title: "Elsewhere on the web",
+        links: build_links_for_sidebar(@content_item.external_links, "url", rel: 'external')
+      ]
+    end
+  end
+end

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "7.0.0".freeze
+  VERSION = "7.1.0".freeze
 end

data/spec/navigation_sidebar_spec.rb

@@ -0,0 +1,139 @@
+require "spec_helper"
+
+RSpec.describe GovukNavigationHelpers::RelatedNavigationSidebar do
+  def payload_for(schema, content_item)
+    generator = GovukSchemas::RandomExample.for_schema(schema, schema_type: "frontend")
+    fully_valid_content_item = generator.merge_and_validate(content_item)
+    GovukNavigationHelpers::NavigationHelper.new(fully_valid_content_item).related_navigation_sidebar
+  end
+
+  describe "#related-navigation-sidebar" do
+    it "can handle randomly generated content" do
+      generator = GovukSchemas::RandomExample.for_schema("placeholder", schema_type: "frontend")
+
+      expect { payload_for("placeholder", generator.payload) }.to_not raise_error
+    end
+
+    it "returns empty arrays if there are no related navigation sidebar links" do
+      nothing = payload_for("placeholder",
+        "details" => {
+          "external_related_links" => []
+        },
+        "links" => {
+        }
+      )
+
+      expected = {
+        related_items: [],
+        collections: [],
+        topics: [],
+        policies: [],
+        publishers: [],
+        other: [[], []]
+      }
+
+      expect(nothing).to eql(expected)
+    end
+
+    it "extracts and returns the appropriate related links" do
+      payload = payload_for("speech",
+        "details" => {
+          "body" => "body",
+          "government" => {
+            "title" => "government",
+            "slug" => "government",
+            "current" => true
+            },
+          "political" => true,
+          "delivered_on" => "2017-09-22T14:30:00+01:00"
+        },
+        "links" => {
+          "ordered_related_items" => [
+            {
+              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+              "locale" => "en",
+              "base_path" => "/related-item",
+              "title" => "related item"
+            }
+          ],
+          "document_collections" => [
+            {
+              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+              "locale" => "en",
+              "base_path" => "/related-collection",
+              "title" => "related collection",
+              "document_type" => "document_collection"
+            }
+          ],
+          "topics" => [
+            {
+              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+              "locale" => "en",
+              "base_path" => "/related-topic",
+              "title" => "related topic",
+              "document_type" => "topic"
+            }
+          ],
+          "organisations" => [
+            {
+              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+              "locale" => "en",
+              "base_path" => "/related-organisation",
+              "title" => "related organisation",
+              "document_type" => "organisation"
+            }
+          ],
+          "related_policies" => [
+            {
+              "content_id" => "32c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+              "locale" => "en",
+              "base_path" => "/related-policy",
+              "title" => "related policy",
+              "document_type" => "policy"
+            }
+          ]
+        }
+      )
+
+      expected = {
+        related_items: [{ path: "/related-item", text: "related item" }],
+        collections: [{ path: "/related-collection", text: "related collection" }],
+        topics: [{ path: "/related-topic", text: "related topic" }],
+        policies: [{ path: "/related-policy", text: "related policy" }],
+        publishers: [{ path: "/related-organisation", text: "related organisation" }],
+        other: [[], []]
+      }
+
+      expect(payload).to eql(expected)
+    end
+
+    it "returns an Elsewhere on the web section for external related links" do
+      payload = payload_for("placeholder",
+        "details" => {
+          "external_related_links" => [
+            {
+              "title" => "external-link",
+              "url" => "https://external"
+            }
+          ]
+        },
+      )
+
+      expected = [
+        [
+          {
+            title: "Elsewhere on the web",
+            links: [{
+                text: "external-link",
+                path: "https://external",
+                rel: "external"
+              }]
+          }
+        ],
+        []
+      ]
+
+      expect(payload[:other]).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: 7.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2017-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
@@ -176,6 +176,7 @@ files:
 - 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/related_navigation_sidebar.rb
 - lib/govuk_navigation_helpers/rummager_taxonomy_sidebar_links.rb
 - lib/govuk_navigation_helpers/services.rb
 - lib/govuk_navigation_helpers/taxon_breadcrumbs.rb
@@ -183,6 +184,7 @@ files:
 - lib/govuk_navigation_helpers/version.rb
 - spec/breadcrumbs_spec.rb
 - spec/content_item_spec.rb
+- spec/navigation_sidebar_spec.rb
 - spec/related_items_spec.rb
 - spec/spec_helper.rb
 - spec/taxon_breadcrumbs_spec.rb
@@ -214,6 +216,7 @@ summary: Gem to transform items from the content-store into payloads for GOV.UK
 test_files:
 - spec/breadcrumbs_spec.rb
 - spec/content_item_spec.rb
+- spec/navigation_sidebar_spec.rb
 - spec/related_items_spec.rb
 - spec/spec_helper.rb
 - spec/taxon_breadcrumbs_spec.rb