rbs 3.3.2 → 3.4.0

data/core/ruby_vm.rbs

@@ -11,21 +11,21 @@ class RubyVM < Object
 end
 
 # <!-- rdoc-file=vm.c -->
-# DEFAULT_PARAMS This constant exposes the VM's default parameters. Note that
-# changing these values does not affect VM execution. Specification is not
-# stable and you should not depend on this value. Of course, this constant is
-# MRI specific.
+# ::RubyVM::DEFAULT_PARAMS This constant exposes the VM's default parameters.
+# Note that changing these values does not affect VM execution. Specification is
+# not stable and you should not depend on this value. Of course, this constant
+# is MRI specific.
 #
 RubyVM::DEFAULT_PARAMS: Hash[Symbol, Integer]
 
 # <!-- rdoc-file=vm.c -->
-# INSTRUCTION_NAMES A list of bytecode instruction names in MRI. This constant
-# is MRI specific.
+# ::RubyVM::INSTRUCTION_NAMES A list of bytecode instruction names in MRI. This
+# constant is MRI specific.
 #
 RubyVM::INSTRUCTION_NAMES: Array[String]
 
 # <!-- rdoc-file=vm.c -->
-# OPTS An Array of VM build options. This constant is MRI specific.
+# ::RubyVM::OPTS An Array of VM build options. This constant is MRI specific.
 #
 RubyVM::OPTS: Array[String]
 
@@ -73,7 +73,7 @@ end
 module RubyVM::AbstractSyntaxTree
   # <!--
   #   rdoc-file=ast.rb
-  #   - RubyVM::AbstractSyntaxTree.parse(string, keep_script_lines: false, error_tolerant: false, keep_tokens: false) -> RubyVM::AbstractSyntaxTree::Node
+  #   - RubyVM::AbstractSyntaxTree.parse(string, keep_script_lines: RubyVM.keep_script_lines, error_tolerant: false, keep_tokens: false) -> RubyVM::AbstractSyntaxTree::Node
   # -->
   # Parses the given *string* into an abstract syntax tree, returning the root
   # node of that tree.
@@ -106,13 +106,13 @@ module RubyVM::AbstractSyntaxTree
   #     #  (ERROR@1:7-1:11),
   #     #  (LASGN@1:12-1:15 :y (LIT@1:14-1:15 2))]
   #
-  # Note that parsing continues even after the errored expresion.
+  # Note that parsing continues even after the errored expression.
   #
   def self.parse: (String string, ?keep_script_lines: bool, ?error_tolerant: bool, ?keep_tokens: bool) -> Node
 
   # <!--
   #   rdoc-file=ast.rb
-  #   - RubyVM::AbstractSyntaxTree.parse_file(pathname, keep_script_lines: false, error_tolerant: false, keep_tokens: false) -> RubyVM::AbstractSyntaxTree::Node
+  #   - RubyVM::AbstractSyntaxTree.parse_file(pathname, keep_script_lines: RubyVM.keep_script_lines, error_tolerant: false, keep_tokens: false) -> RubyVM::AbstractSyntaxTree::Node
   # -->
   # Reads the file from *pathname*, then parses it like ::parse, returning the
   # root node of the abstract syntax tree.
@@ -128,8 +128,8 @@ module RubyVM::AbstractSyntaxTree
 
   # <!--
   #   rdoc-file=ast.rb
-  #   - RubyVM::AbstractSyntaxTree.of(proc, keep_script_lines: false, error_tolerant: false, keep_tokens: false)   -> RubyVM::AbstractSyntaxTree::Node
-  #   - RubyVM::AbstractSyntaxTree.of(method, keep_script_lines: false, error_tolerant: false, keep_tokens: false) -> RubyVM::AbstractSyntaxTree::Node
+  #   - RubyVM::AbstractSyntaxTree.of(proc, keep_script_lines: RubyVM.keep_script_lines, error_tolerant: false, keep_tokens: false)   -> RubyVM::AbstractSyntaxTree::Node
+  #   - RubyVM::AbstractSyntaxTree.of(method, keep_script_lines: RubyVM.keep_script_lines, error_tolerant: false, keep_tokens: false) -> RubyVM::AbstractSyntaxTree::Node
   # -->
   # Returns AST nodes of the given *proc* or *method*.
   #
@@ -260,4 +260,118 @@ module RubyVM::AbstractSyntaxTree
     #
     def children: () -> Array[untyped]
   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
+    #   - 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
+    #   - 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_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
+    #   - 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_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
 end

data/core/rubygems/platform.rbs

@@ -1,3 +1,12 @@
+# <!-- 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

@@ -156,7 +156,7 @@ module Gem
   #   - activated_gem_paths()
   # -->
   # The number of paths in the +$LOAD_PATH+ from activated gems. Used to
-  # prioritize `-I` and +[ENV]('RUBYLIB')+ entries during `require`.
+  # prioritize `-I` and `ENV['RUBYLIB']` entries during `require`.
   #
   def self.activated_gem_paths: () -> Integer
 

data/core/rubygems/version.rbs

@@ -138,7 +138,9 @@ module Gem
   #
   # ## Preventing Version Catastrophe:
   #
-  # From: http://blog.zenspider.com/2008/10/rubygems-howto-preventing-cata.html
+  # From:
+  # https://www.zenspider.com/ruby/2008/10/rubygems-how-to-preventing-catastrophe.
+  # html
   #
   # Let's say you're depending on the fnord gem version 2.y.z. If you specify your
   # dependency as ">= 2.0.0" then, you're good, right? What happens if fnord 3.0
