govuk_navigation_helpers 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 925f41952a73c6f57ba09696d8b3eb9f3cd4f460
-  data.tar.gz: c60be579e0918ac56ab9720e07fc7d9957113d0a
+  metadata.gz: 96733a7614897c0c7289e94d1b07b01854704614
+  data.tar.gz: 7f5b667aa01be69cc1d9324ebabb6db151090c71
 SHA512:
-  metadata.gz: 793282df094eb26e965a5ae97215a2279b7f72bf6afec86cbca844c4fc216231ce7c082800ee3526cbeacd9dd12191697f55ff9aa7b04e1e3d0d699bfc5a97fe
-  data.tar.gz: ba673437955eea0d5ceda36cfe1b53522e278adfa14ca79b9a4228c4d1a89c15d06477befa4ac1f56f6527344edd6081e7ced480d51397a88b249dabf22095de
+  metadata.gz: e74bf5f3785e7017722fc3e540626de37c983e2124589a9d595539f3b50bf78f18a80ee17a20c6c52411db26049d1d40fd02b343f5be6530d3708a9c655358a7
+  data.tar.gz: 9e55565a8216e3bd4a9f95c52e15aeda80e1ed2d73d82dc1d3e566937c3aa393f02958d574532dd5f7ddfc1412186784c724f668664471e0ca73a77ad984e027

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.4.1
+
+* Add related content to the taxonomy sidebar helper
+
 ## 2.4.0
 
 * Add helper for rendering sidebar on taxonomy content pages.

data/Jenkinsfile

@@ -35,36 +35,7 @@ node {
 
     if(env.BRANCH_NAME == "master") {
       stage('Publish Gem') {
-        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'")
-        }
+        govuk.publishGem(REPOSITORY, env.BRANCH_NAME)
       }
     }
 

data/govuk_navigation_helpers.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "gds-api-adapters", "~> 40.1"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.5"
@@ -26,6 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-byebug", "~> 3.4"
   spec.add_development_dependency "yard", "~> 0.8"
   spec.add_development_dependency "govuk_schemas", "~> 1.0"
+  spec.add_development_dependency "webmock", "~> 2.3"
 
   spec.required_ruby_version = ">= 2.3.1"
 end

data/lib/govuk_navigation_helpers/configuration.rb

@@ -0,0 +1,27 @@
+module GovukNavigationHelpers
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration if block_given?
+  end
+
+  class Configuration
+    attr_writer :error_handler
+
+    def initialize
+      @configuration = {}
+    end
+
+    def error_handler
+      @error_handler ||= NoErrorHandler.new
+    end
+
+    class NoErrorHandler
+      def notify(exception, *_args)
+        puts exception
+      end
+    end
+  end
+end

data/lib/govuk_navigation_helpers/guidance.rb

@@ -0,0 +1,31 @@
+module GovukNavigationHelpers
+  module Guidance
+    # DO NOT COPY THIS LIST
+    # This hard-coded list is a temporary measure, and will eventually be replaced by a change in Rummager that
+    # will allow us to search for "Guidance" content.
+    # See: https://trello.com/c/hxGPJ9jw/435-consolidate-guidance-document-types-into-search
+    DOCUMENT_TYPES = %w[
+      answer
+      contact
+      detailed_guide
+      document_collection
+      form
+      guidance
+      guide
+      licence
+      local_transaction
+      manual
+      map
+      notice
+      place
+      programme
+      promotional
+      regulation
+      simple_smart_answer
+      smart_answer
+      statutory_guidance
+      transaction
+      travel_advice
+      ].freeze
+  end
+end

data/lib/govuk_navigation_helpers/services.rb

@@ -0,0 +1,9 @@
+require 'gds_api/rummager'
+
+module GovukNavigationHelpers
+  module Services
+    def self.rummager
+      @rummager ||= GdsApi::Rummager.new(Plek.find('rummager'))
+    end
+  end
+end

data/lib/govuk_navigation_helpers/taxonomy_sidebar.rb

@@ -1,3 +1,7 @@
+require 'govuk_navigation_helpers/services'
+require 'govuk_navigation_helpers/guidance'
+require 'govuk_navigation_helpers/configuration'
+
 module GovukNavigationHelpers
   class TaxonomySidebar
     def initialize(content_item)
@@ -6,7 +10,7 @@ module GovukNavigationHelpers
 
     def sidebar
       {
-        sections: taxons.any? ? [{ title: "More about", items: taxons }] : []
+        sections: taxons.any? ? [{ title: "More about #{@content_item.title}", items: taxons }] : []
       }
     end
 
@@ -19,8 +23,28 @@ module GovukNavigationHelpers
           title: parent_taxon.title,
           url: parent_taxon.base_path,
           description: parent_taxon.description,
+          related_content: content_related_to(parent_taxon),
         }
       end
     end
