slimmer 1.2.5 → 2.0.0

data/test/fixtures/related.raw.html.erb

@@ -1,31 +1,35 @@
-<% if artefact && artefact.present? && artefact.related_items.size > 0 %>
+<% if artefact %>
 
 <!-- related -->
 <div class="related-positioning">
-	<div class="related-container">
+  <div class="related-container">
 
-		<div class="related">
-			<div class="inner group">
-				<h2>Related tools &amp; topics</h2>
-				<nav role="navigation">
-				  <ul>
-				      <% (artefact.related_items || []).each do |item| %>
-  				      <% if item.artefact %>
-  				      <li class="<%= h(item.artefact.kind) %>">
-  				        <a href="/<%= h(item.artefact.slug) %>"><%= h(item.artefact.name) %></a>
-  				      </li>
-  				      <% end %>
+    <div class="related">
+      <div class="inner group">
+        <h2>Related topics</h2>
+        <nav role="navigation">
+          <ul>
+            <% if artefact["related_items"].any? %>
+              <% artefact["related_items"].each do |item| %>
+                <% if item["artefact"] %>
+                <li class="<%= h item["artefact"]["kind"] %>">
+                  <a href="/<%= h item["artefact"]["slug"] %>"><%= h item["artefact"]["name"] %></a>
+                </li>
+                <% end %>
               <% end %>
-				      <% if artefact.section %>
-                <li class="related-topic"><a href="/browse/<%= h(artefact.section.parameterize) %>"
-                  >More from the <span><%= h(artefact.section) %></span> section</a></li>
-				      <% end %>
-				  </ul>
-				</nav>
-	   </div>
-	 </div>
+            <% end %>
 
-	</div>
+            <% if artefact["section"] %>
+              <% section, subsection = artefact["section"].split(':', 2) %>
+              <li class="related-topic"><a href="/browse/<%= h section.parameterize %>"
+                >More from the <span><%= h section %></span> section</a></li>
+            <% end %>
+          </ul>
+        </nav>
+     </div>
+   </div>
+
+  </div>
 </div>
 <!-- end related -->
 <% end %>

data/test/fixtures/wrapper.html.erb

@@ -14,6 +14,8 @@
     </div>
 
     <script id="ga-params" type="text/javascript">
+      var GOVUK = GOVUK || {};
+      GOVUK.Analytics = GOVUK.Analytics || {};
       var _gaq = _gaq || [];
     </script>
   </body>

data/test/headers_test.rb

@@ -1,4 +1,4 @@
-require "test_helper"
+require_relative "test_helper"
 require "slimmer/headers"
 
 class HeadersTest < MiniTest::Unit::TestCase
@@ -55,3 +55,58 @@ class HeadersTest < MiniTest::Unit::TestCase
     end
   end
 end
+
+describe Slimmer::Headers do
+  include Slimmer::Headers
+  attr_accessor :headers
+
+  before do
+    self.headers = {}
+  end
+
+  describe "setting the artefact header" do
+
+    it "should convert a hash to JSON and insert into the header" do
+      artefact = {"foo" => "bar", "slug" => "vat-rates"}
+      self.set_slimmer_artefact(artefact)
+      assert_equal artefact.to_json, headers[Slimmer::Headers::ARTEFACT_HEADER]
+    end
+
+    it "should convert an OpenStruct to JSON and insert into the header" do
+      artefact = OpenStruct.new(section: 'missing', need_id: 'missing', kind: 'missing')
+      self.set_slimmer_artefact(artefact)
+      assert_equal artefact.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 strip the actions from the artefact" do
+      artefact = {"foo" => "bar", "slug" => "vat-rates", "actions" => "some_actions"}
+      self.set_slimmer_artefact(artefact)
+      assert_equal ({"foo" => "bar", "slug" => "vat-rates"}).to_json, headers[Slimmer::Headers::ARTEFACT_HEADER]
+    end
+
+    it "should strip the actions from any related items" do
+      artefact = {"slug" => "vat-rates", "related_items" => [
+        {"artefact" => {"slug" => 'a-thing', "actions" => "something"}},
+        {"artefact" => {"slug" => 'another-thing', "actions" => "something else"}}
+      ]}
+      self.set_slimmer_artefact(artefact)
+      assert_equal ({"slug" => "vat-rates", "related_items" => [
+        {"artefact" => {"slug" => 'a-thing'}}, {"artefact" => {"slug" => 'another-thing'}}
+      ]}).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
+      self.set_slimmer_artefact(artefact)
+      assert_equal artefact_copy, artefact
+    end
+  end
+end

data/test/processors/body_inserter_test.rb

@@ -9,7 +9,7 @@ class BodyInserterTest < MiniTest::Unit::TestCase
       <html><body><nav></nav><div id="wrapper"><p>this should be moved</p></div></body></html>
     }
 
