govuk_publishing_components 5.5.6 → 5.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fbefd48d42ae5e9eb0cfb75f99b26e2ad3d75e6a8ca5f650fdace56ab097738
-  data.tar.gz: 1fd1d1c8c29e5a7f3f98403ae90c6ce69da5da001517f41e781a83e28e1478c7
+  metadata.gz: a741268b6b87bdca3271b0988eef9a43ec7e9b01ad03b59a0bdcdc1611c72278
+  data.tar.gz: e5bd85deb2d496c428100b9e3711a78982e42b39d7aff181b5802e6b1e2a4cf7
 SHA512:
-  metadata.gz: a576f5fa1d962ac57fc9fadb5ee503b15a359d3c6d6b060560ba88c0078bbd66a76953d870a87a55abf40afdab2ce843a7ee4ae74a9016b0999784b128fff4ca
-  data.tar.gz: 3c3bbe4ac3b8f36a078fb80faf562408422c05e6db0af3e7bb2e73add1d884b776a6251edbc7d8a5cf4c2134801c9241ec19878bba312a3739c29547cd083f29
+  metadata.gz: 17e7019b89f86cec1c4e3a80f89495e34ba94ae01350308d23f4795138d673f69112edc8b65668b2337696dcdf62d4cdf2499d0a1b95bc5e315e32a3c0c76812
+  data.tar.gz: cc2f4a5a5124f7e8ba80db9b995f0c14c673b3fcdb5222c08565087ccfafc5a23ed2a15203b5abf5d3cab97e28cd449c799475a1cfb56d2310db545fe0ccb367

data/app/assets/javascripts/govuk_publishing_components/all_components.js

@@ -0,0 +1 @@
+//= require_tree ./components

data/app/assets/javascripts/govuk_publishing_components/application.js

@@ -13,6 +13,5 @@
 //= require govuk/modules
 //= require ../history-support
 //= require ../current-location
-//= require_tree ./components
 //= require_tree ./vendor
 //= require_tree .

data/app/assets/javascripts/govuk_publishing_components/components/feedback.js

@@ -19,11 +19,13 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
       this.$somethingIsWrongButton = $element.find('.js-something-is-wrong');
       this.$promptQuestions = $element.find('.js-prompt-questions');
       this.$promptSuccessMessage = $element.find('.js-prompt-success');
+      this.$somethingIsWrongForm = $element.find('#something-is-wrong');
 
       var that = this;
       var jshiddenClass = 'js-hidden';
 
       setInitialAriaAttributes();
