slimmer 3.1.1 → 3.2.0

data/lib/slimmer/headers.rb

@@ -18,6 +18,8 @@ module Slimmer
     SKIP_HEADER = "#{HEADER_PREFIX}-Skip"
     SEARCH_PATH_HEADER = "#{HEADER_PREFIX}-Search-Path"
     ARTEFACT_HEADER = "#{HEADER_PREFIX}-Artefact"
+    FORMAT_HEADER = "#{HEADER_PREFIX}-Format"
+    RESULT_COUNT_HEADER = "#{HEADER_PREFIX}-Result-Count"
 
     def set_slimmer_headers(hash)
       raise InvalidHeader if (hash.keys - SLIMMER_HEADER_MAPPING.keys).any?
@@ -28,7 +30,11 @@ module Slimmer
     end
 
     def set_slimmer_artefact(artefact_input)
-      artefact = artefact_input.dup
+      if artefact_input.is_a?(Hash) or artefact_input.is_a?(OpenStruct)
+        artefact = artefact_input.dup
+      elsif artefact_input.respond_to?(:to_hash)
+        artefact = artefact_input.to_hash
+      end
       headers[ARTEFACT_HEADER] = artefact.to_json
     end
 

data/lib/slimmer/processors/google_analytics_configurator.rb

@@ -3,25 +3,24 @@ require "json"
 module Slimmer::Processors
   class GoogleAnalyticsConfigurator
     PAGE_LEVEL_EVENT = 3
-    HEADER_MAPPING = {
-      "Section"     => "X-SLIMMER-SECTION",
-      "Format"      => "X-SLIMMER-FORMAT",
-      "NeedID"      => "X-SLIMMER-NEED-ID",
-      "Proposition" => "X-SLIMMER-PROPOSITION",
-      "ResultCount" => "X-SLIMMER-RESULT-COUNT"
-    }
 
-    def initialize(response)
+    def initialize(response, artefact)
       @headers = response.headers
+      @artefact = artefact
     end
 
     def filter(src, dest)
-      custom_vars = HEADER_MAPPING.map.with_index(1) { |(name, key), slot|
-        set_custom_var(slot, name, @headers[key])
-      }.compact.join("\n");
+      custom_vars = []
+      if @artefact
+        custom_vars << set_custom_var(1, "Section", @artefact.primary_section["title"]) if @artefact.primary_section
+        custom_vars << set_custom_var(3, "NeedID", @artefact.need_id)
+        custom_vars << set_custom_var(4, "Proposition", (@artefact.business_proposition ? 'business' : 'citizen')) unless @artefact.business_proposition.nil?
+      end
+      custom_vars << set_custom_var(2, "Format", @headers[Slimmer::Headers::FORMAT_HEADER])
+      custom_vars << set_custom_var(5, "ResultCount", @headers[Slimmer::Headers::RESULT_COUNT_HEADER])
 
       if dest.at_css("#ga-params")
-        dest.at_css("#ga-params").content += custom_vars
+        dest.at_css("#ga-params").content += custom_vars.compact.join("\n")
       end
     end
 

data/lib/slimmer/processors/section_inserter.rb

@@ -8,20 +8,26 @@ module Slimmer::Processors
       if @artefact and (list = dest.at_css('.header-context nav[role=navigation] ol'))
         if (section = @artefact.primary_section)
           append_tag(list, section["parent"]) if section["parent"]
-          append_tag(list, section)
+          append_tag(list, section, :strong => true)
         end
       end
     end
 
     private
 
-    def append_tag(list, tag)
+    def append_tag(list, tag, opts = {})
       link_node = Nokogiri::XML::Node.new('a', list)
       link_node['href'] = tag["content_with_tag"]["web_url"]
       link_node.content = tag["title"]
 
       list_item = Nokogiri::XML::Node.new('li', list)
-      list_item.add_child(link_node)
+      if opts[:strong]
+        strong = Nokogiri::XML::Node.new('strong', list)
+        strong.add_child(link_node)
+        list_item.add_child(strong)
+      else
+        list_item.add_child(link_node)
+      end
 
       list.add_child(list_item)
     end

data/lib/slimmer/skin.rb

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

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '3.1.1'
+  VERSION = '3.2.0'
 end

data/test/headers_test.rb

@@ -77,6 +77,13 @@ describe Slimmer::Headers do
       assert_equal({"foo" => "bar"}.to_json, headers[Slimmer::Headers::ARTEFACT_HEADER])
     end
 
+    it "should handle an object that responds to :to_hash" do
+      hash = {"foo" => "bar", "slug" => "vat-rates"}
+      artefact = stub("Response", :to_hash => hash)
+      self.set_slimmer_artefact(artefact)
+      assert_equal hash.to_json, headers[Slimmer::Headers::ARTEFACT_HEADER]
+    end
+
     it "should not have side-effects on the passed in hash" do
       artefact = {"foo" => "bar", "slug" => "vat-rates", "actions" => "some_actions"}
       artefact_copy = artefact.dup

