From 309ec851cc6f6a91158f60b2d4ac59efc24281d9 Mon Sep 17 00:00:00 2001
From: mahmudh <mahmud.hussain@digital.cabinet-office.gov.uk>
Date: Wed, 7 Nov 2018 17:27:10 +0000
Subject: [PATCH] Add separate tracking data for home link on breadcrumb

---
 Gemfile.lock                                  |  3 +
 .../components/_breadcrumbs.html.erb          | 33 ++++------
 .../components/_layout_header.html.erb        |  2 +-
 .../app_helpers/taxon_breadcrumbs.rb          |  2 +-
 .../presenters/breadcrumbs.rb                 | 63 +++++++++++++++++--
 spec/components/breadcrumbs_spec.rb           | 21 +++++++
 6 files changed, 95 insertions(+), 29 deletions(-)

diff --git a/Gemfile.lock b/Gemfile.lock
index dd45c2abb6..0faac4e903 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -332,5 +332,8 @@ DEPENDENCIES
   webmock (~> 3.0.1)
   yard
 
+RUBY VERSION
+   ruby 2.5.3p105
+
 BUNDLED WITH
    1.17.1
diff --git a/app/views/govuk_publishing_components/components/_breadcrumbs.html.erb b/app/views/govuk_publishing_components/components/_breadcrumbs.html.erb
index 343d07e97c..f5f271dcfc 100644
--- a/app/views/govuk_publishing_components/components/_breadcrumbs.html.erb
+++ b/app/views/govuk_publishing_components/components/_breadcrumbs.html.erb
@@ -4,44 +4,33 @@
   inverse ||= false
   collapse_class =  collapse_on_mobile && breadcrumbs.any? { |crumb| crumb[:is_page_parent] } ? "gem-c-breadcrumbs--collapse-on-mobile" : ""
   invert_class = inverse ? "gem-c-breadcrumbs--inverse" : ""
-  structured_data = GovukPublishingComponents::Presenters::Breadcrumbs.new(breadcrumbs, request.path).structured_data
+  breadcrumb_presenter = GovukPublishingComponents::Presenters::Breadcrumbs.new(breadcrumbs, request.path)
 %>
 
 <script type="application/ld+json">
-  <%= raw structured_data.to_json %>
+  <%= raw breadcrumb_presenter.structured_data.to_json %>
 </script>
 
 <div class="gem-c-breadcrumbs govuk-breadcrumbs <%= invert_class %>" data-module="track-click">
   <ol class="govuk-breadcrumbs__list">
     <% breadcrumbs.each_with_index do |crumb, index| %>
-      <%
-        is_link = crumb[:url].present? || crumb[:is_current_page]
-        path = crumb[:is_current_page] ? '#content' : crumb[:url]
-        aria_current = crumb[:is_current_page] ? 'page' : 'false'
-      %>
-      <li class="govuk-breadcrumbs__list-item" aria-current="<%= aria_current %>">
-        <% if is_link %>
+      <% breadcrumb = GovukPublishingComponents::Presenters::Breadcrumb.new(crumb, index) %>
+      <li class="govuk-breadcrumbs__list-item" aria-current="<%= breadcrumb.aria_current %>">
+        <% if breadcrumb.is_link? %>
           <%= link_to(
-            crumb[:title],
-            path,
-            data: {
-              track_category: 'breadcrumbClicked',
-              track_action: index + 1,
-              track_label: path,
-              track_options: {
-                dimension28: breadcrumbs.length.to_s,
-                dimension29: crumb[:title]
-              }
-            },
+            breadcrumb[:title],
+            breadcrumb.path,
+            data: breadcrumb.tracking_data(breadcrumbs.length),
             class: "govuk-breadcrumbs__link",
             aria: {
-              current: aria_current,
+              current: breadcrumb.aria_current,
             }
           ) %>
         <% else %>
-          <%= crumb[:title] %>
+          <%= breadcrumb[:title] %>
         <% end %>
       </li>
     <% end %>
   </ol>
 </div>
+
diff --git a/app/views/govuk_publishing_components/components/_layout_header.html.erb b/app/views/govuk_publishing_components/components/_layout_header.html.erb
index 5232bbb10a..2fcadd50a5 100644
--- a/app/views/govuk_publishing_components/components/_layout_header.html.erb
+++ b/app/views/govuk_publishing_components/components/_layout_header.html.erb
@@ -6,7 +6,7 @@
   <div class="govuk-header__container govuk-width-container">
 
     <div class="govuk-header__logo">
-      <a href="/" class="govuk-header__link govuk-header__link--homepage">
+      <a href="/" class="govuk-header__link govuk-header__link--homepage" data-module="track-click" data-tracking-category="homeLinkClicked">
         <span class="govuk-header__logotype">
           <svg role="presentation" focusable="false" class="govuk-header__logotype-crown" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 132 97" height="32" width="36">
             <path fill="currentColor" fill-rule="evenodd"
