rbs 3.5.3 → 3.6.0.pre.1

data/core/proc.rbs

@@ -288,8 +288,184 @@
 #
 # Numbered parameters were introduced in Ruby 2.7.
 #
-class Proc < Object
-  def clone: () -> self
+class Proc
+  interface _Callable
+    def call: (?) -> untyped
+  end
+
+  # <!--
+  #   rdoc-file=proc.c
+  #   - Proc.new {|...| block } -> a_proc
+  # -->
+  # Creates a new Proc object, bound to the current context.
+  #
+  #     proc = Proc.new { "hello" }
+  #     proc.call   #=> "hello"
+  #
+  # Raises ArgumentError if called without a block.
+  #
+  #     Proc.new    #=> ArgumentError
+  #
+  def self.new: () { (?) -> untyped } -> instance
+
+  def clone: () -> instance
+  def dup: () -> instance
+
+  # <!-- rdoc-file=proc.c -->
+  # Invokes the block, setting the block's parameters to the values in *params*
+  # using something close to method calling semantics. Returns the value of the
+  # last expression evaluated in the block.
+  #
+  #     a_proc = Proc.new {|scalar, *values| values.map {|value| value*scalar } }
+  #     a_proc.call(9, 1, 2, 3)    #=> [9, 18, 27]
+  #     a_proc[9, 1, 2, 3]         #=> [9, 18, 27]
+  #     a_proc.(9, 1, 2, 3)        #=> [9, 18, 27]
+  #     a_proc.yield(9, 1, 2, 3)   #=> [9, 18, 27]
+  #
+  # Note that `prc.()` invokes `prc.call()` with the parameters given.  It's
+  # syntactic sugar to hide "call".
+  #
+  # For procs created using #lambda or `->()` an error is generated if the wrong
+  # number of parameters are passed to the proc.  For procs created using Proc.new
+  # or Kernel.proc, extra parameters are silently discarded and missing parameters
+  # are set to `nil`.
+  #
+  #     a_proc = proc {|a,b| [a,b] }
+  #     a_proc.call(1)   #=> [1, nil]
+  #
+  #     a_proc = lambda {|a,b| [a,b] }
+  #     a_proc.call(1)   # ArgumentError: wrong number of arguments (given 1, expected 2)
+  #
+  # See also Proc#lambda?.
+  #
+  alias === call
+
+  # <!-- rdoc-file=proc.c -->
+  # Invokes the block, setting the block's parameters to the values in *params*
+  # using something close to method calling semantics. Returns the value of the
+  # last expression evaluated in the block.
+  #
+  #     a_proc = Proc.new {|scalar, *values| values.map {|value| value*scalar } }
+  #     a_proc.call(9, 1, 2, 3)    #=> [9, 18, 27]
+  #     a_proc[9, 1, 2, 3]         #=> [9, 18, 27]
+  #     a_proc.(9, 1, 2, 3)        #=> [9, 18, 27]
+  #     a_proc.yield(9, 1, 2, 3)   #=> [9, 18, 27]
+  #
+  # Note that `prc.()` invokes `prc.call()` with the parameters given.  It's
+  # syntactic sugar to hide "call".
+  #
+  # For procs created using #lambda or `->()` an error is generated if the wrong
+  # number of parameters are passed to the proc.  For procs created using Proc.new
+  # or Kernel.proc, extra parameters are silently discarded and missing parameters
+  # are set to `nil`.
+  #
+  #     a_proc = proc {|a,b| [a,b] }
+  #     a_proc.call(1)   #=> [1, nil]
+  #
+  #     a_proc = lambda {|a,b| [a,b] }
+  #     a_proc.call(1)   # ArgumentError: wrong number of arguments (given 1, expected 2)
+  #
+  # See also Proc#lambda?.
+  #
+  alias yield call
+
+  # <!--
+  #   rdoc-file=proc.c
+  #   - prc << g -> a_proc
+  # -->
+  # Returns a proc that is the composition of this proc and the given *g*. The
+  # returned proc takes a variable number of arguments, calls *g* with them then
+  # calls this proc with the result.
+  #
+  #     f = proc {|x| x * x }
+  #     g = proc {|x| x + x }
+  #     p (f << g).call(2) #=> 16
+  #
+  # See Proc#>> for detailed explanations.
+  #
+  def <<: (_Callable callable) -> Proc
+
+  # <!--
+  #   rdoc-file=proc.c
+  #   - prc >> g -> a_proc
+  # -->
+  # Returns a proc that is the composition of this proc and the given *g*. The
+  # returned proc takes a variable number of arguments, calls this proc with them
+  # then calls *g* with the result.
+  #
+  #     f = proc {|x| x * x }
+  #     g = proc {|x| x + x }
+  #     p (f >> g).call(2) #=> 8
+  #
+  # *g* could be other Proc, or Method, or any other object responding to `call`
+  # method:
+  #
+  #     class Parser
+  #       def self.call(text)
+  #          # ...some complicated parsing logic...
+  #       end
+  #     end
+  #
+  #     pipeline = File.method(:read) >> Parser >> proc { |data| puts "data size: #{data.count}" }
+  #     pipeline.call('data.json')
+  #
+  # See also Method#>> and Method#<<.
+  #
+  def >>: (_Callable callable) -> Proc
+
+  # <!--
+  #   rdoc-file=proc.c
+  #   - prc == other -> true or false
+  #   - prc.eql?(other) -> true or false
+  # -->
+  # Two procs are the same if, and only if, they were created from the same code
+  # block.
+  #
+  #     def return_block(&block)
+  #       block
+  #     end
+  #
+  #     def pass_block_twice(&block)
+  #       [return_block(&block), return_block(&block)]
+  #     end
+  #
+  #     block1, block2 = pass_block_twice { puts 'test' }
+  #     # Blocks might be instantiated into Proc's lazily, so they may, or may not,
+  #     # be the same object.
+  #     # But they are produced from the same code block, so they are equal
+  #     block1 == block2
+  #     #=> true
+  #
+  #     # Another Proc will never be equal, even if the code is the "same"
+  #     block1 == proc { puts 'test' }
+  #     #=> false
+  #
+  def ==: (untyped other) -> bool
+
+  # <!-- rdoc-file=proc.c -->
+  # Two procs are the same if, and only if, they were created from the same code
+  # block.
+  #
+  #     def return_block(&block)
+  #       block
+  #     end
+  #
+  #     def pass_block_twice(&block)
+  #       [return_block(&block), return_block(&block)]
+  #     end
+  #
+  #     block1, block2 = pass_block_twice { puts 'test' }
+  #     # Blocks might be instantiated into Proc's lazily, so they may, or may not,
+  #     # be the same object.
+  #     # But they are produced from the same code block, so they are equal
+  #     block1 == block2
+  #     #=> true
+  #
+  #     # Another Proc will never be equal, even if the code is the "same"
+  #     block1 == proc { puts 'test' }
+  #     #=> false
+  #
+  alias eql? ==
 
   # <!--
   #   rdoc-file=proc.c
