rbs 0.12.0 → 0.14.0

data/stdlib/builtin/thread_group.rbs

@@ -1,11 +1,11 @@
 # [ThreadGroup](ThreadGroup) provides a means of
 # keeping track of a number of threads as a group.
-# 
+#
 # A given [Thread](https://ruby-doc.org/core-2.6.3/Thread.html) object can
 # only belong to one [ThreadGroup](ThreadGroup) at a
 # time; adding a thread to a new group will remove it from any previous
 # group.
-# 
+#
 # Newly created threads belong to the same group as the thread from which
 # they were created.
 class ThreadGroup < Object

data/stdlib/builtin/true_class.rbs

@@ -1,14 +1,14 @@
 # The global value `true` is the only instance of class TrueClass and represents
 # a logically true value in boolean expressions. The class provides operators
 # allowing `true` to be used in logical expressions.
-# 
+#
 class TrueClass
   public
 
   def !: () -> bool
 
   # And---Returns `false` if *obj* is `nil` or `false`, `true` otherwise.
-  # 
+  #
   def &: (nil) -> false
        | (false) -> false
        | (untyped obj) -> bool
@@ -16,12 +16,12 @@ class TrueClass
   # Case Equality -- For class Object, effectively the same as calling `#==`, but
   # typically overridden by descendants to provide meaningful semantics in `case`
   # statements.
-  # 
+  #
   def ===: (true) -> true
          | (untyped obj) -> bool
 
   # Exclusive Or---Returns `true` if *obj* is `nil` or `false`, `false` otherwise.
-  # 
+  #
   def ^: (nil) -> true
        | (false) -> true
        | (untyped obj) -> bool
@@ -29,18 +29,18 @@ class TrueClass
   alias inspect to_s
 
   # The string representation of `true` is "true".
-  # 
+  #
   def to_s: () -> "true"
 
   # Or---Returns `true`. As *obj* is an argument to a method call, it is always
   # evaluated; there is no short-circuit evaluation in this case.
-  # 
+  #
   #     true |  puts("or")
   #     true || puts("logical or")
-  # 
+  #
   # *produces:*
-  # 
+  #
   #     or
-  # 
+  #
   def |: (bool obj) -> bool
 end

data/stdlib/builtin/warning.rbs

@@ -3,7 +3,7 @@
 # module extends itself, making `Warning.warn` available.
 # [\#warn](Warning#method-i-warn) is called for all
 # warnings issued by Ruby. By default, warnings are printed to $stderr.
-# 
+#
 # By overriding [\#warn](Warning#method-i-warn), you
 # can change how warnings are handled by Ruby, either filtering some
 # warnings, and/or outputting warnings somewhere other than $stderr. When

data/stdlib/date/date.rbs

@@ -318,7 +318,7 @@ class Date
   #
   def self.ordinal: (?Integer year, ?Integer yday, ?Integer start) -> Date
 
-  # Parses the given representation of date and time, and creates a date object. 
+  # Parses the given representation of date and time, and creates a date object.
   # This method does not function as a validator.
   #
   # If the optional second argument is true and the detected year is in the range
@@ -448,7 +448,7 @@ class Date
   #
   def +: (Integer | Rational other) -> Date
 
-  # Returns the difference between the two dates if the other is a date object. 
+  # Returns the difference between the two dates if the other is a date object.
   # If the other is a numeric value, returns a date object pointing `other` days
   # before self.  If the other is a fractional number, assumes its precision is at
   # most nanosecond.

data/stdlib/find/find.rbs

@@ -1,12 +1,12 @@
 # The `Find` module supports the top-down traversal of a set of file paths.
-# 
+#
 # For example, to total the size of all files under your home directory,
 # ignoring anything in a "dot" directory (e.g. $HOME/.ssh):
-# 
+#
 #     require 'find'
-# 
+#
 #     total_size = 0
-# 
+#
 #     Find.find(ENV["HOME"]) do |path|
 #       if FileTest.directory?(path)
 #         if File.basename(path).start_with?('.')
@@ -18,23 +18,23 @@
 #         total_size += FileTest.size(path)
 #       end
 #     end
-# 
+#
 module Find
   # Calls the associated block with the name of every file and directory listed as
   # arguments, then recursively on their subdirectories, and so on.
-  # 
+  #
   # Returns an enumerator if no block is given.
-  # 
+  #
   # See the `Find` module documentation for an example.
-  # 
+  #
   def self?.find: (*String | _ToPath paths, ?ignore_error: bool) -> Enumerator[String, nil]
                 | (*String | _ToPath paths, ?ignore_error: bool) { (String arg0) -> void } -> nil
 
   # Skips the current file or directory, restarting the loop with the next entry.
   # If the current file is a directory, that directory will not be recursively
   # entered. Meaningful only within the block associated with Find::find.
-  # 
+  #
   # See the `Find` module documentation for an example.
-  # 
+  #
   def self?.prune: () -> void
 end

data/stdlib/pathname/pathname.rbs

@@ -1077,6 +1077,8 @@ class Pathname
 end
 
 module Kernel
+  private
+
   # Creates a new Pathname object from the given string, `path`, and returns
   # pathname object.
   #

data/stdlib/pty/pty.rbs

@@ -65,34 +65,10 @@ module PTY
   # `raise`
   # :   If `true` and the process identified by `pid` is no longer alive a
   #     PTY::ChildExited is raised.
-  def self.check: (Integer pid) -> (Process::Status | nil)
-                | (Integer pid, FalseClass raise) -> (Process::Status | nil)
-                | (Integer pid, TrueClass raise) -> nil
-
-  # Spawns the specified command on a newly allocated pty. You can also use the
-  # alias ::getpty.
-  #
-  # The command's controlling tty is set to the slave device of the pty and its
-  # standard input/output/error is redirected to the slave device.
   #
-  # `command` and `command_line` are the full commands to run, given a String. Any
-  # additional `arguments` will be passed to the command.
-  #
-  # ### Return values
-  #
-  # In the non-block form this returns an array of size three, `[r, w, pid]`.
-  #
-  # In the block form these same values will be yielded to the block:
-  #
-  # `r`
-  # :   A readable IO that contains the command's standard output and standard
-  #     error
-  # `w`
-  # :   A writable IO that is the command's standard input
-  # `pid`
-  # :   The process identifier for the command.
-  def self.getpty: (*String command) -> [ IO, IO, Integer ]
-                 | (*String command) { ([ IO ,IO , Integer ]) -> untyped } -> untyped
+  def self.check: (Integer pid, ?bool raise) -> Process::Status?
+
+  alias self.getpty self.spawn
 
   # Allocates a pty (pseudo-terminal).
   #
@@ -130,7 +106,7 @@ module PTY
   #       ...
   #     }
   def self.open: () -> [ IO, File ]
-               | () { ([ IO , File ]) -> untyped } -> untyped
+               | [A] () { ([ IO , File ]) -> A } -> A
 
   # Spawns the specified command on a newly allocated pty. You can also use the
   # alias ::getpty.
@@ -155,5 +131,5 @@ module PTY
   # `pid`
   # :   The process identifier for the command.
   def self.spawn: (*String command) -> [ IO, IO, Integer ]
-                | (*String command) {([ IO , IO , Integer ]) -> untyped } -> untyped
+                | (*String command) {([ IO , IO , Integer ]) -> void } -> void
 end

data/stdlib/tmpdir/tmpdir.rbs

@@ -1,13 +1,13 @@
 class Dir
   # Returns the operating system's temporary file path.
-  # 
+  #
   def self.tmpdir: () -> String
 
   # Dir.mktmpdir creates a temporary directory.
-  # 
+  #
   # The directory is created with 0700 permission. Application should not change
   # the permission to make the temporary directory accessible from other users.
-  # 
+  #
   # The prefix and suffix of the name of the directory is specified by the
   # optional first argument, *prefix_suffix*.
   # *   If it is not specified or nil, "d" is used as the prefix and no suffix is
@@ -15,30 +15,30 @@ class Dir
   # *   If it is a string, it is used as the prefix and no suffix is used.
   # *   If it is an array, first element is used as the prefix and second element
   #     is used as a suffix.
-  # 
-  # 
+  #
+  #
   #     Dir.mktmpdir {|dir| dir is ".../d..." }
   #     Dir.mktmpdir("foo") {|dir| dir is ".../foo..." }
   #     Dir.mktmpdir(["foo", "bar"]) {|dir| dir is ".../foo...bar" }
