govuk_publishing_components 9.1.0 → 9.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8a4912cbff99d020d6e61c3a9e4e8b7a32b21b91f0031fd3784876bbc1b3f8b
-  data.tar.gz: 9196ea412a372cf4ad8ec6abb466682bea18736aea6cdcc273c6f881de36f1a1
+  metadata.gz: db15d537c17313a0793b88dc3ccac1f8ba3496e4a74b90243c0727e7b978354a
+  data.tar.gz: 61a1abf7b80c7d18a6279ac941cced1642389918dbd4b5cef98d98d24b522d53
 SHA512:
-  metadata.gz: 81f31e5c4026ac11ddce146d66b6afa59e64af064fea257e9aab78e68b6f041696e29729b6290d58dd2358946eb6948787ff7f204be79aac6656744a799de836
-  data.tar.gz: 4e79ba08990e88c7c848db1c44fecb0fdcff85f408494538e56b06e7e65039a6bff8a01b1b2f731065b2c8b475e8a3527bd91915de10d6ed05381d6d6010aafb
+  metadata.gz: 6128034653da026744dc30526dda393da4d0ee1ed124d700b36b4e8833c244b8db785050af8ef35d313e50ec09ae31c1841d05f492a5af4c781ec57d9cb492bf
+  data.tar.gz: 026ba2c40a3a797853af4586a29f2f9a82b02b1b887eef5364f7db7d8155af74d84988c22160f900c03a0f47f179866955a675a23e30272c90e00026b3d88557

data/app/views/govuk_publishing_components/component_guide/example.html.erb

@@ -3,7 +3,7 @@
 
 <div class="component-show">
   <div class="component-doc">
-    <%= render "govuk_publishing_components/components/govspeak", content: @component_example.html_description %>
+    <%= render "govuk_publishing_components/components/govspeak", content: raw(@component_example.html_description) %>
     <h2 class="component-doc-h2">How to call this example</h2>
     <%= render partial: "govuk_publishing_components/component_guide/component_doc/call", locals: { component_doc: @component_doc, example: @component_example } %>
 

data/app/views/govuk_publishing_components/component_guide/show.html.erb

@@ -13,7 +13,7 @@
       <%= render 'govuk_publishing_components/components/lead_paragraph', text: @component_doc.description %>
       <% if @component_doc.body.present? %>
         <div class="component-body">
-          <%= render 'govuk_publishing_components/components/govspeak', content: @component_doc.html_body %>
+          <%= render 'govuk_publishing_components/components/govspeak', content: raw(@component_doc.html_body) %>
         </div>
       <% end %>
     </div>
@@ -32,7 +32,7 @@
     <div class="grid-row component-accessibility-criteria">
       <div class="column-two-thirds">
         <h2 class="component-doc-h2">Accessibility acceptance criteria</h2>
-        <%= render 'govuk_publishing_components/components/govspeak', content: @component_doc.html_accessibility_criteria %>
+        <%= render 'govuk_publishing_components/components/govspeak', content: raw(@component_doc.html_accessibility_criteria) %>
       </div>
     </div>
   <% end %>
@@ -48,7 +48,7 @@
             <a href="<%= component_example_path(@component_doc.id, example.id) %>"><%= example.name %></a>
             <small>(<a href="<%= component_preview_path(@component_doc.id, example.id) %>">preview</a>)</small>
           </h3>
-          <%= render "govuk_publishing_components/components/govspeak", content: example.html_description %>
+          <%= render "govuk_publishing_components/components/govspeak", content: raw(example.html_description) %>
           <%= render "govuk_publishing_components/component_guide/component_doc/call", component_doc: @component_doc, example: example %>
           <%= render "govuk_publishing_components/component_guide/component_doc/preview", component_doc: @component_doc, example: example %>
         </div>

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

@@ -10,5 +10,28 @@
 %>
 
 <div class="gem-c-govspeak govuk-govspeak <%= classes.join(" ") %>">
