rbs 3.3.2 → 3.4.0.pre.1

data/core/match_data.rbs

@@ -45,15 +45,16 @@
 # See also "Special global variables" section in Regexp documentation.
 #
 class MatchData
-  public
+  type capture = String | Symbol | int
+
+  def initialize_copy: (MatchData instance) -> self
 
   # <!-- rdoc-file=re.c -->
   # Returns `true` if `object` is another MatchData object whose target string,
   # regexp, match, and captures are the same as `self`, `false` otherwise.
   #
-  # MatchData#eql? is an alias for MatchData#==.
-  #
-  def ==: (untyped other) -> bool
+  def ==: (MatchData other) -> bool
+        | (untyped) -> false
 
   # <!--
   #   rdoc-file=re.c
@@ -80,10 +81,9 @@ class MatchData
   #     m['foo'] # => "h"
   #     m[:bar]  # => "ge"
   #
-  def []: (Integer idx) -> String?
-        | (Integer start, Integer length) -> ::Array[String?]
-        | (::Range[Integer] range) -> ::Array[String?]
-        | (interned name) -> String?
+  def []: (capture backref, ?nil) -> String?
+        | (int start, int length) -> Array[String?]
+        | (range[int?] range) -> Array[String?]
 
   # <!--
   #   rdoc-file=re.c
@@ -121,7 +121,7 @@ class MatchData
   #
   # Related: MatchData#end, MatchData#offset, MatchData#byteoffset.
   #
-  def begin: (Integer | interned n_or_name) -> Integer?
+  def begin: (capture backref) -> Integer?
 
   # <!--
   #   rdoc-file=re.c
@@ -139,7 +139,7 @@ class MatchData
   #     p m.byteoffset(:foo) #=> [0, 1]
   #     p m.byteoffset(:bar) #=> [2, 3]
   #
-  def byteoffset: (Integer | interned n_or_name) -> ([ Integer, Integer ] | [ nil, nil ])
+  def byteoffset: (capture backref) -> ([Integer, Integer] | [nil, nil])
 
   # <!--
   #   rdoc-file=re.c
@@ -154,7 +154,7 @@ class MatchData
   #
   # Related: MatchData.to_a.
   #
-  def captures: () -> ::Array[String?]
+  def captures: () -> Array[String?]
 
   # <!-- rdoc-file=re.c -->
   # Returns the array of captures, which are all matches except `m[0]`:
@@ -178,12 +178,12 @@ class MatchData
   #     m.deconstruct_keys([:hours, :minutes]) # => {:hours => "18", :minutes => "37"}
   #     m.deconstruct_keys(nil) # => {:hours => "18", :minutes => "37", :seconds => "22"}
   #
-  # Returns an empty hash of no named captures were defined:
+  # Returns an empty hash if no named captures were defined:
   #
   #     m = /(\d{2}):(\d{2}):(\d{2})/.match("18:37:22")
   #     m.deconstruct_keys(nil) # => {}
   #
-  def deconstruct_keys: (Array[Symbol]?) -> Hash[Symbol, String?]
+  def deconstruct_keys: (Array[Symbol]? array_of_names) -> Hash[Symbol, String?]
 
   # <!--
   #   rdoc-file=re.c
@@ -221,7 +221,7 @@ class MatchData
   #
   # Related: MatchData#begin, MatchData#offset, MatchData#byteoffset.
   #
-  def end: (Integer | interned n_or_name) -> Integer?
+  def end: (capture backref) -> Integer?
 
   # <!--
   #   rdoc-file=re.c
@@ -230,9 +230,7 @@ class MatchData
   # Returns `true` if `object` is another MatchData object whose target string,
   # regexp, match, and captures are the same as `self`, `false` otherwise.
   #
-  # MatchData#eql? is an alias for MatchData#==.
-  #
-  def eql?: (untyped other) -> bool
+  alias eql? ==
 
   # <!--
   #   rdoc-file=re.c
@@ -251,19 +249,19 @@ class MatchData
   # -->
   # Returns a string representation of `self`:
   #
