rbs 3.9.5 → 3.10.0.pre.1

data/stdlib/strscan/0/string_scanner.rbs

@@ -28,7 +28,7 @@
 # *   `match_values_cleared?(scanner)`:
 #      Returns whether the scanner's [match
 #     values](rdoc-ref:StringScanner@Match+Values) are cleared.
-# See examples [[here]](ext/strscan/helper_methods_md.html).
+# See examples at [helper methods](doc/strscan/helper_methods.md).
 # ## The `StringScanner` Object
 # This code creates a `StringScanner` object
 # (we'll call it simply a *scanner*),
@@ -85,10 +85,10 @@
 # and a zero-based *character position*.
 # Each of these methods explicitly sets positions:
 #          Method         |                         Effect
-# ------------------------|--------------------------------------------------------
-#          #reset         |Sets both positions to zero (begining of stored string).
+# ------------------------|---------------------------------------------------------
+#          #reset         |Sets both positions to zero (beginning of stored string).
 #        #terminate       |  Sets both positions to the end of the stored string.
-# #pos=(new_byte_position)|    Sets byte position; adjusts character position.
+# #pos=(new_byte_position)|     Sets byte position; adjusts character position.
 # ### Byte Position (Position)
 # The byte position (or simply *position*)
 # is a zero-based index into the bytes in the scanner's stored string;
@@ -159,7 +159,7 @@
 # #   rest_size: 12
 #
 # ## Target Substring
-# The target substring is the the part of the [stored
+# The target substring is the part of the [stored
 # string](rdoc-ref:StringScanner@Stored+String)
 # that extends from the current [byte
 # position](rdoc-ref:StringScanner@Byte+Position+-28Position-29) to the end of
@@ -211,12 +211,12 @@
 # This table summarizes (details and examples at the links):
 #        Method        |                   Returns                   |Sets Match Values?
 # ---------------------|---------------------------------------------|------------------
-#    #check(pattern)   |     Matched leading substring or +nil+.     |       Yes.
-# #check_until(pattern)|   Matched substring (anywhere) or +nil+.    |       Yes.
+#    #check(pattern)   |     Matched leading substring or `nil`.     |       Yes.
+# #check_until(pattern)|   Matched substring (anywhere) or `nil`.    |       Yes.
 #   #exist?(pattern)   |   Matched substring (anywhere) end index.   |       Yes.
-#   #match?(pattern)   | Size of matched leading substring or +nil+. |       Yes.
+#   #match?(pattern)   | Size of matched leading substring or `nil`. |       Yes.
 #      #peek(size)     | Leading substring of given length (bytes).  |       No.
-#      #peek_byte      |       Integer leading byte or +nil+.        |       No.
+#      #peek_byte      |       Integer leading byte or `nil`.        |       No.
 #         #rest        |Target substring (from byte position to end).|       No.
 # ### Traversing the Target Substring
 # A *traversal* method examines the target substring,
@@ -226,24 +226,24 @@
 # This table summarizes (details and examples at links):
 #        Method       |                      Returns                       |Sets Match Values?
 # --------------------|----------------------------------------------------|------------------
-#      #get_byte      |               Leading byte or +nil+.               |       No.
-#        #getch       |            Leading character or +nil+.             |       No.
-#    #scan(pattern)   |        Matched leading substring or +nil+.         |       Yes.
-#      #scan_byte     |           Integer leading byte or +nil+.           |       No.
-# #scan_until(pattern)|       Matched substring (anywhere) or +nil+.       |       Yes.
-#    #skip(pattern)   |      Matched leading substring size or +nil+.      |       Yes.
-# #skip_until(pattern)|Position delta to end-of-matched-substring or +nil+.|       Yes.
-#       #unscan       |                      +self+.                       |       No.
+#      #get_byte      |               Leading byte or `nil`.               |       No.
+#        #getch       |            Leading character or `nil`.             |       No.
+#    #scan(pattern)   |        Matched leading substring or `nil`.         |       Yes.
+#      #scan_byte     |           Integer leading byte or `nil`.           |       No.
+# #scan_until(pattern)|       Matched substring (anywhere) or `nil`.       |       Yes.
+#    #skip(pattern)   |      Matched leading substring size or `nil`.      |       Yes.
+# #skip_until(pattern)|Position delta to end-of-matched-substring or `nil`.|       Yes.
+#       #unscan       |                      `self`.                       |       No.
 # ## Querying the Scanner
 # Each of these methods queries the scanner object
 # without modifying it (details and examples at links)
 #       Method       |            Returns
 # -------------------|--------------------------------