-  # 
+  #
   # The directory is created under Dir.tmpdir or the optional second argument
   # *tmpdir* if non-nil value is given.
-  # 
+  #
   #     Dir.mktmpdir {|dir| dir is "#{Dir.tmpdir}/d..." }
   #     Dir.mktmpdir(nil, "/var/tmp") {|dir| dir is "/var/tmp/d..." }
-  # 
+  #
   # If a block is given, it is yielded with the path of the directory. The
   # directory and its contents are removed using FileUtils.remove_entry before
   # Dir.mktmpdir returns. The value of the block is returned.
-  # 
+  #
   #     Dir.mktmpdir {|dir|
   #       # use the directory...
   #       open("#{dir}/foo", "w") { ... }
   #     }
-  # 
+  #
   # If a block is not given, The path of the directory is returned. In this case,
   # Dir.mktmpdir doesn't remove the directory.
-  # 
+  #
   #     dir = Dir.mktmpdir
   #     begin
   #       # use the directory...
@@ -47,7 +47,7 @@ class Dir
   #       # remove the directory.
   #       FileUtils.remove_entry dir
   #     end
-  # 
+  #
   def self.mktmpdir: (?(String | [ String, String ] | nil), ?String?, ?max_try: Integer?) -> String
                    | [X] (?(String | [ String, String ] | nil), ?String?, ?max_try: Integer?) { (String) -> X } -> X
 end

data/stdlib/uri/generic.rbs

@@ -851,7 +851,7 @@ module URI
     #   uri.coerce("http://foo.com")
     #   #=> [#<URI::HTTP http://foo.com>, #<URI::HTTP http://my.example.com>]
     #
-    def coerce: ((URI::Generic | String) oth) -> Array[URI::Generic]
+    def coerce: (URI::Generic | String oth) -> Array[URI::Generic]
 
     # Returns a proxy URI.
     # The proxy URI is obtained from environment variables such as http_proxy,

data/stdlib/uri/http.rbs

@@ -0,0 +1,158 @@
+# URI is a module providing classes to handle Uniform Resource Identifiers
+# ([RFC2396](http://tools.ietf.org/html/rfc2396)).
+#
+# ## Features
+#
+# *   Uniform way of handling URIs.
+# *   Flexibility to introduce custom URI schemes.
+# *   Flexibility to have an alternate URI::Parser (or just different patterns
+#     and regexp's).
+#
+#
+# ## Basic example
+#
+#     require 'uri'
+#
+#     uri = URI("http://foo.com/posts?id=30&limit=5#time=1305298413")
+#     #=> #<URI::HTTP http://foo.com/posts?id=30&limit=5#time=1305298413>
+#
+#     uri.scheme    #=> "http"
+#     uri.host      #=> "foo.com"
+#     uri.path      #=> "/posts"
+#     uri.query     #=> "id=30&limit=5"
+#     uri.fragment  #=> "time=1305298413"
+#
+#     uri.to_s      #=> "http://foo.com/posts?id=30&limit=5#time=1305298413"
+#
+# ## Adding custom URIs
+#
+#     module URI
+#       class RSYNC < Generic
+#         DEFAULT_PORT = 873
+#       end
+#       @@schemes['RSYNC'] = RSYNC
+#     end
+#     #=> URI::RSYNC
+#
+#     URI.scheme_list
+#     #=> {"FILE"=>URI::File, "FTP"=>URI::FTP, "HTTP"=>URI::HTTP,
+#     #    "HTTPS"=>URI::HTTPS, "LDAP"=>URI::LDAP, "LDAPS"=>URI::LDAPS,
+#     #    "MAILTO"=>URI::MailTo, "RSYNC"=>URI::RSYNC}
+#
+#     uri = URI("rsync://rsync.foo.com")
+#     #=> #<URI::RSYNC rsync://rsync.foo.com>
+#
+# ## RFC References
+#
+# 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)
+#
+#
+# ## Class tree
+#
+# *   URI::Generic (in uri/generic.rb)
+#     *   URI::File - (in uri/file.rb)
+#     *   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::Escape - (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.
+# Revision
+# :   $Id$
+#
+#
+module URI
+  #
+  # The syntax of HTTP URIs is defined in RFC1738 section 3.3.
+  #
+  # Note that the Ruby URI library allows HTTP URLs containing usernames and
+  # passwords. This is not legal as per the RFC, but used to be
+  # supported in Internet Explorer 5 and 6, before the MS04-004 security
+  # update. See <URL:http://support.microsoft.com/kb/834489>.
+  #
+  class HTTP < Generic
+    # A Default port of 80 for URI::HTTP.
+    DEFAULT_PORT: Integer
+
+    # An Array of the available components for URI::HTTP.
+    COMPONENT: Array[Symbol]
+
+    #
+    # == Description
+    #
+    # Creates a new URI::HTTP object from components, with syntax checking.
+    #
+    # The components accepted are userinfo, host, port, path, query, and
+    # fragment.
+    #
+    # The components should be provided either as an Array, or as a Hash
+    # with keys formed by preceding the component names with a colon.
+    #
+    # If an Array is used, the components must be passed in the
+    # order <code>[userinfo, host, port, path, query, fragment]</code>.
+    #
+    # Example:
+    #
+    #     uri = URI::HTTP.build(host: 'www.example.com', path: '/foo/bar')
+    #
+    #     uri = URI::HTTP.build([nil, "www.example.com", nil, "/path",
+    #       "query", 'fragment'])
+    #
+    # 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
+
+    #
+    # == Description
+    #
+    # Returns the full path for an HTTP request, as required by Net::HTTP::Get.
+    #
+    # If the URI contains a query, the full path is URI#path + '?' + URI#query.
+    # Otherwise, the path is simply URI#path.
+    #
+    # Example:
+    #
+    #     uri = URI::HTTP.build(path: '/foo/bar', query: 'test=true')
+    #     uri.request_uri #  => "/foo/bar?test=true"
+    #
+    def request_uri: () -> String
+  end
+end