+      setHiddenValues();
 
       this.$toggleForms.on('click', function(e) {
         e.preventDefault();
@@ -83,6 +85,11 @@ window.GOVUK.Modules = window.GOVUK.Modules || {};
         that.$somethingIsWrongButton.attr('aria-expanded', false);
       }
 
+      function setHiddenValues () {
+        that.$somethingIsWrongForm.append('<input type="hidden" name="javascript_enabled" value="true"/>');
+        that.$somethingIsWrongForm.append($('<input type="hidden" name="referrer">').val(document.referrer || "unknown"));
+      }
+
       function updateAriaAttributes (linkClicked) {
         linkClicked.attr('aria-expanded', true);
         $('#' + linkClicked.attr('aria-controls')).attr('aria-hidden', false);

data/app/assets/stylesheets/govuk_publishing_components/components/_document-list.scss

@@ -22,18 +22,10 @@
 }
 
 .gem-c-document-list--bottom-margin {
-  margin-bottom: $gutter-half;
-
-  @include media(tablet) {
-    margin-bottom: $gutter * 1.5;
-  }
+  margin-bottom: $gutter-two-thirds;
 }
 
 .gem-c-document-list--top-margin {
-  margin-top: $gutter-half;
-
-  @include media(tablet) {
-    margin-top: $gutter * 1.5;
-  }
+  margin-top: $gutter-two-thirds;
 }
 

data/app/views/govuk_publishing_components/components/_contextual_breadcrumbs.html.erb

@@ -0,0 +1,20 @@
+<% navigation = GovukPublishingComponents::Presenters::ContextualNavigation.new(content_item, request.path) %>
+
+<% if navigation.step_nav_helper.show_header? %>
+  <!-- Rendering step by step nav -->
+  <%= render 'govuk_publishing_components/components/step_by_step_nav_header', navigation.step_nav_helper.header %>
+<% else %>
+  <% if navigation.should_present_taxonomy_navigation? %>
+    <!-- Rendering taxonomy breadcrumbs -->
+    <% if navigation.taxon_breadcrumbs.any? %>
+      <%= render 'govuk_component/breadcrumbs',
+        breadcrumbs: navigation.taxon_breadcrumbs[:breadcrumbs],
+        collapse_on_mobile: true %>
+    <% end %>
+  <% else %>
+    <!-- Rendering normal breadcrumbs -->
+    <% if navigation.breadcrumbs.any? %>
+      <%= render 'govuk_component/breadcrumbs', breadcrumbs: navigation.breadcrumbs %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/govuk_publishing_components/components/_contextual_sidebar.html.erb

@@ -0,0 +1,19 @@
+<% navigation = GovukPublishingComponents::Presenters::ContextualNavigation.new(content_item, request.path) %>
+
+<% if navigation.step_nav_helper.show_related_links? %>
+  <!-- rendering step by step related items -->
+  <%= render 'govuk_publishing_components/components/step_by_step_nav_related', links: navigation.step_nav_helper.related_links %>
+
+  <% if navigation.step_nav_helper.show_sidebar? %>
+    <!-- rendering step by step sidebar -->
+    <%= render 'govuk_publishing_components/components/step_by_step_nav', navigation.step_nav_helper.sidebar %>
+  <% end %>
+<% else %>
+  <% if navigation.should_present_taxonomy_navigation? %>
+    <!-- rendering taxonomy sidebar -->
+    <%= render partial: 'govuk_component/taxonomy_sidebar', locals: navigation.taxonomy_sidebar %>
+  <% else %>
+    <!-- rendering related navigation sidebar -->
+    <%= render 'govuk_publishing_components/components/related_navigation', content_item %>
+  <% end %>
+<% end %>

data/app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml

@@ -0,0 +1,25 @@
+name: Contextual breadcrumbs
+description: Breadcrumbs that shows different things depending on the page
+body: |
+  This is a complex component that calls other components. For more accurate
+  preview with real data, see the [contextual navigation preview][preview].
+
+  There are 3 main variants of the component:
+
+  - Step by step, which uses the [step by step header][header]
+  - Parent breadcrumb, which uses the `parent` link of the page with the [breadcrumbs component][breadcrumbs]
+  - Taxon breadcrumb, which uses the `taxons` link of the page with the [breadcrumbs component][breadcrumbs]
+
+  It must always used [together with the contextual sidebar][sidebar].
+
+  [preview]: https://govuk-publishing-components.herokuapp.com/contextual-navigation
+  [header]: /component-guide/step_by_step_nav_header
+  [sidebar]: /component-guide/contextual_sidebar
+  [breadcrumbs]: https://govuk-static.herokuapp.com/component-guide/breadcrumbs
+accessibility_criteria: |
+  Components called by this component must be accessible
+examples:
+  default:
+    data:
+      content_item:
+        title: "A content item"

data/app/views/govuk_publishing_components/components/docs/contextual_sidebar.yml

@@ -0,0 +1,27 @@
+name: Contextual sidebar
+description: Sidebar that shows different things depending on the page
+body: |
+  This is a complex component that calls other components. For more accurate
+  preview with real data, see the [contextual navigation preview][preview].
+
+  There are 4 main variants of the component:
+
+  - Step by step, which uses the [step by step nav][step-by-step]
+  - Taxonomy, which uses the new taxonomy in the [taxonomy-sidebar component][taxonomy-sidebar]
+  - Mainstream, which uses related links in the [related navigation component][related_navigation]
+  - Related navigation, which uses legacy taxonomies in the [related navigation component][related_navigation]
+
+  It must always used [together with the contextual breadcrumbs][contextual_breadcrumbs].
+
+  [preview]: https://govuk-publishing-components.herokuapp.com/contextual-navigation
+  [step-by-step]: /component-guide/step_by_step_nav
+  [related_navigation]: /component-guide/related_navigation
+  [taxonomy-sidebar]: https://govuk-static.herokuapp.com/component-guide/taxonomy_sidebar
+  [contextual_breadcrumbs]: /component-guide/contextual_breadcrumbs
+accessibility_criteria: |
+  Components called by this component must be accessible
+examples:
+  default:
+    data:
+      content_item:
+        title: "A content item"

data/lib/govuk_publishing_components.rb

@@ -2,6 +2,8 @@ require "govuk_publishing_components/config"
 require "govuk_publishing_components/engine"
 require "govuk_publishing_components/presenters/step_by_step_nav_helper"
 require "govuk_publishing_components/presenters/related_navigation_helper"
+require "govuk_publishing_components/presenters/contextual_navigation"
+require "govuk_publishing_components/presenters/navigation_type"
 
 require "govuk_publishing_components/app_helpers/step_nav"
 require "govuk_publishing_components/app_helpers/step_nav_helper"

data/lib/govuk_publishing_components/presenters/contextual_navigation.rb

@@ -0,0 +1,60 @@
+require 'govuk_navigation_helpers'
+
+module GovukPublishingComponents
+  module Presenters
+    # @private
+    class ContextualNavigation
+      attr_reader :content_item, :request_path
+
+      # @param content_item A content item hash with strings as keys
+      # @param request_path `request.path`
+      def initialize(content_item, request_path)
+        @content_item = content_item
+        @request_path = request_path
+      end
+
+      def taxonomy_sidebar
+        nav_helper.taxonomy_sidebar
+      end
+
+      def taxon_breadcrumbs
+        nav_helper.taxon_breadcrumbs
+      end
+
+      def breadcrumbs
+        if content_item["schema_name"] == "specialist_document"
+          parent_finder = content_item.dig("links", "finder", 0)
+          return [] unless parent_finder
+
+          [
+            {
+              title: "Home",
+              url: "/",
+            },
+            {
+              title: parent_finder['title'],
+              url: parent_finder['base_path'],
+            }
+          ]
+        else
+          nav_helper.breadcrumbs[:breadcrumbs]
+        end
+      end
+
+      def should_present_taxonomy_navigation?
+        navigation = GovukPublishingComponents::Presenters::NavigationType.new(content_item)
+        navigation.should_present_taxonomy_navigation?
+      end
+
+      def step_nav_helper
+        @step_nav_helper ||= GovukPublishingComponents::AppHelpers::StepNavHelper.new(content_item, request_path)
+      end
+
+    private
+
+      def nav_helper
+        @nav_helper ||= GovukNavigationHelpers::NavigationHelper.new(content_item)
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/navigation_type.rb

@@ -0,0 +1,33 @@
+module GovukPublishingComponents
+  module Presenters
+    # @private
+    class NavigationType
+      GUIDANCE_SCHEMAS =
+        %w{answer contact guide detailed_guide document_collection publication}.freeze
+
+      def initialize(content_item)
+        @content_item = content_item
+      end
+
+      def should_present_taxonomy_navigation?
+        !content_is_tagged_to_browse_pages? &&
+          content_is_tagged_to_a_live_taxon? &&
+          content_schema_is_guidance?
+      end
+
+    private
+
+      def content_is_tagged_to_a_live_taxon?
+        @content_item.dig("links", "taxons").to_a.any? { |taxon| taxon["phase"] == "live" }
+      end
+
+      def content_is_tagged_to_browse_pages?
+        @content_item.dig("links", "mainstream_browse_pages").present?
+      end
+
+      def content_schema_is_guidance?
+        GUIDANCE_SCHEMAS.include? @content_item["schema_name"]
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/related_navigation_helper.rb

@@ -141,8 +141,8 @@ module GovukPublishingComponents
         contacts = filter_link_type("related", "contact")
         return [] unless contacts.any?
         [
-          title: "Other contacts",
-          links: build_links_for_sidebar(contacts).map
+          "title" => "Other contacts",
+          "links" => build_links_for_sidebar(contacts)
         ]
       end
 

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '5.5.6'.freeze
+  VERSION = '5.6.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 5.5.6
+  version: 5.6.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-15 00:00:00.000000000 Z
+date: 2018-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: govuk_navigation_helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 9.2.1
 - !ruby/object:Gem::Dependency
   name: govuk-lint
   requirement: !ruby/object:Gem::Requirement
@@ -289,6 +303,7 @@ files:
 - app/assets/config/govuk_publishing_components_manifest.js
 - app/assets/javascripts/current-location.js
 - app/assets/javascripts/govuk_publishing_components/accessibility-test.js
+- app/assets/javascripts/govuk_publishing_components/all_components.js
 - app/assets/javascripts/govuk_publishing_components/application.js
 - app/assets/javascripts/govuk_publishing_components/components/error-summary.js
 - app/assets/javascripts/govuk_publishing_components/components/feedback.js
@@ -334,6 +349,8 @@ files:
 - app/views/govuk_publishing_components/component_guide/preview.html.erb
 - app/views/govuk_publishing_components/component_guide/show.html.erb
 - app/views/govuk_publishing_components/components/_back_link.html.erb
+- app/views/govuk_publishing_components/components/_contextual_breadcrumbs.html.erb
+- app/views/govuk_publishing_components/components/_contextual_sidebar.html.erb
 - app/views/govuk_publishing_components/components/_document_list.html.erb
 - app/views/govuk_publishing_components/components/_error_summary.html.erb
 - app/views/govuk_publishing_components/components/_feedback.html.erb
@@ -347,6 +364,8 @@ files:
 - app/views/govuk_publishing_components/components/_step_by_step_nav_header.html.erb
 - app/views/govuk_publishing_components/components/_step_by_step_nav_related.html.erb
 - app/views/govuk_publishing_components/components/docs/back_link.yml
+- app/views/govuk_publishing_components/components/docs/contextual_breadcrumbs.yml
+- app/views/govuk_publishing_components/components/docs/contextual_sidebar.yml
 - app/views/govuk_publishing_components/components/docs/document_list.yml
 - app/views/govuk_publishing_components/components/docs/error_summary.yml
 - app/views/govuk_publishing_components/components/docs/feedback.yml
@@ -375,6 +394,8 @@ files:
 - lib/govuk_publishing_components/config.rb
 - lib/govuk_publishing_components/engine.rb
 - lib/govuk_publishing_components/minitest/component_guide_test.rb
+- lib/govuk_publishing_components/presenters/contextual_navigation.rb
+- lib/govuk_publishing_components/presenters/navigation_type.rb
 - lib/govuk_publishing_components/presenters/related_navigation_helper.rb
 - lib/govuk_publishing_components/presenters/step_by_step_nav_helper.rb
 - lib/govuk_publishing_components/version.rb