slimmer 1.2.5 → 2.0.0

data/CHANGELOG.md

@@ -1,5 +1,18 @@
+# 2.0.0
+
+Backwards-incompatible changes:
+
+* Artefact has to be explicitly passed to slimmer.
+* RelatedItemsInserter uses passed artefact instead of calling out to panopticon.
+* Slimmer now strips all X-Slimmer-* HTTP headers from the final response.
+
+Other changes
+
+* new LogoClassInserter module - adds classes to the `#wrapper` element to control the appearence of the directgov and businesslink logos
+* Rounded Corners!!! (it is 2.0 after all)
+
 # 0.9.0
 
 * Moved templates into slimmer rather than using separate static project
 * Added railtie so that slimmer can be dropped into a rails app without configuration
-* Began to write *gasp* tests!
+* Began to write *gasp* tests!

data/lib/slimmer.rb

@@ -1,3 +1,8 @@
+       #########################################
+   ####### Look, Rounded corners....  It's 2.0 #####
+ #####################################################
+#######################################################
+
 require 'nokogiri'
 require 'erb'
 require 'open-uri'
@@ -5,33 +10,39 @@ require 'plek'
 require 'null_logger'
 require 'openssl'
 
+require 'slimmer/version'
 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'
   autoload :Skin, 'slimmer/skin'
 
   autoload :Template, 'slimmer/template'
   autoload :App, 'slimmer/app'
-  autoload :TitleInserter, 'slimmer/title_inserter'
-  autoload :AdminTitleInserter, 'slimmer/admin_title_inserter'
-  autoload :SectionInserter, 'slimmer/section_inserter'
-  autoload :TagMover, 'slimmer/tag_mover'
-  autoload :ConditionalCommentMover, 'slimmer/conditional_comment_mover'
-  autoload :FooterRemover, 'slimmer/footer_remover'
-  autoload :BodyInserter, 'slimmer/body_inserter'
-  autoload :BodyClassCopier, 'slimmer/body_class_copier'
-  autoload :UrlRewriter, 'slimmer/url_rewriter'
-  autoload :HeaderContextInserter, 'slimmer/header_context_inserter'
-  autoload :GoogleAnalyticsConfigurator, 'slimmer/google_analytics_configurator'
-  autoload :RelatedItemsInserter, 'slimmer/related_items_inserter'
-  autoload :SearchPathSetter, 'slimmer/search_path_setter'
+  autoload :Headers, 'slimmer/headers'
+
+  module Processors
+    autoload :AdminTitleInserter, 'slimmer/processors/admin_title_inserter'
+    autoload :BodyClassCopier, 'slimmer/processors/body_class_copier'
+    autoload :BodyInserter, 'slimmer/processors/body_inserter'
+    autoload :ConditionalCommentMover, 'slimmer/processors/conditional_comment_mover'
+    autoload :FooterRemover, 'slimmer/processors/footer_remover'
+    autoload :GoogleAnalyticsConfigurator, 'slimmer/processors/google_analytics_configurator'
+    autoload :HeaderContextInserter, 'slimmer/processors/header_context_inserter'
+    autoload :LogoClassInserter, 'slimmer/processors/logo_class_inserter'
+    autoload :RelatedItemsInserter, 'slimmer/processors/related_items_inserter'
+    autoload :SearchPathSetter, 'slimmer/processors/search_path_setter'
+    autoload :SectionInserter, 'slimmer/processors/section_inserter'
+    autoload :TagMover, 'slimmer/processors/tag_mover'
+    autoload :TitleInserter, 'slimmer/processors/title_inserter'
+  end
 
   class TemplateNotFoundException < StandardError; end
   class CouldNotRetrieveTemplate < StandardError; end
 end
+
+#######################################################
+ #####################################################
+   #################################################
+       #########################################

data/lib/slimmer/app.rb

@@ -1,5 +1,3 @@
-require "gds_api/exceptions"
-
 module Slimmer
   class App
     attr_accessor :logger
@@ -29,10 +27,10 @@ module Slimmer
       response = Rack::Response.new(body, status, headers)
 
       if response_can_be_rewritten?(response) && !skip_slimmer?(env, response)
-        rewrite_response(env, response)
-      else
-        [status, headers, body]
+        status, headers, body = rewrite_response(env, response)
       end