@@ -379,7 +555,7 @@ class Proc < Object
   #
   # See also Proc#lambda?.
   #
-  def call: (*untyped arg0) -> untyped
+  def call: (?) -> untyped
 
   # <!-- rdoc-file=proc.c -->
   # Invokes the block, setting the block's parameters to the values in *params*
@@ -408,7 +584,7 @@ class Proc < Object
   #
   # See also Proc#lambda?.
   #
-  def []: (*untyped arg0) -> untyped
+  alias [] call
 
   # <!--
   #   rdoc-file=proc.c
@@ -455,7 +631,7 @@ class Proc < Object
   #     b = proc { :foo }
   #     p b.curry[]                  #=> :foo
   #
-  def curry: (?_ToInt arity) -> Proc
+  def curry: (?int? arity) -> Proc
 
   # <!--
   #   rdoc-file=proc.c
@@ -467,21 +643,6 @@ class Proc < Object
   #
   def hash: () -> Integer
 
-  # <!--
-  #   rdoc-file=proc.c
-  #   - Proc.new {|...| block } -> a_proc
-  # -->
-  # Creates a new Proc object, bound to the current context.
-  #
-  #     proc = Proc.new { "hello" }
-  #     proc.call   #=> "hello"
-  #
-  # Raises ArgumentError if called without a block.
-  #
-  #     Proc.new    #=> ArgumentError
-  #
-  def initialize: () { (*untyped) -> untyped } -> void
-
   # <!--
   #   rdoc-file=proc.c
   #   - prc.lambda? -> true or false
