slimmer 13.0.0 → 13.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 668e43ea2579afcef2047274b110c10f7a377560
-  data.tar.gz: eb7f475b36cda8923e92c230bb190121cea7badb
+SHA256:
+  metadata.gz: 29c95c6ec5fcb3d786e88628da00aa44018de1a338e49359d19088db092ea025
+  data.tar.gz: 5c2f32ef832e751dc5812af7cb9d388fd4a36c8bde03d9525f58b7a46b5f0e87
 SHA512:
-  metadata.gz: d02f1d56e8dd317087cc6a237cedb52df633e7baad7e35cb36f5ec934d2adf6610d272fa1c76d05b2ee8883c553cc1d0cadf44c0932457ecb1e27e6448c157e4
-  data.tar.gz: 3937badf8181de169406b57a6ba2eed98250d49239f727e3fd1e5d80899872e53c2da45f7af7324777117a599935f414e658b800a53bf0ed6db041db30c9498a
+  metadata.gz: 111d7b5964863534428a2a6b9f46252f49624cb226c524e6c048cbff155c2a37d96cf14f85ade73d71b9b8bbeef1065596f9e795682f7f4fe913529fb0225116
+  data.tar.gz: 182cab20358b7ae4b69b17c11b19ddb6697e54bd94cd66575478bdc0fa11d6a03597d9788ec4c03b6da22f6ccbb5a4156042aaecb433b1c7ddc907c2e3b7934f

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+# 13.3.0
+
+* Add X-Slimmer-Ignore-Error header flag to prevent overriding non-200 status responses
+
+# 13.2.2
+
+* Fix bug where parent_name was called without app
+
+# 13.2.1
+
+* Fix deprecation warning: `Module#parent_name` has been renamed to
+  `module_parent_name`. `parent_name` is deprecated and will be removed in
+  Rails 6.1. (#237)
+* Migrate from govuk-lint to rubocop-govuk (#237)
+* Remove lint rake task (#237)
+* Fix linting issues (#237)
+* Fix deprecation warning: Mocha deprecation warning at
+  /my/local/path/to/test/test_helper.rb:6:in 'require': Require
+  'mocha/test_unit', 'mocha/minitest' or 'mocha/api' instead of 'mocha/setup'.
+  (#237)
+
+# 13.2.0
+
+* Upgrade Ruby version to 2.6.5. (#234)
+* Fix linting issues. (#234)
+
+# 13.1.0
+
+* Add `js-enabled` to body tag of test templates. (#226)
+
 # 13.0.0
 
 * Drop cache TTL to 60 seconds.

data/Rakefile

@@ -2,9 +2,9 @@
 
 require "bundler/gem_tasks"
 require "rdoc/task"
-require 'rake/testtask'
+require "rake/testtask"
 
-Dir.glob('lib/tasks/*.rake').each { |r| import r }
+Dir.glob("lib/tasks/*.rake").each { |r| import r }
 
 RDoc::Task.new do |rd|
   rd.rdoc_files.include("lib/**/*.rb")
@@ -12,10 +12,10 @@ RDoc::Task.new do |rd|
 end
 
 Rake::TestTask.new("test") do |t|
-  t.ruby_opts << "-rubygems"
+  t.ruby_opts << "-rrubygems"
   t.libs << "test"
   t.test_files = FileList["test/**/*_test.rb"]
   t.verbose = true
 end
 
-task :default => [:test, :lint]
+task default: %i[test]

data/bin/render_slimmer_error

@@ -1,26 +1,25 @@
 #! /usr/bin/env ruby
 
-require 'optparse'
-require 'slimmer'
-require 'logger'
+require "optparse"
+require "slimmer"
+require "logger"
 
 options = {}
-OptionParser.new do |opts|
-  opts.on '-t', '--template=TEMPLATE',
-    'Template to render' do |v|
+option_parser = OptionParser.new do |opts|
+  opts.on "-t", "--template=TEMPLATE", "Template to render" do |v|
     options[:template] = v
   end
 
-  opts.on '-h', '--asset-host=HOST',
-    'Host that serves assets used in the template' do |v|
+  opts.on "-h", "--asset-host=HOST", "Host that serves assets used in the template" do |v|
     options[:asset_host] = v
   end
 
-  opts.on '-o', '--output-file=FILE',
-    'File to write static error page to' do |v|
+  opts.on "-o", "--output-file=FILE", "File to write static error page to" do |v|
     options[:file] = v
   end
-end.parse!
+end
+
+option_parser.parse!
 
 raise "Please specify a template" unless options[:template]
 raise "Please specify an asset host" unless options[:asset_host]
@@ -28,13 +27,13 @@ raise "Please specify an output file" unless options[:file]
 
 logger = Logger.new STDOUT
 logger.level = Logger::DEBUG
-skin = Slimmer::Skin.new options[:asset_host], false, :logger => logger
+skin = Slimmer::Skin.new options[:asset_host], false, logger: logger
 static_error = skin.error nil, options[:template], Nokogiri::HTML("").to_html
 
-if options[:file] == '-'
+if options[:file] == "-"
   STDOUT.print static_error
 else
-  File.open options[:file], 'w' do |f|
+  File.open options[:file], "w" do |f|
     f.print static_error
   end
 end

data/lib/slimmer.rb

@@ -1,10 +1,10 @@
-require 'nokogiri'
-require 'erb'
-require 'plek'
-require 'null_logger'
+require "nokogiri"
+require "erb"
+require "plek"
+require "null_logger"
 
-require 'slimmer/version'
-require 'slimmer/railtie' if defined? Rails
+require "slimmer/version"
+require "slimmer/railtie" if defined? Rails
 
 module Slimmer
   CACHE_TTL = 60
@@ -19,29 +19,29 @@ module Slimmer
     end
   end
 
-  autoload :Railtie, 'slimmer/railtie'
-  autoload :Skin, 'slimmer/skin'
+  autoload :Railtie, "slimmer/railtie"
+  autoload :Skin, "slimmer/skin"
 
-  autoload :Template, 'slimmer/template'
-  autoload :App, 'slimmer/app'
-  autoload :Headers, 'slimmer/headers'
-  autoload :HTTPClient, 'slimmer/http_client'
+  autoload :Template, "slimmer/template"
+  autoload :App, "slimmer/app"
+  autoload :Headers, "slimmer/headers"
+  autoload :HTTPClient, "slimmer/http_client"
 
   module Processors
-    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 :MetadataInserter, 'slimmer/processors/metadata_inserter'
-    autoload :HeaderContextInserter, 'slimmer/processors/header_context_inserter'
-    autoload :InsideHeaderInserter, 'slimmer/processors/inside_header_inserter'
-    autoload :NavigationMover, 'slimmer/processors/navigation_mover'
-    autoload :SearchIndexSetter, 'slimmer/processors/search_index_setter'
-    autoload :SearchPathSetter, 'slimmer/processors/search_path_setter'
-    autoload :SearchParameterInserter, 'slimmer/processors/search_parameter_inserter'
-    autoload :SearchRemover, 'slimmer/processors/search_remover'
-    autoload :TagMover, 'slimmer/processors/tag_mover'
-    autoload :TitleInserter, 'slimmer/processors/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 :MetadataInserter, "slimmer/processors/metadata_inserter"
+    autoload :HeaderContextInserter, "slimmer/processors/header_context_inserter"
+    autoload :InsideHeaderInserter, "slimmer/processors/inside_header_inserter"
+    autoload :NavigationMover, "slimmer/processors/navigation_mover"
+    autoload :SearchIndexSetter, "slimmer/processors/search_index_setter"
+    autoload :SearchPathSetter, "slimmer/processors/search_path_setter"
+    autoload :SearchParameterInserter, "slimmer/processors/search_parameter_inserter"
+    autoload :SearchRemover, "slimmer/processors/search_remover"
+    autoload :TagMover, "slimmer/processors/tag_mover"
+    autoload :TitleInserter, "slimmer/processors/title_inserter"
   end
 
   class TemplateNotFoundException < StandardError; end

data/lib/slimmer/app.rb

@@ -1,23 +1,20 @@
-require 'slimmer/govuk_request_id'
+require "slimmer/govuk_request_id"
 
 module Slimmer
   class App
     attr_accessor :logger
 
-    def initialize(app, *args, &block)
+    def initialize(app, *args)
       options = args.first || {}
       @app = app
 
       logger = options[:logger] || NullLogger.instance
       self.logger = logger
-      begin
-        if logger.level == 0 # Log set to debug level
-          unless options[:enable_debugging]
-            self.logger = logger.dup
-            self.logger.level = 1 # info
-          end
+      if logger&.level&.zero? # Log set to debug level
+        unless options[:enable_debugging]
+          self.logger = logger.dup
+          self.logger.level = 1 # info
         end
-      rescue NoMethodError # In case logger doesn't respond_to? :level
       end
 
       if options.key? :template_path
@@ -55,22 +52,27 @@ module Slimmer
     end
 
     def in_development?
-      ENV['RAILS_ENV'] == '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
+      skip = Rack::Request.new(env).params["skip_slimmer"]
+      skip && skip.to_i.positive?
     end
 
     def skip_slimmer_header?(response)
       !!response.headers[Headers::SKIP_HEADER]
     end
 
+    def ignore_error_header?(response)
+      !!response.headers[Headers::IGNORE_ERROR_HEADER]
+    end
+
     def s(body)
       return body.to_s unless body.respond_to?(:each)
+
       b = ""
-      body.each {|a| b << a }
+      body.each { |a| b << a }
       b
     end
 
@@ -84,30 +86,36 @@ module Slimmer
       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']
+      GovukRequestId.value = env["HTTP_GOVUK_REQUEST_ID"]
+
+      body = rewritten_body(request, response)
+
+      body = [body] unless body.respond_to?(:each)
+      response.body = body
+      response.headers["Content-Length"] = content_length(response.body)
+
+      response.finish
+    end
+
+    def rewritten_body(request, response)
+      return @skin.success request, response, s(response.body) if ignore_error_header?(response)
 
-      rewritten_body = case response.status
+      case response.status
       when 200
         @skin.success request, response, s(response.body)
       when 403
-        @skin.error '403', s(response.body), request.env
+        @skin.error "403", s(response.body), request.env
       when 404
-        @skin.error '404', s(response.body), request.env
+        @skin.error "404", s(response.body), request.env
       when 410
-        @skin.error '410', s(response.body), request.env
+        @skin.error "410", s(response.body), request.env
       else
-        @skin.error '500', s(response.body), request.env
+        @skin.error "500", s(response.body), request.env
       end
-
-      rewritten_body = [rewritten_body] unless rewritten_body.respond_to?(:each)
-      response.body = rewritten_body
-      response.headers['Content-Length'] = content_length(response.body)
-
-      response.finish
     end
 
     def strip_slimmer_headers(headers)
-      headers.reject {|k, v| k =~ /\A#{Headers::HEADER_PREFIX}/ }
+      headers.reject { |k, _v| k =~ /\A#{Headers::HEADER_PREFIX}/ }
     end
   end
 end

data/lib/slimmer/cucumber.rb

@@ -1,3 +1,3 @@
-require 'cucumber'
+require "cucumber"
 
-require 'slimmer/test'
+require "slimmer/test"

data/lib/slimmer/headers.rb

@@ -5,7 +5,7 @@ module Slimmer
     InvalidHeader = Class.new(RuntimeError)
 
     # @private
-    HEADER_PREFIX = "X-Slimmer"
+    HEADER_PREFIX = "X-Slimmer".freeze
 
     # @private
     SLIMMER_HEADER_MAPPING = {
@@ -20,45 +20,51 @@ module Slimmer
       skip:                 "Skip",
       template:             "Template",
       remove_search:        "Remove-Search",
-    }
+      ignore_error:         "Ignore-Error",
+    }.freeze
 
     # @private
-    APPLICATION_NAME_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:application_name]}"
+    APPLICATION_NAME_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:application_name]}".freeze
 
     # @private
-    FORMAT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:format]}"
+    FORMAT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:format]}".freeze
 
     # @private
-    ORGANISATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:organisations]}"
+    ORGANISATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:organisations]}".freeze
 
     # @private
