rbs 3.6.0.pre.2 → 3.6.0

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

@@ -21,7 +21,7 @@ module URI
   # We can accept URIs and strings that begin with http://, https:// and ftp://.
   # In these cases, the opened file object is extended by OpenURI::Meta.
   #
-  def self.open: (String name, ?String mode, ?Integer perm, ?untyped options) -> (StringIO & OpenURI::Meta | Tempfile & OpenURI::Meta)
+  def self.open: (String name, ?String mode, ?Integer perm, ?untyped options) -> ((StringIO & OpenURI::Meta) | (Tempfile & OpenURI::Meta))
                | [T] (String name, ?String mode, ?Integer perm, ?untyped options) { (StringIO | Tempfile) -> T } -> T
 end
 

data/stdlib/open3/0/open3.rbs

@@ -0,0 +1,155 @@
+# <!-- rdoc-file=lib/open3.rb -->
+# Module Open3 supports creating child processes with access to their $stdin,
+# $stdout, and $stderr streams.
+#
+# ## What's Here
+#
+# Each of these methods executes a given command in a new process or subshell,
+# or multiple commands in new processes and/or subshells:
+#
+# *   Each of these methods executes a single command in a process or subshell,
+#     accepts a string for input to $stdin, and returns string output from
+#     $stdout, $stderr, or both:
+#
+#     *   Open3.capture2: Executes the command; returns the string from $stdout.
+#     *   Open3.capture2e: Executes the command; returns the string from merged
+#         $stdout and $stderr.
+#     *   Open3.capture3: Executes the command; returns strings from $stdout and
+#         $stderr.
+#
+#
+# *   Each of these methods executes a single command in a process or subshell,
+#     and returns pipes for $stdin, $stdout, and/or $stderr:
+#
+#     *   Open3.popen2: Executes the command; returns pipes for $stdin and
+#         $stdout.
+#     *   Open3.popen2e: Executes the command; returns pipes for $stdin and
+#         merged $stdout and $stderr.
+#     *   Open3.popen3: Executes the command; returns pipes for $stdin, $stdout,
+#         and $stderr.
+#
+#
+# *   Each of these methods executes one or more commands in processes and/or
+#     subshells, returns pipes for the first $stdin, the last $stdout, or both:
+#
+#     *   Open3.pipeline_r: Returns a pipe for the last $stdout.
+#     *   Open3.pipeline_rw: Returns pipes for the first $stdin and the last
+#         $stdout.
+#     *   Open3.pipeline_w: Returns a pipe for the first $stdin.
+#     *   Open3.pipeline_start: Does not wait for processes to complete.
+#     *   Open3.pipeline: Waits for processes to complete.
+#
+#
+#
+# Each of the methods above accepts:
+#
+# *   An optional hash of environment variable names and values; see [Execution
+#     Environment](rdoc-ref:Process@Execution+Environment).
+# *   A required string argument that is a `command_line` or `exe_path`; see
+#     [Argument command_line or
+#     exe_path](rdoc-ref:Process@Argument+command_line+or+exe_path).
+# *   An optional hash of execution options; see [Execution
+#     Options](rdoc-ref:Process@Execution+Options).
+#
+module Open3
+  # <!--
+  #   rdoc-file=lib/open3.rb
+  #   - Open3.capture2e([env, ] command_line, options = {}) -> [stdout_and_stderr_s, status]
+  #   - Open3.capture2e([env, ] exe_path, *args, options = {}) -> [stdout_and_stderr_s, status]
+  # -->
+  # Basically a wrapper for Open3.popen3 that:
+  #
+  # *   Creates a child process, by calling Open3.popen3 with the given arguments
+  #     (except for certain entries in hash `options`; see below).
+  # *   Returns as string `stdout_and_stderr_s` the merged standard output and
+  #     standard error of the child process.
+  # *   Returns as `status` a `Process::Status` object that represents the exit
+  #     status of the child process.
+  #
+  #
+  # Returns the array `[stdout_and_stderr_s, status]`:
+  #
+  #     stdout_and_stderr_s, status = Open3.capture2e('echo "Foo"')
+  #     # => ["Foo\n", #<Process::Status: pid 2371692 exit 0>]
+  #
+  # Like Process.spawn, this method has potential security vulnerabilities if
+  # called with untrusted input; see [Command
+  # Injection](rdoc-ref:command_injection.rdoc@Command+Injection).
+  #
+  # Unlike Process.spawn, this method waits for the child process to exit before
+  # returning, so the caller need not do so.
+  #
+  # If the first argument is a hash, it becomes leading argument `env` in the call
+  # to Open3.popen3; see [Execution
+  # Environment](rdoc-ref:Process@Execution+Environment).
+  #
+  # If the last argument is a hash, it becomes trailing argument `options` in the
+  # call to Open3.popen3; see [Execution
+  # Options](rdoc-ref:Process@Execution+Options).
+  #
+  # The hash `options` is given; two options have local effect in method
+  # Open3.capture2e:
+  #
+  # *   If entry `options[:stdin_data]` exists, the entry is removed and its
+  #     string value is sent to the command's standard input:
+  #
+  #         Open3.capture2e('tee', stdin_data: 'Foo')
+  #         # => ["Foo", #<Process::Status: pid 2371732 exit 0>]
+  #
+  # *   If entry `options[:binmode]` exists, the entry is removed and the internal
+  #     streams are set to binary mode.
+  #
+  #
+  # The single required argument is one of the following:
+  #
+  # *   `command_line` if it is a string, and if it begins with a shell reserved
+  #     word or special built-in, or if it contains one or more metacharacters.
+  # *   `exe_path` otherwise.
+  #
+  #
+  # **Argument `command_line`**
+  #
+  # String argument `command_line` is a command line to be passed to a shell; it
+  # must begin with a shell reserved word, begin with a special built-in, or
+  # contain meta characters:
+  #
+  #     Open3.capture2e('if true; then echo "Foo"; fi') # Shell reserved word.
+  #     # => ["Foo\n", #<Process::Status: pid 2371740 exit 0>]
+  #     Open3.capture2e('echo')                         # Built-in.
+  #     # => ["\n", #<Process::Status: pid 2371774 exit 0>]
+  #     Open3.capture2e('date > date.tmp')              # Contains meta character.
+  #     # => ["", #<Process::Status: pid 2371812 exit 0>]
+  #
+  # The command line may also contain arguments and options for the command:
+  #
+  #     Open3.capture2e('echo "Foo"')
+  #     # => ["Foo\n", #<Process::Status: pid 2326183 exit 0>]
+  #
+  # **Argument `exe_path`**
+  #
+  # Argument `exe_path` is one of the following:
+  #
+  # *   The string path to an executable to be called.
+  # *   A 2-element array containing the path to an executable and the string to
+  #     be used as the name of the executing process.
+  #
+  #
+  # Example:
+  #
+  #     Open3.capture2e('/usr/bin/date')
+  #     # => ["Sat Sep 30 09:01:46 AM CDT 2023\n", #<Process::Status: pid 2371820 exit 0>]
+  #
+  # Ruby invokes the executable directly, with no shell and no shell expansion:
+  #
+  #     Open3.capture2e('doesnt_exist') # Raises Errno::ENOENT
+  #
+  # If one or more `args` is given, each is an argument or option to be passed to
+  # the executable:
+  #
+  #     Open3.capture2e('echo', 'C #')
+  #     # => ["C #\n", #<Process::Status: pid 2371856 exit 0>]
+  #     Open3.capture2e('echo', 'hello', 'world')
+  #     # => ["hello world\n", #<Process::Status: pid 2371894 exit 0>]
+  #
+  def self.capture2e: (*String, ?stdin_data: String, ?binmode: boolish) -> [String, Process::Status]
+end

