govuk_navigation_helpers 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 783242d5e27cba520c2b62463bc8b98f3db7caa3
-  data.tar.gz: c9600fd1a77522e033c6f42c8e84e0c82909e782
+  metadata.gz: 925f41952a73c6f57ba09696d8b3eb9f3cd4f460
+  data.tar.gz: c60be579e0918ac56ab9720e07fc7d9957113d0a
 SHA512:
-  metadata.gz: 8322866da307b50a8621068bee8e5571db753405bcdb7087bb95e23975d67f4dc33a4fe3816c3b1bf83de7b8e9d21e943ba6ebbfe973ff341ebb62983c825f9b
-  data.tar.gz: f6db60711406ccd72a5c2fd7046a4bbdc40adf5709f0a1c62f83ad733c5c6bf1a4a4fa628abc4440182c8507c6885212bb086e5c906f9647406041825b6db3e3
+  metadata.gz: 793282df094eb26e965a5ae97215a2279b7f72bf6afec86cbca844c4fc216231ce7c082800ee3526cbeacd9dd12191697f55ff9aa7b04e1e3d0d699bfc5a97fe
+  data.tar.gz: ba673437955eea0d5ceda36cfe1b53522e278adfa14ca79b9a4228c4d1a89c15d06477befa4ac1f56f6527344edd6081e7ced480d51397a88b249dabf22095de

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.4.0
+
+* Add helper for rendering sidebar on taxonomy content pages.
+
 ## 2.3.1
 
 * Convert all ContentItem initialization objects to a hash

data/Jenkinsfile

@@ -1,5 +1,7 @@
 #!/usr/bin/env groovy
 
