slimmer 1.1.19 → 1.1.20

data/lib/slimmer/app.rb

@@ -32,8 +32,8 @@ module Slimmer
       end
     end
 
-    def on_success(request,body)
-      @skin.success(request, body)
+    def on_success(source_request, request, body)
+      @skin.success(source_request, request, body)
     end
 
     def admin(request,body)
@@ -55,8 +55,8 @@ module Slimmer
       b
     end
 
-    def rewrite_response(env,triplet)
-      status, headers, app_body = triplet
+    def rewrite_response(env, response_to_skin)
+      status, headers, app_body = response_to_skin
       logger.debug "Slimmer: constructing request object"
       source_request = Rack::Request.new(env)
       logger.debug "Slimmer: constructing request headers object"
@@ -75,7 +75,7 @@ module Slimmer
             rewritten_body = admin(request,s(app_body))
           else
             logger.debug "Slimmer: Rewriting this request as a public request"
-            rewritten_body = on_success(request,s(app_body))
+            rewritten_body = on_success(source_request, request, s(app_body))
           end
         when 301, 302, 304
           logger.debug "Slimmer: I will not rewrite this request"

data/lib/slimmer/related_items_inserter.rb

@@ -0,0 +1,32 @@
+require 'gds_api/helpers'
+
+class RelatedItemsInserter
+  include GdsApi::Helpers
+  include ERB::Util
+  
+  def initialize(related_block_template, external_request)
+    @related_block_template = related_block_template
+    @external_request = external_request
+  end
+  
+  def requested_slug
+    url_parts = @external_request.path_info.split('/')
+    url_parts.size > 0 ? url_parts[1] : ''
+  end
+  
+  def filter(content_document, page_template)
+    if content_document.at_css('body.citizen div#related-items')
+      page_template.at_css('body.citizen div#related-items').replace(related_item_block)
+    end
+  end
+  
+  def metadata_from_panopticon
+    fetch_artefact(slug: requested_slug)
+  end
+  
+  def related_item_block
+    artefact = metadata_from_panopticon
+    html = ERB.new(@related_block_template).result(binding)
+    Nokogiri::HTML.fragment(html)
+  end
+end

data/lib/slimmer/skin.rb

@@ -56,8 +56,13 @@ module Slimmer
       url = template_url template_name
       logger.debug "Slimmer: template lives at '#{url}'"
       source = open(url, "r:UTF-8", :ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE).read
-      logger.debug "Slimmer: Evaluating the template as ERB"
-      template = ERB.new(source).result binding
+      if template_name =~ /\.raw/
+        logger.debug "Slimmer: reading the raw template"
+        template = source
+      else
+        logger.debug "Slimmer: Evaluating the template as ERB"
+        template = ERB.new(source).result binding
+      end
       cache template_name, template
       logger.debug "Slimmer: Returning evaluated template"
       template
@@ -117,7 +122,7 @@ module Slimmer
       process(processors,body,template('admin'))
     end
 
-    def success(request,body)
+    def success(source_request, request, body)
       processors = [
         TitleInserter.new(),
         TagMover.new(),
@@ -126,6 +131,7 @@ module Slimmer
         HeaderContextInserter.new(),
         SectionInserter.new(),
         GoogleAnalyticsConfigurator.new(request.env),
+        RelatedItemsInserter.new(template('related.raw'), source_request),
       ]
 
       template_name = request.env.has_key?(TEMPLATE_HEADER) ? request.env[TEMPLATE_HEADER] : 'wrapper'

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '1.1.19'
+  VERSION = '1.1.20'
 end

data/lib/slimmer.rb

@@ -27,6 +27,7 @@ module Slimmer
   autoload :UrlRewriter, 'slimmer/url_rewriter'
   autoload :HeaderContextInserter, 'slimmer/header_context_inserter'
   autoload :GoogleAnalyticsConfigurator, 'slimmer/google_analytics_configurator'
+  autoload :RelatedItemsInserter, 'slimmer/related_items_inserter'
 
   class TemplateNotFoundException < StandardError; end
   class CouldNotRetrieveTemplate < StandardError; end

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

