slimmer 4.3.1 → 5.0.0

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 5.0.0
+
+This release contains breaking changes.
+
+* The report-a-problem form is now zero-configuration; it's no longer necessary
+  to add a `div class="report-a-problem"` or extra styling to the app. Slimmer
+  appends the form to the `wrapper` div by default (the default CSS selector for
+  the wrapper div is `#wrapper`, but this id can be overwritten by defining
+  `config.slimmer.wrapper_id` in the app's `application.rb`).
+
+* The report-a-problem form is now opt-out; it's added by default, but can be
+  skipped by setting the `Slimmer::Headers::REPORT_A_PROBLEM_FORM` header value
+  to `false`.
+
+* The steps for upgrading an app that already has report-a-problem are:
+
+  1. Remove all `div class="report-a-problem"` from the app
+  2. Remove all CSS relating to `report-a-problem` or `report-a-problem-toggle`
+  3. Set `Slimmer::Headers::REPORT_A_PROBLEM_FORM` to `false` for any controllers
+  or actions where you don't want the form to appear.
+
 # 4.3.1
 
 * When running tests, don't hide exceptions in the processors. Fix a bug in the

data/lib/slimmer/headers.rb

@@ -13,6 +13,7 @@ module Slimmer
       page_owner:           "Page-Owner",
       proposition:          "Proposition",
       organisations:        "Organisations",
+      report_a_problem:     "Report-a-Problem",
       world_locations:      "World-Locations",
       remove_meta_viewport: "Remove-Meta-Viewport",
       result_count:         "Result-Count",
@@ -29,6 +30,7 @@ module Slimmer
     BETA_LABEL = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:beta_label]}"
     FORMAT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:format]}"
     ORGANISATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:organisations]}"
+    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]}"

data/lib/slimmer/processors/report_a_problem_inserter.rb

@@ -2,15 +2,16 @@ module Slimmer::Processors
   class ReportAProblemInserter
     include ERB::Util
 
-    def initialize(skin, url, headers)
+    def initialize(skin, url, headers, wrapper_id)
       @skin = skin
       @request_url = url
       @headers = headers
+      @wrapper_id = wrapper_id
     end
 
     def filter(content_document, page_template)
-      if (placeholder = page_template.at_css('body #report-a-problem'))
-        placeholder.replace(report_a_problem_block)
+      if enabled? && container = page_template.at_css('#' + @wrapper_id)
+        container.add_child(report_a_problem_block)
       end
     end
 
@@ -22,6 +23,10 @@ module Slimmer::Processors
       html = ERB.new(report_a_problem_template).result(binding)
       Nokogiri::HTML.fragment(html)
     end
+
+  private
+    def enabled?
+      @headers[Slimmer::Headers::REPORT_A_PROBLEM_FORM] != 'false'
+    end
   end
 end
-

data/lib/slimmer/skin.rb

@@ -107,12 +107,13 @@ module Slimmer
 
     def success(source_request, response, body)
       artefact = artefact_from_header(response)
