rbs 4.0.0.dev.4 → 4.0.0

data/stdlib/pp/0/pp.rbs

@@ -31,18 +31,19 @@
 #     pp(obj1, obj2, ...) #=> [obj1, obj2, ...]
 #     pp()                #=> nil
 #
-# Output `obj(s)` to `$>` in pretty printed format.
+# Output <code>obj(s)</code> to <code>$></code> in pretty printed format.
 #
-# It returns `obj(s)`.
+# It returns <code>obj(s)</code>.
 #
 # ## Output Customization
 #
 # To define a customized pretty printing function for your classes, redefine
-# method `#pretty_print(pp)` in the class. Note that `require 'pp'` is needed
-# before redefining `#pretty_print(pp)`.
+# method <code>#pretty_print(pp)</code> in the class. Note that <code>require
+# 'pp'</code> is needed before redefining <code>#pretty_print(pp)</code>.
 #
-# `#pretty_print` takes the `pp` argument, which is an instance of the PP class.
-# The method uses #text, #breakable, #nest, #group and #pp to print the object.
+# <code>#pretty_print</code> takes the `pp` argument, which is an instance of
+# the PP class. The method uses #text, #breakable, #nest, #group and #pp to
+# print the object.
 #
 # ## Pretty-Print JSON
 #
@@ -237,8 +238,8 @@ class PP < PrettyPrint
   # -->
   # Outputs `obj` to `out` in pretty printed format of `width` columns in width.
   #
-  # If `out` is omitted, `$>` is assumed. If `width` is omitted, the width of
-  # `out` is assumed (see width_for).
+  # If `out` is omitted, <code>$></code> is assumed. If `width` is omitted, the
+  # width of `out` is assumed (see width_for).
   #
   # PP.pp returns `out`.
   #

data/stdlib/prettyprint/0/prettyprint.rbs

@@ -196,8 +196,8 @@ class PrettyPrint
   #
   # If `sep` is not specified, " " is used.
   #
-  # If `width` is not specified, `sep.length` is used. You will have to specify
-  # this when `sep` is a multibyte character, for example.
+  # If `width` is not specified, <code>sep.length</code> is used. You will have to
+  # specify this when `sep` is a multibyte character, for example.
   #
   def fill_breakable: (?String sep, ?Integer width) -> void
 
@@ -210,8 +210,8 @@ class PrettyPrint
   #
   # If `sep` is not specified, " " is used.
   #
-  # If `width` is not specified, `sep.length` is used. You will have to specify
-  # this when `sep` is a multibyte character, for example.
+  # If `width` is not specified, <code>sep.length</code> is used. You will have to
+  # specify this when `sep` is a multibyte character, for example.
   #
   def breakable: (?String sep, ?Integer width) -> void
 
@@ -225,9 +225,9 @@ class PrettyPrint
   # If `indent` is specified, the method call is regarded as nested by
   # nest(indent) { ... }.
   #
-  # If `open_obj` is specified, `text open_obj, open_width` is called before
-  # grouping. If `close_obj` is specified, `text close_obj, close_width` is called
-  # after grouping.
+  # If `open_obj` is specified, <code>text open_obj, open_width</code> is called
+  # before grouping. If `close_obj` is specified, <code>text close_obj,
+  # close_width</code> is called after grouping.
   #
   def group: (?::Integer indent, ?::String open_obj, ?::String close_obj, ?Integer open_width, ?Integer close_width) { () -> untyped } -> Integer
 

data/stdlib/pstore/0/pstore.rbs

@@ -299,7 +299,7 @@
 #       end
 #     end
 #
-class PStore
+class PStore[unchecked out K = untyped, unchecked out V = untyped]
   # <!--
   #   rdoc-file=lib/pstore.rb
   #   - [](key)
@@ -320,7 +320,7 @@ class PStore
   #
   # Raises an exception if called outside a transaction block.
   #
-  def []: (untyped name) -> untyped
+  def []: (K name) -> V?
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -338,7 +338,7 @@ class PStore
   #
   # Raises an exception if called outside a transaction block.
   #
-  def []=: (untyped name, untyped value) -> untyped
+  def []=: (K name, V value) -> V
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -349,7 +349,7 @@ class PStore
   #
   # Raises an exception if called outside a transaction block.
   #
-  def abort: () -> untyped
+  def abort: () -> void
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -360,7 +360,7 @@ class PStore
   #
   # Raises an exception if called outside a transaction block.
   #