-  <%= raw content %>
+  <% if local_assigns.include?(:content) %>
+    <% if content.html_safe? %>
+      <%= content %>
+    <% else %>
+      <% puts "
+        You've passed in unsanitised HTML into the govspeak component as the
+        `content` param.
+
+        Passing in unsafe HTML is deprecated and will be removed in a future
+        version. You need to pass in a block instead or use the `capture` helper.
+
+        See the component guide for examples.
+
+        If you're 100% sure there's no unsanitised user input in the string you
+        could also call `.html_safe` on the string or use the `raw` helper before
+        passing it in.
+
+        Called from #{caller_locations.find { |l| l.to_s.include?('.erb') }}
+        " %>
+      <%= raw content %>
+    <% end %>
+  <% elsif block_given? %>
+    <%= yield %>
+  <% end %>
 </div>

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

@@ -1,9 +1,12 @@
 <%
-  govspeak_locals = { content: content }
+  govspeak_locals = {}
+  govspeak_locals[:content] = local_assigns.fetch(:content) if local_assigns.include?(:content)
   govspeak_locals[:direction] = local_assigns.fetch(:direction) if local_assigns.include?(:direction)
   govspeak_locals[:rich_govspeak] = local_assigns.fetch(:rich_govspeak) if local_assigns.include?(:rich_govspeak)
   govspeak_locals[:disable_youtube_expansions] = local_assigns.fetch(:disable_youtube_expansions) if local_assigns.include?(:disable_youtube_expansions)
 %>
 <div class="gem-c-govspeak-html-publication">
-  <%= render 'govuk_publishing_components/components/govspeak', govspeak_locals %>
+  <%= render 'govuk_publishing_components/components/govspeak', govspeak_locals do %>
+    <%= yield %>
+  <% end %>
 </div>

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

@@ -1,4 +1,9 @@
 <% local_assigns[:logo_url] = image_url("govuk_publishing_components/govuk-logo.png") %>
+<% local_assigns[:image_placeholders] = [
+  image_url("govuk_publishing_components/govuk-schema-placeholder-1x1.png"),
+  image_url("govuk_publishing_components/govuk-schema-placeholder-4x3.png"),
+  image_url("govuk_publishing_components/govuk-schema-placeholder-16x9.png"),
+] %>
 <% page = GovukPublishingComponents::Presenters::Page.new(local_assigns) %>
 <% structured_data = GovukPublishingComponents::Presenters::SchemaOrg.new(page).structured_data %>
 

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

@@ -20,13 +20,18 @@ shared_accessibility_criteria:
   - link
 examples:
   basic_content:
+    data:
+      block: |
+        <h2>This is a title</h2>
+          <p>This is some body text with <a href=#>a link</a></p>
+  with_content:
     data:
       content: |
         <h2>This is a title</h2>
         <p>This is some body text with <a href=#>a link</a></p>
   heading_levels:
     data:
-      content: |
+      block: |
         <h2>This is a h2 title</h2>
         <h3>This is a h3 title</h3>
         <h4>This is a h4 title</h4>
@@ -34,7 +39,7 @@ examples:
         <h6>This is a h6 title</h6>
   lists:
     data:
-      content: |
+      block: |
         <h2>ordered list:</h2>
         <ol>
           <li>one</li>
@@ -49,7 +54,7 @@ examples:
         </ul>
   nested_lists:
     data:
-      content: |
+      block: |
         <h2>ordered list:</h2>
         <ol>
           <li>
@@ -72,7 +77,7 @@ examples:
         </ul>
   legislative_lists:
     data:
-      content: |
+      block: |
         <h2>ordered list:</h2>
         <ol class="legislative-list">
           <li>one</li>
@@ -81,7 +86,7 @@ examples:
         </ol>
   image_fractions:
     data:
-      content: |
+      block: |
         <h3 id="number---fractions-1">Number - fractions</h3>
 
         <p>Pupils should be taught to:</p>
@@ -127,18 +132,18 @@ examples:
         </div>
   text_fractions:
     data:
-      content: |
+      block: |
         <p>If an image is not available for a particular fraction, then we'll fallback to text based fraction using <code>sup</code>/<code>sub</code>, like this <span class="fraction"><sup>1</sup>&frasl;<sub>100</sub></span> example.</p>
   blockquote:
     data:
