slimmer 3.26.0 → 3.27.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 3.27.0
+
+* Added BETA_LABEL header and deprecated BETA_NOTICE header.
+
 # 3.26.0
 
 * Added X-Slimmer-World-Location header, value of which will be passed onto Google Analytics.

data/lib/slimmer.rb

@@ -24,6 +24,7 @@ module Slimmer
 
   module Processors
     autoload :BetaNoticeInserter, 'slimmer/processors/beta_notice_inserter'
+    autoload :BetaLabelInserter, 'slimmer/processors/beta_label_inserter'
     autoload :BodyClassCopier, 'slimmer/processors/body_class_copier'
     autoload :BodyInserter, 'slimmer/processors/body_inserter'
     autoload :ConditionalCommentMover, 'slimmer/processors/conditional_comment_mover'

data/lib/slimmer/headers.rb

@@ -7,6 +7,7 @@ module Slimmer
     SLIMMER_HEADER_MAPPING = {
       application_name:     "Application-Name",
       beta:                 "Beta",
+      beta_label:           "Beta-Label",
       format:               "Format",
       need_id:              "Need-ID",
       page_owner:           "Page-Owner",
@@ -23,6 +24,7 @@ module Slimmer
     APPLICATION_NAME_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:application_name]}"
     ARTEFACT_HEADER = "#{HEADER_PREFIX}-Artefact"
     BETA_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:beta]}"
+    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]}"
     WORLD_LOCATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:world_locations]}"

data/lib/slimmer/processors/beta_label_inserter.rb

@@ -0,0 +1,35 @@
+module Slimmer::Processors
+  class BetaLabelInserter
+    def initialize(skin, headers)
+      @skin = skin
+      @headers = headers
+    end
+
+    def filter(content_document, page_template)
+      if should_add_beta_label?
+        if position == 'before'
+          page_template.at_css(selector).add_previous_sibling(beta_label_block)
+        elsif position == 'after'
+          page_template.at_css(selector).add_next_sibling(beta_label_block)
+        end
+      end
+    end
+
+    def should_add_beta_label?
+      !! @headers[Slimmer::Headers::BETA_LABEL]
+    end
+
+    def beta_label_block
+      @beta_label_block ||= @skin.template('beta_label').to_s
+    end
+
+  private
+    def selector
+      @headers[Slimmer::Headers::BETA_LABEL].gsub(/.*:/, '')
+    end
+
+    def position
+      @headers[Slimmer::Headers::BETA_LABEL].gsub(/:.*/, '')
+    end
+  end
+end

data/lib/slimmer/processors/beta_notice_inserter.rb

@@ -7,6 +7,7 @@ module Slimmer::Processors
 
     def filter(content_document, page_template)
       if should_add_beta_notice?
+        warn "[DEPRECATION WARNING] BETA_HEADER is deprecated. Use BETA_LABEL instead."
         page_template.css('body').add_class('beta')
         if header = page_template.at_css('#global-header')
           header.add_next_sibling(beta_notice_block)
@@ -32,4 +33,3 @@ module Slimmer::Processors
     end
   end
 end
-

data/lib/slimmer/skin.rb

@@ -129,6 +129,7 @@ module Slimmer
         Processors::SearchIndexSetter.new(response),
         Processors::MetaViewportRemover.new(response),
         Processors::BetaNoticeInserter.new(self, response.headers),
+        Processors::BetaLabelInserter.new(self, response.headers)
       ]
 
       template_name = response.headers[Headers::TEMPLATE_HEADER] || 'wrapper'

data/lib/slimmer/test_templates/beta_label.html

@@ -0,0 +1 @@
+<div class="beta-label"><p>This page is BETA.</p></div>

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '3.26.0'
+  VERSION = '3.27.0'
 end

data/test/deprecated_usage_test.rb

@@ -0,0 +1,25 @@
+require_relative "test_helper"
+
+module DeprecatedUsage
+  class BetaNoticeInserterTest < SlimmerIntegrationTest
+    def test_should_add_beta_warnings
+      Slimmer::Processors::BetaNoticeInserter.any_instance.
+                                              expects(:warn).
+                                              with(regexp_matches(/BETA_HEADER is deprecated. Use BETA_LABEL instead/))
+
+      given_response 200, %{
+        <html>
+          <body class="wibble">
+            <div id="wrapper">The body of the page</div>
+          </body>
+        </html>
+      }, {Slimmer::Headers::BETA_HEADER => '1'}
+
+      # beta notice after cookie bar
+      assert_rendered_in_template "body.beta.wibble #global-header + div.beta-notice"
+
+      # beta notice before footer
+      assert_rendered_in_template "body.beta.wibble div.beta-notice.js-footer + #footer"
+    end
+  end
+end

data/test/fixtures/beta_label.html.erb

@@ -0,0 +1 @@
+<div class="beta-label"><p>This page is BETA.</p></div>

data/test/processors/beta_label_inserter_test.rb