-    WORLD_LOCATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:world_locations]}"
+    WORLD_LOCATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:world_locations]}".freeze
 
     # @private
-    PAGE_OWNER_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:page_owner]}"
+    PAGE_OWNER_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:page_owner]}".freeze
 
     # @private
-    RESULT_COUNT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:result_count]}"
+    RESULT_COUNT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:result_count]}".freeze
 
     # @private
-    SEARCH_PATH_HEADER = "#{HEADER_PREFIX}-Search-Path"
+    SEARCH_PATH_HEADER = "#{HEADER_PREFIX}-Search-Path".freeze
 
     # @private
-    SEARCH_PARAMETERS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:search_parameters]}"
+    SEARCH_PARAMETERS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:search_parameters]}".freeze
 
     # @private
-    SKIP_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:skip]}"
+    SKIP_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:skip]}".freeze
 
     # @private
-    TEMPLATE_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:template]}"
+    TEMPLATE_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:template]}".freeze
 
     # @private
-    REMOVE_SEARCH_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:remove_search]}"
+    REMOVE_SEARCH_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:remove_search]}".freeze
+
+    # @private
+    IGNORE_ERROR_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:ignore_error]}".freeze
+
 
     # Set the "slimmer headers" to configure the page
     #
     # @param hash [Hash] the options
     # @option hash [String] application_name
