rbs 3.0.0.dev.2 → 3.0.0.dev.3

data/core/method.rbs

@@ -254,30 +254,6 @@ class Method < Object
   #
   def parameters: () -> ::Array[[ :req | :opt | :rest | :keyreq | :key | :keyrest | :block, Symbol ] | [ :rest | :keyrest ]]
 
-  # <!--
-  #   rdoc-file=proc.c
-  #   - meth.private? -> true or false
-  # -->
-  # Returns whether the method is private.
-  #
-  def private?: () -> bool
-
-  # <!--
-  #   rdoc-file=proc.c
-  #   - meth.protected? -> true or false
-  # -->
-  # Returns whether the method is protected.
-  #
-  def protected?: () -> bool
-
-  # <!--
-  #   rdoc-file=proc.c
-  #   - meth.public? -> true or false
-  # -->
-  # Returns whether the method is public.
-  #
-  def public?: () -> bool
-
   # <!--
   #   rdoc-file=proc.c
   #   - meth.receiver    -> object

data/core/module.rbs

@@ -85,13 +85,41 @@ class Module < Object
   #
   def self.used_modules: () -> ::Array[Module]
 
+  # <!--
+  #   rdoc-file=eval.c
+  #   - used_refinements -> array
+  # -->
+  # Returns an array of all modules used in the current scope. The ordering of
+  # modules in the resulting array is not defined.
+  #
+  #     module A
+  #       refine Object do
+  #       end
+  #     end
+  #
+  #     module B
+  #       refine Object do
+  #       end
+  #     end
+  #
+  #     using A
+  #     using B
+  #     p Module.used_refinements
+  #
+  # *produces:*
+  #
+  #     [#<refinement:Object@B>, #<refinement:Object@A>]
+  #
+  def self.used_refinements: () -> Array[Refinement]
+
   # <!--
   #   rdoc-file=object.c
   #   - mod < other   ->  true, false, or nil
   # -->
-  # Returns true if *mod* is a subclass of *other*. Returns `nil` if there's no
-  # relationship between the two. (Think of the relationship in terms of the class
-  # definition: "class A < B" implies "A < B".)
+  # Returns true if *mod* is a subclass of *other*. Returns `false` if *mod* is
+  # the same as *other* or *mod* is an ancestor of *other*. Returns `nil` if
+  # there's no relationship between the two. (Think of the relationship in terms
+  # of the class definition: "class A < B" implies "A < B".)
   #
   def <: (Module other) -> bool?
 
@@ -169,9 +197,10 @@ class Module < Object
   #   rdoc-file=object.c
   #   - mod > other   ->  true, false, or nil
   # -->
-  # Returns true if *mod* is an ancestor of *other*. Returns `nil` if there's no
-  # relationship between the two. (Think of the relationship in terms of the class
-  # definition: "class A < B" implies "B > A".)
+  # Returns true if *mod* is an ancestor of *other*. Returns `false` if *mod* is
+  # the same as *other* or *mod* is a descendant of *other*. Returns `nil` if
+  # there's no relationship between the two. (Think of the relationship in terms
+  # of the class definition: "class A < B" implies "B > A".)
   #
   def >: (Module other) -> bool?
 
@@ -255,7 +284,7 @@ class Module < Object
   #     end
   #     Mod.instance_methods.sort   #=> [:one, :one=, :two, :two=]
   #
-  def attr_accessor: (*Symbol | String arg0) -> NilClass
+  def attr_accessor: (*Symbol | String arg0) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=object.c
@@ -269,7 +298,7 @@ class Module < Object
   # in turn. String arguments are converted to symbols. Returns an array of
   # defined method names as symbols.
   #
-  def attr_reader: (*Symbol | String arg0) -> NilClass
+  def attr_reader: (*Symbol | String arg0) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=object.c
@@ -280,20 +309,24 @@ class Module < Object
   # *symbol*`.id2name`. String arguments are converted to symbols. Returns an
   # array of defined method names as symbols.
   #
-  def attr_writer: (*Symbol | String arg0) -> NilClass
+  def attr_writer: (*Symbol | String arg0) -> Array[Symbol]
 
   # <!--
   #   rdoc-file=load.c
-  #   - mod.autoload(module, filename)   -> nil
+  #   - mod.autoload(const, filename)   -> nil
   # -->
-  # Registers *filename* to be loaded (using Kernel::require) the first time that
-  # *module* (which may be a String or a symbol) is accessed in the namespace of
-  # *mod*.
+  # Registers _filename_ to be loaded (using Kernel::require)
+  #     the first time that _const_ (which may be a String or
+  #     a symbol) is accessed in the namespace of _mod_.
   #
