rbs 3.9.5 → 3.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) hide show
  1. checksums.yaml +4 -4
  2. data/.clang-format +74 -0
  3. data/.clangd +2 -0
  4. data/.github/workflows/c-check.yml +54 -0
  5. data/.github/workflows/comments.yml +3 -3
  6. data/.github/workflows/ruby.yml +34 -19
  7. data/.github/workflows/typecheck.yml +1 -1
  8. data/.github/workflows/windows.yml +1 -1
  9. data/.gitignore +4 -0
  10. data/CHANGELOG.md +49 -0
  11. data/README.md +38 -1
  12. data/Rakefile +152 -23
  13. data/config.yml +190 -62
  14. data/core/array.rbs +100 -46
  15. data/core/complex.rbs +32 -21
  16. data/core/dir.rbs +2 -2
  17. data/core/encoding.rbs +6 -9
  18. data/core/enumerable.rbs +90 -3
  19. data/core/enumerator.rbs +18 -1
  20. data/core/errno.rbs +8 -0
  21. data/core/errors.rbs +28 -1
  22. data/core/exception.rbs +2 -2
  23. data/core/fiber.rbs +5 -4
  24. data/core/file.rbs +27 -12
  25. data/core/file_test.rbs +1 -1
  26. data/core/float.rbs +209 -22
  27. data/core/gc.rbs +417 -281
  28. data/core/hash.rbs +1024 -727
  29. data/core/integer.rbs +78 -38
  30. data/core/io/buffer.rbs +18 -7
  31. data/core/io/wait.rbs +11 -33
  32. data/core/io.rbs +14 -12
  33. data/core/kernel.rbs +57 -51
  34. data/core/marshal.rbs +1 -1
  35. data/core/match_data.rbs +1 -1
  36. data/core/math.rbs +42 -3
  37. data/core/method.rbs +14 -6
  38. data/core/module.rbs +88 -17
  39. data/core/nil_class.rbs +3 -3
  40. data/core/numeric.rbs +16 -16
  41. data/core/object.rbs +3 -3
  42. data/core/object_space.rbs +21 -15
  43. data/{stdlib/pathname/0 → core}/pathname.rbs +255 -355
  44. data/core/proc.rbs +15 -8
  45. data/core/process.rbs +2 -2
  46. data/core/ractor.rbs +278 -437
  47. data/core/range.rbs +7 -8
  48. data/core/rational.rbs +37 -24
  49. data/core/rbs/unnamed/argf.rbs +2 -2
  50. data/core/rbs/unnamed/env_class.rbs +1 -1
  51. data/core/rbs/unnamed/random.rbs +4 -2
  52. data/core/regexp.rbs +25 -20
  53. data/core/ruby.rbs +53 -0
  54. data/core/ruby_vm.rbs +6 -4
  55. data/core/rubygems/errors.rbs +3 -70
  56. data/core/rubygems/rubygems.rbs +11 -79
  57. data/core/rubygems/version.rbs +2 -3
  58. data/core/set.rbs +488 -359
  59. data/core/string.rbs +3145 -1231
  60. data/core/struct.rbs +1 -1
  61. data/core/symbol.rbs +4 -4
  62. data/core/thread.rbs +92 -29
  63. data/core/time.rbs +35 -9
  64. data/core/trace_point.rbs +7 -4
  65. data/core/unbound_method.rbs +14 -6
  66. data/docs/aliases.md +79 -0
  67. data/docs/collection.md +2 -2
  68. data/docs/encoding.md +56 -0
  69. data/docs/gem.md +0 -1
  70. data/docs/sigs.md +3 -3
  71. data/ext/rbs_extension/ast_translation.c +1016 -0
  72. data/ext/rbs_extension/ast_translation.h +37 -0
  73. data/ext/rbs_extension/class_constants.c +155 -0
  74. data/{include/rbs/constants.h → ext/rbs_extension/class_constants.h} +7 -1
  75. data/ext/rbs_extension/compat.h +10 -0
  76. data/ext/rbs_extension/extconf.rb +25 -1
  77. data/ext/rbs_extension/legacy_location.c +317 -0
  78. data/ext/rbs_extension/legacy_location.h +45 -0
  79. data/ext/rbs_extension/main.c +357 -14
  80. data/ext/rbs_extension/rbs_extension.h +6 -21
  81. data/ext/rbs_extension/rbs_string_bridging.c +9 -0
  82. data/ext/rbs_extension/rbs_string_bridging.h +24 -0
  83. data/include/rbs/ast.h +687 -0
  84. data/include/rbs/defines.h +86 -0
  85. data/include/rbs/lexer.h +199 -0
  86. data/include/rbs/location.h +59 -0
  87. data/include/rbs/parser.h +135 -0
  88. data/include/rbs/string.h +47 -0
  89. data/include/rbs/util/rbs_allocator.h +59 -0
  90. data/include/rbs/util/rbs_assert.h +20 -0
  91. data/include/rbs/util/rbs_buffer.h +83 -0
  92. data/include/rbs/util/rbs_constant_pool.h +6 -67
  93. data/include/rbs/util/rbs_encoding.h +282 -0
  94. data/include/rbs/util/rbs_unescape.h +24 -0
  95. data/include/rbs.h +1 -2
  96. data/lib/rbs/annotate/formatter.rb +3 -13
  97. data/lib/rbs/annotate/rdoc_annotator.rb +3 -1
  98. data/lib/rbs/annotate/rdoc_source.rb +1 -1
  99. data/lib/rbs/cli/validate.rb +2 -2
  100. data/lib/rbs/cli.rb +1 -1
  101. data/lib/rbs/collection/config/lockfile_generator.rb +1 -0
  102. data/lib/rbs/definition_builder/ancestor_builder.rb +5 -5
  103. data/lib/rbs/environment.rb +64 -59
  104. data/lib/rbs/environment_loader.rb +1 -1
  105. data/lib/rbs/errors.rb +1 -1
  106. data/lib/rbs/parser_aux.rb +5 -0
  107. data/lib/rbs/resolver/constant_resolver.rb +2 -2
  108. data/lib/rbs/resolver/type_name_resolver.rb +124 -38
  109. data/lib/rbs/test/type_check.rb +14 -0
  110. data/lib/rbs/types.rb +3 -1
  111. data/lib/rbs/version.rb +1 -1
  112. data/lib/rbs.rb +1 -1
  113. data/lib/rdoc/discover.rb +1 -1
  114. data/lib/rdoc_plugin/parser.rb +3 -3
  115. data/sig/annotate/formatter.rbs +2 -2
  116. data/sig/annotate/rdoc_annotater.rbs +1 -1
  117. data/sig/environment.rbs +57 -6
  118. data/sig/manifest.yaml +0 -1
  119. data/sig/parser.rbs +20 -0
  120. data/sig/resolver/type_name_resolver.rbs +38 -7
  121. data/sig/types.rbs +4 -1
  122. data/src/ast.c +1256 -0
  123. data/src/lexer.c +2956 -0
  124. data/src/lexer.re +147 -0
  125. data/src/lexstate.c +205 -0
  126. data/src/location.c +71 -0
  127. data/src/parser.c +3507 -0
  128. data/src/string.c +41 -0
  129. data/src/util/rbs_allocator.c +152 -0
  130. data/src/util/rbs_assert.c +19 -0
  131. data/src/util/rbs_buffer.c +54 -0
  132. data/src/util/rbs_constant_pool.c +18 -88
  133. data/src/util/rbs_encoding.c +21308 -0
  134. data/src/util/rbs_unescape.c +167 -0
  135. data/stdlib/bigdecimal/0/big_decimal.rbs +100 -82
  136. data/stdlib/bigdecimal-math/0/big_math.rbs +169 -8
  137. data/stdlib/cgi/0/core.rbs +2 -396
  138. data/stdlib/cgi/0/manifest.yaml +1 -0
  139. data/stdlib/cgi-escape/0/escape.rbs +153 -0
  140. data/stdlib/coverage/0/coverage.rbs +3 -1
  141. data/stdlib/date/0/date.rbs +67 -59
  142. data/stdlib/date/0/date_time.rbs +1 -1
  143. data/stdlib/delegate/0/delegator.rbs +10 -7
  144. data/stdlib/erb/0/erb.rbs +737 -347
  145. data/stdlib/fileutils/0/fileutils.rbs +18 -13
  146. data/stdlib/forwardable/0/forwardable.rbs +3 -0
  147. data/stdlib/json/0/json.rbs +68 -48
  148. data/stdlib/net-http/0/net-http.rbs +3 -0
  149. data/stdlib/objspace/0/objspace.rbs +9 -4
  150. data/stdlib/open-uri/0/open-uri.rbs +40 -0
  151. data/stdlib/openssl/0/openssl.rbs +331 -228
  152. data/stdlib/optparse/0/optparse.rbs +3 -3
  153. data/stdlib/psych/0/psych.rbs +3 -3
  154. data/stdlib/rdoc/0/code_object.rbs +2 -2
  155. data/stdlib/rdoc/0/comment.rbs +2 -0
  156. data/stdlib/rdoc/0/options.rbs +76 -0
  157. data/stdlib/rdoc/0/rdoc.rbs +7 -5
  158. data/stdlib/rdoc/0/store.rbs +1 -1
  159. data/stdlib/resolv/0/resolv.rbs +25 -68
  160. data/stdlib/ripper/0/ripper.rbs +5 -2
  161. data/stdlib/singleton/0/singleton.rbs +3 -0
  162. data/stdlib/socket/0/socket.rbs +13 -1
  163. data/stdlib/socket/0/tcp_socket.rbs +10 -2
  164. data/stdlib/stringio/0/stringio.rbs +1176 -85
  165. data/stdlib/strscan/0/string_scanner.rbs +31 -31
  166. data/stdlib/tempfile/0/tempfile.rbs +3 -3
  167. data/stdlib/time/0/time.rbs +1 -1
  168. data/stdlib/timeout/0/timeout.rbs +63 -7
  169. data/stdlib/tsort/0/cyclic.rbs +3 -0
  170. data/stdlib/uri/0/common.rbs +11 -2
  171. data/stdlib/uri/0/file.rbs +1 -1
  172. data/stdlib/uri/0/generic.rbs +17 -16
  173. data/stdlib/uri/0/rfc2396_parser.rbs +6 -7
  174. data/stdlib/zlib/0/zstream.rbs +1 -0
  175. metadata +43 -18
  176. data/ext/rbs_extension/lexer.c +0 -2728
  177. data/ext/rbs_extension/lexer.h +0 -179
  178. data/ext/rbs_extension/lexer.re +0 -147
  179. data/ext/rbs_extension/lexstate.c +0 -175
  180. data/ext/rbs_extension/location.c +0 -325
  181. data/ext/rbs_extension/location.h +0 -85
  182. data/ext/rbs_extension/parser.c +0 -2982
  183. data/ext/rbs_extension/parser.h +0 -18
  184. data/ext/rbs_extension/parserstate.c +0 -411
  185. data/ext/rbs_extension/parserstate.h +0 -163
  186. data/ext/rbs_extension/unescape.c +0 -32
  187. data/include/rbs/ruby_objs.h +0 -72
  188. data/src/constants.c +0 -153
  189. data/src/ruby_objs.c +0 -799
