govuk_publishing_components 10.0.0 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eedc7db41f2d178ff05e1905a8eb380dd37140a8a0ed8c8e35adce4843820dcd
-  data.tar.gz: 02b05d72c20971d88bff48a36c42a910e8bf9882c4e9a88d827a9d4a5b399ae0
+  metadata.gz: 79208a2aa5fe09127a376f0b1dfbe4a703c03c738b06cee07b04b0a41c2e5527
+  data.tar.gz: 3a8b99c01ab4b32e6bf18beddfaf798043b83b967d1d93d6be3775ae5932d0e7
 SHA512:
-  metadata.gz: 61fd9a082433a65c367b1e9f56b50d417bfcf1b1479e0830c2be22d7b63af18e91b923058be1d057e104a5bd7587b1e4d59a5887325f116712fa714729431341
-  data.tar.gz: 97c87c351d487aec51b61d9a9e2f6a696d21c6bf219ef94340be088d6f5e368b1692bcab27ecf6e204208d108188c3c7c46fd74549a13c679ee3012375c79e3b
+  metadata.gz: 5602b8c9c50df8e12d28bba3a5ee08a1141cdc67892700745610ac452b8380a0310c51a1b395f91e7273d9d7b7913cfd38ef448a2a229e3e8ea2dcea125ba9ea
+  data.tar.gz: c3dd7d269ed451de61be94db9667121ab96211de00497f197050d9f4d8a25ba21775a4824bd0eea30c83764d5da8273aab87903844fcb2bc554ceb132546c4e5

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

@@ -5,6 +5,7 @@ module GovukPublishingComponents
 
       def initialize(page)
         @page = page
+        @pages = {}
       end
 
       def structured_data
@@ -69,20 +70,21 @@ module GovukPublishingComponents
       end
 
       def is_part_of
-        return {} unless linked_step_by_steps.any?
+        return {} unless step_by_step_schemas.any? || document_collections.any?
+
         {
-          "isPartOf" => step_by_step_schemas
+          "isPartOf" => document_collections + step_by_step_schemas
         }
       end
 
-      def linked_step_by_steps
+      def step_by_step_schemas
         # 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
+        @step_by_steps ||= fetch_step_by_step_schemas
       end
 
-      def step_by_step_schemas
-        linked_step_by_steps.map do |step_by_step|
+      def fetch_step_by_step_schemas
+        page.content_item.dig("links", "part_of_step_navs").to_a.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
 
@@ -100,18 +102,23 @@ module GovukPublishingComponents
       end
 
       def has_part
-        return {} unless collection_pages.any?
+        return {} unless collection_pages("documents").any?
         {
-            "hasPart" => collection_pages.map { |document| HasPartSchema.new(document).structured_data }
+            "hasPart" => collection_pages("documents").map { |document| HasPartSchema.new(document).structured_data }
         }
       end
 
-      def collection_pages
-        @pages ||= fetch_collection_pages
+      def document_collections
+        @document_collections ||= collection_pages("document_collections")
+                                      .map { |document| IsPartOfSchema.new(document).structured_data }
+      end
+
+      def collection_pages(linked_type)
+        @pages[linked_type] ||= fetch_collection_pages(linked_type)
       end
 
-      def fetch_collection_pages
-        page.content_item.dig("links", "documents").to_a.map { |document| document["web_url"] }
+      def fetch_collection_pages(linked_type)
+        page.content_item.dig("links", linked_type).to_a.map { |document| document["web_url"] }
       end
 
       def about

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

@@ -0,0 +1,18 @@
+module GovukPublishingComponents
+  module Presenters
+    class IsPartOfSchema
+      def initialize(is_part_of_url)
+        @is_part_of_url = is_part_of_url
+      end
+
+      def structured_data
+        # http://schema.org/isPartOf - minimal
+        {
+            "@context" => "http://schema.org",
+            "@type" => "CreativeWork",
+            "sameAs" => @is_part_of_url
+        }
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/schema_org.rb

@@ -2,6 +2,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/how_to_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'
 require 'govuk_publishing_components/presenters/machine_readable/organisation_schema'
 require 'govuk_publishing_components/presenters/machine_readable/person_schema'

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '10.0.0'.freeze
+  VERSION = '10.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 10.0.0
+  version: 10.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
@@ -590,6 +590,7 @@ files:
 - lib/govuk_publishing_components/presenters/machine_readable/article_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/has_part_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/how_to_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
 - lib/govuk_publishing_components/presenters/machine_readable/organisation_schema.rb
 - lib/govuk_publishing_components/presenters/machine_readable/page.rb