govuk_publishing_components 9.8.0 → 9.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5448e205e6135944563a216db12b37c143b57016d6bafd80ade3b31bdb8625e
-  data.tar.gz: d108ec91620a235bb335674ffa4549a76a253867c7f18d460be47689babc507c
+  metadata.gz: 960ab5d3187352fb644a25d13ceb60199a064d4c34855ef09b5b076d040a848b
+  data.tar.gz: 0e2eb87f4c638266e06b83cd870db71d5b19ad3cf1feb4ee0716013dbb76028e
 SHA512:
-  metadata.gz: 0dcd90698c861c27e9f3fd036526ad256a20f5896096b8b7b99bc63464f2f754be2267cabb07772686b794b785f68958510e7158fe21cdebadd23412c00f9932
-  data.tar.gz: 40c868822baa69b8d497dcfc3408e8c1c96c677cb0d5a830e232bb8fcf9a2b2f94e214fd0dbb0c84b8763a4ef8106908a1d210a626fab9187391c5785652ae26
+  metadata.gz: cc87b549d4daf795a20093462c3133915a5fa119ed50c599ee0ef4bb379a8c5a8716cf2cfa2eda55df0a0083f5fc8067132d56b77c62d892af7441f4c8243f1e
+  data.tar.gz: 9ad12968cacfe966653c7ef523462b40a9891066b0e97b0db927919e2d6e210882386b24bb4a789c54b8c52bd86a6af1c77f52b8317ed72d7e06a6c1989134a0

data/app/assets/stylesheets/govuk_publishing_components/components/_step-by-step-nav-related.scss

@@ -15,6 +15,19 @@
   padding: 0;
 }
 