-  #       m = /.$/.match("foo")
-  #       # => #<MatchData "o">
-  #       m.inspect # => "#<MatchData \"o\">"
+  #     m = /.$/.match("foo")
+  #     # => #<MatchData "o">
+  #     m.inspect # => "#<MatchData \"o\">"
   #
-  #       m = /(.)(.)(.)/.match("foo")
-  #       # => #<MatchData "foo" 1:"f" 2:"o" 3:"o">
-  #       m.inspect # => "#<MatchData \"foo\" 1:\"f\" 2:\"o\
+  #     m = /(.)(.)(.)/.match("foo")
+  #     # => #<MatchData "foo" 1:"f" 2:"o" 3:"o">
+  #     m.inspect # => "#<MatchData \"foo\" 1:\"f\" 2:\"o\
   #
-  #       m = /(.)(.)?(.)/.match("fo")
-  #       # => #<MatchData "fo" 1:"f" 2:nil 3:"o">
-  #       m.inspect # => "#<MatchData \"fo\" 1:\"f\" 2:nil 3:\"o\">"
+  #     m = /(.)(.)?(.)/.match("fo")
+  #     # => #<MatchData "fo" 1:"f" 2:nil 3:"o">
+  #     m.inspect # => "#<MatchData \"fo\" 1:\"f\" 2:nil 3:\"o\">"
   #
-  #     Related: MatchData#to_s.
+  # Related: MatchData#to_s.
   #
   def inspect: () -> String
 
@@ -274,34 +272,41 @@ class MatchData
   #     # => #<MatchData "HX1138" 1:"H" 2:"X" 3:"113" 4:"8">
   #     m.size # => 5
   #
-  # MatchData#length is an alias for MatchData.size.
-  #
-  def length: () -> Integer
+  alias length size
 
   # <!--
   #   rdoc-file=re.c
-  #   - named_captures -> hash
+  #   - named_captures(symbolize_names: false) -> hash
   # -->
-  # Returns a hash of the named captures; each key is a capture name; each value
-  # is its captured string or `nil`:
+  # Returns a hash of the named captures;
+  #     each key is a capture name; each value is its captured string or +nil+:
   #
-  #     m = /(?<foo>.)(.)(?<bar>.+)/.match("hoge")
-  #     # => #<MatchData "hoge" foo:"h" bar:"ge">
-  #     m.named_captures # => {"foo"=>"h", "bar"=>"ge"}
+  #       m = /(?<foo>.)(.)(?<bar>.+)/.match("hoge")
+  #       # => #<MatchData "hoge" foo:"h" bar:"ge">
+  #       m.named_captures # => {"foo"=>"h", "bar"=>"ge"}
   #
-  #     m = /(?<a>.)(?<b>.)/.match("01")
-  #     # => #<MatchData "01" a:"0" b:"1">
-  #     m.named_captures #=> {"a" => "0", "b" => "1"}
+  #       m = /(?<a>.)(?<b>.)/.match("01")
+  #       # => #<MatchData "01" a:"0" b:"1">
+  #       m.named_captures #=> {"a" => "0", "b" => "1"}
   #
-  #     m = /(?<a>.)(?<b>.)?/.match("0")
-  #     # => #<MatchData "0" a:"0" b:nil>
-  #     m.named_captures #=> {"a" => "0", "b" => nil}
+  #       m = /(?<a>.)(?<b>.)?/.match("0")
+  #       # => #<MatchData "0" a:"0" b:nil>
+  #       m.named_captures #=> {"a" => "0", "b" => nil}
+  #
+  #       m = /(?<a>.)(?<a>.)/.match("01")
+  #       # => #<MatchData "01" a:"0" a:"1">
+  #       m.named_captures #=> {"a" => "1"}
+  #
+  # If keyword argument `symbolize_names` is given a true value, the keys in the
+  # resulting hash are Symbols:
   #
   #     m = /(?<a>.)(?<a>.)/.match("01")
   #     # => #<MatchData "01" a:"0" a:"1">
-  #     m.named_captures #=> {"a" => "1"}
+  #     m.named_captures(symbolize_names: true) #=> {:a => "1"}
   #
