rbs 3.6.1 → 3.9.5

data/stdlib/bigdecimal/0/big_decimal.rbs

@@ -1,155 +1,3 @@
-# <!-- rdoc-file=ext/bigdecimal/bigdecimal.c -->
-# BigDecimal provides arbitrary-precision floating point decimal arithmetic.
-#
-# ## Introduction
-#
-# Ruby provides built-in support for arbitrary precision integer arithmetic.
-#
-# For example:
-#
-#     42**13  #=>   1265437718438866624512
-#
-# BigDecimal provides similar support for very large or very accurate floating
-# point numbers.
-#
-# Decimal arithmetic is also useful for general calculation, because it provides
-# the correct answers people expect--whereas normal binary floating point
-# arithmetic often introduces subtle errors because of the conversion between
-# base 10 and base 2.
-#
-# For example, try:
-#
-#     sum = 0
-#     10_000.times do
-#       sum = sum + 0.0001
-#     end
-#     print sum #=> 0.9999999999999062
-#
-# and contrast with the output from:
-#
-#     require 'bigdecimal'
-#
-#     sum = BigDecimal("0")
-#     10_000.times do
-#       sum = sum + BigDecimal("0.0001")
-#     end
-#     print sum #=> 0.1E1
-#
-# Similarly:
-#
-#     (BigDecimal("1.2") - BigDecimal("1.0")) == BigDecimal("0.2") #=> true
-#
-#     (1.2 - 1.0) == 0.2 #=> false
-#
-# ## A Note About Precision
-#
-# For a calculation using a BigDecimal and another `value`, the precision of the
-# result depends on the type of `value`:
-#
-# *   If `value` is a Float, the precision is Float::DIG + 1.
-# *   If `value` is a Rational, the precision is larger than Float::DIG + 1.
-# *   If `value` is a BigDecimal, the precision is `value`'s precision in the
-#     internal representation, which is platform-dependent.
-# *   If `value` is other object, the precision is determined by the result of
-#     +BigDecimal(value)+.
-#
-#
-# ## Special features of accurate decimal arithmetic
-#
-# Because BigDecimal is more accurate than normal binary floating point
-# arithmetic, it requires some special values.
-#
-# ### Infinity
-#
-# BigDecimal sometimes needs to return infinity, for example if you divide a
-# value by zero.
-#
-#     BigDecimal("1.0") / BigDecimal("0.0")  #=> Infinity
-#     BigDecimal("-1.0") / BigDecimal("0.0")  #=> -Infinity
-#
-# You can represent infinite numbers to BigDecimal using the strings
-# `'Infinity'`, `'+Infinity'` and `'-Infinity'` (case-sensitive)
-#
-# ### Not a Number
-#
-# When a computation results in an undefined value, the special value `NaN` (for
-# 'not a number') is returned.
-#
-# Example:
-#
-#     BigDecimal("0.0") / BigDecimal("0.0") #=> NaN
-#
-# You can also create undefined values.
-#
-# NaN is never considered to be the same as any other value, even NaN itself:
-#
-#     n = BigDecimal('NaN')
-#     n == 0.0 #=> false
-#     n == n #=> false
-#
-# ### Positive and negative zero
-#
-# If a computation results in a value which is too small to be represented as a
-# BigDecimal within the currently specified limits of precision, zero must be
-# returned.
-#
-# If the value which is too small to be represented is negative, a BigDecimal
-# value of negative zero is returned.
-#
-#     BigDecimal("1.0") / BigDecimal("-Infinity") #=> -0.0
-#
-# If the value is positive, a value of positive zero is returned.
-#
-#     BigDecimal("1.0") / BigDecimal("Infinity") #=> 0.0
-#
-# (See BigDecimal.mode for how to specify limits of precision.)
-#
-# Note that `-0.0` and `0.0` are considered to be the same for the purposes of
-# comparison.
-#
-# Note also that in mathematics, there is no particular concept of negative or
-# positive zero; true mathematical zero has no sign.
-#
-# ## bigdecimal/util
-#
-# When you require `bigdecimal/util`, the #to_d method will be available on
-# BigDecimal and the native Integer, Float, Rational, and String classes:
-#
-#     require 'bigdecimal/util'
-#
-#     42.to_d         # => 0.42e2
-#     0.5.to_d        # => 0.5e0
-#     (2/3r).to_d(3)  # => 0.667e0
-#     "0.5".to_d      # => 0.5e0
-#
-# ## Methods for Working with JSON
-#
-# *   [::json_create](rdoc-ref:BigDecimal.json_create): Returns a new BigDecimal
-#     object constructed from the given object.
-# *   [#as_json](rdoc-ref:BigDecimal#as_json): Returns a 2-element hash
-#     representing `self`.
-# *   [#to_json](rdoc-ref:BigDecimal#to_json): Returns a JSON string
-#     representing `self`.
-#
-#
-# These methods are provided by the [JSON gem](https://github.com/flori/json).
-# To make these methods available:
-#
-#     require 'json/add/bigdecimal'
-#
-# *   ## License
-#
-#
-# Copyright (C) 2002 by Shigeo Kobayashi <shigeo@tinyforest.gr.jp>.
-#
-# BigDecimal is released under the Ruby and 2-clause BSD licenses. See
-# LICENSE.txt for details.
-#
-# Maintained by mrkn <mrkn@mrkn.jp> and ruby-core members.
-#
-# Documented by zzak <zachary@zacharyscott.net>, mathew <meta@pobox.com>, and
-# many other contributors.
-#
 class BigDecimal < Numeric
   # <!--
   #   rdoc-file=ext/bigdecimal/bigdecimal.c