@@ -28,7 +28,7 @@
28
28
  # * `match_values_cleared?(scanner)`:
29
29
  # Returns whether the scanner's [match
30
30
  # values](rdoc-ref:StringScanner@Match+Values) are cleared.
31
- # See examples [[here]](ext/strscan/helper_methods_md.html).
31
+ # See examples at [helper methods](helper_methods.md).
32
32
  # ## The `StringScanner` Object
33
33
  # This code creates a `StringScanner` object
34
34
  # (we'll call it simply a *scanner*),
@@ -85,10 +85,10 @@
85
85
  # and a zero-based *character position*.
86
86
  # Each of these methods explicitly sets positions:
87
87
  # Method | Effect
88
- # ------------------------|--------------------------------------------------------
89
- # #reset |Sets both positions to zero (begining of stored string).
88
+ # ------------------------|---------------------------------------------------------
89
+ # #reset |Sets both positions to zero (beginning of stored string).
90
90
  # #terminate | Sets both positions to the end of the stored string.
91
- # #pos=(new_byte_position)| Sets byte position; adjusts character position.
91
+ # #pos=(new_byte_position)| Sets byte position; adjusts character position.
92
92
  # ### Byte Position (Position)
93
93
  # The byte position (or simply *position*)
94
94
  # is a zero-based index into the bytes in the scanner's stored string;
