rbs 3.0.0.dev.2 → 3.0.0.dev.3

data/stdlib/nkf/0/nkf.rbs

@@ -66,7 +66,7 @@
 #
 # {de/en}crypt ROT13/47
 #
-# ### -[h](123) --hiragana --katakana --katakana-hiragana
+# ### -h[123] --hiragana --katakana --katakana-hiragana
 #
 # -h1 --hiragana
 # :   Katakana to Hiragana conversion.
@@ -95,7 +95,7 @@
 #
 # New line preserving line folding.
 #
-# ### -[Z](0-3)
+# ### -Z[0-3]
 #
 # Convert X0208 alphabet (Fullwidth Alphabets) to ASCII.
 #
@@ -120,7 +120,7 @@
 # convert X0201 kana to X0208. In JIS output, ESC-(-I is used. In EUC output,
 # SSO is used.
 #
-# ### -[B](0-2)
+# ### -B[0-2]
 #
 # Assume broken JIS-Kanji input, which lost ESC. Useful when your site is using
 # old B-News Nihongo patch.
@@ -141,7 +141,7 @@
 #
 # Delete r in line feed, Add r in line feed.
 #
-# ### -[m](BQN0)
+# ### -m[BQN0]
 #
 # MIME ISO-2022-JP/ISO8859-1 decode. (DEFAULT) To see ISO8859-1 (Latin-1) -l is
 # necessary.
@@ -181,7 +181,7 @@
 # Input and output code is ISO8859-1 (Latin-1) and ISO-2022-JP. **-s**, **-e**
 # and **-x** are not compatible with this option.
 #
-# ### -[L](uwm)
+# ### -L[uwm]
 #
 # new line mode Without this option, nkf doesn't convert line breaks.
 #

data/stdlib/objspace/0/objspace.rbs

@@ -233,9 +233,9 @@ module ObjectSpace
 
   # <!--
   #   rdoc-file=ext/objspace/lib/objspace.rb
-  #   - ObjectSpace.dump(obj[, output: :string]) # => "{ ... }"
-  #   - ObjectSpace.dump(obj, output: :file)     # => #<File:/tmp/rubyobj20131125-88733-1xkfmpv.json>
-  #   - ObjectSpace.dump(obj, output: :stdout)   # => nil
+  #   - ObjectSpace.dump(obj[, output: :string]) -> "{ ... }"
+  #   - ObjectSpace.dump(obj, output: :file) -> #<File:/tmp/rubyobj20131125-88733-1xkfmpv.json>
+  #   - ObjectSpace.dump(obj, output: :stdout) -> nil
   # -->
   # Dump the contents of a ruby object as JSON.
   #
@@ -247,27 +247,44 @@ module ObjectSpace
 
   # <!--
   #   rdoc-file=ext/objspace/lib/objspace.rb
-  #   - ObjectSpace.dump_all([output: :file]) # => #<File:/tmp/rubyheap20131125-88469-laoj3v.json>
-  #   - ObjectSpace.dump_all(output: :stdout) # => nil
-  #   - ObjectSpace.dump_all(output: :string) # => "{...}\n{...}\n..."
-  #   - ObjectSpace.dump_all(output:
-  #   - File.open('heap.json','w'))         # => #<File:heap.json>
-  #   - ObjectSpace.dump_all(output: :string,
-  #   - since: 42)                          # => "{...}\n{...}\n..."
+  #   - ObjectSpace.dump_all([output: :file]) -> #<File:/tmp/rubyheap20131125-88469-laoj3v.json>
+  #   - ObjectSpace.dump_all(output: :stdout) -> nil
+  #   - ObjectSpace.dump_all(output: :string) -> "{...}\n{...}\n..."
+  #   - ObjectSpace.dump_all(output: File.open('heap.json','w')) -> #<File:heap.json>
+  #   - ObjectSpace.dump_all(output: :string, since: 42) -> "{...}\n{...}\n..."
   # -->
   # Dump the contents of the ruby heap as JSON.
   #
+  # *full* must be a boolean. If true all heap slots are dumped including the
+  # empty ones (T_NONE).
+  #
   # *since* must be a non-negative integer or `nil`.
   #
   # If *since* is a positive integer, only objects of that generation and newer
   # generations are dumped. The current generation can be accessed using
-  # GC::count.
-  #
-  # Objects that were allocated without object allocation tracing enabled are
-  # ignored. See ::trace_object_allocations for more information and examples.
+  # GC::count. Objects that were allocated without object allocation tracing
+  # enabled are ignored. See ::trace_object_allocations for more information and
+  # examples.
   #
   # If *since* is omitted or is `nil`, all objects are dumped.
   #
