rbs 3.3.2 → 3.4.0

data/core/range.rbs

@@ -176,6 +176,8 @@
 # *   [Comparing](rdoc-ref:Range@Methods+for+Comparing)
 # *   [Iterating](rdoc-ref:Range@Methods+for+Iterating)
 # *   [Converting](rdoc-ref:Range@Methods+for+Converting)
+# *   [Methods for Working with
+#     JSON](rdoc-ref:Range@Methods+for+Working+with+JSON)
 #
 #
 # ### Methods for Creating a Range
@@ -225,6 +227,19 @@
 # *   #to_a (aliased as #entries): Returns elements of `self` in an array.
 # *   #to_s: Returns a string representation of `self` (uses #to_s).
 #
+#
+# ### Methods for Working with JSON
+#
+# *   ::json_create: Returns a new Range object constructed from the given
+#     object.
+# *   #as_json: Returns a 2-element hash representing `self`.
+# *   #to_json: Returns a JSON string representing `self`.
+#
+#
+# To make these methods available:
+#
+#     require 'json/add/range'
+#
 class Range[out Elem] < Object
   include Enumerable[Elem]
 
@@ -556,8 +571,6 @@ class Range[out Elem] < Object
   #
   # Related: Range#cover?.
   #
-  # Range#member? is an alias for Range#include?.
-  #
   def include?: (untyped obj) -> bool
 
   # <!--
@@ -808,6 +821,91 @@ class Range[out Elem] < Object
          | (Integer n) -> ::Array[Elem]
          | (Integer n) { (Elem a, Elem b) -> Integer } -> ::Array[Elem]
 
+  # <!--
+  #   rdoc-file=range.c
+  #   - overlap?(range) -> true or false
+  # -->
+  # Returns `true` if `range` overlaps with `self`, `false` otherwise:
+  #
+  #     (0..2).overlap?(1..3) #=> true
+  #     (0..2).overlap?(3..4) #=> false
+  #     (0..).overlap?(..0)   #=> true
+  #
+  # With non-range argument, raises TypeError.
+  #
+  #     (1..3).overlap?(1)         # TypeError
+  #
+  # Returns `false` if an internal call to `<=>` returns `nil`; that is, the
+  # operands are not comparable.
+  #
+  #     (1..3).overlap?('a'..'d')  # => false
+  #
+  # Returns `false` if `self` or `range` is empty. "Empty range" means that its
+  # begin value is larger than, or equal for an exclusive range, its end value.
+  #
+  #     (4..1).overlap?(2..3)      # => false
+  #     (4..1).overlap?(..3)       # => false
+  #     (4..1).overlap?(2..)       # => false
+  #     (2...2).overlap?(1..2)     # => false
+  #
+  #     (1..4).overlap?(3..2)      # => false
+  #     (..4).overlap?(3..2)       # => false
+  #     (1..).overlap?(3..2)       # => false
+  #     (1..2).overlap?(2...2)     # => false
+  #
+  # Returns `false` if the begin value one of `self` and `range` is larger than,
+  # or equal if the other is an exclusive range, the end value of the other:
+  #
+  #     (4..5).overlap?(2..3)      # => false
+  #     (4..5).overlap?(2...4)     # => false
+  #
+  #     (1..2).overlap?(3..4)      # => false
+  #     (1...3).overlap?(3..4)     # => false
+  #
+  # Returns `false` if the end value one of `self` and `range` is larger than, or
+  # equal for an exclusive range, the end value of the other:
+  #
+  #     (4..5).overlap?(2..3)      # => false
+  #     (4..5).overlap?(2...4)     # => false
+  #
+  #     (1..2).overlap?(3..4)      # => false
+  #     (1...3).overlap?(3..4)     # => false
+  #
+  # This method assumes that there is no minimum value because Ruby lacks a
+  # standard method for determining minimum values. This assumption is invalid.
+  # For example, there is no value smaller than `-Float::INFINITY`, making
+  # `(...-Float::INFINITY)` an empty set. Consequently, `(...-Float::INFINITY)`
+  # has no elements in common with itself, yet
+  # `(...-Float::INFINITY).overlap?((...-Float::INFINITY))<tt> returns true due to
+  # this assumption. In general, if <tt>r = (...minimum); r.overlap?(r)` returns
+  # `true`, where `minimum` is a value that no value is smaller than. Such values
+  # include `-Float::INFINITY`, `[]`, `""`, and classes without subclasses.
+  #
+  # Related: Range#cover?.
+  #
+  def overlap?: (Range[untyped]) -> bool
+
+  # <!--
+  #   rdoc-file=range.c
+  #   - reverse_each {|element| ... } -> self
+  #   - reverse_each                  -> an_enumerator
+  # -->
+  # With a block given, passes each element of `self` to the block in reverse
+  # order:
+  #
+  #     a = []
+  #     (1..4).reverse_each {|element| a.push(element) } # => 1..4
+  #     a # => [4, 3, 2, 1]
+  #
+  #     a = []
+  #     (1...4).reverse_each {|element| a.push(element) } # => 1...4
+  #     a # => [3, 2, 1]
+  #
+  # With no block given, returns an enumerator.
+  #
+  def reverse_each: () { (Elem) -> void } -> self
+                  | () -> ::Enumerator[Elem, self]
+
   # <!--
   #   rdoc-file=range.c
   #   - size -> non_negative_integer or Infinity or nil
