rbs 3.7.0 → 3.8.0.pre.1

data/stdlib/nkf/0/nkf.rbs

@@ -71,9 +71,11 @@
 # -h1 --hiragana
 # :   Katakana to Hiragana conversion.
 #
+#
 # -h2 --katakana
 # :   Hiragana to Katakana conversion.
 #
+#
 # -h3 --katakana-hiragana
 # :   Katakana to Hiragana and Hiragana to Katakana conversion.
 #
@@ -102,12 +104,15 @@
 # -Z -Z0
 # :   Convert X0208 alphabet to ASCII.
 #
+#
 # -Z1
 # :   Converts X0208 kankaku to single ASCII space.
 #
+#
 # -Z2
 # :   Converts X0208 kankaku to double ASCII spaces.
 #
+#
 # -Z3
 # :   Replacing Fullwidth >, <, ", & into '&gt;', '&lt;', '&quot;', '&amp;' as
 #     in HTML.
@@ -128,6 +133,7 @@
 # -B1
 # :   allows any char after ESC-( or ESC-$.
 #
+#
 # -B2
 # :   forces ASCII after NL.
 #
@@ -154,6 +160,7 @@
 # -mQ
 # :   Decode MIME quoted stream. '_' in quoted stream is converted to space.
 #
+#
 # -mN
 # :   Non-strict decoding.
 #
@@ -172,6 +179,7 @@
 # -MB
 # :   MIME encode Base64 stream.
 #
+#
 # -MQ
 # :   Perform quoted encoding.
 #
@@ -188,9 +196,11 @@
 # -Lu
 # :   unix (LF)
 #
+#
 # -Lw
 # :   windows (CRLF)
 #
+#
 # -Lm
 # :   mac (CR)
 #
@@ -215,63 +225,83 @@
 # ISO-2022-JP
 # :   a.k.a. RFC1468, 7bit JIS, JUNET
 #
+#
 # EUC-JP (eucJP-nkf)
 # :   a.k.a. AT&T JIS, Japanese EUC, UJIS
 #
+#
 # eucJP-ascii
 # :   a.k.a. x-eucjp-open-19970715-ascii
 #
+#
 # eucJP-ms
 # :   a.k.a. x-eucjp-open-19970715-ms
 #
+#
 # CP51932
 # :   Microsoft Version of EUC-JP.
 #
+#
 # Shift_JIS
 # :   SJIS, MS-Kanji
 #
+#
 # Windows-31J
 # :   a.k.a. CP932
 #
+#
 # UTF-8
 # :   same as UTF-8N
 #
+#
 # UTF-8N
 # :   UTF-8 without BOM
 #
+#
 # UTF-8-BOM
 # :   UTF-8 with BOM
 #
+#
 # UTF-16
 # :   same as UTF-16BE
 #
+#
 # UTF-16BE
 # :   UTF-16 Big Endian without BOM
 #
+#
 # UTF-16BE-BOM
 # :   UTF-16 Big Endian with BOM
 #
+#
 # UTF-16LE
 # :   UTF-16 Little Endian without BOM
 #
+#
 # UTF-16LE-BOM
 # :   UTF-16 Little Endian with BOM
 #
+#
 # UTF-32
 # :   same as UTF-32BE
 #
+#
 # UTF-32BE
 # :   UTF-32 Big Endian without BOM
 #
+#
 # UTF-32BE-BOM
 # :   UTF-32 Big Endian with BOM
 #
+#
 # UTF-32LE
 # :   UTF-32 Little Endian without BOM
 #
+#
 # UTF-32LE-BOM
 # :   UTF-32 Little Endian with BOM
 #
+#
 # UTF8-MAC
 # :   NKDed UTF-8, a.k.a. UTF8-NFD (input only)
 #

data/stdlib/objspace/0/objspace.rbs

@@ -246,7 +246,6 @@ module ObjectSpace
   # *   if an instance of IO object is provided, the output goes there, and the
   #     object is returned.
   #
-  #
   # 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.
@@ -395,7 +394,7 @@ module ObjectSpace
   #
   # With this method, you can find memory leaks.
   #
-  # This method is only expected to work except with C Ruby.
+  # This method is only expected to work with C Ruby.
   #
   # Example:
   #     ObjectSpace.reachable_objects_from(['a', 'b', 'c'])

data/stdlib/observable/0/observable.rbs

@@ -12,7 +12,6 @@
 # *   assert that it has `#changed`
 # *   call `#notify_observers`
 #
-#
 # An observer subscribes to updates using Observable#add_observer, which also
 # specifies the method called via #notify_observers. The default method for
 # #notify_observers is #update.
@@ -139,6 +138,7 @@ module Observable
   #
   # `observer`
   # :   the object that will be notified of changes.
+  #
   # `func`
   # :   Symbol naming the method that will be called when this Observable has
   #     changes.

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

@@ -186,6 +186,7 @@ module OpenURI
     #     When false or nil is given, the environment variables are ignored and
     #     connection will be made to a server directly.
     #
+    #
     # :proxy_http_basic_authentication
     # :   Synopsis:
     #         :proxy_http_basic_authentication =>
@@ -204,6 +205,7 @@ module OpenURI
     #     If :proxy and :proxy_http_basic_authentication is specified, ArgumentError
     #     is raised.
     #