+
+      [status, strip_slimmer_headers(headers), body]
     end
 
     def response_can_be_rewritten?(response)
@@ -53,7 +51,7 @@ module Slimmer
     end
 
     def skip_slimmer_header?(response)
-      !!response.headers[SKIP_HEADER]
+      !!response.headers[Headers::SKIP_HEADER]
     end
 
     def s(body)
@@ -74,7 +72,7 @@ module Slimmer
 
       rewritten_body = case response.status
       when 200
-        if response.headers[TEMPLATE_HEADER] == 'admin' || request.path =~ /^\/admin(\/|$)/
+        if response.headers[Headers::TEMPLATE_HEADER] == 'admin' || request.path =~ /^\/admin(\/|$)/
           @skin.admin s(response.body)
         else
           @skin.success request, response, s(response.body)
@@ -90,8 +88,10 @@ module Slimmer
       response.headers['Content-Length'] = content_length(response.body)
 
       response.finish
-    rescue GdsApi::TimedOutException
-      [503, {"Content-Type" => "text/plain"}, ["GDS API request timed out."]]
+    end
+
+    def strip_slimmer_headers(headers)
+      headers.reject {|k, v| k =~ /\A#{Headers::HEADER_PREFIX}/ }
     end
   end
 end

data/lib/slimmer/headers.rb

@@ -2,6 +2,8 @@ module Slimmer
   module Headers
     InvalidHeader = Class.new(RuntimeError)
 
+    HEADER_PREFIX = "X-Slimmer"
+
     SLIMMER_HEADER_MAPPING = {
       section:      "Section",
       need_id:      "Need-ID",
@@ -12,12 +14,41 @@ module Slimmer
       skip:         "Skip",
     }
 
+    TEMPLATE_HEADER = "#{HEADER_PREFIX}-Template"
+    SKIP_HEADER = "#{HEADER_PREFIX}-Skip"
+    SEARCH_PATH_HEADER = "#{HEADER_PREFIX}-Search-Path"
+    ARTEFACT_HEADER = "#{HEADER_PREFIX}-Artefact"
+
     def set_slimmer_headers(hash)
       raise InvalidHeader if (hash.keys - SLIMMER_HEADER_MAPPING.keys).any?
       SLIMMER_HEADER_MAPPING.each do |hash_key, header_suffix|
         value = hash[hash_key]
-        headers["X-Slimmer-#{header_suffix}"] = value.to_s if value
+        headers["#{HEADER_PREFIX}-#{header_suffix}"] = value.to_s if value
+      end
+    end
+
+    def set_slimmer_artefact(artefact_input)
+      if artefact_input.is_a?(Hash) or artefact_input.is_a?(OpenStruct)
+        artefact = artefact_input.dup
+      elsif artefact_input.respond_to?(:to_hash) # e.g. GdsApi::Response
+        artefact = artefact_input.to_hash.dup
+      end
+
+      if artefact.is_a?(Hash)
+        # Temporary deletions until the actions are removed from the API.
+        # The actions increase the size of the artefact significantly, and will
+        # only grow over time.
+        #
+        # We skip this when given an OpenStruct as they won't have actions etc...
+        artefact.delete("actions")
+        if artefact["related_items"]
+          artefact["related_items"].each do |ri|
+            ri["artefact"].delete("actions") if ri["artefact"]
+          end
+        end
       end
+
+      headers[ARTEFACT_HEADER] = artefact.to_json
     end
   end
 end

data/lib/slimmer/{admin_title_inserter.rb → processors/admin_title_inserter.rb}

@@ -1,4 +1,4 @@
-module Slimmer
+module Slimmer::Processors
   class AdminTitleInserter
     def filter(src,dest)
       title = src.at_css('#site-title')

data/lib/slimmer/{body_class_copier.rb → processors/body_class_copier.rb}

@@ -1,4 +1,4 @@
-module Slimmer
+module Slimmer::Processors
   class BodyClassCopier
     def filter(src, dest)
       src_body_tag = src.at_css("body")

data/lib/slimmer/{body_inserter.rb → processors/body_inserter.rb}

@@ -1,4 +1,4 @@
-module Slimmer
+module Slimmer::Processors
   class BodyInserter
     def initialize(source_id='wrapper', destination_id='wrapper')
       @source_selector = '#' + source_id

data/lib/slimmer/{conditional_comment_mover.rb → processors/conditional_comment_mover.rb}

@@ -1,4 +1,4 @@
-module Slimmer
+module Slimmer::Processors
   class ConditionalCommentMover
     def filter(src, dest)
       src.xpath('//comment()').each do |comment|

data/lib/slimmer/{footer_remover.rb → processors/footer_remover.rb}

@@ -1,4 +1,4 @@
-module Slimmer
+module Slimmer::Processors
   class FooterRemover
     def filter(src,dest)
       footer = src.at_css("#footer")

data/lib/slimmer/{google_analytics_configurator.rb → processors/google_analytics_configurator.rb}

@@ -1,6 +1,6 @@
 require "json"
 
-module Slimmer
+module Slimmer::Processors
   class GoogleAnalyticsConfigurator
     PAGE_LEVEL_EVENT = 3
     HEADER_MAPPING = {
@@ -29,7 +29,8 @@ module Slimmer
     def set_custom_var(slot, name, value)
       return nil unless value
       value.downcase!
-      "_gaq.push(#{JSON.dump([ "_setCustomVar", slot, name, value, PAGE_LEVEL_EVENT])});"
+      response = "_gaq.push(#{JSON.dump([ "_setCustomVar", slot, name, value, PAGE_LEVEL_EVENT])});\n"
+      response + "GOVUK.Analytics.#{name} = \"#{value}\";"
     end
   end
 end

data/lib/slimmer/{header_context_inserter.rb → processors/header_context_inserter.rb}

@@ -1,4 +1,4 @@
-module Slimmer
+module Slimmer::Processors
   class HeaderContextInserter
     def initialize(path='.header-context')
       @path = path

data/lib/slimmer/processors/logo_class_inserter.rb

@@ -0,0 +1,20 @@
+module Slimmer
+  module Processors
+    class LogoClassInserter
+      LOGO_CLASSES = %w(businesslink directgov)
+
+      def initialize(artefact)
+        @artefact = artefact
+      end
+
+      def filter(source, dest)
+        return unless @artefact and @artefact["tag_ids"]
+        logo_classes = LOGO_CLASSES & @artefact["tag_ids"]
+        wrapper = dest.css('#wrapper')
+        logo_classes.each do |klass|
+          wrapper.add_class(klass)
+        end
+      end
+    end
+  end
+end

data/lib/slimmer/processors/related_items_inserter.rb

@@ -0,0 +1,20 @@
+class Slimmer::Processors::RelatedItemsInserter
+  include ERB::Util
+  
+  def initialize(related_block_template, artefact)
+    @related_block_template = related_block_template
+    @artefact = artefact
+  end
+  
+  def filter(content_document, page_template)
+    if content_document.at_css('body.mainstream div#related-items')
+      page_template.at_css('body.mainstream div#related-items').replace(related_item_block)
+    end
+  end
+  
+  def related_item_block
+    artefact = @artefact
+    html = ERB.new(@related_block_template).result(binding)
+    Nokogiri::HTML.fragment(html)
+  end
+end

data/lib/slimmer/{search_path_setter.rb → processors/search_path_setter.rb}

@@ -1,6 +1,4 @@
-require 'gds_api/helpers'
-
-module Slimmer
+module Slimmer::Processors
   class SearchPathSetter
     def initialize(response)
       @response = response
@@ -13,7 +11,7 @@ module Slimmer
     end
 
     def search_scope
-      @response.headers[SEARCH_PATH_HEADER]
+      @response.headers[Slimmer::Headers::SEARCH_PATH_HEADER]
     end
   end
 end

data/lib/slimmer/{section_inserter.rb → processors/section_inserter.rb}

@@ -1,4 +1,4 @@
-module Slimmer
+module Slimmer::Processors
   class SectionInserter
     def filter(src,dest)
       meta_name = dest.at_css('meta[name="x-section-name"]')

data/lib/slimmer/{tag_mover.rb → processors/tag_mover.rb}

@@ -1,4 +1,4 @@
-module Slimmer
+module Slimmer::Processors
   class TagMover
     def filter(src,dest)
       move_tags(src, dest, 'script', :must_have => ['src'])

data/lib/slimmer/{title_inserter.rb → processors/title_inserter.rb}

@@ -1,4 +1,4 @@
-module Slimmer
+module Slimmer::Processors
   class TitleInserter
     def filter(src,dest)
       title = src.at_css('head title')

data/lib/slimmer/skin.rb

@@ -92,8 +92,6 @@ module Slimmer
         logger.debug "Slimmer: Processor #{p} started at #{processor_start_time}"
         begin
           p.filter(src,dest)
-        rescue GdsApi::TimedOutException
-          raise
         rescue => e
           logger.error "Slimmer: Failed while processing #{p}: #{[ e.message, e.backtrace ].flatten.join("\n")}"
         end
@@ -111,39 +109,49 @@ module Slimmer
 
     def admin(body)
       processors = [
-        TitleInserter.new(),
-        TagMover.new(),
-        AdminTitleInserter.new,
-        FooterRemover.new,
-        BodyInserter.new(),
-        BodyClassCopier.new,
+        Processors::TitleInserter.new(),
+        Processors::TagMover.new(),
+        Processors::AdminTitleInserter.new,
+        Processors::FooterRemover.new,
+        Processors::BodyInserter.new(),
+        Processors::BodyClassCopier.new,
       ]
       process(processors, body, template('admin'))
     end
 
     def success(source_request, response, body)
+      artefact = artefact_from_header(response)
       processors = [
-        TitleInserter.new(),
-        TagMover.new(),
-        ConditionalCommentMover.new(),
-        BodyInserter.new(options[:wrapper_id] || 'wrapper'),
-        BodyClassCopier.new,
-        HeaderContextInserter.new(),
-        SectionInserter.new(),
-        GoogleAnalyticsConfigurator.new(response),
-        SearchPathSetter.new(response),
-        RelatedItemsInserter.new(template('related.raw'), source_request),
+        Processors::TitleInserter.new(),
+        Processors::TagMover.new(),
+        Processors::ConditionalCommentMover.new(),
+        Processors::BodyInserter.new(options[:wrapper_id] || 'wrapper'),
+        Processors::BodyClassCopier.new,
+        Processors::HeaderContextInserter.new(),
+        Processors::SectionInserter.new(),
+        Processors::GoogleAnalyticsConfigurator.new(response),
+        Processors::SearchPathSetter.new(response),
+        Processors::RelatedItemsInserter.new(template('related.raw'), artefact),
+        Processors::LogoClassInserter.new(artefact),
       ]
 
-      template_name = response.headers[TEMPLATE_HEADER] || 'wrapper'
+      template_name = response.headers[Headers::TEMPLATE_HEADER] || 'wrapper'
       process(processors, body, template(template_name))
     end
 
     def error(template_name, body)
       processors = [
-        TitleInserter.new()
+        Processors::TitleInserter.new()
       ]
       process(processors, body, template(template_name))
     end
+
+    def artefact_from_header(response)
+      if response.headers.include?(Headers::ARTEFACT_HEADER)
+        JSON.parse(response.headers[Headers::ARTEFACT_HEADER])
+      else
+        nil
+      end
+    end
   end
 end

data/lib/slimmer/template.rb

@@ -7,7 +7,7 @@ module Slimmer
     module ClassMethods
       def slimmer_template template_name
         after_filter do
-          response.headers[Slimmer::TEMPLATE_HEADER] = template_name.to_s
+          response.headers[Slimmer::Headers::TEMPLATE_HEADER] = template_name.to_s
         end
       end
     end

data/lib/slimmer/test.rb

@@ -5,7 +5,11 @@ module Slimmer
   class Skin
     def load_template name
       logger.debug "Slimmer: TEST MODE - Loading fixture template from #{__FILE__}"
-      Slimmer::TestTemplate::TEMPLATE
+      if name == 'related.raw'
+        %{<div id="test-related-items"></div>}
+      else
+        Slimmer::TestTemplate::TEMPLATE
+      end
     end
   end
 end

data/lib/slimmer/test_template.rb

@@ -15,7 +15,13 @@ module Slimmer::TestTemplate
         <script src="http://static.preview.alphagov.co.uk/static/customisation-settings.js" defer></script>
       </head>
       <body>
-        <div class="header-context">Header</div>
+        <nav role="navigation" class="header-context">
+          <ol class="group">
+            <li><a href="/">Home</a></li>
+            <li><a href="/browse">All sections</a></li>
+          </ol>
+        </nav>
+
         <div id="wrapper"></div>
       </body>
     </html>

data/lib/slimmer/version.rb

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