-# #beginning_of_line?|       +true+ or +false+.
+# #beginning_of_line?|       `true` or `false`.
 #      #charpos      |      Character position.
-#        #eos?       |       +true+ or +false+.
-#   #fixed_anchor?   |       +true+ or +false+.
-#      #inspect      |String representation of +self+.
+#        #eos?       |       `true` or `false`.
+#   #fixed_anchor?   |       `true` or `false`.
+#      #inspect      |String representation of `self`.
 #        #pos        |         Byte position.
 #        #rest       |       Target substring.
 #     #rest_size     |   Size of target substring.
@@ -312,11 +312,11 @@
 # Each of these methods returns a basic match value:
 #    Method    |          Return After Match          |Return After No Match
 # -------------|--------------------------------------|---------------------
-#   #matched?  |               +true+.                |      +false+.
-# #matched_size|      Size of matched substring.      |       +nil+.
-#   #matched   |          Matched substring.          |       +nil+.
-#  #pre_match  |Substring preceding matched substring.|       +nil+.
-#  #post_match |Substring following matched substring.|       +nil+.
+#   #matched?  |               `true`.                |      `false`.
+# #matched_size|      Size of matched substring.      |       `nil`.
+#   #matched   |          Matched substring.          |       `nil`.
+#  #pre_match  |Substring preceding matched substring.|       `nil`.
+#  #post_match |Substring following matched substring.|       `nil`.
 #
 # See examples below.
 # #### Captured Match Values
@@ -326,11 +326,11 @@
 # Each of these methods returns a captured match value:
 #     Method     |          Return After Match           |Return After No Match
 # ---------------|---------------------------------------|---------------------
-#      #size     |     Count of captured substrings.     |       +nil+.
-#     #[](n)     |   <tt>n</tt>th captured substring.    |       +nil+.
-#    #captures   |   Array of all captured substrings.   |       +nil+.
-# #values_at(*n) |Array of specified captured substrings.|       +nil+.
-# #named_captures|        Hash of named captures.        |    <tt>{}</tt>.
+#      #size     |     Count of captured substrings.     |       `nil`.
+#     #[](n)     |       `n`th captured substring.       |       `nil`.
+#    #captures   |   Array of all captured substrings.   |       `nil`.
+# #values_at(*n) |Array of specified captured substrings.|       `nil`.
+# #named_captures|        Hash of named captures.        |        `{}`.
 #
 # See examples below.
 # #### Match Values Examples

data/stdlib/tempfile/0/tempfile.rbs

@@ -19,7 +19,7 @@
 #     require 'tempfile'
 #
 #     # Tempfile.create with a block
-#     # The filename are choosen automatically.
+#     # The filename are chosen automatically.
 #     # (You can specify the prefix and suffix of the filename by an optional argument.)
 #     Tempfile.create {|f|
 #       f.puts "foo"

data/stdlib/tsort/0/cyclic.rbs

@@ -1,5 +1,8 @@
 %a{annotate:rdoc:skip}
 module TSort[Node]
+  # <!-- rdoc-file=lib/tsort.rb -->
+  # Exception class to be raised when a cycle is found.
+  #
   class Cyclic < StandardError
   end
 end

data/stdlib/uri/0/common.rbs

@@ -420,8 +420,8 @@ module URI
   #     URI.parse('http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
   #     # => #<URI::HTTP http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
   #
-  # It's recommended to first ::escape string `uri` if it may contain invalid URI
-  # characters.
+  # It's recommended to first URI::RFC2396_PARSER.escape string `uri` if it may
+  # contain invalid URI characters.
   #
   def self.parse: (_ToStr uri) -> (File | FTP | HTTP | HTTPS | LDAP | LDAPS | MailTo | WS | WSS | Generic)
 
@@ -535,6 +535,9 @@ URI::ABS_URI: Regexp
 
 URI::ABS_URI_REF: Regexp
 
+# <!-- rdoc-file=lib/uri/common.rb -->
+# The default parser instance.
+#
 URI::DEFAULT_PARSER: URI::RFC2396_Parser
 
 URI::ESCAPED: Regexp
@@ -557,6 +560,9 @@ URI::REL_URI: Regexp
 
 URI::REL_URI_REF: Regexp
 
