rbs 3.5.2 → 3.6.0.dev.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9764851079fa89592891f71a26c6eee69864530b07b78e11095b5fdd49b3f6e
-  data.tar.gz: 4fa3989f4f1508aff037e9f07d708f8b14355d133415c088ae8a61abec5ad114
+  metadata.gz: f9c653ea578000329720980ce7845237e8c49c9319a72c5a4f5bc315306cde02
+  data.tar.gz: e9ccad52c36cd4ef0509ce78ab0d857810b80ed6489d8b6b1fcdac0af47f5e59
 SHA512:
-  metadata.gz: 95b8dd11d46e7d395bb72fe698e6607eea742d02b1fe78309b030f3e921be8400367abf8ce3985b9afa35febb596fb196d532a420d641f1d6cf1bab78fdfdf38
-  data.tar.gz: bf4153dcdbf740345ed312a75a6452475d1faeb92f5fa7f07d5c0f153582be935c4952aa3ed53dc20f579da0d2ed219f80cda826c575c416d34bb3a9c5ff98d8
+  metadata.gz: c2468b174c0800686e77f26122898d84e2f2506b5b91074d30d18766ce60992257bd560843972ddf72c77e9b8bda26dfb58f012893dbae1585f994fecd480a7b
+  data.tar.gz: 9c534d38496760cc1ad91f8776e83e61672305c564c6b14fc206fd202817a5be2d60d675558dfbe6b9fadbf9f980c595c2432c821cae38a5b447857d5601ab5e

data/.github/workflows/dependabot.yml

@@ -11,8 +11,11 @@ env:
 jobs:
   dependabot:
     runs-on: ubuntu-latest
-    if: ${{ github.actor == 'dependabot[bot]' }}
+    if: ${{ github.event.pull_request.user.login == 'dependabot[bot]' }}
     steps:
+      - name: Dependabot metadata
+        uses: dependabot/fetch-metadata@dbb049abf0d677abbd7f7eee0375145b417fdd34 # v2.2.0
+        id: metadata
       - name: Checkout repository
         uses: actions/checkout@v4
         with:
@@ -21,6 +24,7 @@ jobs:
         run: git diff --exit-code ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }} ${{ env.blocker_files }}
       - name: Enable auto-merge for Dependabot PRs
         run: gh pr merge --auto --merge "$PR_URL"
+        if: ${{ steps.metadata.outputs.update-type == 'version-update:semver-minor' || steps.metadata.outputs.update-type == 'version-update:semver-patch' }}
         env:
           PR_URL: ${{github.event.pull_request.html_url}}
           GH_TOKEN: ${{secrets.DEPENDABOT_MERGE_GH_TOKEN}}

data/.github/workflows/ruby.yml

@@ -42,6 +42,8 @@ jobs:
           bundler: none
       - name: Set working directory as safe
         run: git config --global --add safe.directory $(pwd)
+      - name: Set up permission
+        run: chmod -R o-w /opt/hostedtoolcache/Ruby
       - name: Install dependencies
         run: |
           sudo apt-get update
@@ -76,21 +78,3 @@ jobs:
       - name: Run test
         run: |
           bundle exec rake ${{ matrix.job }}
-
-  windows:
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: false
-      matrix:
-        os: [windows-2019, windows-2022]
-        ruby: [ucrt, mswin]
-    steps:
-      - uses: actions/checkout@v4
-      - name: load ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - name: rake-compiler
-        run: gem install rake-compiler
-      - name: compile
-        run: rake compile

data/.github/workflows/windows.yml

@@ -0,0 +1,26 @@
+name: Ruby on Windows
+
+on:
+  push:
+    branches:
+      - master
+  pull_request: {}
+  merge_group: {}
+
+jobs:
+  compile:
+    runs-on: "windows-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.2', '3.3', ucrt, mswin]
+    steps:
+      - uses: actions/checkout@v4
+      - name: load ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: rake-compiler
+        run: gem install rake-compiler
+      - name: compile
+        run: rake compile

