slimmer 3.24.0 → 3.25.0

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 3.25.0
+
+* Pass on GOVUK-Request-Id HTTP header when fetching templates
+* Use correct asset host in test templates
+* Remove a redundant ERB pass over fetched templates
+
+# 3.24.0
+
+* Removed CampaignNotificationInserter.  The homepage no longer needs these inserted.
+
 # 3.1.0
 
 * 'Breadcrumb' trail is now populated from the artefact data. It adds the section and subsection.

data/README.md

@@ -1,9 +1,9 @@
-Slimmer provides rack middleware for applying a standard header and footer around pages 
-returned by a ruby (rack) application. 
+Slimmer provides Rack middleware for applying a standard header and footer around pages 
+returned by a Ruby (Rack) application. 
 
 It does this by taking the page rendered by the application, extracting the contents of
-a div with id 'wrapper' and inserting that into a div with the same id in one of its templates.
-It also transfers various other details, such as meta, script, and style tags.
+a `div` with id 'wrapper' and inserting that into a `div` with the same id in one of its
+templates. It also transfers various other details, such as `meta`, `script`, and `style` tags.
 
 ## Use in a Rails app
 
@@ -35,11 +35,11 @@ To get asset tag helpers to point to your external asset server, add
 
     config.action_controller.asset_host = "http://my.alternative.host"
     
-to application.rb.
+to `application.rb`.
 
 ## Specifying a template
 
-A specific template can be requested by giving its name in the X-Slimmer-Template HTTP header. 
+A specific template can be requested by giving its name in the `X-Slimmer-Template` HTTP header. 
 
 In a controller action, you can do this by calling `slimmer_template`.
 
@@ -63,8 +63,9 @@ To get this, include Slimmer::Template in your ApplicationController:
 
 ## Logging
 
-Slimmer can be configured with a logger by passing in a logger instance (anything that quacks like an instance of Logger).
-For example to log to the Rails log, put the following in an initializer:
+Slimmer can be configured with a logger by passing in a logger instance
+(anything that quacks like an instance of `Logger`). For example, to log
+to the Rails log, put the following in an initializer:
 
     YourApp::Application.configure do
       config.slimmer.logger = Rails.logger
@@ -74,7 +75,7 @@ For example to log to the Rails log, put the following in an initializer:
 
 **Debug logging**
 
