slimmer 1.1.43 → 1.1.44

data/lib/slimmer/app.rb

@@ -25,46 +25,35 @@ module Slimmer
 
     def call(env)
       logger.debug "Slimmer: capturing response"
-      backend_response = @app.call(env)
-
-      if in_development? and skip_slimmer_param?(env)
-        logger.debug "Slimmer: Asked to skip slimmer via skip_slimmer param"
-        return backend_response
-      elsif skip_slimmer_header?(backend_response)
-        logger.debug "Slimmer: Asked to skip slimmer via HTTP header"
-        return backend_response
+      status, headers, body = @app.call(env)
+      response = Rack::Response.new(body, status, headers)
+
+      if response_can_be_rewritten?(response) && !skip_slimmer?(env, response)
+        rewrite_response(env, response)
       else
-        rewrite_response(env, backend_response)
+        [status, headers, body]
       end
     end
-    
+
+    def response_can_be_rewritten?(response)
+      response.content_type =~ /text\/html/ && ![301, 302, 304].include?(response.status)
+    end
+
+    def skip_slimmer?(env, response)
+      (in_development? && skip_slimmer_param?(env)) || skip_slimmer_header?(response)
+    end
+
     def in_development?
       ENV['RAILS_ENV'] == 'development'
     end
-      
+
     def skip_slimmer_param?(env)
       skip = Rack::Request.new(env).params['skip_slimmer']
       skip and skip.to_i > 0
     end
-    
-    def skip_slimmer_header?(backend_response)
-      !! backend_response[1][SKIP_HEADER]
-    end
-    
-    def on_success(source_request, request, body)
-      @skin.success(source_request, request, body)
-    end
 
-    def admin(request,body)
-      @skin.admin(request,body)
-    end
-
-    def on_error(request, status, body)
-      @skin.error(request, '500', body)
-    end
-
-    def on_404(request,body)
-      @skin.error(request, '404', body)
+    def skip_slimmer_header?(response)
+      !!response.headers[SKIP_HEADER]
     end
 
     def s(body)
@@ -73,57 +62,34 @@ module Slimmer
       body.each {|a| b << a }
       b
     end
-    
+
     def content_length(rewritten_body)
       size = 0
       rewritten_body.each { |part| size += part.bytesize }
       size.to_s
     end
 
-    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"
-      request = Rack::Request.new(headers)
-      content_type = headers['Content-Type'] || headers['content-type']
-      
-      logger.debug "Slimmer: Content-Type: #{content_type}"
-      if content_type =~ /text\/html/
-        logger.debug "Slimmer: Status code = #{status}"
-        case status.to_i
-        when 200
-          logger.debug "Slimmer: I will rewrite this request"
-          logger.debug "Slimmer: #{TEMPLATE_HEADER} = #{headers[TEMPLATE_HEADER].inspect}"
-          logger.debug "Slimmer: Request path = #{source_request.path.inspect}"
-          if headers[TEMPLATE_HEADER] == 'admin' || source_request.path =~ /^\/admin(\/|$)/
-            logger.debug "Slimmer: Rewriting this request as an admin request"
-            rewritten_body = admin(request,s(app_body))
-          else
-            logger.debug "Slimmer: Rewriting this request as a public request"
-            rewritten_body = on_success(source_request, request, s(app_body))
-          end
-        when 301, 302, 304
-          logger.debug "Slimmer: I will not rewrite this request"
-          rewritten_body = app_body
-        when 404
-          logger.debug "Slimmer: Rewriting this request as a 404 error"
-          rewritten_body = on_404(request,s(app_body))
+    def rewrite_response(env, response)
+      request = Rack::Request.new(env)
+
+      rewritten_body = case response.status
+      when 200
+        if response.headers[TEMPLATE_HEADER] == 'admin' || request.path =~ /^\/admin(\/|$)/
+          @skin.admin s(response.body)
         else
-          logger.debug "Slimmer: Rewriting this request as a generic error"
-          rewritten_body = on_error(request,status,s(app_body))
+          @skin.success request, response, s(response.body)
         end
+      when 404
+        @skin.error '404', s(response.body)
       else
