slimmer 3.7.0 → 3.8.0

data/lib/slimmer.rb

@@ -29,6 +29,7 @@ module Slimmer
     autoload :BodyClassCopier, 'slimmer/processors/body_class_copier'
     autoload :BodyInserter, 'slimmer/processors/body_inserter'
     autoload :ConditionalCommentMover, 'slimmer/processors/conditional_comment_mover'
+    autoload :CampaignNotificationInserter, 'slimmer/processors/campaign_notification_inserter'
     autoload :FooterRemover, 'slimmer/processors/footer_remover'
     autoload :GoogleAnalyticsConfigurator, 'slimmer/processors/google_analytics_configurator'
     autoload :HeaderContextInserter, 'slimmer/processors/header_context_inserter'

data/lib/slimmer/headers.rb

@@ -5,6 +5,7 @@ module Slimmer
     HEADER_PREFIX = "X-Slimmer"
 
     SLIMMER_HEADER_MAPPING = {
+      campaign_notification:"Campaign-Notification",
       format:               "Format",
       need_id:              "Need-ID",
       proposition:          "Proposition",
@@ -16,13 +17,14 @@ module Slimmer
     }
 
     ARTEFACT_HEADER = "#{HEADER_PREFIX}-Artefact"
-    FORMAT_HEADER = "#{HEADER_PREFIX}-Format"
-    REMOVE_META_VIEWPORT = "#{HEADER_PREFIX}-Remove-Meta-Viewport"
-    RESULT_COUNT_HEADER = "#{HEADER_PREFIX}-Result-Count"
+    CAMPAIGN_NOTIFICATION = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:campaign_notification]}"
+    FORMAT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:format]}"
+    REMOVE_META_VIEWPORT = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:remove_meta_viewport]}"
+    RESULT_COUNT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:result_count]}"
     SEARCH_INDEX_HEADER = "#{HEADER_PREFIX}-Search-Index"
     SEARCH_PATH_HEADER = "#{HEADER_PREFIX}-Search-Path"
-    SKIP_HEADER = "#{HEADER_PREFIX}-Skip"
-    TEMPLATE_HEADER = "#{HEADER_PREFIX}-Template"
+    SKIP_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:skip]}"
+    TEMPLATE_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:template]}"
 
     def set_slimmer_headers(hash)
       raise InvalidHeader if (hash.keys - SLIMMER_HEADER_MAPPING.keys).any?

data/lib/slimmer/processors/campaign_notification_inserter.rb

@@ -0,0 +1,27 @@
+module Slimmer::Processors
+  class CampaignNotificationInserter
+    def initialize(skin, headers)
+      @headers = headers
+      @skin = skin
+      @old_campaign_selector = ".main-campaign"
+      @new_campaign_selector = "#campaign-notification"
+    end
+
+    def filter(content_document, page_template)
+      if @headers[Slimmer::Headers::CAMPAIGN_NOTIFICATION] == "true" &&
+          old_campaign = page_template.at_css(@old_campaign_selector)
+        new_campaign_block = campaign_notification_block
+        if new_campaign_block.at_css(@new_campaign_selector)
+          old_campaign.replace(new_campaign_block)
+        end
+      end
+    end
+
+    private
+
+    def campaign_notification_block
+      html = @skin.template('campaign')
+      Nokogiri::HTML.fragment(html)
+    end
+  end
+end

data/lib/slimmer/processors/meta_viewport_remover.rb

@@ -5,7 +5,7 @@ module Slimmer::Processors
     end
 
     def filter(src, dest)
-      if @response.headers["X-Slimmer-Remove-Meta-Viewport"] == "true"
+      if @response.headers[Slimmer::Headers::REMOVE_META_VIEWPORT] == "true"
         dest.at_xpath('//head//meta[@name="viewport"]').remove
       end
     end

data/lib/slimmer/skin.rb

@@ -141,6 +141,7 @@ module Slimmer
         Processors::ReportAProblemInserter.new(self, source_request.url),
         Processors::SearchIndexSetter.new(response),
         Processors::MetaViewportRemover.new(response),
+        Processors::CampaignNotificationInserter.new(self, response.headers),
       ]
 
       template_name = response.headers[Headers::TEMPLATE_HEADER] || 'wrapper'

data/lib/slimmer/test.rb

@@ -7,6 +7,8 @@ module Slimmer
       logger.debug "Slimmer: TEST MODE - Loading fixture template from #{__FILE__}"
       if name =~ /\A(.*)\.raw\z/
         %{<div id="test-#{$1}"></div>}
+      elsif name == "campaign"
+        '<section class="black" id="campaign-notification"><div><p>Notifications!</p></div></section>'
       else
         Slimmer::TestTemplate::TEMPLATE
       end

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '3.7.0'
+  VERSION = '3.8.0'
 end

data/test/fixtures/campaign.html.erb

@@ -0,0 +1 @@
+<section id="campaign-notification"><p>testing...</p></section>

data/test/headers_test.rb

@@ -63,6 +63,15 @@ class HeadersTest < MiniTest::Unit::TestCase
     set_slimmer_headers remove_meta_viewport: true
     assert_equal "true", headers["X-Slimmer-Remove-Meta-Viewport"]
   end
