rbs 3.7.0 → 3.8.0.pre.1

data/stdlib/cgi/0/core.rbs

@@ -91,8 +91,10 @@
 #
 # #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
 #
@@ -285,6 +287,7 @@ class CGI
   #     :tag_maker => tag_maker }` Note that it is recommended to use the
   #     `options_hash` form, since it also allows you specify the charset you will
   #     accept.
+  #
   # `options_hash`
   # :   A Hash that recognizes three options:
   #
@@ -303,6 +306,7 @@ class CGI
   #
   #             cgi=CGI.new(:accept_charset => "EUC-JP") # => "EUC-JP"
   #
+  #
   #     `:tag_maker`
   # :       String that specifies which version of the HTML generation methods to
   #         use.  If not specified, no HTML generation methods will be loaded.
@@ -311,16 +315,21 @@ class CGI
   #
   #         "html3"
   # :           HTML 3.x
+  #
   #         "html4"
   # :           HTML 4.0
+  #
   #         "html4Tr"
   # :           HTML 4.0 Transitional
+  #
   #         "html4Fr"
   # :           HTML 4.0 with Framesets
+  #
   #         "html5"
   # :           HTML 5
   #
   #
+  #
   #     `:max_multipart_length`
   # :       Specifies maximum length of multipart data. Can be an Integer scalar
   #         or a lambda, that will be evaluated when the request is parsed. This
@@ -334,6 +343,7 @@ class CGI
   #             cgi=CGI.new(:max_multipart_length => -> {check_filesystem}) # lambda
   #
   #
+  #
   # `block`
   # :   If provided, the block is called when an invalid encoding is encountered.
   #     For example:
@@ -408,72 +418,99 @@ class CGI
   #
   # `content_type_string`
   # :   If this form is used, this string is the `Content-Type`
+  #
   # `headers_hash`
   # :   A Hash of header values. The following header keys are recognized:
   #
   #     type
   # :       The Content-Type header.  Defaults to "text/html"
+  #
   #     charset
   # :       The charset of the body, appended to the Content-Type header.
+  #
   #     nph
   # :       A boolean value.  If true, prepend protocol string and status code,
   #         and date; and sets default values for "server" and "connection" if not
   #         explicitly set.
+  #
   #     status
   # :       The HTTP status code as a String, returned as the Status header.  The
   #         values are:
   #
   #         OK
   # :           200 OK
+  #
   #         PARTIAL_CONTENT
   # :           206 Partial Content
+  #
   #         MULTIPLE_CHOICES
   # :           300 Multiple Choices
+  #
   #         MOVED
   # :           301 Moved Permanently
+  #
   #         REDIRECT
   # :           302 Found
+  #
   #         NOT_MODIFIED
   # :           304 Not Modified
+  #
   #         BAD_REQUEST
   # :           400 Bad Request
+  #
   #         AUTH_REQUIRED
   # :           401 Authorization Required
+  #
   #         FORBIDDEN
   # :           403 Forbidden
+  #
   #         NOT_FOUND
   # :           404 Not Found
+  #
   #         METHOD_NOT_ALLOWED
   # :           405 Method Not Allowed
+  #
   #         NOT_ACCEPTABLE
   # :           406 Not Acceptable
+  #
   #         LENGTH_REQUIRED
   # :           411 Length Required
+  #
   #         PRECONDITION_FAILED
   # :           412 Precondition Failed
+  #
   #         SERVER_ERROR
   # :           500 Internal Server Error
+  #
   #         NOT_IMPLEMENTED
   # :           501 Method Not Implemented
+  #
   #         BAD_GATEWAY
   # :           502 Bad Gateway
+  #
   #         VARIANT_ALSO_VARIES
   # :           506 Variant Also Negotiates
   #
   #
+  #
   #     server
   # :       The server software, returned as the Server header.
+  #
   #     connection
   # :       The connection type, returned as the Connection header (for instance,
   #         "close".
+  #
   #     length
   # :       The length of the content that will be sent, returned as the
   #         Content-Length header.
+  #
   #     language
   # :       The language of the content, returned as the Content-Language header.
+  #
   #     expires
   # :       The time on which the current content expires, as a `Time` object,
   #         returned as the Expires header.
+  #
   #     cookie
   # :       A cookie or cookies, returned as one or more Set-Cookie headers.  The
   #         value can be the literal string of the cookie; a CGI::Cookie object;