-  #     module A
-  #     end
-  #     A.autoload(:B, "b")
-  #     A::B.doit            # autoloads "b"
+  #        module A
+  #        end
+  #        A.autoload(:B, "b")
+  #        A::B.doit            # autoloads "b"
+  #
+  # If *const* in *mod* is defined as autoload, the file name to be loaded is
+  # replaced with *filename*.  If *const* is defined but not as autoload, does
+  # nothing.
   #
   def autoload: (Symbol _module, String filename) -> NilClass
 
@@ -436,6 +469,26 @@ class Module < Object
   #
   def class_variables: (?boolish inherit) -> ::Array[Symbol]
 
+  # <!--
+  #   rdoc-file=object.c
+  #   - const_added(const_name)
+  # -->
+  # Invoked as a callback whenever a constant is assigned on the receiver
+  #
+  #     module Chatty
+  #       def self.const_added(const_name)
+  #         super
+  #         puts "Added #{const_name.inspect}"
+  #       end
+  #       FOO = 1
+  #     end
+  #
+  # *produces:*
+  #
+  #     Added :FOO
+  #
+  def const_added: (Symbol) -> void
+
   # <!--
   #   rdoc-file=object.c
   #   - mod.const_defined?(sym, inherit=true)   -> true or false
@@ -911,6 +964,15 @@ class Module < Object
   #     C.instance_methods(false)                   #=> [:method3]
   #     C.instance_methods.include?(:method2)       #=> true
   #
+  # Note that method visibility changes in the current class, as well as aliases,
+  # are considered as methods of the current class by this method:
+  #
+  #     class C < B
+  #       alias method4 method2
+  #       protected :method2
+  #     end
+  #     C.instance_methods(false).sort               #=> [:method2, :method3, :method4]
+  #
   def instance_methods: (?boolish include_super) -> ::Array[Symbol]
 
   # <!--
@@ -1403,6 +1465,28 @@ class Module < Object
   #
   def refine: (Module mod) { () -> void } -> Refinement
 
+  # <!--
+  #   rdoc-file=eval.c
+  #   - refinements -> array
+  # -->
+  # Returns an array of modules defined within the receiver.
+  #
+  #     module A
+  #       refine Integer do
+  #       end
+  #
+  #       refine String do
+  #       end
+  #     end
+  #
+  #     p A.refinements
+  #
+  # *produces:*
+  #
+  #     [#<refinement:Integer@A>, #<refinement:String@A>]
+  #
+  def refinements: () -> Array[Refinement]
+
   # <!--
   #   rdoc-file=object.c
   #   - remove_class_variable(sym)    -> obj
@@ -1509,6 +1593,15 @@ class Module < Object
   #
   def undef_method: (*Symbol | String arg0) -> self
 
+  # <!--
+  #   rdoc-file=object.c
+  #   - mod.undefined_instance_methods   -> array
+  # -->
+  # Returns a list of the undefined instance methods defined in *mod*. The
+  # undefined methods of any ancestors are not included.
+  #
+  def undefined_instance_methods: () -> Array[Symbol]
+
   # <!--
   #   rdoc-file=eval.c
   #   - using(module)    -> self

data/core/nil_class.rbs

@@ -33,6 +33,8 @@ class NilClass
   # -->
   # Dummy pattern matching -- always returns nil.
   #
+  # This method makes it possible to `while gets =~ /re/ do`.
+  #
   def =~: (untyped obj) -> nil
 
   # <!--

data/core/numeric.rbs

@@ -74,162 +74,90 @@
 #
 # First, what's elsewhere. Class Numeric:
 #
-# *   Inherits from [class
-#     Object](Object.html#class-Object-label-What-27s+Here).
-# *   Includes [module
-#     Comparable](Comparable.html#module-Comparable-label-What-27s+Here).
+# *   Inherits from [class Object](rdoc-ref:Object@What-27s+Here).
+# *   Includes [module Comparable](rdoc-ref:Comparable@What-27s+Here).
 #
 #
 # Here, class Numeric provides methods for:
 #
-# *   [Querying](#class-Numeric-label-Querying)
-# *   [Comparing](#class-Numeric-label-Comparing)
-# *   [Converting](#class-Numeric-label-Converting)
-# *   [Other](#class-Numeric-label-Other)
+# *   [Querying](rdoc-ref:Numeric@Querying)
+# *   [Comparing](rdoc-ref:Numeric@Comparing)
+# *   [Converting](rdoc-ref:Numeric@Converting)
+# *   [Other](rdoc-ref:Numeric@Other)
 #
 #
 # ### Querying
 #
