rbs 3.4.4 → 3.5.0.pre.1

data/core/regexp.rbs

@@ -1332,56 +1332,41 @@
 # *   [Rubular](https://rubular.com/).
 #
 class Regexp
-  # <!--
-  #   rdoc-file=re.c
-  #   - Regexp.new(string, options = 0, timeout: nil) -> regexp
-  #   - Regexp.new(regexp, timeout: nil) -> regexp
-  # -->
-  # With argument `string` given, returns a new regexp with the given string and
-  # options:
-  #
-  #     r = Regexp.new('foo') # => /foo/
-  #     r.source              # => "foo"
-  #     r.options             # => 0
-  #
-  # Optional argument `options` is one of the following:
-  #
-  # *   A String of options:
+  # Represents an object's ability to be converted to a `Regexp`.
   #
-  #         Regexp.new('foo', 'i')  # => /foo/i
-  #         Regexp.new('foo', 'im') # => /foo/im
-  #
-  # *   The bit-wise OR of one or more of the constants Regexp::EXTENDED,
-  #     Regexp::IGNORECASE, Regexp::MULTILINE, and Regexp::NOENCODING:
-  #
-  #         Regexp.new('foo', Regexp::IGNORECASE) # => /foo/i
-  #         Regexp.new('foo', Regexp::EXTENDED)   # => /foo/x
-  #         Regexp.new('foo', Regexp::MULTILINE)  # => /foo/m
-  #         Regexp.new('foo', Regexp::NOENCODING)  # => /foo/n
-  #         flags = Regexp::IGNORECASE | Regexp::EXTENDED |  Regexp::MULTILINE
-  #         Regexp.new('foo', flags)              # => /foo/mix
-  #
-  # *   `nil` or `false`, which is ignored.
-  # *   Any other truthy value, in which case the regexp will be case-insensitive.
+  # This is only used in `Regexp.try_convert` and `Regexp.union` within the standard library.
+  interface _ToRegexp
+    # Converts `self` to a `Regexp`.
+    def to_regexp: () -> Regexp
+  end
+
+  class TimeoutError < RegexpError
+  end
+
+  # <!-- rdoc-file=re.c -->
+  # see Regexp.options and Regexp.new
   #
+  EXTENDED: Integer
+
+  # <!-- rdoc-file=re.c -->
+  # see Regexp.options and Regexp.new
   #
-  # If optional keyword argument `timeout` is given, its float value overrides the
-  # timeout interval for the class, Regexp.timeout. If `nil` is passed as
-  # +timeout, it uses the timeout interval for the class, Regexp.timeout.
+  FIXEDENCODING: Integer
+
+  # <!-- rdoc-file=re.c -->
+  # see Regexp.options and Regexp.new
   #
-  # With argument `regexp` given, returns a new regexp. The source, options,
-  # timeout are the same as `regexp`. `options` and `n_flag` arguments are
-  # ineffective.  The timeout can be overridden by `timeout` keyword.
+  IGNORECASE: Integer
+
+  # <!-- rdoc-file=re.c -->
+  # see Regexp.options and Regexp.new
   #
-  #     options = Regexp::MULTILINE
-  #     r = Regexp.new('foo', options, timeout: 1.1) # => /foo/m
-  #     r2 = Regexp.new(r)                           # => /foo/m
-  #     r2.timeout                                   # => 1.1
-  #     r3 = Regexp.new(r, timeout: 3.14)            # => /foo/m
-  #     r3.timeout                                   # => 3.14
+  MULTILINE: Integer
+
+  # <!-- rdoc-file=re.c -->
+  # see Regexp.options and Regexp.new
   #
-  def initialize: (String string, ?String | Integer | nil | false options, ?timeout: Float?) -> Object
-                | (Regexp regexp, ?timeout: Float?) -> void
+  NOENCODING: Integer
 
   # <!--
   #   rdoc-file=re.c
@@ -1444,8 +1429,7 @@ class Regexp
   #     Regexp.last_match('foo') # Raises IndexError.
   #
   def self.last_match: () -> MatchData?
