Bug #16922: single quote should be escaped in xml

• Status: Closed
• Assignee: akr (Akira Tanaka)
• Target version: -
• ruby -v: ruby 2.6.3p62 (2019-04-16 revision 67580) [x86_64-darwin18]
• Backport: 2.6: REQUIRED, 2.7: REQUIRED, 3.0: DONTNEED

[lisbethw1130 (Lisbeth Wu)]

This is Lisbeth from Taiwan. I'm trying to convert a string to xml by using 'string'.encode(xml: :attr) but single quote doesn't escape as expected
Here's the spec shows which character needs to be escaped: https://www.w3.org/TR/xml/#dt-escape

and I found a more clean table in sitemap spec: https://www.sitemaps.org/protocol.html#escaping

Ampersand 	& 	&
Single Quote 	' 	'
Double Quote 	" 	"
Greater Than 	> 	>
Less Than 	< 	&lt;

expected output:

puts ':$+,;:=?@&'"><'.encode(xml: :attr)

":$+,;:=?@& **'** "><"

real output:

":$+,;:=?@& **'** "><"

Thanks for helping

[shyouhei (Shyouhei Urabe)]

• Description updated (diff)

[jeremyevans0 (Jeremy Evans)]

• Assignee set to akr (Akira Tanaka)

I've added a pull request to escape ' as ': https://github.com/ruby/ruby/pull/3177

@akr (Akira Tanaka), can you let me know if this is correct?

[lisbethw1130 (Lisbeth Wu)]

any update about this issue?

[jeremyevans0 (Jeremy Evans)]

Well, I haven't heard from @akr (Akira Tanaka). But if he doesn't respond in the next few days, I'll merge my pull request.

• Status changed from Open to Closed

Applied in changeset git|ddd9704ae9bf884d867b6f57a16c095a79393fff.

---

Encode ' as ' when using encode(xml: :attr)

Fixes [Bug #16922]

[headius (Charles Nutter)]

• Backport changed from 2.5: UNKNOWN, 2.6: UNKNOWN, 2.7: UNKNOWN to 2.5: UNKNOWN, 2.6: REQUIRED, 2.7: REQUIRED, 3.0: REQUIRED

Requesting backport to 2.6. JRuby runs the CRuby test suite and wants to fix the same issue, but the existing tests in ruby_2_6 branch fail.

[headius (Charles Nutter)]

See https://github.com/jruby/jruby/pull/7142 for JRuby update of our jcodings encoding backend, plus the test changes from https://github.com/ruby/ruby/pull/3177.

[nagachika (Tomoyuki Chikanaga)]

• Backport changed from 2.5: UNKNOWN, 2.6: REQUIRED, 2.7: REQUIRED, 3.0: REQUIRED to 2.6: REQUIRED, 2.7: REQUIRED, 3.0: DONTNEED

ruby_3_0 branch includes the changeset git|ddd9704ae9bf884d867b6f57a16c095a79393fff.