+# <!-- rdoc-file=lib/uri/common.rb -->
+# The default parser instance for RFC 3986.
+#
 URI::RFC3986_PARSER: URI::RFC3986_Parser
 
 URI::SCHEME: Regexp
@@ -588,6 +594,7 @@ module Kernel
   # Returns a URI object derived from the given `uri`, which may be a URI string
   # or an existing URI object:
   #
+  #     require 'uri'
   #     # Returns a new URI.
   #     uri = URI('http://github.com/ruby/ruby')
   #     # => #<URI::HTTP http://github.com/ruby/ruby>
@@ -595,5 +602,7 @@ module Kernel
   #     URI(uri)
   #     # => #<URI::HTTP http://github.com/ruby/ruby>
   #
+  # You must require 'uri' to use this method.
+  #
   def self?.URI: (URI::Generic | String uri) -> URI::Generic
 end

data/stdlib/uri/0/file.rbs

@@ -43,7 +43,7 @@ module URI
     #       :path => '/ruby/src'})
     #     uri2.to_s  # => "file://host.example.com/ruby/src"
     #
-    #     uri3 = URI::File.build({:path => URI::escape('/path/my file.txt')})
+    #     uri3 = URI::File.build({:path => URI::RFC2396_PARSER.escape('/path/my file.txt')})
     #     uri3.to_s  # => "file:///path/my%20file.txt"
     #
     def self.build: (Array[String] args) -> URI::File

data/stdlib/uri/0/generic.rbs

@@ -145,7 +145,7 @@ module URI
     #
     # At first, tries to create a new URI::Generic instance using
     # URI::Generic::build. But, if exception URI::InvalidComponentError is raised,
-    # then it does URI::Escape.escape all URI components and tries again.
+    # then it does URI::RFC2396_PARSER.escape all URI components and tries again.
     #
     def self.build2: (Array[nil | String | Integer]) -> URI::Generic
                    | ({ scheme: String?, userinfo: String?, host: String?, port: Integer?, registry: String?, path: String?, opaque: String?, query: String?, fragment: String? }) -> instance
@@ -293,7 +293,7 @@ module URI
     # -->
     # Returns the parser to be used.
     #
-    # Unless a URI::Parser is defined, DEFAULT_PARSER is used.
+    # Unless the `parser` is defined, DEFAULT_PARSER is used.
     #
     def parser: () -> untyped
 
@@ -317,7 +317,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_scheme(v)
     # -->
-    # Checks the scheme `v` component against the URI::Parser Regexp for :SCHEME.
+    # Checks the scheme `v` component against the `parser` Regexp for :SCHEME.
     #
     def check_scheme: (String? v) -> true
 
@@ -374,8 +374,8 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_user(v)
     # -->
-    # Checks the user `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :USERINFO.
+    # Checks the user `v` component for RFC2396 compliance and against the `parser`
+    # Regexp for :USERINFO.
     #
     # Can not have a registry or opaque component defined, with a user component
     # defined.
@@ -387,7 +387,7 @@ module URI
     #   - check_password(v, user = @user)
     # -->
     # Checks the password `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :USERINFO.
+    # `parser` Regexp for :USERINFO.
     #
     # Can not have a registry or opaque component defined, with a user component
     # defined.
@@ -530,8 +530,8 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_host(v)
     # -->
-    # Checks the host `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :HOST.
+    # Checks the host `v` component for RFC2396 compliance and against the `parser`
+    # Regexp for :HOST.
     #
     # Can not have a registry or opaque component defined, with a host component
     # defined.
@@ -611,8 +611,8 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_port(v)
     # -->
-    # Checks the port `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :PORT.
+    # Checks the port `v` component for RFC2396 compliance and against the `parser`
+    # Regexp for :PORT.
     #
     # Can not have a registry or opaque component defined, with a port component
     # defined.
@@ -670,8 +670,8 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - check_path(v)
     # -->
-    # Checks the path `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :ABS_PATH and :REL_PATH.
+    # Checks the path `v` component for RFC2396 compliance and against the `parser`
+    # Regexp for :ABS_PATH and :REL_PATH.
     #
     # Can not have a opaque component defined, with a path component defined.
     #
@@ -742,7 +742,7 @@ module URI
     #   - check_opaque(v)
     # -->
     # Checks the opaque `v` component for RFC2396 compliance and against the
