Merge pull request #2299 from ruby/cgi-escape

Add `CGI.escape/unescape_uri_component` and `URI.encode/decode_uri_component`

Author: soutaro

stdlib/cgi/0/core.rbs

@@ -931,6 +931,11 @@ class CGI
     #
     def escapeURIComponent: (string) -> String
 
+    # <!-- rdoc-file=ext/cgi/escape/escape.c -->
+    # Returns URL-escaped string following RFC 3986.
+    #
+    alias escape_uri_component escapeURIComponent
+
     # <!--
     #   rdoc-file=ext/cgi/escape/escape.c
     #   - CGI.unescape(string, encoding=@@accept_charset) -> string
@@ -954,6 +959,11 @@ class CGI
     # Returns URL-unescaped string following RFC 3986.
     #
     def unescapeURIComponent: (string) -> String
+
+    # <!-- rdoc-file=ext/cgi/escape/escape.c -->
+    # Returns URL-unescaped string following RFC 3986.
+    #
+    alias unescape_uri_component unescapeURIComponent
   end
 
   # <!-- rdoc-file=lib/cgi/core.rb -->

stdlib/uri/0/common.rbs

@@ -115,6 +115,14 @@ end
 module URI
   include URI::RFC2396_REGEXP
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - decode_uri_component(str, enc=Encoding::UTF_8)
+  # -->
+  # Like URI.decode_www_form_component, except that `'+'` is preserved.
+  #
+  def self.decode_uri_component: (String str, ?encoding enc) -> String
+
   # <!--
   #   rdoc-file=lib/uri/common.rb
   #   - decode_www_form(str, enc=Encoding::UTF_8, separator: '&', use__charset_: false, isindex: false)
@@ -189,6 +197,15 @@ module URI
   #
   def self.decode_www_form_component: (String str, ?encoding enc) -> String
 
+  # <!--
+  #   rdoc-file=lib/uri/common.rb
+  #   - encode_uri_component(str, enc=nil)
+  # -->
+  # Like URI.encode_www_form_component, except that `' '` (space) is encoded as
+  # `'%20'` (instead of `'+'`).
+  #
+  def self.encode_uri_component: (String str, ?encoding enc) -> String
+
   # <!--
   #   rdoc-file=lib/uri/common.rb
   #   - encode_www_form(enum, enc=nil)

test/stdlib/URI_test.rb

@@ -7,6 +7,18 @@ class URISingletonTest < Test::Unit::TestCase
   library "uri"
   testing "singleton(::URI)"
 
+  def test_decode_uri_component
+    assert_send_type(
+      "(String) -> String",
+      URI, :decode_uri_component, "Hello%20World%20%E6%97%A5%E6%9C%AC%E8%AA%9E"
+    )
+
+    assert_send_type(
+      "(String, Encoding) -> String",
+      URI, :decode_uri_component, "Hello%20World%20%E6%97%A5%E6%9C%AC%E8%AA%9E", Encoding::UTF_8
+    )
+  end
+
   def test_decode_www_form
     assert_send_type "(String) -> Array[[String, String]]",
                      URI, :decode_www_form, "a=1&a=2&b=3"
@@ -45,6 +57,17 @@ def test_decode_www_form_component
                      URI, :decode_www_form_component, "%A1", "sjis"
   end
 
+  def test_encode_uri_component
+    assert_send_type(
+      "(String) -> String",
+      URI, :encode_uri_component, "Hello World 日本語"
+    )
+    assert_send_type(
+      "(String, Encoding) -> String",
+      URI, :encode_uri_component, "Hello World 日本語", Encoding::UTF_8
+    )
+  end
+
   def test_encode_www_form
     assert_send_type "(Array[[String, String | Numeric]]) -> String",
                      URI, :encode_www_form, [["a", "1"], ["a", 2], ["b", "3"]]