slimmer 13.2.1 → 15.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddad98c75bd0222c98ea9a7021096064cd2786c93f647c5390b39fcf489a3ab8
-  data.tar.gz: 63217d5ac791ffa9de31f0f20178d997cc0fad22ddea6e3728bcbb2405277ce6
+  metadata.gz: 69efc7036b8f43e79f0a658b8cb7a4d1b8a3a6d6e7083adc4f0d7c5f94660de4
+  data.tar.gz: 1ea0fc004cc8eaf7b51db1071aa6d681bd178aa4f28e311a5c8c896330a2a0d0
 SHA512:
-  metadata.gz: 9048af33f02df5b5e6e9e36382cf38c1028bbeb6eafe2019bc2035e0c4f5b71027c3ce79266e1f7fd013578e4024b0aa1d7735fae2a0bb6c9abd0a81ad4dbd92
-  data.tar.gz: 3af49e52feefa8c44480ff144512a1347157ccae6aafb5596a03b1d3382a53e13b53e0a82f1f8041d5a0b71effe6410727dfd2a21b27ec84586822b4ea64afa9
+  metadata.gz: 526e412c02dec4300125ef6047212538dea07fecf9842b0cfb2716e7f962c582b76ff921107ca3b039c053718a310adc29fe6d7035fb3544c5b0f66b73b83b4e
+  data.tar.gz: d414a38146b156fc6ba454798fe79741bff8b3f3015d42dad4b991e8f5f48e1bf9f0c46b2de7cb079c78b9beb62eeb9925c23ed5514c5a67d80b5e249b31fa83

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# 15.0.0
+
+* BREAKING: Test templates no longer embed links to production JavaScript files,
+  apps should provide their own dependencies.
+
+# 14.0.0
+
+* Remove handling of non-200 responses (#245)
+
+# 13.4.0
+
+* Revert X-Slimmer-Ignore-Error header (#246)
+
+# 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

data/README.md

@@ -96,3 +96,7 @@ Add the following code to spec/spec_helper:
 ```rb
 require 'slimmer/rspec'
 ```
+
+## Licence
+
+[MIT License](LICENCE)

data/Rakefile

@@ -1,8 +1,9 @@
-# -*- encoding: utf-8 -*-
-
 require "bundler/gem_tasks"
 require "rdoc/task"
 require "rake/testtask"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
 
 Dir.glob("lib/tasks/*.rake").each { |r| import r }
 
@@ -18,4 +19,4 @@ Rake::TestTask.new("test") do |t|
   t.verbose = true
 end
 
-task default: %i[test]
+task default: %i[test rubocop]

data/lib/slimmer/app.rb

@@ -35,7 +35,7 @@ module Slimmer
       if response_can_be_rewritten?(status, headers)
         response = Rack::Response.new(body, status, headers)
 
-        if !skip_slimmer?(env, response)
+        unless skip_slimmer?(env, response)
           status, headers, body = rewrite_response(env, response)
         end
       end
@@ -61,7 +61,7 @@ module Slimmer
     end
 
     def skip_slimmer_header?(response)
-      !!response.headers[Headers::SKIP_HEADER]
+      response.headers.key?(Headers::SKIP_HEADER)
     end
 
     def s(body)
@@ -80,24 +80,14 @@ module Slimmer
 
     def rewrite_response(env, response)
       request = Rack::Request.new(env)
+      return response.finish unless response.status == 200
 
       # Store the request id so it can be passed on with any template requests
       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
-
+      rewritten_body = @skin.success request, response, s(response.body)
       rewritten_body = [rewritten_body] unless rewritten_body.respond_to?(:each)
+
       response.body = rewritten_body
       response.headers["Content-Length"] = content_length(response.body)
 

data/lib/slimmer/headers.rb

@@ -9,17 +9,17 @@ module Slimmer
 
     # @private
     SLIMMER_HEADER_MAPPING = {
-      application_name:     "Application-Name",
-      format:               "Format",
-      page_owner:           "Page-Owner",
-      organisations:        "Organisations",
-      world_locations:      "World-Locations",
-      result_count:         "Result-Count",
-      search_parameters:    "Search-Parameters",
-      section:              "Section",
-      skip:                 "Skip",
-      template:             "Template",
-      remove_search:        "Remove-Search",
+      application_name: "Application-Name",
+      format: "Format",
+      page_owner: "Page-Owner",
+      organisations: "Organisations",
+      world_locations: "World-Locations",
+      result_count: "Result-Count",
+      search_parameters: "Search-Parameters",
+      section: "Section",
+      skip: "Skip",
+      template: "Template",
+      remove_search: "Remove-Search",
     }.freeze
 
     # @private

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, "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)
+      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)
@@ -39,15 +39,15 @@ module Slimmer::Processors
       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))