+
+    # This method will fetch content related to @content_item, and tagged to taxon. This is a
+    # temporary method that uses search to achieve this. This behaviour is to be moved into
+    # the content store
+    def content_related_to(taxon)
+      begin
+        Services.rummager.search(
+          similar_to: @content_item.base_path,
+          start: 0,
+          count: 5,
+          filter_taxons: [taxon.content_id],
+          filter_content_store_document_type: Guidance::DOCUMENT_TYPES,
+          fields: %w[title link],
+        )['results']
+      rescue StandardError => e
+        GovukNavigationHelpers.configuration.error_handler.notify(e)
+        []
+      end
+    end
   end
 end

data/lib/govuk_navigation_helpers/version.rb

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

data/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require 'govuk_navigation_helpers'
 require 'govuk_schemas'
+require 'webmock/rspec'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -88,3 +89,7 @@ RSpec.configure do |config|
   # as the one that triggered the failure.
   Kernel.srand config.seed
 end
+
+# This lets WebMock detect query strings with repeated values (eg ?array=1&array=2)
+# See https://github.com/bblimke/webmock/issues/584#issuecomment-185605565
+WebMock::Config.instance.query_values_notation = :flat_array

data/spec/taxonomy_sidebar_spec.rb

@@ -1,7 +1,25 @@
 require 'spec_helper'
+require 'webmock/rspec'
+require 'gds_api/test_helpers/rummager'
+
+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
+
     it 'can handle any valid content item' do
       generator = GovukSchemas::RandomExample.for_schema(
         'placeholder',
@@ -22,22 +40,70 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
     end
 
     context 'given a content item tagged to taxons' do
-      it 'returns a sidebar hash containing a list of parent taxons' do
+      it 'returns a sidebar hash containing a list of parent taxons and related content' do
         content_item = content_item_tagged_to_taxon
 
         expect(sidebar_for(content_item)).to eq(
           sections: [
             {
-              title: "More about",
+              title: "More about A piece of content",
               items: [
-                { title: "Taxon 1", url: "/taxon-1", description: "The 1st taxon." },
-                { title: "Taxon 2", url: "/taxon-2", description: "The 2nd taxon." },
+                {
+                  title: "Taxon 1",
+                  url: "/taxon-1",
+                  description: "The 1st taxon.",
+                  related_content: [
+                    {
+                      "title" => 'Result Content',
+                      "link" => '/result-content',
+                    },
+                  ],
+                },
+                {
+                  title: "Taxon 2",
+                  url: "/taxon-2",
+                  description: "The 2nd taxon.",
+                  related_content: [
+                    {
+                      "title" => 'Result Content',
+                      "link" => '/result-content',
+                    },
+                  ],
+                },
               ],
             }
           ]
         )
       end
     end
+
+    context 'when Rummager raises an exception' do
+      error_handler = nil
+
+      before(:each) do
+        stub_any_rummager_search
+            .to_return(status: 500)
+
+        error_handler = spy('error_handler')
+
+        GovukNavigationHelpers.configure do |config|
+          config.error_handler = error_handler
+        end
+      end
+
+      it 'does not re-raise' do
+        content_item = content_item_tagged_to_taxon
+
+        expect { sidebar_for(content_item) }.to_not raise_error
+      end
+
+      it 'logs an error' do
+        content_item = content_item_tagged_to_taxon
+        sidebar_for(content_item)
+
+        expect(error_handler).to have_received(:notify).at_least(1).times
+      end
+    end
   end
 
   def sidebar_for(content_item)
@@ -47,16 +113,19 @@ RSpec.describe GovukNavigationHelpers::TaxonomySidebar do
   def content_item_tagged_to_taxon
     {
       "title" => "A piece of content",
+      "base_path" => "/a-piece-of-content",
       "links" => {
         "taxons" => [
           {
             "title" => "Taxon 1",
             "base_path" => "/taxon-1",
+            "content_id" => "taxon1",
             "description" => "The 1st taxon.",
           },
           {
             "title" => "Taxon 2",
             "base_path" => "/taxon-2",
+            "content_id" => "taxon2",
             "description" => "The 2nd taxon.",
           },
         ],

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: govuk_navigation_helpers
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-22 00:00:00.000000000 Z
+date: 2017-02-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: gds-api-adapters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '40.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '40.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: Gem to transform items from the content-store into payloads for GOV.UK
   components
 email:
@@ -143,9 +171,12 @@ files:
 - govuk_navigation_helpers.gemspec
 - lib/govuk_navigation_helpers.rb
 - lib/govuk_navigation_helpers/breadcrumbs.rb
+- lib/govuk_navigation_helpers/configuration.rb
 - lib/govuk_navigation_helpers/content_item.rb
 - lib/govuk_navigation_helpers/grouped_related_links.rb
+- lib/govuk_navigation_helpers/guidance.rb
 - lib/govuk_navigation_helpers/related_items.rb
+- lib/govuk_navigation_helpers/services.rb
 - lib/govuk_navigation_helpers/taxon_breadcrumbs.rb
 - lib/govuk_navigation_helpers/taxonomy_sidebar.rb
 - lib/govuk_navigation_helpers/version.rb