@@ -159,7 +159,7 @@
159
159
  # # rest_size: 12
160
160
  #
161
161
  # ## Target Substring
162
- # The target substring is the the part of the [stored
162
+ # The target substring is the part of the [stored
163
163
  # string](rdoc-ref:StringScanner@Stored+String)
164
164
  # that extends from the current [byte
165
165
  # position](rdoc-ref:StringScanner@Byte+Position+-28Position-29) to the end of
@@ -211,12 +211,12 @@
211
211
  # This table summarizes (details and examples at the links):
212
212
  # Method | Returns |Sets Match Values?
213
213
  # ---------------------|---------------------------------------------|------------------
214
- # #check(pattern) | Matched leading substring or +nil+. | Yes.
215
- # #check_until(pattern)| Matched substring (anywhere) or +nil+. | Yes.
214
+ # #check(pattern) | Matched leading substring or `nil`. | Yes.
215
+ # #check_until(pattern)| Matched substring (anywhere) or `nil`. | Yes.
216
216
  # #exist?(pattern) | Matched substring (anywhere) end index. | Yes.
217
- # #match?(pattern) | Size of matched leading substring or +nil+. | Yes.
217
+ # #match?(pattern) | Size of matched leading substring or `nil`. | Yes.
218
218
  # #peek(size) | Leading substring of given length (bytes). | No.
219
- # #peek_byte | Integer leading byte or +nil+. | No.
219
+ # #peek_byte | Integer leading byte or `nil`. | No.
220
220
  # #rest |Target substring (from byte position to end).| No.
221
221
  # ### Traversing the Target Substring
222
222
  # A *traversal* method examines the target substring,
@@ -226,24 +226,24 @@
226
226
  # This table summarizes (details and examples at links):
227
227
  # Method | Returns |Sets Match Values?
228
228
  # --------------------|----------------------------------------------------|------------------
229
- # #get_byte | Leading byte or +nil+. | No.
230
- # #getch | Leading character or +nil+. | No.
231
- # #scan(pattern) | Matched leading substring or +nil+. | Yes.
232
- # #scan_byte | Integer leading byte or +nil+. | No.
233
- # #scan_until(pattern)| Matched substring (anywhere) or +nil+. | Yes.
234
- # #skip(pattern) | Matched leading substring size or +nil+. | Yes.
235
- # #skip_until(pattern)|Position delta to end-of-matched-substring or +nil+.| Yes.
236
- # #unscan | +self+. | No.
229
+ # #get_byte | Leading byte or `nil`. | No.
230
+ # #getch | Leading character or `nil`. | No.
231
+ # #scan(pattern) | Matched leading substring or `nil`. | Yes.
232
+ # #scan_byte | Integer leading byte or `nil`. | No.
233
+ # #scan_until(pattern)| Matched substring (anywhere) or `nil`. | Yes.
234
+ # #skip(pattern) | Matched leading substring size or `nil`. | Yes.
235
+ # #skip_until(pattern)|Position delta to end-of-matched-substring or `nil`.| Yes.
236
+ # #unscan | `self`. | No.
237
237
  # ## Querying the Scanner
238
238
  # Each of these methods queries the scanner object
239
239
  # without modifying it (details and examples at links)
240
240
  # Method | Returns
241
241
  # -------------------|--------------------------------
242
- # #beginning_of_line?| +true+ or +false+.
242
+ # #beginning_of_line?| `true` or `false`.
243
243
  # #charpos | Character position.
244
- # #eos? | +true+ or +false+.
245
- # #fixed_anchor? | +true+ or +false+.
246
- # #inspect |String representation of +self+.
244
+ # #eos? | `true` or `false`.
245
+ # #fixed_anchor? | `true` or `false`.
246
+ # #inspect |String representation of `self`.
247
247
  # #pos | Byte position.
