rbs 3.9.4 → 4.2.0

data/stdlib/cgi-escape/0/escape.rbs

@@ -0,0 +1,171 @@
+# <!-- rdoc-file=lib/cgi/escape.rb -->
+# Since Ruby 4.0, CGI is a small holder for various escaping methods, included
+# from CGI::Escape
+#
+#     require 'cgi/escape'
+#
+#     CGI.escape("Ruby programming language")
+#     #=> "Ruby+programming+language"
+#     CGI.escapeURIComponent("Ruby programming language")
+#     #=> "Ruby%20programming%20language"
+#
+# See CGI::Escape module for methods list and their description.
+#
+class CGI
+  include Escape
+
+  extend Escape
+
+  # <!-- rdoc-file=lib/cgi/escape.rb -->
+  # Web-related escape/unescape functionality.
+  #
+  module Escape
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - escape(string)
+    # -->
+    # URL-encode a string into application/x-www-form-urlencoded. Space characters
+    # (<code>" "</code>) are encoded with plus signs (<code>"+"</code>)
+    #     url_encoded_string = CGI.escape("'Stop!' said Fred")
+    #        # => "%27Stop%21%27+said+Fred"
+    #
+    def escape: (string str) -> String
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - escapeElement(string, *elements)
+    # -->
+    # Escape only the tags of certain HTML elements in `string`.
+    #
+    # Takes an element or elements or array of elements.  Each element is specified
+    # by the name of the element, without angle brackets. This matches both the
+    # start and the end tag of that element. The attribute list of the open tag will
+    # also be escaped (for instance, the double-quotes surrounding attribute
+    # values).
+    #
+    #     print CGI.escapeElement('<BR><A HREF="url"></A>', "A", "IMG")
+    #       # "<BR>&lt;A HREF=&quot;url&quot;&gt;&lt;/A&gt"
+    #
+    #     print CGI.escapeElement('<BR><A HREF="url"></A>', ["A", "IMG"])
+    #       # "<BR>&lt;A HREF=&quot;url&quot;&gt;&lt;/A&gt"
+    #
+    def escapeElement: (string string, *String | Array[String] elements) -> String
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - escapeHTML(string)
+    # -->
+    # Escape special characters in HTML, namely <code>'&\"<></code>
+    #     CGI.escapeHTML('Usage: foo "bar" <baz>')
+    #        # => "Usage: foo &quot;bar&quot; &lt;baz&gt;"
+    #
+    def escapeHTML: (string str) -> String
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - escapeURIComponent(string)
+    # -->
+    # URL-encode a string following RFC 3986 Space characters (<code>" "</code>) are
+    # encoded with (<code>"%20"</code>)
+    #     url_encoded_string = CGI.escapeURIComponent("'Stop!' said Fred")
+    #        # => "%27Stop%21%27%20said%20Fred"
+    #
+    def escapeURIComponent: (string) -> String
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - escape_element(string, *elements)
+    # -->
+    #
+    alias escape_element escapeElement
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - escape_html(string)
+    # -->
+    #
+    alias escape_html escapeHTML
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - escape_uri_component(string)
+    # -->
+    #
+    alias escape_uri_component escapeURIComponent
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - h(string)
+    # -->
+    #
+    alias h escapeHTML
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - unescape(string, encoding = @@accept_charset)
+    # -->
+    # URL-decode an application/x-www-form-urlencoded string with
+    # encoding(optional).
+    #     string = CGI.unescape("%27Stop%21%27+said+Fred")
+    #        # => "'Stop!' said Fred"
+    #
+    def unescape: (string str, ?encoding encoding) -> String
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - unescapeElement(string, *elements)
+    # -->
+    # Undo escaping such as that done by CGI.escapeElement
+    #
+    #     print CGI.unescapeElement(
+    #             CGI.escapeHTML('<BR><A HREF="url"></A>'), "A", "IMG")
+    #       # "&lt;BR&gt;<A HREF="url"></A>"
+    #
+    #     print CGI.unescapeElement(
+    #             CGI.escapeHTML('<BR><A HREF="url"></A>'), ["A", "IMG"])
+    #       # "&lt;BR&gt;<A HREF="url"></A>"
+    #
+    def unescapeElement: (string string, *String | Array[String] elements) -> String
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - unescapeHTML(string)
+    # -->
+    # Unescape a string that has been HTML-escaped
+    #     CGI.unescapeHTML("Usage: foo &quot;bar&quot; &lt;baz&gt;")
+    #        # => "Usage: foo \"bar\" <baz>"
+    #
+    def unescapeHTML: (string str) -> String
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - unescapeURIComponent(string, encoding = @@accept_charset)
+    # -->
+    # URL-decode a string following RFC 3986 with encoding(optional).
+    #     string = CGI.unescapeURIComponent("%27Stop%21%27+said%20Fred")
+    #        # => "'Stop!'+said Fred"
+    #
+    def unescapeURIComponent: (string) -> String
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - unescape_element(string, *elements)
+    # -->
+    #
+    alias unescape_element unescapeElement
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - unescape_html(string)
+    # -->
+    #
+    alias unescape_html unescapeHTML
+
+    # <!--
+    #   rdoc-file=lib/cgi/escape.rb
+    #   - unescape_uri_component(string, encoding = @@accept_charset)
+    # -->
+    #
+    alias unescape_uri_component unescapeURIComponent
+  end
+end