@@ -526,8 +563,10 @@ class CGI
   #
   # `content_type_string`
   # :   If a string is passed, it is assumed to be the content type.
+  #
   # `headers_hash`
   # :   This is a Hash of headers, similar to that used by #http_header.
+  #
   # `block`
   # :   A block is required and should evaluate to the body of the response.
   #
@@ -829,25 +868,33 @@ class CGI
     # :   The name of the cookie; in this form, there is no #domain or #expiration.
     #     The #path is gleaned from the `SCRIPT_NAME` environment variable, and
     #     #secure is false.
+    #
     # `*value`
     # :   value or list of values of the cookie
+    #
     # `options_hash`
     # :   A Hash of options to initialize this Cookie.  Possible options are:
     #
     #     name
     # :       the name of the cookie.  Required.
+    #
     #     value
     # :       the cookie's value or list of values.
+    #
     #     path
     # :       the path for which this cookie applies.  Defaults to the value of the
     #         `SCRIPT_NAME` environment variable.
+    #
     #     domain
     # :       the domain for which this cookie applies.
+    #
     #     expires
     # :       the time at which this cookie expires, as a `Time` object.
+    #
     #     secure
     # :       whether this cookie is a secure cookie or not (default to false).
     #         Secure cookies are only transmitted to HTTPS servers.
+    #
     #     httponly
     # :       whether this cookie is a HttpOnly cookie or not (default to
     #

data/stdlib/coverage/0/coverage.rbs

@@ -15,7 +15,6 @@
 #     of line execution by the interpreter. A `nil` value means coverage is
 #     disabled for this line (lines like `else` and `end`).
 #
-#
 # # Examples
 #
 #     [foo.rb]
@@ -95,7 +94,6 @@
 # 5.  The ending line number it appears on in the file.
 # 6.  The ending column number it appears on in the file.
 #
-#
 # ## Methods Coverage
 #
 # Methods coverage reports how many times each method was executed.
@@ -134,7 +132,6 @@
 # 5.  The ending line number the method appears on in the file.
 # 6.  The ending column number the method appears on in the file.
 #
-#
 # ## All Coverage Modes
 #
 # You can also run all modes of coverage simultaneously with this shortcut. Note

data/stdlib/csv/0/csv.rbs

@@ -9,7 +9,6 @@
 # *   A *column* *separator* delimits fields in a row. A common column separator
 #     is the comma character `","`.
 #
-#
 # This CSV String, with row separator `"\n"` and column separator `","`, has
 # three rows and two columns:
 #     "foo,0\nbar,1\nbaz,2\n"
@@ -28,7 +27,6 @@
 #     IO object.
 # *   Generating CSV data to a String object.
 #
-#
 # To make CSV available:
 #     require 'csv'
 #
@@ -51,11 +49,9 @@
 #     *   The outer Array is the entire "table".
 #     *   Each inner Array is a row.
 #     *   Each String is a field.
-#
 # *   A CSV::Table object.  For details, see [\CSV with
 #     Headers](#class-CSV-label-CSV+with+Headers).
 #
-#
 # #### Parsing a String
 #
 # The input to be parsed can be a string:
@@ -168,7 +164,6 @@
 # *   Method CSV.instance returns a new or cached CSV object.
 # *   Method CSV() also returns a new or cached CSV object.
 #
-#
 # ### Instance Methods
 #
 # CSV has three groups of instance methods:
@@ -176,7 +171,6 @@
 # *   Methods included by module Enumerable.
 # *   Methods delegated to class IO. See below.
 #
-#
 # #### Delegated Methods
 #
 # For convenience, a CSV object will delegate to many methods in class IO. (A
@@ -215,7 +209,6 @@
 # *   IO#truncate
 # *   IO#tty?
 #
-#
 # ### Options
 #
 # The default values for options are:
@@ -274,7 +267,6 @@
 # *   `empty_value`: Specifies the object that is to be substituted for each
 #     empty field.
 #
-#
 # ###### Option `row_sep`
 #
 # Specifies the row separator, a String or the Symbol `:auto` (see below), to be
@@ -365,7 +357,6 @@
 # *   Data is `ARGF`, `STDIN`, `STDOUT`, or `STDERR`.
 # *   The stream is only available for output.
 #
-#
 # Obviously, discovery takes a little time. Set manually if speed is important.
 # Also note that IO objects should be opened in binary mode on Windows if this
 # feature will be used as the line-ending translation can cause problems with
@@ -684,7 +675,6 @@
 # *   The converters apply only to the header row.
 # *   The built-in header converters are `:downcase` and `:symbol`.
 #
