govuk_publishing_components 7.2.0 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 291eb959433c164a7882c30018df0e83f79af74e48de424217ec6abacdebb280
-  data.tar.gz: a30ad7ff07625951cd0c41726a7c03cd7bda78d521740abd82e056243df67ec1
+  metadata.gz: 718e4d3d0e9959be0f7d0270202b9af68951b66b1a75263232a3cff12dab9ec4
+  data.tar.gz: c6c6c04682ea600c4ad69bc6dc1c494046efea44c2e3b3bf87c01d65dbf5d396
 SHA512:
-  metadata.gz: 1f1bafdb22c4c0ca340d5562b777fe6aa88991a65888a21a38f91afafd3ffcb5e0b36d1ae3cfb6e9fe3eaa331df176a4041bfa78c68fbb43987cddd07c3f7aeb
-  data.tar.gz: 7cece34af16873b389b1105e24a6a71fdd2f0799d51b1639b26af462287836366d7533e4a72ec7a9cfce9b7e5963c8c3bf0b253071af77c91ef02379decdee72
+  metadata.gz: 49462b2130f34c4172dc6680b4f1216f44fe5a973e639d573d61a39b712d899571f9a50b69000a37666fb6d7b696cf131833d97c1f731d9e71b63e11cb7ccae6
+  data.tar.gz: a1d8b39fbb2216b2c04d7cdea21d84bf9f5d23f93e63f4f22bdc16ccd0050955f900a2557d17eda0049115af4f8fa440bbf633133eb3e0e2aa235e558234c723

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

@@ -4,10 +4,10 @@
   margin_bottom_class = " gem-c-document-list--bottom-margin" if local_assigns[:margin_bottom]
 
   brand ||= false
-  brand_helper = GovukPublishingComponents::Presenters::BrandHelper.new(brand)
+  brand_helper = GovukPublishingComponents::AppHelpers::BrandHelper.new(brand)
 %>
 <% if items.any? %>
-  <ol class="gem-c-document-list<%= margin_bottom_class %><%= margin_top_class %> <%= brand_helper.get_brand %>">
+  <ol class="gem-c-document-list<%= margin_bottom_class %><%= margin_top_class %> <%= brand_helper.brand_class %>">
     <% items.each do |item| %>
       <li class="gem-c-document-list__item">
         <h3 class="gem-c-document-list__item-title">
@@ -16,7 +16,7 @@
               item[:link][:text],
               item[:link][:path],
               data: item[:link][:data_attributes],
-              class: brand_helper.get_brand_element("color")
+              class: brand_helper.color_class
             )
           %>
         </h3>

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

@@ -32,12 +32,12 @@ examples:
     description: |
       Allows the addition of an aria-describedby attribute. Note that this will be overridden in the event of an error, where the error will be used for the describedby attribute value.
 
-      The example below uses the ID of the skiplink container for demonstration purposes, in real use this would be passed the ID of an element that correctly described the input.
+      The example below uses the ID of the main container for demonstration purposes as there aren't any useful elements with IDs in the component guide. In real use this would be passed the ID of an element that correctly described the input.
     data:
       label:
         text: "This might not work"
       name: "labelledby"
-      describedby: "skiplink-container"
+      describedby: "wrapper"
   with_error:
     data:
       label:

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

@@ -23,3 +23,13 @@ examples:
         links:
           world_locations:
           - analytics_identifier: WL3
+  with_default_canonical_path:
+    data:
+      content_item:
+        base_path: /test
+      canonical_path: true
+  with_overridden_canonical_path:
+    data:
+      content_item:
+        base_path: /test
+      canonical_path: /this-is-a-test-path

data/lib/govuk_publishing_components.rb

@@ -1,6 +1,5 @@
 require "govuk_publishing_components/config"
 require "govuk_publishing_components/engine"
-require "govuk_publishing_components/presenters/brand_helper"
 require "govuk_publishing_components/presenters/contextual_navigation"
 require "govuk_publishing_components/presenters/related_navigation_helper"
 require "govuk_publishing_components/presenters/step_by_step_nav_helper"