+  # *shapes* must be a boolean or a non-negative integer.
+  #
+  # If *shapes* is a positive integer, only shapes newer than the provided shape
+  # id are dumped. The current shape_id can be accessed using
+  # `RubyVM.stat(:next_shape_id)`.
+  #
+  # If *shapes* is `false`, no shapes are dumped.
+  #
+  # To only dump objects allocated past a certain point you can combine *since*
+  # and *shapes*:
+  #     ObjectSpace.trace_object_allocations
+  #     GC.start
+  #     gc_generation = GC.count
+  #     shape_generation = RubyVM.stat(:next_shape_id)
+  #     call_method_to_instrument
+  #     ObjectSpace.dump_all(since: gc_generation, shapes: shape_generation)
+  #
   # This method is only expected to work with C Ruby. This is an experimental
   # method and is subject to change. In particular, the function signature and
   # output format are not guaranteed to be compatible in future versions of ruby.

data/stdlib/openssl/0/openssl.rbs

@@ -689,7 +689,7 @@ module OpenSSL
   #
   # An Array that stores the name of a given tag number. These names are the same
   # as the name of the tag constant that is additionally defined, e.g.
-  # +[UNIVERSAL_TAG_NAME](2) = "INTEGER"+ and +OpenSSL::ASN1::INTEGER = 2+.
+  # `UNIVERSAL_TAG_NAME[2] = "INTEGER"` and `OpenSSL::ASN1::INTEGER = 2`.
   #
   # ## Example usage
   #
@@ -6953,7 +6953,8 @@ module OpenSSL
       #   - rsa.private_decrypt(string, padding) -> String
       # -->
       # Decrypt `string`, which has been encrypted with the public key, with the
-      # private key. `padding` defaults to PKCS1_PADDING.
+      # private key. `padding` defaults to PKCS1_PADDING, which is known to be
+      # insecure but is kept for backwards compatibility.
       #
       # **Deprecated in version 3.0**. Consider using PKey::PKey#encrypt and
       # PKey::PKey#decrypt instead.
@@ -6965,8 +6966,9 @@ module OpenSSL
       #   - rsa.private_encrypt(string)          -> String
       #   - rsa.private_encrypt(string, padding) -> String
       # -->
-      # Encrypt `string` with the private key.  `padding` defaults to PKCS1_PADDING.
-      # The encrypted string output can be decrypted using #public_decrypt.
+      # Encrypt `string` with the private key.  `padding` defaults to PKCS1_PADDING,
+      # which is known to be insecure but is kept for backwards compatibility. The
+      # encrypted string output can be decrypted using #public_decrypt.
       #
       # **Deprecated in version 3.0**. Consider using PKey::PKey#sign_raw and
       # PKey::PKey#verify_raw, and PKey::PKey#verify_recover instead.
@@ -6988,7 +6990,8 @@ module OpenSSL
       #   - rsa.public_decrypt(string, padding) -> String
       # -->
       # Decrypt `string`, which has been encrypted with the private key, with the
-      # public key.  `padding` defaults to PKCS1_PADDING.
+      # public key.  `padding` defaults to PKCS1_PADDING which is known to be insecure
+      # but is kept for backwards compatibility.
       #
       # **Deprecated in version 3.0**. Consider using PKey::PKey#sign_raw and
       # PKey::PKey#verify_raw, and PKey::PKey#verify_recover instead.
@@ -7000,8 +7003,9 @@ module OpenSSL
       #   - rsa.public_encrypt(string)          -> String
       #   - rsa.public_encrypt(string, padding) -> String
       # -->
-      # Encrypt `string` with the public key.  `padding` defaults to PKCS1_PADDING.
-      # The encrypted string output can be decrypted using #private_decrypt.
+      # Encrypt `string` with the public key.  `padding` defaults to PKCS1_PADDING,
+      # which is known to be insecure but is kept for backwards compatibility. The
+      # encrypted string output can be decrypted using #private_decrypt.
       #
       # **Deprecated in version 3.0**. Consider using PKey::PKey#encrypt and
       # PKey::PKey#decrypt instead.

data/stdlib/optparse/0/optparse.rbs

@@ -539,12 +539,12 @@ class OptionParser
   #   - define(*params, &block)
   # -->
   # Creates an option from the given parameters `params`. See [Parameters for New
