govuk_navigation_helpers 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae03499e445926565f940d61ac2ca8a9e6566f40
-  data.tar.gz: e4b3be57785db7c30e2846cb9b2d410d1b3f4309
+  metadata.gz: 5fba2dad8d4cf628e28fa8f21861c424c87ab444
+  data.tar.gz: f9c522d2424160b6f34fc675d107f9b5f7aec215
 SHA512:
-  metadata.gz: 08da4b0086ef29b400da2c05c5b87bbc5219656cefa84fbdf139beefc73e8e150a95ac81c7d4ee08aa412ead50289bff2df652149aa3d8cacb1091d61ce0d5a3
-  data.tar.gz: 3dd946e21c66b799ad1119e2a97a8db3d1cefb3d022e7fc04e6b9542d7d05a409f44d2d429815eaeaab70775738ea8e322fa09a713cda3c927aed34be8916a85
+  metadata.gz: dbdcff0ab5f3f3cf62c24a449d7ca0a6e413edf5762338d0550defeedcab378acbc61f1d851488d3785dd6080dd0d57c5b818972e1bd2c61b8ecf133dd464cf2
+  data.tar.gz: 9d162ed86cdc9a002c01b37140f1ac1da95bb8dce64cbf547be960c4fd616cd166710426eb3ec8f424715b0b66e6a520ca6458beb28bcb210165dd0029a56110

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.1.0
+
+* Add helper to render taxon breadcrumbs
+
 ## 2.0.0
 
 * Functionality to generate data for the related items component

data/lib/govuk_navigation_helpers/breadcrumbs.rb

@@ -1,21 +1,12 @@
 module GovukNavigationHelpers
   class Breadcrumbs
     def initialize(content_item)
-      @content_item = content_item
+      @content_item = ContentItem.new(content_item)
     end
 
     def breadcrumbs
-      direct_parent = content_item.dig("links", "parent", 0)
-
-      ordered_parents = []
-
-      while direct_parent
-        ordered_parents << {
-          title: direct_parent["title"],
-          url: direct_parent["base_path"],
-        }
-
-        direct_parent = direct_parent.dig("links", "parent", 0)
+      ordered_parents = all_parents.map do |parent|
+        { title: parent.title, url: parent.base_path }
       end
 
       ordered_parents << { title: "Home", url: "/" }
@@ -28,5 +19,18 @@ module GovukNavigationHelpers
   private
 
     attr_reader :content_item
+
+    def all_parents
+      parents = []
+
+      direct_parent = content_item.parent
+      while direct_parent
+        parents << direct_parent
+
+        direct_parent = direct_parent.parent
+      end
+
+      parents
+    end
   end
 end

data/lib/govuk_navigation_helpers/content_item.rb

@@ -16,6 +16,13 @@ module GovukNavigationHelpers
       ContentItem.new(parent_item)
     end
 
+    def parent_taxon
+      # TODO: Determine what to do when there are multiple parents. For now just display the first
+      parent_taxon = content_store_response.dig("links", "parent_taxons", 0)
+      return unless parent_taxon
+      ContentItem.new(parent_taxon)
+    end
+
     def mainstream_browse_pages
       content_store_response.dig("links", "mainstream_browse_pages").to_a.map do |link|
         ContentItem.new(link)

data/lib/govuk_navigation_helpers/taxon_breadcrumbs.rb

@@ -0,0 +1,35 @@
+module GovukNavigationHelpers
+  class TaxonBreadcrumbs
+    def initialize(content_item)
+      @content_item = ContentItem.new(content_item)
+    end
+
+    def breadcrumbs
+      ordered_parents = all_parents.map do |parent|
+        { title: parent.title, url: parent.base_path }
+      end
+
+      ordered_parents << { title: "Home", url: "/" }
+
+      {
+          breadcrumbs: ordered_parents.reverse
+      }
+    end
+
+  private
+
+    attr_reader :content_item
+
+    def all_parents
+      parents = []
+
+      direct_parent = content_item.parent_taxon
+      while direct_parent
+        parents << direct_parent
+        direct_parent = direct_parent.parent_taxon
+      end
+
+      parents
+    end
+  end
+end

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "2.0.0".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/govuk_navigation_helpers.rb

@@ -1,6 +1,7 @@
 require "govuk_navigation_helpers/version"
 require "govuk_navigation_helpers/breadcrumbs"
 require "govuk_navigation_helpers/related_items"
+require "govuk_navigation_helpers/taxon_breadcrumbs"
 
 module GovukNavigationHelpers
   class NavigationHelper
@@ -8,7 +9,7 @@ module GovukNavigationHelpers
       @content_item = content_item
     end
 