-  def commit: () -> nil
+  def commit: () -> void
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -379,7 +379,7 @@ class PStore
   #
   # Raises an exception if called outside a transaction block.
   #
-  def delete: (untyped name) -> untyped
+  def delete: (K name) -> V?
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -400,7 +400,7 @@ class PStore
   #
   # Raises an exception if called outside a transaction block.
   #
-  def fetch: (untyped name, ?untyped default) -> untyped
+  def fetch: (K name, ?V default) -> V
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -410,21 +410,25 @@ class PStore
   #
   #     store.path # => "flat.store"
   #
-  def path: () -> untyped
+  def path: () -> String
 
   # <!--
   #   rdoc-file=lib/pstore.rb
   #   - root?(key)
   # -->
   #
-  def root?: (untyped name) -> bool
+  def key?: (K name) -> bool
+
+  alias root? key?
 
   # <!--
   #   rdoc-file=lib/pstore.rb
   #   - roots()
   # -->
   #
-  def roots: () -> Array[untyped]
+  def keys: () -> Array[K]
+
+  alias roots keys
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -441,7 +445,7 @@ class PStore
   #
   # Raises an exception if called within a transaction block.
   #
-  def transaction: (?untyped read_only) -> untyped
+  def transaction: [U] (?bool read_only) { (self) -> U } -> U
 
   # <!-- rdoc-file=lib/pstore.rb -->
   # Whether PStore should do its best to prevent file corruptions, even when an
@@ -458,7 +462,7 @@ class PStore
   #     raises no unexpected I/O error; if such an error occurs during a write to
   #     the store, the file may become corrupted.
   #
-  def ultra_safe: () -> untyped
+  def ultra_safe: () -> bool
 
   # <!-- rdoc-file=lib/pstore.rb -->
   # Whether PStore should do its best to prevent file corruptions, even when an
@@ -475,7 +479,7 @@ class PStore
   #     raises no unexpected I/O error; if such an error occurs during a write to
   #     the store, the file may become corrupted.
   #
-  def ultra_safe=: (untyped) -> untyped
+  def ultra_safe=: (bool) -> bool
 
   private
 
@@ -486,14 +490,14 @@ class PStore
   #   - empty_marshal_checksum()
   # -->
   #
-  def empty_marshal_checksum: () -> untyped
+  def empty_marshal_checksum: () -> String
 
   # <!--
   #   rdoc-file=lib/pstore.rb
   #   - empty_marshal_data()
   # -->
   #
-  def empty_marshal_data: () -> untyped
+  def empty_marshal_data: () -> String
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -501,7 +505,7 @@ class PStore
   # -->
   # Raises PStore::Error if the calling code is not in a PStore#transaction.
   #
-  def in_transaction: () -> untyped
+  def in_transaction: () -> void
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -510,7 +514,7 @@ class PStore
   # Raises PStore::Error if the calling code is not in a PStore#transaction or if
   # the code is in a read-only PStore#transaction.
   #
-  def in_transaction_wr: () -> untyped
+  def in_transaction_wr: () -> void
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -531,7 +535,7 @@ class PStore
   #
   #     store = PStore.new(path, true)
   #
-  def initialize: (untyped file, ?boolish thread_safe) -> untyped
+  def initialize: (path file, ?boolish thread_safe) -> void
 
   def load: (untyped content) -> untyped
 
@@ -543,7 +547,8 @@ class PStore
   # be returned. If `read_only` is false, a 3-tuple will be returned: the
   # unmarshalled Hash, a checksum of the data, and the size of the data.
   #
-  def load_data: (untyped file, untyped read_only) -> untyped
+  def load_data: (path file, true read_only) -> Hash[untyped, untyped]
+               | (path file, false read_only) -> [Hash[untyped, untyped], String, Integer]
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -564,7 +569,7 @@ class PStore
   #
   # All exceptions are propagated.
   #
-  def open_and_lock_file: (untyped filename, untyped read_only) -> untyped
+  def open_and_lock_file: (string filename, bool read_only) -> File?
 
   # <!--
   #   rdoc-file=lib/pstore.rb
@@ -578,26 +583,26 @@ class PStore
   #   - save_data_with_atomic_file_rename_strategy(data, file)
   # -->
   #
-  def save_data_with_atomic_file_rename_strategy: (untyped data, untyped file) -> untyped
+  def save_data_with_atomic_file_rename_strategy: (string data, File file) -> void
 
   # <!--
   #   rdoc-file=lib/pstore.rb
   #   - save_data_with_fast_strategy(data, file)
   # -->
   #
