slimmer 11.1.1 → 13.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 882c71d5e22c37f0dfe1f0598975f4c19e27ceb9
-  data.tar.gz: 6c115e9e40c73fa7216316ffe727663eb26f2b8c
+SHA256:
+  metadata.gz: 966481420a36ac4cbaf811706d2ae142b9ce1556c6b8be10ca682766cbe8e2e6
+  data.tar.gz: 79cb54e5f8d0db751cbc40ff3acd6c573395fec2e13e4bb9e43021b93c69a3a4
 SHA512:
-  metadata.gz: 25ec33d5397c26d2392389bf173619c617ad41c8c54f64d7028c575b217f58f9c4104659c4eee671630412c2d367303c442f502d22bd204eed68cb1bbb4d380e
-  data.tar.gz: aa90a515cae94a8d23d530cf4543be9dba85955ca0421bd59848805803dd7d40d20b9362e2bcb1b009e985ccd898d6bb74b6a6e2b0aa2e07ddcf1e7d98415094
+  metadata.gz: cd9b2d065c5cc805cc92f84728fb4990352030ac25ad5f8ad024b5794e90bc52b82c04f08eb1a7adfbd45abef17849e2ae977d95f579f3d184d290af5a9a4d3b
+  data.tar.gz: d846dd0e2ce3edcb9503708e0c162e5899530e988abf6513a785bef995cc2193df948718892e3200d4408e3ee79b34aead7a9ccec4af042b6214a98f480444b7

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+# 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.
+* BREAKING: Remove the component system, components are now consumed via the [govuk_publishing_components gem](https://github.com/alphagov/govuk_publishing_components)
+
+# 12.1.0
+
+* Make sure that the metatags defined in the application are inserted at the
+  top of the page. This means that third parties will see the custom metatags
+  like `og:image` first, and template tags like the default sharing image second (#218)
+
+# 12.0.0
+
+* Remove the "report a problem" feature. This is now being covered by the
+  feedback component (#213)
+
 # 11.1.1
 
 * Make the 'Inside Header Inserter' more resillient so that it doesn't throw

data/README.md

@@ -15,8 +15,7 @@ Slimmer provides a Railtie so no configuration is necessary.
 
 ## Caching
 
-Slimmer makes HTTP requests to `static` for templates, components and locales. These
-are cached for 15 minutes. Slimmer uses `Rails.cache` for this.
+Slimmer makes HTTP requests to `static` for templates. These are cached using `Rails.cache`.
 
 ## Asset tag helpers
 
@@ -82,54 +81,6 @@ YourApp::Application.configure do
 end
 ```
 
-## GOV.UK Components
-
-To use [shared template components](https://govuk-static.herokuapp.com/component-guide) you need to include the GOV.UK component module:
-
-```rb
-class ApplicationController < ActionController::Base
-  include Slimmer::GovukComponents
-end
-```
-
-This will make calls out to static when you try and render a partial prefixed with `govuk_component`:
-
-```erb
-<%= render partial: 'govuk_component/example_component' %>
-```
-
-You will need a copy of static running for the templates to be loaded from.
-
-### Testing components
-
-In test mode (when `Rails.env.test?` returns `true`), shared components are not
-fetched from Static. Instead they are rendered as a dummy tag which contains a
-JSON dump of the `locals` - the arguments passed to the component.
-
-A test helper is included which returns a CSS selector for finding a given
-component to assert that it was used. You can make it available in your tests
-with:
-
-```rb
-require 'slimmer/test_helpers/govuk_components'
-include Slimmer::TestHelpers::GovukComponents
-```
-
-And then assert that the component has been used:
-
-```rb
-page.should have_css(shared_component_selector('metadata'))
-```
-
-Or look for one of the arguments to the component which will have been
-`JSON.dump`ed inside the tag:
-
-```rb
-within(shared_component_selector('title')) do
-  expect(page).to have_content(expected_title_text)
-end
-```
-
 ### Cucumber
 
 Add the following code to features/support:

data/Rakefile

@@ -12,7 +12,7 @@ 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

data/lib/slimmer.rb

@@ -7,7 +7,7 @@ require 'slimmer/version'
 require 'slimmer/railtie' if defined? Rails
 
 module Slimmer
-  CACHE_TTL = 900
+  CACHE_TTL = 60
 
   def self.cache
     @cache ||= defined?(Rails) ? Rails.cache : NoCache.new
@@ -27,13 +27,6 @@ module Slimmer
   autoload :Headers, 'slimmer/headers'
   autoload :HTTPClient, 'slimmer/http_client'
 
-  autoload :GovukComponents, 'slimmer/govuk_components'
-  autoload :LocalGovukComponents, 'slimmer/local_govuk_components'
-  autoload :ComponentResolver, 'slimmer/component_resolver'
-  autoload :NetworkComponentResolver, 'slimmer/network_component_resolver'
-  autoload :LocalComponentResolver, 'slimmer/local_component_resolver'
-  autoload :I18nBackend, 'slimmer/i18n_backend'
-
   module Processors
     autoload :BodyClassCopier, 'slimmer/processors/body_class_copier'
     autoload :BodyInserter, 'slimmer/processors/body_inserter'
@@ -43,7 +36,6 @@ module Slimmer
     autoload :HeaderContextInserter, 'slimmer/processors/header_context_inserter'
     autoload :InsideHeaderInserter, 'slimmer/processors/inside_header_inserter'
     autoload :NavigationMover, 'slimmer/processors/navigation_mover'
-    autoload :ReportAProblemInserter, 'slimmer/processors/report_a_problem_inserter'
     autoload :SearchIndexSetter, 'slimmer/processors/search_index_setter'
     autoload :SearchPathSetter, 'slimmer/processors/search_path_setter'
     autoload :SearchParameterInserter, 'slimmer/processors/search_parameter_inserter'

data/lib/slimmer/app.rb

@@ -4,20 +4,21 @@ 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
+        if logger.level.zero? # Log set to debug level
           unless options[:enable_debugging]
             self.logger = logger.dup
             self.logger.level = 1 # info
           end
         end
-      rescue NoMethodError # In case logger doesn't respond_to? :level
+      rescue NoMethodError # rubocop:disable Lint/HandleExceptions
+        # In case logger doesn't respond_to? :level
       end
 
       if options.key? :template_path
@@ -60,7 +61,7 @@ module Slimmer
 
     def skip_slimmer_param?(env)
       skip = Rack::Request.new(env).params['skip_slimmer']
-      skip and skip.to_i > 0
+      skip && skip.to_i.positive?
     end
 
     def skip_slimmer_header?(response)
@@ -69,8 +70,9 @@ module Slimmer
 
     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
 
@@ -87,17 +89,17 @@ module Slimmer
       GovukRequestId.value = env['HTTP_GOVUK_REQUEST_ID']
 
       rewritten_body = case response.status
-      when 200
-        @skin.success request, response, s(response.body)
-      when 403
-        @skin.error '403', s(response.body), request.env
-      when 404
-        @skin.error '404', s(response.body), request.env
-      when 410
-        @skin.error '410', s(response.body), request.env
-      else
-        @skin.error '500', s(response.body), request.env
-      end
+                       when 200
+                         @skin.success request, response, s(response.body)
+                       when 403
+                         @skin.error '403', s(response.body), request.env
+                       when 404
+                         @skin.error '404', s(response.body), request.env
+                       when 410
+                         @skin.error '410', s(response.body), request.env
+                       else
+                         @skin.error '500', s(response.body), request.env
+                       end
 
       rewritten_body = [rewritten_body] unless rewritten_body.respond_to?(:each)
       response.body = rewritten_body
@@ -107,7 +109,7 @@ module Slimmer
     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,10 +1,3 @@
 require 'cucumber'
 
 require 'slimmer/test'
-require 'slimmer/test_helpers/govuk_components'
-
-World(Slimmer::TestHelpers::GovukComponents)
-
-Before do
-  stub_shared_component_locales
-end

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 = {
@@ -13,7 +13,6 @@ module Slimmer
       format:               "Format",
       page_owner:           "Page-Owner",
       organisations:        "Organisations",
-      report_a_problem:     "Report-a-Problem",
       world_locations:      "World-Locations",
       result_count:         "Result-Count",
       search_parameters:    "Search-Parameters",
@@ -21,43 +20,40 @@ module Slimmer
       skip:                 "Skip",
       template:             "Template",
       remove_search:        "Remove-Search",
-    }
+    }.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
-    REPORT_A_PROBLEM_FORM = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:report_a_problem]}"
+    WORLD_LOCATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:world_locations]}".freeze
 
     # @private
-    WORLD_LOCATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:world_locations]}"
+    PAGE_OWNER_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:page_owner]}".freeze
 
     # @private
-    PAGE_OWNER_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:page_owner]}"
+    RESULT_COUNT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:result_count]}".freeze
 
     # @private
-    RESULT_COUNT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:result_count]}"
+    SEARCH_PATH_HEADER = "#{HEADER_PREFIX}-Search-Path".freeze
 
     # @private
-    SEARCH_PATH_HEADER = "#{HEADER_PREFIX}-Search-Path"
+    SEARCH_PARAMETERS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:search_parameters]}".freeze
 
     # @private
-    SEARCH_PARAMETERS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:search_parameters]}"
+    SKIP_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:skip]}".freeze
 
     # @private
-    SKIP_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:skip]}"
+    TEMPLATE_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:template]}".freeze
 
     # @private
-    TEMPLATE_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:template]}"
-
-    # @private
-    REMOVE_SEARCH_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:remove_search]}"
+    REMOVE_SEARCH_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:remove_search]}".freeze
 
     # Set the "slimmer headers" to configure the page
     #
@@ -67,7 +63,6 @@ module Slimmer
     # @option hash [String] organisations
     # @option hash [String] page_owner
     # @option hash [String] remove_search
-    # @option hash [String] report_a_problem
     # @option hash [String] result_count
     # @option hash [String] search_parameters
     # @option hash [String] section
@@ -76,6 +71,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_inserter.rb

@@ -1,11 +1,11 @@
 module Slimmer::Processors
   class BodyInserter
-    def initialize(source_id='wrapper', destination_id='wrapper')
+    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

@@ -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/metadata_inserter.rb

@@ -5,7 +5,7 @@ module Slimmer::Processors
       @app_name = app_name
     end
 
-    def filter(src, dest)
+    def filter(_src, dest)
       head = dest.at_css('head')
 
       add_meta_tag('analytics:organisations', @headers[Slimmer::Headers::ORGANISATIONS_HEADER], head)

data/lib/slimmer/processors/navigation_mover.rb

@@ -1,5 +1,4 @@
 class Slimmer::Processors::NavigationMover
-
   def initialize(skin)
     @skin = skin
   end

data/lib/slimmer/processors/search_parameter_inserter.rb

@@ -6,7 +6,7 @@ module Slimmer::Processors
       @response = response
     end
 
-    def filter(content_document, page_template)
+    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|

data/lib/slimmer/processors/search_path_setter.rb

@@ -4,7 +4,7 @@ module Slimmer::Processors
       @response = response
     end
 
-    def filter(content_document, page_template)
+    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

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 => ['src', 'inner_html'])
-      move_tags(src, dest, 'link',   :must_have => ['href'])
-      move_tags(src, dest, 'meta',   :must_have => ['name', 'content'], :keys => ['name', 'content', 'http-equiv'])
-      move_tags(src, dest, 'meta',   :must_have => ['property', 'content'], :keys => ['property', 'content'])
+    def filter(src, dest)
+      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|
+      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[^\]]+\]><!-->/ and 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
@@ -40,7 +42,12 @@ module Slimmer::Processors
         if include_tag?(node, min_attrs) && !already_there.include?(tag_fingerprint(node, comparison_attrs))
           node = wrap_node(src, node)
           node.remove
-          dest.at_xpath("/html/#{dest_node}") << node
+
+          if opts[:insertion_location] == :top
+            dest.at_xpath("/html/#{dest_node}").prepend_child(node)
+          else
+            dest.at_xpath("/html/#{dest_node}") << node
+          end
         end
       end
     end

data/lib/slimmer/processors/title_inserter.rb

@@ -1,10 +1,10 @@
 module Slimmer::Processors
   class TitleInserter
-    def filter(src,dest)
+    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
 

data/lib/slimmer/rspec.rb

@@ -2,10 +2,3 @@ require 'rspec/core'
 
 require 'slimmer'
 require 'slimmer/test'
-require 'slimmer/test_helpers/govuk_components'
-
-RSpec.configure do |config|
-  config.include Slimmer::TestHelpers::GovukComponents
-
-  config.before { stub_shared_component_locales }
-end

data/lib/slimmer/skin.rb

@@ -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)
@@ -34,15 +34,15 @@ module Slimmer
       "#{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] } # rubocop:disable Style/FormatStringToken
       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")
@@ -94,27 +94,18 @@ module Slimmer
     def success(source_request, response, body)
       wrapper_id = options[:wrapper_id] || 'wrapper'
 
-      # The variables set in the source request might not be encoded as UTF-8,
-      # Unicorn, for instance, will set them to be ASCII. This shouldn't matter
-      # normally because URI's should have UTF-8 characters percent encoded,
-      # but not all agents follow this.
-      request_url = source_request.url.force_encoding(Encoding::UTF_8)
       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::ReportAProblemInserter.new(self,
-                                               request_url,
-                                               response.headers,
-                                               wrapper_id),
         Processors::SearchRemover.new(response.headers),
       ]
 
@@ -124,7 +115,7 @@ module Slimmer
 
     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_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 = '11.1.1'
+  VERSION = '13.2.0'.freeze
 end

data/lib/tasks/slimmer.rake

@@ -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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 11.1.1
+  version: 13.2.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-19 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 3.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 3.11.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 3.11.5
 description: Rack middleware for skinning pages using a specific template
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -234,16 +234,10 @@ files:
 - bin/render_slimmer_error
 - lib/slimmer.rb
 - lib/slimmer/app.rb
-- lib/slimmer/component_resolver.rb
 - lib/slimmer/cucumber.rb
-- lib/slimmer/govuk_components.rb
 - lib/slimmer/govuk_request_id.rb
 - lib/slimmer/headers.rb
 - lib/slimmer/http_client.rb
-- lib/slimmer/i18n_backend.rb
-- lib/slimmer/local_component_resolver.rb
-- lib/slimmer/local_govuk_components.rb
-- lib/slimmer/network_component_resolver.rb
 - lib/slimmer/processors/body_class_copier.rb
 - lib/slimmer/processors/body_inserter.rb
 - lib/slimmer/processors/conditional_comment_mover.rb
@@ -252,7 +246,6 @@ files:
 - lib/slimmer/processors/inside_header_inserter.rb
 - lib/slimmer/processors/metadata_inserter.rb
 - lib/slimmer/processors/navigation_mover.rb
-- lib/slimmer/processors/report_a_problem_inserter.rb
 - lib/slimmer/processors/search_parameter_inserter.rb
 - lib/slimmer/processors/search_path_setter.rb
 - lib/slimmer/processors/search_remover.rb
@@ -263,7 +256,6 @@ files:
 - lib/slimmer/skin.rb
 - lib/slimmer/template.rb
 - lib/slimmer/test.rb
-- lib/slimmer/test_helpers/govuk_components.rb
 - lib/slimmer/test_templates/header_footer_only.html
 - lib/slimmer/test_templates/proposition_menu.html
 - lib/slimmer/test_templates/wrapper.html
@@ -289,8 +281,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/slimmer/component_resolver.rb

@@ -1,26 +0,0 @@
-module Slimmer
-  class ComponentResolver < ::ActionView::Resolver
-    TEST_TAG_NAME = 'test-govuk-component'
-
-    def find_templates(name, prefix, partial, details, outside_app_allowed = false)
-      return [] unless prefix == 'govuk_component'
-      template_path = [prefix, name].join('/')
-      details = {
-        :format => 'text/html',
-        :updated_at => Time.now,
-        :virtual_path => template_path
-      }
-
-      [ActionView::Template.new(template_body(template_path), template_path, erb_handler, details)]
-    end
-
-  private
-    def erb_handler
-      @erb_handler ||= ActionView::Template.registered_template_handler(:erb)
-    end
-
-    def template_body(_template_path)
-      raise NotImplementedError, "Use NetworkComponentResolver or LocalComponentResolver"
-    end
-  end
-end

data/lib/slimmer/govuk_components.rb

@@ -1,57 +0,0 @@
-module Slimmer
-  # @api public
-  #
-  # Include this module to add the GOV.UK Components to your app.
-  # @example
-  #   class ApplicationController < ActionController::Base
-  #     include Slimmer::GovukComponents
-  #   end
-  #
-  #   # In your views:
-  #
-  #   <%= render partial: 'govuk_component/example_component' %>
-  module GovukComponents
-    def self.included into
-      into.before_action :add_govuk_components
-    end
-
-    # @private
-    def add_govuk_components
-      append_view_path GovukComponents.expiring_resolver_cache.resolver
-
-      return if slimmer_backend_included?
-      I18n.backend = I18n::Backend::Chain.new(I18n.backend, Slimmer::I18nBackend.new)
-    end
-
-    # @private
-    def self.expiring_resolver_cache
-      @expiring_resolver_cache ||= TimedExpirationResolverCache.new
-    end
-
-  private
-
-    def slimmer_backend_included?
-      I18n.backend.is_a?(I18n::Backend::Chain) &&
-        I18n.backend.backends.any? { |b| b.is_a? Slimmer::I18nBackend }
-    end
-
-    # Slimmer::ComponentResolver instantiates a lot of large objects and leaks
-    # memory. This class will cache the resolver so that it doesn't have to
-    # create new ActionView::Template objects for each request. The cache is
-    # timed to allow frontends to pick up changes made to components in `static`.
-    class TimedExpirationResolverCache
-      def initialize
-        @cache_last_reset = Time.now
-      end
-
-      def resolver
-        if (@cache_last_reset + Slimmer::CACHE_TTL) < Time.now
-          @resolver = nil
-          @cache_last_reset = Time.now
-        end
-
-        @resolver ||= Slimmer::NetworkComponentResolver.new
-      end
-    end
-  end
-end

data/lib/slimmer/i18n_backend.rb

@@ -1,56 +0,0 @@
-require 'json'
-require 'i18n'
-
-module Slimmer
-  class I18nBackend
-    include I18n::Backend::Base, I18n::Backend::Flatten
-
-    def available_locales
-      Slimmer.cache.fetch("available_locales", expires_in: Slimmer::CACHE_TTL) do
-        locale_json = fetch(static_locales_url)
-        JSON.parse(locale_json).map(&:to_sym)
-      end
-    end
-
-    def lookup(locale, key, scope = [], options = {})
-      key = normalize_flat_keys(locale, key, scope, options[:separator])
-      translations = translations(locale)
-      translations["#{locale}.#{key}".to_sym]
-    end
-
-  private
-
-    def translations(locale)
-      Slimmer.cache.fetch("translations/#{locale}", expires_in: Slimmer::CACHE_TTL) do
-        fetch_translations(locale)
-      end
-    end
-
-    def static_locales_url(locale=nil)
-      [static_host, "templates", "locales", locale].compact.join('/')
-    end
-
-    def static_host
-      @static_host ||= Plek.new.find('static')
-    end
-
-    def fetch_translations(locale)
-      url = static_locales_url(locale)
-      json_data = fetch(url)
-      translations = JSON.parse(json_data)
-      flatten_translations(locale, translations, false, false)
-    rescue TemplateNotFoundException
-      {}
-    end
-
-    def fetch(url)
-      HTTPClient.get(url)
-    rescue RestClient::Exception => e
-      raise TemplateNotFoundException, "Unable to fetch: '#{url}' because #{e}", caller
-    rescue Errno::ECONNREFUSED => e
-      raise CouldNotRetrieveTemplate, "Unable to fetch: '#{url}' because #{e}", caller
-    rescue SocketError => e
-      raise CouldNotRetrieveTemplate, "Unable to fetch: '#{url}' because #{e}", caller
-    end
-  end
-end

data/lib/slimmer/local_component_resolver.rb

@@ -1,19 +0,0 @@
-module Slimmer
-  class LocalComponentResolver < ComponentResolver
-  private
-
-    def template_body(template_path)
-      File.read(template_file(template_path))
-    end
-
-    def template_file(template_path)
-      path = template_path.sub(/\.raw(\.html\.erb)?$/, '')
-
-      if defined?(Rails)
-        Rails.root.join("app", "views", "#{path}.raw.html.erb")
-      else
-        "#{path}.raw.html.erb"
-      end
-    end
-  end
-end

data/lib/slimmer/local_govuk_components.rb

@@ -1,49 +0,0 @@
-module Slimmer
-  # @api public
-  #
-  # Include this module to avoid loading components over the network
-  # @example
-  #   class ApplicationController < ActionController::Base
-  #     include Slimmer::LocalGovukComponents
-  #   end
-  #
-  #   # In your views:
-  #
-  #   <%= render partial: 'govuk_component/example_component' %>
-  module LocalGovukComponents
-    def self.included into
-      into.before_action :add_govuk_components
-    end
-
-    # @private
-    def add_govuk_components
-      append_view_path LocalGovukComponents.expiring_resolver_cache.resolver
-    end
-
-    # @private
-    def self.expiring_resolver_cache
-      @expiring_resolver_cache ||= TimedExpirationResolverCache.new
-    end
-
-  private
-
-    # Slimmer::ComponentResolver instantiates a lot of large objects and leaks
-    # memory. This class will cache the resolver so that it doesn't have to
-    # create new ActionView::Template objects for each request. The cache is
-    # timed to allow frontends to pick up changes made to components in `static`.
-    class TimedExpirationResolverCache
-      def initialize
-        @cache_last_reset = Time.now
-      end
-
-      def resolver
-        if (@cache_last_reset + Slimmer::CACHE_TTL) < Time.now
-          @resolver = nil
-          @cache_last_reset = Time.now
-        end
-
-        @resolver ||= Slimmer::LocalComponentResolver.new
-      end
-    end
-  end
-end

data/lib/slimmer/network_component_resolver.rb

@@ -1,45 +0,0 @@
-require 'slimmer/govuk_request_id'
-require 'active_support/core_ext/string/inflections'
-
-module Slimmer
-  class NetworkComponentResolver < ComponentResolver
-  private
-
-    def template_body(template_path)
-      if test?
-        test_body(template_path)
-      else
-        Slimmer.cache.fetch(template_path, expires_in: Slimmer::CACHE_TTL) do
-          fetch(template_url(template_path))
-        end
-      end
-    end
-
-    def test?
-      defined?(Rails) && Rails.env.test?
-    end
-
-    def fetch(template_url)
-      HTTPClient.get(template_url)
-    rescue RestClient::Exception => e
-      raise TemplateNotFoundException, "Unable to fetch: '#{template_url}' because #{e}", caller
-    rescue Errno::ECONNREFUSED => e
-      raise CouldNotRetrieveTemplate, "Unable to fetch: '#{template_url}' because #{e}", caller
-    rescue SocketError => e
-      raise CouldNotRetrieveTemplate, "Unable to fetch: '#{template_url}' because #{e}", caller
-    end
-
-    def template_url(template_path)
-      path = template_path.sub(/\.raw(\.html\.erb)?$/, '')
-      [static_host, "templates", "#{path}.raw.html.erb"].join('/')
-    end
-
-    def static_host
-      @static_host ||= Plek.new.find('static')
-    end
-
-    def test_body(path)
-      %{<#{TEST_TAG_NAME} data-template="#{path.parameterize}"><%= JSON.dump(local_assigns) %></#{TEST_TAG_NAME}>}
-    end
-  end
-end

data/lib/slimmer/processors/report_a_problem_inserter.rb

@@ -1,32 +0,0 @@
-module Slimmer::Processors
-  class ReportAProblemInserter
-    include ERB::Util
-
-    def initialize(skin, url, headers, wrapper_id)
-      @skin = skin
-      @request_url = url
-      @headers = headers
-      @wrapper_id = wrapper_id
-    end
-
-    def filter(content_document, page_template)
-      if enabled? && container = page_template.at_css('#' + @wrapper_id)
-        container.add_child(report_a_problem_block)
-      end
-    end
-
-    def report_a_problem_block
-      request_url = @request_url
-      source      = @headers[Slimmer::Headers::APPLICATION_NAME_HEADER]
-      page_owner  = @headers[Slimmer::Headers::PAGE_OWNER_HEADER]
-      report_a_problem_template = @skin.template('report_a_problem.raw')
-      html = ERB.new(report_a_problem_template).result(binding)
-      Nokogiri::HTML.fragment(html)
-    end
-
-  private
-    def enabled?
-      @headers[Slimmer::Headers::REPORT_A_PROBLEM_FORM] != 'false'
-    end
-  end
-end

data/lib/slimmer/test_helpers/govuk_components.rb

@@ -1,18 +0,0 @@
-require 'webmock'
-
-module Slimmer
-  module TestHelpers
-    module GovukComponents
-      def stub_shared_component_locales
-        stub_request(:get, /https?:\/\/\S+.gov.uk\/templates\/locales\/.+/).
-          to_return(status: 400, headers: {})
-        stub_request(:get, /https?:\/\/\S+.gov.uk\/templates\/locales/).
-          to_return(status: 200, body: '{}', headers: {})
-      end
-
-      def shared_component_selector(name)
-        "#{Slimmer::ComponentResolver::TEST_TAG_NAME}[data-template='govuk_component-#{name}']"
-      end
-    end
-  end
-end