-  def named_captures: () -> ::Hash[String, String?]
+  def named_captures: () -> Hash[String, String?]
+                    | (symbolize_names: true) -> Hash[Symbol, String?]
+                    | (symbolize_names: boolish) -> Hash[String | Symbol, String?]
 
   # <!--
   #   rdoc-file=re.c
@@ -322,7 +327,7 @@ class MatchData
   #     m = /(?<foo>.)(?<bar>.)(?<baz>.)/.match("hoge")
   #     m.regexp.names # => ["foo", "bar", "baz"]
   #
-  def names: () -> ::Array[String]
+  def names: () -> Array[String]
 
   # <!--
   #   rdoc-file=re.c
@@ -348,7 +353,7 @@ class MatchData
   #     m.match('foo') # => "h"
   #     m.match(:bar)  # => "ge"
   #
-  def match: (int | interned) -> String?
+  def match: (capture backref) -> String?
 
   # <!--
   #   rdoc-file=re.c
@@ -375,7 +380,7 @@ class MatchData
   #     m.match_length('foo') # => 1
   #     m.match_length(:bar)  # => 2
   #
-  def match_length: (int | interned) -> Integer?
+  def match_length: (capture backref) -> Integer?
 
   # <!--
   #   rdoc-file=re.c
@@ -414,7 +419,7 @@ class MatchData
   #
   # Related: MatchData#byteoffset, MatchData#begin, MatchData#end.
   #
-  def offset: (Integer | interned n_or_name) -> ([ Integer, Integer ] | [ nil, nil ])
+  def offset: (capture backref) -> ([Integer, Integer] | [nil, nil])
 
   # <!--
   #   rdoc-file=re.c
@@ -471,8 +476,6 @@ class MatchData
   #     # => #<MatchData "HX1138" 1:"H" 2:"X" 3:"113" 4:"8">
   #     m.size # => 5
   #
-  # MatchData#length is an alias for MatchData.size.
-  #
   def size: () -> Integer
 
   # <!--
@@ -500,7 +503,7 @@ class MatchData
   #
   # Related: MatchData#captures.
   #
-  def to_a: () -> ::Array[String?]
+  def to_a: () -> Array[String?]
 
   # <!--
   #   rdoc-file=re.c
@@ -544,9 +547,5 @@ class MatchData
   #     m.values_at(0, 1..2, :a, :b, :op)
   #     # => ["1 + 2", "1", "+", "1", "2", "+"]
   #
-  def values_at: (*Integer | interned n_or_name) -> ::Array[String?]
-
-  private
-
-  def initialize_copy: (self object) -> void
+  def values_at: (*capture | range[int?] backrefs) -> Array[String?]
 end

data/core/module.rbs

@@ -1463,7 +1463,7 @@ class Module < Object
   #
   # Returns a module, where refined methods are defined.
   #
-  def refine: (Module mod) { () -> void } -> Refinement
+  def refine: (Module mod) { () [self: Refinement] -> void } -> Refinement
 
   # <!--
   #   rdoc-file=eval.c
@@ -1527,6 +1527,50 @@ class Module < Object
   #
   def remove_method: (*interned arg0) -> self
 
+  # <!--
+  #   rdoc-file=object.c
+  #   - mod.set_temporary_name(string) -> self
+  #   - mod.set_temporary_name(nil) -> self
+  # -->
+  # Sets the temporary name of the module `mod`. This name is used as a prefix for
+  # the names of constants declared in `mod`. If the module is assigned a
+  # permanent name, the temporary name is discarded.
+  #
+  # After a permanent name is assigned, a temporary name can no longer be set, and
+  # this method raises a RuntimeError.
+  #
+  # If the name given is not a string or is a zero length string, this method
+  # raises an ArgumentError.
+  #
+  # The temporary name must not be a valid constant name, to avoid confusion with
+  # actual constants. If you attempt to set a temporary name that is a a valid
+  # constant name, this method raises an ArgumentError.
+  #
+  # If the given name is `nil`, the module becomes anonymous.
+  #
+  # Example:
+  #
+  #     m = Module.new # => #<Module:0x0000000102c68f38>
+  #     m.name #=> nil
+  #
+  #     m.set_temporary_name("fake_name") # => fake_name
+  #     m.name #=> "fake_name"
+  #
+  #     m.set_temporary_name(nil) # => #<Module:0x0000000102c68f38>
+  #     m.name #=> nil
+  #
+  #     n = Module.new
+  #     n.set_temporary_name("fake_name")
+  #
+  #     n::M = m
+  #     n::M.name #=> "fake_name::M"
+  #     N = n
+  #
+  #     N.name #=> "N"
+  #     N::M.name #=> "N::M"
+  #
+  def set_temporary_name: (string?) -> self
+
   # <!--
   #   rdoc-file=object.c
   #   - mod.singleton_class?    -> true or false

