rbs 3.6.0.pre.1 → 3.6.0.pre.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6884f033b29e9db43f782ee20e91a89d329fa51271d015fe0d25d4f4c1dd8166
-  data.tar.gz: 11db8e1f37cae5204b74d126c80e7b6b75990a33dec81f00519967a517cdf17e
+  metadata.gz: e6d0650c01c5b470a842e74e253097e5b49110518a03fa7d10a436d8c1ca396c
+  data.tar.gz: 5b99332dbafc318d5db5b4de03f09654b35b4108c7e126f2132db9e74d872d6c
 SHA512:
-  metadata.gz: 9193fb829e1503c2179cc802c20b37bd1b8ed25417bf032a642da25689e0709a753525f5bf2424c57caf4bc57aeb9a5cf03c0062b11e2d36632b1e8b6ae77c31
-  data.tar.gz: 13a766ee6f81f3ad426af8e6de51289fea8d656b848d038afc15fc21eda0fabc3f525e5035df02b09948113ae0f8ada0965ede862cd17efb52a72ce42631862a
+  metadata.gz: 15ec712879343b5ab4ebb39d085a29e55d5ad51efd30fb2d294d0bea9e90d483b82a8093d9d00c25572bac3b9f6c25733e2099066f39914192d49baee3b449dc
+  data.tar.gz: 50092cb860beb679e653e457b11ceb169ae588511d82308243cb32fcc0e33f13e00ca5196971cfaf583e25534c5370ec8a592b1d1df132d230ed8d951aabcf3c

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # CHANGELOG
 