@@ -225,6 +227,8 @@ module Gem
     #   rdoc-file=lib/rubygems/version.rb
     #   - canonical_segments()
     # -->
+    # remove trailing zeros segments before first letter or at the end of the
+    # version
     #
     def canonical_segments: () -> Array[Integer | String]
 

data/core/set.rbs

@@ -1,11 +1,8 @@
 # <!-- rdoc-file=lib/set.rb -->
-# This library provides the Set class, which deals with a collection
+# This library provides the Set class, which implements a collection
 # of unordered values with no duplicates. It is a hybrid of Array's
 # intuitive inter-operation facilities and Hash's fast lookup.
 # The method `to_set` is added to Enumerable for convenience.
-# Set implements a collection of unordered values with no duplicates.
-# This is a hybrid of Array's intuitive inter-operation facilities and
-# Hash's fast lookup.
 # Set is easy to use with Enumerable objects (implementing `each`).
 # Most of the initializer methods and binary operators accept generic
 # Enumerable objects besides sets and arrays. An Enumerable object
@@ -60,7 +57,7 @@
 #
 # ### Methods for Creating a Set
 # *   ::[]:
-#  Returns a new set containing the given objects.
+#      Returns a new set containing the given objects.
 # *   ::new:
 #      Returns a new set containing either the given objects
 #      (if no block given) or the return values from the called block
@@ -89,13 +86,13 @@
 #      as determined by Object#eql?.
 # *   #compare_by_identity?:
 #      Returns whether the set considers only identity
-#  when comparing elements.
+#      when comparing elements.
 #
 # ### Methods for Querying
 # *   #length (aliased as #size):
-#  Returns the count of elements.
+#      Returns the count of elements.
 # *   #empty?:
-#  Returns whether the set has no elements.
+#      Returns whether the set has no elements.
 # *   #include? (aliased as #member? and #===):
 #      Returns whether a given object is an element in the set.
 # *   #subset? (aliased as [<=](#method-i-3C-3D)):
@@ -114,37 +111,38 @@
 #      have any common elements, `false` otherwise.
 # *   #compare_by_identity?:
 #      Returns whether the set considers only identity
-#  when comparing elements.
+#      when comparing elements.
 #
 # ### Methods for Assigning
 # *   #add (aliased as #<<):
-#  Adds a given object to the set; returns `self`.
+#      Adds a given object to the set; returns `self`.
 # *   #add?:
 #      If the given object is not an element in the set,
 #      adds it and returns `self`; otherwise, returns `nil`.
 # *   #merge:
-#  Adds each given object to the set; returns `self`.
+#      Merges the elements of each given enumerable object to the set; returns
+#     `self`.
 # *   #replace:
 #      Replaces the contents of the set with the contents
 #      of a given enumerable.
 #
 # ### Methods for Deleting
 # *   #clear:
-#  Removes all elements in the set; returns `self`.
+#      Removes all elements in the set; returns `self`.
 # *   #delete:
-#  Removes a given object from the set; returns `self`.
+#      Removes a given object from the set; returns `self`.
 # *   #delete?:
 #      If the given object is an element in the set,
 #      removes it and returns `self`; otherwise, returns `nil`.
 # *   #subtract:
-#  Removes each given object from the set; returns `self`.
+#      Removes each given object from the set; returns `self`.
 # *   #delete_if - Removes elements specified by a given block.
 # *   #select! (aliased as #filter!):
 #      Removes elements not specified by a given block.
 # *   #keep_if:
-#  Removes elements not specified by a given block.
+#      Removes elements not specified by a given block.
 # *   #reject!
-#  Removes elements specified by a given block.
+#      Removes elements specified by a given block.
 #
 # ### Methods for Converting
 # *   #classify:
@@ -162,20 +160,20 @@
 #      #flatten!:
 #      Replaces each nested set in `self` with the elements from that set.
 # *   #inspect (aliased as #to_s):
-#  Returns a string displaying the elements.
+#      Returns a string displaying the elements.
 # *   #join:
 #      Returns a string containing all elements, converted to strings
 #      as needed, and joined by the given record separator.
 # *   #to_a:
-#  Returns an array containing all set elements.
+#      Returns an array containing all set elements.
 # *   #to_set:
 #      Returns `self` if given no arguments and no block;
 #      with a block given, returns a new set consisting of block
-#  return values.
+#      return values.
 #
 # ### Methods for Iterating
 # *   #each:
-#  Calls the block with each successive element; returns `self`.
+#      Calls the block with each successive element; returns `self`.
 #
 # ### Other Methods
 # *   #reset:
@@ -531,9 +529,9 @@ class Set[unchecked out A]
 
   # <!--
   #   rdoc-file=lib/set.rb
-  #   - merge(enum)
+  #   - merge(*enums, **nil)
   # -->
-  # Merges the elements of the given enumerable object to the set and
+  # Merges the elements of the given enumerable objects to the set and
   # returns self.
   #
   def merge: (_Each[A]) -> self

data/core/signal.rbs

@@ -26,9 +26,9 @@
 #     # ...
 #     Process.kill("TERM", pid)
 #
-# produces:
-#      Debug now: true
-#      Debug now: false
+# *produces:*
+#     Debug now: true
+#     Debug now: false
 #     Terminating...
 #
 # The list of available signal names and their interpretation is system
@@ -84,7 +84,7 @@ module Signal
   #     Signal.trap("CLD")  { puts "Child died" }
   #     fork && Process.wait
   #
-  # produces:
+  # *produces:*
   #     Terminating: 27461
   #     Child died
   #     Terminating: 27460