248
248
  # #rest | Target substring.
249
249
  # #rest_size | Size of target substring.
@@ -312,11 +312,11 @@
312
312
  # Each of these methods returns a basic match value:
313
313
  # Method | Return After Match |Return After No Match
314
314
  # -------------|--------------------------------------|---------------------
315
- # #matched? | +true+. | +false+.
316
- # #matched_size| Size of matched substring. | +nil+.
317
- # #matched | Matched substring. | +nil+.
318
- # #pre_match |Substring preceding matched substring.| +nil+.
319
- # #post_match |Substring following matched substring.| +nil+.
315
+ # #matched? | `true`. | `false`.
316
+ # #matched_size| Size of matched substring. | `nil`.
317
+ # #matched | Matched substring. | `nil`.
318
+ # #pre_match |Substring preceding matched substring.| `nil`.
319
+ # #post_match |Substring following matched substring.| `nil`.
320
320
  #
321
321
  # See examples below.
322
322
  # #### Captured Match Values
@@ -326,11 +326,11 @@
326
326
  # Each of these methods returns a captured match value:
327
327
  # Method | Return After Match |Return After No Match
328
328
  # ---------------|---------------------------------------|---------------------
329
- # #size | Count of captured substrings. | +nil+.
330
- # #[](n) | <tt>n</tt>th captured substring. | +nil+.
331
- # #captures | Array of all captured substrings. | +nil+.
332
- # #values_at(*n) |Array of specified captured substrings.| +nil+.
333
- # #named_captures| Hash of named captures. | <tt>{}</tt>.
329
+ # #size | Count of captured substrings. | `nil`.
330
+ # #[](n) | `n`th captured substring. | `nil`.
331
+ # #captures | Array of all captured substrings. | `nil`.
332
+ # #values_at(*n) |Array of specified captured substrings.| `nil`.
333
+ # #named_captures| Hash of named captures. | `{}`.
334
334
  #
335
335
  # See examples below.
336
336
  # #### Match Values Examples
@@ -19,7 +19,7 @@
19
19
  # require 'tempfile'
20
20
  #
21
21
  # # Tempfile.create with a block
22
- # # The filename are choosen automatically.
22
+ # # The filename are chosen automatically.
23
23
  # # (You can specify the prefix and suffix of the filename by an optional argument.)
24
24
  # Tempfile.create {|f|
25
25
  # f.puts "foo"
@@ -248,8 +248,8 @@ class Tempfile < File
248
248
  #
249
249
  # Implementation note:
250
250
  #
251
- # The keyword argument +anonymous=true+ is implemented using FILE_SHARE_DELETE
252
- # on Windows. O_TMPFILE is used on Linux.
251
+ # The keyword argument `anonymous=true` is implemented using `FILE_SHARE_DELETE`
252
+ # on Windows. `O_TMPFILE` is used on Linux.
253
253
  #
254
254
  # Related: Tempfile.new.
255
255
  #
@@ -10,7 +10,7 @@ class Time
10
10
 
11
11
  # <!--
12
12
  # rdoc-file=lib/time.rb
13
- # - zone_offset(zone, year=self.now.year)
13
+ # - zone_offset(zone, year=nil)
14
14
  # -->
15
15
  # Return the number of seconds the specified time zone differs from UTC.
16
16
  #
@@ -26,7 +26,7 @@ module Timeout
26
26
  # rdoc-file=lib/timeout.rb
27
27
  # - timeout(sec, klass = nil, message = nil) { |sec| ... }
28
28
  # -->
29
- # Perform an operation in a block, raising an error if it takes longer than
29
+ # Perform an operation in a block, raising an exception if it takes longer than
30
30
  # `sec` seconds to complete.
31
31
  #
32
32
  # `sec`
@@ -45,12 +45,20 @@ module Timeout
45
45
  #
46
46
  #
47
47
  # Returns the result of the block **if** the block completed before `sec`
48
- # seconds, otherwise throws an exception, based on the value of `klass`.
48
+ # seconds, otherwise raises an exception, based on the value of `klass`.
49
49
  #
50
- # The exception thrown to terminate the given block cannot be rescued inside the
51
- # block unless `klass` is given explicitly. However, the block can use ensure to
52
- # prevent the handling of the exception. For that reason, this method cannot be
53
- # relied on to enforce timeouts for untrusted blocks.
50
+ # The exception raised to terminate the given block is the given `klass`, or
51
+ # Timeout::ExitException if `klass` is not given. The reason for that behavior
52
+ # is that Timeout::Error inherits from RuntimeError and might be caught
53
+ # unexpectedly by `rescue`. Timeout::ExitException inherits from Exception so it
54
+ # will only be rescued by `rescue Exception`. Note that the
55
+ # Timeout::ExitException is translated to a Timeout::Error once it reaches the
56
+ # Timeout.timeout call, so outside that call it will be a Timeout::Error.
57
+ #
58
+ # In general, be aware that the code block may rescue the exception, and in such
59
+ # a case not respect the timeout. Also, the block can use `ensure` to prevent
60
+ # the handling of the exception. For those reasons, this method cannot be relied
61
+ # on to enforce timeouts for untrusted blocks.
54
62
  #
55
63
  # If a scheduler is defined, it will be used to handle the timeout by invoking
56
64
  # Scheduler#timeout_after.