-        logger.debug "Slimmer: I will not rewrite this request"
-        rewritten_body = app_body
+        @skin.error '500', s(response.body)
       end
-      rewritten_body = [rewritten_body] unless rewritten_body.respond_to?(:each)
 
-      headers['Content-Length'] = content_length(rewritten_body)
-
-      logger.debug "Slimmer: Returning final status, headers and body"
-      [status, headers, rewritten_body]
+      rewritten_body = [rewritten_body] unless rewritten_body.respond_to?(:each)
+      response.body = rewritten_body
+      response.headers['Content-Length'] = content_length(response.body)
 
+      response.finish
     rescue GdsApi::TimedOutException
       [503, {"Content-Type" => "text/plain"}, ["GDS API request timed out."]]
     end

data/lib/slimmer/google_analytics_configurator.rb

@@ -11,8 +11,8 @@ module Slimmer
       "ResultCount" => "X-SLIMMER-RESULT-COUNT"
     }
 
-    def initialize(headers)
-      @headers = normalise_headers(headers)
+    def initialize(response)
+      @headers = response.headers
     end
 
     def filter(src, dest)
@@ -26,10 +26,6 @@ module Slimmer
     end
 
   private
-    def normalise_headers(headers)
-      Hash[headers.map { |k, v| [k.upcase, v] }]
-    end
-
     def set_custom_var(slot, name, value)
       return nil unless value
       value.downcase!

data/lib/slimmer/search_path_setter.rb

@@ -0,0 +1,19 @@
+require 'gds_api/helpers'
+
+module Slimmer
+  class SearchPathSetter
+    def initialize(response)
+      @response = response
+    end
+
+    def filter(content_document, page_template)
+      if search_scope && page_template.at_css('form#search')
+        page_template.at_css('form#search').attributes["action"].value = search_scope
+      end
+    end
+
+    def search_scope
+      @response.headers[SEARCH_PATH_HEADER]
+    end
+  end
+end

data/lib/slimmer/skin.rb

@@ -1,78 +1,35 @@
 module Slimmer
   class Skin
-    attr_accessor :use_cache
-    private :use_cache=, :use_cache
-
-    attr_accessor :templated_cache
-    private :templated_cache=, :templated_cache
-
-    attr_accessor :asset_host
-    private :asset_host=, :asset_host
-
-    attr_accessor :prefix
-    private :prefix=, :prefix
-
-    attr_accessor :logger
-    private :logger=, :logger
-
-    attr_accessor :strict
-    private :strict=, :strict
-
-    attr_accessor :options
-    private :options=, :options
+    attr_accessor :use_cache, :template_cache, :asset_host, :prefix, :logger, :strict, :options
 
     # TODO: Extract the cache to something we can pass in instead of using
     # true/false and an in-memory cache.
     def initialize options = {}
-      self.options = options
-      self.asset_host = options[:asset_host]
-      self.templated_cache = {}
-      self.prefix = options[:prefix]
-      self.use_cache = options[:use_cache] || false
-      self.logger = options[:logger] || NullLogger.instance
-      self.strict = options[:strict] || (%w{development test}.include?(ENV['RACK_ENV']))
+      @options = options
+      @asset_host = options[:asset_host]
+      @template_cache = {}
+      @prefix = options[:prefix]
+      @use_cache = options[:use_cache] || false
+      @logger = options[:logger] || NullLogger.instance
+      @strict = options[:strict] || (%w{development test}.include?(ENV['RACK_ENV']))
     end
 
     def template(template_name)
-      logger.debug "Slimmer: Looking for template '#{template_name}'"
-      return cached_template(template_name) if template_cached? template_name
-      logger.debug "Slimmer: Asking for the template to be loaded"
-      load_template template_name
-    end
-
-    def template_cached? name
-      logger.debug "Slimmer: Checking cache for template '#{name}'"
-      cached = !cached_template(name).nil?
-      logger.debug "Slimmer: Cache hit = #{cached}"
-      cached
-    end
-
-    def cached_template name
-      logger.debug "Slimmer: Trying to load cached template '#{name}'"
-      templated_cache[name]
-    end
-
-    def cache name, template
-      logger.debug "Slimmer: Asked to cache '#{name}'. use_cache = #{use_cache}"
-      return unless use_cache
-      logger.debug "Slimmer: performing caching"
-      templated_cache[name] = template
+      if use_cache
+        template_cache[template_name] ||= load_template(template_name)
+      else
+        load_template(template_name)
+      end
     end
 
