slimmer 7.0.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9764cb7281a906d7133016e1d48fc732a2d5ad50
-  data.tar.gz: 7020a355e1246293785e8a0be2f92d03a31e02b3
+  metadata.gz: 5f23b920aad27dfc980397b64f2f9e401b96d863
+  data.tar.gz: 79a169c43fcc6d616172ff4dcc637857cf2d1419
 SHA512:
-  metadata.gz: bb99ec91c22a9e76db811c330b8466ba2f5217915f770045c14a48028d7533bc8d365cf8b23b85e27dbbceea55a1a2b310369a670579aa9becdadd5960afcd0a
-  data.tar.gz: 88920a6e6fe1d6ebda6f43870e1e09dd7b9e06ac979843c6d6247fc1e3261e03e1aa467fefc2d5d3f7724c2c93e8e62d2c85ed277203834153f4a8c95132af75
+  metadata.gz: 34a7a53a6e06102e2f2db641c9971bc25891a76ed726739ed5a66fcc0db731b7535238884adb97d449616a04e57c259baea0498dd4cf9df67e152bb8755dac9f
+  data.tar.gz: 328d89ec79ca51cfd76a4fb7ebb80d59f53461eb8832115750d6f4998b4adf9f7ac6beced889fba4f71705f980ae6c3a306d51b2ae5872450525e12eb00f9535

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+# 8.0.0
+
+* Switch from JS custom variables to HTML meta tags
+
+  Slimmer now appends page metadata as meta tags instead of setting Google
+  custom variables within a script tag. The Google-specific implementation
+  details have been removed.
+
+  Any apps that need to report analytics events will require additional
+  Javascript that reads the meta tags and sends the relevant data to the
+  analytics platform. The current best practice for doing this is using
+  the GOV.UK Analytics API - you can find the [code, examples and documentation
+  in `govuk_frontend_toolkit`](https://github.com/alphagov/govuk_frontend_toolkit/blob/master/docs/analytics.md).
+
+* Remove Proposition header, since this information wasn't being used
+
 # 7.0.0
 
 * Remove AlphaLabelInserter, BetaNoticeInserter, BetaLabelInserter. These are

data/lib/slimmer.rb

@@ -26,7 +26,7 @@ module Slimmer
     autoload :BodyInserter, 'slimmer/processors/body_inserter'
     autoload :ConditionalCommentMover, 'slimmer/processors/conditional_comment_mover'
     autoload :FooterRemover, 'slimmer/processors/footer_remover'
-    autoload :GoogleAnalyticsConfigurator, 'slimmer/processors/google_analytics_configurator'
+    autoload :MetadataInserter, 'slimmer/processors/metadata_inserter'
     autoload :HeaderContextInserter, 'slimmer/processors/header_context_inserter'
     autoload :NavigationMover, 'slimmer/processors/navigation_mover'
     autoload :MetaViewportRemover, 'slimmer/processors/meta_viewport_remover'

data/lib/slimmer/headers.rb

@@ -8,7 +8,6 @@ module Slimmer
       application_name:     "Application-Name",
       format:               "Format",
       page_owner:           "Page-Owner",
-      proposition:          "Proposition",
       organisations:        "Organisations",
       report_a_problem:     "Report-a-Problem",
       world_locations:      "World-Locations",

data/lib/slimmer/processors/metadata_inserter.rb

@@ -0,0 +1,34 @@
+module Slimmer::Processors
+  class MetadataInserter
+    def initialize(response, artefact)
+      @headers = response.headers
+      @artefact = artefact
+    end
+
+    def filter(src, dest)
+      head = dest.at_css('head')
+
+      if @artefact
+        add_meta_tag('section', @artefact.primary_root_section["title"].downcase, head) if @artefact.primary_root_section
+        add_meta_tag('need-ids', @artefact.need_ids.join(',').downcase, head) if @artefact.need_ids
+      end
+
+      add_meta_tag('analytics:organisations', @headers[Slimmer::Headers::ORGANISATIONS_HEADER], head)
+      add_meta_tag('analytics:world-locations', @headers[Slimmer::Headers::WORLD_LOCATIONS_HEADER], head)
+      add_meta_tag('format', @headers[Slimmer::Headers::FORMAT_HEADER], head)
+      add_meta_tag('search-result-count', @headers[Slimmer::Headers::RESULT_COUNT_HEADER], head)
+    end
+
+  private
+
+    def add_meta_tag(name, content, head)
+      if content
+        meta_node = Nokogiri::XML::Node.new('meta', head)
+        meta_node['name'] = "govuk:#{name}"
+        meta_node['content'] = content
+
+        head.add_child(meta_node)
+      end
+    end
+  end
+end

data/lib/slimmer/skin.rb

@@ -117,7 +117,7 @@ module Slimmer
         Processors::BodyClassCopier.new,
         Processors::HeaderContextInserter.new(),
         Processors::SectionInserter.new(artefact),
-        Processors::GoogleAnalyticsConfigurator.new(response, artefact),
+        Processors::MetadataInserter.new(response, artefact),
         Processors::SearchParameterInserter.new(response),
         Processors::SearchPathSetter.new(response),
         Processors::RelatedItemsInserter.new(self, artefact),

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '7.0.0'
+  VERSION = '8.0.0'
 end

data/test/fixtures/wrapper.html.erb

@@ -2,11 +2,6 @@
 <html>
   <head>
     <title>Slimmer, yay!</title>
-    <script id="ga-params" type="text/javascript">
-      var GOVUK = GOVUK || {};
-      GOVUK.Analytics = GOVUK.Analytics || {};
-      var _gaq = _gaq || [];
-    </script>
   </head>
   <body>
     <header id="global-header"><h1>I AM A TITLE</h1></header>

data/test/processors/metadata_inserter_test.rb

@@ -0,0 +1,149 @@
+require_relative "../test_helper"
+
+module MetadataInserterTest
+
+  GENERIC_DOCUMENT = <<-END
+    <html>
+      <head>
+        <title>The title of the page</title>
+      </head>
+      <body class="body_class">
+        <div id="wrapper">The body of the page</div>
+      </body>
+    </html>
+  END
+
+  module MetaTagAssertions
+    def assert_meta_tag(name, content)
+      template = Nokogiri::HTML(last_response.body)
+      assert_in template, "head meta[name='govuk:#{name}'][content='#{content}']"
+    end
+
+    def refute_meta_tag(name)
+      template = Nokogiri::HTML(last_response.body)
+      assert_not_in template, "head meta[name='govuk:#{name}']"
+    end
+  end
+
+  class WithHeadersTest < SlimmerIntegrationTest
+    include MetaTagAssertions
+
+    def setup
+      super
+
+      artefact = artefact_for_slug_in_a_subsection("something", "rhubarb/in-puddings")
+      artefact["details"].merge!(
+        "need_ids" => [100001,100002],
+      )
+      headers = {
+        Slimmer::Headers::FORMAT_HEADER => "custard",
+        Slimmer::Headers::RESULT_COUNT_HEADER => "3",
+        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json,
+        Slimmer::Headers::ORGANISATIONS_HEADER => "<P1><D422>",
+        Slimmer::Headers::WORLD_LOCATIONS_HEADER => "<WL3>"
+      }
+
+      given_response 200, GENERIC_DOCUMENT, headers
+    end
+
+    def test_should_include_section_meta_tag
+      assert_meta_tag "section", "rhubarb"
+    end
+
+    def test_should_include_format_meta_tag
+      assert_meta_tag "format", "custard"
+    end
+
+    def test_should_include_need_ids_meta_tag
+      assert_meta_tag "need-ids", "100001,100002"
+    end
+
+    def test_should_include_organisations_meta_tag
+      assert_meta_tag "analytics:organisations", "<P1><D422>"
+    end
+
+    def test_should_include_world_locations_meta_tag
+      assert_meta_tag "analytics:world-locations", "<WL3>"
+    end
+
+    def test_should_include_search_result_count_meta_tag
+      assert_meta_tag "search-result-count", "3"
+    end
+  end
+
+  class WithInvalidAttributes < SlimmerIntegrationTest
+    include MetaTagAssertions
+
+    def setup
+      super
+    end
+
+    def test_should_skip_passing_need_ids_if_they_are_nil
+      artefact = artefact_for_slug_in_a_subsection("something", "rhubarb/in-puddings")
+      headers = {
+        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json,
+        Slimmer::Headers::FORMAT_HEADER => "custard"
+      }
+      given_response 200, GENERIC_DOCUMENT, headers
+
+      refute_meta_tag "need-ids"
+      # the presence of these attributes tests that the nil check worked
+      assert_meta_tag "section", "rhubarb"
+      assert_meta_tag "format", "custard"
+    end
+  end
+
+  class WithoutHeadersTest < SlimmerIntegrationTest
+    include MetaTagAssertions
+
+    given_response 200, GENERIC_DOCUMENT, {}
+
+    def test_should_omit_section
+      refute_meta_tag "section"
+    end
+
+    def test_should_omit_internal_format_name
+      refute_meta_tag "format"
+    end
+
+    def test_should_omit_need_ID
+      refute_meta_tag "need-ids"
+    end
+
+    def test_should_omit_organisations
+      refute_meta_tag "analytics:organisations"
+    end
+
+    def test_should_omit_world_locations
+      refute_meta_tag "analytics:world-locations"
+    end
+
+    def test_should_omit_result_count
+      refute_meta_tag "search-result-count"
+    end
+  end
+
+  class WithNilHeaderTest < SlimmerIntegrationTest
+    include MetaTagAssertions
+
+    def setup
+      super
+
+      artefact = artefact_for_slug_in_a_subsection("something", "rhubarb/in-puddings")
+      artefact["details"].merge!(
+        "need_ids" => [100001, 100002],
+      )
+      headers = {
+        Slimmer::Headers::RESULT_COUNT_HEADER => "3",
+        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json,
+        Slimmer::Headers::ORGANISATIONS_HEADER => "<P1><D422>"
+      }
+
+      given_response 200, GENERIC_DOCUMENT, headers
+    end
+
+    def test_should_include_organisation_meta_tag_without_crashing
+      assert_meta_tag "analytics:organisations", "<P1><D422>"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Ben Griffiths
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2015-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -266,9 +266,9 @@ files:
 - lib/slimmer/processors/body_inserter.rb
 - lib/slimmer/processors/conditional_comment_mover.rb
 - lib/slimmer/processors/footer_remover.rb
-- lib/slimmer/processors/google_analytics_configurator.rb
 - lib/slimmer/processors/header_context_inserter.rb
 - lib/slimmer/processors/meta_viewport_remover.rb
+- lib/slimmer/processors/metadata_inserter.rb
 - lib/slimmer/processors/navigation_mover.rb
 - lib/slimmer/processors/related_items_inserter.rb
 - lib/slimmer/processors/report_a_problem_inserter.rb
@@ -300,9 +300,9 @@ files:
 - test/fixtures/wrapper.html.erb
 - test/headers_test.rb
 - test/processors/body_inserter_test.rb
-- test/processors/google_analytics_test.rb
 - test/processors/header_context_inserter_test.rb
 - test/processors/meta_viewport_remover_test.rb
+- test/processors/metadata_inserter_test.rb
 - test/processors/navigation_mover_test.rb
 - test/processors/related_items_inserter_test.rb
 - test/processors/report_a_problem_inserter_test.rb
@@ -361,9 +361,9 @@ test_files:
 - test/processors/navigation_mover_test.rb
 - test/processors/related_items_inserter_test.rb
 - test/processors/search_path_setter_test.rb
-- test/processors/google_analytics_test.rb
 - test/processors/meta_viewport_remover_test.rb
 - test/processors/search_parameter_inserter_test.rb
 - test/processors/section_inserter_test.rb
 - test/processors/report_a_problem_inserter_test.rb
 - test/processors/tag_mover_test.rb
+- test/processors/metadata_inserter_test.rb

data/lib/slimmer/processors/google_analytics_configurator.rb

@@ -1,47 +0,0 @@
-require "json"
-
-module Slimmer::Processors
-  class GoogleAnalyticsConfigurator
-    PAGE_LEVEL_EVENT = 3
-
-    def initialize(response, artefact)
-      @headers = response.headers
-      @artefact = artefact
-    end
-
-    def filter(src, dest)
-      custom_vars = []
-      if @artefact
-        custom_vars << set_custom_var_downcase(1, "Section", @artefact.primary_root_section["title"]) if @artefact.primary_root_section
-        custom_vars << set_multivalue_custom_var(3, "NeedID", @artefact.need_ids)
-        custom_vars << set_custom_var_downcase(4, "Proposition", (@artefact.business_proposition ? 'business' : 'citizen')) unless @artefact.business_proposition.nil?
-      end
-      custom_vars << set_custom_var(9, "Organisations", @headers[Slimmer::Headers::ORGANISATIONS_HEADER])
-      custom_vars << set_custom_var(10, "WorldLocations", @headers[Slimmer::Headers::WORLD_LOCATIONS_HEADER])
-      custom_vars << set_custom_var_downcase(2, "Format", @headers[Slimmer::Headers::FORMAT_HEADER])
-      custom_vars << set_custom_var_downcase(5, "ResultCount", @headers[Slimmer::Headers::RESULT_COUNT_HEADER])
-
-      if dest.at_css("#ga-params")
-        dest.at_css("#ga-params").content += custom_vars.compact.join("\n")
-      end
-    end
-
-  private
-    def set_custom_var_downcase(slot, name, value)
-      return nil unless value
-      set_custom_var(slot, name, value.downcase)
-    end
-
-    def set_multivalue_custom_var(slot, name, values)
-      return nil if !values.is_a?(Array) || values.empty?
-      set_custom_var(slot, name, values.join(',').downcase)
-    end
-
-    def set_custom_var(slot, name, value)
-      return nil unless value
-      response = "_gaq.push(#{JSON.dump([ "_setCustomVar", slot, name, value, PAGE_LEVEL_EVENT])});\n"
-      response + "GOVUK.Analytics.#{name} = \"#{value}\";"
-    end
-  end
-end
-

data/test/processors/google_analytics_test.rb

@@ -1,198 +0,0 @@
-require_relative "../test_helper"
-require "v8"
-
-module GoogleAnalyticsTest
-  PAGE_LEVEL_EVENT = 3
-
-  GENERIC_DOCUMENT = <<-END
-    <html>
-      <head>
-        <title>The title of the page</title>
-      </head>
-      <body class="body_class">
-        <div id="wrapper">The body of the page</div>
-      </body>
-    </html>
-  END
-
-  module JavaScriptAssertions
-    def gaq
-      js = Nokogiri::HTML(last_response.body).at_css("#ga-params").text
-      context = V8::Context.new
-      context.eval(js)
-      context.eval("_gaq");
-    end
-
-    def govuk
-      js = Nokogiri::HTML(last_response.body).at_css("#ga-params").text
-      context = V8::Context.new
-      context.eval(js)
-      context.eval("GOVUK.Analytics");
-    end
-
-    def assert_custom_var(slot, name, value, page_level)
-      # Ruby Racer JS arrays don't accept range indexing, so we must
-      # use a slightly longer workaround
-      vars = gaq.select { |a| a[0] == "_setCustomVar" }.
-                 map { |a| (1..4).map { |i| a[i] } }
-      assert_includes vars, [slot, name, value, page_level]
-    end
-
-    def assert_set_var(name, value, object)
-      assert_equal value, object.find { |each| each[0] == name }[1]
-    end
-
-    def refute_custom_var(name)
-      vars = gaq.select { |a| a[0] == "_setCustomVar" }.map { |a| a[2] }
-      refute_includes vars, name
-    end
-  end
-
-  class WithHeadersTest < SlimmerIntegrationTest
-    include JavaScriptAssertions
-
-    def setup
-      super
-
-      artefact = artefact_for_slug_in_a_subsection("something", "rhubarb/in-puddings")
-      artefact["details"].merge!(
-        "need_ids" => [100001,100002],
-        "business_proposition" => true,
-      )
-      headers = {
-        Slimmer::Headers::FORMAT_HEADER => "custard",
-        Slimmer::Headers::RESULT_COUNT_HEADER => "3",
-        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json,
-        Slimmer::Headers::ORGANISATIONS_HEADER => "<P1><D422>",
-        Slimmer::Headers::WORLD_LOCATIONS_HEADER => "<WL3>"
-      }
-
-      given_response 200, GENERIC_DOCUMENT, headers
-    end
-
-    def test_should_pass_section_to_GA
-      assert_custom_var 1, "Section", "rhubarb", PAGE_LEVEL_EVENT
-    end
-
-    def test_should_set_section_in_GOVUK_object
-      assert_set_var "Section", "rhubarb", govuk
-    end
-
-    def test_should_pass_internal_format_name_to_GA
-      assert_custom_var 2, "Format", "custard", PAGE_LEVEL_EVENT
-    end
-
-    def test_should_set_internal_format_name_in_GOVUK_object
-      assert_set_var "Format", "custard", govuk
-    end
-
-    def test_should_pass_need_ids_to_GA
-      assert_custom_var 3, "NeedID", "100001,100002", PAGE_LEVEL_EVENT
-    end
-
-    def test_should_set_need_ids_in_GOVUK_object
-      assert_set_var "NeedID", "100001,100002", govuk
-    end
-
-    def test_should_pass_proposition_to_GA
-      assert_custom_var 4, "Proposition", "business", PAGE_LEVEL_EVENT
-    end
-
-    def test_should_pass_organisation_to_GA
-      assert_custom_var 9, "Organisations", "<P1><D422>", PAGE_LEVEL_EVENT
-    end
-
-    def test_should_pass_world_location_to_GA
-      assert_custom_var 10, "WorldLocations", "<WL3>", PAGE_LEVEL_EVENT
-    end
-
-    def test_should_set_proposition_in_GOVUK_object
-      assert_set_var "Proposition", "business", govuk
-    end
-
-    def test_should_pass_result_count_to_GA
-      assert_custom_var 5, "ResultCount", "3", PAGE_LEVEL_EVENT
-    end
-
-    def test_should_set_result_count_in_GOVUK_object
-      assert_set_var "ResultCount", "3", govuk
-    end
-  end
-
-  class WithInvalidAttributes < SlimmerIntegrationTest
-    include JavaScriptAssertions
-
-    def setup
-      super
-    end
-
-    def test_should_skip_passing_need_ids_if_they_are_nil
-      artefact = artefact_for_slug_in_a_subsection("something", "rhubarb/in-puddings")
-      headers = {
-        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json,
-        Slimmer::Headers::FORMAT_HEADER => "custard"
-      }
-      given_response 200, GENERIC_DOCUMENT, headers
-
-      refute_custom_var "NeedID"
-      # the presence of these attributes tests that the nil check worked
-      assert_custom_var 1, "Section", "rhubarb", PAGE_LEVEL_EVENT
-      assert_custom_var 2, "Format", "custard", PAGE_LEVEL_EVENT
-    end
-  end
-
-  class WithoutHeadersTest < SlimmerIntegrationTest
-    include JavaScriptAssertions
-
-    given_response 200, GENERIC_DOCUMENT, {}
-
-    def test_should_omit_section
-      refute_custom_var "Section"
-    end
-
-    def test_should_omit_internal_format_name
-      refute_custom_var "Format"
-    end
-
-    def test_should_omit_need_ID
-      refute_custom_var "NeedID"
-    end
-
-    def test_should_omit_proposition
-      refute_custom_var "Proposition"
-    end
-
-    def test_should_omit_organisations
-      refute_custom_var "Organisations"
-    end
-
-    def test_should_omit_result_count
-      refute_custom_var "ResultCount"
-    end
-  end
-
-  class WithNilHeaderTest < SlimmerIntegrationTest
-    include JavaScriptAssertions
-
-    def setup
-      super
-
-      artefact = artefact_for_slug_in_a_subsection("something", "rhubarb/in-puddings")
-      artefact["details"].merge!(
-        "need_ids" => [100001, 100002],
-        "business_proposition" => true
-      )
-      headers = {
-        Slimmer::Headers::RESULT_COUNT_HEADER => "3",
-        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json,
-        Slimmer::Headers::ORGANISATIONS_HEADER => "<P1><D422>"
-      }
-
-      given_response 200, GENERIC_DOCUMENT, headers
-    end
-
-    def test_should_pass_organisation_to_GA_without_crashing
-      assert_custom_var 9, "Organisations", "<P1><D422>", PAGE_LEVEL_EVENT
-    end
-  end
-end