data/test/processors/google_analytics_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require_relative "../test_helper"
 require "v8"
 
 module GoogleAnalyticsTest
@@ -51,15 +51,22 @@ module GoogleAnalyticsTest
     include JavaScriptAssertions
     PAGE_LEVEL_EVENT = 3
 
-    headers = {
-      "X-Slimmer-Section"       => "RHUBARB",
-      "X-Slimmer-Format"        => "custard",
-      "X-Slimmer-Need-ID"       => "42",
-      "X-Slimmer-Proposition"   => "trifle",
-      "X-Slimmer-Result-Count"  => "3"
-    }
+    def setup
+      super
 
-    given_response 200, GENERIC_DOCUMENT, headers
+      artefact = artefact_for_slug_in_a_section("something", "rhubarb")
+      artefact["details"].merge!(
+        "need_id" => "42",
+        "business_proposition" => true
+      )
+      headers = {
+        Slimmer::Headers::FORMAT_HEADER => "custard",
+        Slimmer::Headers::RESULT_COUNT_HEADER => "3",
+        Slimmer::Headers::ARTEFACT_HEADER => artefact.to_json
+      }
+
+      given_response 200, GENERIC_DOCUMENT, headers
+    end
 
     def test_should_pass_section_to_GA
       assert_custom_var 1, "Section", "rhubarb", PAGE_LEVEL_EVENT
@@ -86,7 +93,7 @@ module GoogleAnalyticsTest
     end
 
     def test_should_pass_proposition_to_GA
-      assert_custom_var 4, "Proposition", "trifle", PAGE_LEVEL_EVENT
+      assert_custom_var 4, "Proposition", "business", PAGE_LEVEL_EVENT
     end
 
     def test_should_set_section_in_GOVUK_object

data/test/processors/section_inserter_test.rb

@@ -38,7 +38,7 @@ class SectionInserterTest < MiniTest::Unit::TestCase
     Slimmer::Processors::SectionInserter.new(artefact).filter(:any_source, template)
     list = template.at_css(".header-context nav[role=navigation] ol")
     assert_in list, "li:nth-child(1)", %{<a href="/">Home</a>}
-    assert_in list, "li:nth-child(2)", %{<a href="https://www.test.gov.uk/browse/business">Business</a>}
+    assert_in list, "li:nth-child(2)", %{<strong><a href="https://www.test.gov.uk/browse/business">Business</a></strong>}
   end
 
   def test_should_add_section_link_subsection_link_and_title_to_breadcrumb
@@ -62,7 +62,7 @@ class SectionInserterTest < MiniTest::Unit::TestCase
     list = template.at_css(".header-context nav[role=navigation] ol")
     assert_in list, "li:nth-child(1)", %{<a href="/">Home</a>}
     assert_in list, "li:nth-child(2)", %{<a href="https://www.test.gov.uk/browse/business">Business</a>}
-    assert_in list, "li:nth-child(3)", %{<a href="https://www.test.gov.uk/browse/business/employing-people">Employing people</a>}
+    assert_in list, "li:nth-child(3)", %{<strong><a href="https://www.test.gov.uk/browse/business/employing-people">Employing people</a></strong>}
   end
 
   def test_should_add_links_after_last_item_in_breadcrumb
@@ -90,7 +90,7 @@ class SectionInserterTest < MiniTest::Unit::TestCase
     assert_in list, "li:nth-child(1)", %{<a href="/">Home</a>}
     assert_in list, "li:nth-child(2)", %{<a href="/browse">All Sections</a>}
     assert_in list, "li:nth-child(3)", %{<a href="https://www.test.gov.uk/browse/business">Business</a>}
-    assert_in list, "li:nth-child(4)", %{<a href="https://www.test.gov.uk/browse/business/employing-people">Employing people</a>}
+    assert_in list, "li:nth-child(4)", %{<strong><a href="https://www.test.gov.uk/browse/business/employing-people">Employing people</a></strong>}
   end
 
   def test_should_do_nothing_if_navigation_not_in_template

metadata

@@ -2,7 +2,7 @@
 name: slimmer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors: 
 - Ben Griffiths
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-14 00:00:00 Z
+date: 2012-09-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -159,49 +159,49 @@ files:
 - README.md
 - CHANGELOG.md
 - lib/tasks/slimmer.rake
-- lib/slimmer.rb
-- lib/slimmer/skin.rb
-- lib/slimmer/railtie.rb
-- lib/slimmer/template.rb
-- lib/slimmer/test_template.rb
-- lib/slimmer/test.rb
-- lib/slimmer/app.rb
-- lib/slimmer/processors/logo_class_inserter.rb
+- lib/slimmer/version.rb
 - lib/slimmer/processors/body_class_copier.rb