data/stdlib/coverage/0/coverage.rbs

@@ -147,8 +147,10 @@
 module Coverage
   # <!--
   #   rdoc-file=ext/coverage/lib/coverage.rb
-  #   - line_stub(file)
+  #   - line_stub(file) -> array
   # -->
+  # A simple helper function that creates the "stub" of line coverage from a given
+  # source code.
   #
   def self.line_stub: (String) -> Array[Integer?]
 
@@ -157,7 +159,7 @@ module Coverage
   #   - Coverage.peek_result  => hash
   # -->
   # Returns a hash that contains filename as key and coverage array as value. This
-  # is the same as `Coverage.result(stop: false, clear: false)`.
+  # is the same as <code>Coverage.result(stop: false, clear: false)</code>.
   #
   #     {
   #       "file.rb" => [1, 2, nil],
@@ -242,8 +244,9 @@ module Coverage
   # -->
   # Returns true if coverage measurement is supported for the given mode.
   #
-  # The mode should be one of the following symbols: `:lines`, `:oneshot_lines`,
-  # `:branches`, `:methods`, `:eval`.
+  # The mode should be one of the following symbols: <code>:lines</code>,
+  # <code>:oneshot_lines</code>, <code>:branches</code>, <code>:methods</code>,
+  # <code>:eval</code>.
   #
   # Example:
   #

data/stdlib/csv/0/csv.rbs

@@ -2964,8 +2964,8 @@ end
 #     table['Name'] = ['Foo', 'Bar', 'Baz']
 #     table['Name'] # => ["Foo", "Bar", "Baz"]
 #
-class CSV::Table[out Elem] < Object
-  include Enumerable[Elem]
+class CSV::Table[out E] < Object
+  include Enumerable[E]
   extend Forwardable
 
   # <!--
@@ -3587,8 +3587,8 @@ class CSV::Table[out Elem] < Object
   # Returns a new Enumerator if no block is given:
   #     table.each # => #<Enumerator: #<CSV::Table mode:col row_count:4>:each>
   #
-  def each: () -> Enumerator[Elem, self]
-          | () { (Elem) -> void } -> self
+  def each: () -> Enumerator[E, self]
+          | () { (E) -> void } -> self
           | () { (*untyped) -> void } -> self
 
   def empty?: (*untyped args) { (*untyped) -> untyped } -> untyped
@@ -3758,7 +3758,7 @@ class CSV::Table[out Elem] < Object
 end
 
 %a{annotate:rdoc:skip}
-class Array[unchecked out Elem] < Object
+class Array[unchecked out E] < Object
   # Equivalent to CSV::generate_line(self, options)
   #
   #   ["CSV", "data"].to_csv