rbs 4.0.0.dev.4 → 4.0.0.dev.5

data/stdlib/cgi/0/core.rbs

@@ -1,274 +1,15 @@
-# <!-- rdoc-file=lib/cgi.rb -->
-# ## Overview
+# <!-- rdoc-file=lib/cgi/escape.rb -->
+# Since Ruby 4.0, CGI is a small holder for various escaping methods, included
+# from CGI::Escape
 #
-# The Common Gateway Interface (CGI) is a simple protocol for passing an HTTP
-# request from a web server to a standalone program, and returning the output to
-# the web browser.  Basically, a CGI program is called with the parameters of
-# the request passed in either in the environment (GET) or via $stdin (POST),
-# and everything it prints to $stdout is returned to the client.
+#     require 'cgi/escape'
 #
-# This file holds the CGI class.  This class provides functionality for
-# retrieving HTTP request parameters, managing cookies, and generating HTML
-# output.
+#     CGI.escape("Ruby programming language")
+#     #=> "Ruby+programming+language"
+#     CGI.escapeURIComponent("Ruby programming language")
+#     #=> "Ruby%20programming%20language"
 #
-# The file CGI::Session provides session management functionality; see that
-# class for more details.
-#
-# See http://www.w3.org/CGI/ for more information on the CGI protocol.
-#
-# ## Introduction
-#
-# CGI is a large class, providing several categories of methods, many of which
-# are mixed in from other modules.  Some of the documentation is in this class,
-# some in the modules CGI::QueryExtension and CGI::HtmlExtension.  See
-# CGI::Cookie for specific information on handling cookies, and cgi/session.rb
-# (CGI::Session) for information on sessions.
-#
-# For queries, CGI provides methods to get at environmental variables,
-# parameters, cookies, and multipart request data.  For responses, CGI provides
-# methods for writing output and generating HTML.
-#
-# Read on for more details.  Examples are provided at the bottom.
-#
-# ## Queries
-#
-# The CGI class dynamically mixes in parameter and cookie-parsing functionality,
-#  environmental variable access, and support for parsing multipart requests
-# (including uploaded files) from the CGI::QueryExtension module.
-#
-# ### Environmental Variables
-#
-# The standard CGI environmental variables are available as read-only attributes
-# of a CGI object.  The following is a list of these variables:
-#
-#     AUTH_TYPE               HTTP_HOST          REMOTE_IDENT
-#     CONTENT_LENGTH          HTTP_NEGOTIATE     REMOTE_USER
-#     CONTENT_TYPE            HTTP_PRAGMA        REQUEST_METHOD
-#     GATEWAY_INTERFACE       HTTP_REFERER       SCRIPT_NAME
-#     HTTP_ACCEPT             HTTP_USER_AGENT    SERVER_NAME
-#     HTTP_ACCEPT_CHARSET     PATH_INFO          SERVER_PORT
-#     HTTP_ACCEPT_ENCODING    PATH_TRANSLATED    SERVER_PROTOCOL
-#     HTTP_ACCEPT_LANGUAGE    QUERY_STRING       SERVER_SOFTWARE
-#     HTTP_CACHE_CONTROL      REMOTE_ADDR
-#     HTTP_FROM               REMOTE_HOST
-#
-# For each of these variables, there is a corresponding attribute with the same
-# name, except all lower case and without a preceding HTTP_. `content_length`
-# and `server_port` are integers; the rest are strings.
-#
-# ### Parameters
-#
-# The method #params() returns a hash of all parameters in the request as
-# name/value-list pairs, where the value-list is an Array of one or more values.
-#  The CGI object itself also behaves as a hash of parameter names to values,
-# but only returns a single value (as a String) for each parameter name.
-#
-# For instance, suppose the request contains the parameter "favourite_colours"
-# with the multiple values "blue" and "green".  The following behavior would
-# occur:
-#
-#     cgi.params["favourite_colours"]  # => ["blue", "green"]
-#     cgi["favourite_colours"]         # => "blue"
-#
-# If a parameter does not exist, the former method will return an empty array,
-# the latter an empty string.  The simplest way to test for existence of a
-# parameter is by the #has_key? method.
-#
-# ### Cookies
-#
-# HTTP Cookies are automatically parsed from the request.  They are available
-# from the #cookies() accessor, which returns a hash from cookie name to
-# CGI::Cookie object.
-#
-# ### Multipart requests
-#
-# If a request's method is POST and its content type is multipart/form-data,
-# then it may contain uploaded files.  These are stored by the QueryExtension
-# module in the parameters of the request.  The parameter name is the name
-# attribute of the file input field, as usual.  However, the value is not a
-# string, but an IO object, either an IOString for small files, or a Tempfile
-# for larger ones.  This object also has the additional singleton methods:
-#
-# #local_path()
-# :   the path of the uploaded file on the local filesystem
-#
-# #original_filename()
-# :   the name of the file on the client computer
-#
-# #content_type()
-# :   the content type of the file
-#
-#
-# ## Responses
-#
-# The CGI class provides methods for sending header and content output to the
-# HTTP client, and mixes in methods for programmatic HTML generation from
-# CGI::HtmlExtension and CGI::TagMaker modules.  The precise version of HTML to
-# use for HTML generation is specified at object creation time.
-#
-# ### Writing output
-#
-# The simplest way to send output to the HTTP client is using the #out() method.
-# This takes the HTTP headers as a hash parameter, and the body content via a
-# block.  The headers can be generated as a string using the #http_header()
-# method.  The output stream can be written directly to using the #print()
-# method.
-#
-# ### Generating HTML
-#
-# Each HTML element has a corresponding method for generating that element as a
-# String.  The name of this method is the same as that of the element, all
-# lowercase.  The attributes of the element are passed in as a hash, and the
-# body as a no-argument block that evaluates to a String.  The HTML generation
-# module knows which elements are always empty, and silently drops any passed-in
-# body.  It also knows which elements require matching closing tags and which
-# don't.  However, it does not know what attributes are legal for which
-# elements.
-#
-# There are also some additional HTML generation methods mixed in from the
-# CGI::HtmlExtension module.  These include individual methods for the different
-# types of form inputs, and methods for elements that commonly take particular
-# attributes where the attributes can be directly specified as arguments, rather
-# than via a hash.
-#
-# ### Utility HTML escape and other methods like a function.
-#
-# There are some utility tool defined in cgi/util.rb . And when include, you can
-# use utility methods like a function.
-#
-# ## Examples of use
-#
-# ### Get form values
-#
-#     require "cgi"
-#     cgi = CGI.new
-#     value = cgi['field_name']   # <== value string for 'field_name'
-#       # if not 'field_name' included, then return "".
-#     fields = cgi.keys            # <== array of field names
-#
-#     # returns true if form has 'field_name'
-#     cgi.has_key?('field_name')
-#     cgi.has_key?('field_name')
-#     cgi.include?('field_name')
-#
-# CAUTION! `cgi['field_name']` returned an Array with the old cgi.rb(included in
-# Ruby 1.6)
-#
-# ### Get form values as hash
-#
-#     require "cgi"
-#     cgi = CGI.new
-#     params = cgi.params
-#
-# cgi.params is a hash.
-#
-#     cgi.params['new_field_name'] = ["value"]  # add new param
-#     cgi.params['field_name'] = ["new_value"]  # change value
-#     cgi.params.delete('field_name')           # delete param
-#     cgi.params.clear                          # delete all params
-#
-# ### Save form values to file
-#
-#     require "pstore"
-#     db = PStore.new("query.db")
-#     db.transaction do
-#       db["params"] = cgi.params
-#     end
-#
-# ### Restore form values from file
-#
-#     require "pstore"
-#     db = PStore.new("query.db")
-#     db.transaction do
-#       cgi.params = db["params"]
-#     end
-#
-# ### Get multipart form values
-#
-#     require "cgi"
-#     cgi = CGI.new
-#     value = cgi['field_name']   # <== value string for 'field_name'
-#     value.read                  # <== body of value
-#     value.local_path            # <== path to local file of value
-#     value.original_filename     # <== original filename of value
-#     value.content_type          # <== content_type of value
-#
-# and value has StringIO or Tempfile class methods.
-#
-# ### Get cookie values
-#
-#     require "cgi"
-#     cgi = CGI.new
-#     values = cgi.cookies['name']  # <== array of 'name'
-#       # if not 'name' included, then return [].
-#     names = cgi.cookies.keys      # <== array of cookie names
-#
-# and cgi.cookies is a hash.
-#
-# ### Get cookie objects
-#
-#     require "cgi"
-#     cgi = CGI.new
-#     for name, cookie in cgi.cookies
-#       cookie.expires = Time.now + 30
-#     end
-#     cgi.out("cookie" => cgi.cookies) {"string"}
-#
-#     cgi.cookies # { "name1" => cookie1, "name2" => cookie2, ... }
-#
-#     require "cgi"
-#     cgi = CGI.new
-#     cgi.cookies['name'].expires = Time.now + 30
-#     cgi.out("cookie" => cgi.cookies['name']) {"string"}
-#
-# ### Print http header and html string to $DEFAULT_OUTPUT ($>)
-#
-#     require "cgi"
-#     cgi = CGI.new("html4")  # add HTML generation methods
-#     cgi.out do
-#       cgi.html do
-#         cgi.head do
-#           cgi.title { "TITLE" }
-#         end +
-#         cgi.body do
-#           cgi.form("ACTION" => "uri") do
-#             cgi.p do
-#               cgi.textarea("get_text") +
-#               cgi.br +
-#               cgi.submit
-#             end
-#           end +
-#           cgi.pre do
-#             CGI.escapeHTML(
-#               "params: #{cgi.params.inspect}\n" +
-#               "cookies: #{cgi.cookies.inspect}\n" +
-#               ENV.collect do |key, value|
-#                 "#{key} --> #{value}\n"
-#               end.join("")
-#             )
-#           end
-#         end
-#       end
-#     end
-#
-#     # add HTML generation methods
-#     CGI.new("html3")    # html3.2
-#     CGI.new("html4")    # html4.01 (Strict)
-#     CGI.new("html4Tr")  # html4.01 Transitional
-#     CGI.new("html4Fr")  # html4.01 Frameset
-#     CGI.new("html5")    # html5
-#
-# ### Some utility methods
-#
-#     require 'cgi/util'
-#     CGI.escapeHTML('Usage: foo "bar" <baz>')
-#
-# ### Some utility methods like a function
-#
-#     require 'cgi/util'
-#     include CGI::Util
-#     escapeHTML('Usage: foo "bar" <baz>')
-#     h('Usage: foo "bar" <baz>') # alias
+# See CGI::Escape module for methods list and their description.
 #
 class CGI
   include CGI::Util