@@ -602,7 +763,7 @@ class Proc < Object
   #     prc = lambda{|x, y=42, *other|}
   #     prc.parameters(lambda: false) #=> [[:opt, :x], [:opt, :y], [:rest, :other]]
   #
-  def parameters: (?lambda: boolish) -> ::Array[[ Symbol, Symbol ]]
+  def parameters: (?lambda: boolish) -> Method::param_types
 
   # <!--
   #   rdoc-file=proc.c
@@ -611,7 +772,7 @@ class Proc < Object
   # Returns the Ruby source filename and line number containing this proc or `nil`
   # if this proc was not defined in Ruby (i.e. native).
   #
-  def source_location: () -> [ String, Integer ]
+  def source_location: () -> [String, Integer]?
 
   # <!--
   #   rdoc-file=proc.c
@@ -635,5 +796,5 @@ class Proc < Object
   # Returns the unique identifier for this proc, along with an indication of where
   # the proc was defined.
   #
-  def inspect: () -> String
+  alias inspect to_s
 end

data/core/ractor.rbs

@@ -355,7 +355,7 @@ class Ractor
   #     p r
   #     #=> #<Ractor:#3 my ractor test.rb:1 terminated>
   #
-  def self.new: (*untyped args, ?name: string) { (*untyped) -> untyped } -> Ractor
+  def self.new: (*untyped args, ?name: string) { (?) -> untyped } -> Ractor
 
   # <!--
   #   rdoc-file=ractor.rb

data/core/random.rbs

@@ -91,7 +91,7 @@ class Random < RBS::Unnamed::Random_Base
   #
   # See also Random#rand.
   #
-  def self.rand: () -> Float
+  def self.rand: (?0) -> Float
                | (Integer | ::Range[Integer] max) -> Integer
                | (Float | ::Range[Float] max) -> Float
                | [T < Numeric] (::Range[T]) -> T

data/core/range.rbs

@@ -243,6 +243,36 @@
 class Range[out Elem] < Object
   include Enumerable[Elem]
 
+  # <!--
+  #   rdoc-file=range.c
+  #   - %(n) {|element| ... } -> self
+  #   - %(n)                  -> enumerator
+  # -->
+  # Iterates over the elements of `self`.
+  #
+  # With a block given, calls the block with selected elements of the range;
+  # returns `self`:
+  #
+  #     a = []
+  #     (1..5).%(2) {|element| a.push(element) } # => 1..5
+  #     a # => [1, 3, 5]
+  #     a = []
+  #     ('a'..'e').%(2) {|element| a.push(element) } # => "a".."e"
+  #     a # => ["a", "c", "e"]
+  #
+  # With no block given, returns an enumerator, which will be of class
+  # Enumerator::ArithmeticSequence if `self` is numeric; otherwise of class
+  # Enumerator:
+  #
+  #     e = (1..5) % 2 # => ((1..5).%(2))
+  #     e.class        # => Enumerator::ArithmeticSequence
+  #     ('a'..'e') % 2 # =>  #<Enumerator: ...>
+  #
+  # Related: Range#step.
+  #
+  def %: (Numeric | int n) -> Enumerator[Elem, self]
+       | (Numeric | int n) { (Elem element) -> void } -> self
+
   # <!--
   #   rdoc-file=range.c
   #   - self == other -> true or false

data/core/rbs/unnamed/env_class.rbs

@@ -231,8 +231,8 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.fetch}
       def fetch: (String name) -> String