@@ -59,11 +67,59 @@ module Timeout
59
67
  # Timeout` into your classes so they have a #timeout method, as well as a module
60
68
  # method, so you can call it directly as Timeout.timeout().
61
69
  #
70
+ # #### Ensuring the exception does not fire inside ensure blocks
71
+ #
72
+ # When using Timeout.timeout it can be desirable to ensure the timeout exception
73
+ # does not fire inside an `ensure` block. The simplest and best way to do so it
74
+ # to put the Timeout.timeout call inside the body of the begin/ensure/end:
75
+ #
76
+ # begin
77
+ # Timeout.timeout(sec) { some_long_operation }
78
+ # ensure
79
+ # cleanup # safe, cannot be interrupt by timeout
80
+ # end
81
+ #
82
+ # If that is not feasible, e.g. if there are `ensure` blocks inside
83
+ # `some_long_operation`, they need to not be interrupted by timeout, and it's
84
+ # not possible to move these ensure blocks outside, one can use
85
+ # Thread.handle_interrupt to delay the timeout exception like so:
86
+ #
87
+ # Thread.handle_interrupt(Timeout::Error => :never) {
88
+ # Timeout.timeout(sec, Timeout::Error) do
89
+ # setup # timeout cannot happen here, no matter how long it takes
90
+ # Thread.handle_interrupt(Timeout::Error => :immediate) {
91
+ # some_long_operation # timeout can happen here
92
+ # }
93
+ # ensure
94
+ # cleanup # timeout cannot happen here, no matter how long it takes
95
+ # end
96
+ # }
97
+ #
98
+ # An important thing to note is the need to pass an exception klass to
99
+ # Timeout.timeout, otherwise it does not work. Specifically, using
100
+ # +Thread.handle_interrupt(Timeout::ExitException => ...)+ is unsupported and
101
+ # causes subtle errors like raising the wrong exception outside the block, do
102
+ # not use that.
103
+ #
104
+ # Note that Thread.handle_interrupt is somewhat dangerous because if setup or
105
+ # cleanup hangs then the current thread will hang too and the timeout will never
106
+ # fire. Also note the block might run for longer than `sec` seconds: e.g.
107
+ # some_long_operation executes for `sec` seconds + whatever time cleanup takes.
108
+ #
109
+ # If you want the timeout to only happen on blocking operations one can use
110
+ # :on_blocking instead of :immediate. However, that means if the block uses no
111
+ # blocking operations after `sec` seconds, the block will not be interrupted.
112
+ # ----
113
+ # <!--
114
+ # rdoc-file=lib/timeout.rb
115
+ # - timeout(*args, &block)
116
+ # -->
117
+ #
62
118
  def self?.timeout: [T] (Numeric? sec, ?singleton(Exception) klass, ?String message) { (Numeric sec) -> T } -> T
63
119
  end
64
120
 
65
121
  # <!-- rdoc-file=lib/timeout.rb -->
66
- # Internal error raised to when a timeout is triggered.
122
+ # Internal exception raised to when a timeout is triggered.
67
123
  #
68
124
  class Timeout::ExitException < Exception
69
125
  end
@@ -1,5 +1,8 @@
1
1
  %a{annotate:rdoc:skip}
2
2
  module TSort[Node]
3
+ # <!-- rdoc-file=lib/tsort.rb -->
4
+ # Exception class to be raised when a cycle is found.
5
+ #
3
6
  class Cyclic < StandardError
4
7
  end
5
8
  end
@@ -420,8 +420,8 @@ module URI
420
420
  # URI.parse('http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top')
421
421
  # # => #<URI::HTTP http://john.doe@www.example.com:123/forum/questions/?tag=networking&order=newest#top>
422
422
  #
423
- # It's recommended to first ::escape string `uri` if it may contain invalid URI
424
- # characters.
423
+ # It's recommended to first URI::RFC2396_PARSER.escape string `uri` if it may
424
+ # contain invalid URI characters.
425
425
  #
426
426
  def self.parse: (_ToStr uri) -> (File | FTP | HTTP | HTTPS | LDAP | LDAPS | MailTo | WS | WSS | Generic)
427
427
 
@@ -535,6 +535,9 @@ URI::ABS_URI: Regexp
535
535
 
536
536
  URI::ABS_URI_REF: Regexp
537
537
 
538
+ # <!-- rdoc-file=lib/uri/common.rb -->
539
+ # The default parser instance.
540
+ #
538
541
  URI::DEFAULT_PARSER: URI::RFC2396_Parser
539
542
 
540
543
  URI::ESCAPED: Regexp
@@ -557,6 +560,9 @@ URI::REL_URI: Regexp
557
560
 
558
561
  URI::REL_URI_REF: Regexp
559
562
 
563
+ # <!-- rdoc-file=lib/uri/common.rb -->
564
+ # The default parser instance for RFC 3986.
565
+ #
560
566
  URI::RFC3986_PARSER: URI::RFC3986_Parser
561
567
 
562
568
  URI::SCHEME: Regexp
@@ -588,6 +594,7 @@ module Kernel
588
594
  # Returns a URI object derived from the given `uri`, which may be a URI string
589
595
  # or an existing URI object:
590
596
  #
597
+ # require 'uri'
591
598
  # # Returns a new URI.
592
599
  # uri = URI('http://github.com/ruby/ruby')
593
600
  # # => #<URI::HTTP http://github.com/ruby/ruby>
@@ -595,5 +602,7 @@ module Kernel
595
602
  # URI(uri)