data/core/nil_class.rbs

@@ -1,90 +1,145 @@
 # <!-- rdoc-file=object.c -->
 # The class of the singleton object `nil`.
 #
+# Several of its methods act as operators:
+#
+# *   #&
+# *   #|
+# *   #===
+# *   #=~
+# *   #^
+#
+#
+# Others act as converters, carrying the concept of *nullity* to other classes:
+#
+# *   #rationalize
+# *   #to_a
+# *   #to_c
+# *   #to_h
+# *   #to_r
+# *   #to_s
+#
+#
+# Another method provides inspection:
+#
+# *   #inspect
+#
+#
+# Finally, there is this query method:
+#
+# *   #nil?
+#
 class NilClass
   def !: () -> true
 
   # <!--
   #   rdoc-file=object.c
-  #   - false & obj   -> false
-  #   - nil & obj     -> false
+  #   - false & object -> false
+  #   - nil & object   -> false
   # -->
-  # And---Returns `false`. *obj* is always evaluated as it is the argument to a
-  # method call---there is no short-circuit evaluation in this case.
+  # Returns `false`:
+  #
+  #     false & true       # => false
+  #     false & Object.new # => false
+  #
+  # Argument `object` is evaluated:
+  #
+  #     false & raise # Raises RuntimeError.
   #
   def &: (untyped obj) -> false
 
   # <!--
   #   rdoc-file=object.c
-  #   - obj === other   -> true or false
+  #   - true === other -> true or false
+  #   - false === other -> true or false
+  #   - nil === other -> true or false
   # -->
-  # Case Equality -- For class Object, effectively the same as calling `#==`, but
-  # typically overridden by descendants to provide meaningful semantics in `case`
-  # statements.
+  # Returns `true` or `false`.
+  #
+  # Like Object#==, if `object` is an instance of Object (and not an instance of
+  # one of its many subclasses).
+  #
+  # This method is commonly overridden by those subclasses, to provide meaningful
+  # semantics in `case` statements.
   #
   def ===: (nil) -> true
          | (untyped obj) -> bool
 
   # <!--
   #   rdoc-file=object.c
-  #   - nil =~ other  -> nil
+  #   - nil =~ object -> nil
   # -->
-  # Dummy pattern matching -- always returns nil.
+  # Returns `nil`.
   #
-  # This method makes it possible to `while gets =~ /re/ do`.
+  # This method makes it useful to write:
+  #
+  #     while gets =~ /re/
+  #       # ...
+  #     end
   #
   def =~: (untyped obj) -> nil
 
   # <!--
   #   rdoc-file=object.c
-  #   - false ^ obj    -> true or false
-  #   - nil   ^ obj    -> true or false
+  #   - false ^ object -> true or false
+  #   - nil ^ object   -> true or false
   # -->
-  # Exclusive Or---If *obj* is `nil` or `false`, returns `false`; otherwise,
-  # returns `true`.
+  # Returns `false` if `object` is `nil` or `false`, `true` otherwise:
+  #
+  #     nil ^ nil        # => false
+  #     nil ^ false      # => false
+  #     nil ^ Object.new # => true
   #
   def ^: (false | nil) -> false
        | (untyped obj) -> bool
 
   # <!--
   #   rdoc-file=object.c
-  #   - nil.inspect  -> "nil"
+  #   - inspect -> 'nil'
   # -->
-  # Always returns the string "nil".
+  # Returns string `'nil'`:
+  #
+  #     nil.inspect # => "nil"
   #
   def inspect: () -> "nil"
 
   # <!--
   #   rdoc-file=object.c