@@ -0,0 +1,30 @@
+<% if artefact && artefact.present? && artefact.related_items.size > 0 %>
+
+<!-- related -->
+<div class="related-positioning">
+	<div class="related-container">
+
+		<div class="related">
+			<div class="inner group">
+				<h2>Related tools &amp; topics</h2>
+				<nav role="navigation">
+				  <ul>
+				      <% (artefact.related_items || []).each do |item| %>
+  				      <% if item.artefact %>
+  				      <li class="<%= h(item.artefact.kind) %>">
+  				        <a href="/<%= h(item.artefact.slug) %>"><%= h(item.artefact.name) %></a>
+  				      </li>
+  				      <% end %>
+              <% end %>
+				      <% if artefact.section %>
+				        <li class="related-topic"><a href="/browse/<%= h(artefact.section.parameterize) %>">View more in <span><%= h(artefact.section) %>&rarr;</span></a></li>
+				      <% end %>
+				  </ul>
+				</nav>
+	   </div>
+	 </div>
+
+	</div>
+</div>
+<!-- end related -->
+<% end %>

data/test/test_helper.rb

@@ -1,9 +1,13 @@
 require_relative '../lib/slimmer'
 require 'minitest/autorun'
+require 'minitest/unit'
 require 'rack/test'
 require 'webmock/minitest'
+require 'json'
+require 'logger'
 
 WebMock.disable_net_connect!
+ENV['FACTER_govuk_platform'] = 'test'
 
 class MiniTest::Unit::TestCase
   def as_nokogiri(html_string)
@@ -22,7 +26,7 @@ end
 class SlimmerIntegrationTest < MiniTest::Unit::TestCase
   include Rack::Test::Methods
 