-      content: |
+      block: |
         <blockquote>
           <p>My quote</p>
           <p class="last-child">about things</p>
         </blockquote>
   tables:
     data:
-      content: |
+      block: |
         <table>
           <caption>A table with data</caption>
           <thead>
@@ -157,7 +162,7 @@ examples:
         </table>
   charts:
     data:
-      content: |
+      block: |
         <table class='js-barchart-table mc-auto-outdent'>
           <caption>A table with numerical data</caption>
           <tbody>
@@ -171,7 +176,7 @@ examples:
         </table>
   address:
     data:
-      content: |
+      block: |
         <div class="address">
           <div class="adr org fn">
             <p>
@@ -187,7 +192,7 @@ examples:
         <p>Addresses are generated when using the `$A` markdown pattern.</p>
   contact:
     data:
-      content: |
+      block: |
         <div class="contact" id="contact_1017">
           <div class="content">
             <h3>Media enquiries</h3>
@@ -206,7 +211,7 @@ examples:
         </div>
   contact_with_surrounding_text:
     data:
-      content: |
+      block: |
         <h2>This is a title</h2>
         <div class="contact" id="contact_1018">
           <div class="content">
@@ -243,7 +248,7 @@ examples:
         </div>
   footnotes:
     data:
-      content: |
+      block: |
         <p>This is a text with a footnote<sup id="fnref:1a"><a href="#fn:1a" class="footnote">1</a></sup>.</p>
 
         <div class="footnotes">
@@ -253,10 +258,10 @@ examples:
             </li>
           </ol>
         </div>
-  rtl_content:
+  rtl_block:
     data:
       direction: rtl
-      content: |
+      block: |
         <p>قال وزير الخارجية، ويليام هيغ:</p>
         <blockquote>
           <p>مع بدء هذا الشهر الفضيل أتمنى للمسلمين في أنحاء العالم - في آسيا وأفريقيا والشرق الأوسط وأوروبا وغيرها من مناطق العالم - شهر رمضان مبارك.</p>
@@ -276,27 +281,27 @@ examples:
         </ul>
   with_bold_unstyled:
     data:
-      content: |
+      block: |
         <p>This content has <strong>text in strong tags</strong>, but they are not styled as bold</p>
   with_rich_govspeak:
     data:
       rich_govspeak: true
-      content: |
+      block: |
         <p>This content uses rich govspeak and has <strong>text in strong tags</strong> that are styled as bold</p>
   with_youtube_embed:
     data:
-      content: |
+      block: |
         <p>This content has a YouTube video link, converted to an accessible embedded player by component JavaScript.</p>
         <p><a href="https://www.youtube.com/watch?v=y6hbrS3DheU">Operations: a developer's guide, by Anna Shipman</a></p>
   with_youtube_embed_disabled:
     data:
       disable_youtube_expansions: true
-      content: |
+      block: |
         <p>This content has a YouTube video link, where the govspeak expansion has been disabled</p>
         <p><a href="https://www.youtube.com/watch?v=y6hbrS3DheU">Operations: a developer's guide, by Anna Shipman</a></p>
   statistic_headlines:
     data:
-      content: |
+      block: |
         <aside class="stat-headline">
           <p><em>£6bn</em>
           Total Departmental Expenditure Limit (<abbr title="Departmental Expenditure Limit">DEL</abbr>) in financial year 2015 to 2016</p>
@@ -309,7 +314,7 @@ examples:
         </aside>
   specialist_content:
     data:
-      content: |
+      block: |
         <h2 id="bisphosphonates">Bisphosphonates</h2>
         <p>Bisphosphonates are used to treat osteoporosis, Paget’s disease, and as part of some cancer regimens, particularly for metastatic bone cancer and multiple myeloma. Individual bisphosphonates have different indications (see individual Summaries of Product Characteristics<sup id="fnref:1"><a href="#fn:1" class="footnote">1</a></sup>). The following bisphosphonates are available in the UK:</p>
 
@@ -381,14 +386,14 @@ examples:
         </div>
   inline_attachment:
     data:
-      content: |
+      block: |
         <p>testing my attachment <span class="inline-attachment" id="attachment_1399340">
           <a href="/government/uploads/system/uploads/attachment_data/file/498071/PHE_Payments_over__25k_Jun_15.csv">testing</a>
           (<span class="type"><abbr title="Comma-separated Values">CSV</abbr></span>, <span class="file-size">65.4KB</span>)</span> works in the middle of copy.
         </p>
   block_attachments:
     data:
-      content: |
+      block: |
         <section class="attachment embedded" id="attachment_1399345">
           <div class="attachment-thumb">
             <a aria-hidden="true" class="thumbnail" href="https://www.gov.uk/government/publications/minimum-wage-jobs-in-ashfield-local-authority-since-2009"><img alt="" src="https://assets.digital.cabinet-office.gov.uk/government/uploads/system/uploads/attachment_data/file/496127/thumbnail_LPC_FoI_09.12.15_NMW_jobs_Ashfield_LA.pdf.png"></a>
@@ -529,7 +534,7 @@ examples:
   block_attachment_rtl:
     data:
       direction: rtl
-      content: |
+      block: |
         <section class="attachment embedded" id="attachment_514218">
           <div class="attachment-thumb">
             <a aria-hidden="true" class="thumbnail" href="https://www.gov.uk/government/publications/future-of-food-and-farming.ar"><img alt="" src="https://assets-origin.integration.publishing.service.gov.uk/government/uploads/system/uploads/attachment_data/file/288236/thumbnail_11-924-future-of-food-and-farming-summary-arabic.pdf.png"></a>
@@ -554,7 +559,7 @@ examples:
         </section>
   example:
     data:
-      content: |
+      block: |
         <div class="example">
           <p>
             <strong>Example</strong>
@@ -567,13 +572,13 @@ examples:
         </div>
   call_to_action:
     data:
-      content: |
+      block: |
         <div class="call-to-action">
           <p>Call to action</p>
         </div>
   information_callout:
     data:
-      content: |
+      block: |
         <div class="application-notice info-notice">
           <p>
             If you drilled a tunnel straight through the Earth and jumped in, it would take
@@ -582,7 +587,7 @@ examples:
         </div>
   warning_callout:
     data:
-      content: |
+      block: |
         <div class="application-notice help-notice">
           <p>
             The water in the mouth of a blue whale weighs more than its body.
@@ -590,19 +595,19 @@ examples:
         </div>
   advisory:
     data:
-      content: |
+      block: |
         <h3 role="note" aria-label="Important" class="advisory">
           <span>This is a very important message or warning</span>
         </h3>
   form_download:
     data:
-      content: |
+      block: |
         <div class="form-download">
           <p><a href="http://example.com/" title="Example form" rel="external">An example form download link.</a></p>
         </div>
   steps:
     data:
-      content:
+      block:
         <ol class="steps">
           <li>
             <p>Add numbers.</p>