-    def load_template template_name
-      logger.debug "Slimmer: Loading template '#{template_name}'"
-      url = template_url template_name
-      logger.debug "Slimmer: template lives at '#{url}'"
+    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/
-        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
     rescue OpenURI::HTTPError => e
       raise TemplateNotFoundException, "Unable to fetch: '#{template_name}' from '#{url}' because #{e}", caller
@@ -82,23 +39,16 @@ module Slimmer
       raise CouldNotRetrieveTemplate, "Unable to fetch: '#{template_name}' from '#{url}' because #{e}", caller
     end
 
-    def template_url template_name
+    def template_url(template_name)
       host = asset_host.dup
       host += '/' unless host =~ /\/$/
       "#{host}templates/#{template_name}.html.erb"
     end
 
-    def error(request, template_name, body)
-      processors = [
-        TitleInserter.new()
-      ]
-      process(processors, body, template(template_name))
-    end
-    
     def report_parse_errors_if_strict!(nokogiri_doc, description_for_error_message)
       nokogiri_doc
     end
-    
+
     def parse_html(html, description_for_error_message)
       doc = Nokogiri::HTML.parse(html)
       if strict
@@ -114,7 +64,7 @@ module Slimmer
 
       doc
     end
-    
+
     def context(html, error)
       context_size = 5
       lines = [""] + html.split("\n")
@@ -125,7 +75,7 @@ module Slimmer
       context.insert(context_size, marker)
       context.join("\n")
     end
-    
+
     def ignorable?(error)
       ignorable_codes = [801]
       ignorable_codes.include?(error.code) || error.message.match(/Element script embeds close tag/) || error.message.match(/Unexpected end tag : noscript/)
@@ -153,12 +103,12 @@ 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. 
+      # 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("|')>/, "")
     end
 
-    def admin(request,body)
+    def admin(body)
       processors = [
         TitleInserter.new(),
         TagMover.new(),
@@ -167,10 +117,10 @@ module Slimmer
         BodyInserter.new(),
         BodyClassCopier.new,
       ]
-      process(processors,body,template('admin'))
+      process(processors, body, template('admin'))
     end
 
-    def success(source_request, request, body)
+    def success(source_request, response, body)
       processors = [
         TitleInserter.new(),
         TagMover.new(),
@@ -178,12 +128,20 @@ module Slimmer
         BodyClassCopier.new,
         HeaderContextInserter.new(),
         SectionInserter.new(),
-        GoogleAnalyticsConfigurator.new(request.env),
+        GoogleAnalyticsConfigurator.new(response),
+        SearchPathSetter.new(response),
         RelatedItemsInserter.new(template('related.raw'), source_request),
       ]
-      
-      template_name = request.env.has_key?(TEMPLATE_HEADER) ? request.env[TEMPLATE_HEADER] : 'wrapper'
-      process(processors,body,template(template_name))
+
+      template_name = response.headers[TEMPLATE_HEADER] || 'wrapper'
+      process(processors, body, template(template_name))
+    end
+
+    def error(template_name, body)
+      processors = [
+        TitleInserter.new()
+      ]
+      process(processors, body, template(template_name))
     end
   end
 end

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '1.1.43'
+  VERSION = '1.1.44'
 end

data/lib/slimmer.rb

@@ -10,6 +10,7 @@ require 'slimmer/railtie' if defined? Rails
 module Slimmer
   TEMPLATE_HEADER = 'X-Slimmer-Template'
   SKIP_HEADER = 'X-Slimmer-Skip'
+  SEARCH_PATH_HEADER = 'X-Slimmer-Search-Path'
 
   autoload :Version, 'slimmer/version'
   autoload :Railtie, 'slimmer/railtie'
@@ -28,6 +29,7 @@ module Slimmer
   autoload :HeaderContextInserter, 'slimmer/header_context_inserter'
   autoload :GoogleAnalyticsConfigurator, 'slimmer/google_analytics_configurator'
   autoload :RelatedItemsInserter, 'slimmer/related_items_inserter'