@@ -15,6 +14,7 @@ require "govuk_publishing_components/presenters/curated_taxonomy_sidebar_links"
 require "govuk_publishing_components/presenters/content_item"
 
 require "govuk_publishing_components/app_helpers/taxon_breadcrumbs"
+require "govuk_publishing_components/app_helpers/brand_helper"
 
 module GovukPublishingComponents
 end

data/lib/govuk_publishing_components/app_helpers/brand_helper.rb

@@ -0,0 +1,25 @@
+module GovukPublishingComponents
+  module AppHelpers
+    class BrandHelper
+      def initialize(brand)
+        @brand = brand if brand
+      end
+
+      # Apply government organisation branding to individual components, specifically
+      # link colour and border colour
+      # see https://github.com/alphagov/govuk_publishing_components/blob/master/docs/component_branding.md
+
+      def brand_class
+        "brand--#{@brand}" if @brand
+      end
+
+      def border_color_class
+        "brand__border-color" if @brand
+      end
+
+      def color_class
+        "brand__color" if @brand
+      end
+    end
+  end
+end

data/lib/govuk_publishing_components/presenters/meta_tags.rb

@@ -20,6 +20,7 @@ module GovukPublishingComponents
         meta_tags = add_political_tags(meta_tags)
         meta_tags = add_taxonomy_tags(meta_tags)
         meta_tags = add_step_by_step_tags(meta_tags)
+        meta_tags = add_canonical_tag(meta_tags)
         meta_tags
       end
 
@@ -106,6 +107,20 @@ module GovukPublishingComponents
         meta_tags
       end
 
+      def add_canonical_tag(meta_tags)
+        if local_assigns.key?(:canonical_path)
+          canonical_path = if local_assigns[:canonical_path] == true
+                             content_item[:base_path]
+                           else
+                             local_assigns[:canonical_path]
+                           end
+
+          meta_tags["canonical"] = Plek.new.website_root + canonical_path
+        end
+
+        meta_tags
+      end
+
       def has_content_history?
         (content_item[:public_updated_at] && details[:first_public_at] && content_item[:public_updated_at] != details[:first_public_at]) ||
           (details[:change_history] && details[:change_history].size > 1)

data/lib/govuk_publishing_components/version.rb

@@ -1,3 +1,3 @@
 module GovukPublishingComponents
-  VERSION = '7.2.0'.freeze
+  VERSION = '7.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_publishing_components
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 7.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-04 00:00:00.000000000 Z
+date: 2018-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: govuk_app_config
@@ -425,11 +425,11 @@ files:
 - lib/generators/govuk_publishing_components/templates/_component.scss
 - lib/generators/govuk_publishing_components/templates/component.yml.erb
 - lib/govuk_publishing_components.rb
+- lib/govuk_publishing_components/app_helpers/brand_helper.rb
 - lib/govuk_publishing_components/app_helpers/taxon_breadcrumbs.rb
 - lib/govuk_publishing_components/config.rb
 - lib/govuk_publishing_components/engine.rb
 - lib/govuk_publishing_components/minitest/component_guide_test.rb
-- lib/govuk_publishing_components/presenters/brand_helper.rb
 - lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_parent.rb
 - lib/govuk_publishing_components/presenters/content_breadcrumbs_based_on_taxons.rb
 - lib/govuk_publishing_components/presenters/content_item.rb

data/lib/govuk_publishing_components/presenters/brand_helper.rb

@@ -1,17 +0,0 @@
-module GovukPublishingComponents
-  module Presenters
-    class BrandHelper
-      def initialize(brand)
-        @brand = brand if brand
-      end
-
-      def get_brand
-        "brand--#{@brand}" if @brand
-      end
-
-      def get_brand_element(attribute)
-        "brand__#{attribute}" if @brand
-      end
-    end
-  end
-end