+.gem-c-step-nav-related--singular {
+  margin-bottom: $gutter-one-third + 3;
+
+  .gem-c-step-nav-related__heading {
+    @include _core-font-generator(19px, 19px, 19px, 1.4, 1.4, false, bold);
+    margin-top: $gutter-two-thirds;
+  }
+
+  .gem-c-step-nav-related__pretitle {
+    margin-bottom: $gutter-one-quarter;
+  }
+}
+
 .gem-c-step-nav-related__pretitle {
   display: block;
   margin-bottom: $gutter-half;

data/app/assets/stylesheets/govuk_publishing_components/components/_tabs.scss

@@ -0,0 +1 @@
+// This component relies on styles from GOV.UK Frontend

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

@@ -1,29 +1,11 @@
-<%
-  start ||= false
-  href ||= false
-  info_text ||= false
-  rel ||= false
-  text ||= ""
-  margin_bottom ||= false
-  data_attributes ||= false
-  title ||= false
-  css_classes = %w(gem-c-button govuk-button)
-  css_classes << "govuk-button--start" if start
-  css_classes << "gem-c-button--bottom-margin" if margin_bottom
-  css_classes = css_classes.join(" ")
-  html_options = { class: css_classes }
-  html_options[:role] = "button" if href
-  html_options[:rel] = rel if rel
-  html_options[:data] = data_attributes if data_attributes
-  html_options[:title] = title if title
-%>
-<% if href %>
-  <%= link_to(text, href, html_options) %>
+<% button = GovukPublishingComponents::Presenters::ButtonHelper.new(local_assigns) %>
+
+<% if button.link? %>
+  <%= link_to button.text, button.href, button.html_options %>
 <% else %>
-  <%= button_tag(text, html_options) %>
+  <%= button_tag button.text, button.html_options %>
 <% end %>
-<% if info_text %>
-  <span class="gem-c-button__info-text">
-    <%= info_text %>
-  </span>
+
+<% if button.info_text %>
+  <%= tag.span button.info_text, class: "gem-c-button__info-text" %>
 <% end %>

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

@@ -55,7 +55,7 @@
                       <%= logic %>
                     <% else %>
                       <% step_number += 1 %>
-                      <span class="visuallyhidden">Step</span> <%= step_number %>
+                      <span class="visuallyhidden">Step</span> <%= step_number %><span class="visuallyhidden" aria-hidden="true">:</span>
                     <% end %>
                   </span>
                 </span>

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

@@ -3,7 +3,9 @@
   pretitle ||= t("govuk_component.step_by_step_nav_related.part_of", default: "Part of")
 %>
 <% if links.any? %>
-  <div class="gem-c-step-nav-related" data-module="track-click">
+  <div 
+    class="gem-c-step-nav-related <%= "gem-c-step-nav-related--singular" if links.length == 1 %>" 
+    data-module="track-click">
     <h2 class="gem-c-step-nav-related__heading">
       <span class="gem-c-step-nav-related__pretitle"><%= pretitle %></span>
       <% if links.length == 1 %>

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

@@ -0,0 +1,31 @@
+<%
+  tabs ||= []
+%>
+<% if tabs.count > 1 %>
+  <div class="govuk-tabs gem-c-tabs" data-module="tabs">
+    <h2 class="govuk-tabs__title">
+      Contents
+    </h2>
+    <ul class="govuk-tabs__list">
+      <% tabs.each do |tab| %>
+      <li class="govuk-tabs__list-item">
+        <a class="govuk-tabs__tab" href="#<%= tab[:id] %>">
+            <%= tab[:title] %>
+          </a>
+      </li>
+      <% end %>
+    </ul>
+    <% tabs.each do |tab| %>
+      <section class="govuk-tabs__panel" id="<%= tab[:id] %>">
+        <h2 class="govuk-heading-l"><%= tab[:title] %></h2>
+          <%= tab[:content] %>
+      </section>
+      <% end %>
+  </div>
+<% end %>
+<% if tabs.count == 1 %>
+    <section id="<%= tabs[0][:id] %>">
+      <h2 class="govuk-heading-l"><%= tabs[0][:title] %></h2>
+      <%= tabs[0][:content] %>
+    </section>
+<% end %>

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

@@ -47,3 +47,10 @@ examples:
         base_path: "/foo"
         details: {}
       schema: :person
+  organisation_schema:
+    data:
+      content_item:
+        title: "Ministry of Organisation"
+        base_path: "/foo"
+        details: {}
+      schema: :organisation

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

@@ -4,7 +4,6 @@ part_of_admin_layout: true
 govuk_frontend_components:
   - select
 accessibility_criteria: |
-The component must:
   - accept focus
   - be focusable with a keyboard
   - be usable with a keyboard

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

@@ -0,0 +1,42 @@
+name: "Tabs (experimental)"
+description: "The tabs component lets users toggle between related sections of content."
+part_of_admin_layout: true
+body: |
+  This component is based on the [design system tabs component](https://design-system.service.gov.uk/components/tabs/)
+  and is currently experimental. If using this component, please feed back any research findings to the
+  design team.
+
+  The tabs component lets users navigate between related sections of content on a single page,
+  displaying one section at a time. Note that they are not intended to be used to navigate
+  between different pages.
+
+  The content block MUST be passed as a block to avoid the risk of unsanitised HTML.
+accessibility_criteria: |
+  - Tabs must:
+    * accept focus
+    * be usable with a keyboard
+    * indicate when they have focus
+    * be usable with touch
+    * be usable with voice commands
+    * have visible text
+
+examples:
+  default:
+    data:
+      tabs:
+        - id: "tab1"
+          title: "First section"
+          content: |
+            <p>Fusce at dictum tellus, ac accumsan est. Nulla vitae turpis in nulla gravida tincidunt. Duis lectus felis, tempus id bibendum sit amet, posuere ut elit. Donec enim odio, eleifend in urna a, sagittis egestas est. Proin id ex ultricies, porta eros id, vehicula quam. Morbi non sagittis velit.</p>
+        - id: "tab2"
+          title: "Second section"
+          content: |
+            <p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam congue elementum commodo. Vestibulum elit turpis, efficitur quis posuere vitae, commodo vitae augue. Donec ut pharetra ligula. Phasellus ac mauris eu felis bibendum dapibus rutrum sed quam. Pellentesque posuere ante id consequat pretium.</p>
+  single_item:
+    description: If only an individual item is supplied to the component (if the list is created dynamically, for example) it will be rendered without tabs.
+    data:
+      tabs:
+        - id: "singletab"
+          title: "Single piece of content"
+          content: |
+            Here is a single piece of content, there should be no tabs.

data/lib/govuk_publishing_components.rb

@@ -1,6 +1,7 @@
 require "govuk_publishing_components/config"
 require "govuk_publishing_components/engine"
 require "govuk_publishing_components/presenters/breadcrumbs"
+require "govuk_publishing_components/presenters/button_helper"
 require "govuk_publishing_components/presenters/contextual_navigation"
 require "govuk_publishing_components/presenters/related_navigation_helper"
 require "govuk_publishing_components/presenters/step_by_step_nav_helper"

data/lib/govuk_publishing_components/presenters/button_helper.rb

@@ -0,0 +1,43 @@
+require 'action_view'
+
+module GovukPublishingComponents
+  module Presenters
+    class ButtonHelper
+      attr_reader :href, :text, :title, :info_text, :rel, :data_attributes,
+        :start, :margin_bottom
+
+      def initialize(local_assigns)
+        @href = local_assigns[:href]
+        @text = local_assigns[:text]
+        @title = local_assigns[:title]
+        @info_text = local_assigns[:info_text]
+        @rel = local_assigns[:rel]
+        @data_attributes = local_assigns[:data_attributes]
+        @start = local_assigns[:start]
+        @margin_bottom = local_assigns[:margin_bottom]
+      end
+
+      def link?
+        href.present?
+      end
+
+      def html_options
+        options = { class: css_classes }
+        options[:role] = "button" if link?
+        options[:rel] = rel if rel
+        options[:data] = data_attributes if data_attributes
+        options[:title] = title if title
+        options
+      end
+
+    private
+
+      def css_classes
+        classes = %w(gem-c-button govuk-button)
+        classes << "govuk-button--start" if start
+        classes << "gem-c-button--bottom-margin" if margin_bottom
+        classes.join(" ")
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/machine_readable/article_schema.rb

@@ -29,7 +29,7 @@ module GovukPublishingComponents
               "url" => page.logo_url,
             }
           }