596
603
  # # => #<URI::HTTP http://github.com/ruby/ruby>
597
604
  #
605
+ # You must require 'uri' to use this method.
606
+ #
598
607
  def self?.URI: (URI::Generic | String uri) -> URI::Generic
599
608
  end
@@ -43,7 +43,7 @@ module URI
43
43
  # :path => '/ruby/src'})
44
44
  # uri2.to_s # => "file://host.example.com/ruby/src"
45
45
  #
46
- # uri3 = URI::File.build({:path => URI::escape('/path/my file.txt')})
46
+ # uri3 = URI::File.build({:path => URI::RFC2396_PARSER.escape('/path/my file.txt')})
47
47
  # uri3.to_s # => "file:///path/my%20file.txt"
48
48
  #
49
49
  def self.build: (Array[String] args) -> URI::File
@@ -145,7 +145,7 @@ module URI
145
145
  #
146
146
  # At first, tries to create a new URI::Generic instance using
147
147
  # URI::Generic::build. But, if exception URI::InvalidComponentError is raised,
148
- # then it does URI::Escape.escape all URI components and tries again.
148
+ # then it does URI::RFC2396_PARSER.escape all URI components and tries again.
149
149
  #
150
150
  def self.build2: (Array[nil | String | Integer]) -> URI::Generic
