slimmer 2.0.0 → 2.1.0

data/lib/slimmer/processors/related_items_inserter.rb

@@ -1,8 +1,8 @@
 class Slimmer::Processors::RelatedItemsInserter
   include ERB::Util
   
-  def initialize(related_block_template, artefact)
-    @related_block_template = related_block_template
+  def initialize(skin, artefact)
+    @skin = skin
     @artefact = artefact
   end
   
@@ -14,7 +14,8 @@ class Slimmer::Processors::RelatedItemsInserter
   
   def related_item_block
     artefact = @artefact
-    html = ERB.new(@related_block_template).result(binding)
+    related_block_template = @skin.template('related.raw')
+    html = ERB.new(related_block_template).result(binding)
     Nokogiri::HTML.fragment(html)
   end
 end

data/lib/slimmer/processors/report_a_problem_inserter.rb

@@ -0,0 +1,24 @@
+module Slimmer::Processors
+  class ReportAProblemInserter
+    include ERB::Util
+
+    def initialize(skin, url)
+      @skin = skin
+      @request_url = url
+    end
+
+    def filter(content_document, page_template)
+      if (placeholder = page_template.at_css('body #report-a-problem'))
+        placeholder.replace(report_a_problem_block)
+      end
+    end
+
+    def report_a_problem_block
+      request_url = @request_url
+      report_a_problem_template = @skin.template('report_a_problem.raw')
+      html = ERB.new(report_a_problem_template).result(binding)
+      Nokogiri::HTML.fragment(html)
+    end
+  end
+end
+

data/lib/slimmer/skin.rb

@@ -131,8 +131,9 @@ module Slimmer
         Processors::SectionInserter.new(),
         Processors::GoogleAnalyticsConfigurator.new(response),
         Processors::SearchPathSetter.new(response),
-        Processors::RelatedItemsInserter.new(template('related.raw'), artefact),
+        Processors::RelatedItemsInserter.new(self, artefact),
         Processors::LogoClassInserter.new(artefact),
+        Processors::ReportAProblemInserter.new(self, source_request.url),
       ]
 
       template_name = response.headers[Headers::TEMPLATE_HEADER] || 'wrapper'

data/lib/slimmer/test.rb

@@ -5,8 +5,8 @@ module Slimmer
   class Skin
     def load_template name
       logger.debug "Slimmer: TEST MODE - Loading fixture template from #{__FILE__}"
-      if name == 'related.raw'
-        %{<div id="test-related-items"></div>}
+      if name =~ /\A(.*)\.raw\z/
+        %{<div id="test-#{$1}"></div>}
       else
         Slimmer::TestTemplate::TEMPLATE
       end

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '2.0.0'
+  VERSION = '2.1.0'
 end

data/lib/slimmer.rb

@@ -32,6 +32,7 @@ module Slimmer
     autoload :HeaderContextInserter, 'slimmer/processors/header_context_inserter'
     autoload :LogoClassInserter, 'slimmer/processors/logo_class_inserter'
     autoload :RelatedItemsInserter, 'slimmer/processors/related_items_inserter'
+    autoload :ReportAProblemInserter, 'slimmer/processors/report_a_problem_inserter'
     autoload :SearchPathSetter, 'slimmer/processors/search_path_setter'
     autoload :SectionInserter, 'slimmer/processors/section_inserter'
     autoload :TagMover, 'slimmer/processors/tag_mover'

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

@@ -0,0 +1,21 @@
+<!-- report_a_problem -->
+<div class="report-a-problem-container">
+  <form accept-charset="UTF-8" action="/feedback" method="post">
+    <div style="margin:0;padding:0;display:inline"><input name="utf8" type="hidden" value="✓"></div>
+    <input id="url" name="url" type="hidden" value="<%= request_url %>">
+    <label for="what_doing">
+      What were you doing?
+      <input id="what_doing" name="what_doing" type="text">
+    </label>
+    <label for="what_happened">
+      What happened?
+      <input id="what_happened" name="what_happened" type="text">
+    </label>
+    <label for="what_expected">
+      What did you expect to happen?
+      <input id="what_expected" name="what_expected" type="text">
+    </label>
+    <input name="commit" type="submit" value="Submit">
+  </form>
+</div>
+<!-- end report_a_problem -->

data/test/processors/related_items_inserter_test.rb