-  def save_data_with_fast_strategy: (untyped data, untyped file) -> untyped
-end
+  def save_data_with_fast_strategy: (string data, File file) -> void
 
-PStore::EMPTY_MARSHAL_CHECKSUM: String
+  EMPTY_MARSHAL_CHECKSUM: String
 
-PStore::EMPTY_MARSHAL_DATA: String
+  EMPTY_MARSHAL_DATA: String
 
-PStore::EMPTY_STRING: String
+  EMPTY_STRING: String
 
-PStore::RDWR_ACCESS: Hash[untyped, untyped]
+  RDWR_ACCESS: { mode: Integer, encoding: Encoding }
 
-PStore::RD_ACCESS: Hash[untyped, untyped]
+  RD_ACCESS: { mode: Integer, encoding: Encoding }
 
-PStore::VERSION: String
+  VERSION: String
 
-PStore::WR_ACCESS: Hash[untyped, untyped]
+  WR_ACCESS: { mode: Integer, encoding: Encoding }
+end

data/stdlib/psych/0/psych.rbs

@@ -214,29 +214,30 @@ module Psych
   #
   # Currently supported options are:
   #
-  # `:indentation`
+  # <code>:indentation</code>
   # :   Number of space characters used to indent. Acceptable value should be in
-  #     `0..9` range, otherwise option is ignored.
+  #     <code>0..9</code> range, otherwise option is ignored.
   #
   #     Default: `2`.
   #
-  # `:line_width`
-  # :   Max character to wrap line at. For unlimited line width use `-1`.
+  # <code>:line_width</code>
+  # :   Max character to wrap line at. For unlimited line width use
+  #     <code>-1</code>.
   #
   #     Default: `0` (meaning "wrap at 81").
   #
-  # `:canonical`
+  # <code>:canonical</code>
   # :   Write "canonical" YAML form (very verbose, yet strictly formal).
   #
   #     Default: `false`.
   #
-  # `:header`
-  # :   Write `%YAML [version]` at the beginning of document.
+  # <code>:header</code>
+  # :   Write <code>%YAML [version]</code> at the beginning of document.
   #
   #     Default: `false`.
   #
   #
-  # `:stringify_names`
+  # <code>:stringify_names</code>
   # :   Dump symbol keys in Hash objects as string.
   #
   #     Default: `false`.
@@ -265,7 +266,7 @@ module Psych
 
   # <!--
   #   rdoc-file=ext/psych/lib/psych.rb
-  #   - load(yaml, permitted_classes: [Symbol], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false)
+  #   - load(yaml, permitted_classes: [Symbol], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false, parse_symbols: true)
   # -->
   # Load `yaml` in to a Ruby data structure.  If multiple documents are provided,
   # the object contained in the first document will be returned. `filename` will
@@ -308,11 +309,11 @@ module Psych
   # `fallback` return value, which defaults to `nil`. See load for options.
   #
   %a{annotate:rdoc:copy:Psych.load_file}
