slimmer 13.3.0 → 15.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -0
  3. data/README.md +4 -0
  4. data/Rakefile +4 -3
  5. data/lib/slimmer/app.rb +6 -26
  6. data/lib/slimmer/headers.rb +11 -17
  7. data/lib/slimmer/processors/search_remover.rb +1 -1
  8. data/lib/slimmer/processors/tag_mover.rb +13 -12
  9. data/lib/slimmer/skin.rb +4 -11
  10. data/lib/slimmer/template.rb +3 -4
  11. data/lib/slimmer/test.rb +2 -2
  12. data/lib/slimmer/test_templates/header_footer_only.html +0 -4
  13. data/lib/slimmer/test_templates/wrapper.html +0 -4
  14. data/lib/slimmer/version.rb +1 -1
  15. data/lib/tasks/slimmer.rake +2 -2
  16. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 29c95c6ec5fcb3d786e88628da00aa44018de1a338e49359d19088db092ea025
4
- data.tar.gz: 5c2f32ef832e751dc5812af7cb9d388fd4a36c8bde03d9525f58b7a46b5f0e87
3
+ metadata.gz: 4146598de4151ad771c4b288b7556ab2a8e6ef88378870a11e108188b8ff248a
4
+ data.tar.gz: 06377c22b246a77ac2faad4abed3e10b9cc8ed5d16c6515088ce949a2ea748df
5
5
  SHA512:
