Uh oh!
There was an error while loading. Please reload this page.
Allow GCI.escapeHTML to take a custom escape table - #55
Open
byroot wants to merge 1 commit into
Open
Conversation
nobu
reviewed
Jun 23, 2026
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| dynamic_escape_html(VALUE str, VALUE rb_escape_table) | ||
| { | ||
| VALUE escape_table[UCHAR_MAX+1] = {0}; | ||
| long max_escape_length = build_escape_table(escape_table, rb_escape_table); |
Member
There was a problem hiding this comment.
The key lengths can be changed the methods of the latter keys.
May be better to separate filling the table and calculating the max length.
MemberAuthor
There was a problem hiding this comment.
The key lengths can be changed the methods of the latter keys.
I don't think I understand what you are referring to.
Uh oh!
There was an error while loading. Please reload this page.
byroot
commented
Jun 23, 2026
MemberAuthor
Sorry this is an old patch, not very fresh in my head. I'll try to address your feedback. |
byrootforce-pushed
the
escape-html-provided-list
branch
5 times, most recently
from
June 23, 2026 09:32
653b625 to
8f73bcfComparebyrootforce-pushed
the
escape-html-provided-list
branch
from
June 23, 2026 09:37
8f73bcf to
57a61dcCompareIn some cases you may want to escape a string in a different way than
the default behavior.
For instance, if you are trying to make some JSON save to include
in a `<script>` tag, you may want to escape less, and using JavaScript
codepoints:
```ruby
>> CGI.escapeHTML('Hello </script>', ">" => '\u003e', "<" => '\u003c', "&" => '\u0026')
=> "Hello \\u003c/script\\u003e"
```
Of course you can always use `gsub` for that, but `CGI.escapeHTML` being
specialized is able to be very significantly faster:
```
ruby 3.4.1 (2024-12-25 revision 48d4efcb85) +YJIT +PRISM [arm64-darwin23]
Warming up --------------------------------------
gsub 82.135k i/100ms
escapeHTML 221.405k i/100ms
Calculating -------------------------------------
gsub 821.890k (± 2.2%) i/s (1.22 μs/i) - 4.189M in 5.099152s
escapeHTML 2.330M (± 0.5%) i/s (429.22 ns/i) - 11.734M in 5.036770s
Comparison:
escapeHTML: 2329816.5 i/s
gsub: 821889.7 i/s - 2.83x slower
ruby 3.4.1 (2024-12-25 revision 48d4efcb85) +YJIT +PRISM [arm64-darwin23]
Warming up --------------------------------------
gsub 36.235k i/100ms
escapeHTML 171.347k i/100ms
Calculating -------------------------------------
gsub 359.528k (± 1.5%) i/s (2.78 μs/i) - 1.812M in 5.040422s
escapeHTML 1.812M (± 0.7%) i/s (551.84 ns/i) - 9.081M in 5.011762s
Comparison:
escapeHTML: 1812105.3 i/s
gsub: 359527.5 i/s - 5.04x slower
```
```ruby
require "benchmark/ips"
require "cgi"
ESCAPE = {
">" => '\u003e', "<" => '\u003c', "&" => '\u0026',
}
ESCAPE_B = {
">".b => '\u003e'.b,
"<".b => '\u003c'.b,
"&".b => '\u0026'.b,
}
ESCAPE_REGEX = Regexp.union(ESCAPE_B.keys)
str = ("a" * 1024).freeze
Benchmark.ips do |x|
x.report("gsub") do
b = str.b
b.gsub!(ESCAPE_REGEX, ESCAPE_B)
b.force_encoding(str.encoding)
end
x.report("escapeHTML") do
CGI.escapeHTML(str, ESCAPE)
end
x.compare!
end
str = (("a" * 1023) + "<").freeze
Benchmark.ips do |x|
x.report("gsub") do
b = str.b
b.gsub!(ESCAPE_REGEX, ESCAPE_B)
b.force_encoding(str.encoding)
end
x.report("escapeHTML") do
CGI.escapeHTML(str, ESCAPE)
end
x.compare!
end
```byrootforce-pushed
the
escape-html-provided-list
branch
from
June 23, 2026 09:39
57a61dc to
51256f6Comparebyroot
commented
Jul 29, 2026
MemberAuthor
@nobu is the patch now acceptable? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In some cases you may want to escape a string in a different way than the default behavior.
For instance, if you are trying to make some JSON safe to include in a
<script>tag, you may want to escape less, and using JavaScript codepoints:Of course you can always use
gsubfor that, butCGI.escapeHTMLbeing specialized is able to be very significantly faster:NB: I haven't implemented the Java version, but can do it if there is interest in this feature.