data/stdlib/openssl/0/openssl.rbs

@@ -934,8 +934,6 @@ module OpenSSL
     #     puts int2.value # => 1
     #
     class ASN1Data
-      public
-
       # <!-- rdoc-file=ext/openssl/ossl_asn1.c -->
       # Never `nil`. A boolean value indicating whether the encoding uses indefinite
       # length (in the case of parsing) or whether an indefinite length form shall be
@@ -1082,8 +1080,6 @@ module OpenSSL
     end
 
     class BitString < OpenSSL::ASN1::Primitive
-      public
-
       def unused_bits: () -> ::Integer
 
       def unused_bits=: (::Integer) -> ::Integer
@@ -1127,8 +1123,6 @@ module OpenSSL
     class Constructive < OpenSSL::ASN1::ASN1Data
       include Enumerable[ASN1Data]
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_asn1.c
       #   - asn1_ary.each { |asn1| block } => asn1_ary
@@ -1192,8 +1186,6 @@ module OpenSSL
     end
 
     class EndOfContent < OpenSSL::ASN1::ASN1Data
-      public
-
       def to_der: () -> String
 
       private
@@ -1275,8 +1267,6 @@ module OpenSSL
 
       def value=: (String) -> String
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_asn1.c
       #   - oid == other_oid => true or false