+  autoload :SearchPathSetter, 'slimmer/search_path_setter'
 
   class TemplateNotFoundException < StandardError; end
   class CouldNotRetrieveTemplate < StandardError; end

data/test/search_path_setter_test.rb

@@ -0,0 +1,39 @@
+require "test_helper"
+
+module GoogleAnalyticsTest
+
+  DOCUMENT_WITH_SEARCH = <<-END
+    <html>
+      <head>
+      </head>
+      <body class="body_class">
+        <div id="wrapper">
+          <form id="search" action="/path/to/search">
+          </form>
+        </div>
+      </body>
+    </html>
+  END
+
+  class WithHeaderTest < SlimmerIntegrationTest
+    headers = {
+      "X-Slimmer-Search-Path" => "/specialist/search",
+    }
+
+    given_response 200, DOCUMENT_WITH_SEARCH, headers
+
+    def test_should_rewrite_search_action
+      search_action = Nokogiri::HTML.parse(last_response.body).at_css('#search')["action"]
+      assert_equal "/specialist/search", search_action
+    end
+  end
+
+  class WithoutHeaderTest < SlimmerIntegrationTest
+    given_response 200, DOCUMENT_WITH_SEARCH, {}
+
+    def test_should_leave_original_search_action
+      search_action = Nokogiri::HTML.parse(last_response.body).at_css('#search')["action"]
+      assert_equal "/path/to/search", search_action
+    end
+  end
+end

data/test/skin_test.rb

@@ -6,18 +6,30 @@ class SkinTest < MiniTest::Unit::TestCase
     expected_url = "http://example.local/templates/example.html.erb"
     stub_request(:get, expected_url).to_return :body => "<foo />"
 
-    template = skin.load_template 'example'
+    template = skin.template 'example'
 
     assert_requested :get, "http://example.local/templates/example.html.erb"
     assert_equal "<foo />", template
   end
 
+  def test_templates_can_be_cached
+    skin = Slimmer::Skin.new asset_host: "http://example.local/", use_cache: true
+    expected_url = "http://example.local/templates/example.html.erb"
+    stub_request(:get, expected_url).to_return :body => "<foo />"
+
+    first_access = skin.template 'example'
+    second_access = skin.template 'example'
+
+    assert_requested :get, "http://example.local/templates/example.html.erb", times: 1
+    assert_same first_access, second_access
+  end
+
   def test_should_interpolate_values_for_prefix
     skin = Slimmer::Skin.new asset_host: "http://example.local/", use_cache: false, prefix: "this-is-the-prefix"
     expected_url = "http://example.local/templates/example.html.erb"
     stub_request(:get, expected_url).to_return :body => "<p><%= prefix %></p>"
 
-    template = skin.load_template 'example'
+    template = skin.template 'example'
     assert_equal "<p>this-is-the-prefix</p>", template
   end
 
@@ -27,7 +39,7 @@ class SkinTest < MiniTest::Unit::TestCase
     stub_request(:get, expected_url).to_return(:status => '404')
 
     assert_raises(Slimmer::TemplateNotFoundException) do
-      skin.load_template 'example'
+      skin.template 'example'
     end
   end
 
@@ -37,7 +49,7 @@ class SkinTest < MiniTest::Unit::TestCase
     stub_request(:get, expected_url).to_raise(Errno::ECONNREFUSED)
 
     assert_raises(Slimmer::CouldNotRetrieveTemplate) do
-      skin.load_template 'example'
+      skin.template 'example'
     end
   end
 
@@ -47,7 +59,7 @@ class SkinTest < MiniTest::Unit::TestCase
     stub_request(:get, expected_url).to_raise(SocketError)
 
     assert_raises(Slimmer::CouldNotRetrieveTemplate) do
-      skin.load_template 'example'
+      skin.template 'example'
     end
   end
 end

data/test/test_helper.rb