-  def self.load_file: (string | _ToPath, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
+  def self.load_file: (path, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
 
   # <!--
   #   rdoc-file=ext/psych/lib/psych.rb
-  #   - safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false)
+  #   - safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false, parse_symbols: true)
   # -->
   # Safely load the yaml string in `yaml`.  By default, only the following classes
   # are allowed to be deserialized:
@@ -363,7 +364,7 @@ module Psych
 
   # <!--
   #   rdoc-file=ext/psych/lib/psych.rb
-  #   - unsafe_load(yaml, filename: nil, fallback: false, symbolize_names: false, freeze: false, strict_integer: false)
+  #   - unsafe_load(yaml, filename: nil, fallback: false, symbolize_names: false, freeze: false, strict_integer: false, parse_symbols: true)
   # -->
   # Load `yaml` in to a Ruby data structure.  If multiple documents are provided,
   # the object contained in the first document will be returned. `filename` will
@@ -399,4 +400,56 @@ module Psych
   #
   %a{annotate:rdoc:copy:Psych.unsafe_load}
   def self.unsafe_load: (String yaml, ?filename: String | _ToStr | _ToS?, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool, ?strict_integer: bool) -> untyped
+
+  # <!--
+  #   rdoc-file=ext/psych/lib/psych.rb
+  #   - safe_load_file(filename, **kwargs)
+  # -->
+  # Safely loads the document contained in `filename`.  Returns the yaml contained
+  # in `filename` as a Ruby object, or if the file is empty, it returns the
+  # specified `fallback` return value, which defaults to `nil`. See safe_load for
+  # options.
+  #
+  %a{annotate:rdoc:copy:Psych.safe_load_file}
+  def self.safe_load_file: (path, ?permitted_classes: Array[Class], ?permitted_symbols: Array[Symbol], ?aliases: bool, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
+
+  # <!--
+  #   rdoc-file=ext/psych/lib/psych.rb
+  #   - unsafe_load_file(filename, **kwargs)
+  # -->
+  # Load the document contained in `filename`.  Returns the yaml contained in
+  # `filename` as a Ruby object, or if the file is empty, it returns the specified
+  # `fallback` return value, which defaults to `false`.
+  #
+  # NOTE: This method *should not* be used to parse untrusted documents, such as
+  # YAML documents that are supplied via user input.  Instead, please use the
+  # safe_load_file method.
+  #
+  %a{annotate:rdoc:copy:Psych.unsafe_load_file}
+  def self.unsafe_load_file: (path, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
+
+  class Exception < ::RuntimeError
+  end
+
+  class SyntaxError < ::Psych::Exception
+    attr_reader file: String?
+    attr_reader line: Integer?
+    attr_reader column: Integer?
+    attr_reader offset: Integer?
+    attr_reader problem: String?
+    attr_reader context: String?
+
+    # <!--
+    #   rdoc-file=ext/psych/lib/psych/syntax_error.rb
+    #   - new(file, line, col, offset, problem, context)
+    # -->
+    #
+    def initialize: (?String? file, ?Integer? line, ?Integer? column, ?Integer? offset, ?String? problem, ?String? context) -> void
+  end
+
+  class BadAlias < ::Psych::Exception
+  end
+
+  class DisallowedClass < ::Psych::Exception
+  end
 end

data/stdlib/psych/0/store.rbs

@@ -30,7 +30,7 @@
 #     greeting:
 #       hello: world
 #
-class Psych::Store < ::PStore
+class Psych::Store < ::PStore[string, untyped]
   # <!--
   #   rdoc-file=lib/yaml/store.rb
   #   - initialize( file_name, yaml_opts = {} )
@@ -45,8 +45,6 @@ class Psych::Store < ::PStore
   # Options passed in through `yaml_opts` will be used when converting the store
   # to YAML via Hash#to_yaml().
   #
-  def initialize: (*untyped o) -> void
-
   def dump: (untyped table) -> String
 
   def empty_marshal_checksum: () -> String
@@ -55,5 +53,5 @@ class Psych::Store < ::PStore
 
   def load: (String) -> untyped
 
-  def marshal_dump_supports_canonical_option?: () -> ::FalseClass
+  def marshal_dump_supports_canonical_option?: () -> bool
 end

data/stdlib/pty/0/pty.rbs

@@ -103,7 +103,8 @@ module PTY
   #
   # ### Return values
   #
-  # In the non-block form this returns an array of size three, `[r, w, pid]`.
+  # In the non-block form this returns an array of size three, <code>[r, w,
+  # pid]</code>.
   #
   # In the block form these same values will be yielded to the block:
   #
@@ -136,8 +137,8 @@ module PTY
   # -->
   # Allocates a pty (pseudo-terminal).
   #
-  # In the block form, yields an array of two elements (`master_io, slave_file`)
-  # and the value of the block is returned from `open`.
+  # In the block form, yields an array of two elements (<code>master_io,
+  # slave_file</code>) and the value of the block is returned from `open`.
   #
   # The IO and File are both closed after the block completes if they haven't been
   # already closed.
@@ -148,7 +149,8 @@ module PTY
   #       p slave.path #=> "/dev/pts/1"
   #     }
   #
-  # In the non-block form, returns a two element array, `[master_io, slave_file]`.
+  # In the non-block form, returns a two element array, <code>[master_io,
+  # slave_file]</code>.
   #
   #     master, slave = PTY.open
   #     # do something with master for IO, or the slave file
@@ -160,7 +162,7 @@ module PTY
   #
   # `slave_file`
   # :   the slave of the pty, as a File.  The path to the terminal device is
-  #     available via `slave_file.path`
+  #     available via <code>slave_file.path</code>
   #
   #
   # IO#raw! is usable to disable newline conversions:
@@ -208,7 +210,8 @@ module PTY
   #
   # ### Return values
   #
-  # In the non-block form this returns an array of size three, `[r, w, pid]`.
+  # In the non-block form this returns an array of size three, <code>[r, w,
+  # pid]</code>.
   #
   # In the block form these same values will be yielded to the block:
   #