govuk_publishing_components 20.0.0 → 20.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 990b02a0baa723fb517e965dac760988a241c25961e0aa967d975c706f2b84e2
-  data.tar.gz: d49b26ffa0222193f227a35ca102e02eebba1274627eae1af13c801ad2a9b130
+  metadata.gz: 70e1e7a68a80183757a98e24a3a4c9c62cb7b915574e99213f52bbe7363368a2
+  data.tar.gz: 7bab5f6f55fe885de0fe39090d419c5d3816f8bf162b1ae9b9cb739a07465ced
 SHA512:
-  metadata.gz: 7c6405ee37d9f4b6b6a1b62c48fc246c03f7ab4a6df1018b6f1d899850ded84752a1b40ff39002dbcd7509e3a867c26883dacd16d1659d319d77b105c6deff29
-  data.tar.gz: 1899063ce48abb43bc7c34d4d93e2af84d11c3679fb06bc8111c5afe35aef58d79df7200245d579c623b47bff73ae8be7729019ea7ba677e770b8bd3683dbaa9
+  metadata.gz: 93bebe89425509dfb139678e9031cba30fcbae81c332c7942212ba020289704546551ec10ec470f57e072c7f31803f4ea03c3934797b73fc50f6eb34c055e580
+  data.tar.gz: 16f8ea19a174281ca1c19f9b135c439e5b64c0dfd3dfd372b5761beccd3f3d73ebce5342dc2054435b5e6827355bc96098a77b3c34bfc8af07d38afef638c534

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

@@ -41,6 +41,21 @@ examples:
         details: {}
       schema: :article
       body: "Some other body"
+  a_guide:
+    data:
+      content_item:
+        title: "How to train your dragon"
+        base_path: "/how-to-train-your-dragon"
+        details:
+          parts:
+            - slug: overview
+              body: A thing on how to train scaly beasts
+              title: Overview
+            - slug: treating-injuries
+              body: Get to know a good blacksmith
+              title: Treating injuries
+      schema: :faq
+      canonical_url: https://www.gov.uk/how-to-train-your-dragon
   person_schema:
     data:
       content_item:

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

@@ -0,0 +1,52 @@
+module GovukPublishingComponents
+  module Presenters
+    class FaqPageSchema
+      attr_reader :page
+
+      def initialize(page)
+        @page = page
+      end
+
+      def structured_data
+        # http://schema.org/FAQPage
+        data = CreativeWorkSchema.new(@page).structured_data
+          .merge(main_entity)
+        data["@type"] = "FAQPage"
+        data
+      end
+
+    private
+
+      def main_entity
+        {
+          "mainEntity" => questions_and_answers
+        }
+      end
+
+      def questions_and_answers
+        page.parts.each_with_index.map do |part, index|
+          part_url = part_url(part, index)
+
+          {
+            "@type" => "Question",
+            "name" => part['title'],
+            "url" => part_url,
+            "acceptedAnswer" => {
+              "@type" => "Answer",
+              "url" => part_url,
+              "text" => part['body']
+            }
+          }
+        end
+      end
+
+      def part_url(part, index)
+        if index.zero?
+          page.canonical_url
+        else
+          page.canonical_url + "/" + part["slug"]
+        end
+      end
+    end
+  end
+end

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

@@ -58,6 +58,10 @@ module GovukPublishingComponents
       def logo_url
         local_assigns[:logo_url]
       end
+
+      def parts
+        content_item.dig("details", "parts") || []
+      end
     end
   end
 end

data/lib/govuk_publishing_components/presenters/schema_org.rb

@@ -1,6 +1,7 @@
 require 'govuk_publishing_components/presenters/machine_readable/page'
 require 'govuk_publishing_components/presenters/machine_readable/article_schema'
 require 'govuk_publishing_components/presenters/machine_readable/creative_work_schema'
+require 'govuk_publishing_components/presenters/machine_readable/faq_page_schema'
 require 'govuk_publishing_components/presenters/machine_readable/has_part_schema'
 require 'govuk_publishing_components/presenters/machine_readable/is_part_of_schema'
 require 'govuk_publishing_components/presenters/machine_readable/news_article_schema'
@@ -19,7 +20,9 @@ module GovukPublishingComponents
       end
 
       def structured_data
-        if page.schema == :article
+        if page.schema == :faq
+          FaqPageSchema.new(page).structured_data
+        elsif page.schema == :article
           ArticleSchema.new(page).structured_data
         elsif page.schema == :news_article
           NewsArticleSchema.new(page).structured_data

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '20.0.0'.freeze
+  VERSION = '20.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 20.0.0
+  version: 20.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -667,6 +667,7 @@ files:
 - 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/creative_work_schema.rb
+- lib/govuk_publishing_components/presenters/machine_readable/faq_page_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/has_part_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/is_part_of_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/news_article_schema.rb