data/stdlib/uri/https.rbs

@@ -0,0 +1,108 @@
+# URI is a module providing classes to handle Uniform Resource Identifiers
+# ([RFC2396](http://tools.ietf.org/html/rfc2396)).
+#
+# ## Features
+#
+# *   Uniform way of handling URIs.
+# *   Flexibility to introduce custom URI schemes.
+# *   Flexibility to have an alternate URI::Parser (or just different patterns
+#     and regexp's).
+#
+#
+# ## Basic example
+#
+#     require 'uri'
+#
+#     uri = URI("http://foo.com/posts?id=30&limit=5#time=1305298413")
+#     #=> #<URI::HTTP http://foo.com/posts?id=30&limit=5#time=1305298413>
+#
+#     uri.scheme    #=> "http"
+#     uri.host      #=> "foo.com"
+#     uri.path      #=> "/posts"
+#     uri.query     #=> "id=30&limit=5"
+#     uri.fragment  #=> "time=1305298413"
+#
+#     uri.to_s      #=> "http://foo.com/posts?id=30&limit=5#time=1305298413"
+#
+# ## Adding custom URIs
+#
+#     module URI
+#       class RSYNC < Generic
+#         DEFAULT_PORT = 873
+#       end
+#       @@schemes['RSYNC'] = RSYNC
+#     end
+#     #=> URI::RSYNC
+#
+#     URI.scheme_list
+#     #=> {"FILE"=>URI::File, "FTP"=>URI::FTP, "HTTP"=>URI::HTTP,
+#     #    "HTTPS"=>URI::HTTPS, "LDAP"=>URI::LDAP, "LDAPS"=>URI::LDAPS,
+#     #    "MAILTO"=>URI::MailTo, "RSYNC"=>URI::RSYNC}
+#
+#     uri = URI("rsync://rsync.foo.com")
+#     #=> #<URI::RSYNC rsync://rsync.foo.com>
+#
+# ## RFC References
+#
+# 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)
+#
+#
+# ## Class tree
+#
+# *   URI::Generic (in uri/generic.rb)
+#     *   URI::File - (in uri/file.rb)
+#     *   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::Escape - (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.
+# Revision
+# :   $Id$
+#
+#
+module URI
+  # The default port for HTTPS URIs is 443, and the scheme is 'https:' rather
+  # than 'http:'. Other than that, HTTPS URIs are identical to HTTP URIs;
+  # see URI::HTTP.
+  class HTTPS < HTTP
+    # A Default port of 443 for URI::HTTPS
+    DEFAULT_PORT: Integer
+  end
+end