rbs 3.9.5 → 3.10.0.pre.1

data/stdlib/fileutils/0/fileutils.rbs

@@ -522,11 +522,13 @@ module FileUtils
   # symbolic links; other file types (FIFO streams, device files, etc.) are not
   # supported.
   #
-  # Keyword arguments:
+  # Optional arguments:
   #
-  # *   `dereference_root: true` - if `src` is a symbolic link, follows the link.
-  # *   `preserve: true` - preserves file times.
-  # *   `remove_destination: true` - removes `dest` before copying files.
+  # *   `dereference_root` - if `src` is a symbolic link, follows the link
+  #     (`false` by default).
+  # *   `preserve` - preserves file times (`false` by default).
+  # *   `remove_destination` - removes `dest` before copying files (`false` by
+  #     default).
   #
   # Related: [methods for copying](rdoc-ref:FileUtils@Copying).
   #
@@ -547,12 +549,13 @@ module FileUtils
   #     FileUtils.copy_file('src0.txt', 'dest0.txt')
   #     File.file?('dest0.txt') # => true
   #
-  # Keyword arguments:
+  # Optional arguments:
   #
-  # *   `dereference: false` - if `src` is a symbolic link, does not follow the
-  #     link.
-  # *   `preserve: true` - preserves file times.
-  # *   `remove_destination: true` - removes `dest` before copying files.
+  # *   `dereference` - if `src` is a symbolic link, follows the link (`true` by
+  #     default).
+  # *   `preserve` - preserves file times (`false` by default).
+  # *   `remove_destination` - removes `dest` before copying files (`false` by
+  #     default).
   #
   # Related: [methods for copying](rdoc-ref:FileUtils@Copying).
   #
@@ -963,13 +966,15 @@ module FileUtils
   #     File.file?('dest1/dir1/t2.txt') # => true
   #     File.file?('dest1/dir1/t3.txt') # => true
   #
-  # Keyword arguments:
+  # Optional arguments:
   #
-  # *   `dereference_root: true` - dereferences `src` if it is a symbolic link.
-  # *   `remove_destination: true` - removes `dest` before creating links.
+  # *   `dereference_root` - dereferences `src` if it is a symbolic link (`false`
+  #     by default).
+  # *   `remove_destination` - removes `dest` before creating links (`false` by
+  #     default).
   #
   # Raises an exception if `dest` is the path to an existing file or directory and
-  # keyword argument `remove_destination: true` is not given.
+  # optional argument `remove_destination` is not given.
   #
   # Related: FileUtils.ln (has different options).
   #

data/stdlib/forwardable/0/forwardable.rbs

@@ -100,6 +100,9 @@ module Forwardable
   #
   VERSION: String
 
+  # <!-- rdoc-file=lib/forwardable.rb -->
+  # Version for backward compatibility
+  #
   FORWARDABLE_VERSION: String
 
   # <!--

data/stdlib/json/0/json.rbs

@@ -14,9 +14,6 @@ end
 class JSON::GeneratorError < JSON::JSONError
 end
 
-class JSON::UnparserError < JSON::GeneratorError
-end
-
 # <!-- rdoc-file=ext/json/lib/json/common.rb -->
 # This exception is raised if a parser error occurs.
 #
@@ -202,6 +199,24 @@ end
 #
 # ---
 #
+# Option `allow_duplicate_key` specifies whether duplicate keys in objects
+# should be ignored or cause an error to be raised:
+#
+# When not specified:
+#     # The last value is used and a deprecation warning emitted.
+#     JSON.parse('{"a": 1, "a":2}') => {"a" => 2}
+#     # warning: detected duplicate keys in JSON object.
+#     # This will raise an error in json 3.0 unless enabled via `allow_duplicate_key: true`
+#
+# When set to ``true``
+#     # The last value is used.
+#     JSON.parse('{"a": 1, "a":2}') => {"a" => 2}
+#
+# When set to ``false``, the future default:
+#     JSON.parse('{"a": 1, "a":2}') => duplicate key at line 1 column 1 (JSON::ParserError)
+#
+# ---
+#
 # Option `allow_nan` (boolean) specifies whether to allow NaN, Infinity, and
 # MinusInfinity in `source`; defaults to `false`.
 #