+    # @option hash [String] ignore_error
     # @option hash [String] format
     # @option hash [String] organisations
     # @option hash [String] page_owner
@@ -71,6 +77,7 @@ module Slimmer
     # @option hash [String] world_locations
     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["#{HEADER_PREFIX}-#{header_suffix}"] = value.to_s if value

data/lib/slimmer/processors/body_class_copier.rb

@@ -2,11 +2,11 @@ module Slimmer::Processors
   class BodyClassCopier
     def filter(src, dest)
       src_body_tag = src.at_css("body")
-      dest_body_tag = dest.at_css('body')
+      dest_body_tag = dest.at_css("body")
       if src_body_tag.has_attribute?("class")
-        combinded_classes = dest_body_tag.attr('class').to_s.split(/ +/)
-        combinded_classes << src_body_tag.attr('class').to_s.split(/ +/)
-        dest_body_tag.set_attribute("class", combinded_classes.join(' '))
+        combinded_classes = dest_body_tag.attr("class").to_s.split(/ +/)
+        combinded_classes << src_body_tag.attr("class").to_s.split(/ +/)
+        dest_body_tag.set_attribute("class", combinded_classes.join(" "))
       end
     end
   end

data/lib/slimmer/processors/body_inserter.rb

@@ -1,11 +1,11 @@
 module Slimmer::Processors
   class BodyInserter