-#     #finite?
-# :       Returns true unless `self` is infinite or not a number.
-#
-#     #infinite?
-# :       Returns -1, `nil` or +1, depending on whether `self` is
-#         `-Infinity<tt>, finite, or <tt>+Infinity`.
-#
-#     #integer?
-# :       Returns whether `self` is an integer.
-#
-#     #negative?
-# :       Returns whether `self` is negative.
-#
-#     #nonzero?
-# :       Returns whether `self` is not zero.
-#
-#     #positive?
-# :       Returns whether `self` is positive.
-#
-#     #real?
-# :       Returns whether `self` is a real value.
-#
-#     #zero?
-# :       Returns whether `self` is zero.
-#
+# *   #finite?: Returns true unless `self` is infinite or not a number.
+# *   #infinite?: Returns -1, `nil` or +1, depending on whether `self` is
+#     `-Infinity<tt>, finite, or <tt>+Infinity`.
+# *   #integer?: Returns whether `self` is an integer.
+# *   #negative?: Returns whether `self` is negative.
+# *   #nonzero?: Returns whether `self` is not zero.
+# *   #positive?: Returns whether `self` is positive.
+# *   #real?: Returns whether `self` is a real value.
+# *   #zero?: Returns whether `self` is zero.
 #
 #
 # ### Comparing
 #
-#     [<=>](#method-i-3C-3D-3E)
-# :       Returns:
+# *   #<=>: Returns:
 #
 #     *   -1 if  `self` is less than the given value.
 #     *   0 if `self` is equal to the given value.
 #     *   1 if `self` is greater than the given value.
 #     *   `nil` if `self` and the given value are not comparable.
 #
-#     #eql?
-# :       Returns whether `self` and the given value have the same value and
-#         type.
 #
+# *   #eql?: Returns whether `self` and the given value have the same value and
+#     type.
 #
 #
 # ### Converting
 #
-#     #% (aliased as #modulo)
-# :       Returns the remainder of `self` divided by the given value.
-#
-#     #-@
-# :       Returns the value of `self`, negated.
-#
-#     #abs (aliased as #magnitude)
-# :       Returns the absolute value of `self`.
-#
-#     #abs2
-# :       Returns the square of `self`.
-#
-#     #angle (aliased as #arg and #phase)
-# :       Returns 0 if `self` is positive, Math::PI otherwise.
-#
-#     #ceil
-# :       Returns the smallest number greater than or equal to `self`, to a
-#         given precision.
-#
-#     #coerce
-# :       Returns array `[coerced_self, coerced_other]` for the given other
-#         value.
-#
-#     #conj (aliased as #conjugate)
-# :       Returns the complex conjugate of `self`.
-#
-#     #denominator
-# :       Returns the denominator (always positive) of the Rational
-#         representation of `self`.
-#
-#     #div
-# :       Returns the value of `self` divided by the given value and converted
-#         to an integer.
-#
-#     #divmod
-# :       Returns array `[quotient, modulus]` resulting from dividing `self` the
-#         given divisor.
-#
-#     #fdiv
-# :       Returns the Float result of dividing `self` by the given divisor.
-#
-#     #floor
-# :       Returns the largest number less than or equal to `self`, to a given
-#         precision.
-#
-#     #i
-# :       Returns the Complex object `Complex(0, self)`. the given value.
-#
-#     #imaginary (aliased as #imag)
-# :       Returns the imaginary part of the `self`.
-#
-#     #numerator
-# :       Returns the numerator of the Rational representation of `self`; has
-#         the same sign as `self`.
-#
-#     #polar
-# :       Returns the array `[self.abs, self.arg]`.
-#
-#     #quo
-# :       Returns the value of `self` divided by the given value.
-#
-#     #real
-# :       Returns the real part of `self`.
-#
-#     #rect (aliased as #rectangular)
-# :       Returns the array `[self, 0]`.
-#
-#     #remainder
-# :       Returns `self-arg*(self/arg).truncate` for the given `arg`.
-#
-#     #round
-# :       Returns the value of `self` rounded to the nearest value for the given
-#         a precision.
-#
-#     #to_c
-# :       Returns the Complex representation of `self`.
-#
-#     #to_int
-# :       Returns the Integer representation of `self`, truncating if necessary.
-#
-#     #truncate
-# :       Returns `self` truncated (toward zero) to a given precision.
-#
+# *   #% (aliased as #modulo): Returns the remainder of `self` divided by the
+#     given value.
+# *   #-@: Returns the value of `self`, negated.
+# *   #abs (aliased as #magnitude): Returns the absolute value of `self`.
+# *   #abs2: Returns the square of `self`.
+# *   #angle (aliased as #arg and #phase): Returns 0 if `self` is positive,
+#     Math::PI otherwise.
+# *   #ceil: Returns the smallest number greater than or equal to `self`, to a
+#     given precision.
+# *   #coerce: Returns array `[coerced_self, coerced_other]` for the given other
+#     value.
+# *   #conj (aliased as #conjugate): Returns the complex conjugate of `self`.
+# *   #denominator: Returns the denominator (always positive) of the Rational
+#     representation of `self`.
+# *   #div: Returns the value of `self` divided by the given value and converted
+#     to an integer.
+# *   #divmod: Returns array `[quotient, modulus]` resulting from dividing
+#     `self` the given divisor.
+# *   #fdiv: Returns the Float result of dividing `self` by the given divisor.
+# *   #floor: Returns the largest number less than or equal to `self`, to a
+#     given precision.
+# *   #i: Returns the Complex object `Complex(0, self)`. the given value.
+# *   #imaginary (aliased as #imag): Returns the imaginary part of the `self`.
+# *   #numerator: Returns the numerator of the Rational representation of
+#     `self`; has the same sign as `self`.
+# *   #polar: Returns the array `[self.abs, self.arg]`.
+# *   #quo: Returns the value of `self` divided by the given value.
+# *   #real: Returns the real part of `self`.
+# *   #rect (aliased as #rectangular): Returns the array `[self, 0]`.
+# *   #remainder: Returns `self-arg*(self/arg).truncate` for the given `arg`.
+# *   #round: Returns the value of `self` rounded to the nearest value for the
+#     given a precision.
+# *   #to_c: Returns the Complex representation of `self`.
+# *   #to_int: Returns the Integer representation of `self`, truncating if
+#     necessary.
+# *   #truncate: Returns `self` truncated (toward zero) to a given precision.
 #
 #
 # ### Other
 #