6
- metadata.gz: 111d7b5964863534428a2a6b9f46252f49624cb226c524e6c048cbff155c2a37d96cf14f85ade73d71b9b8bbeef1065596f9e795682f7f4fe913529fb0225116
7
- data.tar.gz: 182cab20358b7ae4b69b17c11b19ddb6697e54bd94cd66575478bdc0fa11d6a03597d9788ec4c03b6da22f6ccbb5a4156042aaecb433b1c7ddc907c2e3b7934f
6
+ metadata.gz: 8a5d1c2d0f54b7cbdf75c2e82ab4dacf27086786b505a1b63983d97751f64439927bcc81aabf24aa5deeeb0e179616edb246f756a15328d659fdc6a3df218538
7
+ data.tar.gz: 3543e2879ef471c1cf87012661c18199c094d4467b5af95aad6979dc68c678a1c1746028faa299eda135b58617c1655e3f73ded277aa98808a5a2173dd8194b3
data/CHANGELOG.md CHANGED
@@ -1,3 +1,24 @@
1
+ # 15.1.1
2
+
3
+ * Amend toggle button selector (#251)
4
+
5
+ # 15.1.0
6
+
7
+ * Add `<base>` tag into the `<head>`.
8
+
9
+ # 15.0.0
10
+
11
+ * BREAKING: Test templates no longer embed links to production JavaScript files,
12
+ apps should provide their own dependencies.
13
+
14
+ # 14.0.0
15
+
16
+ * Remove handling of non-200 responses (#245)
17
+
18
+ # 13.4.0
19
+
20
+ * Revert X-Slimmer-Ignore-Error header (#246)
21
+
1
22
  # 13.3.0
2
23
 
3
24
  * Add X-Slimmer-Ignore-Error header flag to prevent overriding non-200 status responses
data/README.md CHANGED
@@ -96,3 +96,7 @@ Add the following code to spec/spec_helper:
96
96
  ```rb
97
97
  require 'slimmer/rspec'
98
98
  ```
99
+
100
+ ## Licence
101
+
102
+ [MIT License](LICENCE)
data/Rakefile CHANGED
@@ -1,8 +1,9 @@
1
- # -*- encoding: utf-8 -*-
2
-
3
1
  require "bundler/gem_tasks"
4
2
  require "rdoc/task"
5
3
  require "rake/testtask"
4
+ require "rubocop/rake_task"
5
+
6
+ RuboCop::RakeTask.new
6
7
 
7
8
  Dir.glob("lib/tasks/*.rake").each { |r| import r }
8
9
 
@@ -18,4 +19,4 @@ Rake::TestTask.new("test") do |t|
18
19
  t.verbose = true
19
20
  end
20
21
 
21
- task default: %i[test]
22
+ task default: %i[test rubocop]
data/lib/slimmer/app.rb CHANGED
@@ -35,7 +35,7 @@ module Slimmer
35
35
  if response_can_be_rewritten?(status, headers)
36
36
  response = Rack::Response.new(body, status, headers)
37
37
 
38
- if !skip_slimmer?(env, response)
38
+ unless skip_slimmer?(env, response)
39
39
  status, headers, body = rewrite_response(env, response)
40
40
  end
41
41
  end
@@ -61,11 +61,7 @@ module Slimmer
61
61
  end
62
62
 
63
63
  def skip_slimmer_header?(response)
64
- !!response.headers[Headers::SKIP_HEADER]
65
- end
66
-
67
- def ignore_error_header?(response)
68
- !!response.headers[Headers::IGNORE_ERROR_HEADER]
64
+ response.headers.key?(Headers::SKIP_HEADER)
69
65
  end
70
66
 
71
67
  def s(body)
@@ -84,36 +80,20 @@ module Slimmer
84
80
 
85
81
  def rewrite_response(env, response)
86
82
  request = Rack::Request.new(env)
83
+ return response.finish unless response.status == 200
87
84
 
88
85
  # Store the request id so it can be passed on with any template requests
89
86
  GovukRequestId.value = env["HTTP_GOVUK_REQUEST_ID"]
90
87
 
91
- body = rewritten_body(request, response)
88
+ rewritten_body = @skin.success request, response, s(response.body)
89
+ rewritten_body = [rewritten_body] unless rewritten_body.respond_to?(:each)
92
90
 
93
- body = [body] unless body.respond_to?(:each)
94
- response.body = body
91
+ response.body = rewritten_body
95
92
  response.headers["Content-Length"] = content_length(response.body)
96
93
 
97
94
  response.finish
98
95
  end
99
96
 
100
- def rewritten_body(request, response)
101
- return @skin.success request, response, s(response.body) if ignore_error_header?(response)
102
-
103
- case response.status
104
- when 200
105
- @skin.success request, response, s(response.body)
106
- when 403
107
- @skin.error "403", s(response.body), request.env
108
- when 404
109
- @skin.error "404", s(response.body), request.env
110
- when 410
111
- @skin.error "410", s(response.body), request.env
112
- else
113
- @skin.error "500", s(response.body), request.env
114
- end
115
- end
116
-
117
97
  def strip_slimmer_headers(headers)
118
98
  headers.reject { |k, _v| k =~ /\A#{Headers::HEADER_PREFIX}/ }
119
99
  end
data/lib/slimmer/headers.rb CHANGED
@@ -9,18 +9,17 @@ module Slimmer
9
9
 
10
10
  # @private
11
11
  SLIMMER_HEADER_MAPPING = {
12
- application_name: "Application-Name",
13
- format: "Format",
14
- page_owner: "Page-Owner",
15
- organisations: "Organisations",
16
- world_locations: "World-Locations",
17
- result_count: "Result-Count",
18
- search_parameters: "Search-Parameters",
19
- section: "Section",
20
- skip: "Skip",
21
- template: "Template",
22
- remove_search: "Remove-Search",
23
- ignore_error: "Ignore-Error",
12
+ application_name: "Application-Name",
13
+ format: "Format",
14
+ page_owner: "Page-Owner",
15
+ organisations: "Organisations",
16
+ world_locations: "World-Locations",
17
+ result_count: "Result-Count",
18
+ search_parameters: "Search-Parameters",
19
+ section: "Section",
20
+ skip: "Skip",
21
+ template: "Template",
22
+ remove_search: "Remove-Search",
24
23
  }.freeze
25
24
 
26
25
  # @private
@@ -56,15 +55,10 @@ module Slimmer
56
55
  # @private
57
56
  REMOVE_SEARCH_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:remove_search]}".freeze
58
57
 
59
- # @private
60
- IGNORE_ERROR_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:ignore_error]}".freeze
61
-
62
-
63
58
  # Set the "slimmer headers" to configure the page
64
59
  #
65
60
  # @param hash [Hash] the options
66
61
  # @option hash [String] application_name
67
- # @option hash [String] ignore_error
68
62
  # @option hash [String] format
69
63
  # @option hash [String] organisations
70
64
  # @option hash [String] page_owner
data/lib/slimmer/processors/search_remover.rb CHANGED
@@ -9,7 +9,7 @@ module Slimmer::Processors
9
9
  search = dest.at_css("#global-header #search")
10
10
  search.remove if search
11
11
 
12
- search_link = dest.at_css("#global-header a[href='#search']")
12
+ search_link = dest.at_css("#global-header .search-toggle")
13
13
  search_link.remove if search_link
14
14
  end
15
15
  end