-    Slimmer::BodyInserter.new.filter(source, template)
+    Slimmer::Processors::BodyInserter.new.filter(source, template)
     assert_in template, "#wrapper", %{<p>this should be moved</p>}
   end
 
@@ -22,7 +22,7 @@ class BodyInserterTest < MiniTest::Unit::TestCase
       <html><body><nav></nav><div id="wrapper"><p>#{unicode_endash}</p></div></body></html>
     }
 
-    Slimmer::BodyInserter.new.filter(source, template)
+    Slimmer::Processors::BodyInserter.new.filter(source, template)
     assert_equal unicode_endash, template.at_css("#wrapper p").inner_text
   end
 
@@ -36,8 +36,8 @@ class BodyInserterTest < MiniTest::Unit::TestCase
       <html><body><div id="some_other_id"><p>this should be moved</p></div></body></html>
     }
 
-    Slimmer::BodyInserter.new("some_other_id").filter(source, template)
+    Slimmer::Processors::BodyInserter.new("some_other_id").filter(source, template)
     assert_not_in template, "#wrapper"
     assert_in template, "#some_other_id", %{<p>this should be moved</p>}
   end
-end
+end

data/test/{google_analytics_test.rb → processors/google_analytics_test.rb}

@@ -22,6 +22,13 @@ module GoogleAnalyticsTest
       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
@@ -30,6 +37,10 @@ module GoogleAnalyticsTest
       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
@@ -54,21 +65,41 @@ module GoogleAnalyticsTest
       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_section_in_GOVUK_object
+      assert_set_var "Format", "custard", govuk
+    end
+
     def test_should_pass_need_ID_to_GA
       assert_custom_var 3, "NeedID", "42", PAGE_LEVEL_EVENT
     end
 
+    def test_should_set_section_in_GOVUK_object
+      assert_set_var "NeedID", "42", govuk
+    end
+
     def test_should_pass_proposition_to_GA
       assert_custom_var 4, "Proposition", "trifle", PAGE_LEVEL_EVENT
     end
 
+    def test_should_set_section_in_GOVUK_object
+      assert_set_var "Proposition", "trifle", govuk
+    end
+
     def test_should_pass_result_count_to_GA
       assert_custom_var 5, "ResultCount", "3", PAGE_LEVEL_EVENT
     end
+
+    def test_should_set_section_in_GOVUK_object
+      assert_set_var "ResultCount", "3", govuk
+    end
   end
 
   class WithoutHeadersTest < SlimmerIntegrationTest

data/test/processors/header_context_inserter_test.rb

@@ -9,7 +9,7 @@ class HeaderContextInserterTest < MiniTest::Unit::TestCase
       <html><body><nav></nav><div class="header-context"><p>this should be moved</p></div></body></html>
     }
 
-    Slimmer::HeaderContextInserter.new.filter(source, template)
+    Slimmer::Processors::HeaderContextInserter.new.filter(source, template)
     assert_in template, ".header-context", %{<p>this should be moved</p>}
   end
 
@@ -21,7 +21,7 @@ class HeaderContextInserterTest < MiniTest::Unit::TestCase
       <html><body><nav></nav><div class="header-context app-class"><p>this should be moved</p></div></body></html>
     }
 
-    Slimmer::HeaderContextInserter.new.filter(source, template)
+    Slimmer::Processors::HeaderContextInserter.new.filter(source, template)
     assert_in template, ".header-context.app-class", %{<p>this should be moved</p>}
     assert_not_in template, ".header-context.template-class"
   end
@@ -34,7 +34,7 @@ class HeaderContextInserterTest < MiniTest::Unit::TestCase
       <html><body><nav></nav></body></html>
     }
 
-    Slimmer::HeaderContextInserter.new.filter(source, template)
+    Slimmer::Processors::HeaderContextInserter.new.filter(source, template)
     assert_in template, ".header-context", %{should not be removed}
   end
 
@@ -46,6 +46,6 @@ class HeaderContextInserterTest < MiniTest::Unit::TestCase
       <html><body><div><div class="header-context">should be ignored</div></div></body></html>
     }
 
-    Slimmer::HeaderContextInserter.new.filter(source, template) # should not raise
+    Slimmer::Processors::HeaderContextInserter.new.filter(source, template) # should not raise
   end
-end
+end

data/test/processors/logo_class_inserter_test.rb