-                     | (Integer n) -> String?
-                     | (interned n) -> String?
+                     | (MatchData::capture capture) -> String?
 
   # <!--
   #   rdoc-file=re.c
@@ -1466,7 +1450,8 @@ class Regexp
   #
   # (*1): https://doi.org/10.1109/SP40001.2021.00032
   #
-  def self.linear_time?: () -> bool
+  def self.linear_time?: (Regexp regex, ?nil, ?timeout: untyped) -> bool
+                       | (string regex, ?int | string | bool | nil options, ?timeout: untyped) -> bool
 
   # <!--
   #   rdoc-file=re.c
@@ -1482,7 +1467,7 @@ class Regexp
   #     r = Regexp.new(Regexp.escape(s)) # => /\\\\\\\*\\\?\\\{\\\}\\\./
   #     r.match(s)                       # => #<MatchData "\\\\\\*\\?\\{\\}\\.">
   #
-  def self.quote: (interned str) -> String
+  alias self.quote self.escape
 
   # <!--
   #   rdoc-file=re.c
@@ -1501,7 +1486,8 @@ class Regexp
   #
   # Raises an exception unless `object.to_regexp` returns a regexp.
   #
-  def self.try_convert: (untyped obj) -> Regexp?
+  def self.try_convert: (Regexp | _ToRegexp regexp_like) -> Regexp
+                      | (untyped other) -> Regexp?
 
   # <!--
   #   rdoc-file=re.c
@@ -1524,7 +1510,7 @@ class Regexp
   #     Regexp.timeout = 1
   #     /^a*b?a*$/ =~ "a" * 100000 + "x" #=> regexp match timeout (RuntimeError)
   #
-  def self.timeout=: (Float?) -> Float?
+  def self.timeout=: [T < _ToF] (T timeout) -> T
 
   # <!--
   #   rdoc-file=re.c
@@ -1558,11 +1544,62 @@ class Regexp
   #
   # If any regexp pattern contains captures, the behavior is unspecified.
   #
-  def self.union: () -> Regexp
-                | (String | Regexp pat1, *String | Regexp pat2) -> Regexp
-                | (::Array[String | Regexp]) -> Regexp
+  def self.union: (*_ToRegexp | string patterns) -> Regexp
+                | (array[_ToRegexp | string] patterns) -> Regexp
+                | (Symbol | [Symbol] symbol_pattern) -> Regexp
 
-  public
+  # <!--
+  #   rdoc-file=re.c
+  #   - Regexp.new(string, options = 0, timeout: nil) -> regexp
+  #   - Regexp.new(regexp, timeout: nil) -> regexp
+  # -->
+  # With argument `string` given, returns a new regexp with the given string and
+  # options:
+  #
+  #     r = Regexp.new('foo') # => /foo/
+  #     r.source              # => "foo"
+  #     r.options             # => 0
+  #
+  # Optional argument `options` is one of the following:
+  #
+  # *   A String of options:
+  #
+  #         Regexp.new('foo', 'i')  # => /foo/i
+  #         Regexp.new('foo', 'im') # => /foo/im
+  #
+  # *   The bit-wise OR of one or more of the constants Regexp::EXTENDED,
+  #     Regexp::IGNORECASE, Regexp::MULTILINE, and Regexp::NOENCODING:
+  #
+  #         Regexp.new('foo', Regexp::IGNORECASE) # => /foo/i
+  #         Regexp.new('foo', Regexp::EXTENDED)   # => /foo/x
+  #         Regexp.new('foo', Regexp::MULTILINE)  # => /foo/m
+  #         Regexp.new('foo', Regexp::NOENCODING)  # => /foo/n
+  #         flags = Regexp::IGNORECASE | Regexp::EXTENDED |  Regexp::MULTILINE
+  #         Regexp.new('foo', flags)              # => /foo/mix
+  #
+  # *   `nil` or `false`, which is ignored.
+  # *   Any other truthy value, in which case the regexp will be case-insensitive.
+  #
+  #
+  # If optional keyword argument `timeout` is given, its float value overrides the
+  # timeout interval for the class, Regexp.timeout. If `nil` is passed as
+  # +timeout, it uses the timeout interval for the class, Regexp.timeout.
+  #
+  # With argument `regexp` given, returns a new regexp. The source, options,
+  # timeout are the same as `regexp`. `options` and `n_flag` arguments are
+  # ineffective.  The timeout can be overridden by `timeout` keyword.
+  #
+  #     options = Regexp::MULTILINE
+  #     r = Regexp.new('foo', options, timeout: 1.1) # => /foo/m
+  #     r2 = Regexp.new(r)                           # => /foo/m
+  #     r2.timeout                                   # => 1.1
+  #     r3 = Regexp.new(r, timeout: 3.14)            # => /foo/m
+  #     r3.timeout                                   # => 3.14
+  #
+  def initialize: (Regexp regexp, ?timeout: _ToF?) -> self
+                | (string pattern, ?int | string | bool | nil options, ?timeout: _ToF?) -> self
+
+  def initialize_copy: (self object) -> self
 
   # <!-- rdoc-file=re.c -->
   # Returns `true` if `object` is another Regexp whose pattern, flags, and