@@ -906,66 +647,6 @@ class CGI
                   | (Hash[String, untyped] options_hash) -> void
   end
 
-  module Escape
-    # <!--
-    #   rdoc-file=ext/cgi/escape/escape.c
-    #   - CGI.escape(string) -> string
-    # -->
-    # Returns URL-escaped string (`application/x-www-form-urlencoded`).
-    #
-    def escape: (string str) -> String
-
-    # <!--
-    #   rdoc-file=ext/cgi/escape/escape.c
-    #   - CGI.escapeHTML(string) -> string
-    # -->
-    # Returns HTML-escaped string.
-    #
-    def escapeHTML: (string str) -> String
-
-    # <!--
-    #   rdoc-file=ext/cgi/escape/escape.c
-    #   - CGI.escapeURIComponent(string) -> string
-    # -->
-    # Returns URL-escaped string following RFC 3986.
-    #
-    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
-    # -->
-    # Returns URL-unescaped string (`application/x-www-form-urlencoded`).
-    #
-    def unescape: (string str, ?encoding encoding) -> String
-
-    # <!--
-    #   rdoc-file=ext/cgi/escape/escape.c
-    #   - CGI.unescapeHTML(string) -> string
-    # -->
-    # Returns HTML-unescaped string.
-    #
-    def unescapeHTML: (string str) -> String
-
-    # <!--
-    #   rdoc-file=ext/cgi/escape/escape.c
-    #   - CGI.unescapeURIComponent(string, encoding=@@accept_charset) -> string
-    # -->
-    # 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 -->
   # Exception raised when there is an invalid encoding detected
   #