@@ -1393,8 +1383,6 @@ module OpenSSL
     #     prim_zero_tagged_explicit = <class>.new(value, 0, :EXPLICIT)
     #
     class Primitive < OpenSSL::ASN1::ASN1Data
-      public
-
       # <!-- rdoc-file=ext/openssl/ossl_asn1.c -->
       # May be used as a hint for encoding a value either implicitly or explicitly by
       # setting it either to `:IMPLICIT` or to `:EXPLICIT`. *tagging* is not set when
@@ -1535,8 +1523,6 @@ module OpenSSL
     #
     def self.rand_range: (untyped) -> untyped
 
-    public
-
     # <!--
     #   rdoc-file=ext/openssl/ossl_bn.c
     #   - bn % bn2 => aBN
@@ -1950,8 +1936,6 @@ module OpenSSL
   module Buffering
     include Enumerable[untyped]
 
-    public
-
     # <!--
     #   rdoc-file=ext/openssl/lib/openssl/buffering.rb
     #   - <<(s)
@@ -2490,8 +2474,6 @@ module OpenSSL
     #
     def self.ciphers: () -> Array[String]
 
-    public
-
     # <!--
     #   rdoc-file=ext/openssl/ossl_cipher.c
     #   - cipher.auth_data = string -> string
@@ -2908,8 +2890,6 @@ module OpenSSL
     #
     def self.parse_config: (IO io) -> Hash[String, Hash[String, String]]
 
-    public
-
     # <!--
     #   rdoc-file=ext/openssl/ossl_config.c
     #   - config[section] -> hash
@@ -3198,8 +3178,6 @@ module OpenSSL
     #
     def self.digest: (String name, String data) -> String
 
-    public
-
     # <!-- rdoc-file=ext/openssl/ossl_digest.c -->
     # Not every message digest can be computed in one single pass. If a message
     # digest is to be computed from several subsequent sources, then each may be
@@ -3456,8 +3434,6 @@ module OpenSSL
     #
     def self.load: (?String name) -> (true | nil)
 
-    public
-
     # <!--
     #   rdoc-file=ext/openssl/ossl_engine.c
     #   - engine.cipher(name) -> OpenSSL::Cipher
@@ -3689,8 +3665,6 @@ module OpenSSL
     #
     def self.hexdigest: (String | Digest algo, String key, String data) -> String
 
-    public
-
     # <!-- rdoc-file=ext/openssl/ossl_hmac.c -->
     # Returns *hmac* updated with the message to be authenticated. Can be called
     # repeatedly with chunks of the message.
@@ -4046,8 +4020,6 @@ module OpenSSL
     #
     def self.included: (untyped base) -> untyped
 
-    public
-
     # <!--
     #   rdoc-file=ext/openssl/lib/openssl/marshal.rb
     #   - _dump(_level)
@@ -4056,8 +4028,6 @@ module OpenSSL
     def _dump: (untyped _level) -> untyped
 
     module ClassMethods
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/lib/openssl/marshal.rb
       #   - _load(string)
@@ -4112,8 +4082,6 @@ module OpenSSL
     #     #proceed
     #
     class SPKI
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ns_spki.c
       #   - spki.challenge => string
@@ -4505,8 +4473,6 @@ module OpenSSL
     # detailed than a Response.
     #
     class BasicResponse
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ocsp.c
       #   - basic_response.add_nonce(nonce = nil)
@@ -4644,8 +4610,6 @@ module OpenSSL
     # status check can be performed.
     #
     class CertificateId
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ocsp.c
       #   - certificate_id.cmp(other) -> true or false
@@ -4747,8 +4711,6 @@ module OpenSSL
     # certificate or from a DER-encoded request created elsewhere.
     #
     class Request
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ocsp.c
       #   - request.add_certid(certificate_id) -> request