@@ -0,0 +1,55 @@
+require_relative "../test_helper.rb"
+
+describe Slimmer::Processors::LogoClassInserter do
+
+  before do
+    @artefact = {
+      "slug" => "vat",
+      "tag_ids" => ['businesslink']
+    }
+    @processor = Slimmer::Processors::LogoClassInserter.new(@artefact)
+    @template = as_nokogiri %{
+      <html><body><div><div id="wrapper"></div></div></body></html>
+    }
+  end
+
+  it "should add businesslink class to the wrapper" do
+    @processor.filter(:any_source, @template)
+    assert_in @template, "div#wrapper.businesslink"
+  end
+
+  it "should add multiple classes to the wrapper" do
+    @artefact["tag_ids"] = ['businesslink', 'directgov']
+    @processor.filter(:any_source, @template)
+    assert_in @template, "div#wrapper.businesslink.directgov"
+  end
+
+  it "should ignore non-known tags" do
+    @artefact["tag_ids"] = ['businesslink', 'business', 'fooey']
+    @processor.filter(:any_source, @template)
+    assert_in @template, "div#wrapper.businesslink"
+    assert_not_in @template, "div#wrapper.business"
+    assert_not_in @template, "div#wrapper.fooey"
+  end
+
+  it "should do nothing if the #wrapper element doesn't exist" do
+    @template = as_nokogiri %{
+      <html><body><div><div id="not_wrapper"></div></div></body></html>
+    }
+    @processor.filter(:any_source, @template)
+    assert_in @template, "div#not_wrapper"
+    assert_not_in @template, "div#wrapper"
+  end
+
+  it "should do nothing if the artefact has no tag_ids" do
+    @artefact.delete("tag_ids")
+    @processor.filter(:any_source, @template)
+    assert_in @template, "div#wrapper"
+  end
+
+  it "should not blow up without an artefact" do
+    processor = Slimmer::Processors::LogoClassInserter.new(nil)
+    # assert_nothing_raised
+    processor.filter(:any_source, @template)
+  end
+end

data/test/processors/related_items_inserter_test.rb

@@ -0,0 +1,61 @@
+require_relative '../test_helper'
+
+class RelatedItemsInserterTest < MiniTest::Unit::TestCase
+
+  def setup
+    super
+    @related_template = File.read( File.dirname(__FILE__) + "/../fixtures/related.raw.html.erb" )
+    @artefact = {
+      'slug' => 'vat',
+      'title' => 'VAT',
+      'related_items' => [
+        { 'artefact' => { 'kind' => 'answer', 'name' => 'VAT rates', 'slug' => 'vat-rates' } },
+        { 'artefact' => { 'kind' => 'guide', 'name' => 'Starting to import', 'slug' => 'starting-to-import' } },
+      ]
+    }
+  end
+  
+  def test_should_add_related_items
+    source = as_nokogiri %{
+      <html>
+        <body class="mainstream">
+          <div id="wrapper">The body of the page<div id="related-items"></div></div>
+        </body>
+      </html>
+    }
+    template = as_nokogiri %{
+      <html>
+        <body class="mainstream">
+          <div id="wrapper"></div>
+          <div id="related-items"></div>
+        </body>
+      </html>
+    }
+
+    Slimmer::Processors::RelatedItemsInserter.new(@related_template, @artefact).filter(source, template)
+    assert_in template, "div.related h2", "Related topics"
+    assert_in template, "div.related nav[role=navigation] ul li.answer:nth-child(1) a[href='/vat-rates']", "VAT rates"
+    assert_in template, "div.related nav[role=navigation] ul li.guide:nth-child(2) a[href='/starting-to-import']", "Starting to import"
+  end
+
+  def test_should_not_add_related_items_for_non_mainstream_source
+    source = as_nokogiri %{
+      <html>
+        <body class="nonmainstream">
+          <div id="wrapper">The body of the page<div id="related-items"></div></div>
+        </body>
+      </html>
+    }
+    template = as_nokogiri %{
+      <html>
+        <body class="mainstream">
+          <div id="wrapper"></div>
+          <div id="related-items"></div>
+        </body>
+      </html>
+    }
+
+    Slimmer::Processors::RelatedItemsInserter.new(@related_template, @artefact).filter(source, template)
+    assert_not_in template, "div.related"
+  end
+end

data/test/processors/section_inserter_test.rb

@@ -20,7 +20,7 @@ class SectionInserterTest < MiniTest::Unit::TestCase
       </html>
     }
 
-    Slimmer::SectionInserter.new.filter(:any_source, template)
+    Slimmer::Processors::SectionInserter.new.filter(:any_source, template)
     assert_in template, "nav[role=navigation] ol li:nth-child(1)", %{<a href="/">Home</a>}
     assert_in template, "nav[role=navigation] ol li:nth-child(2)", %{<a href="/browse/business">Business</a>}
   end
@@ -43,7 +43,7 @@ class SectionInserterTest < MiniTest::Unit::TestCase
       </html>
     }
 
-    Slimmer::SectionInserter.new.filter(:any_source, template)
+    Slimmer::Processors::SectionInserter.new.filter(:any_source, template)
     assert_in template, "nav[role=navigation] ol li:nth-child(1)", %{<a href="/">Home</a>}
     assert_in template, "nav[role=navigation] ol li:nth-child(2)", %{<a href="/browse">All Sections</a>}
     assert_in template, "nav[role=navigation] ol li:nth-child(3)", %{<a href="/browse/business">Business</a>}
@@ -63,7 +63,7 @@ class SectionInserterTest < MiniTest::Unit::TestCase
       </html>
     }
 
-    Slimmer::SectionInserter.new.filter(:any_source, template)
+    Slimmer::Processors::SectionInserter.new.filter(:any_source, template)
     assert_in template, "nav[role=navigation] ol li:nth-child(1)", %{<a href="/">Home</a>}
     assert_not_in template, "nav[role=navigation] ol li:nth-child(2)"
   end
@@ -82,7 +82,7 @@ class SectionInserterTest < MiniTest::Unit::TestCase
       </html>
     }
 
-    Slimmer::SectionInserter.new.filter(:any_source, template)
+    Slimmer::Processors::SectionInserter.new.filter(:any_source, template)
     assert_in template, "nav[role=navigation] ol li:nth-child(1)", %{<a href="/">Home</a>}
     assert_not_in template, "nav[role=navigation] ol li:nth-child(2)"
   end
@@ -99,7 +99,22 @@ class SectionInserterTest < MiniTest::Unit::TestCase
       </html>
     }
 
-    Slimmer::SectionInserter.new.filter(:any_source, template)
+    Slimmer::Processors::SectionInserter.new.filter(:any_source, template)
     assert_not_in template, "nav[role=navigation]"
   end
+
+  def test_should_not_blow_up_without_an_artefact
+    template = as_nokogiri %{
+      <html>
+        <body>
+          <nav role="navigation">
+            <ol><li><a href="/">Home</a></li></ol>
+          </nav>
+        </body>
+      </html>
+    }
+
+    # assert_nothing_raised do
+    Slimmer::Processors::SectionInserter.new(nil).filter(:any_source, template)
+  end
 end

data/test/test_helper.rb

@@ -15,11 +15,17 @@ class MiniTest::Unit::TestCase
     Nokogiri::HTML.parse(html_string.strip)
   end
 
-  def assert_in(template, selector, content, message=nil)
-    assert_equal content, template.at_css(selector).inner_html.to_s, message
+  def assert_in(template, selector, content=nil, message=nil)
+    message ||= "Expected to find #{content ? "#{content.inspect} at " : ""}#{selector.inspect} in the output template"
+
+    assert template.at_css(selector), message + ", but selector not found."
+
+    if content
+      assert_equal content, template.at_css(selector).inner_html.to_s, message
+    end
   end
 
-  def assert_not_in(template, selector, message="didn't exist to find #{selector}")
+  def assert_not_in(template, selector, message="didn't expect to find #{selector}")
     refute template.at_css(selector), message
   end
 
@@ -34,32 +40,35 @@ end
 class SlimmerIntegrationTest < MiniTest::Unit::TestCase
   include Rack::Test::Methods
 
+  # given_response can either be called from a setup method, or in the class scope.
+  # The setup method variant is necessary if you want to pass variables into the call that
+  # are created in higher setup methods.
   def self.given_response(code, body, headers={}, app_options={})
-    define_method(:app) do
-      inner_app = proc { |env|
-        [code, {"Content-Type" => "text/html"}.merge(headers), body]
-      }
-      Slimmer::App.new inner_app, {asset_host: "http://template.local"}.merge(app_options)
-    end
-
-    define_method :teardown do
-      WebMock.reset!
+    define_method(:setup) do
+      super()
+      given_response(code, body, headers, app_options)
     end
+  end
 
-    define_method(:setup_template) do
-      template_name = case code
-      when 200 then 'wrapper'
-      when 404 then '404'
-      else          '500'
+  def given_response(code, body, headers={}, app_options={})
+    self.class.class_eval do
+      define_method(:app) do
+        inner_app = proc { |env|
+          [code, {"Content-Type" => "text/html"}.merge(headers), body]
+        }
+        Slimmer::App.new inner_app, {asset_host: "http://template.local"}.merge(app_options)
       end
+    end
 
-      use_template(template_name)
-      use_template('related.raw')
+    template_name = case code
+    when 200 then 'wrapper'
+    when 404 then '404'
+    else          '500'
     end
-  end
 
-  def setup
-    setup_template if respond_to? :setup_template
+    use_template(template_name)
+    use_template('related.raw')
+
     fetch_page
   end