rbs 2.8.4 → 3.8.1

data/stdlib/uri/0/generic.rbs

@@ -1,6 +1,6 @@
 # <!-- rdoc-file=lib/uri.rb -->
 # URI is a module providing classes to handle Uniform Resource Identifiers
-# ([RFC2396](http://tools.ietf.org/html/rfc2396)).
+# ([RFC2396](https://www.rfc-editor.org/rfc/rfc2396)).
 #
 # ## Features
 #
@@ -9,7 +9,6 @@
 # *   Flexibility to have an alternate URI::Parser (or just different patterns
 #     and regexp's).
 #
-#
 # ## Basic example
 #
 #     require 'uri'
@@ -48,15 +47,14 @@
 # A good place to view an RFC spec is http://www.ietf.org/rfc.html.
 #
 # Here is a list of all related RFC's:
-# *   [RFC822](http://tools.ietf.org/html/rfc822)
-# *   [RFC1738](http://tools.ietf.org/html/rfc1738)
-# *   [RFC2255](http://tools.ietf.org/html/rfc2255)
-# *   [RFC2368](http://tools.ietf.org/html/rfc2368)
-# *   [RFC2373](http://tools.ietf.org/html/rfc2373)
-# *   [RFC2396](http://tools.ietf.org/html/rfc2396)
-# *   [RFC2732](http://tools.ietf.org/html/rfc2732)
-# *   [RFC3986](http://tools.ietf.org/html/rfc3986)
-#
+# *   [RFC822](https://www.rfc-editor.org/rfc/rfc822)
+# *   [RFC1738](https://www.rfc-editor.org/rfc/rfc1738)
+# *   [RFC2255](https://www.rfc-editor.org/rfc/rfc2255)
+# *   [RFC2368](https://www.rfc-editor.org/rfc/rfc2368)
+# *   [RFC2373](https://www.rfc-editor.org/rfc/rfc2373)
+# *   [RFC2396](https://www.rfc-editor.org/rfc/rfc2396)
+# *   [RFC2732](https://www.rfc-editor.org/rfc/rfc2732)
+# *   [RFC3986](https://www.rfc-editor.org/rfc/rfc3986)
 #
 # ## Class tree
 #
@@ -65,31 +63,27 @@
 #     *   URI::FTP - (in uri/ftp.rb)
 #     *   URI::HTTP - (in uri/http.rb)
 #         *   URI::HTTPS - (in uri/https.rb)
-#
 #     *   URI::LDAP - (in uri/ldap.rb)
 #         *   URI::LDAPS - (in uri/ldaps.rb)
-#
 #     *   URI::MailTo - (in uri/mailto.rb)
-#
 # *   URI::Parser - (in uri/common.rb)
 # *   URI::REGEXP - (in uri/common.rb)
 #     *   URI::REGEXP::PATTERN - (in uri/common.rb)
-#
 # *   URI::Util - (in uri/common.rb)
 # *   URI::Error - (in uri/common.rb)
 #     *   URI::InvalidURIError - (in uri/common.rb)
 #     *   URI::InvalidComponentError - (in uri/common.rb)
 #     *   URI::BadURIError - (in uri/common.rb)
 #
-#
-#
 # ## Copyright Info
 #
 # Author
 # :   Akira Yamada <akira@ruby-lang.org>
+#
 # Documentation
 # :   Akira Yamada <akira@ruby-lang.org> Dmitry V. Sabanin <sdmitry@lrn.ru>
 #     Vincent Batts <vbatts@hashbangbash.com>
+#
 # License
 # :   Copyright (c) 2001 akira yamada <akira@ruby-lang.org> You can redistribute
 #     it and/or modify it under the same term as Ruby.
@@ -154,7 +148,7 @@ module URI
     # then it does URI::Escape.escape all URI components and tries again.
     #
     def self.build2: (Array[nil | String | Integer]) -> URI::Generic
-                   | ({ scheme: String?, userinfo: String?, host: String?, port: Integer?, registry: String?, path: String?, opaque: String?, query: String?, fragment: String? }) -> URI::Generic
+                   | ({ scheme: String?, userinfo: String?, host: String?, port: Integer?, registry: String?, path: String?, opaque: String?, query: String?, fragment: String? }) -> instance
 
     # <!--
     #   rdoc-file=lib/uri/generic.rb