@@ -4884,8 +4846,6 @@ module OpenSSL
       #
       def self.create: (Integer status, ?BasicResponse response) -> instance
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ocsp.c
       #   - response.basic
@@ -4943,8 +4903,6 @@ module OpenSSL
     # which contains the basic information of the status of the certificate.
     #
     class SingleResponse
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ocsp.c
       #   - single_response.cert_status -> Integer
@@ -5089,8 +5047,6 @@ module OpenSSL
     #
     def self.create: (String pass, String name, PKey::PKey key, X509::Certificate cert, ?Array[X509::Certificate]? ca, ?String? key_pbe, ?String? cert_pbe, ?Integer? key_iter, ?Integer? mac_iter, ?Integer? keytype) -> instance
 
-    public
-
     def ca_certs: () -> Array[X509::Certificate]?
 
     def certificate: () -> X509::Certificate
@@ -5182,8 +5138,6 @@ module OpenSSL
     #
     def self.write_smime: (instance pkcs7, ?String data, ?Integer flags) -> String
 
-    public
-
     # <!--
     #   rdoc-file=ext/openssl/ossl_pkcs7.c
     #   - add_certificate(p1)
@@ -5393,8 +5347,6 @@ module OpenSSL
     end
 
     class RecipientInfo
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_pkcs7.c
       #   - enc_key()
@@ -5427,8 +5379,6 @@ module OpenSSL
     end
 
     class SignerInfo
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_pkcs7.c
       #   - issuer()
@@ -5580,8 +5530,6 @@ module OpenSSL
       #
       def self.generate: (Integer size, ?Integer generator) -> instance
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/lib/openssl/pkey.rb
       #   - dh.compute_key(pub_bn) -> string
@@ -5882,8 +5830,6 @@ module OpenSSL
       #
       def self.generate: (Integer size) -> instance
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_pkey_dsa.c
       #   - dsa.export([cipher, password]) -> aString
@@ -6279,8 +6225,6 @@ module OpenSSL
       #
       def self.generate: (String | Group pem_or_der_or_group_or_curve_name) -> instance
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_pkey_ec.c
       #   - key.check_key   => true
@@ -6596,8 +6540,6 @@ module OpenSSL
       type point_conversion_format = :compressed | :uncompressed | :hybrid
 
       class Group
-        public
-
         # <!-- rdoc-file=ext/openssl/ossl_pkey_ec.c -->
         # Returns `true` if the two groups use the same curve and have the same
         # parameters, `false` otherwise.
@@ -6803,8 +6745,6 @@ module OpenSSL
       end
 
       class Point
-        public
-
         # <!--
         #   rdoc-file=ext/openssl/ossl_pkey_ec.c
         #   - ==(p1)
@@ -6953,8 +6893,6 @@ module OpenSSL
     # *   OpenSSL::PKey::EC
     #
     class PKey
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_pkey.c
       #   - pkey.inspect -> string
@@ -7136,8 +7074,6 @@ module OpenSSL
       #
       def self.generate: (Integer size, ?Integer exponent) -> instance
 
-      public
-
       def d: () -> BN?
 
       def dmp1: () -> BN?
@@ -7856,8 +7792,6 @@ module OpenSSL
     # be frozen afterward.
     #
     class SSLContext
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ssl.c
       #   - ctx.add_certificate(certificate, pkey [, extra_certs]) -> self
@@ -8767,8 +8701,6 @@ module OpenSSL
     class SSLServer
       include OpenSSL::SSL::SocketForwarder
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/lib/openssl/ssl.rb
       #   - accept()
@@ -8859,8 +8791,6 @@ module OpenSSL
       #
       def self.open: (untyped remote_host, untyped remote_port, ?untyped local_host, ?untyped local_port, ?context: untyped) -> untyped
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ssl.c
       #   - ssl.accept => self
@@ -9250,8 +9180,6 @@ module OpenSSL
     end
 
     class Session
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ssl_session.c
       #   - session1 == session2 -> boolean
@@ -9350,8 +9278,6 @@ module OpenSSL
     end
 
     module SocketForwarder
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/lib/openssl/ssl.rb
       #   - addr()
@@ -9549,8 +9475,6 @@ module OpenSSL
     #     factory.allowed_digests                                               -> array or nil
     #
     class Factory