151
151
  | ({ 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
293
293
  # -->
294
294
  # Returns the parser to be used.
295
295
  #
296
- # Unless a URI::Parser is defined, DEFAULT_PARSER is used.
296
+ # Unless the `parser` is defined, DEFAULT_PARSER is used.
297
297
  #
298
298
  def parser: () -> untyped
299
299
 
@@ -317,7 +317,7 @@ module URI
317
317
  # rdoc-file=lib/uri/generic.rb
318
318
  # - check_scheme(v)
319
319
  # -->
320
- # Checks the scheme `v` component against the URI::Parser Regexp for :SCHEME.
320
+ # Checks the scheme `v` component against the `parser` Regexp for :SCHEME.
321
321
  #
322
322
  def check_scheme: (String? v) -> true
323
323
 
@@ -374,8 +374,8 @@ module URI
374
374
  # rdoc-file=lib/uri/generic.rb
375
375
  # - check_user(v)
376
376
  # -->
377
- # Checks the user `v` component for RFC2396 compliance and against the
378
- # URI::Parser Regexp for :USERINFO.
377
+ # Checks the user `v` component for RFC2396 compliance and against the `parser`
378
+ # Regexp for :USERINFO.
379
379
  #
380
380
  # Can not have a registry or opaque component defined, with a user component
381
381
  # defined.
@@ -387,7 +387,7 @@ module URI
387
387
  # - check_password(v, user = @user)
388
388
  # -->
389
389
  # Checks the password `v` component for RFC2396 compliance and against the
390
- # URI::Parser Regexp for :USERINFO.
390
+ # `parser` Regexp for :USERINFO.
391
391
  #
392
392
  # Can not have a registry or opaque component defined, with a user component
393
393
  # defined.
@@ -424,7 +424,7 @@ module URI
424
424
  #
425
425
  # uri = URI.parse("http://john:S3nsit1ve@my.example.com")
426
426
  # uri.user = "sam"
427
- # uri.to_s #=> "http://sam:V3ry_S3nsit1ve@my.example.com"
427
+ # uri.to_s #=> "http://sam@my.example.com"
428
428
  #
429
429
  def user=: (String? user) -> String?
430
430
 
@@ -530,8 +530,8 @@ module URI
530
530
  # rdoc-file=lib/uri/generic.rb
531
531
  # - check_host(v)
532
532
  # -->
533
- # Checks the host `v` component for RFC2396 compliance and against the
534
- # URI::Parser Regexp for :HOST.
533
+ # Checks the host `v` component for RFC2396 compliance and against the `parser`
534
+ # Regexp for :HOST.
535
535
  #
536
536
  # Can not have a registry or opaque component defined, with a host component
537
537
  # defined.
@@ -611,8 +611,8 @@ module URI
611
611
  # rdoc-file=lib/uri/generic.rb
612
612
  # - check_port(v)
613
613
  # -->
614
- # Checks the port `v` component for RFC2396 compliance and against the
615
- # URI::Parser Regexp for :PORT.
614
+ # Checks the port `v` component for RFC2396 compliance and against the `parser`
615
+ # Regexp for :PORT.
616
616
  #
617
617
  # Can not have a registry or opaque component defined, with a port component
618
618
  # defined.
@@ -670,8 +670,8 @@ module URI
670
670
  # rdoc-file=lib/uri/generic.rb
671
671
  # - check_path(v)
672
672
  # -->
673
- # Checks the path `v` component for RFC2396 compliance and against the
674
- # URI::Parser Regexp for :ABS_PATH and :REL_PATH.
673
+ # Checks the path `v` component for RFC2396 compliance and against the `parser`
674
+ # Regexp for :ABS_PATH and :REL_PATH.
675
675
  #
676
676
  # Can not have a opaque component defined, with a path component defined.
677
677
  #
@@ -742,7 +742,7 @@ module URI
742
742
  # - check_opaque(v)
743
743
  # -->
744
744
  # Checks the opaque `v` component for RFC2396 compliance and against the
745
- # URI::Parser Regexp for :OPAQUE.
745
+ # `parser` Regexp for :OPAQUE.
746
746
  #
747
747
  # Can not have a host, port, user, or path component defined, with an opaque
748
748
  # component defined.
@@ -781,8 +781,7 @@ module URI
781
781
  # rdoc-file=lib/uri/generic.rb
782
782
  # - fragment=(v)
783
783
  # -->
784
- # Checks the fragment `v` component against the URI::Parser Regexp for
785
- # :FRAGMENT.
784
+ # Checks the fragment `v` component against the `parser` Regexp for :FRAGMENT.
786
785
  #
787
786
  # ## Args
788
787
  #
@@ -1010,6 +1009,7 @@ module URI
1010
1009
  # rdoc-file=lib/uri/generic.rb
1011
1010
  # - hash()
1012
1011
  # -->
1012
+ # Returns the hash value.
1013
1013
  #
1014
1014
  def hash: () -> Integer
1015
1015
 
@@ -1017,6 +1017,7 @@ module URI
1017
1017
  # rdoc-file=lib/uri/generic.rb
1018
1018
  # - eql?(oth)
1019
1019
  # -->
1020
+ # Compares with *oth* for Hash.
1020
1021
  #
1021
1022
  def eql?: (URI::Generic oth) -> bool
1022
1023
 
@@ -17,14 +17,14 @@ module URI
17
17
  # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
18
18
  # The Hash of patterns.
19
19
  #
20
- # See also URI::Parser.initialize_pattern.
20
+ # See also #initialize_pattern.
21
21
  #
22
22
  attr_reader pattern: Hash[Symbol, String]
23
23
 
24
24
  # <!-- rdoc-file=lib/uri/rfc2396_parser.rb -->
25
25
  # The Hash of Regexp.
26
26
  #
27
- # See also URI::Parser.initialize_regexp.
27
+ # See also #initialize_regexp.
28
28
  #
29
29
  attr_reader regexp: Hash[Symbol, Regexp]
30
30
 
@@ -34,7 +34,7 @@ module URI
34
34
  # -->
35
35
  # ## Synopsis
36
36
  #
37
- # URI::Parser.new([opts])
37
+ # URI::RFC2396_Parser.new([opts])
38
38
  #
39
39
  # ## Args
40
40
  #
@@ -52,7 +52,7 @@ module URI
52
52
  #
53
53
  # ## Examples
54
54
  #
55
- # p = URI::Parser.new(:ESCAPED => "(?:%[a-fA-F0-9]{2}|%u[a-fA-F0-9]{4})")
55
+ # p = URI::RFC2396_Parser.new(:ESCAPED => "(?:%[a-fA-F0-9]{2}|%u[a-fA-F0-9]{4})")
56
56
  # u = p.parse("http://example.jp/%uABCD") #=> #<URI::HTTP http://example.jp/%uABCD>
57
57
  # URI.parse(u.to_s) #=> raises URI::InvalidURIError
58
58
  #
@@ -105,7 +105,7 @@ module URI
105
105
  # Attempts to parse and merge a set of URIs. If no `block` given, then returns
106
106
  # the result, else it calls `block` for each element in result.
107
107
  #
108
- # See also URI::Parser.make_regexp.
108
+ # See also #make_regexp.
109
109
  #
110
110
  def extract: (String str, ?Array[String] schemes) -> Array[String]
111
111
  | (String str, ?Array[String] schemes) { (String) -> untyped } -> nil
@@ -152,8 +152,7 @@ module URI
152
152
  #
153
153
  # ## Usage
154
154
  #
155
- # p = URI::Parser.new
156
- # p.parse("ldap://ldap.example.com/dc=example?user=john")
155
+ # URI::RFC2396_PARSER.parse("ldap://ldap.example.com/dc=example?user=john")
157
156
  # #=> #<URI::LDAP ldap://ldap.example.com/dc=example?user=john>
158
157
  #
159
158
  def parse: (String uri) -> URI::Generic
@@ -153,6 +153,7 @@ module Zlib
153
153
  # rdoc-file=ext/zlib/zlib.c
154
154
  # - flush_next_in -> input
155
155
  # -->
156
+ # Flushes input buffer and returns all data in that buffer.
156
157
  #
157
158
  def flush_next_in: () -> String
158
159
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rbs
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.9.5
4
+ version: 3.10.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Soutaro Matsumoto
@@ -33,7 +33,10 @@ extensions:
33
33
  - ext/rbs_extension/extconf.rb
34
34
  extra_rdoc_files: []
35
35
  files:
36
+ - ".clang-format"
37
+ - ".clangd"
36
38
  - ".github/dependabot.yml"
39
+ - ".github/workflows/c-check.yml"
37
40
  - ".github/workflows/comments.yml"
38
41
  - ".github/workflows/dependabot.yml"
39
42
  - ".github/workflows/ruby.yml"
@@ -90,6 +93,7 @@ files:
90
93
  - core/object.rbs
91
94
  - core/object_space.rbs
92
95
  - core/object_space/weak_key_map.rbs
96
+ - core/pathname.rbs
93
97
  - core/proc.rbs
94
98
  - core/process.rbs
95
99
  - core/ractor.rbs
@@ -102,6 +106,7 @@ files:
102
106
  - core/rbs/unnamed/random.rbs
103
107
  - core/refinement.rbs
104
108
  - core/regexp.rbs
109
+ - core/ruby.rbs
105
110
  - core/ruby_vm.rbs
106
111
  - core/rubygems/basic_specification.rbs
107
112
  - core/rubygems/config_file.rbs
@@ -131,9 +136,11 @@ files:
131
136
  - core/unbound_method.rbs
132
137
  - core/warning.rbs
133
138
  - docs/CONTRIBUTING.md
139
+ - docs/aliases.md
134
140
  - docs/architecture.md
135
141
  - docs/collection.md
136
142
  - docs/data_and_struct.md
143
+ - docs/encoding.md
137
144
  - docs/gem.md
138
145
  - docs/rbs_by_example.md
139
146
  - docs/repo.md
@@ -142,25 +149,32 @@ files:
142
149
  - docs/syntax.md
143
150
  - docs/tools.md
144
151
  - exe/rbs
152
+ - ext/rbs_extension/ast_translation.c
153
+ - ext/rbs_extension/ast_translation.h
154
+ - ext/rbs_extension/class_constants.c
155
+ - ext/rbs_extension/class_constants.h
156
+ - ext/rbs_extension/compat.h
145
157
  - ext/rbs_extension/extconf.rb
146
- - ext/rbs_extension/lexer.c
147
- - ext/rbs_extension/lexer.h
148
- - ext/rbs_extension/lexer.re
149
- - ext/rbs_extension/lexstate.c
150
- - ext/rbs_extension/location.c
151
- - ext/rbs_extension/location.h
158
+ - ext/rbs_extension/legacy_location.c
159
+ - ext/rbs_extension/legacy_location.h
152
160
  - ext/rbs_extension/main.c
153
- - ext/rbs_extension/parser.c
154
- - ext/rbs_extension/parser.h
155
- - ext/rbs_extension/parserstate.c
156
- - ext/rbs_extension/parserstate.h
157
161
  - ext/rbs_extension/rbs_extension.h
158
- - ext/rbs_extension/unescape.c
162
+ - ext/rbs_extension/rbs_string_bridging.c
163
+ - ext/rbs_extension/rbs_string_bridging.h
159
164
  - goodcheck.yml
160
165
  - include/rbs.h
161
- - include/rbs/constants.h
162
- - include/rbs/ruby_objs.h
166
+ - include/rbs/ast.h
167
+ - include/rbs/defines.h
168
+ - include/rbs/lexer.h
169
+ - include/rbs/location.h
170
+ - include/rbs/parser.h
171
+ - include/rbs/string.h
172
+ - include/rbs/util/rbs_allocator.h
173
+ - include/rbs/util/rbs_assert.h
174
+ - include/rbs/util/rbs_buffer.h
163
175
  - include/rbs/util/rbs_constant_pool.h
176
+ - include/rbs/util/rbs_encoding.h
177
+ - include/rbs/util/rbs_unescape.h
164
178
  - lib/rbs.rb
165
179
  - lib/rbs/ancestor_graph.rb
166
180
  - lib/rbs/annotate.rb
@@ -341,9 +355,19 @@ files:
341
355
  - sig/version.rbs
342
356
  - sig/visitor.rbs
343
357
  - sig/writer.rbs
344
- - src/constants.c
345
- - src/ruby_objs.c
358
+ - src/ast.c
359
+ - src/lexer.c
360
+ - src/lexer.re
361
+ - src/lexstate.c
362
+ - src/location.c
363
+ - src/parser.c
364
+ - src/string.c
365
+ - src/util/rbs_allocator.c
366
+ - src/util/rbs_assert.c
367
+ - src/util/rbs_buffer.c
346
368
  - src/util/rbs_constant_pool.c
369
+ - src/util/rbs_encoding.c
370
+ - src/util/rbs_unescape.c
347
371
  - stdlib/abbrev/0/abbrev.rbs
348
372
  - stdlib/abbrev/0/array.rbs
349
373
  - stdlib/base64/0/base64.rbs
@@ -351,6 +375,7 @@ files:
351
375
  - stdlib/bigdecimal-math/0/big_math.rbs
352
376
  - stdlib/bigdecimal-math/0/manifest.yaml
353
377
  - stdlib/bigdecimal/0/big_decimal.rbs
378
+ - stdlib/cgi-escape/0/escape.rbs
354
379
  - stdlib/cgi/0/core.rbs
355
380
  - stdlib/cgi/0/manifest.yaml
356
381
  - stdlib/coverage/0/coverage.rbs
@@ -435,7 +460,6 @@ files:
435
460
  - stdlib/openssl/0/manifest.yaml
436
461
  - stdlib/openssl/0/openssl.rbs
437
462
  - stdlib/optparse/0/optparse.rbs
438
- - stdlib/pathname/0/pathname.rbs
439
463
  - stdlib/pp/0/manifest.yaml
440
464
  - stdlib/pp/0/pp.rbs
441
465
  - stdlib/prettyprint/0/prettyprint.rbs
@@ -450,6 +474,7 @@ files:
450
474
  - stdlib/rdoc/0/comment.rbs
451
475
  - stdlib/rdoc/0/context.rbs
452
476
  - stdlib/rdoc/0/markup.rbs
477
+ - stdlib/rdoc/0/options.rbs
453
478
  - stdlib/rdoc/0/parser.rbs
454
479
  - stdlib/rdoc/0/rdoc.rbs
455
480
  - stdlib/rdoc/0/ri.rbs
@@ -537,7 +562,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
537
562
  - !ruby/object:Gem::Version
538
563
  version: '0'
539
564
  requirements: []
540
- rubygems_version: 3.6.9
565
+ rubygems_version: 4.0.2
541
566
  specification_version: 4
542
567
  summary: Type signature for Ruby.
543
568
  test_files: []