+## 3.6.0.pre.3 (2024-09-30)
+
+### Signature updates
+
+* `JSON.load_file`, `.load_file!` ([#2031](https://github.com/ruby/rbs/pull/2031))
+* `Module#class_eval`, `Module#module_eval` ([#2029](https://github.com/ruby/rbs/pull/2029))
+* `Open3` ([#2014](https://github.com/ruby/rbs/pull/2014))
+* `RubyVM::InstructionSequence` ([#2027](https://github.com/ruby/rbs/pull/2027))
+* Fixup RBS type definitions with rbs-on-rubocop ([#2023](https://github.com/ruby/rbs/pull/2023))
+* Avoid using `instance`/`class` types in modules ([#2020](https://github.com/ruby/rbs/pull/2020))
+
+### Language updates
+
+* Optional type param restriction ([#2030](https://github.com/ruby/rbs/pull/2030))
+* Prohibit `self` type as a generics default ([#2022](https://github.com/ruby/rbs/pull/2022))
+* Allow `self` types in generics default type ([#2021](https://github.com/ruby/rbs/pull/2021))
+
+### Library changes
+
+* Add `TypeParamDefaultReferenceError#type_param` ([#2032](https://github.com/ruby/rbs/pull/2032))
+
+## 3.6.0.pre.2 (2024-09-18)
+
+### Signature updates
+
+* `Kernel#class` ([#2017](https://github.com/ruby/rbs/pull/2017))
+* `TracePoint#enable` ([#2015](https://github.com/ruby/rbs/pull/2015))
+
+### Miscellaneous
+
+* Fix type definition and type errors ([#2016](https://github.com/ruby/rbs/pull/2016))
+
 ## 3.6.0.pre.1 (2024-09-17)
 
 ### Signature updates

data/Rakefile

@@ -56,7 +56,7 @@ end
 task :validate => :compile do
   require 'yaml'
 
-  sh "#{ruby} #{rbs} validate"
+  sh "#{ruby} #{rbs} validate --exit-error-on-syntax-error"
 
   libs = FileList["stdlib/*"].map {|path| File.basename(path).to_s }
 
@@ -72,7 +72,7 @@ task :validate => :compile do
   end
 
   libs.each do |lib|
-    sh "#{ruby} #{rbs} -r #{lib} validate"
+    sh "#{ruby} #{rbs} -r #{lib} validate --exit-error-on-syntax-error"
   end
 end
 

data/core/array.rbs

@@ -600,8 +600,6 @@ class Array[unchecked out Elem] < Object
   #
   def self.try_convert: [U] (untyped) -> ::Array[U]?
 
-  public
-
   # <!--
   #   rdoc-file=array.c
   #   - array & other_array -> new_array

data/core/complex.rbs

@@ -109,8 +109,6 @@ class Complex < Numeric
   #
   alias self.rectangular self.rect
 
-  public
-
   # <!--
   #   rdoc-file=complex.c
   #   - complex * numeric -> new_complex

data/core/data.rbs

@@ -183,8 +183,6 @@ class Data
 
   def self.allocate: () -> bot
 
-  public
-
   # <!--
   #   rdoc-file=struct.c
   #   - self == other -> true or false

data/core/dir.rbs

@@ -759,8 +759,6 @@ class Dir
   #
   alias self.unlink self.delete
 
-  public
-
   # <!--
   #   rdoc-file=dir.c
   #   - chdir -> 0

data/core/encoding.rbs

@@ -780,8 +780,6 @@ class Encoding::Converter < Object
                               ?xml: :text | :attr
                             ) -> conversion_path
 
-  public
-
   # <!--
   #   rdoc-file=transcode.c
   #   - ec == other        -> true or false

data/core/enumerator/product.rbs

@@ -44,8 +44,6 @@ class Enumerator[unchecked out Elem, out Return = void]
     #
     def initialize: (*_EachEntry[Elem]) -> void
 
-    public
-
     # <!--
     #   rdoc-file=enumerator.c
     #   - obj.each { |...| ... } -> obj

data/core/enumerator.rbs

@@ -132,7 +132,7 @@ class Enumerator[unchecked out Elem, out Return = void] < Object
 
   # A convenience interface for `each` with optional block
   #
-  interface _Each[out E, out R = self]
+  interface _Each[out E, out R]
     def each: () { (E) -> void } -> R
             | () -> Enumerator[E, R]
   end

data/core/errors.rbs

@@ -270,8 +270,6 @@ class NameError[T] < StandardError
   #
   def initialize: (?string msg, ?String? name, ?receiver: T?) -> void
 
-  public
-
   # <!--
   #   rdoc-file=error.c
   #   - name_error.local_variables  ->  array
@@ -362,8 +360,6 @@ class NoMethodError[T] < NameError[T]
   #
   def initialize: (?string? msg, ?String? name, ?Array[untyped] args, ?boolish `private`, ?receiver: T?) -> void
 
-  public
-
   # <!--
   #   rdoc-file=error.c
   #   - no_method_error.args  -> obj
@@ -471,8 +467,6 @@ class SignalException < Exception
   def initialize: (?string sig_name) -> void
                 | (int sig_number, ?string sig_name) -> void
 
-  public
-
   def signm: () -> String
 
   # <!--
@@ -608,8 +602,6 @@ class SystemCallError < StandardError
   #
   def self.===: (untyped other) -> bool
 
-  public
-
   # <!--
   #   rdoc-file=error.c
   #   - system_call_error.errno   -> integer
@@ -637,8 +629,6 @@ class SystemExit < Exception
                 | (string msg) -> void
                 | (true | false | int status, ?string msg) -> void
 
-  public
-
   # <!--
   #   rdoc-file=error.c
   #   - system_exit.status   -> integer
@@ -726,8 +716,6 @@ class UncaughtThrowError < ArgumentError
   #
   def initialize: (untyped tag, untyped value) -> void
 
-  public
-
   # <!--
   #   rdoc-file=vm_eval.c
   #   - uncaught_throw.tag   -> obj

data/core/file.rbs

@@ -1769,8 +1769,6 @@ class File < IO
   #
   def self.zero?: (string | _ToPath | IO file_name) -> bool
 
-  public
-
   # <!--
   #   rdoc-file=file.c
   #   - file.atime    -> time

data/core/float.rbs

@@ -80,8 +80,6 @@
 # *   #truncate: Returns `self` truncated to a given precision.
 #
 class Float < Numeric
-  public
-
   # <!--
   #   rdoc-file=numeric.c
   #   - self % other -> float

data/core/hash.rbs

@@ -559,8 +559,6 @@ class Hash[unchecked out K, unchecked out V] < Object
   def self.try_convert: [U, V] (_ToHash[U, V]) -> ::Hash[U, V]
                       | (untyped) -> (::Hash[untyped, untyped] | nil)
 
-  public
-
   # <!--
   #   rdoc-file=hash.c
   #   - hash < other_hash -> true or false

data/core/integer.rbs

@@ -149,8 +149,6 @@ class Integer < Numeric
   def self.try_convert: (int) -> Integer
                       | (untyped) -> Integer?
 
-  public
-
   # <!--
   #   rdoc-file=numeric.c
   #   - self % other -> real_number

data/core/io/buffer.rbs

@@ -184,8 +184,6 @@ class IO
     #
     def self.string: (int) { (Buffer) -> void } -> String
 
-    public
-
     # <!--
     #   rdoc-file=io_buffer.c
     #   - <=>(other) -> true or false

data/core/kernel.rbs

@@ -2210,7 +2210,7 @@ module Kernel : BasicObject
   #     s3 = s1.dup #=> #<Klass:0x401c1084>
   #     s3.foo #=> NoMethodError: undefined method `foo' for #<Klass:0x401c1084>
   #
-  def dup: () -> instance
+  def dup: () -> self
 
   # <!-- rdoc-file=enumerator.c -->
   # Creates a new Enumerator which will enumerate by calling `method` on `obj`,
@@ -2956,9 +2956,9 @@ module Kernel : BasicObject
 
   private
 
-  def initialize_copy: (instance object) -> self
+  def initialize_copy: (self object) -> self
 
-  def initialize_clone: (instance object, ?freeze: bool?) -> self
+  def initialize_clone: (self object, ?freeze: bool?) -> self
 
-  def initialize_dup: (instance object) -> self
+  def initialize_dup: (self object) -> self
 end

data/core/module.rbs

@@ -377,7 +377,7 @@ class Module < Object
   #         or method `code' for Thing:Class
   #
   def class_eval: (String arg0, ?String filename, ?Integer lineno) -> untyped
-                | [U] () { (self m) -> U } -> U
+                | [U] () { (self m) [self: self] -> U } -> U
 
   # <!-- rdoc-file=vm_eval.c -->
   # Evaluates the given block in the context of the class/module. The method
@@ -1083,7 +1083,7 @@ class Module < Object
   #         or method `code' for Thing:Class
   #
   def module_eval: (String arg0, ?String filename, ?Integer lineno) -> untyped
-                 | [U] () { (self m) -> U } -> U
+                 | [U] () { (self m) [self: self] -> U } -> U
 
   # <!--
   #   rdoc-file=vm_eval.c

data/core/numeric.rbs

@@ -162,8 +162,6 @@
 class Numeric
   include Comparable
 
-  public
-
   # <!--
   #   rdoc-file=numeric.c
   #   - self % other -> real_numeric

data/core/object_space/weak_key_map.rbs

@@ -59,8 +59,6 @@ module ObjectSpace
   # sitting in the cache forever.
   #
   class WeakKeyMap[Key, Value]
-    public
-
     # <!--
     #   rdoc-file=weakmap.c
     #   - map[key] -> value

data/core/ractor.rbs

@@ -597,8 +597,6 @@ class Ractor
   #
   def self.yield: (untyped obj, ?move: boolish) -> untyped
 
-  public
-
   # <!--
   #   rdoc-file=ractor.rb
   #   - <<(obj, move: false)
@@ -925,8 +923,6 @@ class Ractor
   #     # Ractor::MovedError (can not send any methods to a moved object)
   #
   class MovedObject < BasicObject
-    public
-
     # <!--
     #   rdoc-file=ractor.c
     #   - !(*args)
@@ -1007,8 +1003,6 @@ class Ractor
   #     end
   #
   class RemoteError < Ractor::Error
-    public
-
     def ractor: () -> Ractor
   end
 

data/core/rational.rbs

@@ -48,8 +48,6 @@
 #                        #=> (1.0000000000000002+1.7320508075688772i)
 #
 class Rational < Numeric
-  public
-
   def %: (Integer) -> Rational
        | (Float) -> Float
        | (Rational) -> Rational

data/core/rbs/unnamed/argf.rbs

@@ -45,8 +45,6 @@ module RBS
     class ARGFClass
       include Enumerable[String]
 
-      public
-
       # <!--
       #   rdoc-file=io.c
       #   - ARGF.argv  -> ARGV

data/core/ruby_vm.rbs

@@ -50,6 +50,311 @@ RubyVM::OPTS: Array[String]
 # Of course, this class is MRI specific.
 #
 class RubyVM::InstructionSequence < Object
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - absolute_path()
+  # -->
+  # Returns the absolute path of this instruction sequence.
+  #
+  # `nil` if the iseq was evaluated from a string.
+  #
+  # For example, using ::compile_file:
+  #
+  #     # /tmp/method.rb
+  #     def hello
+  #       puts "hello, world"
+  #     end
+  #
+  #     # in irb
+  #     > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
+  #     > iseq.absolute_path #=> /tmp/method.rb
+  #
+  def absolute_path: () -> String?
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - base_label()
+  # -->
+  # Returns the base label of this instruction sequence.
+  #
+  # For example, using irb:
+  #
+  #     iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
+  #     #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
+  #     iseq.base_label
+  #     #=> "<compiled>"
+  #
+  # Using ::compile_file:
+  #
+  #     # /tmp/method.rb
+  #     def hello
+  #       puts "hello, world"
+  #     end
+  #
+  #     # in irb
+  #     > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
+  #     > iseq.base_label #=> <main>
+  #
+  def base_label: () -> String
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - iseq.disasm -> str
+  #   - iseq.disassemble -> str
+  # -->
+  # Returns the instruction sequence as a `String` in human readable form.
+  #
+  #     puts RubyVM::InstructionSequence.compile('1 + 2').disasm
+  #
+  # Produces:
+  #
+  #     == disasm: <RubyVM::InstructionSequence:<compiled>@<compiled>>==========
+  #     0000 trace            1                                               (   1)
+  #     0002 putobject        1
+  #     0004 putobject        2
+  #     0006 opt_plus         <ic:1>
+  #     0008 leave
+  #
+  def disasm: () -> String
+
+  # <!-- rdoc-file=iseq.c -->
+  # Returns the instruction sequence as a `String` in human readable form.
+  #
+  #     puts RubyVM::InstructionSequence.compile('1 + 2').disasm
+  #
+  # Produces:
+  #
+  #     == disasm: <RubyVM::InstructionSequence:<compiled>@<compiled>>==========
+  #     0000 trace            1                                               (   1)
+  #     0002 putobject        1
+  #     0004 putobject        2
+  #     0006 opt_plus         <ic:1>
+  #     0008 leave
+  #
+  def disassemble: () -> String
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - iseq.each_child{|child_iseq| ...} -> iseq
+  # -->
+  # Iterate all direct child instruction sequences. Iteration order is
+  # implementation/version defined so that people should not rely on the order.
+  #
+  def each_child: () -> RubyVM::InstructionSequence
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - iseq.eval -> obj
+  # -->
+  # Evaluates the instruction sequence and returns the result.
+  #
+  #     RubyVM::InstructionSequence.compile("1 + 2").eval #=> 3
+  #
+  def eval: () -> untyped
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - first_lineno()
+  # -->
+  # Returns the number of the first source line where the instruction sequence was
+  # loaded from.
+  #
+  # For example, using irb:
+  #
+  #     iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
+  #     #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
+  #     iseq.first_lineno
+  #     #=> 1
+  #
+  def first_lineno: () -> Integer
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - inspect()
+  # -->
+  # Returns a human-readable string representation of this instruction sequence,
+  # including the #label and #path.
+  #
+  def inspect: () -> String
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - label()
+  # -->
+  # Returns the label of this instruction sequence.
+  #
+  # `<main>` if it's at the top level, `<compiled>` if it was evaluated from a
+  # string.
+  #
+  # For example, using irb:
+  #
+  #     iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
+  #     #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
+  #     iseq.label
+  #     #=> "<compiled>"
+  #
+  # Using ::compile_file:
+  #
+  #     # /tmp/method.rb
+  #     def hello
+  #       puts "hello, world"
+  #     end
+  #
+  #     # in irb
+  #     > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
+  #     > iseq.label #=> <main>
+  #
+  def label: () -> String
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - path()
+  # -->
+  # Returns the path of this instruction sequence.
+  #
+  # `<compiled>` if the iseq was evaluated from a string.
+  #
+  # For example, using irb:
+  #
+  #     iseq = RubyVM::InstructionSequence.compile('num = 1 + 2')
+  #     #=> <RubyVM::InstructionSequence:<compiled>@<compiled>>
+  #     iseq.path
+  #     #=> "<compiled>"
+  #
+  # Using ::compile_file:
+  #
+  #     # /tmp/method.rb
+  #     def hello
+  #       puts "hello, world"
+  #     end
+  #
+  #     # in irb
+  #     > iseq = RubyVM::InstructionSequence.compile_file('/tmp/method.rb')
+  #     > iseq.path #=> /tmp/method.rb
+  #
+  def path: () -> String
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - iseq.script_lines -> array or nil
+  # -->
+  # It returns recorded script lines if it is available. The script lines are not
+  # limited to the iseq range, but are entire lines of the source file.
+  #
+  # Note that this is an API for ruby internal use, debugging, and research. Do
+  # not use this for any other purpose. The compatibility is not guaranteed.
+  #
+  def script_lines: () -> Array[String]?
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - iseq.to_a -> ary
+  # -->
+  # Returns an Array with 14 elements representing the instruction sequence with
+  # the following data:
+  #
+  # magic
+  # :   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.
+  #
+  #     `<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.
+  #
+  #
+  # Note that this format is MRI specific and version dependent.
+  #
+  def to_a: () -> Array[untyped]
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - iseq.to_binary(extra_data = nil) -> binary str
+  # -->
+  # Returns serialized iseq binary format data as a String object. A corresponding
+  # iseq object is created by RubyVM::InstructionSequence.load_from_binary()
+  # method.
+  #
+  # String extra_data will be saved with binary data. You can access this data
+  # with RubyVM::InstructionSequence.load_from_binary_extra_data(binary).
+  #
+  # Note that the translated binary data is not portable. You can not move this
+  # binary data to another machine. You can not use the binary data which is
+  # created by another version/another architecture of Ruby.
+  #
+  def to_binary: () -> String
+
+  # <!--
+  #   rdoc-file=iseq.c
+  #   - iseq.trace_points -> ary
+  # -->
+  # Return trace points in the instruction sequence. Return an array of [line,
+  # event_symbol] pair.
+  #
+  def trace_points: () -> Array[untyped]
 end
 
 # <!-- rdoc-file=ast.rb -->

data/core/trace_point.rbs

@@ -352,8 +352,8 @@ class TracePoint
   #     trace.enable { p tp.lineno }
   #     #=> RuntimeError: access from outside
   #
-  def enable: (?target: Method | RubyVM::InstructionSequence | Proc | nil, ?target_line: int?, ?target_thread: Thread | :default | nil) -> bool
-            | [T] (?target: Method | RubyVM::InstructionSequence | Proc | nil, ?target_line: int?, ?target_thread: Thread | :default | nil) { () -> T } -> T
+  def enable: (?target: Method | UnboundMethod | RubyVM::InstructionSequence | Proc | nil, ?target_line: int?, ?target_thread: Thread | :default | nil) -> bool
+            | [T] (?target: Method | UnboundMethod | RubyVM::InstructionSequence | Proc | nil, ?target_line: int?, ?target_thread: Thread | :default | nil) { () -> T } -> T
 
   # <!--
   #   rdoc-file=trace_point.rb