slimmer 9.5.0 → 9.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 902e1337c390ba8e7ebb919aa6a6de2ddac90b4f
-  data.tar.gz: 3f38fdc000b501c9fb0a1f8e99e93b23b324c9d6
+  metadata.gz: d37cd678afb1296a6d4cbf84aee3bcd99a74df28
+  data.tar.gz: d2708c4354d2dbf6c4521ee51826636c40a18b3e
 SHA512:
-  metadata.gz: f5c218e9f3a30cbbb927e98c3a435fc752b1890224fdcc35042992d8c9b6aaffaac3cdd369d48928d6505636098d382f792e3cdb691ca917656f129754d3fcbf
-  data.tar.gz: ff37333f3ffda92f97ee5dbd7fa065c4eab3a294d12dd497ba126f4aca02b426fed33b761ad15f7c728544f1308f2dc09eaa2303326758df7e436759739e082f
+  metadata.gz: a3795f3e350eac43b774b3d08acc781b30017f8dd268ce937dc5bcb170023ee48ac1e4fee5081f43a5cc0310eef9f8d24584868e7e1458235d8e9a21ef9cc4ae
+  data.tar.gz: a2b70d4c759b3f0993d3274b5aed1dbc9ff7abbed4ef61f86bbf9b02e260bdfb483f1c1b3c2823d096a91b6f810c40594c8feea7bec208f51954065cfac92ebc

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 9.6.0
+
+* Adds an 'inside header inserter' processor which allows an application to
+  inject a block of HTML after the logo by including a .inside-header element
+  in their application’s output.
+  (PR #167 https://github.com/alphagov/slimmer/pull/167)
+
+* Remove `MetaViewportRemover` processor as it is no longer used.
+  (PR #166 https://github.com/alphagov/slimmer/pull/166)
+
 # 9.5.0
 
 * Adds a Cucumber helper that makes it easy for host applications to

data/Rakefile

@@ -4,6 +4,8 @@ require "bundler/gem_tasks"
 require "rdoc/task"
 require 'rake/testtask'
 
+Dir.glob('lib/tasks/*.rake').each { |r| import r }
+
 RDoc::Task.new do |rd|
   rd.rdoc_files.include("lib/**/*.rb")
   rd.rdoc_dir = "rdoc"
@@ -22,4 +24,4 @@ task :publish_gem do |t|
   puts "Published #{gem}" if gem
 end
 
-task :default => :test
+task :default => [:test, :lint]

data/lib/slimmer.rb

@@ -29,8 +29,8 @@ module Slimmer
     autoload :FooterRemover, 'slimmer/processors/footer_remover'
     autoload :MetadataInserter, 'slimmer/processors/metadata_inserter'
     autoload :HeaderContextInserter, 'slimmer/processors/header_context_inserter'
+    autoload :InsideHeaderInserter, 'slimmer/processors/inside_header_inserter'
     autoload :NavigationMover, 'slimmer/processors/navigation_mover'
-    autoload :MetaViewportRemover, 'slimmer/processors/meta_viewport_remover'
     autoload :RelatedItemsInserter, 'slimmer/processors/related_items_inserter'
     autoload :ReportAProblemInserter, 'slimmer/processors/report_a_problem_inserter'
     autoload :SearchIndexSetter, 'slimmer/processors/search_index_setter'

data/lib/slimmer/headers.rb

@@ -11,7 +11,6 @@ module Slimmer
       organisations:        "Organisations",
       report_a_problem:     "Report-a-Problem",
       world_locations:      "World-Locations",
-      remove_meta_viewport: "Remove-Meta-Viewport",
       result_count:         "Result-Count",
       search_parameters:    "Search-Parameters",
       section:              "Section",
@@ -27,7 +26,6 @@ module Slimmer
     REPORT_A_PROBLEM_FORM = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:report_a_problem]}"
     WORLD_LOCATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:world_locations]}"
     PAGE_OWNER_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:page_owner]}"
-    REMOVE_META_VIEWPORT = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:remove_meta_viewport]}"
     RESULT_COUNT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:result_count]}"
     SEARCH_PATH_HEADER = "#{HEADER_PREFIX}-Search-Path"
     SEARCH_PARAMETERS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:search_parameters]}"

data/lib/slimmer/processors/inside_header_inserter.rb