+
+  def test_should_not_have_campaign_notification_set
+    assert_equal nil, headers["X-Slimmer-Campaign-Notification"]
+  end
+
+  def test_should_set_campaign_notification_header
+    set_slimmer_headers campaign_notification: true
+    assert_equal "true", headers["X-Slimmer-Campaign-Notification"]
+  end
 end
 
 describe Slimmer::Headers do

data/test/processors/campaign_notification_inserter_test.rb

@@ -0,0 +1,49 @@
+require "test_helper"
+
+class CampaignNotificationInserterTest < MiniTest::Unit::TestCase
+  def setup
+    @skin = stub("Skin", :template => nil)
+  end
+
+  def test_should_not_replace_campaign_if_header_not_set
+    @skin.expects(:template).with("campaign").never
+    campaign_inserter = Slimmer::Processors::CampaignNotificationInserter.new(@skin, {})
+
+    source = as_nokogiri %{
+      <html>
+        <body>
+          <section class="main-campaign group"><a href="/tour">A tour!</a></section>
+        </body>
+      </html>
+    }
+    expected = as_nokogiri %{
+      <html>
+        <body>
+          <section class="main-campaign group"><a href="/tour">A tour!</a></section>
+        </body>
+      </html>
+    }
+
+    campaign_inserter.filter(:any_source, source)
+    assert_equal expected.to_html, source.to_html
+  end
+
+  def test_should_replace_campaign_with_notification_if_header_set
+    campaign = '<section id="campaign-notification"><p>testing...</p></section>'
+    @skin.expects(:template).with('campaign').returns(campaign)
+
+    headers = {Slimmer::Headers::CAMPAIGN_NOTIFICATION => "true"}
+    campaign_inserter = Slimmer::Processors::CampaignNotificationInserter.new(@skin, headers)
+
+    source = as_nokogiri %{
+      <html><body><section class="main-campaign group"><a href="/tour">A tour!</a></section></body></html>
+    }
+
+    expected = as_nokogiri %{
+      <html><body><section id="campaign-notification"><p>testing...</p></section></body></html>
+    }
+
+    campaign_inserter.filter(:any_source, source)
+    assert_equal expected.to_html.gsub(/\n/," ").strip, source.to_html.gsub(/\n/," ").strip
+  end
+end

data/test/test_helper.rb

@@ -77,6 +77,7 @@ class SlimmerIntegrationTest < MiniTest::Unit::TestCase
     use_template(template_name)
     use_template('related.raw')
     use_template('report_a_problem.raw')
+    use_template('campaign')
 
     fetch_page
   end

data/test/typical_usage_test.rb

@@ -370,4 +370,21 @@ module TypicalUsage
       assert_equal "Something else", last_response.headers["X-Custom-Header"]
     end
   end
+
+  class CampaignNotificationInserterTest < SlimmerIntegrationTest
+    def test_should_update_the_campaign_with_a_notification
+      given_response 200, %{
+        <html>
+          <body>
+            <div id="wrapper">
+              <section class="main-campaign group"><a href="/tour">A tour!</a></section>
+            </div>
+          </body>
+        </html>
+      },
+      {Slimmer::Headers::CAMPAIGN_NOTIFICATION => "true"}
+
+      assert_rendered_in_template "#campaign-notification", "<p>testing...</p>"
+    end
+  end
 end

metadata

@@ -2,7 +2,7 @@
 name: slimmer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors: 
 - Ben Griffiths
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-09 00:00:00 Z
+date: 2012-10-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -202,6 +202,7 @@ files:
 - lib/slimmer/processors/admin_title_inserter.rb
 - lib/slimmer/processors/report_a_problem_inserter.rb
 - lib/slimmer/processors/meta_viewport_remover.rb
+- lib/slimmer/processors/campaign_notification_inserter.rb
 - lib/slimmer/processors/section_inserter.rb
 - lib/slimmer/processors/footer_remover.rb
 - lib/slimmer/headers.rb
@@ -211,11 +212,13 @@ files:
 - test/headers_test.rb
 - test/artefact_test.rb
 - test/fixtures/related.raw.html.erb
+- test/fixtures/campaign.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/campaign_notification_inserter_test.rb
 - test/processors/meta_viewport_remover_test.rb
 - test/processors/logo_class_inserter_test.rb
 - test/processors/search_index_setter_test.rb
@@ -243,7 +246,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1998055775306667395
+      hash: 4023505413084510363
       segments: 
       - 0
       version: "0"
@@ -252,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1998055775306667395
+      hash: 4023505413084510363
       segments: 
       - 0
       version: "0"
@@ -267,11 +270,13 @@ test_files:
 - test/headers_test.rb
 - test/artefact_test.rb
 - test/fixtures/related.raw.html.erb
+- test/fixtures/campaign.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/campaign_notification_inserter_test.rb
 - test/processors/meta_viewport_remover_test.rb
 - test/processors/logo_class_inserter_test.rb
 - test/processors/search_index_setter_test.rb