@@ -218,8 +233,22 @@ end
 #     ruby = JSON.parse(source, {allow_nan: true})
 #     ruby # => [NaN, Infinity, -Infinity]
 #
+# ---
+#
+# Option `allow_trailing_comma` (boolean) specifies whether to allow trailing
+# commas in objects and arrays; defaults to `false`.
+#
+# With the default, `false`:
+#     JSON.parse('[1,]') # unexpected character: ']' at line 1 column 4 (JSON::ParserError)
+#
+# When enabled:
+#     JSON.parse('[1,]', allow_trailing_comma: true) # => [1]
+#
 # ###### Output Options
 #
+# Option `freeze` (boolean) specifies whether the returned objects will be
+# frozen; defaults to `false`.
+#
 # Option `symbolize_names` (boolean) specifies whether returned Hash keys should
 # be Symbols; defaults to `false` (use Strings).
 #
@@ -348,6 +377,25 @@ end
 #
 # ---
 #
+# Option `allow_duplicate_key` (boolean) specifies whether hashes with duplicate
+# keys should be allowed or produce an error. defaults to emit a deprecation
+# warning.
+#
+# With the default, (not set):
+#     Warning[:deprecated] = true
+#     JSON.generate({ foo: 1, "foo" => 2 })
+#     # warning: detected duplicate key "foo" in {foo: 1, "foo" => 2}.
+#     # This will raise an error in json 3.0 unless enabled via `allow_duplicate_key: true`
+#     # => '{"foo":1,"foo":2}'
+#
+# With `false`
+#     JSON.generate({ foo: 1, "foo" => 2 }, allow_duplicate_key: false)
+#     # detected duplicate key "foo" in {foo: 1, "foo" => 2} (JSON::GeneratorError)
+#
+# In version 3.0, `false` will become the default.
+#
+# ---
+#
 # Option `max_nesting` (Integer) specifies the maximum nesting depth in `obj`;
 # defaults to `100`.
 #
@@ -423,6 +471,9 @@ end
 #
 # ## JSON Additions
 #
+# Note that JSON Additions must only be used with trusted data, and is
+# deprecated.
+#
 # When you "round trip" a non-String object from Ruby to JSON and back, you have
 # a new String, instead of the object you began with:
 #     ruby0 = Range.new(0, 2)
@@ -711,8 +762,6 @@ module JSON
   #
   def self.create_id=: (_ToS create_id) -> _ToS
 
-  def self.deep_const_get: (interned path) -> untyped
-
   # <!--
   #   rdoc-file=ext/json/lib/json/common.rb
   #   - JSON.dump(obj, io = nil, limit = nil)
@@ -754,6 +803,7 @@ module JSON
   #     opts = JSON.dump_default_options
   #     opts # => {:max_nesting=>false, :allow_nan=>true}
   #
+  %a{deprecated}
   def self.dump_default_options: () -> options
 
   # <!-- rdoc-file=ext/json/lib/json/common.rb -->
@@ -761,6 +811,7 @@ module JSON
   #     opts = JSON.dump_default_options
   #     opts # => {:max_nesting=>false, :allow_nan=>true}
   #
+  %a{deprecated}
   def self.dump_default_options=: (options) -> options
 
   # <!--
@@ -778,19 +829,16 @@ module JSON
   #     # Raises SystemStackError (stack level too deep):
   #     JSON.fast_generate(a)
   #
+  %a{deprecated}
   def self?.fast_generate: (_ToJson obj, ?options opts) -> String
 
-  alias self.fast_unparse self.fast_generate
-
-  alias fast_unparse fast_generate
-
   # <!--
   #   rdoc-file=ext/json/lib/json/common.rb
   #   - JSON.generate(obj, opts = nil) -> new_string
   # -->
   # Returns a String containing the generated JSON data.
   #