-    def initialize(source_id='wrapper', destination_id='wrapper')
-      @source_selector = '#' + source_id
-      @destination_selector = '#' + destination_id
+    def initialize(source_id = "wrapper", destination_id = "wrapper")
+      @source_selector = "#" + source_id
+      @destination_selector = "#" + destination_id
     end
 
-    def filter(src,dest)
+    def filter(src, dest)
       body = Nokogiri::HTML.fragment(src.at_css(@source_selector).to_html)
       dest.at_css(@destination_selector).replace(body)
     end

data/lib/slimmer/processors/conditional_comment_mover.rb

@@ -1,9 +1,9 @@
 module Slimmer::Processors
   class ConditionalCommentMover
     def filter(src, dest)
-      src.xpath('//comment()').each do |comment|
+      src.xpath("//comment()").each do |comment|
         if match_conditional_comments(comment)
-          dest.at_xpath('/html/head') << comment
+          dest.at_xpath("/html/head") << comment
         end
       end
     end
@@ -13,5 +13,3 @@ module Slimmer::Processors
     end
   end
 end
-
-

data/lib/slimmer/processors/footer_remover.rb

@@ -1,6 +1,6 @@
 module Slimmer::Processors
   class FooterRemover
-    def filter(src,dest)
+    def filter(src, _dest)
       footer = src.at_css("#footer")
       footer.remove if footer
     end

data/lib/slimmer/processors/header_context_inserter.rb

@@ -1,11 +1,11 @@
 module Slimmer::Processors
   class HeaderContextInserter
-    def initialize(path='.header-context')
+    def initialize(path = ".header-context")
       @path = path
     end
 
-    def filter(src,dest)
-      if dest.at_css(@path) && replacement = src.at_css(@path)
+    def filter(src, dest)
+      if dest.at_css(@path) && (replacement = src.at_css(@path))
         header_context = src.fragment(replacement)
         dest.at_css(@path).replace(header_context)
       end

