govuk_publishing_components 20.5.2 → 21.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38f751bcc662ac5194c82e962eddca8edd4b0fa27c1af17f1cb59dc2d9c19e4a
-  data.tar.gz: 4c87626b816dd2bebc14ab205f8cb5752c6010b07ebc1e08dd80b7e4c9465039
+  metadata.gz: 2ef4a6044ee14caf38ad63acffb0762e4cebc06fa412beeff1df1e07a6c021bc
+  data.tar.gz: a57304c3266b108045c6afd4305e972ba1441e7f7150b24796c585c55c5fd802
 SHA512:
-  metadata.gz: b53285bb7fe7369a290e2cb0d40ca82edf0e54c5131dbec6611b14e548026f34f1baf39cdd2b7dc20b3a60f6a122cae9eae202ecca70411d6039038ae6ac64b6
-  data.tar.gz: 502a6b3a0650938848b4cd46cb16f6de1e43157e215073297578ce1400b21533e4e735ca6ac0a983a53ac091216fc7b47a3031383d07a969693a62488dac5260
+  metadata.gz: 9a79245895e9ad222d86d6977d4c0a08db90a4a034c1650ef84d86919a051fbcec76fb40f780f249b0feaa4108f8b05609eccf5d188f9aae28b345bd78791a90
+  data.tar.gz: 7da229230ec92c542edebca0921fd85bf234c126c883fb89c0005d24e12ed4d0aade2a9c507722edf59248a077b9c408abb54ce5b12e61511a36c14abe7ef5ef

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

@@ -4,6 +4,7 @@
   image_url("govuk_publishing_components/govuk-schema-placeholder-4x3.png"),
   image_url("govuk_publishing_components/govuk-schema-placeholder-16x9.png"),
 ] %>
+<% local_assigns[:request_path] = request.path %>
 <% page = GovukPublishingComponents::Presenters::Page.new(local_assigns) %>
 <% structured_data = GovukPublishingComponents::Presenters::SchemaOrg.new(page).structured_data %>
 

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

@@ -54,6 +54,12 @@ examples:
             - slug: treating-injuries
               body: Get to know a good blacksmith
               title: Treating injuries
+      body: >
+        <p>Training scaly beasts can be tricky</p>
+        <h2 id='preparation'>Preparation</h2>
+        <p>Prepare by meditating and writing a will</p>
+        <h2 id='afterwards'>Afterwards<h2>
+        <p>Your next of kin may need a strong stomach</p>
       schema: :faq
       canonical_url: https://www.gov.uk/how-to-train-your-dragon
   person_schema:

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

@@ -19,36 +19,82 @@ module GovukPublishingComponents
 
       def main_entity
         {
-          "mainEntity" => questions_and_answers
+          "mainEntity" => questions_and_answers_markup
         }
       end
 
-      def questions_and_answers
-        page.parts.each_with_index.map do |part, index|
-          part_url = part_url(part, index)
+      def questions_and_answers_markup
+        question_and_answers(page.body).map do |question, value|
+          q_and_a_url = section_url(value[:anchor])
 
           {
             "@type" => "Question",
-            "name" => part['title'],
-            "url" => part_url,
+            "name" => question,
+            "url" => q_and_a_url,
             "acceptedAnswer" => {
               "@type" => "Answer",
-              "url" => part_url,
-              "text" => part['body']
+              "url" => q_and_a_url,
+              "text" => value[:answer]
             }
           }
         end
       end
 
-      def part_url(part, index)
-        if index.zero?
-          guide_url
-        else
-          guide_url + "/" + part["slug"]
+      # Generates a hash of questions and associated information:
+      # - question: the text in the h2 tag preceding other markup. Questions are
+      #             used to key the hash. "Summary" is set as the default, as
+      #             there is often a preamble in guides before any h2 is set.
+      #
+      # - :answer: the markup that is not an h2 tag. It is associated with the
+      #            preceding h2 header.
+      #
+      # - :anchor: the id of the h2 (autogenerated by the markdown converter).
+      #            This is used to build links directly to the section in question
+      def question_and_answers(html)
+        doc = Nokogiri::HTML(html)
+
+        question = "Summary"
+
+        # rubocop:disable Style/IfInsideElse
+        doc.xpath("html/body").children.each_with_object({}) do |element, q_and_as|
+          if question_element?(element)
+            question = element.text
+            q_and_as[question] = { anchor: element["id"] }
+          else
+            if question_hash_is_unset?(q_and_as, question)
+              q_and_as[question] = { answer: element.to_s }
+            elsif answer_is_unset?(q_and_as, question)
+              q_and_as[question][:answer] = element.to_s
+            else
+              q_and_as[question][:answer] << element.to_s
+            end
+          end
         end
+        # rubocop:enable Style/IfInsideElse
+      end
+
+      def question_hash_is_unset?(q_and_as, question)
+        q_and_as[question].nil?
+      end
+
+      def answer_is_unset?(q_and_as, question)
+        !q_and_as[question].has_key?(:answer)
+      end
+
+      # we use H2 tags as the "question" and the html between them as the "answer"
+      QUESTION_TAG = "h2".freeze
+
+      def question_element?(element)
+        element.name == QUESTION_TAG
+      end
+
+      def section_url(anchor)
+        return page_url + "#" + anchor if anchor.present?
+
+        page_url
       end
 
-      def guide_url
+      def page_url
         Plek.new.website_root + page.base_path
       end
     end

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

@@ -59,8 +59,8 @@ module GovukPublishingComponents
         local_assigns[:logo_url]
       end
 
-      def parts
-        content_item.dig("details", "parts") || []
+      def requested_path
+        local_assigns[:request_path]
       end
     end
   end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '20.5.2'.freeze
+  VERSION = '21.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 20.5.2
+  version: 21.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-17 00:00:00.000000000 Z
+date: 2019-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters