rbs 3.9.5 → 3.10.0.pre.1

data/stdlib/optparse/0/optparse.rbs

@@ -96,7 +96,7 @@
 # Used:
 #
 #     $ ruby optparse-test.rb -r
-#     optparse-test.rb:9:in `<main>': missing argument: -r (OptionParser::MissingArgument)
+#     optparse-test.rb:9:in '<main>': missing argument: -r (OptionParser::MissingArgument)
 #     $ ruby optparse-test.rb -r my-library
 #     You required my-library!
 #
@@ -191,7 +191,7 @@
 #     $ ruby optparse-test.rb --user 2
 #     #<struct User id=2, name="Gandalf">
 #     $ ruby optparse-test.rb --user 3
-#     optparse-test.rb:15:in `block in find_user': No User Found for id 3 (RuntimeError)
+#     optparse-test.rb:15:in 'block in find_user': No User Found for id 3 (RuntimeError)
 #
 # ### Store options to a Hash
 #
@@ -1092,7 +1092,7 @@ OptionParser::RequiredArgument: Array[untyped]
 OptionParser::SPLAT_PROC: Proc
 
 # <!-- rdoc-file=lib/optparse.rb -->
-# The version string
+# An alias for compatibility
 #
 OptionParser::Version: String
 

data/stdlib/rdoc/0/code_object.rbs

@@ -30,7 +30,7 @@ module RDoc
     # <!-- rdoc-file=lib/rdoc/code_object.rb -->
     # Our comment
     #
-    attr_reader comment: Markup::Document | Comment | String
+    attr_reader comment: Comment | String
 
     # <!--
     #   rdoc-file=lib/rdoc/code_object.rb
@@ -46,6 +46,6 @@ module RDoc
     # -->
     # Replaces our comment with `comment`, unless it is empty.
     #
-    def comment=: (Markup::Document | Comment | String | nil) -> (Markup::Document | Comment | String)
+    def comment=: (Comment | String | nil) -> (Comment | String | nil)
   end
 end

data/stdlib/rdoc/0/comment.rbs

@@ -20,6 +20,8 @@ module RDoc
     #
     attr_accessor location: String
 
+    alias file location
+
     # <!--
     #   rdoc-file=lib/rdoc/comment.rb
     #   - new(text = nil, location = nil, language = nil)

data/stdlib/rdoc/0/options.rbs

@@ -0,0 +1,76 @@
+%a{annotate:rdoc:skip}
+module RDoc
+  # <!-- rdoc-file=lib/rdoc/options.rb -->
+  # RDoc::Options handles the parsing and storage of options
+  #
+  # ## Saved Options
+  #
+  # You can save some options like the markup format in the `.rdoc_options` file
+  # in your gem.  The easiest way to do this is:
+  #
+  #     rdoc --markup tomdoc --write-options
+  #
+  # Which will automatically create the file and fill it with the options you
+  # specified.
+  #
+  # The following options will not be saved since they interfere with the user's
+  # preferences or with the normal operation of RDoc:
+  #
+  # *   `--coverage-report`
+  # *   `--dry-run`
+  # *   `--encoding`
+  # *   `--force-update`
+  # *   `--format`
+  # *   `--pipe`
+  # *   `--quiet`
+  # *   `--template`
+  # *   `--verbose`
+  #
+  # ## Custom Options
+  #
+  # Generators can hook into RDoc::Options to add generator-specific command line
+  # options.
+  #
+  # When `--format` is encountered in ARGV, RDoc calls ::setup_options on the
+  # generator class to add extra options to the option parser.  Options for custom
+  # generators must occur after `--format`.  `rdoc --help` will list options for
+  # all installed generators.
+  #
+  # Example:
+  #
+  #     class RDoc::Generator::Spellcheck
+  #       RDoc::RDoc.add_generator self
+  #
+  #       def self.setup_options rdoc_options
+  #         op = rdoc_options.option_parser
+  #
+  #         op.on('--spell-dictionary DICTIONARY',
+  #               RDoc::Options::Path) do |dictionary|
+  #           rdoc_options.spell_dictionary = dictionary
+  #         end
+  #       end
+  #     end
+  #
+  # Of course, RDoc::Options does not respond to `spell_dictionary` by default so
+  # you will need to add it:
+  #
+  #     class RDoc::Options
+  #
+  #       ##
+  #       # The spell dictionary used by the spell-checking plugin.
+  #
+  #       attr_accessor :spell_dictionary
+  #
+  #     end
+  #
+  # ## Option Validators
+  #
+  # OptionParser validators will validate and cast user input values.  In addition
+  # to the validators that ship with OptionParser (String, Integer, Float,
+  # TrueClass, FalseClass, Array, Regexp, Date, Time, URI, etc.), RDoc::Options
+  # adds Path, PathArray and Template.
+  #
+  class Options
+    def initialize: (?untyped loaded_options) -> void
+  end
+end