-              | [X] (String name, X default) -> (String | X)
-              | [X] (String name) { (String) -> X } -> (String | X)
+               | [X] (String name, X default) -> (String | X)
+               | [X] (String name) { (String) -> X } -> (String | X)
 
       # <!--
       #   rdoc-file=hash.c
@@ -382,7 +382,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.each_pair}
       def each_pair: () -> ::Enumerator[[ String, String ], self]
-                  | () { ([ String, String ]) -> void } -> self
+                   | () { ([ String, String ]) -> void } -> self
 
       # <!--
       #   rdoc-file=hash.c
@@ -479,7 +479,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.delete_if}
       def delete_if: () -> ::Enumerator[[ String, String ], self]
-                  | () { (String name, String value) -> boolish } -> self
+                   | () { (String name, String value) -> boolish } -> self
 
       # <!--
       #   rdoc-file=hash.c
@@ -501,7 +501,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.keep_if}
       def keep_if: () -> ::Enumerator[[ String, String ], self]
-                | () { (String name, String value) -> boolish } -> self
+                 | () { (String name, String value) -> boolish } -> self
 
       # <!--
       #   rdoc-file=hash.c
@@ -588,7 +588,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.reject!}
       def reject!: () -> ::Enumerator[[ String, String ], self?]
-                | () { (String name, String value) -> boolish } -> self?
+                 | () { (String name, String value) -> boolish } -> self?
 
       # <!--
       #   rdoc-file=hash.c
@@ -674,7 +674,7 @@ module RBS
       #
       %a{annotate:rdoc:copy:ENV.select!}
       def select!: () -> ::Enumerator[[ String, String ], self?]
-                | () { (String name, String value) -> boolish } -> self?
+                 | () { (String name, String value) -> boolish } -> self?
 
       # <!--
       #   rdoc-file=hash.c

data/core/rbs/unnamed/random.rbs

