Implement `CGI.escapeURIComponent ` and `CGI.unescapeURIComponent ` by casperisfine · Pull Request #26 · ruby/cgi

casperisfine · 2022-06-09T10:09:54Z

Ref: https://bugs.ruby-lang.org/issues/18822

Ruby is somewhat missing an RFC 3986 compliant escape method.

olleolleolle

(My comments were about... comments.)

casperisfine · 2022-06-09T12:10:39Z

Thanks @olleolleolle

byroot · 2022-08-03T19:43:31Z

I updated the PR to match what was accepted at the last meeting.

ioquatix · 2022-08-04T01:24:05Z

I'm curious what was the justification for the non-standard camel case names? To match the standards?

nurse · 2022-08-11T12:12:16Z

I'm curious what was the justification for the non-standard camel case names? To match the standards?

It's because there are already escapeHTML
The expected use case of escapeURIComponent is similar to encodeURIComponent of JavaScript, but the escape is slightly different from it

ioquatix · 2022-08-12T01:15:04Z

It's because there are already escapeHTML

Is it good justification? Why not add alias escape_html. escapeHTML and escapeURIComponent is not standard Ruby convention. Do we want to introduce it?

[Feature #18822] Ruby is somewhat missing an RFC 3986 compliant escape method.

byroot · 2022-08-16T10:12:07Z

Thank you for the review @nobu and @mame

Ref: ruby/cgi#26 This native implementation is much faster and available in `cgi 0.3.3`.

(ruby/erb#23) Ref: ruby/cgi#26 This native implementation is much faster and available in `cgi 0.3.3`. ruby/erb@2d90e9b010

jrochkind · 2023-02-05T16:31:13Z

Thank you, this is very helpful!

The expected use case of escapeURIComponent is similar to encodeURIComponent of JavaScript, but the escape is slightly different from it

I am curious to learn more about how the escape differs from Javascript encodeURIComponent, and why.

byroot · 2023-02-05T16:58:36Z

how the escape differs from Javascript encodeURIComponent

From MDN:

encodeURIComponent escapes all characters except:
A–Z a–z 0–9 - _ . ! ~ * ' ( )

Whereas CGI.escapeURIComponent, escape all characters, except:

A–Z a–z 0–9 - _ . ~

https://github.com/casperisfine/cgi/blob/c2729c7f333dd68a318b943ff06c7830b5db53a9/ext/cgi/escape/escape.c#L187-L194

So it's a bit more strict even.

jrochkind · 2023-02-05T17:17:32Z

Thank you! Any clues as to motivation? The ruby choice to escape seems right to me, I wouldn't want ! * ' ( ) characters in a URI path or query component, but perhaps they are technically legal. Escaping where not required shouldn't actually harm things either way, so no matter I guess.

I guess this also just shows how many people have had such trouble getting this right and consistent over time.

byroot · 2023-02-05T17:21:30Z

Thank you! Any clues as to motivation?

Ruby follow a fairly recent RFC https://www.rfc-editor.org/rfc/rfc3986#section-2.3, and allow you to escape for pretty much all parts of the URL (path, query, anchor, etc).

The behavior of JS EncodeURIComponent is much older, and I'm unsure which RFC or other spec it tries to follow.

olleolleolle reviewed Jun 9, 2022
View reviewed changes

Comment threadext/cgi/escape/escape.c Outdated
Comment threadlib/cgi/util.rb Outdated
Comment threadlib/cgi/util.rb Outdated

casperisfine force-pushed the escape-url-variants branch from 2b9e3ba to 5280728Compare June 9, 2022 12:10

casperisfine force-pushed the escape-url-variants branch from 5280728 to 652fadbCompare August 3, 2022 14:21

casperisfine changed the title ~~Implement CGI.url_encode and CGI.url_decode~~Implement CGI. escapeURIComponent and CGI.unescapeURIComponent Aug 3, 2022

casperisfine force-pushed the escape-url-variants branch from 652fadb to dbdf846Compare August 3, 2022 14:44

casperisfine changed the title ~~Implement CGI. escapeURIComponent and CGI.unescapeURIComponent~~ Implement CGI.escapeURIComponent and CGI.unescapeURIComponent Aug 3, 2022

byroot requested review from hsbt and nobu August 3, 2022 19:43

mame reviewed Aug 16, 2022
View reviewed changes

Comment threadext/cgi/escape/escape.c Outdated

casperisfine force-pushed the escape-url-variants branch from dbdf846 to 926cdfdCompare August 16, 2022 08:30

nobu reviewed Aug 16, 2022
View reviewed changes

casperisfine force-pushed the escape-url-variants branch from 926cdfd to deb2873Compare August 16, 2022 08:35

nobu approved these changes Aug 16, 2022
View reviewed changes

Implement CGI.url_encode and CGI.url_decode
c2729c7
[Feature #18822] Ruby is somewhat missing an RFC 3986 compliant escape method.

casperisfine force-pushed the escape-url-variants branch from deb2873 to c2729c7Compare August 16, 2022 08:48

byroot merged commit 4de4012 into ruby:masterAug 16, 2022

byroot added a commit to ruby/erb that referenced this pull request Oct 25, 2022
url_encode: use CGI.escapeURIComponent
83ea8c8
Ref: ruby/cgi#26 This native implementation is much faster and available in `cgi 0.3.3`.

byroot mentioned this pull request Oct 25, 2022
url_encode: use CGI.escapeURIComponent ruby/erb#23
Merged

byroot added a commit to ruby/erb that referenced this pull request Oct 25, 2022
url_encode: use CGI.escapeURIComponent
5b0ee7a
Ref: ruby/cgi#26 This native implementation is much faster and available in `cgi 0.3.3`.

k0kubun pushed a commit to ruby/erb that referenced this pull request Oct 25, 2022
url_encode: use CGI.escapeURIComponent (#23)
2d90e9b
Ref: ruby/cgi#26 This native implementation is much faster and available in `cgi 0.3.3`.

matzbot pushed a commit to ruby/ruby that referenced this pull request Oct 25, 2022
[ruby/erb] url_encode: use CGI.escapeURIComponent
217fdbf
(ruby/erb#23) Ref: ruby/cgi#26 This native implementation is much faster and available in `cgi 0.3.3`. ruby/erb@2d90e9b010

tenderlove pushed a commit to Shopify/ruby that referenced this pull request Oct 27, 2022
[ruby/erb] url_encode: use CGI.escapeURIComponent
70c545c
(ruby/erb#23) Ref: ruby/cgi#26 This native implementation is much faster and available in `cgi 0.3.3`. ruby/erb@2d90e9b010

Uh oh!

Conversation

casperisfine commented Jun 9, 2022

Uh oh!

olleolleolle left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

casperisfine commented Jun 9, 2022

Uh oh!

byroot commented Aug 3, 2022

Uh oh!

ioquatix commented Aug 4, 2022

Uh oh!

nurse commented Aug 11, 2022

Uh oh!

ioquatix commented Aug 12, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

byroot commented Aug 16, 2022

Uh oh!

jrochkind commented Feb 5, 2023

Uh oh!

byroot commented Feb 5, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jrochkind commented Feb 5, 2023

Uh oh!

byroot commented Feb 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

byroot commented Feb 5, 2023•
edited
Loading