data/lib/slimmer/processors/inside_header_inserter.rb

@@ -1,10 +1,10 @@
 module Slimmer::Processors
   class InsideHeaderInserter
     def filter(src, dest)
-      insertion = src.at_css('.slimmer-inside-header')
+      insertion = src.at_css(".slimmer-inside-header")
 
       if insertion
-        logo = dest.at_css('.header-logo')
+        logo = dest.at_css(".header-logo")
         logo.add_next_sibling(insertion.inner_html) unless logo.nil?
       end
     end

data/lib/slimmer/processors/metadata_inserter.rb

@@ -5,23 +5,23 @@ module Slimmer::Processors
       @app_name = app_name
     end
 
-    def filter(src, dest)
-      head = dest.at_css('head')
+    def filter(_src, dest)
+      head = dest.at_css("head")
 
-      add_meta_tag('analytics:organisations', @headers[Slimmer::Headers::ORGANISATIONS_HEADER], head)
-      add_meta_tag('analytics:world-locations', @headers[Slimmer::Headers::WORLD_LOCATIONS_HEADER], head)
-      add_meta_tag('format', @headers[Slimmer::Headers::FORMAT_HEADER], head)
-      add_meta_tag('search-result-count', @headers[Slimmer::Headers::RESULT_COUNT_HEADER], head)
-      add_meta_tag('rendering-application', @app_name, head)
+      add_meta_tag("analytics:organisations", @headers[Slimmer::Headers::ORGANISATIONS_HEADER], head)
+      add_meta_tag("analytics:world-locations", @headers[Slimmer::Headers::WORLD_LOCATIONS_HEADER], head)
+      add_meta_tag("format", @headers[Slimmer::Headers::FORMAT_HEADER], head)
+      add_meta_tag("search-result-count", @headers[Slimmer::Headers::RESULT_COUNT_HEADER], head)
+      add_meta_tag("rendering-application", @app_name, head)
     end
 
   private
 
     def add_meta_tag(name, content, head)
       if content
-        meta_node = Nokogiri::XML::Node.new('meta', head)
-        meta_node['name'] = "govuk:#{name}"
-        meta_node['content'] = content
+        meta_node = Nokogiri::XML::Node.new("meta", head)
+        meta_node["name"] = "govuk:#{name}"
+        meta_node["content"] = content
 
         head.add_child(meta_node)
       end

data/lib/slimmer/processors/navigation_mover.rb

@@ -1,5 +1,4 @@
 class Slimmer::Processors::NavigationMover
-
   def initialize(skin)
     @skin = skin
   end
@@ -10,16 +9,16 @@ class Slimmer::Processors::NavigationMover
     if proposition_header && global_header
       proposition_header.remove
 
-      global_header['class'] = [global_header['class'], 'with-proposition'].compact.join(' ')
+      global_header["class"] = [global_header["class"], "with-proposition"].compact.join(" ")
 
       header_block = Nokogiri::HTML.fragment(proposition_header_block)
-      header_block.at_css('.content') << proposition_header
+      header_block.at_css(".content") << proposition_header
 
-      global_header.at_css('.header-wrapper') << header_block
+      global_header.at_css(".header-wrapper") << header_block
     end
   end
 
   def proposition_header_block
-    @proposition_header_block ||= @skin.template('proposition_menu')
+    @proposition_header_block ||= @skin.template("proposition_menu")
   end
 end

data/lib/slimmer/processors/search_parameter_inserter.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 module Slimmer::Processors
   class SearchParameterInserter
@@ -6,8 +6,8 @@ module Slimmer::Processors
       @response = response
     end
 
-    def filter(content_document, page_template)
-      search_form = page_template.at_css('form#search')
+    def filter(_content_document, page_template)
+      search_form = page_template.at_css("form#search")
       if search_parameters && search_form
         search_parameters.each_pair do |name, value|
           # Value can either be a string or an array of values
@@ -24,10 +24,10 @@ module Slimmer::Processors
     end
 
     def add_hidden_input(search_form, name, value)