data/CHANGELOG.md

@@ -1,17 +1,5 @@
 # CHANGELOG
 
-## 3.5.2 (2024-07-10)
-
-### Library changes
-
-* Update docs for ruby-3.3.4 ([#1923](https://github.com/ruby/rbs/pull/1923), Backported in [#1925](https://github.com/ruby/rbs/pull/1925))
-* Update docs for ruby-3.3.3 ([#1889](https://github.com/ruby/rbs/pull/1889), Backported in [#1925](https://github.com/ruby/rbs/pull/1925))
-* Fix #1905: Fix typo in `UntypedFunction` ([#1906](https://github.com/ruby/rbs/pull/1906), Backported in [#1925](https://github.com/ruby/rbs/pull/1925))
-
-### Miscellaneous
-
-* Use `File.open` instead of `IO.sysopen` ([#1913](https://github.com/ruby/rbs/pull/1913))
-
 ## 3.5.1 (2024-06-07)
 
 ### Library changes

data/core/array.rbs

@@ -1082,7 +1082,7 @@ class Array[unchecked out Elem] < Object
   #     a.at(0) # => :foo
   #     a.at(2) # => 2
   #
-  def at: (int index) -> Elem?
+  def at: %a{implicitly-returns-nil} (int index) -> Elem
 
   # <!--
   #   rdoc-file=array.c
@@ -1378,7 +1378,7 @@ class Array[unchecked out Elem] < Object
   #
   # If `index` is too small (far from zero), returns nil.
   #
-  def delete_at: (int index) -> Elem?
+  def delete_at: %a{implicitly-returns-nil} (int index) -> Elem
 
   # <!--
   #   rdoc-file=array.c
@@ -1942,7 +1942,7 @@ class Array[unchecked out Elem] < Object
   #
   # Related: #last.
   #
-  def first: () -> Elem?
+  def first: %a{implicitly-returns-nil} () -> Elem
            | (int n) -> ::Array[Elem]
 
   # <!--
@@ -2241,7 +2241,7 @@ class Array[unchecked out Elem] < Object
   #
   # Related: #first.
   #
-  def last: () -> Elem?
+  def last: %a{implicitly-returns-nil} () -> Elem
           | (int n) -> ::Array[Elem]
 
   # <!--
@@ -2321,8 +2321,8 @@ class Array[unchecked out Elem] < Object
   #
   #     ['0', '00', '000'].max(2) {|a, b| a.size <=> b.size } # => ["000", "00"]
   #
-  def max: () -> Elem?
-         | () { (Elem a, Elem b) -> ::Integer? } -> Elem?
+  def max: %a{implicitly-returns-nil} () -> Elem
+         | %a{implicitly-returns-nil} () { (Elem a, Elem b) -> ::Integer? } -> Elem
          | (int n) -> ::Array[Elem]
          | (int n) { (Elem a, Elem b) -> ::Integer? } -> ::Array[Elem]
 
@@ -3118,7 +3118,7 @@ class Array[unchecked out Elem] < Object
   #     a.sample(random: Random.new(1))     #=> 6
   #     a.sample(4, random: Random.new(1))  #=> [6, 10, 9, 2]
   #
-  def sample: (?random: _Rand rng) -> Elem?
+  def sample: %a{implicitly-returns-nil} (?random: _Rand rng) -> Elem
             | (int n, ?random: _Rand rng) -> ::Array[Elem]
 
   # <!--
@@ -3197,7 +3197,7 @@ class Array[unchecked out Elem] < Object
   #
   # Related: #push, #pop, #unshift.
   #
-  def shift: () -> Elem?
+  def shift: %a{implicitly-returns-nil} () -> Elem
            | (int n) -> ::Array[Elem]
 
   # <!--
@@ -3323,7 +3323,7 @@ class Array[unchecked out Elem] < Object
   #     # Raises TypeError (no implicit conversion of Symbol into Integer):
   #     a[:foo]
   #
-  def slice: (int index) -> Elem?
+  def slice: %a{implicitly-returns-nil} (int index) -> Elem
            | (int start, int length) -> ::Array[Elem]?
            | (::Range[::Integer] range) -> ::Array[Elem]?
 
@@ -3393,7 +3393,7 @@ class Array[unchecked out Elem] < Object
   #     a.slice!(-2..2) # => ["bar", 2]
   #     a # => [:foo]
   #
-  def slice!: (int index) -> Elem?
+  def slice!: %a{implicitly-returns-nil} (int index) -> Elem
             | (int start, int length) -> ::Array[Elem]?
             | (::Range[::Integer] range) -> ::Array[Elem]?
 

data/core/basic_object.rbs

@@ -163,7 +163,7 @@ class BasicObject
   #     k = Klass.new
   #     k.send :hello, "gentle", "readers"   #=> "Hello gentle readers"
   #
-  def __send__: (interned name, *untyped, **untyped) ?{ (*untyped, **untyped) -> untyped } -> untyped
+  def __send__: (interned name, *untyped, **untyped) ?{ (?) -> untyped } -> untyped
 
   # <!-- rdoc-file=object.c -->
   # Equality --- At the Object level, #== returns `true` only if `obj` and `other`
@@ -248,7 +248,7 @@ class BasicObject
   #     k = KlassWithSecret.new
   #     k.instance_exec(5) {|x| @secret+x }   #=> 104
   #
-  def instance_exec: [U, V] (*V args) { (*V args) [self: self] -> U } -> U
+  def instance_exec: [U] (*untyped, **untyped) { (?) [self: self] -> U } -> U
 
   # <!--
   #   rdoc-file=object.c
@@ -295,7 +295,7 @@ class BasicObject
   #     r.mm      #=> 2000
   #     r.foo     #=> NoMethodError
   #
-  def method_missing: (Symbol, *untyped, **untyped) ?{ (*untyped, **untyped) -> untyped } -> untyped
+  def method_missing: (Symbol, *untyped, **untyped) ?{ (?) -> untyped } -> untyped
 
   # <!--
   #   rdoc-file=object.c

data/core/enumerable.rbs

@@ -528,6 +528,12 @@ module Enumerable[unchecked out Elem] : _Each[Elem]
   #
   def entries: () -> ::Array[Elem]
 
+  def enum_for: (Symbol method, *untyped, **untyped) ?{ (?) -> Integer } -> Enumerator[untyped, untyped]
+    | () ?{ () -> Integer } -> Enumerator[Elem, self]
+
+  %a{annotate:rdoc:skip}
+  alias to_enum enum_for
+
   # <!--
   #   rdoc-file=enum.c
   #   - select {|element| ... } -> array

data/core/enumerator.rbs

@@ -130,6 +130,13 @@
 class Enumerator[unchecked out Elem, out Return] < Object
   include Enumerable[Elem]
 
+  # A convenience interface for `each` with optional block
+  #
+  interface _Each[out E, out R]
+    def each: () { (E) -> void } -> R
+            | () -> Enumerator[E, R]
+  end
+
   # <!--
   #   rdoc-file=enumerator.c
   #   - Enumerator.produce(initial = nil) { |prev| block } -> enumerator

data/core/fiber.rbs

@@ -268,7 +268,7 @@ class Fiber < Object
   # Explicitly using `storage: true` is currently experimental and may change in
   # the future.
   #
-  def initialize: (?blocking: boolish, ?storage: true | Hash[interned, untyped] | nil) { (*untyped) -> void } -> void
+  def initialize: (?blocking: boolish, ?storage: true | Hash[interned, untyped] | nil) { (?) -> void } -> void
 
   # <!--
   #   rdoc-file=cont.c

data/core/global_variables.rbs

@@ -118,7 +118,7 @@ $;: Regexp | String | nil
 $<: RBS::Unnamed::ARGFClass
 
 # This variable is no longer effective. Deprecated.
-$=: bool
+$=: false
 
 # The default output stream for Kernel#print and Kernel#printf. $stdout by default.
 $>: IO
@@ -150,7 +150,7 @@ $LOADED_FEATURES: Array[String]
 $LOAD_PATH: Array[String] & _LoadPathAPI
 
 interface _LoadPathAPI
-  def resolve_feature_path: (String) -> [:rb | :so, String]?
+  def resolve_feature_path: (path feature_path) -> [:rb | :so, String]?
 end
 
 # Contains the name of the script being executed. May be assignable.

data/core/kernel.rbs

@@ -282,7 +282,7 @@ module Kernel : BasicObject
   #     1.class      #=> Integer
   #     self.class   #=> Object
   #
-  def class: () -> untyped
+  def class: () -> Class
 
   # <!--
   #   rdoc-file=vm_eval.c
@@ -2066,7 +2066,7 @@ module Kernel : BasicObject
   # Returns true if two objects do not match (using the *=~* method), otherwise
   # false.
   #
-  def !~: (untyped) -> bool
+  def !~: (untyped other) -> bool
 
   # <!--
   #   rdoc-file=object.c
@@ -2086,7 +2086,7 @@ module Kernel : BasicObject
   # When you define #<=>, you can include Comparable to gain the methods #<=, #<,
   # #==, #>=, #> and #between?.
   #
-  def <=>: (untyped) -> Integer?
+  def <=>: (untyped other) -> 0?
 
   # <!--
   #   rdoc-file=object.c
@@ -2096,7 +2096,7 @@ module Kernel : BasicObject
   # typically overridden by descendants to provide meaningful semantics in `case`
   # statements.
   #
-  def ===: (untyped) -> bool
+  alias === ==
 
   # <!--
   #   rdoc-file=kernel.rb
@@ -2152,8 +2152,8 @@ module Kernel : BasicObject
   #     chris.define_singleton_method(:greet) {|greeting| "#{greeting}, I'm Chris!" }
   #     chris.greet("Hi") #=> "Hi, I'm Chris!"
   #
-  def define_singleton_method: (interned, Method | UnboundMethod | Proc method) -> Symbol
-                             | (interned) { (*untyped) -> untyped } -> Symbol
+  def define_singleton_method: (interned name, Method | UnboundMethod | Proc method) -> Symbol
+                             | (interned name) { (?) -> untyped } -> Symbol
 
   # <!--
   #   rdoc-file=io.c
@@ -2170,7 +2170,7 @@ module Kernel : BasicObject
   #
   #     1cat[4, 5, 6]
   #
-  def display: (?_Writer port) -> void
+  def display: (?_Writer port) -> nil
 
   # <!--
   #   rdoc-file=object.c
@@ -2210,7 +2210,7 @@ module Kernel : BasicObject
   #     s3 = s1.dup #=> #<Klass:0x401c1084>
   #     s3.foo #=> NoMethodError: undefined method `foo' for #<Klass:0x401c1084>
   #
-  def dup: () -> self
+  def dup: () -> instance
 
   # <!-- rdoc-file=enumerator.c -->
   # Creates a new Enumerator which will enumerate by calling `method` on `obj`,
@@ -2267,10 +2267,8 @@ module Kernel : BasicObject
   #     enum.first(4) # => [1, 1, 1, 2]
   #     enum.size # => 42
   #
-  def enum_for: (Symbol method, *untyped, **untyped) ?{ (*untyped, **untyped) -> Integer } -> Enumerator[untyped, untyped]
-              | () ?{ () -> Integer } -> Enumerator[untyped, self]
+  def enum_for: (?interned method, *untyped, **untyped) ?{ (*untyped, **untyped) -> Integer } -> Enumerator[untyped, untyped]
 
-  %a{annotate:rdoc:skip}
   alias to_enum enum_for
 
   # <!--
@@ -2308,7 +2306,7 @@ module Kernel : BasicObject
   #     1 == 1.0     #=> true
   #     1.eql? 1.0   #=> false
   #
-  def eql?: (untyped) -> bool
+  def eql?: (untyped other) -> bool
 
   # <!--
   #   rdoc-file=eval.c
@@ -2333,7 +2331,7 @@ module Kernel : BasicObject
   #     k.extend(Mod)   #=> #<Klass:0x401b3bc8>
   #     k.hello         #=> "Hello from Mod.\n"
   #
-  def extend: (Module, *Module) -> self
+  def extend: (Module module, *Module other_modules) -> self
 
   # <!--
   #   rdoc-file=object.c
@@ -2447,7 +2445,7 @@ module Kernel : BasicObject
   #     b.instance_of? B   #=> true
   #     b.instance_of? C   #=> false
   #
-  def instance_of?: (Module) -> bool
+  def instance_of?: (Module | Class module_or_class) -> bool
 
   # <!--
   #   rdoc-file=object.c
@@ -2467,7 +2465,7 @@ module Kernel : BasicObject
   #     fred.instance_variable_defined?("@b")   #=> true
   #     fred.instance_variable_defined?("@c")   #=> false
   #
-  def instance_variable_defined?: (interned var) -> bool
+  def instance_variable_defined?: (interned variable) -> bool
 
   # <!--
   #   rdoc-file=object.c
@@ -2489,7 +2487,7 @@ module Kernel : BasicObject
   #     fred.instance_variable_get(:@a)    #=> "cat"
   #     fred.instance_variable_get("@b")   #=> 99
   #
-  def instance_variable_get: (interned var) -> untyped
+  def instance_variable_get: (interned variable) -> untyped
 
   # <!--
   #   rdoc-file=object.c
@@ -2512,7 +2510,7 @@ module Kernel : BasicObject
   #     fred.instance_variable_set(:@c, 'cat')   #=> "cat"
   #     fred.inspect                             #=> "#<Fred:0x401b3da8 @a=\"dog\", @b=99, @c=\"cat\">"
   #
-  def instance_variable_set: [X] (interned var, X value) -> X
+  def instance_variable_set: [T] (interned variable, T value) -> T
 
   # <!--
   #   rdoc-file=object.c
@@ -2553,9 +2551,8 @@ module Kernel : BasicObject
   #     b.kind_of? C       #=> false
   #     b.kind_of? M       #=> true
   #
-  def is_a?: (Module) -> bool
+  def is_a?: (Module | Class module_or_class) -> bool
 
-  %a{annotate:rdoc:skip}
   alias kind_of? is_a?
 
   # <!--
@@ -2636,7 +2633,7 @@ module Kernel : BasicObject
   #     k.extend M123
   #     k.methods(false)   #=> [:singleton_method]
   #
-  def methods: () -> Array[Symbol]
+  def methods: (?boolish regular) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=object.c
@@ -2647,7 +2644,7 @@ module Kernel : BasicObject
   #     Object.new.nil?   #=> false
   #     nil.nil?          #=> true
   #
-  def nil?: () -> bool
+  def nil?: () -> false
 
   # <!--
   #   rdoc-file=gc.c
@@ -2672,7 +2669,7 @@ module Kernel : BasicObject
   #     "hello".object_id     == "hello".object_id     # => false
   #     "hi".freeze.object_id == "hi".freeze.object_id # => true
   #
-  def object_id: () -> Integer
+  alias object_id __id__
 
   # <!--
   #   rdoc-file=object.c
@@ -2682,7 +2679,7 @@ module Kernel : BasicObject
   # parameter is set to `false`, only those methods in the receiver will be
   # listed.
   #
-  def private_methods: () -> Array[Symbol]
+  def private_methods: (?boolish all) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=object.c
@@ -2692,7 +2689,7 @@ module Kernel : BasicObject
   # parameter is set to `false`, only those methods in the receiver will be
   # listed.
   #
-  def protected_methods: () -> Array[Symbol]
+  def protected_methods: (?boolish all) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=proc.c
@@ -2722,7 +2719,7 @@ module Kernel : BasicObject
   #
   #     1.public_send(:puts, "hello")  # causes NoMethodError
   #
-  def public_send: (interned name, *untyped args) ?{ (*untyped) -> untyped } -> untyped
+  def public_send: (interned name, *untyped, **untyped) ?{ (?) -> untyped } -> untyped
 
   # <!--
   #   rdoc-file=object.c
@@ -2746,7 +2743,7 @@ module Kernel : BasicObject
   #     d.remove   #=> 99
   #     d.var      #=> nil
   #
-  def remove_instance_variable: (interned name) -> untyped
+  def remove_instance_variable: (interned variable) -> untyped
 
   # <!--
   #   rdoc-file=vm_method.c
@@ -2782,8 +2779,7 @@ module Kernel : BasicObject
   #
   # See #respond_to?, and the example of BasicObject.
   #
-  %a{annotate:rdoc:copy:Object#respond_to_missing?}
-  private def respond_to_missing?: (Symbol, bool) -> bool
+  private def respond_to_missing?: (Symbol | String name, bool include_all) -> bool
 
   # <!--
   #   rdoc-file=vm_eval.c
@@ -2808,7 +2804,7 @@ module Kernel : BasicObject
   #     k = Klass.new
   #     k.send :hello, "gentle", "readers"   #=> "Hello gentle readers"
   #
-  def send: (interned name, *untyped args) ?{ (*untyped) -> untyped } -> untyped
+  alias send __send__
 
   # <!--
   #   rdoc-file=object.c
@@ -2883,7 +2879,7 @@ module Kernel : BasicObject
   #     a.singleton_methods(false)  #=> [:two, :one]
   #     a.singleton_methods         #=> [:two, :one, :three]
   #
-  def singleton_methods: () -> Array[Symbol]
+  def singleton_methods: (?boolish all) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=kernel.rb
@@ -2919,17 +2915,50 @@ module Kernel : BasicObject
   #
   #     "my string".yield_self {|s| s.upcase }   #=> "MY STRING"
   #
-  def yield_self: [X] () { (self) -> X } -> X
-                | () -> Enumerator[self, untyped]
+  def yield_self: () -> Enumerator[self, untyped]
+                | [T] () { (self) -> T } -> T
 
-  %a{annotate:rdoc:skip}
+  # <!--
+  #   rdoc-file=kernel.rb
+  #   - obj.then {|x| block }          -> an_object
+  # -->
+  # Yields self to the block and returns the result of the block.
+  #
+  #     3.next.then {|x| x**x }.to_s             #=> "256"
+  #
+  # Good usage for `then` is value piping in method chains:
+  #
+  #     require 'open-uri'
+  #     require 'json'
+  #
+  #     construct_url(arguments).
+  #       then {|url| URI(url).read }.
+  #       then {|response| JSON.parse(response) }
+  #
+  # When called without block, the method returns `Enumerator`, which can be used,
+  # for example, for conditional circuit-breaking:
+  #
+  #     # meets condition, no-op
+  #     1.then.detect(&:odd?)            # => 1
+  #     # does not meet condition, drop value
+  #     2.then.detect(&:odd?)            # => nil
+  #
+  # Good usage for `then` is value piping in method chains:
+  #
+  #     require 'open-uri'
+  #     require 'json'
+  #
+  #     construct_url(arguments).
+  #       then {|url| URI(url).read }.
+  #       then {|response| JSON.parse(response) }
+  #
   alias then yield_self
 
-  private def initialize_copy: (self object) -> self
+  private
 
-  private def initialize_clone: (self object, ?freeze: bool?) -> self
+  def initialize_copy: (instance object) -> self
 
-  private def initialize_dup: (self object) -> self
-end
+  def initialize_clone: (instance object, ?freeze: bool?) -> self
 
-Kernel::RUBYGEMS_ACTIVATION_MONITOR: untyped
+  def initialize_dup: (instance object) -> self
+end