@@ -947,7 +1045,5 @@ class Range[out Elem] < Object
   #
   # Related: Range#cover?.
   #
-  # Range#member? is an alias for Range#include?.
-  #
   def member?: (untyped obj) -> bool
 end

data/core/rational.rbs

@@ -190,8 +190,6 @@ class Rational < Numeric
   #     (1/2r).abs    #=> (1/2)
   #     (-1/2r).abs   #=> (1/2)
   #
-  # Rational#magnitude is an alias for Rational#abs.
-  #
   def abs: () -> Rational
 
   def abs2: () -> Rational
@@ -328,8 +326,6 @@ class Rational < Numeric
   #     (1/2r).abs    #=> (1/2)
   #     (-1/2r).abs   #=> (1/2)
   #
-  # Rational#magnitude is an alias for Rational#abs.
-  #
   alias magnitude abs
 
   def modulo: (Float) -> Float

data/core/rbs/unnamed/argf.rbs

@@ -31,12 +31,16 @@ module RBS
     #     ARGV.replace ["file2", "file3"]
     #     ARGF.read      # Returns the contents of file2 and file3
     #
-    # If `ARGV` is empty, ARGF acts as if it contained STDIN, i.e. the data piped to
-    # your script. For example:
+    # If `ARGV` is empty, ARGF acts as if it contained `"-"` that makes ARGF read
+    # from STDIN, i.e. the data piped or typed to your script. For example:
     #
     #     $ echo "glark" | ruby -e 'p ARGF.read'
     #     "glark\n"
     #
+    #     $ echo Glark > file1
+    #     $ echo "glark" | ruby -e 'p ARGF.read' -- - file1
+    #     "glark\nGlark\n"
+    #
     %a{annotate:rdoc:copy:ARGF}
     class ARGFClass
       include Enumerable[String]
@@ -825,12 +829,12 @@ module RBS
 
       # <!--
       #   rdoc-file=io.c
-      #   - ARGF.readlines(sep = $/)     -> array
-      #   - ARGF.readlines(limit)      -> array
-      #   - ARGF.readlines(sep, limit) -> array
-      #   - ARGF.to_a(sep = $/)     -> array
-      #   - ARGF.to_a(limit)      -> array
-      #   - ARGF.to_a(sep, limit) -> array
+      #   - ARGF.readlines(sep = $/, chomp: false)   -> array
+      #   - ARGF.readlines(limit, chomp: false)      -> array
+      #   - ARGF.readlines(sep, limit, chomp: false) -> array
+      #   - ARGF.to_a(sep = $/, chomp: false)   -> array
+      #   - ARGF.to_a(limit, chomp: false)      -> array
+      #   - ARGF.to_a(sep, limit, chomp: false) -> array
       # -->
       # Reads each file in ARGF in its entirety, returning an Array containing lines
       # from the files. Lines are assumed to be separated by *sep*.
@@ -838,6 +842,8 @@ module RBS
       #     lines = ARGF.readlines
       #     lines[0]                #=> "This is line one\n"
       #
