rbs 3.7.0 → 3.8.0.pre.1

data/core/regexp.rbs

@@ -41,7 +41,6 @@
 #
 #     See [Regexp Methods](rdoc-ref:regexp/methods.rdoc).
 #
-#
 # ## Regexp Objects
 #
 # A regexp object has:
@@ -54,7 +53,6 @@
 #
 # *   An encoding; see [Encodings](rdoc-ref:Regexp@Encodings).
 #
-#
 # ## Creating a Regexp
 #
 # A regular expression may be created with:
@@ -82,7 +80,6 @@
 #
 # *   Method Regexp.new.
 #
-#
 # ## Method `match`
 #
 # Each of the methods Regexp#match, String#match, and Symbol#match returns a
@@ -118,7 +115,6 @@
 # *   `#match`: see [Method match](rdoc-ref:Regexp@Method+match).
 # *   `#=~`: see [Operator =~](rdoc-ref:Regexp@Operator+-3D~).
 #
-#
 # The affected global variables are:
 #
 # *   `$~`: Returns a MatchData object, or `nil`.
@@ -130,7 +126,6 @@
 #     `nil`. Note that `$0` is quite different; it returns the name of the
 #     currently executing program.
 #
-#
 # Examples:
 #
 #     # Matched string, but no matched groups.
@@ -188,7 +183,6 @@
 # *   [POSIX Bracket Expressions](rdoc-ref:Regexp@POSIX+Bracket+Expressions)
 # *   [Comments](rdoc-ref:Regexp@Comments)
 #
-#
 # ### Special Characters
 #
 # Regexp special characters, called *metacharacters*, have special meanings in
@@ -216,8 +210,9 @@
 #
 # ### Source Literals
 #
-# The source literal largely behaves like a double-quoted string; see [String
-# Literals](rdoc-ref:syntax/literals.rdoc@String+Literals).
+# The source literal largely behaves like a double-quoted string; see
+# [Double-Quoted String
+# Literals](rdoc-ref:syntax/literals.rdoc@Double-Quoted+String+Literals).
 #
 # In particular, a source literal may contain interpolated expressions:
 #
@@ -237,7 +232,6 @@
 #
 #         \w \W \d \D \h \H \S \R
 #
-#
 # ### Character Classes
 #
 # A *character class* is delimited by square brackets; it specifies that certain
@@ -342,7 +336,6 @@
 #         /\R/.match("\u2028") # => #<MatchData "\u2028"> # Line separator (LSEP)
 #         /\R/.match("\u2029") # => #<MatchData "\u2029"> # Paragraph separator (PSEP)
 #
-#
 # ### Anchors
 #
 # An anchor is a metasequence that matches a zero-width position between
@@ -414,7 +407,6 @@
 #         "hello, world".match(/,/, 3)   # => #<MatchData ",">
 #         "hello, world".match(/\G,/, 3) # => nil
 #
-#
 # #### Lookaround Anchors
 #
 # Lookahead anchors:
@@ -427,7 +419,6 @@
 #     characters *do not* match *pat*, but doesn't include those characters in
 #     the matched substring.
 #
-#
 # Lookbehind anchors:
 #
 # *   `(?<=*pat*)`: Positive lookbehind assertion: ensures that the preceding
@@ -438,7 +429,6 @@
 #     characters do not match *pat*, but doesn't include those characters in the
 #     matched substring.
 #
-#
 # The pattern below uses positive lookahead and positive lookbehind to match
 # text appearing in **...** tags without including the tags in the match:
 #
@@ -462,7 +452,6 @@
 #         /(a)\K(b)\Kc/
 #         /(?<=(?<=(a))(b))c/
 #
-#
 # ### Alternation
 #
 # The vertical bar metacharacter (`|`) may be used within parentheses to express
@@ -546,7 +535,6 @@
 #         /\w{1,2}/.match('x')   # => #<MatchData "x">
 #         /\w{1,2}/.match('xyz') # => #<MatchData "xy">
 #
-#
 # #### Greedy, Lazy, or Possessive Matching
 #
 # Quantifier matching may be greedy, lazy, or possessive:
@@ -561,7 +549,6 @@
 #     Possessive quantifiers: `*+`, `++`, `?+`. Note that `{min, max}` and its
 #     variants do *not* support possessive matching.
 #
-#
 # More:
 #
 # *   About greedy and lazy matching, see [Choosing Minimal or Maximal
@@ -575,7 +562,6 @@
 #     gramming%20Languages%20%282nd%20ed.%29%20%5BGoyvaerts%20%26%20Levithan%202
 #     012-09-06%5D.pdf#tutorial-backtrack).
 #
-#
 # ### Groups and Captures
 #
 # A simple regexp has (at most) one match:
@@ -660,7 +646,6 @@
 #     *   The ordinary `\*n`* notation applies only for *n* in range (1..9).
 #     *   The `MatchData[*n*]` notation applies for any non-negative *n*.
 #
-#
 # *   `\0` is a special backreference, referring to the entire matched string;
 #     it may not be used within the regexp itself, but may be used outside it
 #     (for example, in a substitution method call):
@@ -668,7 +653,6 @@
 #         'The cat sat in the hat'.gsub(/[csh]at/, '\0s')
 #         # => "The cats sats in the hats"
 #
-#
 # #### Named Captures
 #
 # As seen above, a capture can be referred to by its number. A capture can also
@@ -733,7 +717,6 @@
 # 5.  The final subexpression `"` now matches the final substring `"`, and the
 #     overall match succeeds.
 #
-#
 # If subexpression `.*` is grouped atomically, the backtracking is disabled, and
 # the overall match fails:
 #
@@ -775,7 +758,6 @@
 # 9.  Matches the fourth character in the string, `')'`.
 # 10. Matches the end of the string.
 #
-#
 # See [Subexpression
 # calls](https://learnbyexample.github.io/Ruby_Regexp/groupings-and-backreferenc
 # es.html?highlight=subexpression#subexpression-calls).
@@ -789,7 +771,6 @@
 #     match to be applied is *no*.
 # *   If not needed, `|*no`* may be omitted.
 #
-#
 # Examples:
 #
 #     re = /\A(foo)?(?(1)(T)|(F))\z/
@@ -852,7 +833,6 @@
 # *   `/\p{Upper}/`: Uppercase alphabetical
 # *   `/\p{XDigit}/`: Digit allowed in a hexadecimal number (i.e., 0-9a-fA-F)
 #
-#
 # These are also commonly used:
 #
 # *   `/\p{Emoji}/`: Unicode emoji.
@@ -866,18 +846,14 @@
 #         *   `Decimal Number` (`Nd`)
 #         *   `Connector Punctuation` (`Pc`).
 #
-#
 #     *   Unicode properties:
 #         *   `Alpha`
 #         *   `Join_Control`
 #
-#
-#
 # *   `/\p{ASCII}/`: A character in the ASCII character set.
 # *   `/\p{Any}/`: Any Unicode character (including unassigned characters).
 # *   `/\p{Assigned}/`: An assigned character.
 #
-#
 # #### Unicode Character Categories
 #
 # A Unicode character category name:
@@ -886,7 +862,6 @@
 # *   Is case-insensitive.
 # *   Treats a space, a hyphen, and an underscore as equivalent.
 #
-#
 # Examples:
 #
 #     /\p{lu}/                # => /\p{lu}/
@@ -908,7 +883,6 @@
 # *   [Lu, Titlecase_Letter](https://www.compart.com/en/unicode/category/Lt).
 # *   [Lu, Uppercase_Letter](https://www.compart.com/en/unicode/category/Lu).
 #
-#
 # Marks:
 #
 # *   `M`, `Mark`: `Mc`, `Me`, or `Mn`.
@@ -916,7 +890,6 @@
 # *   [Me, Enclosing_Mark](https://www.compart.com/en/unicode/category/Me).
 # *   [Mn, Nonapacing_Mark](https://www.compart.com/en/unicode/category/Mn).
 #
-#
 # Numbers:
 #
 # *   `N`, `Number`: `Nd`, `Nl`, or `No`.
@@ -924,7 +897,6 @@
 # *   [Nl, Letter_Number](https://www.compart.com/en/unicode/category/Nl).
 # *   [No, Other_Number](https://www.compart.com/en/unicode/category/No).
 #
