slimmer 16.0.1 → 18.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9fa11bce76f394cdd62bf87754f0a9fe701d12318de438129e6d09c8595ce6d
-  data.tar.gz: d12897d944a227f8bef8c7c07038136e598ac2ab6f285698d4a75a70855c716a
+  metadata.gz: a7a260effd72ec2553063c010694a0486e5990b664e5934332630b40586933a1
+  data.tar.gz: 70ebd575e41468a07f64c9ebff2e0b168a5cd890f5f32c736bfdbd70befdb1f2
 SHA512:
-  metadata.gz: f6bc30a38aa60c2582b5fb4b7fbdc9c542e4852f75941dc72edf783a145f9a347c4c2ac8afe454b4d130da4767cb22056cea63f6b6866c6cf080c521d0d95b90
-  data.tar.gz: 82a4a80af07e8c9554fab7934a02055b30f125a6239ee429375e7a16d893805ab3ad374f77ca2c4b76cacdba1a4d4010b80ea0c9cd760d4502712ad1bac4502c
+  metadata.gz: 62607015532688137712ead664e2948e7581c739d6ecfc58b31164d1f63a8a15b652f8e750a2af23e4b0a5439e4a5d139862e8d0bc3cf3c3535c8d93b387a898
+  data.tar.gz: 6bd6af1f703e2d4ec1ce04dc2a883fbb7f208e9d24a3819e257e2d109fc067d0472ed96001d9e873385beab1a3a1aff41db781561d37ac2d383a817fac5b761c

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 18.0.0
+
+* BREAKING: Drop support for determining Rails < 6 application names
+* BREAKING: Remove `bin/render_slimmer_error` as a feature - it's expected that this is unused.
+* Require Ruby >= 2.7.0
+* Resolve deprecation warning for Plek.current
+
+# 17.0.0
+
+* BREAKING: Set default template to `gem_layout` and remove references to the deprecated `core_layout`.
+
 # 16.0.1
 * Resolve Nokogiri deprecation warning (#277)
 

data/README.md

@@ -57,6 +57,10 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+## Use in before_action renders
+
+If you have a non-default layout and want to render in a before_action method, note that you may have to explicitly call `slimmer_template(:your_template_name)` in the action before rendering. Rendering in a before_action immediately stops the action chain, and since slimmer usually calls slimmer_template as an after_action, it would be skipped over (and you'd get the default layout). 
+
 ## Logging
 
 Slimmer can be configured with a logger by passing in a logger instance

data/Rakefile

@@ -1,5 +1,4 @@
 require "bundler/gem_tasks"
-require "rdoc/task"
 require "rake/testtask"
 require "rubocop/rake_task"
 
@@ -7,11 +6,6 @@ RuboCop::RakeTask.new
 
 Dir.glob("lib/tasks/*.rake").each { |r| import r }
 
-RDoc::Task.new do |rd|
-  rd.rdoc_files.include("lib/**/*.rb")
-  rd.rdoc_dir = "rdoc"
-end
-
 Rake::TestTask.new("test") do |t|
   t.ruby_opts << "-rrubygems"
   t.libs << "test"
@@ -19,4 +13,4 @@ Rake::TestTask.new("test") do |t|
   t.verbose = true
 end
 
-task default: %i[test rubocop]
+task default: %i[rubocop test]

data/lib/slimmer/app.rb

@@ -10,11 +10,9 @@ module Slimmer
 
       logger = options[:logger] || NullLogger.instance
       self.logger = logger
-      if logger&.level&.zero? # Log set to debug level
-        unless options[:enable_debugging]
-          self.logger = logger.dup
-          self.logger.level = 1 # info
-        end
+      if logger&.level&.zero? && !(options[:enable_debugging])
+        self.logger = logger.dup
+        self.logger.level = 1 # info
       end
 
       if options.key? :template_path
@@ -22,7 +20,7 @@ module Slimmer
       end
 
       unless options[:asset_host]
-        options[:asset_host] = Plek.current.find("static")
+        options[:asset_host] = Plek.find("static")
       end
 
       @skin = Skin.new options.merge(logger: self.logger)
@@ -95,7 +93,9 @@ module Slimmer
     end
 
     def strip_slimmer_headers(headers)
-      headers.reject { |k, _v| k =~ /\A#{Headers::HEADER_PREFIX}/ }
+      # Convert Rack::Util::HeaderHash to a simple hash to avoid a Ruby warning
+      # of extra states not copied. Can be removed once Ruby < 3.1 support is removed.
+      headers.to_h.reject { |k, _v| k =~ /\A#{Headers::HEADER_PREFIX}/ }
     end
   end
 end

data/lib/slimmer/processors/accounts_shower.rb

@@ -15,9 +15,10 @@ module Slimmer::Processors
         layout_header.remove if layout_header
       end
 
-      if header_value == "signed-in"
+      case header_value
+      when "signed-in"
         remove_signed_out(dest)
-      elsif header_value == "signed-out"
+      when "signed-out"
         remove_signed_in(dest)
       else
         remove_signed_out(dest)
@@ -57,7 +58,7 @@ module Slimmer::Processors
     end
 
     def is_gem_layout?
-      @headers[Slimmer::Headers::TEMPLATE_HEADER]&.starts_with?("gem_layout")
+      @headers[Slimmer::Headers::TEMPLATE_HEADER]&.start_with?("gem_layout")
     end
   end
 end

data/lib/slimmer/processors/body_inserter.rb

@@ -1,8 +1,8 @@
 module Slimmer::Processors
   class BodyInserter
     def initialize(source_id = "wrapper", destination_id = "wrapper", headers = {})
-      @source_selector = "#" + source_id
-      @destination_selector = "#" + destination_id
+      @source_selector = "##{source_id}"
+      @destination_selector = "##{destination_id}"
       @headers = headers
     end
 
@@ -22,7 +22,7 @@ module Slimmer::Processors
   private
 
     def is_gem_layout?
-      @headers[Slimmer::Headers::TEMPLATE_HEADER]&.starts_with?("gem_layout")
+      @headers[Slimmer::Headers::TEMPLATE_HEADER]&.start_with?("gem_layout")
     end
   end
 end

data/lib/slimmer/processors/feedback_url_swapper.rb

@@ -28,7 +28,7 @@ module Slimmer::Processors
     end
 
     def is_gem_layout?
-      @headers[Slimmer::Headers::TEMPLATE_HEADER]&.starts_with?("gem_layout")
+      @headers[Slimmer::Headers::TEMPLATE_HEADER]&.start_with?("gem_layout")
     end
   end
 end

data/lib/slimmer/railtie.rb

@@ -4,20 +4,14 @@ module Slimmer
 
     initializer "slimmer.configure" do |app|
       slimmer_config = app.config.slimmer.to_hash
-      app_name = ENV["GOVUK_APP_NAME"] || Slimmer::Railtie.parent_name(app)
+      parent_name = app.class.module_parent_name if app.class.respond_to?(:module_parent_name)
+      app_name = ENV.fetch("GOVUK_APP_NAME", parent_name)
       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
+      # The extra kwargs **{} is for Ruby 2.7 so that it doesn't recognise the
+      # slimmer_config as kwargs, this change can be removed once Ruby 2.7
+      # support is dropped
+      app.middleware.use Slimmer::App, slimmer_config, **{}
     end
   end
 end

data/lib/slimmer/skin.rb

@@ -68,7 +68,7 @@ module Slimmer
       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| sprintf("%4d: %s", lineno, line) }
-      marker = " " * (error.column - 1) + "-----v"
+      marker = "#{' ' * (error.column - 1)}-----v"
       context.insert(context_size, marker)
       context.join("\n")
     end
@@ -119,7 +119,7 @@ module Slimmer
         Processors::AccountsShower.new(response.headers),
       ]
 
-      template_name = response.headers[Headers::TEMPLATE_HEADER] || "core_layout"
+      template_name = response.headers[Headers::TEMPLATE_HEADER] || "gem_layout"
       process(processors, body, template(template_name), source_request.env)
     end
   end

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = "16.0.1".freeze
+  VERSION = "18.0.0".freeze
 end

data/lib/slimmer.rb

@@ -9,6 +9,10 @@ require "slimmer/railtie" if defined? Rails
 module Slimmer
   CACHE_TTL = 60
 
+  def self.cache=(cache)
+    @cache = cache
+  end
+
   def self.cache
     @cache ||= defined?(Rails) ? Rails.cache : NoCache.new
   end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 16.0.1
+  version: 18.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-31 00:00:00.000000000 Z
+date: 2022-10-21 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -109,143 +95,113 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: climate_control
   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: mocha
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.2
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-govuk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.1
-- !ruby/object:Gem::Dependency
-  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 4.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 4.7.0
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.6
+        version: '3.8'
 description: Rack middleware for skinning pages using a specific template
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
-executables:
-- render_slimmer_error
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - README.md
 - Rakefile
-- bin/render_slimmer_error
 - lib/slimmer.rb
 - lib/slimmer/app.rb
 - lib/slimmer/cucumber.rb
@@ -285,16 +241,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.24
 signing_key: 
 specification_version: 4
 summary: Thinner than the skinner

data/bin/render_slimmer_error

@@ -1,39 +0,0 @@
-#! /usr/bin/env ruby
-
-require "optparse"
-require "slimmer"
-require "logger"
-
-options = {}
-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|
-    options[:asset_host] = v
-  end
-
-  opts.on "-o", "--output-file=FILE", "File to write static error page to" do |v|
-    options[:file] = v
-  end
-end
-
-option_parser.parse!
-
-raise "Please specify a template" unless options[:template]
-raise "Please specify an asset host" unless options[:asset_host]
-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
-static_error = skin.error nil, options[:template], Nokogiri::HTML("").to_html
-
-if options[:file] == "-"
-  STDOUT.print static_error
-else
-  File.open options[:file], "w" do |f|
-    f.print static_error
-  end
-end