rbs 3.2.2 → 3.3.0.pre.1

data/core/enumerator.rbs

@@ -124,6 +124,43 @@
 class Enumerator[unchecked out Elem, out Return] < Object
   include Enumerable[Elem]
 
+  # <!--
+  #   rdoc-file=enumerator.c
+  #   - Enumerator.produce(initial = nil) { |prev| block } -> enumerator
+  # -->
+  # Creates an infinite enumerator from any block, just called over and over.  The
+  # result of the previous iteration is passed to the next one. If `initial` is
+  # provided, it is passed to the first iteration, and becomes the first element
+  # of the enumerator; if it is not provided, the first iteration receives `nil`,
+  # and its result becomes the first element of the iterator.
+  #
+  # Raising StopIteration from the block stops an iteration.
+  #
+  #     Enumerator.produce(1, &:succ)   # => enumerator of 1, 2, 3, 4, ....
+  #
+  #     Enumerator.produce { rand(10) } # => infinite random number sequence
+  #
+  #     ancestors = Enumerator.produce(node) { |prev| node = prev.parent or raise StopIteration }
+  #     enclosing_section = ancestors.find { |n| n.type == :section }
+  #
+  # Using ::produce together with Enumerable methods like Enumerable#detect,
+  # Enumerable#slice_after, Enumerable#take_while can provide Enumerator-based
+  # alternatives for `while` and `until` cycles:
+  #
+  #     # Find next Tuesday
+  #     require "date"
+  #     Enumerator.produce(Date.today, &:succ).detect(&:tuesday?)
+  #
+  #     # Simple lexer:
+  #     require "strscan"
+  #     scanner = StringScanner.new("7+38/6")
+  #     PATTERN = %r{\d+|[-/+*]}
+  #     Enumerator.produce { scanner.scan(PATTERN) }.slice_after { scanner.eos? }.first
+  #     # => ["7", "+", "38", "/", "6"]
+  #
+  def self.produce: [T] () { (T? prev) -> T } -> Enumerator[T, bot]
+                  | [T] (T initial) { (T prev) -> T } -> Enumerator[T, bot]
+
   # <!--
   #   rdoc-file=enumerator.c
   #   - Enumerator.product(*enums) -> enumerator

data/core/exception.rbs

@@ -105,7 +105,7 @@
 # *   SystemStackError
 # *   fatal
 #
-class Exception < Object
+class Exception
   # <!--
   #   rdoc-file=error.c
   #   - Exception.to_tty?   ->  true or false
@@ -122,7 +122,7 @@ class Exception < Object
   # receiver. Otherwise, create a new exception object of the same class as the
   # receiver, but with a message equal to `string.to_str`.
   #
-  def self.exception: (?String msg) -> Exception
+  def self.exception: (?string | _ToS msg) -> instance
 
   # <!--
   #   rdoc-file=error.c
@@ -131,7 +131,7 @@ class Exception < Object
   # Equality---If *obj* is not an Exception, returns `false`. Otherwise, returns
   # `true` if *exc* and *obj* share same class, messages, and backtrace.
   #
-  def ==: (untyped arg0) -> bool
+  def ==: (untyped obj) -> bool
 
   # <!--
   #   rdoc-file=error.c
@@ -167,7 +167,7 @@ class Exception < Object
   #     ex.backtrace
   #     #=> nil
   #
-  def backtrace: () -> ::Array[String]?
+  def backtrace: () -> Array[String]?
 
   # <!--
   #   rdoc-file=error.c
@@ -179,7 +179,7 @@ class Exception < Object
   #
   # This method is not affected by Exception#set_backtrace().
   #
-  def backtrace_locations: () -> ::Array[Thread::Backtrace::Location]?
+  def backtrace_locations: () -> Array[Thread::Backtrace::Location]?
 
   # <!--
   #   rdoc-file=error.c
@@ -230,7 +230,7 @@ class Exception < Object
   # sequences to express essential information; the message should be readable
   # even if all escape sequences are ignored.
   #
-  def detailed_message: (?highlight: boolish, **untyped) -> String
+  def detailed_message: (?highlight: bool?, **untyped ignored) -> String
 
   # <!--
   #   rdoc-file=error.c
@@ -240,8 +240,8 @@ class Exception < Object
   # receiver. Otherwise, create a new exception object of the same class as the
   # receiver, but with a message equal to `string.to_str`.
   #
-  def exception: () -> self
-               | (String arg0) -> Exception
+  def exception: (?self) -> self
+               | (string | _ToS message) -> instance
 
   # <!--
   #   rdoc-file=error.c
@@ -250,7 +250,7 @@ class Exception < Object
   # -->
   # Construct a new Exception object, optionally passing in a message.
   #
-  def initialize: (?String arg0) -> void
+  def initialize: (?string | _ToS message) -> self
 
   # <!--
   #   rdoc-file=error.c
@@ -277,7 +277,7 @@ class Exception < Object
   # an array of String objects or a single String in the format described in
   # Exception#backtrace.
   #
-  def set_backtrace: (String | ::Array[String] arg0) -> ::Array[String]
+  def set_backtrace: (String | Array[String] backtrace) -> Array[String]
                    | (nil) -> nil
 
   # <!--
@@ -306,5 +306,5 @@ class Exception < Object
   # The default values of these options depend on `$stderr` and its `tty?` at the
   # timing of a call.
   #
-  def full_message: (?highlight: bool, ?order: :top | :bottom) -> String
+  def full_message: (?highlight: bool?, ?order: (:top | :bottom | string)?) -> String
 end

data/core/false_class.rbs

@@ -4,8 +4,6 @@
 # operators allowing `false` to participate correctly in logical expressions.
 #
 class FalseClass
-  public
-
   def !: () -> true
 
   # <!--
@@ -27,7 +25,7 @@ class FalseClass
   # statements.
   #
   def ===: (false) -> true
-         | (untyped obj) -> false
+         | (untyped obj) -> bool
 
   # <!--
   #   rdoc-file=object.c
@@ -37,9 +35,8 @@ class FalseClass
   # Exclusive Or---If *obj* is `nil` or `false`, returns `false`; otherwise,
   # returns `true`.
   #
-  def ^: (nil) -> false
-       | (false) -> false
-       | (untyped obj) -> true
+  def ^: (false | nil) -> false
+       | (untyped obj) -> bool
 
   # <!-- rdoc-file=object.c -->
   # The string representation of `false` is "false".
@@ -61,9 +58,6 @@ class FalseClass
   # -->
   # Or---Returns `false` if *obj* is `nil` or `false`; `true` otherwise.
   #
-  def |: (nil) -> false
-       | (false) -> false
-       | (untyped obj) -> true
-
-  def clone: (?freeze: true?) -> self
+  def |: (nil | false) -> false
+       | (untyped obj) -> bool
 end

data/core/fiber.rbs

@@ -268,7 +268,7 @@ class Fiber < Object
   # Explicitly using `storage: true` is currently experimental and may change in
   # the future.
   #
-  def initialize: (?blocking: boolish, ?storage: true | Hash[Symbol | String, untyped] | nil) { (*untyped) -> void } -> void
+  def initialize: (?blocking: boolish, ?storage: true | Hash[interned, untyped] | nil) { (*untyped) -> void } -> void
 
   # <!--
   #   rdoc-file=cont.c
@@ -414,7 +414,7 @@ class Fiber < Object
   # Returns a copy of the storage hash for the fiber. The method can only be
   # called on the Fiber.current.
   #
-  def storage: () -> Hash[Symbol | String, untyped]
+  def storage: () -> Hash[interned, untyped]
 
   # <!--
   #   rdoc-file=cont.c
@@ -438,7 +438,7 @@ class Fiber < Object
   #       handle_request(request)
   #     end
   #
-  def storage=: (Hash[Symbol | String, untyped]) -> Hash[Symbol | String, untyped]
+  def storage=: (Hash[interned, untyped]) -> Hash[interned, untyped]
 
   # <!--
   #   rdoc-file=cont.c

data/core/file_test.rbs

@@ -13,7 +13,7 @@ module FileTest
   #     File.blockdev?('/dev/sda1')       # => true
   #     File.blockdev?(File.new('t.tmp')) # => false
   #
-  def self?.blockdev?: (String | IO file_name) -> bool
+  def self?.blockdev?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -24,7 +24,7 @@ module FileTest
   #     File.chardev?($stdin)     # => true
   #     File.chardev?('t.txt')     # => false
   #
-  def self?.chardev?: (String | IO file_name) -> bool
+  def self?.chardev?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -42,14 +42,16 @@ module FileTest
   #
   # Argument `path` can be an IO object.
   #
-  def self?.directory?: (String | IO file_name) -> bool
+  def self?.directory?: (path | io file_name) -> bool
 
   # <!-- rdoc-file=file.c -->
   # Returns `true` if the named file exists and has a zero size.
   #
   # *file_name* can be an IO object.
   #