-By default if you pass in a logger with its log level set to debug, slimmer will dup this logger and reduce the level to info. (Slimmer's debug logging is very noisy).  To prevent this, set the `enable_debugging` option to true.  e.g. for Rails:
+By default if you pass in a logger with its log level set to `debug`, slimmer will dup this logger and reduce the level to `info`. (Slimmer's debug logging is very noisy).  To prevent this, set the `enable_debugging` option to true.  e.g. for Rails:
 
     YourApp::Application.configure do
       config.slimmer.enable_debugging = true

data/lib/slimmer.rb

@@ -5,10 +5,8 @@
 
 require 'nokogiri'
 require 'erb'
-require 'open-uri'
 require 'plek'
 require 'null_logger'
-require 'openssl'
 require 'lrucache'
 
 require 'slimmer/version'

data/lib/slimmer/app.rb

@@ -1,3 +1,5 @@
+require 'slimmer/govuk_request_id'
+
 module Slimmer
   class App
     attr_accessor :logger
@@ -81,6 +83,9 @@ module Slimmer
     def rewrite_response(env, response)
       request = Rack::Request.new(env)
 
+      # Store the request id so it can be passed on with any template requests
+      GovukRequestId.value = env['HTTP_GOVUK_REQUEST_ID']
+
       rewritten_body = case response.status
       when 200
         @skin.success request, response, s(response.body)

data/lib/slimmer/govuk_request_id.rb

@@ -0,0 +1,18 @@
+module Slimmer
+  class GovukRequestId
+    class << self
+      def set?
+        !(value.nil? || value.empty?)
+      end
+
+      def value
+        Thread.current[:slimmer_govuk_request_id]
+      end
+
+      def value=(new_id)
+        Thread.current[:slimmer_govuk_request_id] = new_id
+      end
+    end
+  end
+end
+

data/lib/slimmer/skin.rb

@@ -1,3 +1,6 @@
+require 'rest_client'
+require 'slimmer/govuk_request_id'
+
 module Slimmer
   class Skin
     attr_accessor :use_cache, :template_cache, :asset_host, :logger, :strict, :options
@@ -28,14 +31,11 @@ module Slimmer
 
     def load_template(template_name)
       url = template_url(template_name)
-      source = open(url, "r:UTF-8", :ssl_verify_mode => OpenSSL::SSL::VERIFY_NONE).read
-      if template_name =~ /\.raw/
-        template = source
-      else
-        template = ERB.new(source).result binding
-      end
-      template
-    rescue OpenURI::HTTPError => e
+      headers = {}
+      headers[:govuk_request_id] = GovukRequestId.value if GovukRequestId.set?
+      response = RestClient.get(url, headers)
+      response.body
+    rescue RestClient::Exception => e
       raise TemplateNotFoundException, "Unable to fetch: '#{template_name}' from '#{url}' because #{e}", caller
     rescue Errno::ECONNREFUSED => e
       raise CouldNotRetrieveTemplate, "Unable to fetch: '#{template_name}' from '#{url}' because #{e}", caller
@@ -107,9 +107,7 @@ module Slimmer
       end_time = Time.now
       logger.debug "Slimmer: Skinning process completed at #{end_time} (#{end_time - start_time}s)"
 
-      # this is a horrible fix to Nokogiri removing the closing </noscript> tag required by Google Website Optimizer.
-      # http://www.google.com/support/websiteoptimizer/bin/answer.py?hl=en_us&answer=64418
-      dest.to_html.sub(/<noscript rel=("|')placeholder("|')>/, "")
+      dest.to_html
     end
 
     def success(source_request, response, body)

data/lib/slimmer/test_templates/header_footer_only.html

@@ -16,12 +16,8 @@
 
     <footer id="footer"></footer>
 
-    <script src="https://static.preview.alphagov.co.uk/static/govuk-template.js" type="text/javascript"></script>
-    <script src="https://static.preview.alphagov.co.uk/static/libs/jquery/jquery-1.7.2.js" type="text/javascript"></script>
-    <script defer src="https://static.preview.alphagov.co.uk/static/libs/jquery/plugins/jquery.base64.js?body=1" type="text/javascript"></script>
-    <script defer src="https://static.preview.alphagov.co.uk/static/user-satisfaction-survey.js?body=1" type="text/javascript"></script>
-    <script defer src="https://static.preview.alphagov.co.uk/static/core.js?body=1" type="text/javascript"></script>
-    <script defer src="https://static.preview.alphagov.co.uk/static/report-a-problem.js?body=1" type="text/javascript"></script>
-    <script src="https://static.preview.alphagov.co.uk/static/header-footer-only.js" type="text/javascript"></script>
+    <script src="https://assets-origin.preview.alphagov.co.uk/static/govuk-template.js" type="text/javascript"></script>
+    <script src="https://assets-origin.preview.alphagov.co.uk/static/libs/jquery/jquery-1.7.2.js" type="text/javascript"></script>
+    <script src="https://assets-origin.preview.alphagov.co.uk/static/header-footer-only.js" type="text/javascript"></script>
   </body>
 </html>

data/lib/slimmer/test_templates/wrapper.html

@@ -16,8 +16,8 @@
 
     <footer id="footer"></footer>
 
-    <script src="https://static.preview.alphagov.co.uk/static/govuk-template.js" type="text/javascript"></script>
-    <script src="https://static.preview.alphagov.co.uk/static/libs/jquery/jquery-1.7.2.js" type="text/javascript"></script>
-    <script src="https://static.preview.alphagov.co.uk/static/application.js" type="text/javascript"></script>
+    <script src="https://assets-origin.preview.alphagov.co.uk/static/govuk-template.js" type="text/javascript"></script>
+    <script src="https://assets-origin.preview.alphagov.co.uk/static/libs/jquery/jquery-1.7.2.js" type="text/javascript"></script>
+    <script src="https://assets-origin.preview.alphagov.co.uk/static/application.js" type="text/javascript"></script>
   </body>
 </html>

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '3.24.0'
+  VERSION = '3.25.0'
 end

data/test/changelog_test.rb

@@ -0,0 +1,10 @@
+require_relative 'test_helper'
+
+describe 'CHANGELOG' do
+
+  it "should have an entry for the current version" do
+    changelog_contents = File.read(File.expand_path("../../CHANGELOG.md", __FILE__))
+
+    assert_match /^#+\s*#{Regexp.escape(Slimmer::VERSION)}/, changelog_contents, "No entry for #{Slimmer::VERSION} found in CHANGELOG.md"
+  end
+end

data/test/skin_test.rb

@@ -10,10 +10,38 @@ describe Slimmer::Skin do
 
       template = skin.template 'example'
 
-      assert_requested :get, "http://example.local/templates/example.html.erb"
+      assert_requested :get, expected_url
       assert_equal "<foo />", template
     end
 
+    describe "should pass the GOVUK-Request-Id header when requesting the template" do
+      before do
+        @skin = Slimmer::Skin.new asset_host: "http://example.local/"
+        @expected_url = "http://example.local/templates/example.html.erb"
+        stub_request(:get, @expected_url).to_return :body => "<foo />"
+      end
+
+      it "should pass the value from the original request if set" do
+        Slimmer::GovukRequestId.value = '12345'
+        template = @skin.template('example')
+
+        assert_requested :get, @expected_url do |request|
+          request.headers['Govuk-Request-Id'] == '12345'
+        end
+        assert_equal "<foo />", template
+      end
+
+      it "shouldnot set the header if the value is not set" do
+        Slimmer::GovukRequestId.value = ''
+        template = @skin.template('example')
+
+        assert_requested :get, @expected_url do |request|
+          ! request.headers.has_key?('Govuk-Request-Id')
+        end
+        assert_equal "<foo />", template
+      end
+    end
+
     describe "template caching" do
       it "should not cache the template by default" do
         skin = Slimmer::Skin.new asset_host: "http://example.local/"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 3.24.0
+  version: 3.25.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2014-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -108,6 +108,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -257,6 +273,7 @@ files:
 - lib/slimmer/test.rb
 - lib/slimmer/version.rb
 - lib/slimmer/artefact.rb
+- lib/slimmer/govuk_request_id.rb
 - lib/slimmer/template.rb
 - lib/slimmer/processors/header_context_inserter.rb
 - lib/slimmer/processors/navigation_mover.rb
@@ -278,6 +295,7 @@ files:
 - lib/tasks/slimmer.rake
 - lib/slimmer.rb
 - Rakefile
+- test/changelog_test.rb
 - test/typical_usage_test.rb
 - test/skin_test.rb
 - test/artefact_test.rb
@@ -318,7 +336,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3770913411525795405
+      hash: 3065065351120828273
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -327,7 +345,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3770913411525795405
+      hash: 3065065351120828273
 requirements: []
 rubyforge_project: slimmer
 rubygems_version: 1.8.23
@@ -335,6 +353,7 @@ signing_key:
 specification_version: 3
 summary: Thinner than the skinner
 test_files:
+- test/changelog_test.rb
 - test/typical_usage_test.rb
 - test/skin_test.rb
 - test/artefact_test.rb