-#
 # Punctation:
 #
 # *   `P`, `Punctuation`: `Pc`, `Pd`, `Pe`, `Pf`, `Pi`, `Po`, or `Ps`.
@@ -955,7 +927,6 @@
 # *   [Co, Private_Use](https://www.compart.com/en/unicode/category/Co).
 # *   [Cs, Surrogate](https://www.compart.com/en/unicode/category/Cs).
 #
-#
 # #### Unicode Scripts and Blocks
 #
 # Among the Unicode properties are:
@@ -965,7 +936,6 @@
 # *   [Unicode blocks](https://en.wikipedia.org/wiki/Unicode_block); see
 #     [supported blocks](http://www.unicode.org/Public/UNIDATA/Blocks.txt).
 #
-#
 # ### POSIX Bracket Expressions
 #
 # A POSIX *bracket expression* is also similar to a character class. These
@@ -976,7 +946,6 @@
 # *   `/[[:digit:]]/` matches any character in the Unicode `Decimal Number`
 #     (`Nd`) category; see below.
 #
-#
 # The POSIX bracket expressions:
 #
 # *   `/[[:digit:]]/`: Matches a [Unicode
@@ -1030,7 +999,6 @@
 # *   `/[[:punct:]]/`: Matches any (Unicode punctuation
 #     character}[https://www.compart.com/en/unicode/category/Po]:
 #
-#
 # Ruby also supports these (non-POSIX) bracket expressions:
 #
 # *   `/[[:ascii:]]/`: Matches a character in the ASCII character set.
@@ -1042,14 +1010,10 @@
 #         *   `Decimal Number` (`Nd`)
 #         *   `Connector Punctuation` (`Pc`).
 #
-#
 #     *   Unicode properties:
 #         *   `Alpha`
 #         *   `Join_Control`
 #
-#
-#
-#
 # ### Comments
 #
 # A comment may be included in a regexp pattern using the `(?#`*comment*`)`
@@ -1073,7 +1037,6 @@
 # *   `o`: `/*pattern*/o` sets [Interpolation
 #     Mode](rdoc-ref:Regexp@Interpolation+Mode).
 #
-#
 # Any, all, or none of these may be applied.
 #
 # Modifiers `i`, `m`, and `x` may be applied to subexpressions:
@@ -1084,7 +1047,6 @@
 # *   `(?-*modifier*:*subexp*)` turns the mode "off" for *subexp* within the
 #     group
 #
-#
 # Example:
 #
 #     re = /(?i)te(?-i)st/
@@ -1126,7 +1088,6 @@
 #
 #         /a.c/m.match("a\nc") # => #<MatchData "a\nc">
 #
-#
 # Unlike other languages, the modifier `m` does not affect the anchors `^` and
 # `$`. These anchors always match at line-boundaries in Ruby.
 #
@@ -1138,7 +1099,6 @@
 # *   Character `#` marks the remainder of its containing line as a comment,
 #     which is also to be ignored for matching purposes.
 #
-#
 # In extended mode, whitespace and comments may be used to form a
 # self-documented regexp.
 #
@@ -1219,7 +1179,6 @@
 #
 #         /foo/s.encoding # => #<Encoding:Windows-31J>
 #
-#
 # A regexp can be matched against a target string when either:
 #
 # *   They have the same encoding.
@@ -1227,7 +1186,6 @@
 #     ASCII characters. Method Regexp#fixed_encoding? returns whether the regexp
 #     has a *fixed* encoding.
 #
-#
 # If a match between incompatible encodings is attempted an
 # `Encoding::CompatibilityError` exception is raised.
 #
@@ -1270,7 +1228,6 @@
 #         re = Regexp.new('foo', timeout: 5.0)
 #         re.timeout # => 5.0
 #
-#
 # When regexp.timeout is `nil`, the timeout "falls through" to Regexp.timeout;
 # when regexp.timeout is non-`nil`, that value controls timing out:
 #
@@ -1300,7 +1257,6 @@
 # *   No nested quantifiers with counting (i.e. no nested `{n}`, `{min,}`,
 #     `{,max}`, or `{min,max}` style quantifiers)
 #