data/stdlib/rdoc/0/rdoc.rbs

@@ -84,7 +84,7 @@ module RDoc
     # -->
     # Starts collecting tokens
     #
-    def collect_tokens: () -> void
+    def collect_tokens: (Symbol) -> void
 
     # <!--
     #   rdoc-file=lib/rdoc/token_stream.rb
@@ -190,7 +190,7 @@ module RDoc
     #
     # Usually this is called by super from a subclass.
     #
-    def initialize: (String text, String name) -> void
+    def initialize: (String text, String name, ?singleton: bool) -> void
 
     # <!--
     #   rdoc-file=lib/rdoc/method_attr.rb
@@ -267,7 +267,7 @@ module RDoc
     # -->
     # Creates a new AnyMethod with a token stream `text` and `name`
     #
-    def initialize: (String? text, String name) -> void
+    def initialize: (String? text, String name, ?singleton: bool) -> void
   end
 
   # <!-- rdoc-file=lib/rdoc/attr.rb -->
@@ -286,7 +286,7 @@ module RDoc
     # Creates a new Attr with body `text`, `name`, read/write status `rw` and
     # `comment`.  `singleton` marks this as a class attribute.
     #
-    def initialize: (String? text, String name, String rw, RDoc::Comment? comment, ?bool `singleton`) -> void
+    def initialize: (String? text, String name, String rw, RDoc::Comment? comment, ?singleton: bool) -> void
   end
 
   # <!-- rdoc-file=lib/rdoc/constant.rb -->
@@ -372,6 +372,8 @@ module RDoc
     #
     attr_accessor old_name: String
 
+    attr_reader singleton: bool
+
     # <!--
     #   rdoc-file=lib/rdoc/alias.rb
     #   - new(text, old_name, new_name, comment, singleton = false)
@@ -379,7 +381,7 @@ module RDoc
     # Creates a new Alias with a token stream of `text` that aliases `old_name` to
     # `new_name`, has `comment` and is a `singleton` context.
     #
-    def initialize: (String? text, String name, String old_name, RDoc::Comment? comment, ?bool `singleton`) -> void
+    def initialize: (String? text, String name, String old_name, RDoc::Comment? comment, ?singleton: bool) -> void
   end
 
   # <!-- rdoc-file=lib/rdoc/stats.rb -->

data/stdlib/rdoc/0/store.rbs

@@ -26,7 +26,7 @@ module RDoc
     # -->
     # Creates a new Store of `type` that will load or save to `path`
     #
-    def initialize: (?String? path, ?Symbol? type) -> void
+    def initialize: (Options, ?path: String? , ?type: Symbol?) -> void
 
     # <!--
     #   rdoc-file=lib/rdoc/store.rb

data/stdlib/resolv/0/resolv.rbs

@@ -427,15 +427,9 @@ end
 class Resolv::DNS::Config::OtherResolvError < Resolv::ResolvError
 end
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Indicates that the DNS response was unable to be decoded.
-#
 class Resolv::DNS::DecodeError < StandardError
 end
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Indicates that the DNS request was unable to be encoded.
-#
 class Resolv::DNS::EncodeError < StandardError
 end
 
@@ -585,9 +579,6 @@ class Resolv::DNS::Message::MessageEncoder
   def initialize: () -> untyped
 end
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# A representation of a DNS name.
-#
 class Resolv::DNS::Name
   # <!--
   #   rdoc-file=lib/resolv.rb
