rbs 3.10.0 → 3.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e4107a0a29610713b34bf84a13fd4e348257e56e865a40358e61312f158fe0
-  data.tar.gz: d9776ace0cb6e68ba97cd4bcdd2ade5e41ba909dbf562914053d64afad118d1c
+  metadata.gz: c0e199e19fdc063a93575bc59d1daff68480bc7c678e0b9a00a20bd882c0167f
+  data.tar.gz: 42415916b4eebb2b739ce009088fd8fcec8c02a8ad0c4169ccf57dd9b69bba79
 SHA512:
-  metadata.gz: 8805e28d9b760da1aa847fb8fa5ed26f26a2dc7309a37d861a178a511bfac68181955324803b42f64aada55cdd8806522c682b0980457aded2279f6493611eb0
-  data.tar.gz: 4ffa069bffbcaa8e869d30f50dbe42344f624691acea5e9aa1ff8c665f4749c32c8450d5b2dab0e6ed3fc94e4bc67f8c82a833ac5cb167f35c4cb17eaeb59d45
+  metadata.gz: a9ba79e77d4f6ca3b57f6a89e245e20edd6ceba274475ad435a4bfb45e78dc17e4ab3ca033b208279b4ee1bef0498d82459ef912bbc2dfcabb16c921f4802e72
+  data.tar.gz: 8c8100da156288e99931d15f0a3e61439a08d51e3d85605f95770d62cdfc4e1fd3cc71ede93763ce08e480084ed8301a26b781db3988b7fc931ea727fccd7e29

data/.github/workflows/c-check.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "4.0.0-preview3"
+          ruby-version: "4.0"
           bundler-cache: none
       - name: Set working directory as safe
         run: git config --global --add safe.directory $(pwd)

data/.github/workflows/comments.yml

@@ -10,13 +10,13 @@ on:
 jobs:
   comments:
     runs-on: "ubuntu-latest"
-    env:
-      RUBY_COMMIT: v4.0.0-preview3
+    # env:
+    #   RUBY_COMMIT: v4.0.0-preview2
     steps:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "4.0.0-preview3"
+          ruby-version: "4.0.0"
           bundler: none
       - name: Install dependencies
         run: |

data/.github/workflows/ruby.yml

@@ -13,24 +13,24 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.2', '3.3', '3.4', '4.0.0-preview3', head]
+        ruby: ['3.2', '3.3', '3.4', '4.0', head]
         rubyopt: [""]
         job:
           - test
         include:
           - ruby: head
             job: stdlib_test rubocop
-          - ruby: "4.0.0-preview3"
+          - ruby: "4.0"
             job: stdlib_test
-          - ruby: "4.0.0-preview3"
+          - ruby: "4.0"
             job: test
             rubyopt: "--enable-frozen-string-literal"
-          - ruby: "4.0.0-preview3"
+          - ruby: "4.0"
             job: stdlib_test
             rubyopt: "--enable-frozen-string-literal"
-          - ruby: "4.0.0-preview3"
+          - ruby: "4.0"
             job: rubocop validate test_doc build test_generate_stdlib raap
-          - ruby: "4.0.0-preview3"
+          - ruby: "4.0"
             job: typecheck_test
     env:
       RANDOMIZE_STDLIB_TEST_ORDER: "true"
@@ -94,7 +94,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['4.0.0-preview3', head]
+        ruby: ['4.0', head]
     steps:
       - uses: actions/checkout@v4
       - name: Install dependencies
@@ -116,4 +116,3 @@ jobs:
         run: |
           bin/setup
       - run: bundle exec rake clean compile_c99
-

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # CHANGELOG
 