-  # See also JSON.fast_generate, JSON.pretty_generate.
+  # See also JSON.pretty_generate.
   #
   # Argument `obj` is the Ruby object to be converted to JSON.
   #
@@ -830,14 +878,6 @@ module JSON
 
   def self.generator=: (generator generator) -> void
 
-  # <!--
-  #   rdoc-file=ext/json/lib/json/common.rb
-  #   - iconv(to, from, string)
-  # -->
-  # Encodes string using String.encode.
-  #
-  def self.iconv: (encoding to, encoding from, String string) -> String
-
   # <!--
   #   rdoc-file=ext/json/lib/json/common.rb
   #   - JSON.load(source, proc = nil, options = {}) -> object
@@ -952,6 +992,7 @@ module JSON
   #       when Array
   #         obj.map! {|v| deserialize_obj v }
   #       end
+  #       obj
   #     })
   #     pp ruby
   #
@@ -974,7 +1015,8 @@ module JSON
   #        #<Admin:0x00000000064c41f8
   #        @attributes={"type"=>"Admin", "password"=>"0wn3d"}>}
   #
-  def self?.load: (string | _ReadableIO | _Read source, ?Proc proc, ?options options) -> untyped
+  def self?.load: (string | _ReadableIO | _Read source, ?options options) -> untyped
+                | [T] (string | _ReadableIO | _Read source, ^(?) -> T, ?options options) -> T
 
   # <!--
   #   rdoc-file=ext/json/lib/json/common.rb
@@ -1003,6 +1045,7 @@ module JSON
   #     opts = JSON.load_default_options
   #     opts # => {:max_nesting=>false, :allow_nan=>true, :allow_blank=>true, :create_additions=>true}
   #
+  %a{deprecated}
   def self.load_default_options: () -> options
 
   # <!-- rdoc-file=ext/json/lib/json/common.rb -->
@@ -1010,6 +1053,7 @@ module JSON
   #     opts = JSON.load_default_options
   #     opts # => {:max_nesting=>false, :allow_nan=>true, :allow_blank=>true, :create_additions=>true}
   #
+  %a{deprecated}
   def self.load_default_options=: (options) -> options
 
   # <!--
@@ -1120,29 +1164,6 @@ module JSON
   #
   def self?.pretty_generate: (_ToJson obj, ?options opts) -> untyped
 
-  alias self.pretty_unparse self.pretty_generate
-
-  alias pretty_unparse pretty_generate
-
-  # Recursively calls passed *Proc* if the parsed data structure is an *Array* or
-  # *Hash*
-  #
-  def self?.recurse_proc: (untyped result) { (*untyped) -> void } -> void
-
-  # <!--
-  #   rdoc-file=ext/json/lib/json/common.rb
-  #   - restore(source, proc = nil, options = nil)
-  # -->
-  #
-  alias self.restore self.load
-
-  # <!--
-  #   rdoc-file=ext/json/lib/json/common.rb
-  #   - restore(source, proc = nil, options = nil)
-  # -->
-  #
-  alias restore load
-
   # <!-- rdoc-file=ext/json/lib/json/common.rb -->
   # Sets or Returns the JSON generator state class that is used by JSON.
   #
@@ -1152,10 +1173,6 @@ module JSON
   # Sets or Returns the JSON generator state class that is used by JSON.
   #
   def self.state=: (state) -> state
-
-  alias self.unparse self.generate
-
-  alias unparse generate
 end
 
 JSON::FAST_STATE_PROTOTYPE: JSON::state
@@ -1193,6 +1210,7 @@ module Kernel
   # Outputs *objs* to STDOUT as JSON strings in the shortest form, that is in one
   # line.
   #
+  %a{deprecated}
   def j: (*_ToJson) -> nil
 
   # <!--