+    #
     # :http_basic_authentication
     # :   Synopsis:
     #         :http_basic_authentication=>[user, password]
@@ -212,6 +214,7 @@ module OpenURI
     #     which contains 2 strings: username and password. It is used for HTTP Basic
     #     authentication defined by RFC 2617.
     #
+    #
     # :content_length_proc
     # :   Synopsis:
     #         :content_length_proc => lambda {|content_length| ... }
@@ -226,6 +229,7 @@ module OpenURI
     #     When expected content length is unknown, the procedure is called with nil.
     #      This happens when the HTTP response has no Content-Length header.
     #
+    #
     # :progress_proc
     # :   Synopsis:
     #         :progress_proc => lambda {|size| ...}
@@ -253,6 +257,7 @@ module OpenURI
     #             pbar.set s if pbar
     #           }) {|f| ... }
     #
+    #
     # :read_timeout
     # :   Synopsis:
     #         :read_timeout=>nil     (no timeout)
@@ -260,6 +265,7 @@ module OpenURI
     #
     #     :read_timeout option specifies a timeout of read for http connections.
     #
+    #
     # :open_timeout
     # :   Synopsis:
     #         :open_timeout=>nil     (no timeout)
@@ -267,6 +273,7 @@ module OpenURI
     #
     #     :open_timeout option specifies a timeout of open for http connections.
     #
+    #
     # :ssl_ca_cert
     # :   Synopsis:
     #         :ssl_ca_cert=>filename or an Array of filenames
@@ -274,12 +281,14 @@ module OpenURI
     #     :ssl_ca_cert is used to specify CA certificate for SSL. If it is given,
     #     default certificates are not used.
     #
+    #
     # :ssl_verify_mode
     # :   Synopsis:
     #         :ssl_verify_mode=>mode
     #
     #     :ssl_verify_mode is used to specify openssl verify mode.
     #
+    #
     # :ssl_min_version
     # :   Synopsis:
     #         :ssl_min_version=>:TLS1_2
@@ -287,6 +296,7 @@ module OpenURI
     #     :ssl_min_version option specifies the minimum allowed SSL/TLS protocol
     #     version.  See also OpenSSL::SSL::SSLContext#min_version=.
     #
+    #
     # :ssl_max_version
     # :   Synopsis:
     #         :ssl_max_version=>:TLS1_2
@@ -294,6 +304,7 @@ module OpenURI
     #     :ssl_max_version option specifies the maximum allowed SSL/TLS protocol
     #     version.  See also OpenSSL::SSL::SSLContext#max_version=.
     #
+    #
     # :ftp_active_mode
     # :   Synopsis:
     #         :ftp_active_mode=>bool
@@ -302,6 +313,7 @@ module OpenURI
     #     passive mode by default. Note that the active mode is default in Ruby 1.8
     #     or prior.
     #
+    #
     # :redirect
     # :   Synopsis:
     #         :redirect=>bool
@@ -312,6 +324,46 @@ module OpenURI
     #     OpenURI::HTTPRedirect exception raised on redirection. Using `true` also
     #     means that redirections between http and ftp are permitted.
     #
+    #
+    # :max_redirects
+    # :   Synopsis:
+    #         :max_redirects=>int
+    #
+    #     Number of HTTP redirects allowed before OpenURI::TooManyRedirects is
+    #     raised. The default is 64.
+    #
+    #
+    # :request_specific_fields
+    # :   Synopsis:
+    #         :request_specific_fields => {}
+    #         :request_specific_fields => lambda {|url| ...}
+    #
+    #     :request_specific_fields option allows specifying custom header fields
+    #     that are sent with the HTTP request. It can be passed as a Hash or a Proc
+    #     that gets evaluated on each request and returns a Hash of header fields.
+    #
+    #     If a Hash is provided, it specifies the headers only for the initial
+    #     request and these headers will not be sent on redirects.
+    #
+    #     If a Proc is provided, it will be executed for each request including
+    #     redirects, allowing dynamic header customization based on the request URL.
+    #     It is important that the Proc returns a Hash. And this Hash specifies the
+    #     headers to be sent with the request.
+    #
+    #     For Example with Hash
+    #         URI.open("http://...",
+    #                  request_specific_fields: {"Authorization" => "token dummy"}) {|f| ... }
+    #
+    #     For Example with Proc:
+    #         URI.open("http://...",
+    #                  request_specific_fields: lambda { |uri|
+    #                    if uri.host == "example.com"
+    #                      {"Authorization" => "token dummy"}
+    #                    else
+    #                      {}
+    #                    end
+    #                  }) {|f| ... }
+    #
     def open: (*untyped) -> IO
             | [T] (*untyped) { (IO) -> T } -> T
 

data/stdlib/open3/0/open3.rbs

@@ -17,7 +17,6 @@
 #     *   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:
 #
@@ -28,7 +27,6 @@
 #     *   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:
 #
@@ -39,8 +37,6 @@
 #     *   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
@@ -66,7 +62,6 @@ module Open3
   # *   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"')
@@ -99,14 +94,12 @@ module Open3
   # *   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
@@ -133,7 +126,6 @@ module Open3
   # *   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')