-#
 # This section assumes prior execution of:
 #     str = <<-EOT
 #     Name,Value
@@ -756,7 +746,6 @@
 # *   If a String, converts it to a Regexp, ignores lines that match it.
 # *   If `nil`, no lines are considered to be comments.
 #
-#
 # Default value:
 #     CSV::DEFAULT_OPTIONS.fetch(:skip_lines) # => nil
 #
@@ -885,7 +874,6 @@
 # *   `write_empty_value`: Specifies the object that is to be substituted for
 #     each empty field.
 #
-#
 # ###### Option `row_sep`
 #
 # Specifies the row separator, a String or the Symbol `:auto` (see below), to be
@@ -976,7 +964,6 @@
 # *   Data is `ARGF`, `STDIN`, `STDOUT`, or `STDERR`.
 # *   The stream is only available for output.
 #
-#
 # Obviously, discovery takes a little time. Set manually if speed is important.
 # Also note that IO objects should be opened in binary mode on Windows if this
 # feature will be used as the line-ending translation can cause problems with
@@ -1231,12 +1218,10 @@
 # *   See [Field Converters](#class-CSV-label-Field+Converters).
 # *   See [Header Converters](#class-CSV-label-Header+Converters).
 #
-#
 # Also by default, each value to be written during generation is written
 # 'as-is'. You can use a *write* *converter* to modify values before writing.
 # *   See [Write Converters](#class-CSV-label-Write+Converters).
 #
-#
 # #### Specifying Converters
 #
 # You can specify converters for parsing or generating in the `options` argument
@@ -1245,14 +1230,12 @@
 # *   Option `header_converters` for converting parsed header values.
 # *   Option `write_converters` for converting values to be written (generated).
 #
-#
 # There are three forms for specifying converters:
 # *   A converter proc: executable code to be used for conversion.
 # *   A converter name: the name of a stored converter.
 # *   A converter list: an array of converter procs, converter names, and
 #     converter lists.
 #
-#
 # ##### Converter Procs
 #
 # This converter proc, `strip_converter`, accepts a value `field` and returns
@@ -1263,7 +1246,6 @@
 # string_converter` specifies that:
 # *   Proc `string_converter` is to be called for each parsed field.
 # *   The converter's return value is to replace the `field` value.
-#
 # Example:
 #     string = " foo , 0 \n bar , 1 \n baz , 2 \n"
 #     array = CSV.parse(string, converters: strip_converter)
@@ -1293,7 +1275,6 @@
 # *   The 1-based line index.
 # *   The field header, if any.
 #
-#
 # ##### Stored Converters
 #
 # A converter may be given a name and stored in a structure where the parsing
@@ -1305,7 +1286,6 @@
 # *   `:float`: converts each String-embedded float into a true Float.
 # *   `:date`: converts each String-embedded date into a true Date.
 # *   `:date_time`: converts each String-embedded date-time into a true DateTime
-#
 # . This example creates a converter proc, then stores it:
 #     strip_converter = proc {|field| field.strip }
 #     CSV::Converters[:strip] = strip_converter
@@ -1320,7 +1300,6 @@
 # *   `:downcase`: Downcases each header.
 # *   `:symbol`: Converts each header to a Symbol.
 #
-#
 # There is no such storage structure for write headers.
 #
 # In order for the parsing methods to access stored converters in
@@ -1338,7 +1317,6 @@
 # *   Names of stored converters.
 # *   Nested converter lists.
 #
-#
 # Examples:
 #     numeric_converters = [:integer, :float]
 #     date_converters = [:date, :date_time]
@@ -1387,7 +1365,6 @@
 #         csv.converters # => [:integer]
 #         csv.read # => [["foo", 0], ["bar", 1], ["baz", 2]]
 #
-#
 # Installing a field converter does not affect already-read rows:
 #     csv = CSV.new(string)
 #     csv.shift # => ["foo", "0"]
@@ -1407,8 +1384,6 @@
 #     *   A Proc field converter.
 #     *   An Array of field converter names.
 #
-#
-#
 # Display:
 #     CSV::Converters.each_pair do |name, value|
 #       if value.kind_of?(Proc)
@@ -1522,7 +1497,6 @@
 #         tbl = CSV.parse(string, headers: true)
 #         tbl.headers # => ["Name", "Count"]
 #
-#
 # ##### Built-In Header Converters
 #
 # The built-in header converters are in Hash CSV::HeaderConverters. The keys