-#
 # You can use method Regexp.linear_time? to determine whether a pattern meets
 # these criteria:
 #
@@ -1326,7 +1282,6 @@
 #     ming%20Languages%20%282nd%20ed.%29%20%5BGoyvaerts%20%26%20Levithan%202012-
 #     09-06%5D.pdf) by Jan Goyvaerts & Steven Levithan.
 #
-#
 # Explore, test (interactive online editor):
 #
 # *   [Rubular](https://rubular.com/).
@@ -1398,7 +1353,7 @@ class Regexp
   #   - Regexp.last_match(n) -> string or nil
   #   - Regexp.last_match(name) -> string or nil
   # -->
-  # With no argument, returns the value of `$!`, which is the result of the most
+  # With no argument, returns the value of `$~`, which is the result of the most
   # recent pattern match (see [Regexp global
   # variables](rdoc-ref:Regexp@Global+Variables)):
   #
@@ -1580,7 +1535,6 @@ class Regexp
   # *   `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.
@@ -1654,7 +1608,6 @@ class Regexp
   #     interpolation](rdoc-ref:Regexp@Interpolation+Mode).
   # *   Is at the left of the expression.
   #
-  #
   # Example:
   #
   #     /(?<lhs>\w+)\s*=\s*(?<rhs>\w+)/ =~ '  x = y  '
@@ -1843,7 +1796,6 @@ class Regexp
   # *   Each key is the name of a named capture.
   # *   Each value is an array of integer indexes for that named capture.
   #
-  #
   # Examples:
   #
   #     /(?<foo>.)(?<bar>.)/.named_captures # => {"foo"=>[1], "bar"=>[2]}

data/core/ruby_vm.rbs

@@ -257,28 +257,35 @@ class RubyVM::InstructionSequence < Object
   # :   A string identifying the data format. **Always
   #     `YARVInstructionSequence/SimpleDataFormat`.**
   #
+  #
   # major_version
   # :   The major version of the instruction sequence.
   #
+  #
   # minor_version
   # :   The minor version of the instruction sequence.
   #
+  #
   # format_type
   # :   A number identifying the data format. **Always 1**.
   #
+  #
   # misc
   # :   A hash containing:
   #
   #     `:arg_size`
   # :       the total number of arguments taken by the method or the block (0 if
   #         *iseq* doesn't represent a method or block)
+  #
   #     `:local_size`
   # :       the number of local variables + 1
+  #
   #     `:stack_max`
   # :       used in calculating the stack depth at which a SystemStackError is
   #         thrown.
   #
   #
+  #
   # #label
   # :   The name of the context (block, method, class, module, etc.) that this
   #     instruction sequence belongs to.
@@ -286,41 +293,49 @@ class RubyVM::InstructionSequence < Object
   #     `<main>` if it's at the top level, `<compiled>` if it was evaluated from a
   #     string.
   #
+  #
   # #path
   # :   The relative path to the Ruby file where the instruction sequence was
   #     loaded from.
   #
   #     `<compiled>` if the iseq was evaluated from a string.
   #
+  #
   # #absolute_path
   # :   The absolute path to the Ruby file where the instruction sequence was
   #     loaded from.
   #
   #     `nil` if the iseq was evaluated from a string.
   #
+  #
   # #first_lineno
   # :   The number of the first source line where the instruction sequence was
   #     loaded from.
   #
+  #
   # type
   # :   The type of the instruction sequence.
   #
   #     Valid values are `:top`, `:method`, `:block`, `:class`, `:rescue`,
   #     `:ensure`, `:eval`, `:main`, and `plain`.
   #
+  #
   # locals
   # :   An array containing the names of all arguments and local variables as
   #     symbols.
   #
+  #
   # params
   # :   An Hash object containing parameter information.
   #
   #     More info about these values can be found in `vm_core.h`.
   #
+  #
   # catch_table
   # :   A list of exceptions and control flow operators (rescue, next, redo,
   #     break, etc.).
   #
+  #
   # bytecode
   # :   An array of arrays containing the instruction names and operands that make
   #     up the body of the instruction sequence.