@@ -1182,45 +863,6 @@ class CGI
   end
 
   module Util
-    include CGI::Escape
-
-    # <!--
-    #   rdoc-file=lib/cgi/util.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/util.rb -->
-    # Synonym for CGI.escapeElement(str)
-    #
-    alias escape_element escapeElement
-
-    # <!-- rdoc-file=lib/cgi/util.rb -->
-    # Synonym for CGI.escapeHTML(str)
-    #
-    alias escape_html escapeHTML
-
-    # <!--
-    #   rdoc-file=lib/cgi/util.rb
-    #   - h(string)
-    # -->
-    #
-    alias h escapeHTML
-
     # <!--
     #   rdoc-file=lib/cgi/util.rb
     #   - pretty(string, shift = " ")
@@ -1255,32 +897,6 @@ class CGI
     #
     def rfc1123_date: (Time time) -> String
 
-    # <!--
-    #   rdoc-file=lib/cgi/util.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/util.rb -->
-    # Synonym for CGI.unescapeElement(str)
-    #
-    alias unescape_element unescapeElement
-
-    # <!-- rdoc-file=lib/cgi/util.rb -->
-    # Synonym for CGI.unescapeHTML(str)
-    #
-    alias unescape_html unescapeHTML
-
     # Abbreviated day-of-week names specified by RFC 822
     RFC822_DAYS: Array[String]
 

data/stdlib/cgi/0/manifest.yaml

@@ -1,3 +1,4 @@
 dependencies:
   - name: tempfile
   - name: stringio
+  - name: cgi-escape

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
+    # (`" "`) are encoded with plus signs (`"+"`)
+    #     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 `'&\"<>`
+    #     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 (`" "`) are encoded
+    # with (`"%20"`)
+    #     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?]