@@ -677,9 +668,6 @@ Resolv::DNS::OpCode::Status: Integer
 
 Resolv::DNS::OpCode::Update: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# A DNS query abstract class.
-#
 class Resolv::DNS::Query
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -817,9 +805,6 @@ class Resolv::DNS::Requester::UnconnectedUDP::Sender < Resolv::DNS::Requester::S
   def initialize: (Resolv::DNS::Message msg, String data, UDPSocket sock, String host, Integer port) -> untyped
 end
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# A DNS resource abstract class.
-#
 class Resolv::DNS::Resource < Resolv::DNS::Query
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -845,25 +830,16 @@ Resolv::DNS::Resource::ClassInsensitiveTypes: Array[singleton(Resolv::DNS::Resou
 
 Resolv::DNS::Resource::ClassValue: Integer?
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# A Query type requesting any RR.
-#
 class Resolv::DNS::Resource::ANY < Resolv::DNS::Query
 end
 
 Resolv::DNS::Resource::ANY::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# The canonical name for an alias.
-#
 class Resolv::DNS::Resource::CNAME < Resolv::DNS::Resource::DomainName
 end
 
 Resolv::DNS::Resource::CNAME::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Domain Name resource abstract class.
-#
 class Resolv::DNS::Resource::DomainName < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -885,9 +861,6 @@ class Resolv::DNS::Resource::DomainName < Resolv::DNS::Resource
   def initialize: (String name) -> untyped
 end
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# A generic resource abstract class.
-#
 class Resolv::DNS::Resource::Generic < Resolv::DNS::Resource
   def self.create: (Integer type_value, Integer class_value) -> Class
 
@@ -911,9 +884,6 @@ class Resolv::DNS::Resource::Generic < Resolv::DNS::Resource
   def initialize: (String data) -> untyped
 end
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Host Information resource.
-#
 class Resolv::DNS::Resource::HINFO < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -942,17 +912,11 @@ end
 
 Resolv::DNS::Resource::HINFO::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# module IN contains ARPA Internet specific RRs.
-#
 module Resolv::DNS::Resource::IN
 end
 
 Resolv::DNS::Resource::IN::ClassValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# IPv4 Address resource
-#
 class Resolv::DNS::Resource::IN::A < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -978,9 +942,6 @@ Resolv::DNS::Resource::IN::A::ClassValue: Integer
 
 Resolv::DNS::Resource::IN::A::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# An IPv6 address record.
-#
 class Resolv::DNS::Resource::IN::AAAA < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -1069,11 +1030,6 @@ Resolv::DNS::Resource::IN::SOA::ClassValue: Integer
 
 Resolv::DNS::Resource::IN::SOA::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# SRV resource record defined in RFC 2782
-#
-# These records identify the hostname and port that a service is available at.
-#
 class Resolv::DNS::Resource::IN::SRV < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -1141,9 +1097,6 @@ Resolv::DNS::Resource::IN::TXT::ClassValue: Integer
 
 Resolv::DNS::Resource::IN::TXT::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Well Known Service resource.
-#
 class Resolv::DNS::Resource::IN::WKS < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -1182,9 +1135,6 @@ Resolv::DNS::Resource::IN::WKS::ClassValue: Integer
 
 Resolv::DNS::Resource::IN::WKS::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Location resource
-#
 class Resolv::DNS::Resource::LOC < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -1243,9 +1193,6 @@ end
 
 Resolv::DNS::Resource::LOC::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Mailing list or mailbox information.
-#
 class Resolv::DNS::Resource::MINFO < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -1273,9 +1220,6 @@ end
 
 Resolv::DNS::Resource::MINFO::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Mail Exchanger resource.
-#
 class Resolv::DNS::Resource::MX < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -1304,25 +1248,16 @@ end
 
 Resolv::DNS::Resource::MX::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# An authoritative name server.
-#
 class Resolv::DNS::Resource::NS < Resolv::DNS::Resource::DomainName
 end
 
 Resolv::DNS::Resource::NS::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# A Pointer to another DNS name.
-#
 class Resolv::DNS::Resource::PTR < Resolv::DNS::Resource::DomainName
 end
 
 Resolv::DNS::Resource::PTR::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Start Of Authority resource.
-#
 class Resolv::DNS::Resource::SOA < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -1380,9 +1315,6 @@ end
 
 Resolv::DNS::Resource::SOA::TypeValue: Integer
 
-# <!-- rdoc-file=lib/resolv.rb -->
-# Unstructured text resource.
-#
 class Resolv::DNS::Resource::TXT < Resolv::DNS::Resource
   def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
 
@@ -1478,6 +1410,9 @@ class Resolv::Hosts
   def initialize: (?String filename) -> untyped
 end
 
+# <!-- rdoc-file=lib/resolv.rb -->
+# The default file name for host names
+#
 Resolv::Hosts::DefaultFileName: String
 
 # <!-- rdoc-file=lib/resolv.rb -->
@@ -1488,6 +1423,13 @@ class Resolv::IPv4
   #   rdoc-file=lib/resolv.rb
   #   - create(arg)
   # -->
+  # Creates a new IPv4 address from `arg` which may be:
+  #
+  # IPv4
+  # :   returns `arg`.
+  #
+  # String
+  # :   `arg` must match the IPv4::Regex constant
   #
   def self.create: (String | instance arg) -> instance
 
@@ -1519,6 +1461,9 @@ class Resolv::IPv4
   def initialize: (String address) -> untyped
 end
 
+# <!-- rdoc-file=lib/resolv.rb -->
+# Regular expression IPv4 addresses must match.
+#
 Resolv::IPv4::Regex: Regexp
 
 # <!-- rdoc-file=lib/resolv.rb -->
@@ -1649,10 +1594,14 @@ class Resolv::LOC::Alt
   #   rdoc-file=lib/resolv.rb
   #   - new(altitude)
   # -->
+  # Internal use; use self.create.
   #
   def initialize: (Integer altitude) -> untyped
 end
 
+# <!-- rdoc-file=lib/resolv.rb -->
+# Regular expression LOC Alt must match.
+#
 Resolv::LOC::Alt::Regex: Regexp
 
 # <!-- rdoc-file=lib/resolv.rb -->
@@ -1701,10 +1650,14 @@ class Resolv::LOC::Coord
   #   rdoc-file=lib/resolv.rb
   #   - new(coordinates,orientation)
   # -->
+  # Internal use; use self.create.
   #
   def initialize: (String coordinates, orientation orientation) -> untyped
 end
 
+# <!-- rdoc-file=lib/resolv.rb -->
+# Regular expression LOC Coord must match.
+#
 Resolv::LOC::Coord::Regex: Regexp
 
 # <!-- rdoc-file=lib/resolv.rb -->
@@ -1746,10 +1699,14 @@ class Resolv::LOC::Size
   #   rdoc-file=lib/resolv.rb
   #   - new(scalar)
   # -->
+  # Internal use; use self.create.
   #
   def initialize: (String scalar) -> untyped
 end
 
+# <!-- rdoc-file=lib/resolv.rb -->
+# Regular expression LOC size must match.
+#
 Resolv::LOC::Size::Regex: Regexp
 
 # <!-- rdoc-file=lib/resolv.rb -->

data/stdlib/ripper/0/ripper.rbs

@@ -247,8 +247,8 @@ class Ripper
       #   - to_a()
       # -->
       #
-      def to_a: () -> [ [ Integer, Integer ], Symbol, String, Ripper::Lexer::State, String ]
-              | () -> [ [ Integer, Integer ], Symbol, String, Ripper::Lexer::State ]
+      def to_a: () -> ( [ [ Integer, Integer ], Symbol, String, Ripper::Lexer::State, String ]
+                      | [ [ Integer, Integer ], Symbol, String, Ripper::Lexer::State ] )
     end
 
     class State
@@ -911,6 +911,7 @@ class Ripper
 
     class CompileError < Error
     end
+
     class Error < StandardError
     end
 
@@ -927,6 +928,7 @@ class Ripper
 
       def match: (?untyped n) -> untyped
     end
+
     class MatchError < Error
     end
     alias self.compile self.new
@@ -949,6 +951,7 @@ class Ripper
 
     def map_tokens: (untyped tokens) -> untyped
   end
+
   interface _Gets
     def gets: (?String sep, ?Integer limit) -> String?
   end

data/stdlib/singleton/0/singleton.rbs

@@ -128,4 +128,7 @@ module Singleton
   end
 end
 
+# <!-- rdoc-file=lib/singleton.rb -->
+# The version string
+#
 Singleton::VERSION: String

data/stdlib/socket/0/socket.rbs

@@ -488,6 +488,13 @@ class Socket < BasicSocket
   #     a timeout is set for each connection attempt and any connection attempt
   #     that exceeds its timeout will be canceled.
   #
+  # :open_timeout
+  # :   Specifies the timeout in seconds from the start of the method execution.
+  #     If this timeout is reached while there are still addresses that have not
+  #     yet been attempted for connection, no further attempts will be made.
+  #     If this option is specified together with other timeout options, an
+  #     `ArgumentError` will be raised.
+  #
   # :fast_fallback
   # :   Enables the Happy Eyeballs Version 2 algorithm (enabled by default).
   #
@@ -504,7 +511,9 @@ class Socket < BasicSocket
   #     }
   #
   def self.tcp: (String host, Integer port, ?String local_host, ?Integer local_port, ?resolv_timeout: Time::_Timeout, ?connect_timeout: Time::_Timeout) -> instance
-              | (String host, Integer port, ?String local_host, ?Integer local_port, ?resolv_timeout: Time::_Timeout, ?connect_timeout: Time::_Timeout) { (instance) -> void } -> void
+              | (String host, Integer port, ?String local_host, ?Integer local_port, ?open_timeout: Time::_Timeout) -> instance
+              | [T] (String host, Integer port, ?String local_host, ?Integer local_port, ?resolv_timeout: Time::_Timeout, ?connect_timeout: Time::_Timeout) { (instance) -> T } -> T
+              | [T] (String host, Integer port, ?String local_host, ?Integer local_port, ?open_timeout: Time::_Timeout) { (instance) -> T } -> T
 
   # <!--
   #   rdoc-file=ext/socket/lib/socket.rb
@@ -3769,6 +3778,9 @@ class Socket::Ifaddr
   # -->
   # Returns the flags of *ifaddr*.
   #
+  # The value is bitwise-or of Socket::IFF_* constants such as
+  # Socket::IFF_LOOPBACK.
+  #
   def flags: () -> Integer
 
   # <!--

data/stdlib/socket/0/tcp_socket.rbs

@@ -38,7 +38,7 @@ class TCPSocket < IPSocket
 
   # <!--
   #   rdoc-file=ext/socket/tcpsocket.c
-  #   - TCPSocket.new(remote_host, remote_port, local_host=nil, local_port=nil, resolv_timeout: nil, connect_timeout: nil, fast_fallback: true)
+  #   - TCPSocket.new(remote_host, remote_port, local_host=nil, local_port=nil, resolv_timeout: nil, connect_timeout: nil, open_timeout: nil, fast_fallback: true)
   # -->
   # Opens a TCP connection to `remote_host` on `remote_port`.  If `local_host` and
   # `local_port` are specified, then those parameters are used on the local end to
@@ -72,8 +72,16 @@ class TCPSocket < IPSocket
   #     a timeout is set for each connection attempt and any connection attempt
   #     that exceeds its timeout will be canceled.
   #
+  # :open_timeout
+  # :   Specifies the timeout in seconds from the start of the method execution.
+  #     If this timeout is reached while there are still addresses that have not
+  #     yet been attempted for connection, no further attempts will be made.
+  #     If this option is specified together with other timeout options, an
+  #     `ArgumentError` will be raised.
+  #
   # :fast_fallback
   # :   Enables the Happy Eyeballs Version 2 algorithm (enabled by default).
   #
-  def initialize: (String remote_host, Integer remote_port, ?String local_host, ?Integer local_port) -> untyped
+  def initialize: (String remote_host, Integer remote_port, ?String local_host, ?Integer local_port, ?fast_fallback: boolish, ?resolv_timeout: Integer, ?connect_timeout: Integer) -> void
+                | (String remote_host, Integer remote_port, ?String local_host, ?Integer local_port, ?fast_fallback: boolish, ?open_timeout: Integer) -> void
 end