@@ -208,14 +56,12 @@ class BigDecimal < Numeric
   # *   BigDecimal::EXCEPTION_ZERODIVIDE.
   # *   BigDecimal::EXCEPTION_ALL.
   #
-  #
   # Values for `setting` for exception handling:
   #
   # *   `true`: sets the given `mode` to `true`.
   # *   `false`: sets the given `mode` to `false`.
   # *   `nil`: does not modify the mode settings.
   #
-  #
   # You can use method BigDecimal.save_exception_mode to temporarily change, and
   # then automatically restore, exception modes.
   #
@@ -226,7 +72,6 @@ class BigDecimal < Numeric
   #
   # *   BigDecimal::ROUND_MODE
   #
-  #
   # You can use method BigDecimal.save_rounding_mode to temporarily change, and
   # then automatically restore, the rounding mode.
   #
@@ -240,7 +85,6 @@ class BigDecimal < Numeric
   # *   `false` (default): Returns `BigDecimal('NaN')`.
   # *   `true`: Raises FloatDomainError.
   #
-  #
   # Examples:
   #
   #     BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false) # => 0
@@ -257,7 +101,6 @@ class BigDecimal < Numeric
   #     `BigDecimal('-Infinity')`.
   # *   `true`: Raises FloatDomainError.
   #
-  #
   # Examples:
   #
   #     BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false)     # => 0
@@ -275,7 +118,6 @@ class BigDecimal < Numeric
   # *   `false` (default): Returns `BigDecimal('0')` or `BigDecimal('-Infinity')`.
   # *   `true`: Raises FloatDomainError.
   #
-  #
   # Examples:
   #
   #     BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false)      # => 0
@@ -296,7 +138,6 @@ class BigDecimal < Numeric
   #     `BigDecimal('-Infinity')`.
   # *   `true`: Raises FloatDomainError.
   #
-  #
   # Examples:
   #
   #     BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false)     # => 0
@@ -317,7 +158,6 @@ class BigDecimal < Numeric
   #     `BigDecimal('-Infinity')`.
   # *   `true`: Raises FloatDomainError.
   #
-  #
   # Examples:
   #
   #     BigDecimal.mode(BigDecimal::EXCEPTION_ALL, false)       # => 0
@@ -1030,16 +870,22 @@ class BigDecimal < Numeric
   #
   # BigDecimal::SIGN_NaN
   # :   value is Not a Number
+  #
   # BigDecimal::SIGN_POSITIVE_ZERO
   # :   value is +0
+  #
   # BigDecimal::SIGN_NEGATIVE_ZERO
   # :   value is -0
+  #
   # BigDecimal::SIGN_POSITIVE_INFINITE
   # :   value is +Infinity
+  #
   # BigDecimal::SIGN_NEGATIVE_INFINITE
   # :   value is -Infinity
+  #
   # BigDecimal::SIGN_POSITIVE_FINITE
   # :   value is positive
+  #
   # BigDecimal::SIGN_NEGATIVE_FINITE
   # :   value is negative
   #
@@ -1403,8 +1249,6 @@ module Kernel
   #     *   Raises an exception if keyword argument `exception` is `true`.
   #     *   Returns `nil` if keyword argument `exception` is `false`.
   #
-  #
-  #
   # Raises an exception if `value` evaluates to a Float and `digits` is larger
   # than Float::DIG + 1.
   #
@@ -1713,11 +1557,11 @@ class Complex
   # -->
   # Returns the quotient of `self` and `numeric`:
   #
-  #     Complex(2, 3)  / Complex(2, 3)  # => ((1/1)+(0/1)*i)
-  #     Complex(900)   / Complex(1)     # => ((900/1)+(0/1)*i)
-  #     Complex(-2, 9) / Complex(-9, 2) # => ((36/85)-(77/85)*i)
-  #     Complex(9, 8)  / 4              # => ((9/4)+(2/1)*i)
-  #     Complex(20, 9) / 9.8            # => (2.0408163265306123+0.9183673469387754i)
+  #     Complex.rect(2, 3)  / Complex.rect(2, 3)  # => (1+0i)
+  #     Complex.rect(900)   / Complex.rect(1)     # => (900+0i)
+  #     Complex.rect(-2, 9) / Complex.rect(-9, 2) # => ((36/85)-(77/85)*i)
+  #     Complex.rect(9, 8)  / 4                   # => ((9/4)+2i)
+  #     Complex.rect(20, 9) / 9.8                 # => (2.0408163265306123+0.9183673469387754i)
   #
   def /: (BigDecimal) -> Complex
     | ...
