Skip to content

Commit 61a2dae

Browse files
authored
Load cgi/escape instead of cgi/util (#1366)
`cgi/util` will warn on Ruby 3.5. `cgi/escape` is available since Ruby 2.4, but to use CGI.unescape* methods on Ruby 3.4 and earlier, `cgi/util` must still be required. There's only one place in rdoc that uses such a method, so only one place needs to handle earlier rubies. https://bugs.ruby-lang.org/issues/21258
1 parent eb05c44 commit 61a2dae

File tree

4 files changed

+6
-4
lines changed

4 files changed

+6
-4
lines changed

lib/rdoc/code_object/context/section.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# frozen_string_literal: true
2-
require 'cgi/util'
2+
require 'cgi/escape'
33

44
##
55
# A section of documentation like:

lib/rdoc/code_object/method_attr.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ def block_params=(value)
282282
# HTML id-friendly method/attribute name
283283

284284
def html_name
285-
require 'cgi/util'
285+
require 'cgi/escape'
286286

287287
CGI.escape(@name.gsub('-', '-2D')).gsub('%', '-').sub(/^-/, '')
288288
end

lib/rdoc/markup/to_html.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# frozen_string_literal: true
2-
require 'cgi/util'
2+
require 'cgi/escape'
3+
# For CGI.unescape on earlier rubies
4+
require 'cgi/util' if RUBY_VERSION < '3.5'
35

46
##
57
# Outputs RDoc markup as HTML.

lib/rdoc/markup/to_label.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# frozen_string_literal: true
2-
require 'cgi/util'
2+
require 'cgi/escape'
33

44
##
55
# Creates HTML-safe labels suitable for use in id attributes. Tidylinks are

0 commit comments

Comments
 (0)