-  #   - nil.nil?               -> true
+  #   - nil.nil?  -> true
   # -->
-  # Only the object *nil* responds `true` to `nil?`.
+  # Returns `true`. For all other objects, method `nil?` returns `false`.
   #
   def nil?: () -> true
 
   # <!--
   #   rdoc-file=rational.c
-  #   - nil.rationalize([eps])  ->  (0/1)
+  #   - rationalize(eps = nil)  ->  (0/1)
   # -->
-  # Returns zero as a rational.  The optional argument `eps` is always ignored.
+  # Returns zero as a Rational:
+  #
+  #     nil.rationalize # => (0/1)
+  #
+  # Argument `eps` is ignored.
   #
   def rationalize: (?untyped eps) -> Rational
 
   # <!--
   #   rdoc-file=object.c
-  #   - nil.to_a    -> []
+  #   - to_a -> []
   # -->
-  # Always returns an empty array.
+  # Returns an empty Array.
   #
-  #     nil.to_a   #=> []
+  #     nil.to_a # => []
   #
   def to_a: () -> []
 
   # <!--
   #   rdoc-file=complex.c
-  #   - nil.to_c  ->  (0+0i)
+  #   - to_c -> (0+0i)
   # -->
-  # Returns zero as a complex.
+  # Returns zero as a Complex:
+  #
+  #     nil.to_c # => (0+0i)
   #
   def to_c: () -> Complex
 
@@ -100,9 +155,9 @@ class NilClass
 
   # <!--
   #   rdoc-file=object.c
-  #   - nil.to_h    -> {}
+  #   - to_h -> {}
   # -->
-  # Always returns an empty hash.
+  # Returns an empty Hash.
   #
   #     nil.to_h   #=> {}
   #
@@ -120,26 +175,34 @@ class NilClass
 
   # <!--
   #   rdoc-file=rational.c
-  #   - nil.to_r  ->  (0/1)
+  #   - to_r  ->  (0/1)
   # -->
-  # Returns zero as a rational.
+  # Returns zero as a Rational:
+  #
+  #     nil.to_r # => (0/1)
   #
   def to_r: () -> Rational
 
   # <!--
   #   rdoc-file=object.c
-  #   - nil.to_s    -> ""
+  #   - to_s -> ''
   # -->
-  # Always returns the empty string.
+  # Returns an empty String:
+  #
+  #     nil.to_s # => ""
   #
   def to_s: () -> ""
 
   # <!--
   #   rdoc-file=object.c
-  #   - false | obj   ->   true or false
-  #   - nil   | obj   ->   true or false
+  #   - false | object -> true or false
+  #   - nil   | object -> true or false
   # -->
-  # Or---Returns `false` if *obj* is `nil` or `false`; `true` otherwise.
+  # Returns `false` if `object` is `nil` or `false`, `true` otherwise:
+  #
+  #     nil | nil        # => false
+  #     nil | false      # => false
+  #     nil | Object.new # => true
   #
   def |: (nil | false) -> false
        | (untyped obj) -> bool

data/core/numeric.rbs

@@ -196,8 +196,6 @@ class Numeric
   #     (-r) % r2             # => (119/100)
   #     (-r) %-r2             # => (-21/100)
   #
-  # Numeric#modulo is an alias for Numeric#%.
-  #
   def %: (Numeric) -> Numeric
 
   # Performs addition: the class of the resulting object depends on the class of
@@ -246,8 +244,6 @@ class Numeric
   #     (-34.56).abs  #=> 34.56
   #     -34.56.abs    #=> 34.56
   #
-  # Numeric#magnitude is an alias for Numeric#abs.
-  #
   def abs: () -> Numeric
 
   # <!--
@@ -329,10 +325,9 @@ class Numeric
 
   # <!--
   #   rdoc-file=numeric.rb
-  #   - num.conj       ->  self
-  #   - num.conjugate  ->  self
+  #   - conj -> self
   # -->
-  # Returns self.
+  # Returns `self`.
   #
   def conjugate: () -> Numeric
 