@@ -0,0 +1,11 @@
+module Slimmer::Processors
+  class InsideHeaderInserter
+    def filter(src, dest)
+      insertion = src.at_css('.slimmer-inside-header')
+
+      if insertion
+        dest.at_css('.header-logo').add_next_sibling(insertion.inner_html)
+      end
+    end
+  end
+end

data/lib/slimmer/skin.rb

@@ -113,6 +113,7 @@ module Slimmer
         Processors::ConditionalCommentMover.new(),
         Processors::BodyInserter.new(wrapper_id),
         Processors::BodyClassCopier.new,
+        Processors::InsideHeaderInserter.new,
         Processors::HeaderContextInserter.new(),
         Processors::SectionInserter.new(artefact),
         Processors::MetadataInserter.new(response, artefact, options[:app_name]),
@@ -123,7 +124,6 @@ module Slimmer
                                                source_request.url,
                                                response.headers,
                                                wrapper_id),
-        Processors::MetaViewportRemover.new(self, response.headers),
         Processors::SearchRemover.new(response.headers),
       ]
 

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '9.5.0'
+  VERSION = '9.6.0'
 end

data/lib/tasks/lint.rake

@@ -0,0 +1,4 @@
+desc "Run govuk-lint with similar params to CI"
+task :lint do
+  sh "bundle exec govuk-lint-ruby --diff --cached --format clang bin lib test"
+end

data/test/headers_test.rb

@@ -59,15 +59,6 @@ class HeadersTest < MiniTest::Test
       set_slimmer_headers seccion: "wrong"
     end
   end
-
-  def test_should_not_have_meta_viewport_header_set
-    assert_equal nil, headers["X-Slimmer-Remove-Meta-Viewport"]
-  end
-
-  def test_should_set_meta_viewport_header
-    set_slimmer_headers remove_meta_viewport: true
-    assert_equal "true", headers["X-Slimmer-Remove-Meta-Viewport"]
-  end
 end
 
 describe Slimmer::Headers do

data/test/processors/inside_header_inserter_test.rb

@@ -0,0 +1,35 @@
+require_relative '../test_helper'
+
+class InsideHeaderInserterTest < MiniTest::Test
+  def test_should_insert_into_header
+    source = as_nokogiri %{
+      <html>
+        <body>
+          <div class="slimmer-inside-header">
+            <h2>Inserted Page Title</h2>
+          </div>
+        </body>
+      </html>
+    }
+    template = as_nokogiri %{
+      <html>
+        <body>
+          <div class="header-global">
+            <div class="header-logo">
+              <a href="https://www.gov.uk/" title="Go to the GOV.UK homepage" id="logo" class="content">
+                <img src="/assets/gov.uk_logotype_crown_invert_trans.png" width="35" height="31" alt="">
+              </a>
+            </div>
+          </div>
+        </body>
+      </html>
+    }
+
+    Slimmer::Processors::InsideHeaderInserter.new.filter(source, template)
+
+    assert_in template,
+      "div.header-global .header-logo + h2",
+      "Inserted Page Title",
+      'Expecting the H2 to be inserted after .header-logo'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 9.5.0
+  version: 9.6.0
 platform: ruby
 authors:
 - Ben Griffiths
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -268,7 +268,7 @@ files:
 - lib/slimmer/processors/conditional_comment_mover.rb
 - lib/slimmer/processors/footer_remover.rb
 - lib/slimmer/processors/header_context_inserter.rb
-- lib/slimmer/processors/meta_viewport_remover.rb
+- lib/slimmer/processors/inside_header_inserter.rb
 - lib/slimmer/processors/metadata_inserter.rb
 - lib/slimmer/processors/navigation_mover.rb
 - lib/slimmer/processors/related_items_inserter.rb
@@ -289,6 +289,7 @@ files:
 - lib/slimmer/test_templates/header_footer_only.html
 - lib/slimmer/test_templates/wrapper.html
 - lib/slimmer/version.rb
+- lib/tasks/lint.rake
 - lib/tasks/slimmer.rake
 - test/artefact_test.rb
 - test/cache_test.rb
@@ -304,7 +305,7 @@ files:
 - test/headers_test.rb
 - test/processors/body_inserter_test.rb
 - test/processors/header_context_inserter_test.rb
-- test/processors/meta_viewport_remover_test.rb
+- test/processors/inside_header_inserter_test.rb
 - test/processors/metadata_inserter_test.rb
 - test/processors/navigation_mover_test.rb
 - test/processors/related_items_inserter_test.rb