-  # Options](./option_params.rdoc).
+  # Options](optparse/option_params.rdoc).
   #
   # The block, if given, is the handler for the created option. When the option is
   # encountered during command-line parsing, the block is called with the argument
   # given for the option, if any. See [Option
-  # Handlers](./option_params.rdoc#label-Option+Handlers).
+  # Handlers](optparse/option_params.rdoc#label-Option+Handlers).
   #
   def define: (*String params) ?{ (*untyped) -> untyped } -> untyped
             | (String params, Class | Array[String] | Hash[Symbol, untyped] | Regexp obj, ?String desc) ?{ (*untyped) -> untyped } -> untyped
@@ -556,12 +556,12 @@ class OptionParser
   #   - define_head(*params, &block)
   # -->
   # Creates an option from the given parameters `params`. See [Parameters for New
-  # Options](./option_params.rdoc).
+  # Options](optparse/option_params.rdoc).
   #
   # The block, if given, is the handler for the created option. When the option is
   # encountered during command-line parsing, the block is called with the argument
   # given for the option, if any. See [Option
-  # Handlers](./option_params.rdoc#label-Option+Handlers).
+  # Handlers](optparse/option_params.rdoc#label-Option+Handlers).
   #
   def define_head: (*String params) ?{ (*untyped) -> untyped } -> untyped
                  | (String params, Class | Array[String] | Hash[Symbol, untyped] | Regexp obj, ?String desc) ?{ (*untyped) -> untyped } -> untyped
@@ -573,12 +573,12 @@ class OptionParser
   #   - define_tail(*params, &block)
   # -->
   # Creates an option from the given parameters `params`. See [Parameters for New
-  # Options](./option_params.rdoc).
+  # Options](optparse/option_params.rdoc).
   #
   # The block, if given, is the handler for the created option. When the option is
   # encountered during command-line parsing, the block is called with the argument
   # given for the option, if any. See [Option
-  # Handlers](./option_params.rdoc#label-Option+Handlers).
+  # Handlers](optparse/option_params.rdoc#label-Option+Handlers).
   #
   def define_tail: (*String params) ?{ (*untyped) -> untyped } -> untyped
                  | (String params, Class | Array[String] | Hash[Symbol, untyped] | Regexp obj, ?String desc) ?{ (*untyped) -> untyped } -> untyped
@@ -629,7 +629,7 @@ class OptionParser
 
   # <!--
   #   rdoc-file=lib/optparse.rb
-  #   - load(filename = nil)
+  #   - load(filename = nil, into: nil)
   # -->
   # Loads options from file names as `filename`. Does nothing when the file is not
   # present. Returns whether successfully loaded.
@@ -638,6 +638,9 @@ class OptionParser
   # ~/.options, then the basename with '.options' suffix under XDG and Haiku
   # standard places.
   #
+  # The optional `into` keyword argument works exactly like that accepted in
+  # method #parse.
+  #
   def load: (?String filename) -> bool
 
   # <!--
@@ -645,12 +648,12 @@ class OptionParser
   #   - make_switch(params, block = nil)
   # -->
   # Creates an option from the given parameters `params`. See [Parameters for New
-  # Options](./option_params.rdoc).
+  # Options](optparse/option_params.rdoc).
   #
   # The block, if given, is the handler for the created option. When the option is
   # encountered during command-line parsing, the block is called with the argument
   # given for the option, if any. See [Option
-  # Handlers](./option_params.rdoc#label-Option+Handlers).
+  # Handlers](optparse/option_params.rdoc#label-Option+Handlers).
   #
   def make_switch: (Array[untyped] opts, ?Proc block) -> [ untyped, untyped, untyped, untyped, untyped ]
 
@@ -668,12 +671,12 @@ class OptionParser
   #   - on(*params, &block)
   # -->
   # Creates an option from the given parameters `params`. See [Parameters for New
-  # Options](./option_params.rdoc).
+  # Options](optparse/option_params.rdoc).
   #
   # The block, if given, is the handler for the created option. When the option is
   # encountered during command-line parsing, the block is called with the argument
   # given for the option, if any. See [Option
-  # Handlers](./option_params.rdoc#label-Option+Handlers).
+  # Handlers](optparse/option_params.rdoc#label-Option+Handlers).
   #
   def on: (*String params) ?{ (*untyped) -> untyped } -> self
         | (String params, Class | Array[String] | Hash[Symbol, untyped] | Regexp obj, ?String desc) ?{ (*untyped) -> untyped } -> self
@@ -687,12 +690,12 @@ class OptionParser
   #   - on_head(*params, &block)
   # -->
   # Creates an option from the given parameters `params`. See [Parameters for New