+      wrapper_id = options[:wrapper_id] || 'wrapper'
       processors = [
         Processors::TitleInserter.new(),
         Processors::TagMover.new(),
         Processors::NavigationMover.new(self),
         Processors::ConditionalCommentMover.new(),
-        Processors::BodyInserter.new(options[:wrapper_id] || 'wrapper'),
+        Processors::BodyInserter.new(wrapper_id),
         Processors::BodyClassCopier.new,
         Processors::HeaderContextInserter.new(),
         Processors::SectionInserter.new(artefact),
@@ -121,7 +122,10 @@ module Slimmer
         Processors::SearchPathSetter.new(response),
         Processors::RelatedItemsInserter.new(self, artefact),
         Processors::LogoClassInserter.new(artefact),
-        Processors::ReportAProblemInserter.new(self, source_request.url, response.headers),
+        Processors::ReportAProblemInserter.new(self,
+                                               source_request.url,
+                                               response.headers,
+                                               wrapper_id),
         Processors::MetaViewportRemover.new(response),
         Processors::BetaNoticeInserter.new(self, response.headers),
         Processors::BetaLabelInserter.new(self, response.headers),

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '4.3.1'
+  VERSION = '5.0.0'
 end

data/test/processors/report_a_problem_inserter_test.rb

@@ -12,7 +12,12 @@ class ReportAProblemInserterTest < MiniTest::Test
     @skin.expects(:template).with('report_a_problem.raw').returns(@report_a_problem_template)
 
     headers = { Slimmer::Headers::APPLICATION_NAME_HEADER => 'government' }
-    Slimmer::Processors::ReportAProblemInserter.new(@skin, "http://www.example.com/somewhere?foo=bar", headers).filter(:any_source, template)
+    Slimmer::Processors::ReportAProblemInserter.new(
+      @skin,
+      "http://www.example.com/somewhere?foo=bar",
+      headers,
+      "wrapper"
+    ).filter(:any_source, template)
 
     assert_in template, "#wrapper div.report-a-problem-container"
     assert_in template, "div.report-a-problem-container form input[name=url][value='http://www.example.com/somewhere?foo=bar']"
@@ -22,7 +27,12 @@ class ReportAProblemInserterTest < MiniTest::Test
   def test_should_add_page_owner_if_provided_in_headers
     @skin.expects(:template).with('report_a_problem.raw').returns(@report_a_problem_template)
     headers = { Slimmer::Headers::PAGE_OWNER_HEADER => 'hmrc' }
-    Slimmer::Processors::ReportAProblemInserter.new(@skin, "http://www.example.com/somewhere", headers).filter(:any_source, template)
+    Slimmer::Processors::ReportAProblemInserter.new(
+      @skin,
+      "http://www.example.com/somewhere",
+      headers,
+      "wrapper"
+    ).filter(:any_source, template)
 
     assert_in template, "#wrapper div.report-a-problem-container"
     assert_in template, "div.report-a-problem-container form input[name=page_owner][value='hmrc']"
@@ -32,15 +42,20 @@ class ReportAProblemInserterTest < MiniTest::Test
     template = as_nokogiri %{
       <html>
         <body class="mainstream">
-          <div id="wrapper">
-          </div>
         </body>
       </html>
     }
 
     @skin.expects(:template).never # Shouldn't fetch template when not inserting block
 
-    Slimmer::Processors::ReportAProblemInserter.new(@skin, "", {}).filter(:any_source, template)
+    Slimmer::Processors::ReportAProblemInserter.new(@skin, "", {}, "wrapper").filter(:any_source, template)
+    assert_not_in template, "div.report-a-problem-container"
+  end
+
+  def test_should_not_add_report_a_problem_form_if_app_opts_out_in_header
+    @skin.expects(:template).never
+    headers = { Slimmer::Headers::REPORT_A_PROBLEM_FORM => 'false' }
+    Slimmer::Processors::ReportAProblemInserter.new(@skin, "", headers, "wrapper").filter(:any_source, template)
     assert_not_in template, "div.report-a-problem-container"
   end
 
@@ -51,7 +66,7 @@ class ReportAProblemInserterTest < MiniTest::Test
       <html>
         <body">
           <div id="wrapper">
-            <div id="report-a-problem"></div>
+            <div id="content"></div>
           </div>
         </body>
       </html>

data/test/typical_usage_test.rb

@@ -35,7 +35,7 @@ module TypicalUsage
       with_rails_env('test') do
         get "/some-slug?skip_slimmer=1"
       end
-      assert_rendered_in_template '#wrapper', "Don't template me"
+      assert_rendered_in_template '#wrapper', /^Don't template me/
     end
   end
 
@@ -106,7 +106,7 @@ module TypicalUsage
     end
 
     def test_should_replace_the_wrapper_using_the_app_response
-      assert_rendered_in_template "#wrapper", "The body of the page"
+      assert_rendered_in_template "#wrapper", /^The body of the page/
     end
 
     def test_should_replace_the_title_using_the_app_response
@@ -241,7 +241,7 @@ module TypicalUsage
     given_response 200, %{
       <html>
       <body>
-      <div id="wrapper">The body of the page<div id="report-a-problem"></div></div>
+      <div id="wrapper">The body of the page</div>
       </body>
       </html>
     }
@@ -381,7 +381,7 @@ module TypicalUsage
     }, {}, {wrapper_id: "custom_wrapper"}
 
     def test_should_replace_wrapper_with_custom_wrapper
