govuk_tech_docs 2.0.13 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35c96cfb5a9198c31ad6a4e4d4a3676299c938089127b1c2a564d2401c50ac10
-  data.tar.gz: 7ea84b4a4c0601a8c291020f538817b4d7dd7503aa57c22124e2dedf8deb3f34
+  metadata.gz: e6eb13261f7f9ed89665a78f4a39b41936486bbbb945de36818908d703f078cd
+  data.tar.gz: b968b91fe10b4075ed1544d7a98e8f4257401464f138c790ee1290d597a1e018
 SHA512:
-  metadata.gz: 3b906c3c277e8f1a5a923c7e05a57491b801109d61d8bda3f3ab393905eff5b39297663ce856ec06735703df5bc1a2389be39948e6b23f633657cc6744226233
-  data.tar.gz: 0ffe6a62bed3f6f8e32c4a087fb3d1a7fb617ff1867e27d3d99f20c08e098de53230885e4dcd438348347596368366212bf17a81042528e5767abe5baa6300d0
+  metadata.gz: cdbe93545cd55d9b8ae9d9d2490c08e9e55bccceb5653b9d5ab680ce141b3238391d12949b50df6b52821847e8902891f6d1c5ed76417b7f6dbe035735b92702
+  data.tar.gz: 1becd936b596332a278fd5895f6f37ad67356b862bdb33bd5df6d1aa49f441bdfd2a2b94cd9f4bb75d15fbc54c94568a0be12629ecefbd1809ed7013aef67c81

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## Unreleased
+
+## 2.1.0
+
+### New features
+
+#### Exclude pages from search engine results
+
+You can now exclude a page from search engine results by including `prevent_indexing: true` in the page's frontmatter.
+
+This was added in [pull request #192: Fixes and improvements to meta tags](https://github.com/alphagov/tech-docs-gem/pull/192).
+
+### Fixes
+
+We’ve made fixes in the following pull requests:
+
+- [#192: Fixes and improvements to meta tags](https://github.com/alphagov/tech-docs-gem/pull/192)
+
 ## 2.0.13
 
 - [Pull request #189: Update orange code highlight colour to meet minimum AA colour contrast ratio criterion](https://github.com/alphagov/tech-docs-gem/pull/189)

data/example/source/index.html.md.erb

@@ -1,5 +1,6 @@
 ---
 title: GOV.UK Documentation Example
+description: Example of a documentation homepage
 old_paths:
  - /something/old-as-well.html
 ---

data/example/source/prevent-index-page.html.md

@@ -0,0 +1,10 @@
+---
+title: Un-indexed Page
+prevent_indexing: true
+hide_in_navigation: true
+---
+
+# Un-indexed page
+
+This page should not be indexed by search engines, because it contains a 
+`<meta name="robots" content="noindex">` tag.

data/lib/govuk_tech_docs/meta_tags.rb

@@ -8,12 +8,8 @@ module GovukTechDocs
     def tags
       all_tags = {
         "description" => page_description,
-        "og:description" => page_description,
-        "og:image" => page_image,
-        "og:site_name" => site_name,
-        "og:title" => page_title,
-        "og:type" => "object",
-        "og:url" => canonical_url,
+        "google-site-verification" => google_site_verification,
+        "robots" => robots,
         "twitter:card" => "summary",
         "twitter:domain" => URI.parse(host).host,
         "twitter:image" => page_image,
@@ -24,6 +20,21 @@ module GovukTechDocs
       Hash[all_tags.select { |_k, v| v }]
     end
 
+    # OpenGraph uses the non-standard property attribute instead of name, so we
+    # return these separately so we can output them correctly.
+    def opengraph_tags
+      all_opengraph_tags = {
+        "og:description" => page_description,
+        "og:image" => page_image,
+        "og:site_name" => site_name,
+        "og:title" => page_title,
+        "og:type" => "object",
+        "og:url" => canonical_url,
+      }
+
+      Hash[all_opengraph_tags.select { |_k, v| v }]
+    end
+
     def browser_title
       [page_title, site_name].select(&:present?).uniq.join(" - ")
     end
@@ -45,11 +56,19 @@ module GovukTechDocs
     end
 
     def page_description
-      locals[:description] || frontmatter.description
+      locals[:description] || frontmatter[:description]
     end
 
     def page_title
-      locals[:title] || frontmatter.title
+      locals[:title] || frontmatter[:title]
+    end
+
+    def robots
+      "noindex" if config[:tech_docs][:prevent_indexing] || frontmatter[:prevent_indexing]
+    end
+
+    def google_site_verification
+      config[:tech_docs][:google_site_verification]
     end
 
     def host

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "2.0.13".freeze
+  VERSION = "2.1.0".freeze
 end

data/lib/source/layouts/core.erb

@@ -4,9 +4,6 @@
     <meta content="IE=edge" http-equiv="X-UA-Compatible">
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
-    <% if config[:tech_docs][:prevent_indexing] %>
-      <meta name="robots" content="noindex">
-    <% end %>
 
     <title><%= meta_tags.browser_title %></title>
 
@@ -14,11 +11,11 @@
 
     <link rel="canonical" href="<%= meta_tags.canonical_url %>">
 
-    <% if config[:tech_docs][:google_site_verification] %>
-      <meta name="google-site-verification" content="<%= config[:tech_docs][:google_site_verification] %>" />
+    <% meta_tags.tags.each do |name, content| %>
+      <%= tag :meta, name: name, content: content %>
     <% end %>
 
-    <% meta_tags.tags.each do |property, content| %>
+    <% meta_tags.opengraph_tags.each do |property, content| %>
       <%= tag :meta, property: property, content: content %>
     <% end %>
 

data/package-lock.json

@@ -1108,9 +1108,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A==",
+      "version": "4.17.19",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.19.tgz",
+      "integrity": "sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ==",
       "dev": true
     },
     "loose-envify": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 2.0.13
+  version: 2.1.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -363,6 +363,7 @@ files:
 - example/source/nested-page/index.html.md
 - example/source/not-expired-page.html.md
 - example/source/pets.yml
+- example/source/prevent-index-page.html.md
 - example/source/stylesheets/print.css.scss
 - example/source/stylesheets/screen-old-ie.css.scss
 - example/source/stylesheets/screen.css.scss