@@ -421,9 +416,9 @@ class Numeric
 
   # <!--
   #   rdoc-file=numeric.rb
-  #   - num.finite?  ->  true or false
+  #   - finite? -> true or false
   # -->
-  # Returns `true` if `num` is a finite number, otherwise returns `false`.
+  # Returns `true` if `self` is a finite number, `false` otherwise.
   #
   def finite?: () -> bool
 
@@ -463,8 +458,7 @@ class Numeric
 
   # <!--
   #   rdoc-file=numeric.rb
-  #   - num.imag       ->  0
-  #   - num.imaginary  ->  0
+  #   - imag -> 0
   # -->
   # Returns zero.
   #
@@ -472,21 +466,21 @@ class Numeric
 
   # <!--
   #   rdoc-file=numeric.rb
-  #   - num.infinite?  ->  -1, 1, or nil
+  #   - infinite? -> -1, 1, or nil
   # -->
-  # Returns `nil`, -1, or 1 depending on whether the value is finite, `-Infinity`,
-  # or `+Infinity`.
+  # Returns `nil`, -1, or 1 depending on whether `self` is finite, `-Infinity`, or
+  # `+Infinity`.
   #
   def infinite?: () -> Integer?
 
   # <!--
   #   rdoc-file=numeric.rb
-  #   - num.integer?  ->  true or false
+  #   - integer? -> true or false
   # -->
-  # Returns `true` if `num` is an Integer.
+  # Returns `true` if `self` is an Integer.
   #
-  #     1.0.integer?   #=> false
-  #     1.integer?     #=> true
+  #     1.0.integer? # => false
+  #     1.integer?   # => true
   #
   def integer?: () -> bool
 
@@ -497,8 +491,6 @@ class Numeric
   #     (-34.56).abs  #=> 34.56
   #     -34.56.abs    #=> 34.56
   #
-  # Numeric#magnitude is an alias for Numeric#abs.
-  #
   alias magnitude abs
 
   # <!-- rdoc-file=numeric.c -->
@@ -530,8 +522,6 @@ class Numeric
   #     (-r) % r2             # => (119/100)
   #     (-r) %-r2             # => (-21/100)
   #
-  # Numeric#modulo is an alias for Numeric#%.
-  #
   def modulo: (Numeric) -> Numeric
 
   # <!--
@@ -600,17 +590,17 @@ class Numeric
 
   # <!--
   #   rdoc-file=numeric.rb
-  #   - num.real  ->  self
+  #   - real -> self
   # -->
-  # Returns self.
+  # Returns `self`.
   #
   def real: () -> Numeric
 
   # <!--
   #   rdoc-file=numeric.rb
-  #   - num.real?  ->  true or false
+  #   - real? -> true or false
   # -->
-  # Returns `true` if `num` is a real number (i.e. not Complex).
+  # Returns `true` if `self` is a real number (i.e. not Complex).
   #
   def real?: () -> bool
 
@@ -697,11 +687,11 @@ class Numeric
   #     The generated sequence:
   #
   #     - Begins with +self+.
-  #     - Continues at intervals of +step+ (which may not be zero).
-  #     - Ends with the last number that is within or equal to +limit+;
-  #       that is, less than or equal to +limit+ if +step+ is positive,
-  #       greater than or equal to +limit+ if +step+ is negative.
-  #       If +limit+ is not given, the sequence is of infinite length.
+  #     - Continues at intervals of +by+ (which may not be zero).
+  #     - Ends with the last number that is within or equal to +to+;
+  #       that is, less than or equal to +to+ if +by+ is positive,
+  #       greater than or equal to +to+ if +by+ is negative.
+  #       If +to+ is +nil+, the sequence is of infinite length.
   #
   #     If a block is given, calls the block with each number in the sequence;
   #     returns +self+.  If no block is given, returns an Enumerator::ArithmeticSequence.
@@ -743,7 +733,7 @@ class Numeric
   #
   #     <b>Positional Arguments</b>
   #
-  #     With optional positional arguments +limit+ and +step+,
+  #     With optional positional arguments +to+ and +by+,
   #     their values (or defaults) determine the step and limit:
   #
   #       squares = []