@@ -1202,11 +1220,12 @@ module Kernel
   # Outputs *objs* to STDOUT as JSON strings in a pretty format, with indentation
   # and over many lines.
   #
+  %a{deprecated}
   def jj: (*_ToJson) -> nil
 
   # <!--
   #   rdoc-file=ext/json/lib/json/common.rb
-  #   - JSON(object, *args)
+  #   - JSON(object, opts = nil)
   # -->
   # If *object* is string-like, parse the string and return the parsed result as a
   # Ruby data structure. Otherwise, generate a JSON text from the Ruby data
@@ -1854,7 +1873,7 @@ class Symbol
 
   # <!--
   #   rdoc-file=ext/json/lib/json/add/symbol.rb
-  #   - to_json(*a)
+  #   - to_json(state = nil, *a)
   # -->
   # Returns a JSON string representing `self`:
   #

data/stdlib/net-http/0/net-http.rbs

@@ -4047,6 +4047,9 @@ module Net
     alias entity body
   end
 
+  # <!-- rdoc-file=lib/net/http/responses.rb -->
+  # Unknown HTTP response
+  #
   class HTTPUnknownResponse < HTTPResponse
     HAS_BODY: bool
 

data/stdlib/objspace/0/objspace.rbs

@@ -332,9 +332,11 @@ module ObjectSpace
   # information as only a **HINT**. Especially, the size of `T_DATA` may not be
   # correct.
   #
-  # This method is only expected to work with C Ruby.
+  # This method is only expected to work with CRuby.
   #
-  # From Ruby 2.2, memsize_of(obj) returns a memory size includes sizeof(RVALUE).
+  # From Ruby 3.2 with Variable Width Allocation, it returns the actual slot size
+  # used plus any additional memory allocated outside the slot (such as external
+  # strings, arrays, or hash tables).
   #
   def self?.memsize_of: (untyped) -> Integer
 
@@ -461,8 +463,11 @@ module ObjectSpace
 
   # <!--
   #   rdoc-file=ext/objspace/object_tracing.c
-  #   - trace_object_allocations_debug_start()
+  #   - trace_object_allocations_debug_start
   # -->
+  # Starts tracing object allocations for GC debugging. If you encounter the BUG
+  # "... is T_NONE" (and so on) on your application, please try this method at the
+  # beginning of your app.
   #
   def self?.trace_object_allocations_debug_start: () -> void
 

data/stdlib/open-uri/0/open-uri.rbs

@@ -83,6 +83,46 @@ end
 # :   Tanaka Akira <akr@m17n.org>
 #
 module OpenURI
+  # <!-- rdoc-file=lib/open-uri.rb -->
+  # Raised on HTTP session failure
+  #
+  class HTTPError < StandardError
+    # <!--
+    #   rdoc-file=lib/open-uri.rb
+    #   - new(message, io)
+    # -->
+    #
+    def initialize: (String message, (StringIO & OpenURI::Meta) io) -> void
+
+    # <!-- rdoc-file=lib/open-uri.rb -->
+    # StringIO having the received data
+    #
+    attr_reader io: StringIO & OpenURI::Meta
+  end
+
+  # <!-- rdoc-file=lib/open-uri.rb -->
+  # Raised on redirection, only occurs when `redirect` option for HTTP is `false`.
+  #
+  class HTTPRedirect < HTTPError
+    # <!--
+    #   rdoc-file=lib/open-uri.rb
+    #   - new(message, io, uri)
+    # -->
+    #
+    def initialize: (String message, (StringIO & OpenURI::Meta) io, URI uri) -> void
+
+    # <!-- rdoc-file=lib/open-uri.rb -->
+    # URI to redirect
+    #
+    attr_reader uri: URI
+  end
+
+  # <!-- rdoc-file=lib/open-uri.rb -->
+  # Raised on too many redirection,
+  #
+  class TooManyRedirects < HTTPError
+  end
+
   # <!-- rdoc-file=lib/open-uri.rb -->
   # Mixin for holding meta-information.
   #