rbs 4.0.0.dev.4 → 4.0.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 (281) hide show
  1. checksums.yaml +4 -4
  2. data/.github/dependabot.yml +14 -14
  3. data/.github/workflows/bundle-update.yml +60 -0
  4. data/.github/workflows/c-check.yml +18 -11
  5. data/.github/workflows/comments.yml +5 -3
  6. data/.github/workflows/dependabot.yml +2 -2
  7. data/.github/workflows/ruby.yml +27 -34
  8. data/.github/workflows/rust.yml +95 -0
  9. data/.github/workflows/typecheck.yml +2 -2
  10. data/.github/workflows/windows.yml +2 -2
  11. data/.rubocop.yml +1 -1
  12. data/CHANGELOG.md +323 -0
  13. data/README.md +1 -1
  14. data/Rakefile +43 -33
  15. data/Steepfile +1 -0
  16. data/config.yml +426 -24
  17. data/core/array.rbs +307 -227
  18. data/core/basic_object.rbs +9 -8
  19. data/core/binding.rbs +0 -2
  20. data/core/builtin.rbs +2 -2
  21. data/core/class.rbs +6 -5
  22. data/core/comparable.rbs +55 -34
  23. data/core/complex.rbs +104 -78
  24. data/core/dir.rbs +61 -49
  25. data/core/encoding.rbs +12 -15
  26. data/core/enumerable.rbs +179 -87
  27. data/core/enumerator/arithmetic_sequence.rbs +70 -0
  28. data/core/enumerator.rbs +65 -2
  29. data/core/errno.rbs +11 -2
  30. data/core/errors.rbs +58 -29
  31. data/core/exception.rbs +13 -13
  32. data/core/fiber.rbs +74 -54
  33. data/core/file.rbs +280 -177
  34. data/core/file_test.rbs +3 -3
  35. data/core/float.rbs +257 -92
  36. data/core/gc.rbs +425 -281
  37. data/core/hash.rbs +1045 -739
  38. data/core/integer.rbs +135 -137
  39. data/core/io/buffer.rbs +53 -42
  40. data/core/io/wait.rbs +13 -35
  41. data/core/io.rbs +192 -144
  42. data/core/kernel.rbs +216 -155
  43. data/core/marshal.rbs +4 -4
  44. data/core/match_data.rbs +15 -13
  45. data/core/math.rbs +107 -66
  46. data/core/method.rbs +69 -33
  47. data/core/module.rbs +244 -106
  48. data/core/nil_class.rbs +7 -6
  49. data/core/numeric.rbs +74 -63
  50. data/core/object.rbs +9 -11
  51. data/core/object_space.rbs +30 -23
  52. data/core/pathname.rbs +1322 -0
  53. data/core/proc.rbs +95 -58
  54. data/core/process.rbs +222 -202
  55. data/core/ractor.rbs +371 -515
  56. data/core/random.rbs +21 -3
  57. data/core/range.rbs +159 -57
  58. data/core/rational.rbs +60 -89
  59. data/core/rbs/unnamed/argf.rbs +60 -53
  60. data/core/rbs/unnamed/env_class.rbs +19 -14
  61. data/core/rbs/unnamed/main_class.rbs +123 -0
  62. data/core/rbs/unnamed/random.rbs +11 -118
  63. data/core/regexp.rbs +258 -214
  64. data/core/ruby.rbs +53 -0
  65. data/core/ruby_vm.rbs +38 -34
  66. data/core/rubygems/config_file.rbs +5 -5
  67. data/core/rubygems/errors.rbs +4 -71
  68. data/core/rubygems/requirement.rbs +5 -5
  69. data/core/rubygems/rubygems.rbs +16 -82
  70. data/core/rubygems/version.rbs +2 -3
  71. data/core/set.rbs +490 -360
  72. data/core/signal.rbs +26 -16
  73. data/core/string.rbs +3234 -1285
  74. data/core/struct.rbs +27 -26
  75. data/core/symbol.rbs +41 -34
  76. data/core/thread.rbs +135 -67
  77. data/core/time.rbs +81 -50
  78. data/core/trace_point.rbs +41 -35
  79. data/core/true_class.rbs +2 -2
  80. data/core/unbound_method.rbs +24 -16
  81. data/core/warning.rbs +7 -7
  82. data/docs/aliases.md +79 -0
  83. data/docs/collection.md +3 -3
  84. data/docs/config.md +171 -0
  85. data/docs/encoding.md +56 -0
  86. data/docs/gem.md +0 -1
  87. data/docs/inline.md +576 -0
  88. data/docs/sigs.md +3 -3
  89. data/docs/syntax.md +46 -16
  90. data/docs/type_fingerprint.md +21 -0
  91. data/exe/rbs +1 -1
  92. data/ext/rbs_extension/ast_translation.c +544 -116
  93. data/ext/rbs_extension/ast_translation.h +3 -0
  94. data/ext/rbs_extension/class_constants.c +16 -2
  95. data/ext/rbs_extension/class_constants.h +8 -0
  96. data/ext/rbs_extension/extconf.rb +5 -1
  97. data/ext/rbs_extension/legacy_location.c +33 -56
  98. data/ext/rbs_extension/legacy_location.h +37 -0
  99. data/ext/rbs_extension/main.c +44 -35
  100. data/include/rbs/ast.h +448 -173
  101. data/include/rbs/defines.h +27 -0
  102. data/include/rbs/lexer.h +30 -11
  103. data/include/rbs/location.h +25 -44
  104. data/include/rbs/parser.h +6 -6
  105. data/include/rbs/string.h +0 -2
  106. data/include/rbs/util/rbs_allocator.h +34 -13
  107. data/include/rbs/util/rbs_assert.h +12 -1
  108. data/include/rbs/util/rbs_constant_pool.h +0 -3
  109. data/include/rbs/util/rbs_encoding.h +2 -0
  110. data/include/rbs/util/rbs_unescape.h +2 -1
  111. data/include/rbs.h +8 -0
  112. data/lib/rbs/ast/annotation.rb +1 -1
  113. data/lib/rbs/ast/comment.rb +1 -1
  114. data/lib/rbs/ast/declarations.rb +10 -10
  115. data/lib/rbs/ast/members.rb +14 -14
  116. data/lib/rbs/ast/ruby/annotations.rb +293 -3
  117. data/lib/rbs/ast/ruby/comment_block.rb +24 -0
  118. data/lib/rbs/ast/ruby/declarations.rb +198 -3
  119. data/lib/rbs/ast/ruby/helpers/constant_helper.rb +4 -0
  120. data/lib/rbs/ast/ruby/members.rb +532 -22
  121. data/lib/rbs/ast/type_param.rb +24 -4
  122. data/lib/rbs/buffer.rb +20 -15
  123. data/lib/rbs/cli/diff.rb +16 -15
  124. data/lib/rbs/cli/validate.rb +38 -106
  125. data/lib/rbs/cli.rb +52 -19
  126. data/lib/rbs/collection/config/lockfile_generator.rb +14 -2
  127. data/lib/rbs/collection/sources/git.rb +1 -0
  128. data/lib/rbs/definition.rb +1 -1
  129. data/lib/rbs/definition_builder/ancestor_builder.rb +62 -9
  130. data/lib/rbs/definition_builder/method_builder.rb +20 -0
  131. data/lib/rbs/definition_builder.rb +147 -25
  132. data/lib/rbs/diff.rb +7 -1
  133. data/lib/rbs/environment.rb +227 -74
  134. data/lib/rbs/environment_loader.rb +0 -6
  135. data/lib/rbs/errors.rb +27 -18
  136. data/lib/rbs/inline_parser.rb +342 -6
  137. data/lib/rbs/location_aux.rb +1 -1
  138. data/lib/rbs/locator.rb +5 -1
  139. data/lib/rbs/method_type.rb +5 -3
  140. data/lib/rbs/parser_aux.rb +20 -7
  141. data/lib/rbs/prototype/helpers.rb +57 -0
  142. data/lib/rbs/prototype/rb.rb +3 -28
  143. data/lib/rbs/prototype/rbi.rb +3 -20
  144. data/lib/rbs/prototype/runtime.rb +8 -0
  145. data/lib/rbs/resolver/constant_resolver.rb +2 -2
  146. data/lib/rbs/resolver/type_name_resolver.rb +116 -38
  147. data/lib/rbs/subtractor.rb +3 -1
  148. data/lib/rbs/test/type_check.rb +19 -2
  149. data/lib/rbs/type_name.rb +1 -1
  150. data/lib/rbs/types.rb +88 -78
  151. data/lib/rbs/unit_test/type_assertions.rb +35 -8
  152. data/lib/rbs/validator.rb +2 -2
  153. data/lib/rbs/version.rb +1 -1
  154. data/lib/rbs.rb +1 -2
  155. data/lib/rdoc/discover.rb +1 -1
  156. data/lib/rdoc_plugin/parser.rb +1 -1
  157. data/rbs.gemspec +4 -3
  158. data/rust/.gitignore +1 -0
  159. data/rust/Cargo.lock +378 -0
  160. data/rust/Cargo.toml +7 -0
  161. data/rust/ruby-rbs/Cargo.toml +22 -0
  162. data/rust/ruby-rbs/build.rs +764 -0
  163. data/rust/ruby-rbs/examples/locations.rs +60 -0
  164. data/rust/ruby-rbs/src/lib.rs +1 -0
  165. data/rust/ruby-rbs/src/node/mod.rs +742 -0
  166. data/rust/ruby-rbs/tests/sanity.rs +47 -0
  167. data/rust/ruby-rbs/vendor/rbs/config.yml +1 -0
  168. data/rust/ruby-rbs-sys/Cargo.toml +23 -0
  169. data/rust/ruby-rbs-sys/build.rs +204 -0
  170. data/rust/ruby-rbs-sys/src/lib.rs +50 -0
  171. data/rust/ruby-rbs-sys/vendor/rbs/include +1 -0
  172. data/rust/ruby-rbs-sys/vendor/rbs/src +1 -0
  173. data/rust/ruby-rbs-sys/wrapper.h +1 -0
  174. data/schema/typeParam.json +17 -1
  175. data/sig/ast/ruby/annotations.rbs +315 -4
  176. data/sig/ast/ruby/comment_block.rbs +8 -0
  177. data/sig/ast/ruby/declarations.rbs +102 -4
  178. data/sig/ast/ruby/members.rbs +108 -2
  179. data/sig/cli/diff.rbs +5 -11
  180. data/sig/cli/validate.rbs +12 -8
  181. data/sig/cli.rbs +18 -18
  182. data/sig/definition.rbs +6 -1
  183. data/sig/definition_builder.rbs +2 -0
  184. data/sig/environment.rbs +70 -12
  185. data/sig/errors.rbs +13 -14
  186. data/sig/inline_parser.rbs +39 -2
  187. data/sig/locator.rbs +0 -2
  188. data/sig/manifest.yaml +0 -1
  189. data/sig/method_builder.rbs +3 -1
  190. data/sig/parser.rbs +31 -13
  191. data/sig/prototype/helpers.rbs +2 -0
  192. data/sig/resolver/type_name_resolver.rbs +35 -7
  193. data/sig/source.rbs +3 -3
  194. data/sig/type_param.rbs +13 -8
  195. data/sig/types.rbs +6 -7
  196. data/sig/unit_test/spy.rbs +0 -8
  197. data/sig/unit_test/type_assertions.rbs +11 -0
  198. data/src/ast.c +410 -153
  199. data/src/lexer.c +1392 -1313
  200. data/src/lexer.re +3 -0
  201. data/src/lexstate.c +58 -37
  202. data/src/location.c +8 -48
  203. data/src/parser.c +977 -516
  204. data/src/string.c +0 -48
  205. data/src/util/rbs_allocator.c +89 -71
  206. data/src/util/rbs_assert.c +1 -1
  207. data/src/util/rbs_buffer.c +2 -2
  208. data/src/util/rbs_constant_pool.c +10 -14
  209. data/src/util/rbs_encoding.c +4 -8
  210. data/src/util/rbs_unescape.c +56 -20
  211. data/stdlib/bigdecimal/0/big_decimal.rbs +116 -98
  212. data/stdlib/bigdecimal-math/0/big_math.rbs +169 -8
  213. data/stdlib/cgi/0/core.rbs +9 -393
  214. data/stdlib/cgi/0/manifest.yaml +1 -0
  215. data/stdlib/cgi-escape/0/escape.rbs +171 -0
  216. data/stdlib/coverage/0/coverage.rbs +7 -4
  217. data/stdlib/date/0/date.rbs +92 -79
  218. data/stdlib/date/0/date_time.rbs +25 -24
  219. data/stdlib/delegate/0/delegator.rbs +10 -7
  220. data/stdlib/did_you_mean/0/did_you_mean.rbs +17 -16
  221. data/stdlib/digest/0/digest.rbs +110 -0
  222. data/stdlib/erb/0/erb.rbs +748 -347
  223. data/stdlib/etc/0/etc.rbs +55 -50
  224. data/stdlib/fileutils/0/fileutils.rbs +158 -139
  225. data/stdlib/forwardable/0/forwardable.rbs +13 -10
  226. data/stdlib/io-console/0/io-console.rbs +2 -2
  227. data/stdlib/json/0/json.rbs +217 -136
  228. data/stdlib/monitor/0/monitor.rbs +3 -3
  229. data/stdlib/net-http/0/net-http.rbs +162 -134
  230. data/stdlib/objspace/0/objspace.rbs +17 -34
  231. data/stdlib/open-uri/0/open-uri.rbs +48 -8
  232. data/stdlib/open3/0/open3.rbs +469 -10
  233. data/stdlib/openssl/0/openssl.rbs +475 -357
  234. data/stdlib/optparse/0/optparse.rbs +26 -17
  235. data/stdlib/pathname/0/pathname.rbs +11 -1381
  236. data/stdlib/pp/0/pp.rbs +9 -8
  237. data/stdlib/prettyprint/0/prettyprint.rbs +7 -7
  238. data/stdlib/pstore/0/pstore.rbs +35 -30
  239. data/stdlib/psych/0/psych.rbs +65 -12
  240. data/stdlib/psych/0/store.rbs +2 -4
  241. data/stdlib/pty/0/pty.rbs +9 -6
  242. data/stdlib/random-formatter/0/random-formatter.rbs +277 -0
  243. data/stdlib/rdoc/0/code_object.rbs +2 -1
  244. data/stdlib/rdoc/0/parser.rbs +1 -1
  245. data/stdlib/rdoc/0/rdoc.rbs +1 -1
  246. data/stdlib/rdoc/0/store.rbs +1 -1
  247. data/stdlib/resolv/0/resolv.rbs +25 -68
  248. data/stdlib/ripper/0/ripper.rbs +22 -19
  249. data/stdlib/securerandom/0/manifest.yaml +2 -0
  250. data/stdlib/securerandom/0/securerandom.rbs +7 -20
  251. data/stdlib/shellwords/0/shellwords.rbs +2 -2
  252. data/stdlib/singleton/0/singleton.rbs +3 -0
  253. data/stdlib/socket/0/addrinfo.rbs +7 -7
  254. data/stdlib/socket/0/basic_socket.rbs +3 -3
  255. data/stdlib/socket/0/ip_socket.rbs +10 -8
  256. data/stdlib/socket/0/socket.rbs +23 -10
  257. data/stdlib/socket/0/tcp_server.rbs +1 -1
  258. data/stdlib/socket/0/tcp_socket.rbs +11 -3
  259. data/stdlib/socket/0/udp_socket.rbs +1 -1
  260. data/stdlib/socket/0/unix_server.rbs +1 -1
  261. data/stdlib/stringio/0/stringio.rbs +1177 -85
  262. data/stdlib/strscan/0/string_scanner.rbs +27 -25
  263. data/stdlib/tempfile/0/tempfile.rbs +25 -21
  264. data/stdlib/time/0/time.rbs +8 -6
  265. data/stdlib/timeout/0/timeout.rbs +63 -7
  266. data/stdlib/tsort/0/cyclic.rbs +3 -0
  267. data/stdlib/tsort/0/tsort.rbs +7 -6
  268. data/stdlib/uri/0/common.rbs +42 -20
  269. data/stdlib/uri/0/file.rbs +3 -3
  270. data/stdlib/uri/0/generic.rbs +26 -18
  271. data/stdlib/uri/0/http.rbs +2 -2
  272. data/stdlib/uri/0/ldap.rbs +2 -2
  273. data/stdlib/uri/0/mailto.rbs +3 -3
  274. data/stdlib/uri/0/rfc2396_parser.rbs +12 -12
  275. data/stdlib/zlib/0/deflate.rbs +4 -3
  276. data/stdlib/zlib/0/gzip_reader.rbs +6 -6
  277. data/stdlib/zlib/0/gzip_writer.rbs +14 -12
  278. data/stdlib/zlib/0/inflate.rbs +1 -1
  279. data/stdlib/zlib/0/need_dict.rbs +1 -1
  280. data/stdlib/zlib/0/zstream.rbs +1 -0
  281. metadata +50 -6