@@ -172,7 +166,7 @@ module URI
     # See ::new for hash keys to use or for order of array items.
     #
     def self.build: (Array[nil | String | Integer]) -> URI::Generic
-                  | ({ scheme: String?, userinfo: String?, host: String?, port: Integer?, registry: String?, path: String?, opaque: String?, query: String?, fragment: String? }) -> URI::Generic
+                  | ({ scheme: String?, userinfo: String?, host: String?, port: Integer?, registry: String?, path: String?, opaque: String?, query: String?, fragment: String? }) -> instance
 
     # <!--
     #   rdoc-file=lib/uri/generic.rb
@@ -182,24 +176,34 @@ module URI
     #
     # `scheme`
     # :   Protocol scheme, i.e. 'http','ftp','mailto' and so on.
+    #
     # `userinfo`
     # :   User name and password, i.e. 'sdmitry:bla'.
+    #
     # `host`
     # :   Server host name.
+    #
     # `port`
     # :   Server port.
+    #
     # `registry`
     # :   Registry of naming authorities.
+    #
     # `path`
     # :   Path on server.
+    #
     # `opaque`
     # :   Opaque part.
+    #
     # `query`
     # :   Query data.
+    #
     # `fragment`
     # :   Part of the URI after '#' character.
+    #
     # `parser`
     # :   Parser for internal use [URI::DEFAULT_PARSER by default].
+    #
     # `arg_check`
     # :   Check arguments [false by default].
     #
@@ -510,7 +514,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - user()
     # -->
-    # Returns the user component.
+    # Returns the user component (without URI decoding).
     #
     def user: () -> String?
 
@@ -518,7 +522,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - password()
     # -->
-    # Returns the password component.
+    # Returns the password component (without URI decoding).
     #
     def password: () -> String?
 
@@ -809,7 +813,7 @@ module URI
     # ## Description
     #
     # URI has components listed in order of decreasing significance from left to
-    # right, see RFC3986 https://tools.ietf.org/html/rfc3986 1.2.3.
+    # right, see RFC3986 https://www.rfc-editor.org/rfc/rfc3986 1.2.3.
     #
     # ## Usage
     #

data/stdlib/uri/0/http.rbs

@@ -45,8 +45,8 @@ module URI
     # Currently, if passed userinfo components this method generates invalid HTTP
     # URIs as per RFC 1738.
     #
-    def self.build: (Array[String | Integer] args) -> URI::HTTP
-                  | ({ userinfo: String?, host: String?, port: Integer?, path: String?, query: String?, fragment: String? }) -> URI::HTTP
+    def self.build: (Array[String | Integer] args) -> instance
+                  | ({ userinfo: String?, host: String?, port: Integer?, path: String?, query: String?, fragment: String? }) -> instance
 
     # <!--
     #   rdoc-file=lib/uri/http.rb
@@ -55,7 +55,7 @@ module URI
     # ## Description
     #
     # Returns the authority for an HTTP uri, as defined in
-    # https://datatracker.ietf.org/doc/html/rfc3986/#section-3.2.
+    # https://www.rfc-editor.org/rfc/rfc3986#section-3.2.
     #
     # Example:
     #
@@ -72,7 +72,7 @@ module URI
     # ## Description
     #
     # Returns the origin for an HTTP uri, as defined in
-    # https://datatracker.ietf.org/doc/html/rfc6454.
+    # https://www.rfc-editor.org/rfc/rfc6454.
     #
     # Example:
     #

data/stdlib/uri/0/ldap.rbs

@@ -71,7 +71,7 @@ module URI
     #
     # See also URI::Generic.new.
     #
-    def initialize: (String schema, String? userinfo, String host, Integer? port, String? registry, String? path, String? opaque, String query, String? fragment) -> URI::LDAP
+    def initialize: (String schema, String? userinfo, String host, Integer? port, String? registry, String? path, String? opaque, String query, String? fragment) -> void
 
     # <!--
     #   rdoc-file=lib/uri/ldap.rb

data/stdlib/uri/0/mailto.rbs

@@ -4,5 +4,89 @@ module URI
   # RFC6068, the mailto URL scheme.
   #
   class MailTo < Generic