data/lib/slimmer/processors/tag_mover.rb CHANGED
@@ -1,10 +1,11 @@
1
1
  module Slimmer::Processors
2
2
  class TagMover
3
3
  def filter(src, dest)
4
- move_tags(src, dest, "script", dest_node: "body", keys: %w(src inner_html))
4
+ move_tags(src, dest, "script", dest_node: "body", keys: %w[src inner_html])
5
5
  move_tags(src, dest, "link", must_have: %w[href])
6
- move_tags(src, dest, "meta", must_have: %w(name content), keys: %w[name content http-equiv], insertion_location: :top)
7
- move_tags(src, dest, "meta", must_have: %w(property content), keys: %w(property content), insertion_location: :top)
6
+ move_tags(src, dest, "meta", must_have: %w[name content], keys: %w[name content http-equiv], insertion_location: :top)
7
+ move_tags(src, dest, "meta", must_have: %w[property content], keys: %w[property content], insertion_location: :top)
8
+ move_tags(src, dest, "base", must_have: %w[href])
8
9
  end
9
10
 
10
11
  def include_tag?(node, min_attrs)
@@ -39,15 +40,15 @@ module Slimmer::Processors
39
40
  dest_node = opts[:dest_node] || "head"
40
41
 
41
42
  src.css(type).each do |node|
42
- if include_tag?(node, min_attrs) && !already_there.include?(tag_fingerprint(node, comparison_attrs))
43
- node = wrap_node(src, node)
44
- node.remove
45
-
46
- if opts[:insertion_location] == :top
47
- dest.at_xpath("/html/#{dest_node}").prepend_child(node)
48
- else
49
- dest.at_xpath("/html/#{dest_node}") << node
50
- end
43
+ next unless include_tag?(node, min_attrs) && !already_there.include?(tag_fingerprint(node, comparison_attrs))
44
+
45
+ node = wrap_node(src, node)
46
+ node.remove
47
+
48
+ if opts[:insertion_location] == :top
49
+ dest.at_xpath("/html/#{dest_node}").prepend_child(node)
50
+ else
51
+ dest.at_xpath("/html/#{dest_node}") << node
51
52
  end
52
53
  end
53
54
  end
data/lib/slimmer/skin.rb CHANGED
@@ -5,12 +5,12 @@ module Slimmer
5
5
  class Skin
6
6
  attr_accessor :asset_host, :logger, :strict, :options
7
7
 
8
- def initialize options = {}
8
+ def initialize(options = {})
9
9
  @options = options
10
10
  @asset_host = options[:asset_host]
11
11
 
12
12
  @logger = options[:logger] || NullLogger.instance
13
- @strict = options[:strict] || %w{development test}.include?(ENV["RACK_ENV"])
13
+ @strict = options[:strict] || %w[development test].include?(ENV["RACK_ENV"])
14
14
  end
15
15
 
16
16
  def template(template_name)
@@ -42,7 +42,7 @@ module Slimmer
42
42
  doc = Nokogiri::HTML.parse(html)
43
43
  if strict
44
44
  errors = doc.errors.select(&:error?).reject { |e| ignorable?(e) }
45
- if !errors.empty?
45
+ unless errors.empty?
46
46
  error = errors.first
47
47
  message = "In #{description_for_error_message}: '#{error.message}' at line #{error.line} col #{error.column} (code #{error.code}).\n"
48
48
  message << "Add ?skip_slimmer=1 to the url to show the raw backend request.\n\n"
@@ -59,7 +59,7 @@ module Slimmer
59
59
  lines = [""] + html.split("\n")
60
60
  from = [1, error.line - context_size].max
61
61
  to = [lines.size - 1, error.line + context_size].min
62
- context = (from..to).zip(lines[from..to]).map { |lineno, line| "%4d: %s" % [lineno, line] }
62
+ context = (from..to).zip(lines[from..to]).map { |lineno, line| sprintf("%4d: %s", lineno, line) }
63
63
  marker = " " * (error.column - 1) + "-----v"
64
64
  context.insert(context_size, marker)
65
65
  context.join("\n")
@@ -112,12 +112,5 @@ module Slimmer
112
112
  template_name = response.headers[Headers::TEMPLATE_HEADER] || "core_layout"
113
113
  process(processors, body, template(template_name), source_request.env)
114
114
  end
115
-
116
- def error(template_name, body, rack_env)
117
- processors = [
118
- Processors::TitleInserter.new,
119
- ]
120
- process(processors, body, template(template_name), rack_env)
121
- end
122
115
  end