-          node = wrap_node(src, node)
-          node.remove
-
-          if opts[:insertion_location] == :top
-            dest.at_xpath("/html/#{dest_node}").prepend_child(node)
-          else
-            dest.at_xpath("/html/#{dest_node}") << node
-          end
+        next unless include_tag?(node, min_attrs) && !already_there.include?(tag_fingerprint(node, comparison_attrs))
+
+        node = wrap_node(src, node)
+        node.remove
+
+        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

data/lib/slimmer/railtie.rb

@@ -4,18 +4,15 @@ module Slimmer
 
     initializer "slimmer.configure" do |app|
       slimmer_config = app.config.slimmer.to_hash
-
-      app_name = ENV["GOVUK_APP_NAME"] || module_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
 
-  private
-
     # 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 module_parent_name
+    def self.parent_name(app)
       if app.class.respond_to?(:module_parent_name)
         app.class.module_parent_name
       else

data/lib/slimmer/skin.rb

@@ -5,12 +5,12 @@ module Slimmer
   class Skin
     attr_accessor :asset_host, :logger, :strict, :options
 
-    def initialize options = {}
+    def initialize(options = {})
       @options = options
       @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)
@@ -42,7 +42,7 @@ module Slimmer
       doc = Nokogiri::HTML.parse(html)
       if strict
         errors = doc.errors.select(&:error?).reject { |e| ignorable?(e) }
-        if !errors.empty?
+        unless 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| sprintf("%4d: %s", lineno, line) }
       marker = " " * (error.column - 1) + "-----v"
       context.insert(context_size, marker)
       context.join("\n")
@@ -112,12 +112,5 @@ module Slimmer
       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,
-      ]
-      process(processors, body, template(template_name), rack_env)
-    end
   end
 end

data/lib/slimmer/template.rb

@@ -1,16 +1,15 @@
 module Slimmer
   module Template
-    def self.included into
+    def self.included(into)
       into.extend ClassMethods
     end
 
-    def slimmer_template template_name
+    def slimmer_template(template_name)
       response.headers[Slimmer::Headers::TEMPLATE_HEADER] = template_name.to_s
     end
 
-
     module ClassMethods
-      def slimmer_template template_name
+      def slimmer_template(template_name)
         after_action do
           response.headers[Slimmer::Headers::TEMPLATE_HEADER] ||= template_name.to_s
         end

data/lib/slimmer/test.rb

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

data/lib/slimmer/test_templates/header_footer_only.html

@@ -19,9 +19,5 @@
     <div id="wrapper"></div>
 
     <footer id="footer"></footer>
-
-    <script src="https://assets.publishing.service.gov.uk/static/govuk-template.js" type="text/javascript"></script>
-    <script src="https://assets.publishing.service.gov.uk/static/libs/jquery/jquery-1.7.2.js" type="text/javascript"></script>
-    <script src="https://assets.publishing.service.gov.uk/static/header-footer-only.js" type="text/javascript"></script>
   </body>
 </html>

data/lib/slimmer/test_templates/wrapper.html

@@ -19,9 +19,5 @@
     <div id="wrapper"></div>
 
     <footer id="footer"></footer>
-
-    <script src="https://assets.publishing.service.gov.uk/static/govuk-template.js" type="text/javascript"></script>
-    <script src="https://assets.publishing.service.gov.uk/static/libs/jquery/jquery-1.7.2.js" type="text/javascript"></script>
-    <script src="https://assets.publishing.service.gov.uk/static/application.js" type="text/javascript"></script>
   </body>
 </html>

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = "13.2.1".freeze
+  VERSION = "15.0.0".freeze
 end

data/lib/tasks/slimmer.rake

@@ -6,9 +6,9 @@ namespace :slimmer do
     path_to_static = "../static/public"
     path_to_public = "public"
     commands = ["cd #{path_to_public}"]
-    Dir.glob("../static/public/*") { |f|
+    Dir.glob("../static/public/*") do |f|
       commands << "ln -s #{path_to_static}/#{f}"
-    }
+    end
     commands << ["cd .."]
     run commands.join(" && ")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 13.2.1
+  version: 15.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2020-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement