rbs 3.7.0 → 3.8.0.pre.1

data/stdlib/json/0/json.rbs

@@ -8,6 +8,8 @@ end
 
 interface _JsonWrite
   def write: (String json) -> void
+
+  def flush: () -> void
 end
 
 interface _JsonReadableIO
@@ -115,7 +117,6 @@ type json_state = singleton(JSON::Ext::Generator::State) | singleton(JSON::Pure:
 #     name is double-quoted text; the values may be any JSON values:
 #         {"a": "foo", "b": 1, "c": 1.0, "d": 2.0e2, "e": true, "f": false, "g": null}
 #
-#
 # A JSON array or object may contain nested arrays, objects, and scalars to any
 # depth:
 #     {"foo": {"bar": 1, "baz": 2}, "bat": [0, 1, 2]}
@@ -134,13 +135,11 @@ type json_state = singleton(JSON::Ext::Generator::State) | singleton(JSON::Pure:
 # *   `JSON.parse(source, opts)`
 # *   `JSON.parse!(source, opts)`
 #
-#
 # where
 # *   `source` is a Ruby object.
 # *   `opts` is a Hash object containing options that control both input allowed
 #     and output formatting.
 #
-#
 # The difference between the two methods is that JSON.parse! omits some checks
 # and may not be safe for some `source` data; use it only for data from trusted
 # sources. Use the safer method JSON.parse for less trusted sources.
@@ -298,7 +297,6 @@ type json_state = singleton(JSON::Ext::Generator::State) | singleton(JSON::Pure:
 # *   `opts` is a Hash object containing options that control both input allowed
 #     and output formatting.
 #
-#
 # #### Generating JSON from Arrays
 #
 # When the source is a Ruby Array, JSON.generate returns a String containing a
@@ -417,7 +415,6 @@ type json_state = singleton(JSON::Ext::Generator::State) | singleton(JSON::Pure:
 #     inserted before the colon in each JSON object's pair; defaults to the
 #     empty String, `''`.
 #
-#
 # In this example, `obj` is used first to generate the shortest JSON data (no
 # whitespace), then again with all formatting options specified:
 #
@@ -465,7 +462,6 @@ type json_state = singleton(JSON::Ext::Generator::State) | singleton(JSON::Pure:
 # *   JSON.parse, called with option `create_additions`, uses that information
 #     to create a proper Ruby object.
 #
-#
 # This example shows a Range being generated into JSON and parsed back into
 # Ruby, both without and with the addition for Range:
 #     ruby = Range.new(0, 2)
@@ -477,13 +473,13 @@ type json_state = singleton(JSON::Ext::Generator::State) | singleton(JSON::Pure:
 #     json1 = JSON.generate(ruby)
 #     ruby1 = JSON.parse(json1, create_additions: true)
 #     # Make a nice display.
-#     display = <<EOT
-#     Generated JSON:
-#       Without addition:  #{json0} (#{json0.class})
-#       With addition:     #{json1} (#{json1.class})
-#     Parsed JSON:
-#       Without addition:  #{ruby0.inspect} (#{ruby0.class})
-#       With addition:     #{ruby1.inspect} (#{ruby1.class})
+#     display = <<~EOT
+#       Generated JSON:
+#         Without addition:  #{json0} (#{json0.class})
+#         With addition:     #{json1} (#{json1.class})
+#       Parsed JSON:
+#         Without addition:  #{ruby0.inspect} (#{ruby0.class})
+#         With addition:     #{ruby1.inspect} (#{ruby1.class})
 #     EOT
 #     puts display
 #
@@ -517,7 +513,6 @@ type json_state = singleton(JSON::Ext::Generator::State) | singleton(JSON::Pure:
 # *   Symbol: `require 'json/add/symbol'`
 # *   Time: `require 'json/add/time'`
 #
-#
 # To reduce punctuation clutter, the examples below show the generated JSON via
 # `puts`, rather than the usual `inspect`,
 #
@@ -660,13 +655,13 @@ type json_state = singleton(JSON::Ext::Generator::State) | singleton(JSON::Pure:
 #     json1 = JSON.generate(foo1)
 #     obj1 = JSON.parse(json1, create_additions: true)
 #     #   Make a nice display.
-#     display = <<EOT
-#     Generated JSON:
-#       Without custom addition:  #{json0} (#{json0.class})
-#       With custom addition:     #{json1} (#{json1.class})
-#     Parsed JSON:
-#       Without custom addition:  #{obj0.inspect} (#{obj0.class})
-#       With custom addition:     #{obj1.inspect} (#{obj1.class})
+#     display = <<~EOT
+#       Generated JSON:
+#         Without custom addition:  #{json0} (#{json0.class})
+#         With custom addition:     #{json1} (#{json1.class})
+#       Parsed JSON:
+#         Without custom addition:  #{obj0.inspect} (#{obj0.class})
+#         With custom addition:     #{obj1.inspect} (#{obj1.class})
 #     EOT
 #     puts display
 #
@@ -731,7 +726,6 @@ module JSON
   # *   Argument `limit`, if given, is passed to JSON.generate as option
   #     `max_nesting`.
   #
-  #
   # ---
   #
   # When argument `io` is not given, returns the JSON String generated from `obj`:
@@ -756,14 +750,14 @@ module JSON
   # <!-- rdoc-file=ext/json/lib/json/common.rb -->
   # Sets or returns the default options for the JSON.dump method. Initially:
   #     opts = JSON.dump_default_options
-  #     opts # => {:max_nesting=>false, :allow_nan=>true, :script_safe=>false}
+  #     opts # => {:max_nesting=>false, :allow_nan=>true}
   #
   def self.dump_default_options: () -> json_options
 
   # <!-- rdoc-file=ext/json/lib/json/common.rb -->
   # Sets or returns the default options for the JSON.dump method. Initially:
   #     opts = JSON.dump_default_options
-  #     opts # => {:max_nesting=>false, :allow_nan=>true, :script_safe=>false}
+  #     opts # => {:max_nesting=>false, :allow_nan=>true}
   #
   def self.dump_default_options=: (json_options) -> json_options
 
@@ -828,9 +822,7 @@ module JSON
   def self?.generate: (_ToJson obj, ?json_options opts) -> String
 
   # <!-- rdoc-file=ext/json/lib/json/common.rb -->
-  # Returns the JSON generator module that is used by JSON. This is either
-  # JSON::Ext::Generator or JSON::Pure::Generator:
-  #     JSON.generator # => JSON::Ext::Generator
+  # Returns the JSON generator module that is used by JSON.
   #
   def self.generator: () -> json_generator
 
@@ -850,6 +842,15 @@ module JSON
   # -->
   # Returns the Ruby objects created by parsing the given `source`.
   #
+  # BEWARE: This method is meant to serialise data from trusted user input, like
+  # from your own database server or clients under your control, it could be
+  # dangerous to allow untrusted users to pass JSON sources into it. If you must
+  # use it, use JSON.unsafe_load instead to make it clear.
+  #
+  # Since JSON version 2.8.0, `load` emits a deprecation warning when a non native
+  # type is deserialized, without `create_additions` being explicitly enabled, and
+  # in JSON version 3.0, `load` will have `create_additions` disabled by default.
+  #
   # *   Argument `source` must be, or be convertible to, a String:
   #     *   If `source` responds to instance method `to_str`, `source.to_str`
   #         becomes the source.
@@ -860,37 +861,31 @@ module JSON
   #     *   If both of the following are true, source becomes the String `'null'`:
   #         *   Option `allow_blank` specifies a truthy value.
   #         *   The source, as defined above, is `nil` or the empty String `''`.
-  #
   #     *   Otherwise, `source` remains the source.
-  #
   # *   Argument `proc`, if given, must be a Proc that accepts one argument. It
   #     will be called recursively with each result (depth-first order). See
-  #     details below. BEWARE: This method is meant to serialise data from trusted
-  #     user input, like from your own database server or clients under your
-  #     control, it could be dangerous to allow untrusted users to pass JSON
-  #     sources into it.
+  #     details below.
   # *   Argument `opts`, if given, contains a Hash of options for the parsing. See
   #     [Parsing Options](#module-JSON-label-Parsing+Options). The default options
   #     can be changed via method JSON.load_default_options=.
   #
-  #
   # ---
   #
   # When no `proc` is given, modifies `source` as above and returns the result of
   # `parse(source, opts)`;  see #parse.
   #
   # Source for following examples:
-  #     source = <<-EOT
-  #     {
-  #     "name": "Dave",
-  #       "age" :40,
-  #       "hats": [
-  #         "Cattleman's",
-  #         "Panama",
-  #         "Tophat"
-  #       ]
-  #     }
-  #     EOT
+  #     source = <<~JSON
+  #       {
+  #         "name": "Dave",
+  #         "age" :40,
+  #         "hats": [
+  #           "Cattleman's",
+  #           "Panama",
+  #           "Tophat"
+  #         ]
+  #       }
+  #     JSON
   #
   # Load a String:
   #     ruby = JSON.load(source)
@@ -916,7 +911,6 @@ module JSON
   # *   Recursively calls `proc(result)`.
   # *   Returns the final result.
   #
-  #
   # Example:
   #     require 'json'
   #
@@ -1045,17 +1039,17 @@ module JSON
   # \JSON](#module-JSON-label-Parsing+JSON).
   #
   # Parses nested JSON objects:
-  #     source = <<-EOT
-  #     {
-  #     "name": "Dave",
-  #       "age" :40,
-  #       "hats": [
-  #         "Cattleman's",
-  #         "Panama",
-  #         "Tophat"
-  #       ]
-  #     }
-  #     EOT
+  #     source = <<~JSON
+  #       {
+  #       "name": "Dave",
+  #         "age" :40,
+  #         "hats": [
+  #           "Cattleman's",
+  #           "Panama",
+  #           "Tophat"
+  #         ]
+  #       }
+  #     JSON
   #     ruby = JSON.parse(source)
   #     ruby # => {"name"=>"Dave", "age"=>40, "hats"=>["Cattleman's", "Panama", "Tophat"]}
   #
@@ -1084,9 +1078,7 @@ module JSON
   def self?.parse!: (string source, ?json_options opts) -> untyped
 
   # <!-- rdoc-file=ext/json/lib/json/common.rb -->
-  # Returns the JSON parser class that is used by JSON. This is either
-  # JSON::Ext::Parser or JSON::Pure::Parser:
-  #     JSON.parser # => JSON::Ext::Parser
+  # Returns the JSON parser class that is used by JSON.
   #
   def self.parser: () -> json_parser
 
@@ -1137,29 +1129,25 @@ module JSON
 
   # <!--
   #   rdoc-file=ext/json/lib/json/common.rb
-  #   - restore(source, proc = nil, options = {})
+  #   - restore(source, proc = nil, options = nil)
   # -->
   #
   alias self.restore self.load
 
   # <!--
   #   rdoc-file=ext/json/lib/json/common.rb
-  #   - restore(source, proc = nil, options = {})
+  #   - 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. This is
-  # either JSON::Ext::Generator::State or JSON::Pure::Generator::State:
-  #     JSON.state # => JSON::Ext::Generator::State
+  # Sets or Returns the JSON generator state class that is used by JSON.
   #
   def self.state: () -> json_state
 
   # <!-- rdoc-file=ext/json/lib/json/common.rb -->
-  # Sets or Returns the JSON generator state class that is used by JSON. This is
-  # either JSON::Ext::Generator::State or JSON::Pure::Generator::State:
-  #     JSON.state # => JSON::Ext::Generator::State
+  # Sets or Returns the JSON generator state class that is used by JSON.
   #
   def self.state=: (json_state) -> json_state
 
@@ -1182,9 +1170,6 @@ JSON::PRETTY_STATE_PROTOTYPE: json_state
 
 JSON::SAFE_STATE_PROTOTYPE: json_state
 
-# <!-- rdoc-file=ext/json/lib/json/version.rb -->
-# JSON version
-#
 JSON::VERSION: String
 
 JSON::VERSION_ARRAY: Array[Integer]

data/stdlib/logger/0/log_device.rbs

@@ -57,7 +57,7 @@ class Logger
 
     # <!--
     #   rdoc-file=lib/logger/log_device.rb
-    #   - new(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false)
+    #   - new(log = nil, shift_age: nil, shift_size: nil, shift_period_suffix: nil, binmode: false, reraise_write_errors: [])
     # -->
     #
     def initialize: (?untyped logdev, ?binmode: boolish, ?shift_period_suffix: String, ?shift_size: Integer, ?shift_age: Numeric | String) -> void

data/stdlib/logger/0/logger.rbs

@@ -66,13 +66,11 @@
 # *   A severity (the required argument to #add).
 # *   An automatically created timestamp.
 #
-#
 # And may also have:
 #
 # *   A message.
 # *   A program name.
 #
-#
 # Example:
 #
 #     logger = Logger.new($stdout)
@@ -92,7 +90,6 @@
 # *   Program name.
 # *   Message.
 #
-#
 # You can use a different entry format by:
 #
 # *   Setting a custom format proc (affects following entries); see
@@ -112,8 +109,6 @@
 #
 #             logger.error("#{my_slow_message_generator}")
 #
-#
-#
 # ### Severity
 #
 # The severity of a log entry has two effects:
@@ -123,7 +118,6 @@
 # *   Indicates to any log reader (whether a person or a program) the relative
 #     importance of the entry.
 #
-#
 # ### Timestamp
 #
 # The timestamp for a log entry is generated automatically when the entry is
@@ -157,7 +151,6 @@
 # *   An Exception: `message.message` is used.
 # *   Anything else: `message.inspect` is used.
 #
-#
 # **Note**: Logger::Formatter does not escape or sanitize the message passed to
 # it. Developers should be aware that malicious data (user input) may be in the
 # message, and should explicitly escape untrusted data.
@@ -271,7 +264,6 @@
 # *   Only the most recent log file is open and active; the others are closed
 #     and inactive.
 #
-#
 # ### Size-Based Rotation
 #
 # For size-based log file rotation, call Logger.new with:
@@ -282,7 +274,6 @@
 # *   Argument `shift_size` as a positive integer: the maximum size (in bytes)
 #     of each log file; defaults to 1048576 (1 megabyte).
 #
-#
 # Examples:
 #
 #     logger = Logger.new('t.log', 3)           # Three 1-megabyte files.
@@ -300,14 +291,12 @@
 # *   `t.log` is closed and renamed to `t.log.0`.
 # *   A new file `t.log` is opened.
 #
-#
 # The second time `t.log` is full:
 #
 # *   +t.log.0 is renamed as `t.log.1`.
 # *   `t.log` is closed and renamed to `t.log.0`.
 # *   A new file `t.log` is opened.
 #
-#
 # Each subsequent time that `t.log` is full, the log files are rotated:
 #
 # *   `t.log.1` is removed.
@@ -315,7 +304,6 @@
 # *   `t.log` is closed and renamed to `t.log.0`.
 # *   A new file `t.log` is opened.
 #
-#
 # ### Periodic Rotation
 #
 # For periodic rotation, call Logger.new with:
@@ -323,7 +311,6 @@
 # *   Argument `logdev` as a file path.
 # *   Argument `shift_age` as a string period indicator.
 #
-#
 # Examples:
 #
 #     logger = Logger.new('t.log', 'daily')   # Rotate log files daily.
@@ -341,7 +328,6 @@
 # *   A new log file `t.log` is opened.
 # *   Nothing is removed.
 #
-#
 # The default format for the suffix is `'%Y%m%d'`, which produces a suffix
 # similar to the one above. You can set a different format using create-time
 # option `shift_period_suffix`; see details and suggestions at
@@ -534,7 +520,6 @@ class Logger
   # *   `progname`: The program name for the entry.
   # *   `msg`: The message for the entry (string or string-convertible object).
   #
-  #
   # The proc should return a string containing the formatted entry.
   #
   # This custom formatter uses [String#dump](rdoc-ref:String#dump) to escape the
@@ -568,7 +553,6 @@ class Logger
   # *   `progname`: The program name for the entry.
   # *   `msg`: The message for the entry (string or string-convertible object).
   #
-  #
   # The proc should return a string containing the formatted entry.
   #
   # This custom formatter uses [String#dump](rdoc-ref:String#dump) to escape the
@@ -670,7 +654,6 @@ class Logger
   # *   If `logdev` is an IO stream (usually `$stdout`, `$stderr`, or an open File
   #     object), opens the stream for append.
   #
-  #
   # Example:
   #
   #     logger = Logger.new('t.log')
@@ -770,7 +753,6 @@ class Logger
   #     are to be written to the given stream.
   # *   `nil` or `File::NULL`: no entries are to be written.
   #
-  #
   # Examples:
   #
   #     Logger.new('t.log')
@@ -797,6 +779,9 @@ class Logger
   # *   `shift_period_suffix`: sets the format for the filename suffix for
   #     periodic log file rotation; default is `'%Y%m%d'`. See [Periodic
   #     Rotation](rdoc-ref:Logger@Periodic+Rotation).
+  # *   `reraise_write_errors`: An array of exception classes, which will be
+  #     reraised if there is an error when writing to the log device. The default
+  #     is to swallow all exceptions raised.
   #
   def initialize: (logdev? logdev, ?Numeric | String shift_age, ?Integer shift_size, ?shift_period_suffix: String, ?binmode: boolish, ?datetime_format: String, ?formatter: _Formatter, ?progname: String, ?level: Integer | interned) -> void
 end