123
116
  end
data/lib/slimmer/template.rb CHANGED
@@ -1,16 +1,15 @@
1
1
  module Slimmer
2
2
  module Template
3
- def self.included into
3
+ def self.included(into)
4
4
  into.extend ClassMethods
5
5
  end
6
6
 
7
- def slimmer_template template_name
7
+ def slimmer_template(template_name)
8
8
  response.headers[Slimmer::Headers::TEMPLATE_HEADER] = template_name.to_s
9
9
  end
10
10
 
11
-
12
11
  module ClassMethods
13
- def slimmer_template template_name
12
+ def slimmer_template(template_name)
14
13
  after_action do
15
14
  response.headers[Slimmer::Headers::TEMPLATE_HEADER] ||= template_name.to_s
16
15
  end
data/lib/slimmer/test.rb CHANGED
@@ -2,10 +2,10 @@ require "slimmer/skin"
2
2
 
3
3
  module Slimmer
4
4
  class Skin
5
- def load_template name
5
+ def load_template(name)
6
6
  logger.debug "Slimmer: TEST MODE - Loading fixture template from #{__FILE__}"
7
7
  if name =~ /\A(.*)\.raw\z/
8
- %{<div id="test-#{$1}"></div>}
8
+ %(<div id="test-#{Regexp.last_match(1)}"></div>)
9
9
  elsif File.exist?(template_path = File.join(File.dirname(__FILE__), "test_templates", "#{name}.html"))
10
10
  File.read(template_path)
11
11
  else
data/lib/slimmer/test_templates/header_footer_only.html CHANGED
@@ -19,9 +19,5 @@
19
19
  <div id="wrapper"></div>
20
20
 
21
21
  <footer id="footer"></footer>
22
-
23
- <script src="https://assets.publishing.service.gov.uk/static/govuk-template.js" type="text/javascript"></script>
24
- <script src="https://assets.publishing.service.gov.uk/static/libs/jquery/jquery-1.7.2.js" type="text/javascript"></script>
25
- <script src="https://assets.publishing.service.gov.uk/static/header-footer-only.js" type="text/javascript"></script>
26
22
  </body>
27
23
  </html>
data/lib/slimmer/test_templates/wrapper.html CHANGED
@@ -19,9 +19,5 @@
19
19
  <div id="wrapper"></div>
20
20
 
21
21
  <footer id="footer"></footer>
22
-
23
- <script src="https://assets.publishing.service.gov.uk/static/govuk-template.js" type="text/javascript"></script>
24
- <script src="https://assets.publishing.service.gov.uk/static/libs/jquery/jquery-1.7.2.js" type="text/javascript"></script>
25
- <script src="https://assets.publishing.service.gov.uk/static/application.js" type="text/javascript"></script>
26
22
  </body>
27
23
  </html>
data/lib/slimmer/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Slimmer
2
- VERSION = "13.3.0".freeze
2
+ VERSION = "15.1.1".freeze
3
3
  end
data/lib/tasks/slimmer.rake CHANGED
@@ -6,9 +6,9 @@ namespace :slimmer do
6
6
  path_to_static = "../static/public"
7
7
  path_to_public = "public"
8
8
  commands = ["cd #{path_to_public}"]
9
- Dir.glob("../static/public/*") { |f|
9
+ Dir.glob("../static/public/*") do |f|
10
10
  commands << "ln -s #{path_to_static}/#{f}"
11
- }
11
+ end
12
12
  commands << ["cd .."]
13
13
  run commands.join(" && ")
14
14
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: slimmer
3
3
  version: !ruby/object:Gem::Version
4
- version: 13.3.0
4
+ version: 15.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - GOV.UK Dev
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-04-08 00:00:00.000000000 Z
11
+ date: 2020-09-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activesupport
@@ -184,14 +184,14 @@ dependencies:
184
184
  requirements:
185
185
  - - "~>"
186
186
  - !ruby/object:Gem::Version
187
- version: 2.0.0
187
+ version: '3'
188
188
  type: :development
189
189
  prerelease: false
190
190
  version_requirements: !ruby/object:Gem::Requirement
191
191
  requirements:
192
192
  - - "~>"
193
193
  - !ruby/object:Gem::Version
194
- version: 2.0.0
194
+ version: '3'
195
195
  - !ruby/object:Gem::Dependency
196
196
  name: timecop
197
197
  requirement: !ruby/object:Gem::Requirement