@@ -344,32 +345,32 @@ signing_key:
 specification_version: 4
 summary: Thinner than the skinner
 test_files:
-- test/component_resolver_test.rb
-- test/changelog_test.rb
-- test/test_helpers/shared_templates_test.rb
+- test/test_helper.rb
 - test/typical_usage_test.rb
+- test/cache_test.rb
+- test/test_helpers/shared_templates_test.rb
 - test/skin_test.rb
-- test/artefact_test.rb
 - test/fixtures/500.html.erb
-- test/fixtures/proposition_menu.html.erb
+- test/fixtures/related.raw.html.erb
+- test/fixtures/404.html.erb
 - test/fixtures/410.html.erb
 - test/fixtures/core_layout.html.erb
-- test/fixtures/404.html.erb
+- test/fixtures/proposition_menu.html.erb
 - test/fixtures/report_a_problem.raw.html.erb
-- test/fixtures/related.raw.html.erb
+- test/changelog_test.rb
+- test/component_resolver_test.rb
 - test/headers_test.rb
 - test/test_template_dependency_on_static_test.rb
-- test/cache_test.rb
-- test/test_helper.rb
+- test/artefact_test.rb
+- test/processors/search_parameter_inserter_test.rb
+- test/processors/metadata_inserter_test.rb
 - test/processors/header_context_inserter_test.rb
-- test/processors/body_inserter_test.rb
-- test/processors/navigation_mover_test.rb
 - test/processors/related_items_inserter_test.rb
-- test/processors/search_path_setter_test.rb
-- test/processors/meta_viewport_remover_test.rb
-- test/processors/search_parameter_inserter_test.rb
-- test/processors/search_remover_test.rb
 - test/processors/section_inserter_test.rb
+- test/processors/body_inserter_test.rb
 - test/processors/report_a_problem_inserter_test.rb
+- test/processors/search_remover_test.rb
+- test/processors/inside_header_inserter_test.rb
+- test/processors/navigation_mover_test.rb
+- test/processors/search_path_setter_test.rb
 - test/processors/tag_mover_test.rb
-- test/processors/metadata_inserter_test.rb

data/lib/slimmer/processors/meta_viewport_remover.rb

@@ -1,19 +0,0 @@
-module Slimmer::Processors
-  class MetaViewportRemover
-    def initialize(skin, headers)
-      @skin = skin
-      @headers = headers
-    end
-
-    def filter(content_document, page_template)
-      if should_remove_meta_viewport?
-        viewport = page_template.at_xpath('//head//meta[@name="viewport"]')
-        viewport.remove if viewport
-      end
-    end
-
-    def should_remove_meta_viewport?
-      !! @headers[Slimmer::Headers::REMOVE_META_VIEWPORT]
-    end
-  end
-end

data/test/processors/meta_viewport_remover_test.rb

@@ -1,39 +0,0 @@
-require_relative "../test_helper"
-
-class MetaViewportRemover < SlimmerIntegrationTest
-  TEMPLATE = <<-END
-      <html>
-        <head>
-          <meta name="viewport" content="width=device-width, intial-scale=1">
-        </head>
-        <body>
-          <div><div id="wrapper"></div></div>
-        </body>
-      </html>
-    END
-
-  NO_VIEWPORT_TEMPLATE = <<-END
-      <html>
-        <head>
-        </head>
-        <body>
-          <div><div id="wrapper"></div></div>
-        </body>
-      </html>
-    END
-
-  def test_should_leave_all_content_as_it_is_if_there_is_not_a_meta_viewport_header_set
-    given_response 200, TEMPLATE, {}
-    assert_equal "<meta name=\"viewport\" content=\"width=device-width, intial-scale=1\">",
-                 Nokogiri::HTML.parse(last_response.body).at_xpath('//head//meta[@name="viewport"]').to_s
-  end
-
-  def test_should_not_fail_if_there_is_no_viewport_meta
-    given_response 200, NO_VIEWPORT_TEMPLATE, {Slimmer::Headers::REMOVE_META_VIEWPORT => "true"}
-  end
-
-  def test_should_remove_the_meta_viewport_if_the_relevant_header_is_set
-    given_response 200, TEMPLATE, {Slimmer::Headers::REMOVE_META_VIEWPORT => "true"}
-    assert_nil Nokogiri::HTML.parse(last_response.body).at_xpath('//head//meta[@name="viewport"]')
-  end
-end