-  def self?.empty?: (String | IO file_name) -> bool
+  alias empty? zero?
+
+  alias self.empty? self.zero?
 
   # <!--
   #   rdoc-file=file.c
@@ -65,7 +67,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not executable by the effective user/group.
   #
-  def self?.executable?: (String file_name) -> bool
+  def self?.executable?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -81,7 +83,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not executable by the real user/group.
   #
-  def self?.executable_real?: (String file_name) -> bool
+  def self?.executable_real?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -93,7 +95,7 @@ module FileTest
   #
   # "file exists" means that stat() or fstat() system call is successful.
   #
-  def self?.exist?: (String | IO file_name) -> bool
+  def self?.exist?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -106,7 +108,7 @@ module FileTest
   # If the `file` argument is a symbolic link, it will resolve the symbolic link
   # and use the file referenced by the link.
   #
-  def self?.file?: (String | IO file) -> bool
+  def self?.file?: (path | io file) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -117,7 +119,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.grpowned?: (String | IO file_name) -> bool
+  def self?.grpowned?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -137,7 +139,7 @@ module FileTest
   #     open("d", "w") {}
   #     p File.identical?("a", "d")      #=> false
   #
-  def self?.identical?: (String | IO file_1, String | IO file_2) -> bool
+  def self?.identical?: (path | io file_1, path | io file_2) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -148,7 +150,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.owned?: (String | IO file_name) -> bool
+  def self?.owned?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -160,7 +162,7 @@ module FileTest
   #     File.pipe?('tmp/fifo') # => true
   #     File.pipe?('t.txt')    # => false
   #
-  def self?.pipe?: (String | IO file_name) -> bool
+  def self?.pipe?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -172,7 +174,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not readable by the effective user/group.
   #
-  def self?.readable?: (String file_name) -> bool
+  def self?.readable?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -184,7 +186,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not readable by the real user/group.
   #
-  def self?.readable_real?: (String file_name) -> bool
+  def self?.readable_real?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -194,7 +196,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.setgid?: (String | IO file_name) -> bool
+  def self?.setgid?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -204,7 +206,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.setuid?: (String | IO file_name) -> bool
+  def self?.setuid?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -214,7 +216,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.size: (String | IO file_name) -> Integer
+  def self?.size: (path | io file_name) -> Integer
 
   # <!--
   #   rdoc-file=file.c
@@ -225,7 +227,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.size?: (String | IO file_name) -> Integer?
+  def self?.size?: (path | io file_name) -> Integer?
 
   # <!--
   #   rdoc-file=file.c
@@ -237,7 +239,7 @@ module FileTest
   #     File.socket?(Socket.new(:INET, :STREAM)) # => true
   #     File.socket?(File.new('t.txt'))          # => false
   #
-  def self?.socket?: (String | IO file_name) -> bool
+  def self?.socket?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -247,7 +249,7 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.sticky?: (String | IO file_name) -> bool
+  def self?.sticky?: (path | io file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -259,7 +261,7 @@ module FileTest
   #     File.symlink?('symlink') # => true
   #     File.symlink?('t.txt')   # => false
   #
-  def self?.symlink?: (String file_name) -> bool
+  def self?.symlink?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -275,7 +277,7 @@ module FileTest
   #     m = File.world_readable?("/etc/passwd")
   #     sprintf("%o", m)                              #=> "644"
   #
-  def self?.world_readable?: (String | IO file_name) -> Integer?
+  def self?.world_readable?: (path | io file_name) -> Integer?
 
   # <!--
   #   rdoc-file=file.c
@@ -291,7 +293,7 @@ module FileTest
   #     m = File.world_writable?("/tmp")
   #     sprintf("%o", m)                              #=> "777"
   #
-  def self?.world_writable?: (String | IO file_name) -> Integer?
+  def self?.world_writable?: (path | io file_name) -> Integer?
 
   # <!--
   #   rdoc-file=file.c
@@ -303,7 +305,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not writable by the effective user/group.
   #
-  def self?.writable?: (String file_name) -> bool
+  def self?.writable?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -315,7 +317,7 @@ module FileTest
   # Note that some OS-level security features may cause this to return true even
   # though the file is not writable by the real user/group.
   #
-  def self?.writable_real?: (String file_name) -> bool
+  def self?.writable_real?: (path file_name) -> bool
 
   # <!--
   #   rdoc-file=file.c
@@ -325,5 +327,5 @@ module FileTest
   #
   # *file_name* can be an IO object.
   #
-  def self?.zero?: (String | IO file_name) -> bool
+  def self?.zero?: (path | io file_name) -> bool
 end