-      public
-
       def additional_certs: () -> Array[X509::Certificate]?
 
       def additional_certs=: (Array[X509::Certificate]? certs) -> Array[X509::Certificate]?
@@ -9609,8 +9533,6 @@ module OpenSSL
     # *   algorithm, message_imprint, policy_id, and nonce are set to `false`
     #
     class Request
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ts.c
       #   - request.algorithm    -> string
@@ -9753,8 +9675,6 @@ module OpenSSL
     # Response.
     #
     class Response
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ts.c
       #   - response.failure_info -> nil or symbol
@@ -9917,8 +9837,6 @@ module OpenSSL
     # Response.
     #
     class TokenInfo
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_ts.c
       #   - token_info.algorithm -> string or nil
@@ -10287,8 +10205,6 @@ module OpenSSL
 
       extend OpenSSL::Marshal::ClassMethods
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/lib/openssl/x509.rb
       #   - ==(other)
@@ -10359,8 +10275,6 @@ module OpenSSL
 
       extend OpenSSL::Marshal::ClassMethods
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/lib/openssl/x509.rb
       #   - ==(other)
@@ -10637,8 +10551,6 @@ module OpenSSL
 
       extend OpenSSL::Marshal::ClassMethods
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_x509cert.c
       #   - cert1 == cert2 -> true | false
@@ -10867,8 +10779,6 @@ module OpenSSL
 
       extend OpenSSL::Marshal::ClassMethods
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/lib/openssl/x509.rb
       #   - ==(other)
@@ -10980,8 +10890,6 @@ module OpenSSL
       module AuthorityInfoAccess
         include OpenSSL::X509::Extension::Helpers
 
-        public
-
         # <!--
         #   rdoc-file=ext/openssl/lib/openssl/x509.rb
         #   - ca_issuer_uris()
@@ -11018,8 +10926,6 @@ module OpenSSL
       module AuthorityKeyIdentifier
         include OpenSSL::X509::Extension::Helpers
 
-        public
-
         # <!--
         #   rdoc-file=ext/openssl/lib/openssl/x509.rb
         #   - authority_key_identifier()
@@ -11035,8 +10941,6 @@ module OpenSSL
       module CRLDistributionPoints
         include OpenSSL::X509::Extension::Helpers
 
-        public
-
         # <!--
         #   rdoc-file=ext/openssl/lib/openssl/x509.rb
         #   - crl_uris()
@@ -11050,8 +10954,6 @@ module OpenSSL
       end
 
       module Helpers
-        public
-
         # <!--
         #   rdoc-file=ext/openssl/lib/openssl/x509.rb
         #   - find_extension(oid)
@@ -11063,8 +10965,6 @@ module OpenSSL
       module SubjectKeyIdentifier
         include OpenSSL::X509::Extension::Helpers
 
-        public
-
         # <!--
         #   rdoc-file=ext/openssl/lib/openssl/x509.rb
         #   - subject_key_identifier()
@@ -11082,8 +10982,6 @@ module OpenSSL
     end
 
     class ExtensionFactory
-      public
-
       def config: () -> Config?
 
       def config=: (Config config) -> Config
@@ -11233,8 +11131,6 @@ module OpenSSL
       #
       def self.parse_rfc2253: (String str, ?template template) -> instance
 
-      public
-
       # <!-- rdoc-file=ext/openssl/ossl_x509name.c -->
       # Compares this Name with *other* and returns `0` if they are the same and `-1`
       # or `+1` if they are greater or less than each other respectively. Returns
@@ -11506,8 +11402,6 @@ module OpenSSL
 
       extend OpenSSL::Marshal::ClassMethods
 
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/lib/openssl/x509.rb
       #   - ==(other)
@@ -11649,8 +11543,6 @@ module OpenSSL
     end
 
     class Revoked
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/lib/openssl/x509.rb
       #   - ==(other)
@@ -11770,8 +11662,6 @@ module OpenSSL
     #     ssl_socket = OpenSSL::SSL::SSLSocket.new tcp_socket, ssl_context
     #
     class Store
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_x509store.c
       #   - store.add_cert(cert) -> self
@@ -11980,8 +11870,6 @@ module OpenSSL
     # status involved.
     #
     class StoreContext
-      public
-
       # <!--
       #   rdoc-file=ext/openssl/ossl_x509store.c
       #   - stctx.chain -> nil | Array of X509::Certificate