govuk_publishing_components 8.0.1 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a807f46b56a43e9a79163851845688d4d075932e761aac875b071eea0400b61c
-  data.tar.gz: 3e611522cc50824a805b5b121ea175015d29ef040600fd042eb6fbf73f65d352
+  metadata.gz: 575de4ef4fef97453f60afc3d3ab388997efd80f10d76c9b7ee5860ca6423278
+  data.tar.gz: 2a418743b25fa77ef0d553025f0d757642d4d2cf69ad6817402e77087f638894
 SHA512:
-  metadata.gz: dd250b6fff1108627b1f635243c61f348a48d73ef97882947085fb83f9720377f86dd7aedf921ebb025df4174f54a60ed75dca59959f8d4ee0dc40db5d703865
-  data.tar.gz: cce7f2a94fce3f69a001bcc05c91e9932d7aa744e01388a7304cb0ccd31a1e3563386ff818bc06cdacdeb128327972d6928183cc7c6b32c5068f8c8a0325c681
+  metadata.gz: 619fc4f95918f3f296d8981e9cbbb7ed3bccc7b56faa402e5b844c3b1057044ca5274b6ca7b5e684adc091e86f8a5a416eb50a4d86cb90e52f48b7f554b49f4b
+  data.tar.gz: a46ec8e3951691469c222b91047967ee2c2822367ba04aae67dea3b68b34fe7d6b0cb65f0b6f3ce91db50c77cd1266eee94624e36b429f480c7fe82c7ee3392d

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

@@ -0,0 +1,5 @@
+<% structured_data = GovukPublishingComponents::Presenters::SchemaOrg.new(local_assigns).structured_data %>
+
+<script type="application/ld+json">
+  <%= raw structured_data.to_json %>
+</script>

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