-  def self.given_response(code, body, headers={})
+  def self.given_response(code, body, headers={}, url="/")
     define_method(:app) do
       inner_app = proc { |env|
         [code, headers.merge("Content-Type" => "text/html"), body]
@@ -35,19 +39,25 @@ class SlimmerIntegrationTest < MiniTest::Unit::TestCase
     end
 
     define_method(:setup) do
+      additional_setup if self.class.method_defined? :additional_setup
       template_name = case code
       when 200 then 'wrapper'
       when 404 then '404'
       else          '500'
       end
 
-      template = File.read File.dirname(__FILE__) + "/fixtures/#{template_name}.html.erb"
-      stub_request(:get, "http://template.local/templates/#{template_name}.html.erb").
-        to_return(:body => template)
-      get "/"
+      use_template(template_name)
+      use_template('related.raw')
+      get url
     end
   end
 
+  def use_template(template_name)
+    template = File.read File.dirname(__FILE__) + "/fixtures/#{template_name}.html.erb"
+    stub_request(:get, "http://template.local/templates/#{template_name}.html.erb").
+      to_return(:body => template)
+  end
+    
   private
 
   def assert_not_rendered_in_template(content)
@@ -63,7 +73,14 @@ class SlimmerIntegrationTest < MiniTest::Unit::TestCase
       end
     end
     element = Nokogiri::HTML.parse(last_response.body).at_css(selector)
-    assert element, message
-    assert_equal content, element.inner_html.to_s, message if content
+    assert element, message + ", but selector not found."
+    if content
+      message << ". But found #{element.inner_html.to_s}"
+      if content.is_a?(Regexp)
+        assert_match content, element.inner_html.to_s, message
+      else
+        assert_equal content, element.inner_html.to_s, message
+      end
+    end
   end
 end

data/test/typical_usage_test.rb

@@ -1,4 +1,5 @@
 require "test_helper"
+require "gds_api/test_helpers/panopticon"
 
 module TypicalUsage
 
@@ -53,6 +54,56 @@ module TypicalUsage
     def test_should_insert_meta_navigation_links_into_the_navigation
       assert_rendered_in_template "nav[role=navigation] li a[href='/this_section']", "This section"
     end
+    
+  end
+  
+  class ResponseWithRelatedItemsTest < SlimmerIntegrationTest
+    include GdsApi::TestHelpers::Panopticon
+
+    def additional_setup
+      panopticon_has_metadata(
+        'slug' => 'some-slug', 
+        'title' => 'Example document', 
+        'related_items' => [
+            {
+            'artefact' => {
+              'kind' => 'guide',
+              'name' => 'How to test computer software automatically & ensure that 2>1',
+              'slug' => 'how-to-test-computer-software-automatically',
+              }
+            }
+          ]
+        )
+    end
+  end
+  
+  class CitizenRelatedItemsTest < ResponseWithRelatedItemsTest
+    given_response 200, %{
+      <html>
+      <body class="citizen">
+      <div id="wrapper">The body of the page<div id="related-items"></div></div>
+      </body>
+      </html>
+    }, {}, "/some-slug"
+    
+    def test_should_insert_related_items_block
+      assert_rendered_in_template "div.related nav li.guide a", "How to test computer software automatically &amp; ensure that 2&gt;1"
+      assert_rendered_in_template "div.related nav li.guide", %r{href="/how-to-test-computer-software-automatically"}
+    end
+  end
+
+  class NonCitizentRelatedItemsTest < ResponseWithRelatedItemsTest
+    given_response 200, %{
+      <html>
+      <body class="noncitizen">
+      <div id="wrapper">The body of the page<div id="related-items"></div></div>
+      </body>
+      </html>
+    }, {}, "/some-slug"
+    
+    def test_should_not_insert_related_items_block
+      assert_rendered_in_template "div#related-items", ""
+    end
   end
 
   class HeaderContextResponseTest < SlimmerIntegrationTest

metadata

@@ -1,136 +1,150 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: slimmer
-version: !ruby/object:Gem::Version
-  version: 1.1.19
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 1.1.20
 platform: ruby
-authors:
+authors: 
 - Ben Griffiths
 - James Stewart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-12 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-01-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: nokogiri
-  requirement: &70164012495200 !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70164012495200
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: rack
-  requirement: &70164012494660 !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.3.5
   type: :runtime
   prerelease: false
-  version_requirements: *70164012494660
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: plek
-  requirement: &70164012494160 !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 0.1.8
   type: :runtime
   prerelease: false
-  version_requirements: *70164012494160
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &70164012493740 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
   prerelease: false
-  version_requirements: *70164012493740
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: null_logger
-  requirement: &70164012493260 !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :runtime
   prerelease: false
-  version_requirements: *70164012493260
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: gds-api-adapters
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.0.33
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70164012492300 !ruby/object:Gem::Requirement
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70164012492300
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: rack-test
-  requirement: &70164012491740 !ruby/object:Gem::Requirement
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *70164012491740
-- !ruby/object:Gem::Dependency
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
   name: mocha
-  requirement: &70164012491020 !ruby/object:Gem::Requirement
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *70164012491020
-- !ruby/object:Gem::Dependency
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
   name: webmock
-  requirement: &70164012488760 !ruby/object:Gem::Requirement
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.7'
+      - !ruby/object:Gem::Version 
+        version: "1.7"
   type: :development
   prerelease: false
-  version_requirements: *70164012488760
-- !ruby/object:Gem::Dependency
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
   name: therubyracer
-  requirement: &70164012488340 !ruby/object:Gem::Requirement
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
   prerelease: false
-  version_requirements: *70164012488340
+  version_requirements: *id011
 description: Rack middleware for skinning pages using a specific template
-email:
+email: 
 - bengriffiths@gmail.com
 - james.stewart@digital.cabinet-office.gov.uk
-executables:
+executables: 
 - render_slimmer_error
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - README.md
 - CHANGELOG.md
 - lib/slimmer/admin_title_inserter.rb
@@ -142,6 +156,7 @@ files:
 - lib/slimmer/header_context_inserter.rb
 - lib/slimmer/headers.rb
 - lib/slimmer/railtie.rb
+- lib/slimmer/related_items_inserter.rb
 - lib/slimmer/section_inserter.rb
 - lib/slimmer/skin.rb
 - lib/slimmer/tag_mover.rb
@@ -155,6 +170,7 @@ files:
 - Rakefile
 - test/fixtures/404.html.erb
 - test/fixtures/500.html.erb
+- test/fixtures/related.raw.html.erb
 - test/fixtures/wrapper.html.erb
 - test/google_analytics_test.rb
 - test/headers_test.rb
@@ -166,37 +182,41 @@ files:
 - bin/render_slimmer_error
 homepage: http://github.com/alphagov/slimmer
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4024382224342024618
+      segments: 
       - 0
-      hash: -1615013662764741884
-required_rubygems_version: !ruby/object:Gem::Requirement
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 4024382224342024618
+      segments: 
       - 0
-      hash: -1615013662764741884
+      version: "0"
 requirements: []
+
 rubyforge_project: slimmer
-rubygems_version: 1.8.11
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: Thinner than the skinner
-test_files:
+test_files: 
 - test/fixtures/404.html.erb
 - test/fixtures/500.html.erb
+- test/fixtures/related.raw.html.erb
 - test/fixtures/wrapper.html.erb
 - test/google_analytics_test.rb
 - test/headers_test.rb