-      element = Nokogiri::XML::Node.new('input', search_form)
-      element['type'] = 'hidden'
-      element['name'] = name
-      element['value'] = value.to_s
+      element = Nokogiri::XML::Node.new("input", search_form)
+      element["type"] = "hidden"
+      element["name"] = name
+      element["value"] = value.to_s
       search_form.add_child(element)
     end
 

data/lib/slimmer/processors/search_path_setter.rb

@@ -4,9 +4,9 @@ module Slimmer::Processors
       @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
+    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
 

data/lib/slimmer/processors/search_remover.rb

@@ -4,7 +4,7 @@ module Slimmer::Processors
       @headers = headers
     end
 
-    def filter(src,dest)
+    def filter(_src, dest)
       if @headers.include?(Slimmer::Headers::REMOVE_SEARCH_HEADER)
         search = dest.at_css("#global-header #search")
         search.remove if search

data/lib/slimmer/processors/tag_mover.rb

@@ -1,10 +1,10 @@
 module Slimmer::Processors
   class TagMover
     def filter(src, dest)
-      move_tags(src, dest, 'script', dest_node: 'body', keys: %w(src inner_html))
-      move_tags(src, dest, 'link',   must_have: ['href'])
-      move_tags(src, dest, 'meta',   must_have: %w(name content), keys: ['name', 'content', 'http-equiv'], insertion_location: :top)
-      move_tags(src, dest, 'meta',   must_have: %w(property content), keys: %w(property content), insertion_location: :top)
+      move_tags(src, dest, "script", dest_node: "body", keys: %w(src inner_html))
+      move_tags(src, dest, "link",   must_have: %w[href])
+      move_tags(src, dest, "meta",   must_have: %w(name content), keys: %w[name content http-equiv], insertion_location: :top)
+      move_tags(src, dest, "meta",   must_have: %w(property content), keys: %w(property content), insertion_location: :top)
     end
 
     def include_tag?(node, min_attrs)
@@ -12,17 +12,19 @@ module Slimmer::Processors
     end
 
     def tag_fingerprint(node, attrs)
-      attrs.collect do |attr_name|
-        if attr_name == 'inner_html'
+      collected_attrs = attrs.collect do |attr_name|
+        if attr_name == "inner_html"
           node.content
         else
           node.has_attribute?(attr_name) ? node.attr(attr_name) : nil
         end
-      end.compact.sort
+      end
+
+      collected_attrs.compact.sort
     end
 
     def wrap_node(src, node)
-      if node.previous_sibling.to_s =~ /<!--\[if[^\]]+\]><!-->/ && node.next_sibling.to_s == '<!--<![endif]-->'
+      if node.previous_sibling.to_s =~ /<!--\[if[^\]]+\]><!-->/ && node.next_sibling.to_s == "<!--<![endif]-->"
         node = Nokogiri::XML::NodeSet.new(src, [node.previous_sibling, node, node.next_sibling])
       end
       node
@@ -34,7 +36,7 @@ module Slimmer::Processors
       already_there = dest.css(type).map { |node|
         tag_fingerprint(node, comparison_attrs)
       }.compact
-      dest_node = opts[:dest_node] || 'head'
+      dest_node = opts[:dest_node] || "head"
 
       src.css(type).each do |node|
         if include_tag?(node, min_attrs) && !already_there.include?(tag_fingerprint(node, comparison_attrs))

data/lib/slimmer/processors/title_inserter.rb

@@ -1,18 +1,18 @@
 module Slimmer::Processors
   class TitleInserter
-    def filter(src,dest)
-      title = src.at_css('head title')
-      head  = dest.at_xpath('/html/head')
+    def filter(src, dest)
+      title = src.at_css("head title")
+      head  = dest.at_xpath("/html/head")
       if head && title
-        insert_title(title,head)
+        insert_title(title, head)
       end
     end
 
     def insert_title(title, head)
-      if head.at_css('title').nil?
+      if head.at_css("title").nil?
         head.first_element_child.nil? ? head << title : head.first_element_child.before(title)
       else
-        head.at_css('title').replace(title)
+        head.at_css("title").replace(title)
       end
     end
   end

data/lib/slimmer/railtie.rb

@@ -4,11 +4,20 @@ module Slimmer
 
     initializer "slimmer.configure" do |app|
       slimmer_config = app.config.slimmer.to_hash