+REPOSITORY = 'govuk_navigation_helpers'
+
 node {
   def govuk = load '/var/lib/jenkins/groovy_scripts/govuk_jenkinslib.groovy'
 
@@ -33,8 +35,35 @@ node {
 
     if(env.BRANCH_NAME == "master") {
       stage('Publish Gem') {
-        sshagent(['govuk-ci-ssh-key']) {
-          govuk.runRakeTask("publish_gem --trace")
+        def version = sh(
+          script: /ruby -e "puts eval(File.read('${REPOSITORY}.gemspec'), TOPLEVEL_BINDING).version.to_s"/,
+          returnStdout: true
+        ).trim()
+
+        def taggedReleaseExists = sh(
+          script: "git tag | grep v${version}",
+          returnStatus: true
+        ) == 0
+
+        if (taggedReleaseExists) {
+          echo "Version ${version} has already been tagged on Github"
+        } else {
+          echo('Pushing tag')
+          govuk.pushTag(REPOSITORY, env.BRANCH_NAME, 'v' + version)
+        }
+
+        def escapedVersion = version.replaceAll(/\./, /\\\\./)
+        def versionAlreadyPublished = sh(
+          script: /gem list ^${REPOSITORY}\$ --remote --all --quiet | grep [^0-9\\.]${escapedVersion}[^0-9\\.]/,
+          returnStatus: true
+        ) == 0
+
+        if (versionAlreadyPublished) {
+          echo "Version ${version} has already been published to rubygems.org"
+        } else {
+          echo('Publishing gem')
+          sh("gem build ${REPOSITORY}.gemspec")
+          sh("gem push '${REPOSITORY}-${version}.gem'")
         }
       }
     }

data/lib/govuk_navigation_helpers.rb

@@ -2,6 +2,7 @@ require "govuk_navigation_helpers/version"
 require "govuk_navigation_helpers/breadcrumbs"
 require "govuk_navigation_helpers/related_items"
 require "govuk_navigation_helpers/taxon_breadcrumbs"
+require "govuk_navigation_helpers/taxonomy_sidebar"
 
 module GovukNavigationHelpers
   class NavigationHelper
@@ -25,6 +26,15 @@ module GovukNavigationHelpers
       TaxonBreadcrumbs.new(content_item).breadcrumbs
     end
 
+    # Generate a payload containing taxon sidebar data. Intended for use with
+    # the related items component.
+    #
+    # @return [Hash] Payload for the GOV.UK related items component
+    # @see http://govuk-component-guide.herokuapp.com/components/related_items
+    def taxonomy_sidebar
+      TaxonomySidebar.new(content_item).sidebar
+    end
+
     # Generate a related items payload
     #
     # @return [Hash] Payload for the GOV.UK Component

data/lib/govuk_navigation_helpers/content_item.rb

@@ -1,6 +1,7 @@
 module GovukNavigationHelpers
-  # Simple wrapper around a content store representation of a content item. Works
-  # for both the main content item and the expanded links in the links hash.
+  # Simple wrapper around a content store representation of a content item.
+  # Works for both the main content item and the expanded links in the links
+  # hash.
   #
   # @private
   class ContentItem
@@ -17,12 +18,20 @@ module GovukNavigationHelpers
     end
 
     def parent_taxon
-      # TODO: Determine what to do when there are multiple taxons/parents. For now just display the first of each.
-      taxon = content_store_response.dig("links", "taxons", 0)
-      return ContentItem.new(taxon) if taxon
+      # TODO: Determine what to do when there are multiple taxons/parents. For
+      # now just display the first of each.
+      parent_taxons.first
+    end
+
+    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?
 
-      parent_taxon = content_store_response.dig("links", "parent_taxons", 0)
-      return ContentItem.new(parent_taxon) if parent_taxon
+      # 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) }
     end
 
     def mainstream_browse_pages
@@ -39,6 +48,10 @@ module GovukNavigationHelpers
       content_store_response.fetch("base_path")
     end
 
+    def description
+      content_store_response.fetch("description", "")
+    end
+
     def content_id
       content_store_response.fetch("content_id")
     end

data/lib/govuk_navigation_helpers/taxonomy_sidebar.rb

@@ -0,0 +1,26 @@
+module GovukNavigationHelpers
+  class TaxonomySidebar
+    def initialize(content_item)
+      @content_item = ContentItem.new content_item
+    end
+
+    def sidebar
+      {
+        sections: taxons.any? ? [{ title: "More about", items: taxons }] : []
+      }
+    end
+
+  private
+
+    def taxons
+      parent_taxons = @content_item.parent_taxons
+      parent_taxons.map do |parent_taxon|
+        {
+          title: parent_taxon.title,
+          url: parent_taxon.base_path,
+          description: parent_taxon.description,
+        }
+      end
+    end
+  end
+end

data/lib/govuk_navigation_helpers/version.rb

@@ -1,3 +1,3 @@
 module GovukNavigationHelpers
-  VERSION = "2.3.1".freeze
+  VERSION = "2.4.0".freeze
 end

data/spec/taxonomy_sidebar_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
+  describe '#sidebar' do
+    it 'can handle any valid content item' do
+      generator = GovukSchemas::RandomExample.for_schema(
+        'placeholder',
+        schema_type: 'frontend'
+      )
+
+      expect { sidebar_for(generator.payload) }.to_not raise_error
+    end
+
+    context 'given a content item not tagged to any taxon' do
+      it 'returns an empty sidebar hash' do
+        content_item = { "links" => {} }
+
+        expect(sidebar_for(content_item)).to eq(
+          sections: []
+        )
+      end
+    end
+
+    context 'given a content item tagged to taxons' do
+      it 'returns a sidebar hash containing a list of parent taxons' do
+        content_item = content_item_tagged_to_taxon
+
+        expect(sidebar_for(content_item)).to eq(
+          sections: [
+            {
+              title: "More about",
+              items: [
+                { title: "Taxon 1", url: "/taxon-1", description: "The 1st taxon." },
+                { title: "Taxon 2", url: "/taxon-2", description: "The 2nd taxon." },
+              ],
+            }
+          ]
+        )
+      end
+    end
+  end
+
+  def sidebar_for(content_item)
+    GovukNavigationHelpers::NavigationHelper.new(content_item).taxonomy_sidebar
+  end
+
+  def content_item_tagged_to_taxon
+    {
+      "title" => "A piece of content",
+      "links" => {
+        "taxons" => [
+          {
+            "title" => "Taxon 1",
+            "base_path" => "/taxon-1",
+            "description" => "The 1st taxon.",
+          },
+          {
+            "title" => "Taxon 2",
+            "base_path" => "/taxon-2",
+            "description" => "The 2nd taxon.",
+          },
+        ],
+      },
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-16 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -147,11 +147,13 @@ files:
 - 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/taxonomy_sidebar.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
+- spec/taxonomy_sidebar_spec.rb
 homepage: https://github.com/alphagov/govuk_navigation_helpers
 licenses:
 - MIT
@@ -181,3 +183,4 @@ test_files:
 - spec/related_items_spec.rb
 - spec/spec_helper.rb
 - spec/taxon_breadcrumbs_spec.rb
+- spec/taxonomy_sidebar_spec.rb