-  # Options](./option_params.rdoc).
+  # Options](optparse/option_params.rdoc).
   #
   # The block, if given, is the handler for the created option. When the option is
   # encountered during command-line parsing, the block is called with the argument
   # given for the option, if any. See [Option
-  # Handlers](./option_params.rdoc#label-Option+Handlers).
+  # Handlers](optparse/option_params.rdoc#label-Option+Handlers).
   #
   # The new option is added at the head of the summary.
   #
@@ -708,12 +711,12 @@ class OptionParser
   #   - on_tail(*params, &block)
   # -->
   # Creates an option from the given parameters `params`. See [Parameters for New
-  # Options](./option_params.rdoc).
+  # Options](optparse/option_params.rdoc).
   #
   # The block, if given, is the handler for the created option. When the option is
   # encountered during command-line parsing, the block is called with the argument
   # given for the option, if any. See [Option
-  # Handlers](./option_params.rdoc#label-Option+Handlers).
+  # Handlers](optparse/option_params.rdoc#label-Option+Handlers).
   #
   # The new option is added at the tail of the summary.
   #
@@ -1660,7 +1663,7 @@ class OptionParser::Switch::OptionalArgument < OptionParser::Switch
 end
 
 # <!-- rdoc-file=lib/optparse.rb -->
-# Switch that takes an argument, which does not begin with '-'.
+# Switch that takes an argument, which does not begin with '-' or is '-'.
 #
 class OptionParser::Switch::PlacedArgument < OptionParser::Switch
   public
@@ -1669,7 +1672,7 @@ class OptionParser::Switch::PlacedArgument < OptionParser::Switch
   #   rdoc-file=lib/optparse.rb
   #   - parse(arg, argv, &error)
   # -->
-  # Returns nil if argument is not present or begins with '-'.
+  # Returns nil if argument is not present or begins with '-' and is not '-'.
   #
   def parse: (untyped arg, untyped argv) { (*untyped) -> untyped } -> untyped
 end

data/stdlib/pathname/0/pathname.rbs

@@ -135,6 +135,7 @@
 # *   #make_symlink(old)
 # *   #truncate(length)
 # *   #utime(atime, mtime)
+# *   #lutime(atime, mtime)
 # *   #basename(*args)
 # *   #dirname
 # *   #extname
@@ -230,7 +231,9 @@ class Pathname
   #   rdoc-file=ext/pathname/lib/pathname.rb
   #   - +(other)
   # -->
-  # Appends a pathname fragment to `self` to produce a new Pathname object.
+  # Appends a pathname fragment to `self` to produce a new Pathname object. Since
+  # `other` is considered as a path relative to `self`, if `other` is an absolute
+  # path, the new Pathname object is created from just `other`.
   #
   #     p1 = Pathname.new("/usr")      # Pathname:/usr
   #     p2 = p1 + "bin/ruby"           # Pathname:/usr/bin/ruby
@@ -808,7 +811,9 @@ class Pathname
   #   rdoc-file=ext/pathname/lib/pathname.rb
   #   - join(*args)
   # -->
-  # Joins the given pathnames onto `self` to create a new Pathname object.
+  # Joins the given pathnames onto `self` to create a new Pathname object. This is
+  # effectively the same as using Pathname#+ to append `self` and all arguments
+  # sequentially.
   #
   #     path0 = Pathname.new("/usr")                # Pathname:/usr
   #     path0 = path0.join("bin/ruby")              # Pathname:/usr/bin/ruby
@@ -847,6 +852,18 @@ class Pathname
   #
   def lstat: () -> ::File::Stat
 
+  # <!--
+  #   rdoc-file=ext/pathname/pathname.c
+  #   - lutime(p1, p2)
+  # -->
+  # Update the access and modification times of the file.
+  #
+  # Same as Pathname#utime, but does not follow symbolic links.
+  #
+  # See File.lutime.
+  #
+  def lutime: (Time | Numeric atime, Time | Numeric mtime) -> Integer
+
   # <!--
   #   rdoc-file=ext/pathname/pathname.c
   #   - pathname.make_link(old)
@@ -1091,11 +1108,11 @@ class Pathname
 
   # <!--
   #   rdoc-file=ext/pathname/lib/pathname.rb
-  #   - rmtree()
+  #   - rmtree(noop: nil, verbose: nil, secure: nil)
   # -->
   # Recursively deletes a directory, including all directories beneath it.
   #
-  # See FileUtils.rm_r
+  # See FileUtils.rm_rf
   #
   def rmtree: () -> void