@@ -30,7 +30,7 @@ class SlimmerIntegrationTest < MiniTest::Unit::TestCase
   def self.given_response(code, body, headers={}, app_options={})
     define_method(:app) do
       inner_app = proc { |env|
-        [code, headers.merge("Content-Type" => "text/html"), body]
+        [code, {"Content-Type" => "text/html"}.merge(headers), body]
       }
       Slimmer::App.new inner_app, {asset_host: "http://template.local"}.merge(app_options)
     end
@@ -55,17 +55,17 @@ class SlimmerIntegrationTest < MiniTest::Unit::TestCase
     setup_template if respond_to? :setup_template
     fetch_page
   end
-  
+
   def fetch_page
     get "/"
   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)

data/test/typical_usage_test.rb

@@ -10,10 +10,10 @@ module TypicalUsage
       assert_equal "Don't template me", last_response.body
     end
   end
-  
+
   class SkipUsingQueryParamTest < SlimmerIntegrationTest
     given_response 200, %{<html><body><div id='unskinned'>Unskinned</div><div id="wrapper">Don't template me</div></body></html>}, {}
-    
+
     def fetch_page; end
 
     def with_rails_env(new_env, &block)
@@ -24,7 +24,7 @@ module TypicalUsage
         ENV['RAILS_ENV'] = old_env
       end
     end
-    
+
     def test_should_return_the_response_as_is_in_development
       with_rails_env('development') do
         get "/some-slug?skip_slimmer=1"
@@ -40,6 +40,14 @@ module TypicalUsage
     end
   end
 
+  class SkipNonHtmlResponse < SlimmerIntegrationTest
+    given_response 200, '{ "json" : "document" }', {'Content-Type' => 'application/json'}
+
+    def test_should_pass_through_non_html_response
+      assert_equal '{ "json" : "document" }', last_response.body
+    end
+  end
+
   class ContentLengthTest < SlimmerIntegrationTest
     given_response 200, %{
       <html>
@@ -105,16 +113,16 @@ 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 setup
       panopticon_has_metadata(
-        'slug' => 'some-slug', 
-        'title' => 'Example document', 
+        'slug' => 'some-slug',
+        'title' => 'Example document',
         'related_items' => [
             {
             'artefact' => {
@@ -128,7 +136,7 @@ module TypicalUsage
       super
     end
   end
-  
+
   class CitizenRelatedItemsTest < ResponseWithRelatedItemsTest
     given_response 200, %{
       <html>
@@ -137,11 +145,11 @@ module TypicalUsage
       </body>
       </html>
     }, {}
-    
+
     def fetch_page
       get "/some-slug"
     end
-    
+
     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"}
@@ -156,11 +164,11 @@ module TypicalUsage
       </body>
       </html>
     }, {}
-    
+
     def fetch_page
       get "/some-slug"
     end
-    
+
     def test_should_not_insert_related_items_block
       assert_rendered_in_template "div#related-items", ""
     end

metadata

@@ -2,7 +2,7 @@
 name: slimmer
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.43
+  version: 1.1.44
 platform: ruby
 authors: 
 - Ben Griffiths
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-07-09 00:00:00 Z
+date: 2012-07-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -170,6 +170,7 @@ files:
 - lib/slimmer/skin.rb
 - lib/slimmer/section_inserter.rb
 - lib/slimmer/title_inserter.rb
+- lib/slimmer/search_path_setter.rb
 - lib/slimmer/url_rewriter.rb
 - lib/slimmer/body_class_copier.rb
 - lib/slimmer/headers.rb
@@ -191,6 +192,7 @@ files:
 - test/fixtures/related.raw.html.erb
 - test/fixtures/404.html.erb
 - test/fixtures/wrapper.html.erb
+- test/search_path_setter_test.rb
 - test/skin_test.rb
 - test/google_analytics_test.rb
 - bin/render_slimmer_error
@@ -207,7 +209,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1691084330246776623
+      hash: -3422349494229689063
       segments: 
       - 0
       version: "0"
@@ -216,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1691084330246776623
+      hash: -3422349494229689063
       segments: 
       - 0
       version: "0"
@@ -237,5 +239,6 @@ test_files:
 - test/fixtures/related.raw.html.erb
 - test/fixtures/404.html.erb
 - test/fixtures/wrapper.html.erb
+- test/search_path_setter_test.rb
 - test/skin_test.rb
 - test/google_analytics_test.rb