@@ -1648,7 +1685,8 @@ class Regexp
   #     /(?<foo>\w+)\s*=\s*#{r}/ =~ 'x = y'
   #     p foo # Undefined local variable
   #
-  def =~: (String? | Symbol | _ToStr str) -> Integer?
+  def =~: (interned? string) -> Integer?
+        | (nil) -> nil
 
   # <!--
   #   rdoc-file=re.c
@@ -1683,7 +1721,7 @@ class Regexp
   #     /foo/ == Regexp.new('food')                         # => false
   #     /foo/ == Regexp.new("abc".force_encoding("euc-jp")) # => false
   #
-  def eql?: (untyped other) -> bool
+  alias eql? ==
 
   # <!--
   #   rdoc-file=re.c
@@ -1774,8 +1812,9 @@ class Regexp
   #      /(.)(.)(.)/.match("abc")[2] # => "b"
   #      /(.)(.)/.match("abc", 1)[2] # => "c"
   #
-  def match: (String? | Symbol | _ToStr str, ?Integer pos) -> MatchData?
-           | [T] (String? | Symbol | _ToStr str, ?Integer pos) { (MatchData) -> T } -> T?
+  def match: (interned? str, ?int offset) -> MatchData?
+           | [T] (interned? str, ?int offset) { (MatchData matchdata) -> T } -> T?
+           | (nil, ?int offset) ?{ (MatchData matchdata) -> void } -> nil
 
   # <!--
   #   rdoc-file=re.c
@@ -1791,7 +1830,8 @@ class Regexp
   #     /P.../.match?("Ruby")    # => false
   #     $&                       # => nil
   #
-  def match?: (String? | Symbol | _ToStr str, ?Integer pos) -> bool
+  def match?: (interned str, ?int offset) -> bool
+            | (nil, ?int offset) -> false
 
   # <!--
   #   rdoc-file=re.c
@@ -1810,7 +1850,7 @@ class Regexp
   #     /(?<foo>.)(?<foo>.)/.named_captures # => {"foo"=>[1, 2]}
   #     /(.)(.)/.named_captures             # => {}
   #
-  def named_captures: () -> ::Hash[String, ::Array[Integer]]
+  def named_captures: () -> Hash[String, Array[Integer]]
 
   # <!--
   #   rdoc-file=re.c
@@ -1823,7 +1863,7 @@ class Regexp
   #     /(?<foo>.)(?<foo>.)/.names          # => ["foo"]
   #     /(.)(.)/.names                      # => []
   #
-  def names: () -> ::Array[String]
+  def names: () -> Array[String]
 
   # <!--
   #   rdoc-file=re.c
@@ -1933,33 +1973,4 @@ class Regexp
   #     ~ /at/ # => 7
   #
   def ~: () -> Integer?