@@ -371,9 +386,8 @@ end
 # access children nodes by name, etc.
 #
 # If you are looking for a stable API or an API working under multiple Ruby
-# implementations, consider using the *parser* gem or Ripper. If you would like
-# to make RubyVM::AbstractSyntaxTree stable, please join the discussion at
-# https://bugs.ruby-lang.org/issues/14844.
+# implementations, consider using the *prism* gem, which is the official Ruby
+# API to parse Ruby code.
 #
 module RubyVM::AbstractSyntaxTree
   # <!--
@@ -521,6 +535,15 @@ module RubyVM::AbstractSyntaxTree
     #
     def last_column: () -> Integer
 
+    # <!--
+    #   rdoc-file=ast.rb
+    #   - node.locations -> array
+    # -->
+    # Returns location objects associated with the AST node. The returned array
+    # contains RubyVM::AbstractSyntaxTree::Location.
+    #
+    def locations: () -> Array[Location]
+
     # <!--
     #   rdoc-file=ast.rb
     #   - node.tokens -> array
@@ -565,6 +588,54 @@ module RubyVM::AbstractSyntaxTree
     #
     def children: () -> Array[untyped]
   end
+
+  # <!-- rdoc-file=ast.rb -->
+  # RubyVM::AbstractSyntaxTree::Location instances are created by
+  # RubyVM::AbstractSyntaxTree#locations.
+  #
+  # This class is MRI specific.
+  #
+  class Location
+    # <!--
+    #   rdoc-file=ast.rb
+    #   - location.first_column -> integer
+    # -->
+    # The column number in the source code where this AST's text began.
+    #
+    def first_column: () -> Integer
+
+    # <!--
+    #   rdoc-file=ast.rb
+    #   - location.first_lineno -> integer
+    # -->
+    # The line number in the source code where this AST's text began.
+    #
+    def first_lineno: () -> Integer
+
+    # <!--
+    #   rdoc-file=ast.rb
+    #   - location.inspect -> string
+    # -->
+    # Returns debugging information about this location as a string.
+    #
+    def inspect: () -> String
+
+    # <!--
+    #   rdoc-file=ast.rb
+    #   - location.last_lineno -> integer
+    # -->
+    # The line number in the source code where this AST's text ended.
+    #
+    def last_lineno: () -> Integer
+
+    # <!--
+    #   rdoc-file=ast.rb
+    #   - location.last_column -> integer
+    # -->
+    # The column number in the source code where this AST's text ended.
+    #
+    def last_column: () -> Integer
+  end
 end
 
 # <!-- rdoc-file=yjit.rb -->
@@ -612,13 +683,19 @@ module RubyVM::YJIT
 
   # <!--
   #   rdoc-file=yjit.rb
-  #   - enable(stats: false)
+  #   - enable(stats: false, log: false)
   # -->
   # Enable YJIT compilation. `stats` option decides whether to enable YJIT stats
-  # or not.
-  # *   `false`: Disable stats.
-  # *   `true`: Enable stats. Print stats at exit.
-  # *   `:quiet`: Enable stats. Do not print stats at exit.
+  # or not. `compilation_log` decides
+  # whether to enable YJIT compilation logging or not.
+  # `stats`:
+  # * `false`: Don't enable stats.
+  # * `true`: Enable stats. Print stats at exit.
+  # * `:quiet`: Enable stats. Do not print stats at exit.
+  # `log`:
+  # * `false`: Don't enable the log.
+  # * `true`: Enable the log. Print log at exit.
+  # * `:quiet`: Enable the log. Do not print log at exit.
   #
   def self.enable: (?stats: false | true | :quiet) -> void
 
@@ -656,11 +733,13 @@ module RubyVM::YJIT
 
   # <!--
   #   rdoc-file=yjit.rb
-  #   - runtime_stats(context: false)
+  #   - runtime_stats(key = nil)
   # -->
   # Return a hash for statistics generated for the `--yjit-stats` command line
   # option.
   # Return `nil` when option is not passed or unavailable.
+  # If a symbol argument is provided, return only the value for the named stat.
+  # If any other type is provided, raises TypeError.
   #
   def self.runtime_stats: (?context: bool) -> Hash[untyped, untyped]?
 