-    # Generate a breacrumb trail
+    # Generate a breadcrumb trail
     #
     # @return [Hash] Payload for the GOV.UK breadcrumbs component
     # @see http://govuk-component-guide.herokuapp.com/components/breadcrumbs
@@ -16,6 +17,14 @@ module GovukNavigationHelpers
       Breadcrumbs.new(content_item).breadcrumbs
     end
 
+    # Generate a breadcrumb trail for a taxon, using the taxon_parent link field
+    #
+    # @return [Hash] Payload for the GOV.UK breadcrumbs component
+    # @see http://govuk-component-guide.herokuapp.com/components/breadcrumbs
+    def taxon_breadcrumbs
+      TaxonBreadcrumbs.new(content_item).breadcrumbs
+    end
+
     # Generate a related items payload
     #
     # @return [Hash] Payload for the GOV.UK Component

data/spec/taxon_breadcrumbs_spec.rb

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+RSpec.describe GovukNavigationHelpers::TaxonBreadcrumbs do
+  describe "Taxon breadcrumbs" do
+    it "can handle any valid content item" do
+      generator = GovukSchemas::RandomExample.for_schema("taxon", schema_type: "frontend")
+
+      expect { GovukNavigationHelpers::TaxonBreadcrumbs.new(generator.payload).breadcrumbs }.to_not raise_error
+    end
+
+    it "returns the root when parent is not specified" do
+      content_item = { "links" => {} }
+      breadcrumbs = breadcrumbs_for(content_item)
+
+      expect(breadcrumbs).to eq(
+        breadcrumbs: [
+          { title: "Home", url: "/" },
+        ]
+      )
+    end
+
+    it "returns the root when parent is empty" do
+      content_item = content_item_with_parents([])
+      breadcrumbs = breadcrumbs_for(content_item)
+
+      expect(breadcrumbs).to eq(
+        breadcrumbs: [
+          { title: "Home", url: "/" },
+        ]
+      )
+    end
+
+    it "places parent under the root when there is a parent" do
+      parent = {
+          "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+          "locale" => "en",
+          "title" => "A-parent",
+          "base_path" => "/a-parent",
+      }
+
+      content_item = content_item_with_parents([parent])
+      breadcrumbs = breadcrumbs_for(content_item)
+
+      expect(breadcrumbs).to eq(
+        breadcrumbs: [
+          { title: "Home", url: "/" },
+          { title: "A-parent", url: "/a-parent" }
+        ]
+      )
+    end
+
+    it "includes grandparent when available" do
+      grandparent = {
+          "title" => "Another-parent",
+          "base_path" => "/another-parent",
+          "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+          "locale" => "en",
+      }
+
+      parent = {
+          "content_id" => "30c1b93d-2553-47c9-bc3c-fc5b513ecc32",
+          "locale" => "en",
+          "title" => "A-parent",
+          "base_path" => "/a-parent",
+          "links" => {
+              "parent_taxons" => [grandparent]
+          }
+      }
+
+      content_item = content_item_with_parents([parent])
+      breadcrumbs = breadcrumbs_for(content_item)
+
+      expect(breadcrumbs).to eq(
+        breadcrumbs: [
+          { title: "Home", url: "/" },
+          { title: "Another-parent", url: "/another-parent" },
+          { title: "A-parent", url: "/a-parent" }
+        ]
+      )
+    end
+  end
+
+  def breadcrumbs_for(content_item)
+    generator = GovukSchemas::RandomExample.for_schema("taxon", schema_type: "frontend")
+    fully_valid_content_item = generator.merge_and_validate(content_item)
+
+    # Use the main class instead of GovukNavigationHelpers::Breadcrumbs, so that
+    # we're testing both at the same time.
+    GovukNavigationHelpers::NavigationHelper.new(fully_valid_content_item).taxon_breadcrumbs
+  end
+
+  def content_item_with_parents(parents)
+    {
+        "links" => { "parent_taxons" => parents }
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-25 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -145,10 +145,12 @@ files:
 - lib/govuk_navigation_helpers/content_item.rb
 - lib/govuk_navigation_helpers/grouped_related_links.rb
 - lib/govuk_navigation_helpers/related_items.rb
+- lib/govuk_navigation_helpers/taxon_breadcrumbs.rb
 - lib/govuk_navigation_helpers/version.rb
 - spec/breadcrumbs_spec.rb
 - spec/related_items_spec.rb
 - spec/spec_helper.rb
+- spec/taxon_breadcrumbs_spec.rb
 homepage: https://github.com/alphagov/govuk_navigation_helpers
 licenses:
 - MIT
@@ -177,3 +179,4 @@ test_files:
 - spec/breadcrumbs_spec.rb
 - spec/related_items_spec.rb
 - spec/spec_helper.rb
+- spec/taxon_breadcrumbs_spec.rb