-
-  private
-
-  def initialize_copy: (self object) -> self
 end
-
-# <!-- rdoc-file=re.c -->
-# see Regexp.options and Regexp.new
-#
-Regexp::EXTENDED: Integer
-
-# <!-- rdoc-file=re.c -->
-# see Regexp.options and Regexp.new
-#
-Regexp::FIXEDENCODING: Integer
-
-# <!-- rdoc-file=re.c -->
-# see Regexp.options and Regexp.new
-#
-Regexp::IGNORECASE: Integer
-
-# <!-- rdoc-file=re.c -->
-# see Regexp.options and Regexp.new
-#
-Regexp::MULTILINE: Integer
-
-# <!-- rdoc-file=re.c -->
-# see Regexp.options and Regexp.new
-#
-Regexp::NOENCODING: Integer

data/core/ruby_vm.rbs

@@ -260,118 +260,118 @@ module RubyVM::AbstractSyntaxTree
     #
     def children: () -> Array[untyped]
   end
+end
 
-  # <!-- rdoc-file=yjit.rb -->
-  # This module allows for introspection of YJIT, CRuby's just-in-time compiler.
-  # Everything in the module is highly implementation specific and the API might
-  # be less stable compared to the standard library.
-  # This module may not exist if YJIT does not support the particular platform
-  # for which CRuby is built.
-  #
-  module YJIT
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - code_gc()
-    # -->
-    # Discard existing compiled code to reclaim memory
-    # and allow for recompilations in the future.
-    #
-    def self.code_gc: () -> void
+# <!-- rdoc-file=yjit.rb -->
+# This module allows for introspection of YJIT, CRuby's just-in-time compiler.
+# Everything in the module is highly implementation specific and the API might
+# be less stable compared to the standard library.
+# This module may not exist if YJIT does not support the particular platform
+# for which CRuby is built.
+#
+module RubyVM::YJIT
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - code_gc()
+  # -->
+  # Discard existing compiled code to reclaim memory
+  # and allow for recompilations in the future.
+  #
+  def self.code_gc: () -> void
 
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - dump_exit_locations(filename)
-    # -->
-    # Marshal dumps exit locations to the given filename.
-    # Usage:
-    # If `--yjit-exit-locations` is passed, a file named
-    # "yjit_exit_locations.dump" will automatically be generated.
-    # If you want to collect traces manually, call `dump_exit_locations`
-    # directly.
-    # Note that calling this in a script will generate stats after the
-    # dump is created, so the stats data may include exits from the
-    # dump itself.
-    # In a script call:
-    #     at_exit do
-    #       RubyVM::YJIT.dump_exit_locations("my_file.dump")
-    #     end
-    #
-    # Then run the file with the following options:
-    #     ruby --yjit --yjit-trace-exits test.rb
-    #
-    # Once the code is done running, use Stackprof to read the dump file.
-    # See Stackprof documentation for options.
-    #
-    def self.dump_exit_locations: (untyped filename) -> void
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - dump_exit_locations(filename)
+  # -->
+  # Marshal dumps exit locations to the given filename.
+  # Usage:
+  # If `--yjit-exit-locations` is passed, a file named
+  # "yjit_exit_locations.dump" will automatically be generated.
+  # If you want to collect traces manually, call `dump_exit_locations`
+  # directly.
+  # Note that calling this in a script will generate stats after the
+  # dump is created, so the stats data may include exits from the
+  # dump itself.
+  # In a script call:
+  #     at_exit do
+  #       RubyVM::YJIT.dump_exit_locations("my_file.dump")
+  #     end
+  #
+  # Then run the file with the following options:
+  #     ruby --yjit --yjit-trace-exits test.rb
+  #
+  # Once the code is done running, use Stackprof to read the dump file.
+  # See Stackprof documentation for options.
+  #
+  def self.dump_exit_locations: (untyped filename) -> void
 
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - enable()
-    # -->
-    # Enable YJIT compilation.
-    #
-    def self.enable: () -> void
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - enable(stats: false)
+  # -->
+  # Enable YJIT compilation.
+  #
+  def self.enable: () -> void
 
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - enabled?()
-    # -->
-    # Check if YJIT is enabled.
-    #
-    def self.enabled?: () -> bool
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - enabled?()
+  # -->
+  # Check if YJIT is enabled.
+  #
+  def self.enabled?: () -> bool
 
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - format_number(pad, number)
-    # -->
-    # Format large numbers with comma separators for readability
-    #
-    def self.format_number: (untyped pad, untyped number) -> untyped
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - format_number(pad, number)
+  # -->
+  # Format large numbers with comma separators for readability
+  #
+  def self.format_number: (untyped pad, untyped number) -> untyped
 
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - format_number_pct(pad, number, total)
-    # -->
-    # Format a number along with a percentage over a total value
-    #
-    def self.format_number_pct: (untyped pad, untyped number, untyped total) -> untyped
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - format_number_pct(pad, number, total)
+  # -->
+  # Format a number along with a percentage over a total value
+  #
+  def self.format_number_pct: (untyped pad, untyped number, untyped total) -> untyped
 
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - reset_stats!()
-    # -->
-    # Discard statistics collected for `--yjit-stats`.
-    #
-    def self.reset_stats!: () -> void
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - reset_stats!()
+  # -->
+  # Discard statistics collected for `--yjit-stats`.
+  #
+  def self.reset_stats!: () -> void
 
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - runtime_stats(context: false)
-    # -->
-    # Return a hash for statistics generated for the `--yjit-stats` command line
-    # option.
-    # Return `nil` when option is not passed or unavailable.
-    #
-    def self.runtime_stats: (?context: bool) -> Hash[untyped, untyped]?
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - runtime_stats(context: false)
+  # -->
+  # Return a hash for statistics generated for the `--yjit-stats` command line
+  # option.
+  # Return `nil` when option is not passed or unavailable.
+  #
+  def self.runtime_stats: (?context: bool) -> Hash[untyped, untyped]?
 
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - stats_enabled?()
-    # -->
-    # Check if `--yjit-stats` is used.
-    #
-    def self.stats_enabled?: () -> bool
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - stats_enabled?()
+  # -->
+  # Check if `--yjit-stats` is used.
+  #
+  def self.stats_enabled?: () -> bool
 