+      # See `IO.readlines` for a full description of all options.
+      #
       %a{annotate:rdoc:copy:ARGF#readlines}
       def readlines: (?String sep, ?Integer limit) -> ::Array[String]
 
@@ -956,6 +962,8 @@ module RBS
       #     lines = ARGF.readlines
       #     lines[0]                #=> "This is line one\n"
       #
+      # See `IO.readlines` for a full description of all options.
+      #
       %a{annotate:rdoc:copy:ARGF#to_a}
       def to_a: (?String sep, ?Integer limit) -> ::Array[String]
 

data/core/rbs/unnamed/env_class.rbs

@@ -239,8 +239,6 @@ module RBS
       #   - ENV[name] = value      -> value
       #   - ENV.store(name, value) -> value
       # -->
-      # ENV.store is an alias for ENV.[]=.
-      #
       # Creates, updates, or deletes the named environment variable, returning the
       # value. Both `name` and `value` may be instances of String. See [Valid Names
       # and Values](rdoc-ref:ENV@Valid+Names+and+Values).
@@ -294,8 +292,6 @@ module RBS
       #   - ENV[name] = value      -> value
       #   - ENV.store(name, value) -> value
       # -->
-      # ENV.store is an alias for ENV.[]=.
-      #
       # Creates, updates, or deletes the named environment variable, returning the
       # value. Both `name` and `value` may be instances of String. See [Valid Names
       # and Values](rdoc-ref:ENV@Valid+Names+and+Values).
@@ -601,8 +597,6 @@ module RBS
       #   - ENV.filter { |name, value| block } -> hash of name/value pairs
       #   - ENV.filter                         -> an_enumerator
       # -->
-      # ENV.filter is an alias for ENV.select.
-      #
       # Yields each environment variable name and its value as a 2-element Array,
       # returning a Hash of the names and values for which the block returns a truthy
       # value:
@@ -627,8 +621,6 @@ module RBS
       #   - ENV.filter { |name, value| block } -> hash of name/value pairs
       #   - ENV.filter                         -> an_enumerator
       # -->
-      # ENV.filter is an alias for ENV.select.
-      #
       # Yields each environment variable name and its value as a 2-element Array,
       # returning a Hash of the names and values for which the block returns a truthy
       # value:
@@ -652,8 +644,6 @@ module RBS
       #   - ENV.filter! { |name, value| block } -> ENV or nil
       #   - ENV.filter!                         -> an_enumerator
       # -->
-      # ENV.filter! is an alias for ENV.select!.
-      #
       # Yields each environment variable name and its value as a 2-element Array,
       # deleting each entry for which the block returns `false` or `nil`, and
       # returning ENV if any deletions made, or `nil` otherwise:
@@ -693,8 +683,6 @@ module RBS
       #   - ENV.filter! { |name, value| block } -> ENV or nil
       #   - ENV.filter!                         -> an_enumerator
       # -->
-      # ENV.filter! is an alias for ENV.select!.
-      #
       # Yields each environment variable name and its value as a 2-element Array,
       # deleting each entry for which the block returns `false` or `nil`, and
       # returning ENV if any deletions made, or `nil` otherwise:
@@ -794,8 +782,6 @@ module RBS
       #   - ENV.merge!(*hashes)                                     -> ENV
       #   - ENV.merge!(*hashes) { |name, env_val, hash_val| block } -> ENV
       # -->
-      # ENV.update is an alias for ENV.merge!.
-      #
       # Adds to ENV each key/value pair in the given `hash`; returns ENV:
       #     ENV.replace('foo' => '0', 'bar' => '1')
       #     ENV.merge!('baz' => '2', 'bat' => '3') # => {"bar"=>"1", "bat"=>"3", "baz"=>"2", "foo"=>"0"}
@@ -839,8 +825,6 @@ module RBS
       #   - ENV.merge!(*hashes)                                     -> ENV
       #   - ENV.merge!(*hashes) { |name, env_val, hash_val| block } -> ENV
       # -->
-      # ENV.update is an alias for ENV.merge!.
-      #
       # Adds to ENV each key/value pair in the given `hash`; returns ENV:
       #     ENV.replace('foo' => '0', 'bar' => '1')
       #     ENV.merge!('baz' => '2', 'bat' => '3') # => {"bar"=>"1", "bat"=>"3", "baz"=>"2", "foo"=>"0"}
@@ -1026,8 +1010,6 @@ module RBS
       #   - ENV.member?(name)  -> true or false
       #   - ENV.key?(name)     -> true or false
       # -->
-      # ENV.has_key?, ENV.member?, and ENV.key? are aliases for ENV.include?.
-      #
       # Returns `true` if there is an environment variable with the given `name`:
       #     ENV.replace('foo' => '0', 'bar' => '1')
       #     ENV.include?('foo') # => true
@@ -1061,8 +1043,6 @@ module RBS
       #   - ENV.member?(name)  -> true or false
       #   - ENV.key?(name)     -> true or false
       # -->
-      # ENV.has_key?, ENV.member?, and ENV.key? are aliases for ENV.include?.
-      #
       # Returns `true` if there is an environment variable with the given `name`:
       #     ENV.replace('foo' => '0', 'bar' => '1')
       #     ENV.include?('foo') # => true
@@ -1096,8 +1076,6 @@ module RBS
       #   - ENV.member?(name)  -> true or false
       #   - ENV.key?(name)     -> true or false
       # -->
-      # ENV.has_key?, ENV.member?, and ENV.key? are aliases for ENV.include?.
-      #
       # Returns `true` if there is an environment variable with the given `name`:
       #     ENV.replace('foo' => '0', 'bar' => '1')
       #     ENV.include?('foo') # => true
@@ -1163,8 +1141,6 @@ module RBS
       #   - ENV.member?(name)  -> true or false
       #   - ENV.key?(name)     -> true or false
       # -->
-      # ENV.has_key?, ENV.member?, and ENV.key? are aliases for ENV.include?.
-      #
       # Returns `true` if there is an environment variable with the given `name`:
       #     ENV.replace('foo' => '0', 'bar' => '1')
       #     ENV.include?('foo') # => true

data/core/refinement.rbs

@@ -49,4 +49,12 @@ class Refinement < Module
   # Return the class refined by the receiver.
   #
   def refined_class: () -> Module
+
+  # <!--
+  #   rdoc-file=eval.c
+  #   - target    -> class
+  # -->
+  # Return the class or module refined by the receiver.
+  #
+  def target: () -> Module
 end