@@ -47,7 +47,7 @@ module RBS
       # (`-`) and add (`+`)methods, or rand will raise an ArgumentError.
       #
       %a{annotate:rdoc:copy:Random#rand}
-      def rand: () -> Float
+      def rand: (?0) -> Float
               | (Integer | ::Range[Integer] max) -> Integer
               | (Float | ::Range[Float] max) -> Float
 
@@ -200,13 +200,13 @@ module RBS
       # Generates formatted random number from raw random bytes. See Random#rand.
       #
       %a{annotate:rdoc:copy:Random::Formatter#rand}
-      def rand: () -> Float
-              | (?Float? n) -> Float
-              | (?Integer? n) -> Integer
-              | (?Numeric? n) -> Numeric
-              | (?::Range[Float]? n) -> Float
-              | (?::Range[Integer]? n) -> Integer
-              | (?::Range[Numeric]? n) -> Numeric
+      def rand: (?0) -> Float
+              | (Float? n) -> Float
+              | (Integer n) -> Integer
+              | (Numeric n) -> Numeric
+              | (::Range[Float] n) -> Float
+              | (::Range[Integer] n) -> Integer
+              | (::Range[Numeric] n) -> Numeric
 
       %a{annotate:rdoc:copy:Random::Formatter#random_byte}
       def random_bytes: (?Integer? n) -> String
@@ -224,12 +224,12 @@ module RBS
       #
       %a{annotate:rdoc:copy:Random::Formatter#random_number}
       def random_number: () -> Float
-                      | (?Float? n) -> Float
-                      | (?Integer? n) -> Integer
-                      | (?Numeric? n) -> Numeric
-                      | (?::Range[Float]? n) -> Float
-                      | (?::Range[Integer]? n) -> Integer
-                      | (?::Range[Numeric]? n) -> Numeric
+                       | (?Float? n) -> Float
+                       | (?Integer? n) -> Integer
+                       | (?Numeric? n) -> Numeric
+                       | (?::Range[Float]? n) -> Float
+                       | (?::Range[Integer]? n) -> Integer
+                       | (?::Range[Numeric]? n) -> Numeric
 
       # <!--
       #   rdoc-file=lib/random/formatter.rb

data/core/refinement.rbs

@@ -4,6 +4,21 @@
 # #import_methods.
 #
 class Refinement < Module
+  # <!--
+  #   rdoc-file=eval.c
+  #   - target    -> class_or_module
+  # -->
+  # Return the class or module refined by the receiver.
+  #
+  #     module M
+  #       refine String do
+  #       end
+  #     end
+  #
+  #     M.refinements[0].target # => String
+  #
+  def target: () -> Module?
+
   private
 
   # <!--
@@ -40,30 +55,5 @@ class Refinement < Module
   #       end
   #     end
   #
-  def import_methods: (*Module) -> self
-
-  # <!--
-  #   rdoc-file=eval.c
-  #   - refined_class    -> class
-  # -->
-  # Deprecated; prefer #target.
-  #
-  # Return the class refined by the receiver.
-  #
-  def refined_class: () -> Module
-
-  # <!--
-  #   rdoc-file=eval.c
-  #   - target    -> class_or_module
-  # -->
-  # Return the class or module refined by the receiver.
-  #
-  #     module M
-  #       refine String do
-  #       end
-  #     end
-  #
-  #     M.refinements[0].target # => String
-  #
-  def target: () -> Module
+  def import_methods: (Module module, *Module extra_modules) -> self
 end

data/core/regexp.rbs

@@ -1596,8 +1596,8 @@ class Regexp
   #     r3 = Regexp.new(r, timeout: 3.14)            # => /foo/m
   #     r3.timeout                                   # => 3.14
   #
-  def initialize: (Regexp regexp, ?timeout: _ToF?) -> self
-                | (string pattern, ?int | string | bool | nil options, ?timeout: _ToF?) -> self
+  def initialize: (Regexp regexp, ?timeout: _ToF?) -> void
+                | (string pattern, ?int | string | bool | nil options, ?timeout: _ToF?) -> void
 
   def initialize_copy: (self object) -> self
 

data/core/symbol.rbs

@@ -131,9 +131,7 @@ class Symbol
   #     Symbol.all_symbols.size    # => 9334
   #     Symbol.all_symbols.take(3) # => [:!, :"\"", :"#"]
   #
-  def self.all_symbols: () -> ::Array[Symbol]
-
-  public
+  def self.all_symbols: () -> Array[Symbol]
 
   # <!--
   #   rdoc-file=string.c
@@ -152,8 +150,8 @@ class Symbol
   #
   # Related: String#<=>.
   #
-  def <=>: (Symbol other) -> Integer
-         | (untyped other) -> Integer?
+  def <=>: (Symbol object) -> (-1 | 0 | 1)
+         | (untyped) -> (-1 | 0 | 1)?
 
   # <!--
   #   rdoc-file=string.c
@@ -161,12 +159,12 @@ class Symbol
   # -->
   # Returns `true` if `object` is the same object as `self`, `false` otherwise.
   #
-  def ==: (untyped obj) -> bool
+  def ==: (untyped object) -> bool
 
   # <!-- rdoc-file=string.c -->
   # Returns `true` if `object` is the same object as `self`, `false` otherwise.
   #
-  def ===: (untyped obj) -> bool
+  alias === ==
 
   # <!--
   #   rdoc-file=string.c
@@ -176,7 +174,7 @@ class Symbol
   # variables; see String#=~.
   #
   def =~: (Regexp regex) -> Integer?
-        | [T] (String::_MatchAgainst[self, T] object) -> T
+        | [T] (String::_MatchAgainst[String, T] object) -> T
 
   # <!--
   #   rdoc-file=string.c
@@ -188,12 +186,10 @@ class Symbol
   # -->
   # Equivalent to `symbol.to_s[]`; see String#[].
   #
-  def []: (int index) -> String?
-        | (int start, int length) -> String?
-        | (Range[Integer?] range) -> String?
-        | (Regexp regexp) -> String?
-        | (Regexp regexp, int | String capture) -> String?
-        | (String match_str) -> String?
+  def []: (int start, ?int length) -> String?
+        | (range[int?] range) -> String?
+        | (Regexp regexp, ?MatchData::capture backref) -> String?
+        | (String substring) -> String?
 
   # <!--
   #   rdoc-file=string.c
@@ -240,7 +236,7 @@ class Symbol
   #
   # Related: Symbol#casecmp?, String#casecmp.
   #
-  def casecmp: (untyped other) -> Integer?
+  def casecmp: (untyped object) -> (-1 | 0 | 1)?
 
   # <!--
   #   rdoc-file=string.c
@@ -273,7 +269,7 @@ class Symbol
   #
   # Related: Symbol#casecmp, String#casecmp?.
   #
-  def casecmp?: (untyped other) -> bool?
+  def casecmp?: (untyped object) -> bool?
 
   # <!--
   #   rdoc-file=string.c
@@ -321,7 +317,7 @@ class Symbol
   #
   # Related: Symbol#inspect, Symbol#name.
   #
-  def id2name: () -> String
+  alias id2name to_s
 
   # <!--
   #   rdoc-file=string.c
@@ -340,7 +336,7 @@ class Symbol
   #   - intern()
   # -->
   #
-  def intern: () -> Symbol
+  alias intern to_sym
 
   # <!--
   #   rdoc-file=string.c
@@ -358,8 +354,8 @@ class Symbol
   # Equivalent to `self.to_s.match`, including possible updates to global
   # variables; see String#match.
   #
-  def match: (Regexp | string pattern, ?int pos) -> MatchData?
-           | (Regexp | string pattern, ?int pos) { (MatchData) -> void } -> untyped
+  def match: (Regexp | string pattern, ?int offset) -> MatchData?
+           | [T] (Regexp | string pattern, ?int offset) { (MatchData matchdata) -> T } -> T?
 
   # <!--
   #   rdoc-file=string.c
@@ -367,7 +363,7 @@ class Symbol
   # -->
   # Equivalent to `sym.to_s.match?`; see String#match.
   #
-  def match?: (Regexp | string pattern, ?int pos) -> bool
+  def match?: (Regexp | string pattern, ?int offset) -> bool
 
   # <!-- rdoc-file=string.c -->
   # Equivalent to `self.to_s.succ.to_sym`:
@@ -378,6 +374,20 @@ class Symbol
   #
   def next: () -> Symbol
 
+  # <!--
+  #   rdoc-file=string.c
+  #   - name -> string
+  # -->
+  # Returns a frozen string representation of `self` (not including the leading
+  # colon):
+  #
+  #     :foo.name         # => "foo"
+  #     :foo.name.frozen? # => true
+  #
+  # Related: Symbol#to_s, Symbol#inspect.
+  #
+  def name: () -> String
+
   # <!-- rdoc-file=string.c -->
   # Equivalent to `self.to_s.length`; see String#length.
   #
@@ -394,7 +404,7 @@ class Symbol
   # -->
   # Equivalent to `self.to_s.start_with?`; see String#start_with?.
   #
-  def start_with?: (*string | Regexp prefixes) -> bool
+  def start_with?: (*Regexp | string prefixes) -> bool
 
   # <!--
   #   rdoc-file=string.c
@@ -445,7 +455,7 @@ class Symbol
   #
   # Related: Symbol#inspect, Symbol#name.
   #
-  alias to_s id2name
+  def to_s: () -> String
 
   # <!--
   #   rdoc-file=symbol.rb
@@ -455,7 +465,7 @@ class Symbol
   #
   # Related: String#to_sym.
   #
-  alias to_sym intern
+  def to_sym: () -> self
 
   # <!--
   #   rdoc-file=string.c
@@ -469,6 +479,4 @@ class Symbol
             | (:ascii | :lithuanian | :turkic) -> Symbol
             | (:lithuanian, :turkic) -> Symbol
             | (:turkic, :lithuanian) -> Symbol
-
-  def clone: (?freeze: true?) -> self
 end