+## 3.10.1 (2026-01-07)
+
+This is a follow-up release for Ruby 4.0.0 with documentation update based on Ruby 4.0.0, and bugfixes related to set/pathname library loading.
+
+### Pull Requests
+
+* Merge pull request #2777 from ksss/pathname-ext ([#2786](https://github.com/ruby/rbs/pull/2786))
+* Ruby 4.0.0 backports ([#2785](https://github.com/ruby/rbs/pull/2785))
+* [Backport] Fix subtraction of civar ([#2783](https://github.com/ruby/rbs/pull/2783))
+* [Backport] Update ruby to 4.0 ([#2778](https://github.com/ruby/rbs/pull/2778))
+
 ## 3.10.0 (2025-12-23)
 
 RBS 3.10.0 ships with a pure C parser implementation, signature updates for Ruby 4.0, and various bug fixes.

data/core/array.rbs

@@ -2029,14 +2029,12 @@ class Array[unchecked out Elem] < Object
   # With a block given, calls the block with successive elements of the array;
   # returns the first element for which the block returns a truthy value:
   #
-  #     (0..9).find {|element| element > 2}                # => 3
+  #     [1, 3, 5].find {|element| element > 2}                # => 3
   #
   # If no such element is found, calls `if_none_proc` and returns its return
   # value.
   #
-  #     (0..9).find(proc {false}) {|element| element > 12} # => false
-  #     {foo: 0, bar: 1, baz: 2}.find {|key, value| key.start_with?('b') }            # => [:bar, 1]
-  #     {foo: 0, bar: 1, baz: 2}.find(proc {[]}) {|key, value| key.start_with?('c') } # => []
+  #     [1, 3, 5].find(proc {-1}) {|element| element > 12} # => -1
   #
   # With no block given, returns an Enumerator.
   #
@@ -3022,17 +3020,15 @@ class Array[unchecked out Elem] < Object
   # Returns the last element for which the block returns a truthy value.
   #
   # With a block given, calls the block with successive elements of the array in
-  # reverse order; returns the last element for which the block returns a truthy
+  # reverse order; returns the first element for which the block returns a truthy
   # value:
   #
-  #     (0..9).rfind {|element| element < 5}                # => 4
+  #     [1, 2, 3, 4, 5, 6].rfind {|element| element < 5}       # => 4
   #
   # If no such element is found, calls `if_none_proc` and returns its return
   # value.
   #
-  #     (0..9).rfind(proc {false}) {|element| element < -2} # => false
-  #     {foo: 0, bar: 1, baz: 2}.rfind {|key, value| key.start_with?('b') }            # => [:baz, 2]
-  #     {foo: 0, bar: 1, baz: 2}.rfind(proc {[]}) {|key, value| key.start_with?('c') } # => []
+  #     [1, 2, 3, 4].rfind(proc {0}) {|element| element < -2}  # => 0
   #
   # With no block given, returns an Enumerator.
   #

data/core/comparable.rbs

@@ -55,19 +55,26 @@
 module Comparable : _WithSpaceshipOperator
   # <!--
   #   rdoc-file=compar.c
-  #   - obj < other    -> true or false
+  #   - self < other -> true or false
   # -->
-  # Compares two objects based on the receiver's `<=>` method, returning true if
-  # it returns a value less than 0.
+  # Returns whether `self` is "less than" `other`; equivalent to `(self <=> other)
+  # < 0`:
+  #
+  #     'foo' < 'foo'  # => false
+  #     'foo' < 'food' # => true
   #
   def <: (untyped other) -> bool
 
   # <!--
   #   rdoc-file=compar.c
-  #   - obj <= other    -> true or false
+  #   - self <= other -> true or false
   # -->
-  # Compares two objects based on the receiver's `<=>` method, returning true if
-  # it returns a value less than or equal to 0.
+  # Returns whether `self` is "less than or equal to" `other`; equivalent to
+  # `(self <=> other) <= 0`:
+  #
+  #     'foo' <= 'foo'  # => true
+  #     'foo' <= 'food' # => true
+  #     'food' <= 'foo' # => false
   #
   def <=: (untyped other) -> bool
 

data/core/complex.rbs

@@ -279,15 +279,16 @@ class Complex < Numeric
 
   # <!--
   #   rdoc-file=complex.c
-  #   - complex <=> object -> -1, 0, 1, or nil
+  #   - self <=> other -> -1, 0, 1, or nil
   # -->
+  # Compares `self` and `other`.
+  #
   # Returns:
   #
-  # *   `self.real <=> object.real` if both of the following are true:
+  # *   `self.real <=> other.real` if both of the following are true:
   #
   #     *   `self.imag == 0`.
-  #     *   `object.imag == 0`. # Always true if object is numeric but not
-  #         complex.
+  #     *   `other.imag == 0` (always true if `other` is numeric but not complex).
   #
   # *   `nil` otherwise.
   #
@@ -300,6 +301,9 @@ class Complex < Numeric
   #     Complex.rect(1) <=> Complex.rect(1, 1) # => nil # object.imag not zero.
   #     Complex.rect(1) <=> 'Foo'              # => nil # object.imag not defined.
   #
+  # Class Complex includes module Comparable, each of whose methods uses
+  # Complex#<=> for comparison.
+  #
   def <=>: (untyped) -> Integer?
 
   # <!--

data/core/dir.rbs

@@ -171,7 +171,7 @@ class Dir
   # system's encoding is used:
   #
   #     Dir.new('.').read.encoding                       # => #<Encoding:UTF-8>
-  #     Dir.new('.', encoding: 'US-ASCII').read.encoding # => #<Encoding:US-ASCII>
+  #     Dir.new('.', encoding: Encoding::US_ASCI).read.encoding # => #<Encoding:US-ASCII>
   #
   def initialize: (path dir, ?encoding: encoding?) -> void
 
@@ -704,7 +704,7 @@ class Dir
   # system's encoding is used:
   #
   #     Dir.open('.').read.encoding                       # => #<Encoding:UTF-8>
-  #     Dir.open('.', encoding: 'US-ASCII').read.encoding # => #<Encoding:US-ASCII>
+  #     Dir.open('.', encoding: Encoding::US_ASCII).read.encoding # => #<Encoding:US-ASCII>
   #
   def self.open: (path dirname, ?encoding: encoding?) -> instance
                | [U] (path dirname, ?encoding: encoding?) { (instance) -> U } -> U

data/core/enumerator.rbs

@@ -186,6 +186,12 @@ class Enumerator[unchecked out Elem, out Return = void] < Object
   #     }
   #     traverser.size  # => 4
   #
+  #     # Finite enumerator with unknown size
+  #     calendar = Enumerator.produce(Date.today, size: nil) {
+  #       it.monday? ? raise(StopIteration) : it + 1
+  #     }
+  #     calendar.size  # => nil
+  #
   def self.produce: [T] () { (T? prev) -> T } -> Enumerator[T, bot]
                   | [T] (T initial) { (T prev) -> T } -> Enumerator[T, bot]
 
@@ -463,6 +469,25 @@ class Enumerator[unchecked out Elem, out Return = void] < Object
   #     loop.size # => Float::INFINITY
   #     (1..100).drop_while.size # => nil
   #
+  # Note that enumerator size might be inaccurate, and should be rather treated as
+  # a hint. For example, there is no check that the size provided to ::new is
+  # accurate:
+  #
+  #     e = Enumerator.new(5) { |y| 2.times { y << it} }
+  #     e.size # => 5
+  #     e.to_a.size # => 2
+  #
+  # Another example is an enumerator created by ::produce without a `size`
+  # argument. Such enumerators return `Infinity` for size, but this is inaccurate
+  # if the passed block raises StopIteration:
+  #
+  #     e = Enumerator.produce(1) { it + 1 }
+  #     e.size # => Infinity
+  #
+  #     e = Enumerator.produce(1) { it > 3 ? raise(StopIteration) : it + 1 }
+  #     e.size # => Infinity
+  #     e.to_a.size # => 4
+  #
   def size: () -> (Integer | Float)?
 
   # <!--

data/core/fiber.rbs

@@ -393,27 +393,35 @@ class Fiber < Object
 
   # <!--
   #   rdoc-file=cont.c
-  #   - fiber.raise                                 -> obj
-  #   - fiber.raise(string)                         -> obj
-  #   - fiber.raise(exception [, string [, array]]) -> obj
+  #   - raise(exception, message = exception.to_s, backtrace = nil, cause: $!)
+  #   - raise(message = nil, cause: $!)
   # -->
   # Raises an exception in the fiber at the point at which the last `Fiber.yield`
-  # was called. If the fiber has not been started or has already run to
-  # completion, raises `FiberError`. If the fiber is yielding, it is resumed. If
-  # it is transferring, it is transferred into. But if it is resuming, raises
-  # `FiberError`.
-  #
-  # With no arguments, raises a `RuntimeError`. With a single `String` argument,
-  # raises a `RuntimeError` with the string as a message.  Otherwise, the first
-  # parameter should be the name of an `Exception` class (or an object that
-  # returns an `Exception` object when sent an `exception` message). The optional
-  # second parameter sets the message associated with the exception, and the third
-  # parameter is an array of callback information. Exceptions are caught by the
-  # `rescue` clause of `begin...end` blocks.
+  # was called.
+  #
+  #     f = Fiber.new {
+  #       puts "Before the yield"
+  #       Fiber.yield 1 # -- exception will be raised here
+  #       puts "After the yield"
+  #     }
+  #
+  #     p f.resume
+  #     f.raise "Gotcha"
+  #
+  # Output
+  #
+  #     Before the first yield
+  #     1
+  #     t.rb:8:in 'Fiber.yield': Gotcha (RuntimeError)
+  #       from t.rb:8:in 'block in <main>'
+  #
+  # If the fiber has not been started or has already run to completion, raises
+  # `FiberError`. If the fiber is yielding, it is resumed. If it is transferring,
+  # it is transferred into. But if it is resuming, raises `FiberError`.
   #
   # Raises `FiberError` if called on a Fiber belonging to another `Thread`.
   #
-  # See Kernel#raise for more information.
+  # See Kernel#raise for more information on arguments.
   #
   def raise: (?string msg, ?cause: Exception?) -> untyped
            | (_Exception, ?string msg, ?Array[string] | Array[Thread::Backtrace::Location] | nil backtrace, ?cause: Exception?) -> untyped

data/core/file.rbs

@@ -2455,16 +2455,31 @@ class File::Stat < Object
 
   # <!--
   #   rdoc-file=file.c
-  #   - stat <=> other_stat    -> -1, 0, 1, nil
+  #   - self <=> other -> -1, 0, 1, or nil
   # -->
-  # Compares File::Stat objects by comparing their respective modification times.
+  # Compares `self` and `other`, by comparing their modification times; that is,
+  # by comparing `self.mtime` and `other.mtime`.
   #
-  # `nil` is returned if `other_stat` is not a File::Stat object
+  # Returns:
   #
-  #     f1 = File.new("f1", "w")
-  #     sleep 1
-  #     f2 = File.new("f2", "w")
-  #     f1.stat <=> f2.stat   #=> -1
+  # *   `-1`, if `self.mtime` is earlier.
+  # *   `0`, if the two values are equal.
+  # *   `1`, if `self.mtime` is later.
+  # *   `nil`, if `other` is not a File::Stat object.
+  #
+  # Examples:
+  #
+  #     stat0 = File.stat('README.md')
+  #     stat1 = File.stat('NEWS.md')
+  #     stat0.mtime         # => 2025-12-20 15:33:05.6972341 -0600
+  #     stat1.mtime         # => 2025-12-20 16:02:08.2672945 -0600
+  #     stat0 <=> stat1     # => -1
+  #     stat0 <=> stat0.dup # => 0
+  #     stat1 <=> stat0     # => 1
+  #     stat0 <=> :foo      # => nil
+  #
+  # Class File::Stat includes module Comparable, each of whose methods uses
+  # File::Stat#<=> for comparison.
   #
   def <=>: (File::Stat other) -> Integer
          | (untyped) -> nil

data/core/float.rbs

@@ -384,7 +384,8 @@ class Float < Numeric
   #   rdoc-file=numeric.c
   #   - self < other -> true or false
   # -->
-  # Returns `true` if `self` is numerically less than `other`:
+  # Returns whether the value of `self` is less than the value of `other`; `other`
+  # must be numeric, but may not be Complex:
   #
   #     2.0 < 3              # => true
   #     2.0 < 3.0            # => true
@@ -399,7 +400,8 @@ class Float < Numeric
   #   rdoc-file=numeric.c
   #   - self <= other -> true or false
   # -->
-  # Returns `true` if `self` is numerically less than or equal to `other`:
+  # Returns whether the value of `self` is less than or equal to the value of
+  # `other`; `other` must be numeric, but may not be Complex:
   #
   #     2.0 <= 3              # => true
   #     2.0 <= 3.0            # => true
@@ -413,30 +415,32 @@ class Float < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self <=> other ->  -1, 0, +1, or nil
+  #   - self <=> other ->  -1, 0, 1, or nil
   # -->
-  # Returns a value that depends on the numeric relation between `self` and
-  # `other`:
+  # Compares `self` and `other`.
   #
-  # *   -1, if `self` is less than `other`.
-  # *   0, if `self` is equal to `other`.
-  # *   1, if `self` is greater than `other`.
+  # Returns:
+  #
+  # *   `-1`, if `self` is less than `other`.
+  # *   `0`, if `self` is equal to `other`.
+  # *   `1`, if `self` is greater than `other`.
   # *   `nil`, if the two values are incommensurate.
   #
   # Examples:
   #
+  #     2.0 <=> 2.1            # => -1
   #     2.0 <=> 2              # => 0
   #     2.0 <=> 2.0            # => 0
   #     2.0 <=> Rational(2, 1) # => 0
   #     2.0 <=> Complex(2, 0)  # => 0
   #     2.0 <=> 1.9            # => 1
-  #     2.0 <=> 2.1            # => -1
   #     2.0 <=> 'foo'          # => nil
   #
-  # This is the basis for the tests in the Comparable module.
-  #
   # `Float::NAN <=> Float::NAN` returns an implementation-dependent value.
   #
+  # Class Float includes module Comparable, each of whose methods uses Float#<=>
+  # for comparison.
+  #
   def <=>: (Numeric) -> Integer?
 
   # <!--

data/core/hash.rbs

@@ -534,10 +534,10 @@ class Hash[unchecked out K, unchecked out V] < Object
 
   # <!--
   #   rdoc-file=hash.c
-  #   - self < other_hash -> true or false
+  #   - self < other -> true or false
   # -->
-  # Returns `true` if the entries of `self` are a proper subset of the entries of
-  # `other_hash`, `false` otherwise:
+  # Returns whether the entries of `self` are a proper subset of the entries of
+  # `other`:
   #
   #     h = {foo: 0, bar: 1}
   #     h < {foo: 0, bar: 1, baz: 2} # => true   # Proper subset.
@@ -558,10 +558,9 @@ class Hash[unchecked out K, unchecked out V] < Object
 
   # <!--
   #   rdoc-file=hash.c
-  #   - self <= other_hash -> true or false
+  #   - self <= other -> true or false
   # -->
-  # Returns `true` if the entries of `self` are a subset of the entries of
-  # `other_hash`, `false` otherwise:
+  # Returns whether the entries of `self` are a subset of the entries of `other`:
   #
   #     h0 = {foo: 0, bar: 1}
   #     h1 = {foo: 0, bar: 1, baz: 2}

data/core/integer.rbs

@@ -340,15 +340,14 @@ class Integer < Numeric
   #   rdoc-file=numeric.c
   #   - self < other -> true or false
   # -->
-  # Returns `true` if the value of `self` is less than that of `other`:
+  # Returns whether the value of `self` is less than the value of `other`; `other`
+  # must be numeric, but may not be Complex:
   #
-  #       1 < 0              # => false
-  #       1 < 1              # => false
-  #       1 < 2              # => true
-  #       1 < 0.5            # => false
-  #       1 < Rational(1, 2) # => false
-  #
-  #     Raises an exception if the comparison cannot be made.
+  #     1 < 0              # => false
+  #     1 < 1              # => false
+  #     1 < 2              # => true
+  #     1 < 0.5            # => false
+  #     1 < Rational(1, 2) # => false
   #
   def <: (Numeric) -> bool
 
@@ -371,44 +370,46 @@ class Integer < Numeric
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self <= real -> true or false
+  #   - self <= other -> true or false
   # -->
-  # Returns `true` if the value of `self` is less than or equal to that of
-  # `other`:
+  # Returns whether the value of `self` is less than or equal to the value of
+  # `other`; `other` must be numeric, but may not be Complex:
   #
-  #     1 <= 0              # => false
-  #     1 <= 1              # => true
-  #     1 <= 2              # => true
-  #     1 <= 0.5            # => false
-  #     1 <= Rational(1, 2) # => false
+  #       1 <= 0              # => false
+  #       1 <= 1              # => true
+  #       1 <= 2              # => true
+  #       1 <= 0.5            # => false
+  #       1 <= Rational(1, 2) # => false
   #
-  # Raises an exception if the comparison cannot be made.
+  #     Raises an exception if the comparison cannot be made.
   #
   def <=: (Numeric) -> bool
 
   # <!--
   #   rdoc-file=numeric.c
-  #   - self <=> other  ->  -1, 0, +1, or nil
+  #   - self <=> other -> -1, 0, 1, or nil
   # -->
+  # Compares `self` and `other`.
+  #
   # Returns:
   #
-  # *   -1, if `self` is less than `other`.
-  # *   0, if `self` is equal to `other`.
-  # *   1, if `self` is greater then `other`.
+  # *   `-1`, if `self` is less than `other`.
+  # *   `0`, if `self` is equal to `other`.
+  # *   `1`, if `self` is greater then `other`.
   # *   `nil`, if `self` and `other` are incomparable.
   #
   # Examples:
   #
   #     1 <=> 2              # => -1
   #     1 <=> 1              # => 0
-  #     1 <=> 0              # => 1
-  #     1 <=> 'foo'          # => nil
-  #
   #     1 <=> 1.0            # => 0
   #     1 <=> Rational(1, 1) # => 0
   #     1 <=> Complex(1, 0)  # => 0
+  #     1 <=> 0              # => 1
+  #     1 <=> 'foo'          # => nil
   #
-  # This method is the basis for comparisons in module Comparable.
+  # Class Integer includes module Comparable, each of whose methods uses
+  # Integer#<=> for comparison.
   #
   def <=>: (Integer | Rational) -> Integer
          | (untyped) -> Integer?

data/core/io/buffer.rbs

@@ -64,9 +64,9 @@ class IO
   #
   #     File.write('test.txt', 'test data')
   #     # => 9
-  #     buffer = IO::Buffer.map(File.open('test.txt'))
+  #     buffer = IO::Buffer.map(File.open('test.txt'), nil, 0, IO::Buffer::READONLY)
   #     # =>
-  #     # #<IO::Buffer 0x00007f3f0768c000+9 MAPPED IMMUTABLE>
+  #     # #<IO::Buffer 0x00007f3f0768c000+9 EXTERNAL MAPPED FILE SHARED READONLY>
   #     # ...
   #     buffer.get_string(5, 2) # read 2 bytes, starting from offset 5
   #     # => "da"
@@ -113,7 +113,7 @@ class IO
     #     buffer.get_string(0, 1)
     #     # => "t"
     #     string
-    #     # => "best"
+    #     # => "test"
     #
     #     buffer.resize(100)
     #     # in `resize': Cannot resize external buffer! (IO::Buffer::AccessError)

data/core/kernel.rbs

@@ -1004,6 +1004,8 @@ module Kernel : BasicObject
   # With argument `exception` not given, argument `message` and keyword argument
   # `cause` may be given, but argument `backtrace` may not be given.
   #
+  # `cause` can not be given as an only argument.
+  #
   def self?.fail: () -> bot
                 | (string message, ?cause: Exception?) -> bot
                 | (_Exception exception, ?_ToS? message, ?String | Array[String] | Array[Thread::Backtrace::Location] | nil backtrace, ?cause: Exception?) -> bot
@@ -1110,6 +1112,8 @@ module Kernel : BasicObject
   # With argument `exception` not given, argument `message` and keyword argument
   # `cause` may be given, but argument `backtrace` may not be given.
   #
+  # `cause` can not be given as an only argument.
+  #
   alias raise fail
 
   alias self.raise self.fail