-
-      app_name = ENV['GOVUK_APP_NAME'] || app.class.parent_name
+      app_name = ENV["GOVUK_APP_NAME"] || Slimmer::Railtie.parent_name(app)
       slimmer_config = slimmer_config.reverse_merge(app_name: app_name)
 
       app.middleware.use Slimmer::App, slimmer_config
     end
+
+    # TODO: remove this method when all our apps are in rails 6 and substitute
+    # it with: app_name = ENV['GOVUK_APP_NAME'] || app.class.module_parent_name
+    def self.parent_name(app)
+      if app.class.respond_to?(:module_parent_name)
+        app.class.module_parent_name
+      else
+        app.class.parent_name
+      end
+    end
   end
 end

data/lib/slimmer/rspec.rb

@@ -1,4 +1,4 @@
-require 'rspec/core'
+require "rspec/core"
 
-require 'slimmer'
-require 'slimmer/test'
+require "slimmer"
+require "slimmer/test"

data/lib/slimmer/skin.rb

@@ -1,5 +1,5 @@
-require 'rest_client'
-require 'slimmer/govuk_request_id'
+require "rest_client"
+require "slimmer/govuk_request_id"
 
 module Slimmer
   class Skin
@@ -10,7 +10,7 @@ module Slimmer
       @asset_host = options[:asset_host]
 
       @logger = options[:logger] || NullLogger.instance
-      @strict = options[:strict] || (%w{development test}.include?(ENV['RACK_ENV']))
+      @strict = options[:strict] || %w{development test}.include?(ENV["RACK_ENV"])
     end
 
     def template(template_name)
@@ -30,19 +30,19 @@ module Slimmer
 
     def template_url(template_name)
       host = asset_host.dup
-      host += '/' unless host =~ /\/$/
+      host += "/" unless host =~ /\/$/
       "#{host}templates/#{template_name}.html.erb"
     end
 
-    def report_parse_errors_if_strict!(nokogiri_doc, description_for_error_message)
+    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
-        errors = doc.errors.select {|e| e.error?}.reject {|e| ignorable?(e)}
-        if errors.size > 0
+        errors = doc.errors.select(&:error?).reject { |e| ignorable?(e) }
+        if !errors.empty?
           error = errors.first
           message = "In #{description_for_error_message}: '#{error.message}' at line #{error.line} col #{error.column} (code #{error.code}).\n"
           message << "Add ?skip_slimmer=1 to the url to show the raw backend request.\n\n"
@@ -59,7 +59,7 @@ module Slimmer
       lines = [""] + html.split("\n")
       from = [1, error.line - context_size].max
       to = [lines.size - 1, error.line + context_size].min
-      context = (from..to).zip(lines[from..to]).map {|lineno, line| "%4d: %s" % [lineno, line] }
+      context = (from..to).zip(lines[from..to]).map { |lineno, line| "%4d: %s" % [lineno, line] }
       marker = " " * (error.column - 1) + "-----v"
       context.insert(context_size, marker)
       context.join("\n")
@@ -70,7 +70,7 @@ module Slimmer
       ignorable_codes.include?(error.code) || error.message.match(/Element script embeds close tag/) || error.message.match(/Unexpected end tag : noscript/)
     end
 
-    def process(processors,body,template, rack_env)
+    def process(processors, body, template, _rack_env)
       logger.debug "Slimmer: starting skinning process"
       src = parse_html(body.to_s, "backend response")
       dest = parse_html(template, "template")
@@ -92,30 +92,30 @@ module Slimmer
     end
 
     def success(source_request, response, body)
-      wrapper_id = options[:wrapper_id] || 'wrapper'
+      wrapper_id = options[:wrapper_id] || "wrapper"
 
       processors = [
-        Processors::TitleInserter.new(),
-        Processors::TagMover.new(),
+        Processors::TitleInserter.new,
+        Processors::TagMover.new,
         Processors::NavigationMover.new(self),
-        Processors::ConditionalCommentMover.new(),
+        Processors::ConditionalCommentMover.new,
         Processors::BodyInserter.new(wrapper_id),
         Processors::BodyClassCopier.new,
         Processors::InsideHeaderInserter.new,
-        Processors::HeaderContextInserter.new(),
+        Processors::HeaderContextInserter.new,
         Processors::MetadataInserter.new(response, options[:app_name]),
         Processors::SearchParameterInserter.new(response),
         Processors::SearchPathSetter.new(response),
         Processors::SearchRemover.new(response.headers),
       ]
 