-    # URI::Parser Regexp for :OPAQUE.
+    # `parser` Regexp for :OPAQUE.
     #
     # Can not have a host, port, user, or path component defined, with an opaque
     # component defined.
@@ -781,8 +781,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - fragment=(v)
     # -->
-    # Checks the fragment `v` component against the URI::Parser Regexp for
-    # :FRAGMENT.
+    # Checks the fragment `v` component against the `parser` Regexp for :FRAGMENT.
     #
     # ## Args
     #
@@ -1010,6 +1009,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - hash()
     # -->
+    # Returns the hash value.
     #
     def hash: () -> Integer
 
@@ -1017,6 +1017,7 @@ module URI
     #   rdoc-file=lib/uri/generic.rb
     #   - eql?(oth)
     # -->
+    # Compares with *oth* for Hash.
     #
     def eql?: (URI::Generic oth) -> bool
 

data/stdlib/uri/0/rfc2396_parser.rbs

@@ -17,14 +17,14 @@ module URI
     # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
     # The Hash of patterns.
     #
-    # See also URI::Parser.initialize_pattern.
+    # See also #initialize_pattern.
     #
     attr_reader pattern: Hash[Symbol, String]
 
     # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
     # The Hash of Regexp.
     #
-    # See also URI::Parser.initialize_regexp.
+    # See also #initialize_regexp.
     #
     attr_reader regexp: Hash[Symbol, Regexp]
 
@@ -34,7 +34,7 @@ module URI
     # -->
     # ## Synopsis
     #
-    #     URI::Parser.new([opts])
+    #     URI::RFC2396_Parser.new([opts])
     #
     # ## Args
     #
@@ -52,7 +52,7 @@ module URI
     #
     # ## Examples
     #
-    #     p = URI::Parser.new(:ESCAPED => "(?:%[a-fA-F0-9]{2}|%u[a-fA-F0-9]{4})")
+    #     p = URI::RFC2396_Parser.new(:ESCAPED => "(?:%[a-fA-F0-9]{2}|%u[a-fA-F0-9]{4})")
     #     u = p.parse("http://example.jp/%uABCD") #=> #<URI::HTTP http://example.jp/%uABCD>
     #     URI.parse(u.to_s) #=> raises URI::InvalidURIError
     #
@@ -105,7 +105,7 @@ module URI
     # Attempts to parse and merge a set of URIs. If no `block` given, then returns
     # the result, else it calls `block` for each element in result.
     #
-    # See also URI::Parser.make_regexp.
+    # See also #make_regexp.
     #
     def extract: (String str, ?Array[String] schemes) -> Array[String]
                | (String str, ?Array[String] schemes) { (String) -> untyped } -> nil
@@ -152,8 +152,7 @@ module URI
     #
     # ## Usage
     #
-    #     p = URI::Parser.new
-    #     p.parse("ldap://ldap.example.com/dc=example?user=john")
+    #     URI::RFC2396_PARSER.parse("ldap://ldap.example.com/dc=example?user=john")
     #     #=> #<URI::LDAP ldap://ldap.example.com/dc=example?user=john>
     #
     def parse: (String uri) -> URI::Generic

data/stdlib/zlib/0/zstream.rbs

@@ -153,6 +153,7 @@ module Zlib
     #   rdoc-file=ext/zlib/zlib.c
     #   - flush_next_in -> input
     # -->
+    # Flushes input buffer and returns all data in that buffer.
     #
     def flush_next_in: () -> String
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbs
 version: !ruby/object:Gem::Version
-  version: 3.9.5
+  version: 3.10.0.pre.1
 platform: ruby
 authors:
 - Soutaro Matsumoto
@@ -33,7 +33,10 @@ extensions:
 - ext/rbs_extension/extconf.rb
 extra_rdoc_files: []
 files:
+- ".clang-format"
+- ".clangd"
 - ".github/dependabot.yml"
+- ".github/workflows/c-check.yml"
 - ".github/workflows/comments.yml"
 - ".github/workflows/dependabot.yml"
 - ".github/workflows/ruby.yml"
@@ -90,6 +93,7 @@ files:
 - core/object.rbs
 - core/object_space.rbs
 - core/object_space/weak_key_map.rbs
+- core/pathname.rbs
 - core/proc.rbs
 - core/process.rbs
 - core/ractor.rbs
