slimmer 12.0.0 → 13.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 55f0a341bbb309da449a52a668b281087674586c
-  data.tar.gz: e090f9302dfd9dea5d91184a50942bfe9751bd02
+SHA256:
+  metadata.gz: ddad98c75bd0222c98ea9a7021096064cd2786c93f647c5390b39fcf489a3ab8
+  data.tar.gz: 63217d5ac791ffa9de31f0f20178d997cc0fad22ddea6e3728bcbb2405277ce6
 SHA512:
-  metadata.gz: 464f4d805159cd667d1cdc3478fba42e18741e4f7d3978c717b608098099fb3b87f56b83c9b31f61ee8bd2fa1acaf7778ab62be006d363365bd673162b2d18ad
-  data.tar.gz: 7aa2bb20cb3c5a3151949436d6e2d36cae311ee31552ef17cb7e254f2a2569c93205dec13b0e5baf6e155c862714af4a1ec6379165cd23275929ffcec2bec1b7
+  metadata.gz: 9048af33f02df5b5e6e9e36382cf38c1028bbeb6eafe2019bc2035e0c4f5b71027c3ce79266e1f7fd013578e4024b0aa1d7735fae2a0bb6c9abd0a81ad4dbd92
+  data.tar.gz: 3af49e52feefa8c44480ff144512a1347157ccae6aafb5596a03b1d3382a53e13b53e0a82f1f8041d5a0b71effe6410727dfd2a21b27ec84586822b4ea64afa9

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+# 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.
+* 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

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

@@ -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,13 +1,13 @@
-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 = 900
+  CACHE_TTL = 60
 
   def self.cache
     @cache ||= defined?(Rails) ? Rails.cache : NoCache.new
@@ -19,36 +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 :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'
+  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,12 +52,12 @@ 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)
@@ -69,8 +66,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
 
@@ -84,30 +82,30 @@ 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"]
 
       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
-      response.headers['Content-Length'] = content_length(response.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,10 +1,3 @@
-require 'cucumber'
+require "cucumber"
 
-require 'slimmer/test'
-require 'slimmer/test_helpers/govuk_components'
-
-World(Slimmer::TestHelpers::GovukComponents)
-
-Before do
-  stub_shared_component_locales
-end
+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,40 +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
-    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
 
     # Set the "slimmer headers" to configure the page
     #
@@ -71,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