-    # <!--
-    #   rdoc-file=yjit.rb
-    #   - stats_string()
-    # -->
-    # Format and print out counters as a String. This returns a non-empty
-    # content only when `--yjit-stats` is enabled.
-    #
-    def self.stats_string: () -> String
-  end
+  # <!--
+  #   rdoc-file=yjit.rb
+  #   - stats_string()
+  # -->
+  # Format and print out counters as a String. This returns a non-empty
+  # content only when `--yjit-stats` is enabled.
+  #
+  def self.stats_string: () -> String
+end
 
-  module RJIT
-  end
+module RubyVM::RJIT
 end

data/core/string.rbs

@@ -703,7 +703,7 @@ class String
   #
   #     String.new('hello', encoding: 'UTF-8', capacity: 25)
   #
-  def initialize: (?string source, ?encoding: encoding?, ?capacity: int?) -> self
+  def initialize: (?string source, ?encoding: encoding, ?capacity: int) -> void
 
   # <!--
   #   rdoc-file=string.c
@@ -1185,7 +1185,7 @@ class String
   # offset does not land on character (codepoint) boundary, an IndexError will be
   # raised.
   #
-  def bytesplice: (int start, int length, string str) -> String
+  def bytesplice: (Integer start, int length, string str) -> String
                 | (int start, int length, string str, int str_start, int str_length) -> String
                 | (range[int?] range, string str, ?range[int?] str_range) -> String
 
@@ -2098,7 +2098,7 @@ class String
   # Related: String#sub, String#gsub, String#sub!.
   #
   def gsub!: (Regexp | string pattern, string | hash[String, _ToS] replacement) -> self?