@@ -131,6 +135,7 @@ files:
 - core/unbound_method.rbs
 - core/warning.rbs
 - docs/CONTRIBUTING.md
+- docs/aliases.md
 - docs/architecture.md
 - docs/collection.md
 - docs/data_and_struct.md
@@ -142,25 +147,32 @@ files:
 - docs/syntax.md
 - docs/tools.md
 - exe/rbs
+- ext/rbs_extension/ast_translation.c
+- ext/rbs_extension/ast_translation.h
+- ext/rbs_extension/class_constants.c
+- ext/rbs_extension/class_constants.h
+- ext/rbs_extension/compat.h
 - ext/rbs_extension/extconf.rb
-- ext/rbs_extension/lexer.c
-- ext/rbs_extension/lexer.h
-- ext/rbs_extension/lexer.re
-- ext/rbs_extension/lexstate.c
-- ext/rbs_extension/location.c
-- ext/rbs_extension/location.h
+- ext/rbs_extension/legacy_location.c
+- ext/rbs_extension/legacy_location.h
 - ext/rbs_extension/main.c
-- ext/rbs_extension/parser.c
-- ext/rbs_extension/parser.h
-- ext/rbs_extension/parserstate.c
-- ext/rbs_extension/parserstate.h
 - ext/rbs_extension/rbs_extension.h
-- ext/rbs_extension/unescape.c
+- ext/rbs_extension/rbs_string_bridging.c
+- ext/rbs_extension/rbs_string_bridging.h
 - goodcheck.yml
 - include/rbs.h
-- include/rbs/constants.h
-- include/rbs/ruby_objs.h
+- include/rbs/ast.h
+- include/rbs/defines.h
+- include/rbs/lexer.h
+- include/rbs/location.h
+- include/rbs/parser.h
+- include/rbs/string.h
+- include/rbs/util/rbs_allocator.h
+- include/rbs/util/rbs_assert.h
+- include/rbs/util/rbs_buffer.h
 - include/rbs/util/rbs_constant_pool.h
+- include/rbs/util/rbs_encoding.h
+- include/rbs/util/rbs_unescape.h
 - lib/rbs.rb
 - lib/rbs/ancestor_graph.rb
 - lib/rbs/annotate.rb
@@ -341,9 +353,19 @@ files:
 - sig/version.rbs
 - sig/visitor.rbs
 - sig/writer.rbs
-- src/constants.c
-- src/ruby_objs.c
+- src/ast.c
+- src/lexer.c
+- src/lexer.re
+- src/lexstate.c
+- src/location.c
+- src/parser.c
+- src/string.c
+- src/util/rbs_allocator.c
+- src/util/rbs_assert.c
+- src/util/rbs_buffer.c
 - src/util/rbs_constant_pool.c
+- src/util/rbs_encoding.c
+- src/util/rbs_unescape.c
 - stdlib/abbrev/0/abbrev.rbs
 - stdlib/abbrev/0/array.rbs
 - stdlib/base64/0/base64.rbs
@@ -351,6 +373,7 @@ files:
 - stdlib/bigdecimal-math/0/big_math.rbs
 - stdlib/bigdecimal-math/0/manifest.yaml
 - stdlib/bigdecimal/0/big_decimal.rbs
+- stdlib/cgi-escape/0/escape.rbs
 - stdlib/cgi/0/core.rbs
 - stdlib/cgi/0/manifest.yaml
 - stdlib/coverage/0/coverage.rbs
@@ -435,7 +458,6 @@ files:
 - stdlib/openssl/0/manifest.yaml
 - stdlib/openssl/0/openssl.rbs
 - stdlib/optparse/0/optparse.rbs
-- stdlib/pathname/0/pathname.rbs
 - stdlib/pp/0/manifest.yaml
 - stdlib/pp/0/pp.rbs
 - stdlib/prettyprint/0/prettyprint.rbs
@@ -450,6 +472,7 @@ files:
 - stdlib/rdoc/0/comment.rbs
 - stdlib/rdoc/0/context.rbs
 - stdlib/rdoc/0/markup.rbs
+- stdlib/rdoc/0/options.rbs
 - stdlib/rdoc/0/parser.rbs
 - stdlib/rdoc/0/rdoc.rbs
 - stdlib/rdoc/0/ri.rbs
@@ -537,7 +560,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.0.dev
 specification_version: 4
 summary: Type signature for Ruby.
 test_files: []