+    EMAIL_REGEXP: Regexp
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - build(args)
+    # -->
+    # ## Description
+    #
+    # Creates a new URI::MailTo object from components, with syntax checking.
+    #
+    # Components can be provided as an Array or Hash. If an Array is used, the
+    # components must be supplied as `[to, headers]`.
+    #
+    # If a Hash is used, the keys are the component names preceded by colons.
+    #
+    # The headers can be supplied as a pre-encoded string, such as
+    # `"subject=subscribe&cc=address"`, or as an Array of Arrays like `[['subject',
+    # 'subscribe'], ['cc', 'address']]`.
+    #
+    # Examples:
+    #
+    #     require 'uri'
+    #
+    #     m1 = URI::MailTo.build(['joe@example.com', 'subject=Ruby'])
+    #     m1.to_s  # => "mailto:joe@example.com?subject=Ruby"
+    #
+    #     m2 = URI::MailTo.build(['john@example.com', [['Subject', 'Ruby'], ['Cc', 'jack@example.com']]])
+    #     m2.to_s  # => "mailto:john@example.com?Subject=Ruby&Cc=jack@example.com"
+    #
+    #     m3 = URI::MailTo.build({:to => 'listman@example.com', :headers => [['subject', 'subscribe']]})
+    #     m3.to_s  # => "mailto:listman@example.com?subject=subscribe"
+    #
+    def self.build: (Array[String]) -> instance
+                  | ([String, Array[Array[String]]]) -> instance
+                  | (Hash[Symbol, String | Array[Array[String]]]) -> instance
+
+    # <!-- rdoc-file=lib/uri/mailto.rb -->
+    # E-mail headers set by the URL, as an Array of Arrays.
+    #
+    def headers: () -> Array[[String, String]]
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - headers=(v)
+    # -->
+    # Setter for headers `v`.
+    #
+    def headers=: (String) -> String
+
+    # <!-- rdoc-file=lib/uri/mailto.rb -->
+    # The primary e-mail address of the URL, as a String.
+    #
+    def to: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - to=(v)
+    # -->
+    # Setter for to `v`.
+    #
+    def to=: (String) -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - to_mailtext()
+    # -->
+    # Returns the RFC822 e-mail text equivalent of the URL, as a String.
+    #
+    # Example:
+    #
+    #     require 'uri'
+    #
+    #     uri = URI.parse("mailto:ruby-list@ruby-lang.org?Subject=subscribe&cc=myaddr")
+    #     uri.to_mailtext
+    #     # => "To: ruby-list@ruby-lang.org\nSubject: subscribe\nCc: myaddr\n\n\n"
+    #
+    def to_mailtext: () -> String
+
+    # <!--
+    #   rdoc-file=lib/uri/mailto.rb
+    #   - to_rfc822text()
+    # -->
+    #
+    def to_rfc822text: () -> String
   end
 end

data/stdlib/uri/0/rfc2396_parser.rbs

@@ -73,6 +73,7 @@ module URI
     #
     # `str`
     # :   String to make safe
+    #
     # `unsafe`
     # :   Regexp to apply. Defaults to `self.regexp[:UNSAFE]`
     #
@@ -94,6 +95,7 @@ module URI
     #
     # `str`
     # :   String to search
+    #
     # `schemes`
     # :   Patterns to apply to `str`
     #
@@ -173,6 +175,7 @@ module URI
     #
     # `str`
     # :   String to remove escapes from
+    #
     # `escaped`
     # :   Regexp to apply. Defaults to `self.regexp[:ESCAPED]`
     #

data/stdlib/yaml/0/manifest.yaml

@@ -1,3 +1,2 @@
 dependencies:
-  - name: dbm
-  - name: pstore
+  - name: psych

data/stdlib/yaml/0/yaml.rbs