@@ -1547,7 +1521,6 @@
 # *   Removes non-word characters.
 # *   Makes the string into a Symbol.
 #
-#
 # ##### Custom Header Converters
 #
 # You can define a custom header converter:
@@ -1744,15 +1717,12 @@ class CSV < Object
   #     *   Positioned at the beginning. To position at the end, for appending,
   #         use method CSV.generate. For any other positioning, pass a preset
   #         StringIO object instead.
-  #
   # *   Argument `options`: See:
   #     *   [Options for Parsing](#class-CSV-label-Options+for+Parsing)
   #     *   [Options for Generating](#class-CSV-label-Options+for+Generating)
-  #
   #     For performance reasons, the options cannot be overridden in a CSV object,
   #     so those specified here will endure.
   #
-  #
   # In addition to the CSV instance methods, several IO methods are delegated. See
   # [Delegated Methods](#class-CSV-label-Delegated+Methods).
   #
@@ -1793,11 +1763,9 @@ class CSV < Object
   #     *   Positioned at the beginning. To position at the end, for appending,
   #         use method CSV.generate. For any other positioning, pass a preset
   #         StringIO object instead.
-  #
   # *   Argument `options`: see [Options for
   #     Parsing](#class-CSV-label-Options+for+Parsing)
   #
-  #
   # ###### Without Option `headers`
   #
   # Without {option `headers`[}](#class-CSV-label-Option+headers) case.
@@ -1916,11 +1884,9 @@ class CSV < Object
   #     *   Positioned at the beginning. To position at the end, for appending,
   #         use method CSV.generate. For any other positioning, pass a preset
   #         StringIO object instead.
-  #
   # *   Argument `options`: see [Options for
   #     Parsing](#class-CSV-label-Options+for+Parsing)
   #
-  #
   # ###### Without Option `headers`
   #
   # Without option `headers`, returns the first row as a new Array.
@@ -1975,7 +1941,6 @@ class CSV < Object
   # *   A CSV::Table object, if headers are in use.
   # *   An Array of Arrays, otherwise.
   #
-  #
   # The data source must be opened for reading.
   #
   # Without headers:
@@ -2043,7 +2008,6 @@ class CSV < Object
   # *   Argument `row` must be an Array object or a CSV::Row object.
   # *   The output stream must be open for writing.
   #
-  #
   # ---
   #
   # Append Arrays:
@@ -2099,7 +2063,6 @@ class CSV < Object
   # *   Arguments `options`, if given, should be generating options. See [Options
   #     for Generating](#class-CSV-label-Options+for+Generating).
   #
-  #
   # ---
   #
   # Creates a new CSV object via `CSV.new(csv_string, **options)`; calls the block
@@ -2227,7 +2190,6 @@ CSV::VERSION: String
 # *   Fields: each is an object, not necessarily a String.
 # *   Headers: each serves a key, and also need not be a String.
 #
-#
 # ### Instance Methods
 #
 # CSV::Row has three groups of instance methods:
@@ -2238,8 +2200,6 @@ CSV::VERSION: String
 #     *   Array#length
 #     *   Array#size
 #
-#
-#
 # ## Creating a CSV::Row Instance
 #
 # Commonly, a new CSV::Row instance is created by parsing CSV source that has
@@ -2658,7 +2618,6 @@ class CSV::Row < Object
   # *   Header.
   # *   Range of headers.
   #
-  #
   # For `specifier` in one of the first four cases above, returns the result of
   # `self.field(specifier)`;  see #field.
   #
@@ -2765,7 +2724,6 @@ class CSV::Row < Object
   # Returns an ASCII-compatible String showing:
   # *   Class CSV::Row.
   # *   Header-value pairs.
-  #
   # Example:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
   #     table = CSV.parse(source, headers: true)
@@ -2875,7 +2833,6 @@ end
 # *   Rows: each is a Table::Row object.
 # *   Headers: names for the columns.
 #
-#
 # ### Instance Methods
 #
 # CSV::Table has three groups of instance methods:
@@ -2886,8 +2843,6 @@ end
 #     *   Array#length
 #     *   Array#size
 #
-#
-#
 # ## Creating a CSV::Table Instance
 #
 # Commonly, a new CSV::Table instance is created by parsing CSV source using
@@ -2921,7 +2876,6 @@ end
 # *   Column mode.
 # *   Mixed mode (the default for a new table).
 #