data/core/rubygems/config_file.rbs

@@ -16,10 +16,13 @@
 #
 # `:backtrace`
 # :   See #backtrace
+#
 # `:sources`
 # :   Sets Gem::sources
+#
 # `:verbose`
 # :   See #verbose
+#
 # `:concurrent_downloads`
 # :   See #concurrent_downloads
 #

data/core/rubygems/errors.rbs

@@ -8,21 +8,18 @@
 # *   [RubyGems User Guide](https://guides.rubygems.org/)
 # *   [Frequently Asked Questions](https://guides.rubygems.org/faqs)
 #
-#
 # For gem developer documentation see:
 #
 # *   [Creating Gems](https://guides.rubygems.org/make-your-own-gem)
 # *   Gem::Specification
 # *   Gem::Version for version dependency notes
 #
-#
 # Further RubyGems documentation can be found at:
 #
 # *   [RubyGems Guides](https://guides.rubygems.org)
 # *   [RubyGems API](https://www.rubydoc.info/github/rubygems/rubygems) (also
 #     available from `gem server`)
 #
-#
 # ## RubyGems Plugins
 #
 # RubyGems will load plugins in the latest version of each installed gem or
@@ -65,7 +62,6 @@
 # *   Paul Brannan -- paul(at)atdesk.com
 # *   Jim Weirich   -- jim(at)weirichhouse.org
 #
-#
 # Contributors:
 #
 # *   Gavin Sinclair     -- gsinclair(at)soyabean.com.au
@@ -83,7 +79,6 @@
 # *   Evan Phoenix       -- evan(at)fallingsnow.net
 # *   Steve Klabnik      -- steve(at)steveklabnik.com
 #
-#
 # (If your name is missing, PLEASE let us know!)
 #
 # ## License

data/core/rubygems/platform.rbs

@@ -1,12 +1,3 @@
-# <!-- rdoc-file=lib/rubygems.rb -->
-# TruffleRuby >= 24 defines REUSE_AS_BINARY_ON_TRUFFLERUBY in
-# defaults/truffleruby. However, TruffleRuby < 24 defines
-# REUSE_AS_BINARY_ON_TRUFFLERUBY directly in its copy of
-# lib/rubygems/platform.rb, so it is not defined if RubyGems is updated (gem
-# update --system). Instead, we define it here in that case, similar to
-# bundler/lib/bundler/rubygems_ext.rb. We must define it here and not in
-# platform.rb because platform.rb is loaded before defaults/truffleruby.
-#
 # <!-- rdoc-file=lib/rubygems/platform.rb -->
 # Available list of platforms for targeting Gem installations.
 #

data/core/rubygems/rubygems.rbs

@@ -8,21 +8,18 @@
 # *   [RubyGems User Guide](https://guides.rubygems.org/)
 # *   [Frequently Asked Questions](https://guides.rubygems.org/faqs)
 #
-#
 # For gem developer documentation see:
 #
 # *   [Creating Gems](https://guides.rubygems.org/make-your-own-gem)
 # *   Gem::Specification
 # *   Gem::Version for version dependency notes
 #
-#
 # Further RubyGems documentation can be found at:
 #
 # *   [RubyGems Guides](https://guides.rubygems.org)
 # *   [RubyGems API](https://www.rubydoc.info/github/rubygems/rubygems) (also
 #     available from `gem server`)
 #
-#
 # ## RubyGems Plugins
 #
 # RubyGems will load plugins in the latest version of each installed gem or
@@ -65,7 +62,6 @@
 # *   Paul Brannan -- paul(at)atdesk.com
 # *   Jim Weirich   -- jim(at)weirichhouse.org
 #
-#
 # Contributors:
 #
 # *   Gavin Sinclair     -- gsinclair(at)soyabean.com.au
@@ -83,7 +79,6 @@
 # *   Evan Phoenix       -- evan(at)fallingsnow.net
 # *   Steve Klabnik      -- steve(at)steveklabnik.com
 #
-#
 # (If your name is missing, PLEASE let us know!)
 #
 # ## License