-        }.merge(image_schema).merge(author_schema).merge(body)
+        }.merge(image_schema).merge(author_schema).merge(body).merge(is_part_of)
       end
 
     private
@@ -67,6 +67,37 @@ module GovukPublishingComponents
       def publishing_organisation
         page.content_item.dig("links", "primary_publishing_organisation").to_a.first
       end
+
+      def is_part_of
+        return {} unless linked_step_by_steps.any?
+        {
+          "isPartOf" => step_by_step_schemas
+        }
+      end
+
+      def linked_step_by_steps
+        # We could include `related_to_step_navs` eventually too, but initially
+        # link to those that we render in the "step_by_step_nav_related" component
+        @step_by_steps ||= page.content_item.dig("links", "part_of_step_navs").to_a
+      end
+
+      def step_by_step_schemas
+        linked_step_by_steps.map do |step_by_step|
+          step_by_step_page = linked_page(step_by_step)
+          structured_data = HowToSchema.new(step_by_step_page.canonical_url).structured_data
+
+          structured_data.merge(image_schema)
+        end
+      end
+
+      def linked_page(step_by_step)
+        Page.new(
+          content_item: step_by_step,
+          schema: :article,
+          logo_url: page.logo_url,
+          image_placeholders: page.image_placeholders
+        )
+      end
     end
   end
 end

data/lib/govuk_publishing_components/presenters/machine_readable/how_to_schema.rb

@@ -0,0 +1,20 @@
+module GovukPublishingComponents
+  module Presenters
+    class HowToSchema
+      attr_reader :how_to_url
+
+      def initialize(how_to_url)
+        @how_to_url = how_to_url
+      end
+
+      def structured_data
+        # http://schema.org/HowTo - minimal
+        {
+          "@context" => "http://schema.org",
+          "@type" => "HowTo",
+          "sameAs" => how_to_url
+        }
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/machine_readable/organisation_schema.rb

@@ -0,0 +1,25 @@
+module GovukPublishingComponents
+  module Presenters
+    class OrganisationSchema
+      attr_reader :page
+
+      def initialize(page)
+        @page = page
+      end
+
+      def structured_data
+        # http://schema.org/GovernmentOrganization
+        {
+          "@context" => "http://schema.org",
+          "@type" => "GovernmentOrganization",
+          "mainEntityOfPage" => {
+            "@type" => "WebPage",
+            "@id" => page.canonical_url,
+          },
+          "name" => page.title,
+          "description" => page.body
+        }
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/machine_readable/page.rb