@@ -0,0 +1,42 @@
+require_relative "../test_helper"
+
+class BetaLabelInserterTest < MiniTest::Unit::TestCase
+
+  def setup
+    super
+    beta_label_block = '<div class="beta-label"><p>This page is BETA.</p></div>'
+    @skin = stub("Skin", :template => beta_label_block)
+    @template = as_nokogiri %{
+      <html><body><div><div id="wrapper"><header id="main">GOV.UK</header></div></div></body></html>
+    }
+  end
+
+  def test_should_add_beta_label_after    
+
+    headers = {
+      Slimmer::Headers::BETA_LABEL => "after:header#main"
+    }
+
+    Slimmer::Processors::BetaLabelInserter.new(@skin, headers).filter(nil, @template)
+
+    assert_in @template, '#main + .beta-label'
+  end
+
+  def test_should_add_beta_label_before
+    headers = {
+      Slimmer::Headers::BETA_LABEL => "before:header#main"
+    }
+
+    Slimmer::Processors::BetaLabelInserter.new(@skin, headers).filter(nil, @template)
+
+    assert_in @template, '.beta-label + #main'
+  end
+
+  def test_should_not_add_beta_label
+    headers = {}
+
+    Slimmer::Processors::BetaLabelInserter.new(@skin, headers).filter(nil, @template)
+
+    assert_not_in @template, '.beta-label'
+  end
+end

data/test/test_helper.rb

@@ -78,6 +78,7 @@ class SlimmerIntegrationTest < MiniTest::Unit::TestCase
     use_template('related.raw')
     use_template('report_a_problem.raw')
     use_template('beta_notice')
+    use_template('beta_label')
 
     fetch_page
   end

data/test/typical_usage_test.rb

@@ -253,21 +253,17 @@ module TypicalUsage
     end
   end
 
-  class BetaNoticeInserterTest < SlimmerIntegrationTest
-    def test_should_add_beta_warnings
+  class BetaLabelInserterTest < SlimmerIntegrationTest
+    def test_should_add_beta_label
       given_response 200, %{
         <html>
           <body class="wibble">
             <div id="wrapper">The body of the page</div>
           </body>
         </html>
-      }, {Slimmer::Headers::BETA_HEADER => '1'}
+      }, {Slimmer::Headers::BETA_LABEL => 'after:#wrapper'}
 
-      # beta notice after cookie bar
-      assert_rendered_in_template "body.beta.wibble #global-header + div.beta-notice"
-
-      # beta notice before footer
-      assert_rendered_in_template "body.beta.wibble div.beta-notice.js-footer + #footer"
+      assert_rendered_in_template '.beta-label'
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 3.26.0
+  version: 3.27.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-18 00:00:00.000000000 Z
+date: 2014-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -270,6 +270,7 @@ files:
 - lib/slimmer/test_templates/header_footer_only.html
 - lib/slimmer/test_templates/wrapper.html
 - lib/slimmer/test_templates/beta_notice.html
+- lib/slimmer/test_templates/beta_label.html
 - lib/slimmer/test.rb
 - lib/slimmer/version.rb
 - lib/slimmer/artefact.rb
@@ -283,6 +284,7 @@ files:
 - lib/slimmer/processors/tag_mover.rb
 - lib/slimmer/processors/meta_viewport_remover.rb
 - lib/slimmer/processors/body_class_copier.rb
+- lib/slimmer/processors/beta_label_inserter.rb
 - lib/slimmer/processors/report_a_problem_inserter.rb
 - lib/slimmer/processors/title_inserter.rb
 - lib/slimmer/processors/search_index_setter.rb
@@ -298,12 +300,14 @@ files:
 - test/changelog_test.rb
 - test/typical_usage_test.rb
 - test/skin_test.rb
+- test/deprecated_usage_test.rb
 - test/artefact_test.rb
 - test/fixtures/wrapper.html.erb
 - test/fixtures/500.html.erb
 - test/fixtures/proposition_menu.html.erb
 - test/fixtures/404.html.erb
 - test/fixtures/report_a_problem.raw.html.erb
+- test/fixtures/beta_label.html.erb
 - test/fixtures/related.raw.html.erb
 - test/fixtures/beta_notice.html.erb
 - test/headers_test.rb
@@ -321,6 +325,7 @@ files:
 - test/processors/report_a_problem_inserter_test.rb
 - test/processors/tag_mover_test.rb
 - test/processors/logo_class_inserter_test.rb
+- test/processors/beta_label_inserter_test.rb
 - bin/render_slimmer_error
 homepage: http://github.com/alphagov/slimmer
 licenses: []
@@ -336,7 +341,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2647039670405045744
+      hash: 553986080410227119
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -345,7 +350,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2647039670405045744
+      hash: 553986080410227119
 requirements: []
 rubyforge_project: slimmer
 rubygems_version: 1.8.23
@@ -356,12 +361,14 @@ test_files:
 - test/changelog_test.rb
 - test/typical_usage_test.rb
 - test/skin_test.rb
+- test/deprecated_usage_test.rb
 - test/artefact_test.rb
 - test/fixtures/wrapper.html.erb
 - test/fixtures/500.html.erb
 - test/fixtures/proposition_menu.html.erb
 - test/fixtures/404.html.erb
 - test/fixtures/report_a_problem.raw.html.erb
+- test/fixtures/beta_label.html.erb
 - test/fixtures/related.raw.html.erb
 - test/fixtures/beta_notice.html.erb
 - test/headers_test.rb
@@ -379,3 +386,4 @@ test_files:
 - test/processors/report_a_problem_inserter_test.rb
 - test/processors/tag_mover_test.rb
 - test/processors/logo_class_inserter_test.rb
+- test/processors/beta_label_inserter_test.rb