@@ -0,0 +1,277 @@
1
+ module RBS
2
+ module Unnamed
3
+ module Random_Formatter
4
+ # <!--
5
+ # rdoc-file=lib/random/formatter.rb
6
+ # - base64(n=nil)
7
+ # -->
8
+ # Generate a random base64 string.
9
+ #
10
+ # The argument *n* specifies the length, in bytes, of the random number to be
11
+ # generated. The length of the result string is about 4/3 of *n*.
12
+ #
13
+ # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
14
+ # future.
15
+ #
16
+ # The result may contain A-Z, a-z, 0-9, "+", "/" and "=".
17
+ #
18
+ # require 'random/formatter'
19
+ #
20
+ # Random.base64 #=> "/2BuBuLf3+WfSKyQbRcc/A=="
21
+ # # or
22
+ # prng = Random.new
23
+ # prng.base64 #=> "6BbW0pxO0YENxn38HMUbcQ=="
24
+ #
25
+ # See RFC 3548 for the definition of base64.
26
+ #
27
+ %a{annotate:rdoc:copy:Random::Formatter#base64}
28
+ def base64: (?Integer? n) -> String
29
+
30
+ # <!--
31
+ # rdoc-file=lib/random/formatter.rb
32
+ # - hex(n=nil)
33
+ # -->
34
+ # Generate a random hexadecimal string.
35
+ #
36
+ # The argument *n* specifies the length, in bytes, of the random number to be
37
+ # generated. The length of the resulting hexadecimal string is twice of *n*.
38
+ #
39
+ # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
40
+ # future.
41
+ #
42
+ # The result may contain 0-9 and a-f.
43
+ #
44
+ # require 'random/formatter'
45
+ #
46
+ # Random.hex #=> "eb693ec8252cd630102fd0d0fb7c3485"
47
+ # # or
48
+ # prng = Random.new
49
+ # prng.hex #=> "91dc3bfb4de5b11d029d376634589b61"
50
+ #
51
+ %a{annotate:rdoc:copy:Random::Formatter#hex}
52
+ def hex: (?Integer? n) -> String
53
+
54
+ # <!--
55
+ # rdoc-file=lib/random/formatter.rb
56
+ # - random_bytes(n=nil)
57
+ # -->
58
+ # Generate a random binary string.
59
+ #
60
+ # The argument *n* specifies the length of the result string.
61
+ #
62
+ # If *n* is not specified or is nil, 16 is assumed. It may be larger in future.
63
+ #
64
+ # The result may contain any byte: "x00" - "xff".
65
+ #
66
+ # require 'random/formatter'
67
+ #
68
+ # Random.random_bytes #=> "\xD8\\\xE0\xF4\r\xB2\xFC*WM\xFF\x83\x18\xF45\xB6"
69
+ # # or
70
+ # prng = Random.new
71
+ # prng.random_bytes #=> "m\xDC\xFC/\a\x00Uf\xB2\xB2P\xBD\xFF6S\x97"
72
+ #
73
+ %a{annotate:rdoc:copy:Random::Formatter#random_bytes}
74
+ def random_bytes: (?Integer? n) -> String
75
+
76
+ # <!--
77
+ # rdoc-file=lib/random/formatter.rb
78
+ # - urlsafe_base64(n=nil, padding=false)
79
+ # -->
80
+ # Generate a random URL-safe base64 string.
81
+ #
82
+ # The argument *n* specifies the length, in bytes, of the random number to be
83
+ # generated. The length of the result string is about 4/3 of *n*.
84
+ #
85
+ # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
86
+ # future.
87
+ #
88
+ # The boolean argument *padding* specifies the padding. If it is false or nil,
89
+ # padding is not generated. Otherwise padding is generated. By default, padding
90
+ # is not generated because "=" may be used as a URL delimiter.
91
+ #
92
+ # The result may contain A-Z, a-z, 0-9, "-" and "_". "=" is also used if
93
+ # *padding* is true.
94
+ #
95
+ # require 'random/formatter'
96
+ #
97
+ # Random.urlsafe_base64 #=> "b4GOKm4pOYU_-BOXcrUGDg"
98
+ # # or
99
+ # prng = Random.new
100
+ # prng.urlsafe_base64 #=> "UZLdOkzop70Ddx-IJR0ABg"
101
+ #
102
+ # prng.urlsafe_base64(nil, true) #=> "i0XQ-7gglIsHGV2_BNPrdQ=="
103
+ # prng.urlsafe_base64(nil, true) #=> "-M8rLhr7JEpJlqFGUMmOxg=="
104
+ #
105
+ # See RFC 3548 for the definition of URL-safe base64.
106
+ #
107
+ %a{annotate:rdoc:copy:Random::Formatter#urlsafe_base64}
108
+ def urlsafe_base64: (?Integer? n, ?boolish padding) -> String
109
+
110
+ # <!--
111
+ # rdoc-file=lib/random/formatter.rb
112
+ # - uuid()
113
+ # -->
114
+ # Generate a random v4 UUID (Universally Unique IDentifier).
115
+ #
116
+ # require 'random/formatter'
117
+ #
118
+ # Random.uuid #=> "2d931510-d99f-494a-8c67-87feb05e1594"
119
+ # Random.uuid #=> "bad85eb9-0713-4da7-8d36-07a8e4b00eab"
120
+ # # or
121
+ # prng = Random.new
122
+ # prng.uuid #=> "62936e70-1815-439b-bf89-8492855a7e6b"
123
+ #
124
+ # The version 4 UUID is purely random (except the version). It doesn't contain
125
+ # meaningful information such as MAC addresses, timestamps, etc.
126
+ #
127
+ # The result contains 122 random bits (15.25 random bytes).
128
+ #
129
+ # See [RFC9562](https://www.rfc-editor.org/rfc/rfc9562) for details of UUIDv4.
130
+ #
131
+ %a{annotate:rdoc:copy:Random::Formatter#uuid}
132
+ def uuid: () -> String
133
+
134
+ # <!--
135
+ # rdoc-file=lib/random/formatter.rb
136
+ # - uuid_v4()
137
+ # -->
138
+ #
139
+ %a{annotate:rdoc:copy:Random::Formatter#uuid_v4}
140
+ alias uuid_v4 uuid
141
+
142
+ # <!--
143
+ # rdoc-file=lib/random/formatter.rb
144
+ # - uuid_v7(extra_timestamp_bits: 0)
145
+ # -->
146
+ # Generate a random v7 UUID (Universally Unique IDentifier).
147
+ #
148
+ # require 'random/formatter'
149
+ #
150
+ # Random.uuid_v7 # => "0188d4c3-1311-7f96-85c7-242a7aa58f1e"
151
+ # Random.uuid_v7 # => "0188d4c3-16fe-744f-86af-38fa04c62bb5"
152
+ # Random.uuid_v7 # => "0188d4c3-1af8-764f-b049-c204ce0afa23"
153
+ # Random.uuid_v7 # => "0188d4c3-1e74-7085-b14f-ef6415dc6f31"
154
+ # # |<--sorted-->| |<----- random ---->|
155
+ #
156
+ # # or
157
+ # prng = Random.new
158
+ # prng.uuid_v7 # => "0188ca51-5e72-7950-a11d-def7ff977c98"
159
+ #
160
+ # The version 7 UUID starts with the least significant 48 bits of a 64 bit Unix
161
+ # timestamp (milliseconds since the epoch) and fills the remaining bits with
162
+ # random data, excluding the version and variant bits.
163
+ #
164
+ # This allows version 7 UUIDs to be sorted by creation time. Time ordered UUIDs
165
+ # can be used for better database index locality of newly inserted records,
166
+ # which may have a significant performance benefit compared to random data
167
+ # inserts.
168
+ #
169
+ # The result contains 74 random bits (9.25 random bytes).
170
+ #
171
+ # Note that this method cannot be made reproducible because its output includes
172
+ # not only random bits but also timestamp.
173
+ #
174
+ # See [RFC9562](https://www.rfc-editor.org/rfc/rfc9562) for details of UUIDv7.
175
+ #
176
+ # #### Monotonicity
177
+ #
178
+ # UUIDv7 has millisecond precision by default, so multiple UUIDs created within
179
+ # the same millisecond are not issued in monotonically increasing order. To
180
+ # create UUIDs that are time-ordered with sub-millisecond precision, up to 12
181
+ # bits of additional timestamp may added with `extra_timestamp_bits`. The extra
182
+ # timestamp precision comes at the expense of random bits. Setting
183
+ # <code>extra_timestamp_bits: 12</code> provides ~244ns of precision, but only
184
+ # 62 random bits (7.75 random bytes).
185
+ #
186
+ # prng = Random.new
187
+ # Array.new(4) { prng.uuid_v7(extra_timestamp_bits: 12) }
188
+ # # =>
189
+ # ["0188d4c7-13da-74f9-8b53-22a786ffdd5a",
190
+ # "0188d4c7-13da-753b-83a5-7fb9b2afaeea",
191
+ # "0188d4c7-13da-754a-88ea-ac0baeedd8db",
192
+ # "0188d4c7-13da-7557-83e1-7cad9cda0d8d"]
193
+ # # |<--- sorted --->| |<-- random --->|
194
+ #
195
+ # Array.new(4) { prng.uuid_v7(extra_timestamp_bits: 8) }
196
+ # # =>
197
+ # ["0188d4c7-3333-7a95-850a-de6edb858f7e",
198
+ # "0188d4c7-3333-7ae8-842e-bc3a8b7d0cf9", # <- out of order
199
+ # "0188d4c7-3333-7ae2-995a-9f135dc44ead", # <- out of order
200
+ # "0188d4c7-3333-7af9-87c3-8f612edac82e"]
201
+ # # |<--- sorted -->||<---- random --->|
202
+ #
203
+ # Any rollbacks of the system clock will break monotonicity. UUIDv7 is based on
204
+ # UTC, which excludes leap seconds and can rollback the clock. To avoid this,
205
+ # the system clock can synchronize with an NTP server configured to use a "leap
206
+ # smear" approach. NTP or PTP will also be needed to synchronize across
207
+ # distributed nodes.
208
+ #
209
+ # Counters and other mechanisms for stronger guarantees of monotonicity are not
210
+ # implemented. Applications with stricter requirements should follow [Section
211
+ # 6.2](https://www.rfc-editor.org/rfc/rfc9562.html#name-monotonicity-and-counter
212
+ # s) of the specification.
213
+ #
214
+ %a{annotate:rdoc:copy:Random::Formatter#uuid_v7}
215
+ def uuid_v7: (?extra_timestamp_bits: Integer) -> String
216
+
217
+ # <!--
218
+ # rdoc-file=lib/random/formatter.rb
219
+ # - alphanumeric(n = nil, chars: ALPHANUMERIC)
220
+ # -->
221
+ # Generate a random alphanumeric string.
222
+ #
223
+ # The argument *n* specifies the length, in characters, of the alphanumeric
224
+ # string to be generated. The argument *chars* specifies the character list
225
+ # which the result is consist of.
226
+ #
227
+ # If *n* is not specified or is nil, 16 is assumed. It may be larger in the
228
+ # future.
229
+ #
230
+ # The result may contain A-Z, a-z and 0-9, unless *chars* is specified.
231
+ #
232
+ # require 'random/formatter'
233
+ #
234
+ # Random.alphanumeric #=> "2BuBuLf3WfSKyQbR"
235
+ # # or
236
+ # prng = Random.new
237
+ # prng.alphanumeric(10) #=> "i6K93NdqiH"
238
+ #
239
+ # Random.alphanumeric(4, chars: [*"0".."9"]) #=> "2952"
240
+ # # or
241
+ # prng = Random.new
242
+ # prng.alphanumeric(10, chars: [*"!".."/"]) #=> ",.,++%/''."
243
+ #
244
+ %a{annotate:rdoc:copy:Random::Formatter#alphanumeric}
245
+ def alphanumeric: (?Numeric?, ?chars: Array[String]) -> String
246
+
247
+ # <!--
248
+ # rdoc-file=lib/random/formatter.rb
249
+ # - gen_random(n)
250
+ # -->
251
+ # Internal interface to Random; Generate random data *n* bytes.
252
+ #
253
+ %a{annotate:rdoc:copy:Random::Formatter#gen_random}
254
+ private def gen_random: (Integer n) -> String
255
+
256
+ # <!--
257
+ # rdoc-file=lib/random/formatter.rb
258
+ # - choose(source, n)
259
+ # -->
260
+ # Generate a string that randomly draws from a source array of characters.
261
+ #
262
+ # The argument *source* specifies the array of characters from which to generate
263
+ # the string. The argument *n* specifies the length, in characters, of the
264
+ # string to be generated.
265
+ #
266
+ # The result may contain whatever characters are in the source array.
267
+ #
268
+ # require 'random/formatter'
269
+ #
270
+ # prng.choose([*'l'..'r'], 16) #=> "lmrqpoonmmlqlron"
271
+ # prng.choose([*'0'..'9'], 5) #=> "27309"
272
+ #
273
+ %a{annotate:rdoc:copy:Random::Formatter#choose}
274
+ private def choose: (Array[String] source, Integer n) -> String
275
+ end
276
+ end
277
+ end
@@ -22,9 +22,10 @@ module RDoc
22
22
  # * RDoc::MetaMethod
23
23
  # * RDoc::Alias
24
24
  # * RDoc::Constant
25
+ # * RDoc::Require
25
26
  # * RDoc::Mixin
26
- # * RDoc::Require
27
27
  # * RDoc::Include
28
+ # * RDoc::Extend
28
29
  #
29
30
  class CodeObject
30
31
  # <!-- rdoc-file=lib/rdoc/code_object.rb -->
@@ -42,7 +42,7 @@ module RDoc
42
42
 
43
43
  # <!--
44
44
  # rdoc-file=lib/rdoc/parser.rb
45
- # - new(top_level, file_name, content, options, stats)
45
+ # - new(top_level, content, options, stats)
46
46
  # -->
47
47
  # Creates a new Parser storing `top_level`, `file_name`, `content`, `options`
48
48
  # and `stats` in instance variables. In +@preprocess+ an
@@ -84,7 +84,7 @@ module RDoc
84
84
  # -->
85
85
  # Starts collecting tokens
86
86
  #
87
- def collect_tokens: () -> void
87
+ def collect_tokens: (Symbol) -> void
88
88
 
89
89
  # <!--
90
90
  # rdoc-file=lib/rdoc/token_stream.rb
@@ -22,7 +22,7 @@ module RDoc
22
22
  class Store
23
23
  # <!--
24
24
  # rdoc-file=lib/rdoc/store.rb
25
- # - new(path = nil, type = nil)
25
+ # - new(options, path: nil, type: nil)
26
26
  # -->
27
27
  # Creates a new Store of `type` that will load or save to `path`
28
28
  #
@@ -427,15 +427,9 @@ end
427
427
  class Resolv::DNS::Config::OtherResolvError < Resolv::ResolvError
428
428
  end
429
429
 
430
- # <!-- rdoc-file=lib/resolv.rb -->
431
- # Indicates that the DNS response was unable to be decoded.
432
- #
433
430
  class Resolv::DNS::DecodeError < StandardError
434
431
  end
435
432
 
436
- # <!-- rdoc-file=lib/resolv.rb -->
437
- # Indicates that the DNS request was unable to be encoded.
438
- #
439
433
  class Resolv::DNS::EncodeError < StandardError
440
434
  end
441
435
 
@@ -585,9 +579,6 @@ class Resolv::DNS::Message::MessageEncoder
585
579
  def initialize: () -> untyped
586
580
  end
587
581
 
588
- # <!-- rdoc-file=lib/resolv.rb -->
589
- # A representation of a DNS name.
590
- #
591
582
  class Resolv::DNS::Name
592
583
  # <!--
593
584
  # rdoc-file=lib/resolv.rb
@@ -677,9 +668,6 @@ Resolv::DNS::OpCode::Status: Integer
677
668
 
678
669
  Resolv::DNS::OpCode::Update: Integer
679
670
 
680
- # <!-- rdoc-file=lib/resolv.rb -->
681
- # A DNS query abstract class.
682
- #
683
671
  class Resolv::DNS::Query
684
672
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
685
673
 
@@ -817,9 +805,6 @@ class Resolv::DNS::Requester::UnconnectedUDP::Sender < Resolv::DNS::Requester::S
817
805
  def initialize: (Resolv::DNS::Message msg, String data, UDPSocket sock, String host, Integer port) -> untyped
818
806
  end
819
807
 
820
- # <!-- rdoc-file=lib/resolv.rb -->
821
- # A DNS resource abstract class.
822
- #
823
808
  class Resolv::DNS::Resource < Resolv::DNS::Query
824
809
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
825
810
 
@@ -845,25 +830,16 @@ Resolv::DNS::Resource::ClassInsensitiveTypes: Array[singleton(Resolv::DNS::Resou
845
830
 
846
831
  Resolv::DNS::Resource::ClassValue: Integer?
847
832
 
848
- # <!-- rdoc-file=lib/resolv.rb -->
849
- # A Query type requesting any RR.
850
- #
851
833
  class Resolv::DNS::Resource::ANY < Resolv::DNS::Query
852
834
  end
853
835
 
854
836
  Resolv::DNS::Resource::ANY::TypeValue: Integer
855
837
 
856
- # <!-- rdoc-file=lib/resolv.rb -->
857
- # The canonical name for an alias.
858
- #
859
838
  class Resolv::DNS::Resource::CNAME < Resolv::DNS::Resource::DomainName
860
839
  end
861
840
 
862
841
  Resolv::DNS::Resource::CNAME::TypeValue: Integer
863
842
 
864
- # <!-- rdoc-file=lib/resolv.rb -->
865
- # Domain Name resource abstract class.
866
- #
867
843
  class Resolv::DNS::Resource::DomainName < Resolv::DNS::Resource
868
844
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
869
845
 
@@ -885,9 +861,6 @@ class Resolv::DNS::Resource::DomainName < Resolv::DNS::Resource
885
861
  def initialize: (String name) -> untyped
886
862
  end
887
863
 
888
- # <!-- rdoc-file=lib/resolv.rb -->
889
- # A generic resource abstract class.
890
- #
891
864
  class Resolv::DNS::Resource::Generic < Resolv::DNS::Resource
892
865
  def self.create: (Integer type_value, Integer class_value) -> Class
893
866
 
@@ -911,9 +884,6 @@ class Resolv::DNS::Resource::Generic < Resolv::DNS::Resource
911
884
  def initialize: (String data) -> untyped
912
885
  end
913
886
 
914
- # <!-- rdoc-file=lib/resolv.rb -->
915
- # Host Information resource.
916
- #
917
887
  class Resolv::DNS::Resource::HINFO < Resolv::DNS::Resource
918
888
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
919
889
 
@@ -942,17 +912,11 @@ end
942
912
 
943
913
  Resolv::DNS::Resource::HINFO::TypeValue: Integer
944
914
 
945
- # <!-- rdoc-file=lib/resolv.rb -->
946
- # module IN contains ARPA Internet specific RRs.
947
- #
948
915
  module Resolv::DNS::Resource::IN
949
916
  end
950
917
 
951
918
  Resolv::DNS::Resource::IN::ClassValue: Integer
952
919
 
953
- # <!-- rdoc-file=lib/resolv.rb -->
954
- # IPv4 Address resource
955
- #
956
920
  class Resolv::DNS::Resource::IN::A < Resolv::DNS::Resource
957
921
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
958
922
 
@@ -978,9 +942,6 @@ Resolv::DNS::Resource::IN::A::ClassValue: Integer
978
942
 
979
943
  Resolv::DNS::Resource::IN::A::TypeValue: Integer
980
944
 
981
- # <!-- rdoc-file=lib/resolv.rb -->
982
- # An IPv6 address record.
983
- #
984
945
  class Resolv::DNS::Resource::IN::AAAA < Resolv::DNS::Resource
985
946
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
986
947
 
@@ -1069,11 +1030,6 @@ Resolv::DNS::Resource::IN::SOA::ClassValue: Integer
1069
1030
 
1070
1031
  Resolv::DNS::Resource::IN::SOA::TypeValue: Integer
1071
1032
 
1072
- # <!-- rdoc-file=lib/resolv.rb -->
1073
- # SRV resource record defined in RFC 2782
1074
- #
1075
- # These records identify the hostname and port that a service is available at.
1076
- #
1077
1033
  class Resolv::DNS::Resource::IN::SRV < Resolv::DNS::Resource
1078
1034
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
1079
1035
 
@@ -1141,9 +1097,6 @@ Resolv::DNS::Resource::IN::TXT::ClassValue: Integer
1141
1097
 
1142
1098
  Resolv::DNS::Resource::IN::TXT::TypeValue: Integer
1143
1099
 
1144
- # <!-- rdoc-file=lib/resolv.rb -->
1145
- # Well Known Service resource.
1146
- #
1147
1100
  class Resolv::DNS::Resource::IN::WKS < Resolv::DNS::Resource
1148
1101
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
1149
1102
 
@@ -1182,9 +1135,6 @@ Resolv::DNS::Resource::IN::WKS::ClassValue: Integer
1182
1135
 
1183
1136
  Resolv::DNS::Resource::IN::WKS::TypeValue: Integer
1184
1137
 
1185
- # <!-- rdoc-file=lib/resolv.rb -->
1186
- # Location resource
1187
- #
1188
1138
  class Resolv::DNS::Resource::LOC < Resolv::DNS::Resource
1189
1139
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
1190
1140
 
@@ -1243,9 +1193,6 @@ end
1243
1193
 
1244
1194
  Resolv::DNS::Resource::LOC::TypeValue: Integer
1245
1195
 
1246
- # <!-- rdoc-file=lib/resolv.rb -->
1247
- # Mailing list or mailbox information.
1248
- #
1249
1196
  class Resolv::DNS::Resource::MINFO < Resolv::DNS::Resource
1250
1197
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
1251
1198
 
@@ -1273,9 +1220,6 @@ end
1273
1220
 
1274
1221
  Resolv::DNS::Resource::MINFO::TypeValue: Integer
1275
1222
 
1276
- # <!-- rdoc-file=lib/resolv.rb -->
1277
- # Mail Exchanger resource.
1278
- #
1279
1223
  class Resolv::DNS::Resource::MX < Resolv::DNS::Resource
1280
1224
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
1281
1225
 
@@ -1304,25 +1248,16 @@ end
1304
1248
 
1305
1249
  Resolv::DNS::Resource::MX::TypeValue: Integer
1306
1250
 
1307
- # <!-- rdoc-file=lib/resolv.rb -->
1308
- # An authoritative name server.
1309
- #
1310
1251
  class Resolv::DNS::Resource::NS < Resolv::DNS::Resource::DomainName
1311
1252
  end
1312
1253
 
1313
1254
  Resolv::DNS::Resource::NS::TypeValue: Integer
1314
1255
 
1315
- # <!-- rdoc-file=lib/resolv.rb -->
1316
- # A Pointer to another DNS name.
1317
- #
1318
1256
  class Resolv::DNS::Resource::PTR < Resolv::DNS::Resource::DomainName
1319
1257
  end
1320
1258
 
1321
1259
  Resolv::DNS::Resource::PTR::TypeValue: Integer
1322
1260
 
1323
- # <!-- rdoc-file=lib/resolv.rb -->
1324
- # Start Of Authority resource.
1325
- #
1326
1261
  class Resolv::DNS::Resource::SOA < Resolv::DNS::Resource
1327
1262
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
1328
1263
 
@@ -1380,9 +1315,6 @@ end
1380
1315
 
1381
1316
  Resolv::DNS::Resource::SOA::TypeValue: Integer
1382
1317
 
1383
- # <!-- rdoc-file=lib/resolv.rb -->
1384
- # Unstructured text resource.
1385
- #
1386
1318
  class Resolv::DNS::Resource::TXT < Resolv::DNS::Resource
1387
1319
  def self.decode_rdata: (Resolv::DNS::Message::MessageDecoder msg) -> instance
1388
1320
 
@@ -1478,6 +1410,9 @@ class Resolv::Hosts
1478
1410
  def initialize: (?String filename) -> untyped
1479
1411
  end
1480
1412
 
1413
+ # <!-- rdoc-file=lib/resolv.rb -->
1414
+ # The default file name for host names
1415
+ #
1481
1416
  Resolv::Hosts::DefaultFileName: String
1482
1417
 
1483
1418
  # <!-- rdoc-file=lib/resolv.rb -->
@@ -1488,6 +1423,13 @@ class Resolv::IPv4
1488
1423
  # rdoc-file=lib/resolv.rb
1489
1424
  # - create(arg)
1490
1425
  # -->
1426
+ # Creates a new IPv4 address from `arg` which may be:
1427
+ #
1428
+ # IPv4
1429
+ # : returns `arg`.
1430
+ #
1431
+ # String
1432
+ # : `arg` must match the IPv4::Regex constant
1491
1433
  #
1492
1434
  def self.create: (String | instance arg) -> instance
1493
1435
 
@@ -1519,6 +1461,9 @@ class Resolv::IPv4
1519
1461
  def initialize: (String address) -> untyped
1520
1462
  end
1521
1463
 
1464
+ # <!-- rdoc-file=lib/resolv.rb -->
1465
+ # Regular expression IPv4 addresses must match.
1466
+ #
1522
1467
  Resolv::IPv4::Regex: Regexp
1523
1468
 
1524
1469
  # <!-- rdoc-file=lib/resolv.rb -->
@@ -1649,10 +1594,14 @@ class Resolv::LOC::Alt
1649
1594
  # rdoc-file=lib/resolv.rb
1650
1595
  # - new(altitude)
1651
1596
  # -->
1597
+ # Internal use; use self.create.
1652
1598
  #
1653
1599
  def initialize: (Integer altitude) -> untyped
1654
1600
  end
1655
1601
 
1602
+ # <!-- rdoc-file=lib/resolv.rb -->
1603
+ # Regular expression LOC Alt must match.
1604
+ #
1656
1605
  Resolv::LOC::Alt::Regex: Regexp
1657
1606
 
1658
1607
  # <!-- rdoc-file=lib/resolv.rb -->
@@ -1701,10 +1650,14 @@ class Resolv::LOC::Coord
1701
1650
  # rdoc-file=lib/resolv.rb
1702
1651
  # - new(coordinates,orientation)
1703
1652
  # -->
1653
+ # Internal use; use self.create.
1704
1654
  #
1705
1655
  def initialize: (String coordinates, orientation orientation) -> untyped
1706
1656
  end
1707
1657
 
1658
+ # <!-- rdoc-file=lib/resolv.rb -->
1659
+ # Regular expression LOC Coord must match.
1660
+ #
1708
1661
  Resolv::LOC::Coord::Regex: Regexp
1709
1662
 
1710
1663
  # <!-- rdoc-file=lib/resolv.rb -->
@@ -1746,10 +1699,14 @@ class Resolv::LOC::Size
1746
1699
  # rdoc-file=lib/resolv.rb
1747
1700
  # - new(scalar)
1748
1701
  # -->
1702
+ # Internal use; use self.create.
1749
1703
  #
1750
1704
  def initialize: (String scalar) -> untyped
1751
1705
  end
1752
1706
 
1707
+ # <!-- rdoc-file=lib/resolv.rb -->
1708
+ # Regular expression LOC size must match.
1709
+ #
1753
1710
  Resolv::LOC::Size::Regex: Regexp
1754
1711
 
1755
1712
  # <!-- rdoc-file=lib/resolv.rb -->
@@ -31,23 +31,26 @@
31
31
  # nil,
32
32
  # nil]]]]
33
33
  #
34
- # You can see in the example above, the expression starts with `:program`.
34
+ # You can see in the example above, the expression starts with
35
+ # <code>:program</code>.
35
36
  #
36
- # From here, a method definition at `:def`, followed by the method's identifier
37
- # `:@ident`. After the method's identifier comes the parentheses `:paren` and
38
- # the method parameters under `:params`.
37
+ # From here, a method definition at <code>:def</code>, followed by the method's
38
+ # identifier <code>:@ident</code>. After the method's identifier comes the
39
+ # parentheses <code>:paren</code> and the method parameters under
40
+ # <code>:params</code>.
39
41
  #
40
- # Next is the method body, starting at `:bodystmt` (`stmt` meaning statement),
41
- # which contains the full definition of the method.
42
+ # Next is the method body, starting at <code>:bodystmt</code> (`stmt` meaning
43
+ # statement), which contains the full definition of the method.
42
44
  #
43
45
  # In our case, we're simply returning a String, so next we have the
44
- # `:string_literal` expression.
46
+ # <code>:string_literal</code> expression.
45
47
  #
46
- # Within our `:string_literal` you'll notice two `@tstring_content`, this is the
47
- # literal part for `Hello, ` and `!`. Between the two `@tstring_content`
48
- # statements is a `:string_embexpr`, where *embexpr* is an embedded expression.
49
- # Our expression consists of a local variable, or `var_ref`, with the identifier
50
- # (`@ident`) of `world`.
48
+ # Within our <code>:string_literal</code> you'll notice two
49
+ # <code>@tstring_content</code>, this is the literal part for <code>Hello,
50
+ # </code> and <code>!</code>. Between the two <code>@tstring_content</code>
51
+ # statements is a <code>:string_embexpr</code>, where *embexpr* is an embedded
52
+ # expression. Our expression consists of a local variable, or `var_ref`, with
53
+ # the identifier (<code>@ident</code>) of `world`.
51
54
  #
52
55
  # ## Resources
53
56
  #
@@ -189,7 +192,7 @@ class Ripper
189
192
  # - state()
190
193
  # -->
191
194
  # The scanner's state of the current token. This value is the bitwise OR of zero
192
- # or more of the `Ripper::EXPR_*` constants.
195
+ # or more of the <code>Ripper::EXPR_*</code> constants.
193
196
  #
194
197
  def state: () -> Ripper::Lexer::State
195
198
 
@@ -247,8 +250,8 @@ class Ripper
247
250
  # - to_a()
248
251
  # -->
249
252
  #
250
- def to_a: () -> [ [ Integer, Integer ], Symbol, String, Ripper::Lexer::State, String ]
251
- | () -> [ [ Integer, Integer ], Symbol, String, Ripper::Lexer::State ]
253
+ def to_a: () -> ( [ [ Integer, Integer ], Symbol, String, Ripper::Lexer::State, String ]
254
+ | [ [ Integer, Integer ], Symbol, String, Ripper::Lexer::State ] )
252
255
  end
253
256
 
254
257
  class State
@@ -972,10 +975,10 @@ class Ripper
972
975
  # - lex(src, filename = '-', lineno = 1, **kw)
973
976
  # -->
974
977
  # Tokenizes the Ruby program and returns an array of an array, which is
975
- # formatted like `[[lineno, column], type, token, state]`. The `filename`
976
- # argument is mostly ignored. By default, this method does not handle syntax
977
- # errors in `src`, use the `raise_errors` keyword to raise a SyntaxError for an
978
- # error in `src`.
978
+ # formatted like <code>[[lineno, column], type, token, state]</code>. The
979
+ # `filename` argument is mostly ignored. By default, this method does not handle
980
+ # syntax errors in `src`, use the `raise_errors` keyword to raise a SyntaxError
981
+ # for an error in `src`.
979
982
  #
980
983
  # require 'ripper'
981
984
  # require 'pp'
@@ -0,0 +1,2 @@
1
+ dependencies:
2
+ - name: random-formatter