-           | (Regexp | string pattern) -> Enumerator[String, self]
+           | (Regexp | string pattern) -> Enumerator[String, self?]
            | (Regexp | string pattern) { (String match) -> _ToS } -> self?
 
   # <!--

data/core/symbol.rbs

@@ -175,7 +175,8 @@ class Symbol
   # Equivalent to `symbol.to_s =~ object`, including possible updates to global
   # variables; see String#=~.
   #
-  def =~: (untyped obj) -> Integer?
+  def =~: (Regexp regex) -> Integer?
+        | [T] (String::_MatchAgainst[self, T] object) -> T
 
   # <!--
   #   rdoc-file=string.c

data/core/thread.rbs

@@ -1437,7 +1437,7 @@ class Thread::ConditionVariable < Object
   #
   # Returns the slept result on `mutex`.
   #
-  def wait: (Thread::Mutex mutex, ?Integer | Float? timeout) -> Integer?
+  def wait: (Thread::Mutex mutex, ?Time::_Timeout? timeout) -> Integer?
 end
 
 # <!-- rdoc-file=thread_sync.c -->

data/core/time.rbs

@@ -389,6 +389,26 @@
 # You can define this method per subclasses, or on the toplevel Time class.
 #
 class Time < Object
+  # A type that's used for timeouts.
+  #
+  # All numeric types implement this, but custom classes can also implement it if desired.
+  #
+  # Usage of `Time::_Timeout` is fairly common throughout the stdlib, such as in `Kernel#sleep`,
+  # `IO#timeout=`, and `TCPSocket#new`'s `connet_timeout` field.
+  interface _Timeout
+    # Returns `[seconds, nanoseconds]`.
+    #
+    # The `seconds` should be a whole number of seconds, whereas the `nanoseconds` should be smaller
+    # than one. For example, `3.125.divmod(1)` would yield `[3, 0.125]`
+    def divmod: (1) -> [int, _TimeoutNSecs]
+  end
+
+  # The nanoseconds part of `Time::_Timeout`'s return value. See it for details
+  interface _TimeoutNSecs
+    # Convert `self` into a whole number of seconds.
+    def *: (1_000_000_000) -> int
+  end
+
   include Comparable
 
   # <!--
@@ -1083,8 +1103,8 @@ class Time < Object
   #     More digits will be truncated, as other operations of `Time`. Ignored
   #     unless the first argument is a string.
   #
-  def initialize: (?Integer? year, ?Integer? month, ?Integer? day, ?Integer? hour, ?Integer? min, ?Numeric? sec, ?String | Integer | nil) -> void
-                | (?Integer? year, ?Integer? month, ?Integer? day, ?Integer? hour, ?Integer? min, ?Numeric? sec, in: String | Integer | nil) -> void
+  def initialize: (?Integer year, ?Integer? month, ?Integer? day, ?Integer? hour, ?Integer? min, ?Numeric? sec, ?String | Integer | nil) -> void
+                | (?Integer year, ?Integer? month, ?Integer? day, ?Integer? hour, ?Integer? min, ?Numeric? sec, in: String | Integer | nil) -> void
                 | (String, ?in: string | int | nil, ?precision: int) -> void
 
   # <!--
@@ -1333,7 +1353,7 @@ class Time < Object
   # The returned array is suitable for use as an argument to Time.utc or
   # Time.local to create a new `Time` object.
   #
-  def to_a: () -> [ Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, bool, String ]
+  def to_a: () -> [ Integer, Integer, Integer, Integer, Integer, Integer, Integer, Integer, bool, String? ]
 
   # <!--
   #   rdoc-file=time.c
@@ -1564,7 +1584,7 @@ class Time < Object
   #     Time.utc(2000, 1, 1).zone # => "UTC"
   #     Time.new(2000, 1, 1).zone # => "Central Standard Time"
   #
-  def zone: () -> String
+  def zone: () -> String?
 
   # <!-- rdoc-file=time.c -->
   # Like Time.utc, except that the returned `Time` object has the local timezone,