@@ -16,7 +16,7 @@ module GovukPublishingComponents
       end
 
       def body
-        local_assigns[:body] || content_item["details"]["body"]
+        local_assigns[:body] || content_item.dig("details", "body")
       end
 
       def title

data/lib/govuk_publishing_components/presenters/schema_org.rb

@@ -1,6 +1,8 @@
 require 'govuk_publishing_components/presenters/machine_readable/page'
 require 'govuk_publishing_components/presenters/machine_readable/article_schema'
+require 'govuk_publishing_components/presenters/machine_readable/how_to_schema'
 require 'govuk_publishing_components/presenters/machine_readable/news_article_schema'
+require 'govuk_publishing_components/presenters/machine_readable/organisation_schema'
 require 'govuk_publishing_components/presenters/machine_readable/person_schema'
 
 module GovukPublishingComponents
@@ -19,6 +21,8 @@ module GovukPublishingComponents
           NewsArticleSchema.new(page).structured_data
         elsif page.schema == :person
           PersonSchema.new(page).structured_data
+        elsif page.schema == :organisation
+          OrganisationSchema.new(page).structured_data
         else
           raise "#{page.schema} is not supported"
         end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '9.8.0'.freeze
+  VERSION = '9.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 9.8.0
+  version: 9.9.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-01 00:00:00.000000000 Z
+date: 2018-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -377,6 +377,7 @@ files:
 - app/assets/stylesheets/govuk_publishing_components/components/_step-by-step-nav.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_subscription-links.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_success-alert.scss
+- app/assets/stylesheets/govuk_publishing_components/components/_tabs.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_taxonomy-navigation.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_textarea.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_title.scss
@@ -480,6 +481,7 @@ files:
 - app/views/govuk_publishing_components/components/_step_by_step_nav_related.html.erb
 - app/views/govuk_publishing_components/components/_subscription-links.html.erb
 - app/views/govuk_publishing_components/components/_success_alert.html.erb
+- app/views/govuk_publishing_components/components/_tabs.html.erb
 - app/views/govuk_publishing_components/components/_taxonomy_navigation.html.erb
 - app/views/govuk_publishing_components/components/_textarea.html.erb
 - app/views/govuk_publishing_components/components/_title.html.erb
@@ -529,6 +531,7 @@ files:
 - app/views/govuk_publishing_components/components/docs/step_by_step_nav_related.yml
 - app/views/govuk_publishing_components/components/docs/subscription-links.yml
 - app/views/govuk_publishing_components/components/docs/success_alert.yml
+- app/views/govuk_publishing_components/components/docs/tabs.yml
 - app/views/govuk_publishing_components/components/docs/taxonomy_navigation.yml
 - app/views/govuk_publishing_components/components/docs/textarea.yml
 - app/views/govuk_publishing_components/components/docs/title.yml
@@ -552,6 +555,7 @@ files:
 - lib/govuk_publishing_components/engine.rb
 - lib/govuk_publishing_components/minitest/component_guide_test.rb
 - lib/govuk_publishing_components/presenters/breadcrumbs.rb
+- lib/govuk_publishing_components/presenters/button_helper.rb
 - lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_parent.rb
 - lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons.rb
 - lib/govuk_publishing_components/presenters/content_item.rb
@@ -562,7 +566,9 @@ files:
 - lib/govuk_publishing_components/presenters/highlight_boxes_helper.rb
 - lib/govuk_publishing_components/presenters/image_card_helper.rb
 - lib/govuk_publishing_components/presenters/machine_readable/article_schema.rb
+- lib/govuk_publishing_components/presenters/machine_readable/how_to_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/news_article_schema.rb
+- lib/govuk_publishing_components/presenters/machine_readable/organisation_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/page.rb
 - lib/govuk_publishing_components/presenters/machine_readable/person_schema.rb
 - lib/govuk_publishing_components/presenters/meta_tags.rb