govuk_publishing_components 8.1.0 → 8.2.0

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

@@ -0,0 +1,63 @@
+name: Page title
+description: A page title with optional context label
+body: |
+  This contains an optional parameter for average title length. The two valid
+  values for this parameter are 'medium' or 'long'. Medium titles are titles
+  where the average is around 30 characters or less. Long titles would have
+  an average length of nearer 50 characters or more.
+
+  On average the titles on government bits of content are 50 characters. The
+  average for bits of general guidance are nearer 27 characters long.
+accessibility_criteria: |
+  The page title must:
+
+  - be part of a correct heading structure for a page
+  - be semantically represented as a heading
+  - convey the heading level
+shared_accessibility_criteria:
+  - link
+examples:
+  default:
+    data:
+      title: My page title
+  with_context:
+    data:
+      context: Publication
+      title: My page title
+  with_context_link:
+    description: |
+      It’s unclear if links in the context of a title are useful and are being clicked by users. Data attributes are included to track this behaviour.
+
+      Context links are used on [topic pages](https://www.gov.uk/topic/business-tax/vat) where there is also a breadcrumb.
+    data:
+      context:
+        text: Publication
+        href: '/link'
+        data:
+          some_tracking_parameter: 'tracking-param'
+      title: My page title
+  long_title_with_context:
+    data:
+      context: Publication
+      title: My page title which is often really long and verbose and has lots of extra words it doesn't need
+      average_title_length: long
+  in_html_publication:
+    description: Page titles are used in HTML Publications ([see example](https://www.gov.uk/government/publications/fees-for-civil-and-family-courts/court-fees-for-the-high-court-county-court-and-family-court))
+    data:
+      context: Publication
+      title: HTML publication page title
+      inverse: true
+      margin_bottom: 0
+    context:
+      dark_background: true
+  in_html_publication_with_context_link:
+    description: Page titles are used in HTML Publications ([see example](https://www.gov.uk/government/publications/fees-for-civil-and-family-courts/court-fees-for-the-high-court-county-court-and-family-court))
+    data:
+      context:
+        text: Publication
+        href: '/link'
+      title: HTML publication page title
+      inverse: true
+      margin_bottom: 0
+    context:
+      dark_background: true

data/lib/govuk_publishing_components.rb

@@ -14,6 +14,7 @@ require "govuk_publishing_components/presenters/rummager_taxonomy_sidebar_links"
 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/sanitisation"
 require "govuk_publishing_components/presenters/subscription_links_helper"
 require "govuk_publishing_components/presenters/schema_org"
 require "govuk_publishing_components/presenters/heading_helper"

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

@@ -0,0 +1,72 @@
+module GovukPublishingComponents
+  module Presenters
+    class ArticleSchema
+      attr_reader :page
+
+      def initialize(page)
+        @page = page
+      end
+
+      def structured_data
+        # http://schema.org/Article
+        {
+          "@context" => "http://schema.org",
+          "@type" => "Article",
+          "mainEntityOfPage" => {
+            "@type" => "WebPage",
+            "@id" => page.canonical_url,
+          },
+          "headline" => page.title,
+          "datePublished" => page.content_item["first_published_at"],
+          "dateModified" => page.content_item["public_updated_at"],
+          "description" => page.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 page.body
+
+        {
+          "articleBody" => page.body
+        }
+      end
+
+      def image_schema
+        return {} unless page.has_image?
+
+        {
+          "image" => [
+            page.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
+        page.content_item.dig("links", "primary_publishing_organisation").to_a.first
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module GovukPublishingComponents
+  module Presenters
+    class NewsArticleSchema
+      def initialize(page)
+        @page = page
+      end
+
+      def structured_data
+        # http://schema.org/NewsArticle
+        data = ArticleSchema.new(@page).structured_data
+        data["@type"] = "NewsArticle"
+        data
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+module GovukPublishingComponents
+  module Presenters
+    class Page
+      attr_reader :local_assigns
+
+      def initialize(local_assigns)
+        @local_assigns = local_assigns
+      end
+
+      def schema
+        local_assigns.fetch(:schema)
+      end
+
+      def canonical_url
+        local_assigns[:canonical_url] || (Plek.current.website_root + content_item["base_path"])
+      end
+
+      def body
+        local_assigns[:body] || content_item["details"]["body"]
+      end
+
+      def title
+        local_assigns[:title] || content_item["title"]
+      end
+
+      def description
+        content_item["description"]
+      end
+
+      def has_image?
+        content_item.dig("details", "image").present?
+      end
+
+      def image_url
+        content_item.dig("details", "image", "url")
+      end
+
+      def image_alt_text
+        content_item.dig("details", "image", "alt_text")
+      end
+
+      def content_item
+        local_assigns[:content_item]
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/sanitisation.rb

@@ -0,0 +1,13 @@
+module GovukPublishingComponents
+  module Presenters
+    # @private
+    class Sanitisation
+      # Use `sub` on a potentially unsafe string. This method will sanitize
+      # the method first, do the replacement, and mark the result as HTML safe.
+      def self.sub_safely(string, pattern, replacement)
+        escaped_text = ERB::Util.html_escape_once(string.strip)
+        escaped_text.sub(pattern, replacement).html_safe
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/schema_org.rb

@@ -1,111 +1,23 @@
+require 'govuk_publishing_components/presenters/machine_readable/page'
+require 'govuk_publishing_components/presenters/machine_readable/article_schema'
+require 'govuk_publishing_components/presenters/machine_readable/news_article_schema'
+
 module GovukPublishingComponents
   module Presenters
     class SchemaOrg
-      def initialize(local_assigns)
-        @local_assigns = local_assigns
+      attr_reader :page
+
+      def initialize(page)
+        @page = page
       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
+        if page.schema == :article
+          ArticleSchema.new(page).structured_data
+        elsif page.schema == :news_article
+          NewsArticleSchema.new(page).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")
+          raise "#{page.schema} is not supported"
         end
       end
     end

data/lib/govuk_publishing_components/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-16 00:00:00.000000000 Z
+date: 2018-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -336,6 +336,9 @@ files:
 - app/assets/stylesheets/govuk_publishing_components/components/_input.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_inverse-header.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_label.scss
+- app/assets/stylesheets/govuk_publishing_components/components/_lead-paragraph.scss
+- app/assets/stylesheets/govuk_publishing_components/components/_phase-banner.scss
+- app/assets/stylesheets/govuk_publishing_components/components/_previous-and-next-navigation.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_radio.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_related-navigation.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_search.scss
@@ -346,6 +349,7 @@ files:
 - app/assets/stylesheets/govuk_publishing_components/components/_subscription-links.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_success-alert.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_taxonomy-navigation.scss
+- app/assets/stylesheets/govuk_publishing_components/components/_title.scss
 - app/assets/stylesheets/govuk_publishing_components/components/_translation-nav.scss
 - app/assets/stylesheets/govuk_publishing_components/components/helpers/_brand-colours.scss
 - app/assets/stylesheets/govuk_publishing_components/components/helpers/_px-to-em.scss
@@ -358,15 +362,17 @@ files:
 - app/assets/stylesheets/govuk_publishing_components/components/print/_feedback.scss
 - app/assets/stylesheets/govuk_publishing_components/components/print/_step-by-step-nav-header.scss
 - app/assets/stylesheets/govuk_publishing_components/components/print/_step-by-step-nav.scss
+- app/assets/stylesheets/govuk_publishing_components/components/print/_title.scss
 - app/controllers/govuk_publishing_components/application_controller.rb
 - app/controllers/govuk_publishing_components/component_guide_controller.rb
 - app/helpers/govuk_publishing_components/application_helper.rb
 - app/models/govuk_publishing_components/component_doc.rb
-- app/models/govuk_publishing_components/component_doc_resolver.rb
+- app/models/govuk_publishing_components/component_docs.rb
 - app/models/govuk_publishing_components/component_example.rb
 - app/models/govuk_publishing_components/shared_accessibility_criteria.rb
 - app/views/govuk_publishing_components/component_guide/component_doc/_call.html.erb
 - app/views/govuk_publishing_components/component_guide/component_doc/_component.html.erb
+- app/views/govuk_publishing_components/component_guide/component_doc/_component_output.html.erb
 - app/views/govuk_publishing_components/component_guide/component_doc/_preview.html.erb
 - app/views/govuk_publishing_components/component_guide/example.html.erb
 - app/views/govuk_publishing_components/component_guide/index.html.erb
@@ -381,12 +387,16 @@ files:
 - app/views/govuk_publishing_components/components/_error_summary.html.erb
 - app/views/govuk_publishing_components/components/_feedback.html.erb
 - app/views/govuk_publishing_components/components/_fieldset.html.erb
+- app/views/govuk_publishing_components/components/_government_navigation.html.erb
 - app/views/govuk_publishing_components/components/_heading.html.erb
 - 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/_lead_paragraph.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/_phase_banner.html.erb
+- app/views/govuk_publishing_components/components/_previous_and_next_navigation.html.erb
 - app/views/govuk_publishing_components/components/_radio.html.erb
 - app/views/govuk_publishing_components/components/_related_navigation.html.erb
 - app/views/govuk_publishing_components/components/_search.html.erb
@@ -397,6 +407,7 @@ files:
 - app/views/govuk_publishing_components/components/_subscription-links.html.erb
 - app/views/govuk_publishing_components/components/_success_alert.html.erb
 - app/views/govuk_publishing_components/components/_taxonomy_navigation.html.erb
+- app/views/govuk_publishing_components/components/_title.html.erb
 - app/views/govuk_publishing_components/components/_translation-nav.html.erb
 - app/views/govuk_publishing_components/components/docs/back_link.yml
 - app/views/govuk_publishing_components/components/docs/breadcrumbs.yml
@@ -407,12 +418,16 @@ files:
 - app/views/govuk_publishing_components/components/docs/error_summary.yml
 - app/views/govuk_publishing_components/components/docs/feedback.yml
 - app/views/govuk_publishing_components/components/docs/fieldset.yml
+- app/views/govuk_publishing_components/components/docs/government_navigation.yml
 - app/views/govuk_publishing_components/components/docs/heading.yml
 - 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/lead_paragraph.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/phase_banner.yml
+- app/views/govuk_publishing_components/components/docs/previous_and_next_navigation.yml
 - app/views/govuk_publishing_components/components/docs/radio.yml
 - app/views/govuk_publishing_components/components/docs/related_navigation.yml
 - app/views/govuk_publishing_components/components/docs/search.yml
@@ -423,6 +438,7 @@ files:
 - app/views/govuk_publishing_components/components/docs/subscription-links.yml
 - app/views/govuk_publishing_components/components/docs/success_alert.yml
 - app/views/govuk_publishing_components/components/docs/taxonomy_navigation.yml
+- app/views/govuk_publishing_components/components/docs/title.yml
 - app/views/govuk_publishing_components/components/docs/translation-nav.yml
 - app/views/govuk_publishing_components/components/related_navigation/_section.html.erb
 - app/views/layouts/govuk_publishing_components/application.html.erb
@@ -448,10 +464,14 @@ files:
 - lib/govuk_publishing_components/presenters/contextual_navigation.rb
 - lib/govuk_publishing_components/presenters/curated_taxonomy_sidebar_links.rb
 - lib/govuk_publishing_components/presenters/heading_helper.rb
+- lib/govuk_publishing_components/presenters/machine_readable/article_schema.rb
+- lib/govuk_publishing_components/presenters/machine_readable/news_article_schema.rb
+- lib/govuk_publishing_components/presenters/machine_readable/page.rb
 - lib/govuk_publishing_components/presenters/meta_tags.rb
 - 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/sanitisation.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