diff --git a/lib/govuk_publishing_components/app_helpers/taxon_breadcrumbs.rb b/lib/govuk_publishing_components/app_helpers/taxon_breadcrumbs.rb
index 13d909cbf4..6c1d1f62ea 100644
--- a/lib/govuk_publishing_components/app_helpers/taxon_breadcrumbs.rb
+++ b/lib/govuk_publishing_components/app_helpers/taxon_breadcrumbs.rb
@@ -15,7 +15,7 @@ def breadcrumbs
           {
             title: parent.title,
             url: parent.base_path,
-            is_page_parent: index.zero?
+            is_page_parent: index.zero?,
           }
         end
 
diff --git a/lib/govuk_publishing_components/presenters/breadcrumbs.rb b/lib/govuk_publishing_components/presenters/breadcrumbs.rb
index eaf2b1986d..851ca3a656 100644
--- a/lib/govuk_publishing_components/presenters/breadcrumbs.rb
+++ b/lib/govuk_publishing_components/presenters/breadcrumbs.rb
@@ -20,15 +20,68 @@ def structured_data
 
       def item_list_element
         breadcrumbs.each_with_index.map do |crumb, index|
-          {
-            "@type" => "ListItem",
-            "position" => index + 1,
-            "item" => list_item_item(crumb)
+          Breadcrumb.new(crumb, index).item_list_element(@request_path)
+        end
+      end
+    end
+
+    class Breadcrumb
+      extend Forwardable
+      def_delegators :@crumb, :[]
+
+      def initialize(crumb, index)
+        @crumb = crumb
+        @index = index + 1
+      end
+
+      def item_list_element(request_path)
+        {
+          "@type" => "ListItem",
+          "position" => index,
+          "item" => list_item_item(request_path)
+        }
+      end
+
+      def is_link?
+        crumb[:url].present? || crumb[:is_current_page]
+      end
+
+      def path
+        crumb[:is_current_page] ? '#content' : crumb[:url]
+      end
+
+      def aria_current
+        crumb[:is_current_page] ? 'page' : 'false'
+      end
+
+      def tracking_data(breadcrumbs_length)
+        data = {
+          track_category: 'breadcrumbClicked',
+          track_action: index,
+          track_label: path,
+          track_options: {
+              dimension28: breadcrumbs_length.to_s,
+              dimension29: crumb[:title]
           }
+        }
+
+        is_homepage = crumb[:url] == "/"
+
+        if is_homepage
+          data[:track_category] = 'homeLinkClicked'
+          data[:track_action] = 'homeBreadcrumb'
+          data[:track_label] = ''
+          data[:track_options] = '{}'
         end
+
+        data
       end
 
-      def list_item_item(crumb)
+    private
+
+      attr_reader :crumb, :index
+
+      def list_item_item(request_path)
         path = crumb[:is_current_page] ? request_path : crumb[:url]
         item = { "name" => crumb[:title] }
         item["@id"] = Plek.new.website_root + path if path
diff --git a/spec/components/breadcrumbs_spec.rb b/spec/components/breadcrumbs_spec.rb
index b18c8888c1..5a27c84dfb 100644
--- a/spec/components/breadcrumbs_spec.rb
+++ b/spec/components/breadcrumbs_spec.rb
@@ -53,6 +53,27 @@ def assert_link_with_text_in(selector, link, text)
     assert_select ".govuk-breadcrumbs__list-item:first-child a[data-track-options='#{expected_tracking_options.to_json}']", 1
   end
 
+  it "a link to the homepage has separate tracking data" do
+    render_component(breadcrumbs: [{ title: 'Section', url: '/section' }, { title: 'Home', url: '/' }])
+
+    expected_tracking_options = {
+        dimension28: "2",
+        dimension29: "Section"
+    }
+
+    assert_select '.gem-c-breadcrumbs[data-module="track-click"]', 1
+
+    assert_select '.govuk-breadcrumbs__list-item:nth-child(1) a[data-track-action="1"]', 1
+    assert_select '.govuk-breadcrumbs__list-item:nth-child(1) a[data-track-label="/section"]', 1
+    assert_select '.govuk-breadcrumbs__list-item:nth-child(1) a[data-track-category="breadcrumbClicked"]', 1
+    assert_select ".govuk-breadcrumbs__list-item:nth-child(1) a[data-track-options='#{expected_tracking_options.to_json}']", 1
+
+    assert_select '.govuk-breadcrumbs__list-item:nth-child(2) a[data-track-action="homeBreadcrumb"]', 1
+    assert_select '.govuk-breadcrumbs__list-item:nth-child(2) a[data-track-label=""]', 1
+    assert_select '.govuk-breadcrumbs__list-item:nth-child(2) a[data-track-category="homeLinkClicked"]', 1
+    assert_select ".govuk-breadcrumbs__list-item:nth-child(2) a[data-track-options='{}']", 1
+  end
+
   it "tracks the total breadcrumb count on each breadcrumb" do
     breadcrumbs = [
       { title: 'Section 1', url: '/section-1' },