-#
 # The access mode for aCSV::Table instance affects the behavior of some of its
 # instance methods:
 # *   #[]
@@ -2931,7 +2885,6 @@ end
 # *   #each
 # *   #values_at
 #
-#
 # ### Row Mode
 #
 # Set a table to row mode with method #by_row!:
@@ -2984,7 +2937,6 @@ end
 # *   A Range index refers to multiple rows.
 # *   A String index refers to a column.
 #
-#
 # Set a table to mixed mode with method #by_col_or_row!:
 #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
 #     table = CSV.parse(source, headers: true)
@@ -3025,7 +2977,6 @@ class CSV::Table[out Elem] < Object
   # *   Argument `array_of_rows` must be an Array of CSV::Row objects.
   # *   Argument `headers`, if given, may be an Array of Strings.
   #
-  #
   # ---
   #
   # Create an empty CSV::Table object:
@@ -3135,7 +3086,6 @@ class CSV::Table[out Elem] < Object
   # *   Access mode: `:row` or `:col_or_row`.
   # *   Return value: *nth* row of the table, if that row exists; otherwise `nil`.
   #
-  #
   # Returns the *nth* row of the table if that row exists:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
   #     table = CSV.parse(source, headers: true)
@@ -3166,7 +3116,6 @@ class CSV::Table[out Elem] < Object
   # *   Return value: *nth* column of the table, if that column exists; otherwise
   #     an Array of `nil` fields of length `self.size`.
   #
-  #
   # Returns the *nth* column of the table if that column exists:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
   #     table = CSV.parse(source, headers: true)
@@ -3190,7 +3139,6 @@ class CSV::Table[out Elem] < Object
   # *   Return value: rows from the table, beginning at row `range.start`, if
   #     those rows exists.
   #
-  #
   # Returns rows from the table, beginning at row `range.first`, if those rows
   # exist:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
@@ -3230,7 +3178,6 @@ class CSV::Table[out Elem] < Object
   # *   Return value: column data from the table, beginning at column
   #     `range.start`, if those columns exist.
   #
-  #
   # Returns column values from the table, if the column exists; the values are
   # arranged by row:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
@@ -3261,7 +3208,6 @@ class CSV::Table[out Elem] < Object
   # *   Access mode: `:col` or `:col_or_row`
   # *   Return value: column data from the table, if that `header` exists.
   #
-  #
   # Returns column values from the table, if the column exists:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
   #     table = CSV.parse(source, headers: true)
@@ -3299,7 +3245,6 @@ class CSV::Table[out Elem] < Object
   # *   Access mode: `:row` or `:col_or_row`.
   # *   Return value: `row`.
   #
-  #
   # If the row exists, it is replaced:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
   #     table = CSV.parse(source, headers: true)
@@ -3341,7 +3286,6 @@ class CSV::Table[out Elem] < Object
   # *   Access mode: `:col`.
   # *   Return value: `array_of_fields`.
   #
-  #
   # If the column exists, it is replaced:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
   #     table = CSV.parse(source, headers: true)
@@ -3380,7 +3324,6 @@ class CSV::Table[out Elem] < Object
   # *   Access mode: `:col` or `:col_or_row`.
   # *   Return value: `field_or_array_of_fields`.
   #
-  #
   # If the column exists, it is replaced:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
   #     table = CSV.parse(source, headers: true)
@@ -3684,7 +3627,6 @@ class CSV::Table[out Elem] < Object
   # *   Access mode: `:row`, `:col`, or `:col_or_row`.
   # *   Size:  Row count, including the header row.
   #
-  #
   # Example:
   #     source = "Name,Value\nfoo,0\nbar,1\nbaz,2\n"
   #     table = CSV.parse(source, headers: true)
@@ -3814,3 +3756,21 @@ class CSV::Table[out Elem] < Object
   #
   def values_at: (*untyped indices_or_headers) -> untyped
 end
+
+%a{annotate:rdoc:skip}
+class Array[unchecked out Elem] < Object
+  # Equivalent to CSV::generate_line(self, options)
+  #
+  #   ["CSV", "data"].to_csv
+  #     #=> "CSV,data\n"
+  def to_csv: (**untyped options) -> String
+end
+
+%a{annotate:rdoc:skip}
+class String
+  # Equivalent to CSV::parse_line(self, options)
+  #
+  #   "CSV,data".parse_csv
+  #     #=> ["CSV", "data"]
+  def parse_csv: (**untyped options) -> ::Array[String?]?
+end