-- lib/slimmer/processors/tag_mover.rb
-- lib/slimmer/processors/search_path_setter.rb
-- lib/slimmer/processors/title_inserter.rb
 - lib/slimmer/processors/google_analytics_configurator.rb
-- lib/slimmer/processors/conditional_comment_mover.rb
 - lib/slimmer/processors/related_items_inserter.rb
-- lib/slimmer/processors/header_context_inserter.rb
 - lib/slimmer/processors/body_inserter.rb
-- lib/slimmer/processors/admin_title_inserter.rb
+- lib/slimmer/processors/logo_class_inserter.rb
 - lib/slimmer/processors/report_a_problem_inserter.rb
-- lib/slimmer/processors/section_inserter.rb
 - lib/slimmer/processors/footer_remover.rb
-- lib/slimmer/headers.rb
-- lib/slimmer/version.rb
+- lib/slimmer/processors/conditional_comment_mover.rb
+- lib/slimmer/processors/admin_title_inserter.rb
+- lib/slimmer/processors/section_inserter.rb
+- lib/slimmer/processors/search_path_setter.rb
+- lib/slimmer/processors/tag_mover.rb
+- lib/slimmer/processors/title_inserter.rb
+- lib/slimmer/processors/header_context_inserter.rb
+- lib/slimmer/template.rb
+- lib/slimmer/railtie.rb
+- lib/slimmer/test.rb
 - lib/slimmer/artefact.rb
+- lib/slimmer/skin.rb
+- lib/slimmer/app.rb
+- lib/slimmer/headers.rb
+- lib/slimmer/test_template.rb
+- lib/slimmer.rb
 - Rakefile
-- test/headers_test.rb
-- test/artefact_test.rb
-- test/fixtures/related.raw.html.erb
-- test/fixtures/500.html.erb
-- test/fixtures/404.html.erb
-- test/fixtures/wrapper.html.erb
-- test/fixtures/report_a_problem.raw.html.erb
-- test/skin_test.rb
-- test/processors/logo_class_inserter_test.rb
-- test/processors/google_analytics_test.rb
+- test/processors/related_items_inserter_test.rb
 - test/processors/report_a_problem_inserter_test.rb
-- test/processors/body_inserter_test.rb
-- test/processors/search_path_setter_test.rb
 - test/processors/section_inserter_test.rb
-- test/processors/related_items_inserter_test.rb
+- test/processors/google_analytics_test.rb
 - test/processors/header_context_inserter_test.rb
-- test/typical_usage_test.rb
+- test/processors/body_inserter_test.rb
+- test/processors/logo_class_inserter_test.rb
+- test/processors/search_path_setter_test.rb
+- test/artefact_test.rb
+- test/skin_test.rb
+- test/headers_test.rb
 - test/test_template_dependency_on_static_test.rb
+- test/typical_usage_test.rb
+- test/fixtures/500.html.erb
+- test/fixtures/404.html.erb
+- test/fixtures/report_a_problem.raw.html.erb
+- test/fixtures/related.raw.html.erb
+- test/fixtures/wrapper.html.erb
 - test/test_helper.rb
 - bin/render_slimmer_error
 homepage: http://github.com/alphagov/slimmer
@@ -217,7 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2539638205319737760
+      hash: 3747362976319846846
       segments: 
       - 0
       version: "0"
@@ -226,7 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2539638205319737760
+      hash: 3747362976319846846
       segments: 
       - 0
       version: "0"
@@ -238,22 +238,22 @@ signing_key:
 specification_version: 3
 summary: Thinner than the skinner
 test_files: 
-- test/headers_test.rb
-- test/artefact_test.rb
-- test/fixtures/related.raw.html.erb
-- test/fixtures/500.html.erb
-- test/fixtures/404.html.erb
-- test/fixtures/wrapper.html.erb
-- test/fixtures/report_a_problem.raw.html.erb
-- test/skin_test.rb
-- test/processors/logo_class_inserter_test.rb
-- test/processors/google_analytics_test.rb
+- test/processors/related_items_inserter_test.rb
 - test/processors/report_a_problem_inserter_test.rb
-- test/processors/body_inserter_test.rb
-- test/processors/search_path_setter_test.rb
 - test/processors/section_inserter_test.rb
-- test/processors/related_items_inserter_test.rb
+- test/processors/google_analytics_test.rb
 - test/processors/header_context_inserter_test.rb
-- test/typical_usage_test.rb
+- test/processors/body_inserter_test.rb
+- test/processors/logo_class_inserter_test.rb
+- test/processors/search_path_setter_test.rb
+- test/artefact_test.rb
+- test/skin_test.rb
+- test/headers_test.rb
 - test/test_template_dependency_on_static_test.rb
+- test/typical_usage_test.rb
+- test/fixtures/500.html.erb
+- test/fixtures/404.html.erb
+- test/fixtures/report_a_problem.raw.html.erb
+- test/fixtures/related.raw.html.erb
+- test/fixtures/wrapper.html.erb
 - test/test_helper.rb