@@ -1728,11 +1572,11 @@ class Complex
   # -->
   # Returns the product of `self` and `numeric`:
   #
-  #     Complex(2, 3)  * Complex(2, 3)  # => (-5+12i)
-  #     Complex(900)   * Complex(1)     # => (900+0i)
-  #     Complex(-2, 9) * Complex(-9, 2) # => (0-85i)
-  #     Complex(9, 8)  * 4              # => (36+32i)
-  #     Complex(20, 9) * 9.8            # => (196.0+88.2i)
+  #     Complex.rect(2, 3)  * Complex.rect(2, 3)  # => (-5+12i)
+  #     Complex.rect(900)   * Complex.rect(1)     # => (900+0i)
+  #     Complex.rect(-2, 9) * Complex.rect(-9, 2) # => (0-85i)
+  #     Complex.rect(9, 8)  * 4                   # => (36+32i)
+  #     Complex.rect(20, 9) * 9.8                 # => (196.0+88.2i)
   #
   def *: (BigDecimal) -> Complex
     | ...
@@ -1743,11 +1587,11 @@ class Complex
   # -->
   # Returns the sum of `self` and `numeric`:
   #
-  #     Complex(2, 3)  + Complex(2, 3)  # => (4+6i)
-  #     Complex(900)   + Complex(1)     # => (901+0i)
-  #     Complex(-2, 9) + Complex(-9, 2) # => (-11+11i)
-  #     Complex(9, 8)  + 4              # => (13+8i)
-  #     Complex(20, 9) + 9.8            # => (29.8+9i)
+  #     Complex.rect(2, 3)  + Complex.rect(2, 3)  # => (4+6i)
+  #     Complex.rect(900)   + Complex.rect(1)     # => (901+0i)
+  #     Complex.rect(-2, 9) + Complex.rect(-9, 2) # => (-11+11i)
+  #     Complex.rect(9, 8)  + 4                   # => (13+8i)
+  #     Complex.rect(20, 9) + 9.8                 # => (29.8+9i)
   #
   def +: (BigDecimal) -> Complex
     | ...
@@ -1758,11 +1602,11 @@ class Complex
   # -->
   # Returns the difference of `self` and `numeric`:
   #
-  #     Complex(2, 3)  - Complex(2, 3)  # => (0+0i)
-  #     Complex(900)   - Complex(1)     # => (899+0i)
-  #     Complex(-2, 9) - Complex(-9, 2) # => (7+7i)
-  #     Complex(9, 8)  - 4              # => (5+8i)
-  #     Complex(20, 9) - 9.8            # => (10.2+9i)
+  #     Complex.rect(2, 3)  - Complex.rect(2, 3)  # => (0+0i)
+  #     Complex.rect(900)   - Complex.rect(1)     # => (899+0i)
+  #     Complex.rect(-2, 9) - Complex.rect(-9, 2) # => (7+7i)
+  #     Complex.rect(9, 8)  - 4                   # => (5+8i)
+  #     Complex.rect(20, 9) - 9.8                 # => (10.2+9i)
   #
   def -: (BigDecimal) -> Complex
     | ...

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:
@@ -360,7 +370,7 @@ class CGI
   # -->
   # Return the accept character set for all new CGI instances.
   #
-  def self.accept_charset: () -> String
+  def self.accept_charset: () -> encoding
 
   # <!--
   #   rdoc-file=lib/cgi/core.rb
@@ -368,7 +378,7 @@ class CGI
   # -->
   # Set the accept character set for all new CGI instances.
   #
-  def self.accept_charset=: (String accept_charset) -> String
+  def self.accept_charset=: (encoding accept_charset) -> encoding
 
   # <!--
   #   rdoc-file=lib/cgi/core.rb
@@ -385,7 +395,7 @@ class CGI
   # <!-- rdoc-file=lib/cgi/core.rb -->
   # Return the accept character set for this CGI instance.
   #
-  attr_reader accept_charset: String
+  attr_reader accept_charset: encoding
 
   # <!-- rdoc-file=lib/cgi/core.rb -->
   # This method is an alias for #http_header, when HTML5 tag maker is inactive.
@@ -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
     #
@@ -884,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
@@ -907,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 -->

data/stdlib/cgi/0/manifest.yaml

@@ -1,2 +1,3 @@
 dependencies:
   - name: tempfile
+  - name: stringio

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