@@ -1,199 +1 @@
-# <!-- rdoc-file=lib/yaml.rb -->
-# YAML Ain't Markup Language
-#
-# This module provides a Ruby interface for data serialization in YAML format.
-#
-# The YAML module is an alias of Psych, the YAML engine for Ruby.
-#
-# ## Usage
-#
-# Working with YAML can be very simple, for example:
-#
-#     require 'yaml'
-#     # Parse a YAML string
-#     YAML.load("--- foo") #=> "foo"
-#
-#     # Emit some YAML
-#     YAML.dump("foo")     # => "--- foo\n...\n"
-#     { :a => 'b'}.to_yaml  # => "---\n:a: b\n"
-#
-# As the implementation is provided by the Psych library, detailed documentation
-# can be found in that library's docs (also part of standard library).
-#
-# ## Security
-#
-# Do not use YAML to load untrusted data. Doing so is unsafe and could allow
-# malicious input to execute arbitrary code inside your application. Please see
-# doc/security.rdoc for more information.
-#
-# ## History
-#
-# Syck was the original YAML implementation in Ruby's standard library developed
-# by why the lucky stiff.
-#
-# You can still use Syck, if you prefer, for parsing and emitting YAML, but you
-# must install the 'syck' gem now in order to use it.
-#
-# In older Ruby versions, ie. <= 1.9, Syck is still provided, however it was
-# completely removed with the release of Ruby 2.0.0.
-#
-# ## More info
-#
-# For more advanced details on the implementation see Psych, and also check out
-# http://yaml.org for spec details and other helpful information.
-#
-# Psych is maintained by Aaron Patterson on github:
-# https://github.com/ruby/psych
-#
-# Syck can also be found on github: https://github.com/ruby/syck
-#
-module YAML
-  # <!--
-  #   rdoc-file=ext/psych/lib/psych.rb
-  #   - Psych.dump(o)               -> string of yaml
-  #   - Psych.dump(o, options)      -> string of yaml
-  #   - Psych.dump(o, io)           -> io object passed in
-  #   - Psych.dump(o, io, options)  -> io object passed in
-  # -->
-  # Dump Ruby object `o` to a YAML string.  Optional `options` may be passed in to
-  # control the output format.  If an IO object is passed in, the YAML will be
-  # dumped to that IO object.
-  #
-  # Currently supported options are:
-  #
-  # `:indentation`
-  # :   Number of space characters used to indent. Acceptable value should be in
-  #     `0..9` range, otherwise option is ignored.
-  #
-  #     Default: `2`.
-  # `:line_width`
-  # :   Max character to wrap line at.
-  #
-  #     Default: `0` (meaning "wrap at 81").
-  # `:canonical`
-  # :   Write "canonical" YAML form (very verbose, yet strictly formal).
-  #
-  #     Default: `false`.
-  # `:header`
-  # :   Write `%YAML [version]` at the beginning of document.
-  #
-  #     Default: `false`.
-  #
-  #
-  # Example:
-  #
-  #     # Dump an array, get back a YAML string
-  #     Psych.dump(['a', 'b'])  # => "---\n- a\n- b\n"
-  #
-  #     # Dump an array to an IO object
-  #     Psych.dump(['a', 'b'], StringIO.new)  # => #<StringIO:0x000001009d0890>
-  #
-  #     # Dump an array with indentation set
-  #     Psych.dump(['a', ['b']], indentation: 3) # => "---\n- a\n-  - b\n"
-  #
-  #     # Dump an array to an IO with indentation set
-  #     Psych.dump(['a', ['b']], StringIO.new, indentation: 3)
-  #
-  %a{annotate:rdoc:copy:Psych.dump}
-  def self.dump: (untyped o, ?indentation: Integer, ?line_width: Integer, ?canonical: bool, ?header: bool) -> String
-               | [IO] (untyped o, IO, ?indentation: Integer, ?line_width: Integer, ?canonical: bool, ?header: bool) -> IO
-
-  # <!--
-  #   rdoc-file=ext/psych/lib/psych.rb
-  #   - load(yaml, permitted_classes: [Symbol], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false)
-  # -->
-  # Load `yaml` in to a Ruby data structure.  If multiple documents are provided,
-  # the object contained in the first document will be returned. `filename` will
-  # be used in the exception message if any exception is raised while parsing.  If
-  # `yaml` is empty, it returns the specified `fallback` return value, which
-  # defaults to `false`.
-  #
-  # Raises a Psych::SyntaxError when a YAML syntax error is detected.
-  #
-  # Example:
-  #
-  #     Psych.load("--- a")             # => 'a'
-  #     Psych.load("---\n - a\n - b")   # => ['a', 'b']
-  #
-  #     begin
-  #       Psych.load("--- `", filename: "file.txt")
-  #     rescue Psych::SyntaxError => ex
-  #       ex.file    # => 'file.txt'
-  #       ex.message # => "(file.txt): found character that cannot start any token"
-  #     end
-  #
-  # When the optional `symbolize_names` keyword argument is set to a true value,
-  # returns symbols for keys in Hash objects (default: strings).
-  #
-  #     Psych.load("---\n foo: bar")                         # => {"foo"=>"bar"}
-  #     Psych.load("---\n foo: bar", symbolize_names: true)  # => {:foo=>"bar"}
-  #
-  # Raises a TypeError when `yaml` parameter is NilClass.  This method is similar
-  # to `safe_load` except that `Symbol` objects are allowed by default.
-  #
-  %a{annotate:rdoc:copy:Psych.load}
-  def self.load: (String yaml, ?filename: String | _ToStr | _ToS?, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
-
-  # <!--
-  #   rdoc-file=ext/psych/lib/psych.rb
-  #   - load_file(filename, **kwargs)
-  # -->
-  # Loads the document contained in `filename`.  Returns the yaml contained in
-  # `filename` as a Ruby object, or if the file is empty, it returns the specified
-  # `fallback` return value, which defaults to `false`. See load for options.
-  #
-  %a{annotate:rdoc:copy:Psych.load_file}
-  def self.load_file: (string | _ToPath, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
-
-  # <!--
-  #   rdoc-file=ext/psych/lib/psych.rb
-  #   - safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false)
-  # -->
-  # Safely load the yaml string in `yaml`.  By default, only the following classes
-  # are allowed to be deserialized:
-  #
-  # *   TrueClass
-  # *   FalseClass
-  # *   NilClass
-  # *   Integer
-  # *   Float
-  # *   String
-  # *   Array
-  # *   Hash
-  #
-  #
-  # Recursive data structures are not allowed by default.  Arbitrary classes can
-  # be allowed by adding those classes to the `permitted_classes` keyword
-  # argument.  They are additive.  For example, to allow Date deserialization:
-  #
-  #     Psych.safe_load(yaml, permitted_classes: [Date])
-  #
-  # Now the Date class can be loaded in addition to the classes listed above.
-  #
-  # Aliases can be explicitly allowed by changing the `aliases` keyword argument.
-  # For example:
-  #
-  #     x = []
-  #     x << x
-  #     yaml = Psych.dump x
-  #     Psych.safe_load yaml               # => raises an exception
-  #     Psych.safe_load yaml, aliases: true # => loads the aliases
-  #
-  # A Psych::DisallowedClass exception will be raised if the yaml contains a class
-  # that isn't in the `permitted_classes` list.
-  #
-  # A Psych::BadAlias exception will be raised if the yaml contains aliases but
-  # the `aliases` keyword argument is set to false.
-  #
-  # `filename` will be used in the exception message if any exception is raised
-  # while parsing.
-  #
-  # When the optional `symbolize_names` keyword argument is set to a true value,
-  # returns symbols for keys in Hash objects (default: strings).
-  #
-  #     Psych.safe_load("---\n foo: bar")                         # => {"foo"=>"bar"}
-  #     Psych.safe_load("---\n foo: bar", symbolize_names: true)  # => {:foo=>"bar"}
-  #
-  %a{annotate:rdoc:copy:Psych.safe_load}
-  def self.safe_load: (String yaml, ?permitted_classes: Array[Class], ?permitted_symbols: Array[Symbol], ?aliases: bool, ?filename: String | _ToStr | _ToS?, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
-end
+module YAML = Psych

data/stdlib/zlib/0/buf_error.rbs

@@ -0,0 +1,10 @@
+%a{annotate:rdoc:skip}
+module Zlib
+  # <!-- rdoc-file=ext/zlib/zlib.c -->
+  # Subclass of Zlib::Error when zlib returns a Z_BUF_ERROR.
+  #
+  # Usually if no progress is possible.
+  #
+  class BufError < Zlib::Error
+  end
+end

data/stdlib/zlib/0/data_error.rbs

@@ -0,0 +1,10 @@
+%a{annotate:rdoc:skip}
+module Zlib
+  # <!-- rdoc-file=ext/zlib/zlib.c -->
+  # Subclass of Zlib::Error when zlib returns a Z_DATA_ERROR.
+  #
+  # Usually if a stream was prematurely freed.
+  #
+  class DataError < Zlib::Error
+  end
+end