@@ -623,7 +628,7 @@ examples:
       * [https://gov.uk/individual-savings-accounts](https://gov.uk/individual-savings-accounts)
       * [https://gov.uk/corporation-tax-rates](https://gov.uk/corporation-tax-rates)
     data:
-      content: |
+      block: |
         <div class="highlight-answer">
           <p>The VAT rate is <em>20%</em></p>
         </div>
@@ -635,19 +640,19 @@ examples:
         </div>
   place:
     data:
-      content: |
+      block: |
         <div class="place">
           <p>This is a place</p>
         </div>
   summary:
     data:
-      content: |
+      block: |
         <div class="summary">
           <p>This is a summary</p>
         </div>
   button:
     data:
-      content: |
+      block: |
         <a href="#" class="button button-start" role="button">
           Start now
         </a>

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

@@ -11,26 +11,30 @@ shared_accessibility_criteria:
   - link
 examples:
   basic_content:
+    data:
+      block: |
+        <p>This is a Budget that puts security first. It ensures economic security for working people by putting the public finances in order and setting out a bold plan for a more productive, balanced economy.</p>
+  with_content:
     data:
       content: |
         <p>This is a Budget that puts security first. It ensures economic security for working people by putting the public finances in order and setting out a bold plan for a more productive, balanced economy.</p>
   heading_level_2:
     data:
-      content: |
+      block: |
         <h2>
           <span class="number">1. </span>Executive summary
         </h2>
         <p>This is a Budget that puts security first. It ensures economic security for working people by putting the public finances in order and setting out a bold plan for a more productive, balanced economy.</p>
   heading_level_3:
     data:
-      content: |
+      block: |
         <h3>
           <span class="number">1.1 </span>Fixing the public finances and running a surplus
         </h3>
         <p>The government’s long-term economic plan has laid the foundations for a stronger economy, and the UK’s recovery is now well established. The labour market remains strong, and in the 3 months to April 2015, employment was around record levels at 31.1 million.</p>
   numbered_content:
     data:
-      content: |
+      block: |
         <h2 id="executive-summary">
           <span class="number">1. </span>Executive summary
         </h2>
@@ -53,7 +57,7 @@ examples:
   right_to_left:
     data:
       direction: 'rtl'
-      content: |
+      block: |
         <h2>
           <span class="number">1. </span>Executive summary
         </h2>
@@ -75,7 +79,7 @@ examples:
         <p>The government’s long‑term economic plan has secured the recovery. The government’s fiscal responsibility has allowed monetary activism to support demand in the economy alongside repair of the financial sector. This has been supported by supply-side reform to deliver sustainable increases in standards of living.</p>
   financial_table:
     data:
-      content: |
+      block: |
         <table class="financial-data">
           <caption>Table 1.6: Total Managed Expenditure (as produced by the <a href="https://alphagov.github.io/table-editor/financial-tables.html">financial table editor</a>)</caption>
           <thead>

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

@@ -3,6 +3,8 @@ description: A text heading
 body: |
   A versatile heading tag component, including options for different heading levels and font sizes.
 
+  This is a `h2` by default.
+
   Real world examples:
 
   - [Publication](/government/publications/recognising-the-terrorist-threat)

data/config/initializers/assets.rb

@@ -9,4 +9,7 @@ Rails.application.config.assets.precompile += %w(
   govuk_publishing_components/icon-pointer.png
   govuk_publishing_components/icon-pointer-2x.png
   govuk_publishing_components/govuk-logo.png
+  govuk_publishing_components/govuk-schema-placeholder-1x1.png
+  govuk_publishing_components/govuk-schema-placeholder-4x3.png
+  govuk_publishing_components/govuk-schema-placeholder-16x9.png
 )

data/lib/govuk_publishing_components/presenters/heading_helper.rb

@@ -4,7 +4,7 @@ module GovukPublishingComponents
       attr_reader :heading_tag, :id, :classes
 
       def initialize(options)
-        @heading_tag = "h1"
+        @heading_tag = "h2"
         @heading_tag = "h#{options[:heading_level]}" if [1, 2, 3, 4, 5, 6].include? options[:heading_level]
         @id = options[:id]
 

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

@@ -47,12 +47,8 @@ module GovukPublishingComponents
       end
 
       def image_schema
-        return {} unless page.has_image?
-
         {
-          "image" => [
-            page.image_url
-          ]
+          "image" => page.has_image? ? [page.image_url] : page.image_placeholders
         }
       end
 

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

@@ -39,6 +39,10 @@ module GovukPublishingComponents
         content_item.dig("details", "image", "alt_text")
       end
 
+      def image_placeholders
+        local_assigns[:image_placeholders]
+      end
+
       def content_item
         local_assigns[:content_item]
       end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '9.1.0'.freeze
+  VERSION = '9.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 9.1.1
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -303,6 +303,9 @@ files:
 - app/assets/config/govuk_publishing_components_manifest.js
 - app/assets/images/govuk_publishing_components/feed-icon-black.png
 - app/assets/images/govuk_publishing_components/govuk-logo.png
+- app/assets/images/govuk_publishing_components/govuk-schema-placeholder-16x9.png
+- app/assets/images/govuk_publishing_components/govuk-schema-placeholder-1x1.png
+- app/assets/images/govuk_publishing_components/govuk-schema-placeholder-4x3.png
 - app/assets/images/govuk_publishing_components/icon-pointer-2x.png
 - app/assets/images/govuk_publishing_components/icon-pointer.png
 - app/assets/images/govuk_publishing_components/mail-icon-x2.png