@@ -5,6 +5,7 @@ class RelatedItemsInserterTest < MiniTest::Unit::TestCase
   def setup
     super
     @related_template = File.read( File.dirname(__FILE__) + "/../fixtures/related.raw.html.erb" )
+    @skin = stub("Skin", :template => @related_template)
     @artefact = {
       'slug' => 'vat',
       'title' => 'VAT',
@@ -32,7 +33,7 @@ class RelatedItemsInserterTest < MiniTest::Unit::TestCase
       </html>
     }
 
-    Slimmer::Processors::RelatedItemsInserter.new(@related_template, @artefact).filter(source, template)
+    Slimmer::Processors::RelatedItemsInserter.new(@skin, @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"
@@ -55,7 +56,9 @@ class RelatedItemsInserterTest < MiniTest::Unit::TestCase
       </html>
     }
 
-    Slimmer::Processors::RelatedItemsInserter.new(@related_template, @artefact).filter(source, template)
+    @skin.expects(:template).never # Shouldn't fetch template when not inserting block
+
+    Slimmer::Processors::RelatedItemsInserter.new(@skin, @artefact).filter(source, template)
     assert_not_in template, "div.related"
   end
 end

data/test/processors/report_a_problem_inserter_test.rb

@@ -0,0 +1,44 @@
+require_relative '../test_helper'
+
+class ReportAProblemInserterTest < MiniTest::Unit::TestCase
+
+  def setup
+    super
+    @report_a_problem_template = File.read( File.dirname(__FILE__) + "/../fixtures/report_a_problem.raw.html.erb" )
+    @skin = stub("Skin", :template => nil)
+  end
+
+  def test_should_add_report_a_problem_form_using_the_template_from_static
+    @skin.expects(:template).with('report_a_problem.raw').returns(@report_a_problem_template)
+
+    template = as_nokogiri %{
+      <html>
+        <body">
+          <div id="wrapper">
+            <div id="report-a-problem"></div>
+          </div>
+        </body>
+      </html>
+    }
+
+    Slimmer::Processors::ReportAProblemInserter.new(@skin, "http://www.example.com/somewhere?foo=bar").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']"
+  end
+
+  def test_should_not_add_report_a_problem_form_if_wrapper_element_missing
+    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)
+    assert_not_in template, "div.report-a-problem-container"
+  end
+end

data/test/processors/section_inserter_test.rb

@@ -102,19 +102,4 @@ class SectionInserterTest < MiniTest::Unit::TestCase
     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

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

data/test/typical_usage_test.rb

@@ -246,6 +246,24 @@ module TypicalUsage
     end
   end
 
+  class ReportAProblemTest < SlimmerIntegrationTest
+    given_response 200, %{
+      <html>
+      <body>
+      <div id="wrapper">The body of the page<div id="report-a-problem"></div></div>
+      </body>
+      </html>
+    }
+
+    def test_should_insert_the_report_a_problem_form
+      assert_rendered_in_template "#wrapper .report-a-problem-container"
+    end
+
+    def test_should_add_the_current_url_to_the_form
+      assert_rendered_in_template ".report-a-problem-container input[name=url][value='http://example.org/']"
+    end
+  end
+
   class Error500ResponseTest < SlimmerIntegrationTest
     include Rack::Test::Methods
 

metadata

@@ -2,7 +2,7 @@
 name: slimmer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors: 
 - Ben Griffiths
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-24 00:00:00 Z
+date: 2012-09-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -97,7 +97,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.9.12
+        version: 0.12.4
   type: :development
   prerelease: false
   version_requirements: *id008
@@ -148,44 +148,47 @@ files:
 - README.md
 - CHANGELOG.md
 - lib/tasks/slimmer.rake
-- lib/slimmer/version.rb
+- lib/slimmer.rb
+- lib/slimmer/skin.rb
+- lib/slimmer/railtie.rb
+- lib/slimmer/template.rb
+- lib/slimmer/test_template.rb
+- lib/slimmer/test.rb
+- lib/slimmer/app.rb
+- lib/slimmer/processors/logo_class_inserter.rb
 - lib/slimmer/processors/body_class_copier.rb
+- lib/slimmer/processors/tag_mover.rb
+- lib/slimmer/processors/search_path_setter.rb
+- lib/slimmer/processors/title_inserter.rb
 - lib/slimmer/processors/google_analytics_configurator.rb