-      template_name = response.headers[Headers::TEMPLATE_HEADER] || 'core_layout'
+      template_name = response.headers[Headers::TEMPLATE_HEADER] || "core_layout"
       process(processors, body, template(template_name), source_request.env)
     end
 
     def error(template_name, body, rack_env)
       processors = [
-        Processors::TitleInserter.new()
+        Processors::TitleInserter.new,
       ]
       process(processors, body, template(template_name), rack_env)
     end

data/lib/slimmer/test.rb

@@ -1,4 +1,4 @@
-require 'slimmer/skin'
+require "slimmer/skin"
 
 module Slimmer
   class Skin
@@ -6,10 +6,10 @@ module Slimmer
       logger.debug "Slimmer: TEST MODE - Loading fixture template from #{__FILE__}"
       if name =~ /\A(.*)\.raw\z/
         %{<div id="test-#{$1}"></div>}
-      elsif File.exist?(template_path = File.join(File.dirname(__FILE__), 'test_templates', "#{name}.html"))
+      elsif File.exist?(template_path = File.join(File.dirname(__FILE__), "test_templates", "#{name}.html"))
         File.read(template_path)
       else
-        File.read(File.join(File.dirname(__FILE__), 'test_templates', "wrapper.html"))
+        File.read(File.join(File.dirname(__FILE__), "test_templates", "wrapper.html"))
       end
     end
   end

data/lib/slimmer/test_templates/header_footer_only.html

@@ -3,6 +3,8 @@
     <title>Test Template</title>
   </head>
   <body>
+    <script>document.body.className = ((document.body.className) ? document.body.className + ' js-enabled' : 'js-enabled');</script>
+
     <header id="global-header">
       <div class="header-wrapper"></div>
     </header>

data/lib/slimmer/test_templates/wrapper.html

@@ -3,6 +3,8 @@
     <title>Test Template</title>
   </head>
   <body>
+    <script>document.body.className = ((document.body.className) ? document.body.className + ' js-enabled' : 'js-enabled');</script>
+
     <header id="global-header">
       <div class="header-wrapper"></div>
     </header>

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '13.0.0'
+  VERSION = "13.3.0".freeze
 end

data/lib/tasks/slimmer.rake

@@ -1,4 +1,4 @@
-require 'rake'
+require "rake"
 
 namespace :slimmer do
   desc "Symlink from public directory to static directory"
@@ -6,7 +6,7 @@ namespace :slimmer do
     path_to_static = "../static/public"
     path_to_public = "public"
     commands = ["cd #{path_to_public}"]
-    dirs_to_link = Dir.glob("../static/public/*") {|f|
+    Dir.glob("../static/public/*") { |f|
       commands << "ln -s #{path_to_static}/#{f}"
     }
     commands << ["cd .."]

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 13.0.0
+  version: 13.3.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-01 00:00:00.000000000 Z
+date: 2020-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,21 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: plek
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '1.7'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: null_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,21 +67,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: null_logger
+  name: plek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,89 +109,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: '5.4'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 0.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 6.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: 6.0.2
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.9.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.9.2.2
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop-govuk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 2.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -207,19 +207,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.1
 - !ruby/object:Gem::Dependency
-  name: govuk-lint
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
 description: Rack middleware for skinning pages using a specific template
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -260,7 +274,6 @@ files:
 - lib/slimmer/test_templates/proposition_menu.html
 - lib/slimmer/test_templates/wrapper.html
 - lib/slimmer/version.rb
-- lib/tasks/lint.rake
 - lib/tasks/slimmer.rake
 homepage: http://github.com/alphagov/slimmer
 licenses:
@@ -281,8 +294,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: slimmer
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Thinner than the skinner

data/lib/tasks/lint.rake

@@ -1,4 +0,0 @@
-desc "Run govuk-lint with similar params to CI"
-task :lint do
-  sh "bundle exec govuk-lint-ruby --diff --cached --format clang bin lib test"
-end