-#     #clone
-# :       Returns `self`; does not allow freezing.
-#
-#     #dup (aliased as #+@)
-# :       Returns `self`.
-#
-#     #step
-# :       Invokes the given block with the sequence of specified numbers.
+# *   #clone: Returns `self`; does not allow freezing.
+# *   #dup (aliased as #+@): Returns `self`.
+# *   #step: Invokes the given block with the sequence of specified numbers.
 #
 class Numeric
   include Comparable
@@ -247,9 +175,9 @@ class Numeric
   #
   # For Rational `r` and real number `n`, these expressions are equivalent:
   #
-  #     c % n
-  #     c-n*(c/n).floor
-  #     c.divmod(n)[1]
+  #     r % n
+  #     r-n*(r/n).floor
+  #     r.divmod(n)[1]
   #
   # See Numeric#divmod.
   #
@@ -392,13 +320,15 @@ class Numeric
   #
   def coerce: (Numeric) -> [ Numeric, Numeric ]
 
-  # <!-- rdoc-file=complex.c -->
-  # Returns self.
+  # <!--
+  #   rdoc-file=numeric.rb
+  #   - conj()
+  # -->
   #
   def conj: () -> Numeric
 
   # <!--
-  #   rdoc-file=complex.c
+  #   rdoc-file=numeric.rb
   #   - num.conj       ->  self
   #   - num.conjugate  ->  self
   # -->
@@ -422,8 +352,8 @@ class Numeric
   # `/` in the derived class of `self`. (Numeric itself does not define method
   # `/`.)
   #
-  # Of the Core and Standard Library classes, Float, Rational, and Complex use
-  # this implementation.
+  # Of the Core and Standard Library classes, Only Float and Rational use this
+  # implementation.
   #
   def div: (Numeric) -> Integer
 
@@ -524,13 +454,15 @@ class Numeric
   #
   def i: () -> Complex
 
-  # <!-- rdoc-file=complex.c -->
-  # Returns zero.
+  # <!--
+  #   rdoc-file=numeric.rb
+  #   - imag()
+  # -->
   #
   def imag: () -> Numeric
 
   # <!--
-  #   rdoc-file=complex.c
+  #   rdoc-file=numeric.rb
   #   - num.imag       ->  0
   #   - num.imaginary  ->  0
   # -->
@@ -577,9 +509,9 @@ class Numeric
   #
   # For Rational `r` and real number `n`, these expressions are equivalent:
   #
-  #     c % n
-  #     c-n*(c/n).floor
-  #     c.divmod(n)[1]
+  #     r % n
+  #     r-n*(r/n).floor
+  #     r.divmod(n)[1]
   #
   # See Numeric#divmod.
   #
@@ -667,7 +599,7 @@ class Numeric
   def quo: (Numeric) -> Numeric
 
   # <!--
-  #   rdoc-file=complex.c
+  #   rdoc-file=numeric.rb
   #   - num.real  ->  self
   # -->
   # Returns self.