-      assert_rendered_in_template "body #custom_wrapper", "The body of the page"
+      assert_rendered_in_template "body #custom_wrapper", /^The body of the page/
       assert_no_selector "#wrapper"
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 5.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-29 00:00:00.000000000 Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &19342560 !ruby/object:Gem::Requirement
+  requirement: &12577020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *19342560
+  version_requirements: *12577020
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &19341520 !ruby/object:Gem::Requirement
+  requirement: &12591820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.3.5
   type: :runtime
   prerelease: false
-  version_requirements: *19341520
+  version_requirements: *12591820
 - !ruby/object:Gem::Dependency
   name: plek
-  requirement: &19340020 !ruby/object:Gem::Requirement
+  requirement: &12590680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 0.1.8
   type: :runtime
   prerelease: false
-  version_requirements: *19340020
+  version_requirements: *12590680
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &19339280 !ruby/object:Gem::Requirement
+  requirement: &12590040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19339280
+  version_requirements: *12590040
 - !ruby/object:Gem::Dependency
   name: null_logger
-  requirement: &19338080 !ruby/object:Gem::Requirement
+  requirement: &12588580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19338080
+  version_requirements: *12588580
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &19336560 !ruby/object:Gem::Requirement
+  requirement: &12587020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +77,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19336560
+  version_requirements: *12587020
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &19425860 !ruby/object:Gem::Requirement
+  requirement: &12584640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,10 +88,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19425860
+  version_requirements: *12584640
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &19422940 !ruby/object:Gem::Requirement
+  requirement: &12597700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,10 +99,10 @@ dependencies:
         version: '5.4'
   type: :development
   prerelease: false
-  version_requirements: *19422940
+  version_requirements: *12597700
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &19421680 !ruby/object:Gem::Requirement
+  requirement: &12596600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +110,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *19421680
+  version_requirements: *12596600
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &19420360 !ruby/object:Gem::Requirement
+  requirement: &12595940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +121,10 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *19420360
+  version_requirements: *12595940
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &19508080 !ruby/object:Gem::Requirement
+  requirement: &12595260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +132,10 @@ dependencies:
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *19508080
+  version_requirements: *12595260
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &19507520 !ruby/object:Gem::Requirement
+  requirement: &12594540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -143,10 +143,10 @@ dependencies:
         version: 1.18.0
   type: :development
   prerelease: false
-  version_requirements: *19507520
+  version_requirements: *12594540
 - !ruby/object:Gem::Dependency
   name: therubyracer
-  requirement: &19507020 !ruby/object:Gem::Requirement
+  requirement: &12593820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -154,10 +154,10 @@ dependencies:
         version: 0.10.2
   type: :development
   prerelease: false
-  version_requirements: *19507020
+  version_requirements: *12593820
 - !ruby/object:Gem::Dependency
   name: gem_publisher
-  requirement: &19506480 !ruby/object:Gem::Requirement
+  requirement: &12593040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -165,10 +165,10 @@ dependencies:
         version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *19506480
+  version_requirements: *12593040
 - !ruby/object:Gem::Dependency
   name: gds-api-adapters
-  requirement: &19505980 !ruby/object:Gem::Requirement
+  requirement: &12607680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -176,10 +176,10 @@ dependencies:
         version: 2.7.1
   type: :development
   prerelease: false
-  version_requirements: *19505980
+  version_requirements: *12607680
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &19505340 !ruby/object:Gem::Requirement
+  requirement: &12606600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -187,7 +187,7 @@ dependencies:
         version: 0.5.1
   type: :development
   prerelease: false
-  version_requirements: *19505340
+  version_requirements: *12606600
 description: Rack middleware for skinning pages using a specific template
 email:
 - bengriffiths@gmail.com
@@ -287,7 +287,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1973016183234359331
+      hash: 4596273305865996013
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -296,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1973016183234359331
+      hash: 4596273305865996013
 requirements: []
 rubyforge_project: slimmer
 rubygems_version: 1.8.11