+- lib/slimmer/processors/conditional_comment_mover.rb
 - lib/slimmer/processors/related_items_inserter.rb
+- lib/slimmer/processors/header_context_inserter.rb
 - lib/slimmer/processors/body_inserter.rb
-- lib/slimmer/processors/logo_class_inserter.rb
-- lib/slimmer/processors/footer_remover.rb
-- lib/slimmer/processors/conditional_comment_mover.rb
 - lib/slimmer/processors/admin_title_inserter.rb
+- lib/slimmer/processors/report_a_problem_inserter.rb
 - lib/slimmer/processors/section_inserter.rb
-- lib/slimmer/processors/search_path_setter.rb
-- lib/slimmer/processors/tag_mover.rb
-- lib/slimmer/processors/title_inserter.rb
-- lib/slimmer/processors/header_context_inserter.rb
-- lib/slimmer/template.rb
-- lib/slimmer/railtie.rb
-- lib/slimmer/test.rb
-- lib/slimmer/skin.rb
-- lib/slimmer/app.rb
+- lib/slimmer/processors/footer_remover.rb
 - lib/slimmer/headers.rb
-- lib/slimmer/test_template.rb
-- lib/slimmer.rb
+- lib/slimmer/version.rb
 - Rakefile
-- test/processors/related_items_inserter_test.rb
-- test/processors/section_inserter_test.rb
-- test/processors/google_analytics_test.rb
-- test/processors/header_context_inserter_test.rb
-- test/processors/body_inserter_test.rb
-- test/processors/logo_class_inserter_test.rb
-- test/processors/search_path_setter_test.rb
-- test/skin_test.rb
 - test/headers_test.rb
-- test/test_template_dependency_on_static_test.rb
-- test/typical_usage_test.rb
+- test/fixtures/related.raw.html.erb
 - test/fixtures/500.html.erb
 - test/fixtures/404.html.erb
-- test/fixtures/related.raw.html.erb
 - test/fixtures/wrapper.html.erb
+- test/fixtures/report_a_problem.raw.html.erb
+- test/skin_test.rb
+- test/processors/logo_class_inserter_test.rb
+- test/processors/google_analytics_test.rb
+- test/processors/report_a_problem_inserter_test.rb
+- test/processors/body_inserter_test.rb
+- test/processors/search_path_setter_test.rb
+- test/processors/section_inserter_test.rb
+- test/processors/related_items_inserter_test.rb
+- test/processors/header_context_inserter_test.rb
+- test/typical_usage_test.rb
+- test/test_template_dependency_on_static_test.rb
 - test/test_helper.rb
 - bin/render_slimmer_error
 homepage: http://github.com/alphagov/slimmer
@@ -201,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3192498978421929573
+      hash: -2259214820452961452
       segments: 
       - 0
       version: "0"
@@ -210,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -3192498978421929573
+      hash: -2259214820452961452
       segments: 
       - 0
       version: "0"
@@ -222,19 +225,21 @@ signing_key:
 specification_version: 3
 summary: Thinner than the skinner
 test_files: 
-- test/processors/related_items_inserter_test.rb
-- test/processors/section_inserter_test.rb
-- test/processors/google_analytics_test.rb
-- test/processors/header_context_inserter_test.rb
-- test/processors/body_inserter_test.rb
-- test/processors/logo_class_inserter_test.rb
-- test/processors/search_path_setter_test.rb
-- test/skin_test.rb
 - test/headers_test.rb
-- test/test_template_dependency_on_static_test.rb
-- test/typical_usage_test.rb
+- test/fixtures/related.raw.html.erb
 - test/fixtures/500.html.erb
 - test/fixtures/404.html.erb
-- test/fixtures/related.raw.html.erb
 - test/fixtures/wrapper.html.erb
+- test/fixtures/report_a_problem.raw.html.erb
+- test/skin_test.rb
+- test/processors/logo_class_inserter_test.rb
+- test/processors/google_analytics_test.rb
+- test/processors/report_a_problem_inserter_test.rb
+- test/processors/body_inserter_test.rb
+- test/processors/search_path_setter_test.rb
+- test/processors/section_inserter_test.rb
+- test/processors/related_items_inserter_test.rb
+- test/processors/header_context_inserter_test.rb
+- test/typical_usage_test.rb
+- test/test_template_dependency_on_static_test.rb
 - test/test_helper.rb