@@ -0,0 +1,33 @@
+name: Machine readable metadata
+description: Generates schema.org JSON-LD for use by search engines
+body: |
+  This component doesn't output anything visible. It generates "structured data"
+  in JSON-LD format, with [schema.org](http://schema.org) schemas.
+accessibility_criteria: |
+  The HTML should not be visible.
+display_html: true
+examples:
+  default:
+    data:
+      content_item:
+        title: "A title"
+        base_path: "/foo"
+        details: {}
+      schema: :article
+  with_canonical_url:
+    data:
+      content_item:
+        title: "A title"
+        base_path: "/foo"
+        details: {}
+      schema: :article
+      canonical_url: "https://www.gov.uk/foreign-travel-advice/andorra/health"
+
+  with_body:
+    data:
+      content_item:
+        title: "A title"
+        base_path: "/foo"
+        details: {}
+      schema: :article
+      body: "Some other body"

data/lib/govuk_publishing_components.rb

@@ -15,6 +15,7 @@ require "govuk_publishing_components/presenters/curated_taxonomy_sidebar_links"
 require "govuk_publishing_components/presenters/content_item"
 require "govuk_publishing_components/presenters/translation_nav_helper"
 require "govuk_publishing_components/presenters/subscription_links_helper"
+require "govuk_publishing_components/presenters/schema_org"
 require "govuk_publishing_components/presenters/heading_helper"
 
 require "govuk_publishing_components/app_helpers/taxon_breadcrumbs"

data/lib/govuk_publishing_components/presenters/schema_org.rb

@@ -0,0 +1,113 @@
+module GovukPublishingComponents
+  module Presenters
+    class SchemaOrg
+      def initialize(local_assigns)
+        @local_assigns = local_assigns
+      end
+
+      def structured_data
+        if @local_assigns.fetch(:schema) == :article
+          ArticleSchema.new(@local_assigns).structured_data
+        elsif @local_assigns.fetch(:schema) == :news_article
+          NewsArticleSchema.new(@local_assigns).structured_data
+        else
+          raise "#{@local_assigns.fetch(:schema)} is not supported"
+        end
+      end
+
+      class NewsArticleSchema
+        def initialize(local_assigns)
+          @local_assigns = local_assigns
+        end
+
+        def structured_data
+          # http://schema.org/NewsArticle
+          data = ArticleSchema.new(@local_assigns).structured_data
+          data["@type"] = "NewsArticle"
+          data
+        end
+      end
+
+      class ArticleSchema
+        attr_reader :content_item, :canonical_url, :local_assigns
+
+        def initialize(local_assigns)
+          @local_assigns = local_assigns
+
+          @content_item = local_assigns[:content_item]
+          @canonical_url = local_assigns[:canonical_url]
+          @custom_body = local_assigns[:body]
+        end
+
+        def structured_data
+          # http://schema.org/Article
+          {
+            "@context" => "http://schema.org",
+            "@type" => "Article",
+            "mainEntityOfPage" => {
+              "@type" => "WebPage",
+              "@id" => canonical_url || page_url_from_content_item,
+            },
+            "headline" => local_assigns[:title] || content_item["title"],
+            "datePublished" => content_item["first_published_at"],
+            "dateModified" => content_item["public_updated_at"],
+            "description" => content_item["description"],
+            "publisher" => {
+              "@type" => "Organization",
+              "name" => "GOV.UK",
+              "url" => "https://www.gov.uk",
+            }
+          }.merge(image_schema).merge(author_schema).merge(body)
+        end
+
+      private
+
+        attr_reader :presenter
+
+        # Not all formats have a `body` - some have their content split over
+        # multiple fields. In this case we'll skip the `articleBody` field
+        def body
+          return {} unless @custom_body || content_item["details"]["body"]
+
+          {
+            "articleBody" => @custom_body || content_item["details"]["body"]
+          }
+        end
+
+        def image_schema
+          return {} unless image
+
+          {
+            "image" => [
+              image["url"],
+            ]
+          }
+        end
+
+        def author_schema
+          return {} unless publishing_organisation
+
+          {
+            "author" => {
+              "@type" => "Organization",
+              "name" => publishing_organisation["title"],
+              "url" => Plek.current.website_root + publishing_organisation["base_path"],
+            }
+          }
+        end
+
+        def publishing_organisation
+          content_item.dig("links", "primary_publishing_organisation").to_a.first
+        end
+
+        def page_url_from_content_item
+          Plek.current.website_root + content_item["base_path"]
+        end
+
+        def image
+          content_item.dig("details", "image")
+        end
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '8.0.1'.freeze
+  VERSION = '8.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 8.0.1
+  version: 8.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-15 00:00:00.000000000 Z
+date: 2018-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -385,6 +385,7 @@ files:
 - app/views/govuk_publishing_components/components/_input.html.erb
 - app/views/govuk_publishing_components/components/_inverse_header.html.erb
 - app/views/govuk_publishing_components/components/_label.html.erb
+- app/views/govuk_publishing_components/components/_machine_readable_metadata.html.erb
 - app/views/govuk_publishing_components/components/_meta_tags.html.erb
 - app/views/govuk_publishing_components/components/_radio.html.erb
 - app/views/govuk_publishing_components/components/_related_navigation.html.erb
@@ -410,6 +411,7 @@ files:
 - app/views/govuk_publishing_components/components/docs/input.yml
 - app/views/govuk_publishing_components/components/docs/inverse_header.yml
 - app/views/govuk_publishing_components/components/docs/label.yml
+- app/views/govuk_publishing_components/components/docs/machine_readable_metadata.yml
 - app/views/govuk_publishing_components/components/docs/meta_tags.yml
 - app/views/govuk_publishing_components/components/docs/radio.yml
 - app/views/govuk_publishing_components/components/docs/related_navigation.yml
@@ -450,6 +452,7 @@ files:
 - lib/govuk_publishing_components/presenters/page_with_step_by_step_navigation.rb
 - lib/govuk_publishing_components/presenters/related_navigation_helper.rb
 - lib/govuk_publishing_components/presenters/rummager_taxonomy_sidebar_links.rb
+- lib/govuk_publishing_components/presenters/schema_org.rb
 - lib/govuk_publishing_components/presenters/services.rb
 - lib/govuk_publishing_components/presenters/step_by_step_nav_helper.rb
 - lib/govuk_publishing_components/presenters/subscription_links_helper.rb