rbs 2.8.4 → 3.8.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/dependabot.yml +12 -4
- data/.github/workflows/comments.yml +11 -11
- data/.github/workflows/dependabot.yml +30 -0
- data/.github/workflows/ruby.yml +40 -49
- data/.github/workflows/typecheck.yml +36 -0
- data/.github/workflows/windows.yml +28 -0
- data/.gitignore +1 -0
- data/.rubocop.yml +42 -2
- data/CHANGELOG.md +845 -1
- data/README.md +64 -4
- data/Rakefile +198 -18
- data/Steepfile +11 -11
- data/config.yml +311 -0
- data/core/array.rbs +2189 -1914
- data/core/basic_object.rbs +59 -84
- data/core/binding.rbs +7 -69
- data/core/builtin.rbs +210 -11
- data/core/class.rbs +37 -0
- data/core/comparable.rbs +23 -25
- data/core/complex.rbs +449 -227
- data/core/constants.rbs +29 -21
- data/core/data.rbs +415 -0
- data/core/dir.rbs +698 -415
- data/core/encoding.rbs +468 -843
- data/core/enumerable.rbs +495 -455
- data/core/enumerator/product.rbs +92 -0
- data/core/enumerator.rbs +106 -9
- data/core/env.rbs +1 -1
- data/core/errno.rbs +506 -605
- data/core/errors.rbs +15 -17
- data/core/exception.rbs +361 -145
- data/core/false_class.rbs +39 -26
- data/core/fiber.rbs +121 -14
- data/core/file.rbs +1262 -320
- data/core/file_test.rbs +62 -45
- data/core/float.rbs +187 -208
- data/core/gc.rbs +446 -196
- data/core/global_variables.rbs +29 -29
- data/core/hash.rbs +242 -349
- data/core/integer.rbs +246 -308
- data/core/io/buffer.rbs +373 -122
- data/core/io/wait.rbs +29 -17
- data/core/io.rbs +1881 -1518
- data/core/kernel.rbs +2116 -1538
- data/core/marshal.rbs +24 -14
- data/core/match_data.rbs +413 -166
- data/core/math.rbs +531 -291
- data/core/method.rbs +101 -32
- data/core/module.rbs +228 -64
- data/core/nil_class.rbs +106 -47
- data/core/numeric.rbs +206 -292
- data/core/object.rbs +73 -1168
- data/core/object_space/weak_key_map.rbs +166 -0
- data/core/object_space.rbs +5 -3
- data/core/proc.rbs +280 -39
- data/core/process.rbs +1318 -658
- data/core/ractor.rbs +200 -134
- data/core/random.rbs +21 -4
- data/core/range.rbs +309 -153
- data/core/rational.rbs +4 -12
- data/core/rb_config.rbs +64 -43
- data/core/rbs/unnamed/argf.rbs +411 -147
- data/core/rbs/unnamed/env_class.rbs +137 -253
- data/core/rbs/unnamed/random.rbs +49 -26
- data/core/refinement.rbs +16 -1
- data/core/regexp.rbs +1568 -862
- data/core/ruby_vm.rbs +719 -7
- data/core/rubygems/config_file.rbs +3 -0
- data/core/rubygems/errors.rbs +69 -6
- data/core/rubygems/rubygems.rbs +71 -17
- data/core/rubygems/version.rbs +11 -7
- data/{stdlib/set/0 → core}/set.rbs +80 -91
- data/core/signal.rbs +14 -8
- data/core/string.rbs +1732 -1607
- data/core/struct.rbs +467 -95
- data/core/symbol.rbs +215 -245
- data/core/thread.rbs +133 -89
- data/core/thread_group.rbs +9 -9
- data/core/time.rbs +1141 -841
- data/core/trace_point.rbs +181 -121
- data/core/true_class.rbs +58 -32
- data/core/unbound_method.rbs +103 -30
- data/core/warning.rbs +50 -5
- data/docs/CONTRIBUTING.md +1 -1
- data/docs/architecture.md +110 -0
- data/docs/collection.md +59 -5
- data/docs/data_and_struct.md +86 -0
- data/docs/gem.md +57 -0
- data/docs/rbs_by_example.md +16 -35
- data/docs/repo.md +1 -1
- data/docs/sigs.md +7 -7
- data/docs/stdlib.md +63 -5
- data/docs/syntax.md +255 -61
- data/docs/tools.md +1 -0
- data/ext/rbs_extension/extconf.rb +10 -0
- data/ext/rbs_extension/lexer.c +1741 -1548
- data/ext/rbs_extension/lexer.h +11 -1
- data/ext/rbs_extension/lexer.re +12 -6
- data/ext/rbs_extension/lexstate.c +26 -3
- data/ext/rbs_extension/location.c +119 -111
- data/ext/rbs_extension/location.h +32 -7
- data/ext/rbs_extension/main.c +3 -0
- data/ext/rbs_extension/parser.c +883 -481
- data/ext/rbs_extension/parserstate.c +65 -25
- data/ext/rbs_extension/parserstate.h +13 -3
- data/ext/rbs_extension/rbs_extension.h +1 -10
- data/ext/rbs_extension/unescape.c +7 -47
- data/goodcheck.yml +2 -2
- data/{ext/rbs_extension → include/rbs}/constants.h +26 -15
- data/include/rbs/ruby_objs.h +72 -0
- data/include/rbs.h +7 -0
- data/lib/rbs/annotate/annotations.rb +3 -3
- data/lib/rbs/annotate/formatter.rb +13 -3
- data/lib/rbs/annotate/rdoc_annotator.rb +1 -1
- data/lib/rbs/annotate/rdoc_source.rb +12 -3
- data/lib/rbs/ast/declarations.rb +85 -2
- data/lib/rbs/ast/directives.rb +39 -0
- data/lib/rbs/ast/members.rb +49 -15
- data/lib/rbs/ast/type_param.rb +104 -15
- data/lib/rbs/ast/visitor.rb +137 -0
- data/lib/rbs/buffer.rb +5 -0
- data/lib/rbs/cli/colored_io.rb +48 -0
- data/lib/rbs/cli/diff.rb +83 -0
- data/lib/rbs/cli/validate.rb +356 -0
- data/lib/rbs/cli.rb +253 -143
- data/lib/rbs/collection/cleaner.rb +8 -1
- data/lib/rbs/collection/config/lockfile.rb +92 -0
- data/lib/rbs/collection/config/lockfile_generator.rb +154 -65
- data/lib/rbs/collection/config.rb +19 -46
- data/lib/rbs/collection/installer.rb +12 -13
- data/lib/rbs/collection/sources/base.rb +2 -2
- data/lib/rbs/collection/sources/git.rb +146 -69
- data/lib/rbs/collection/sources/local.rb +81 -0
- data/lib/rbs/collection/sources/rubygems.rb +10 -12
- data/lib/rbs/collection/sources/stdlib.rb +14 -13
- data/lib/rbs/collection/sources.rb +15 -2
- data/lib/rbs/collection.rb +2 -1
- data/lib/rbs/definition.rb +13 -16
- data/lib/rbs/definition_builder/ancestor_builder.rb +100 -24
- data/lib/rbs/definition_builder/method_builder.rb +4 -4
- data/lib/rbs/definition_builder.rb +489 -584
- data/lib/rbs/diff.rb +125 -0
- data/lib/rbs/environment/use_map.rb +77 -0
- data/lib/rbs/environment.rb +406 -105
- data/lib/rbs/environment_loader.rb +48 -44
- data/lib/rbs/environment_walker.rb +1 -1
- data/lib/rbs/errors.rb +175 -56
- data/lib/rbs/file_finder.rb +28 -0
- data/lib/rbs/location_aux.rb +8 -7
- data/lib/rbs/locator.rb +37 -15
- data/lib/rbs/method_type.rb +23 -0
- data/lib/rbs/namespace.rb +1 -0
- data/lib/rbs/parser/lex_result.rb +15 -0
- data/lib/rbs/parser/token.rb +23 -0
- data/lib/rbs/parser_aux.rb +22 -13
- data/lib/rbs/prototype/helpers.rb +48 -22
- data/lib/rbs/prototype/node_usage.rb +99 -0
- data/lib/rbs/prototype/rb.rb +125 -31
- data/lib/rbs/prototype/rbi.rb +49 -36
- data/lib/rbs/prototype/runtime/helpers.rb +59 -0
- data/lib/rbs/prototype/runtime/reflection.rb +19 -0
- data/lib/rbs/prototype/runtime/value_object_generator.rb +279 -0
- data/lib/rbs/prototype/runtime.rb +273 -159
- data/lib/rbs/resolver/constant_resolver.rb +24 -8
- data/lib/rbs/resolver/type_name_resolver.rb +41 -7
- data/lib/rbs/sorter.rb +153 -123
- data/lib/rbs/substitution.rb +19 -0
- data/lib/rbs/subtractor.rb +201 -0
- data/lib/rbs/test/errors.rb +24 -11
- data/lib/rbs/test/guaranteed.rb +30 -0
- data/lib/rbs/test/hook.rb +45 -40
- data/lib/rbs/test/setup.rb +1 -1
- data/lib/rbs/test/tester.rb +1 -1
- data/lib/rbs/test/type_check.rb +120 -23
- data/lib/rbs/test.rb +6 -3
- data/lib/rbs/type_alias_dependency.rb +13 -3
- data/lib/rbs/type_alias_regularity.rb +21 -14
- data/lib/rbs/type_name.rb +18 -13
- data/lib/rbs/types.rb +352 -18
- data/lib/rbs/unit_test/convertibles.rb +176 -0
- data/lib/rbs/unit_test/spy.rb +136 -0
- data/lib/rbs/unit_test/type_assertions.rb +341 -0
- data/lib/rbs/unit_test/with_aliases.rb +143 -0
- data/lib/rbs/unit_test.rb +6 -0
- data/lib/rbs/validator.rb +55 -30
- data/lib/rbs/variance_calculator.rb +26 -23
- data/lib/rbs/vendorer.rb +3 -3
- data/lib/rbs/version.rb +1 -1
- data/lib/rbs/writer.rb +69 -22
- data/lib/rbs.rb +7 -2
- data/lib/rdoc/discover.rb +1 -1
- data/lib/rdoc_plugin/parser.rb +5 -5
- data/rbs.gemspec +12 -2
- data/schema/decls.json +1 -1
- data/schema/members.json +15 -10
- data/sig/ancestor_builder.rbs +4 -0
- data/sig/ancestor_graph.rbs +22 -2
- data/sig/annotate/formatter.rbs +2 -2
- data/sig/annotate/rdoc_annotater.rbs +1 -1
- data/sig/cli/colored_io.rbs +15 -0
- data/sig/cli/diff.rbs +21 -0
- data/sig/cli/validate.rbs +43 -0
- data/sig/cli.rbs +4 -0
- data/sig/collection/config/lockfile.rbs +74 -0
- data/sig/collection/config/lockfile_generator.rbs +66 -0
- data/sig/collection/config.rbs +5 -48
- data/sig/collection/installer.rbs +1 -1
- data/sig/collection/sources.rbs +105 -33
- data/sig/constant.rbs +1 -1
- data/sig/declarations.rbs +42 -3
- data/sig/definition.rbs +26 -10
- data/sig/definition_builder.rbs +103 -81
- data/sig/diff.rbs +28 -0
- data/sig/directives.rbs +61 -0
- data/sig/environment.rbs +175 -29
- data/sig/environment_loader.rbs +20 -18
- data/sig/errors.rbs +123 -2
- data/sig/file_finder.rbs +28 -0
- data/sig/location.rbs +0 -3
- data/sig/locator.rbs +14 -2
- data/sig/manifest.yaml +0 -1
- data/sig/members.rbs +32 -9
- data/sig/method_types.rbs +10 -4
- data/sig/namespace.rbs +2 -3
- data/sig/parser.rbs +55 -16
- data/sig/prototype/helpers.rbs +4 -0
- data/sig/prototype/node_usage.rbs +20 -0
- data/sig/prototype/rb.rbs +10 -2
- data/sig/prototype/rbi.rbs +2 -0
- data/sig/prototype/runtime.rbs +182 -0
- data/sig/rbs.rbs +1 -1
- data/sig/rdoc/rbs.rbs +4 -0
- data/sig/repository.rbs +7 -5
- data/sig/resolver/constant_resolver.rbs +3 -4
- data/sig/resolver/context.rbs +1 -1
- data/sig/resolver/type_name_resolver.rbs +5 -1
- data/sig/shims/bundler.rbs +38 -0
- data/sig/shims/rubygems.rbs +19 -0
- data/sig/sorter.rbs +23 -5
- data/sig/substitution.rbs +6 -0
- data/sig/subtractor.rbs +37 -0
- data/sig/test/errors.rbs +52 -0
- data/sig/test/guranteed.rbs +9 -0
- data/sig/test/type_check.rbs +19 -0
- data/sig/test.rbs +82 -0
- data/sig/type_alias_dependency.rbs +31 -0
- data/sig/type_alias_regularity.rbs +12 -6
- data/sig/type_param.rbs +45 -9
- data/sig/typename.rbs +8 -5
- data/sig/types.rbs +119 -12
- data/sig/unit_test/convertibles.rbs +154 -0
- data/sig/unit_test/spy.rbs +28 -0
- data/sig/unit_test/type_assertions.rbs +194 -0
- data/sig/unit_test/with_aliases.rbs +136 -0
- data/sig/use_map.rbs +35 -0
- data/sig/validator.rbs +12 -5
- data/sig/variance_calculator.rbs +3 -1
- data/sig/vendorer.rbs +1 -1
- data/sig/visitor.rbs +47 -0
- data/sig/writer.rbs +6 -2
- data/src/constants.c +153 -0
- data/src/ruby_objs.c +793 -0
- data/stdlib/base64/0/base64.rbs +298 -45
- data/stdlib/benchmark/0/benchmark.rbs +12 -3
- data/stdlib/bigdecimal/0/big_decimal.rbs +62 -198
- data/stdlib/cgi/0/core.rbs +68 -15
- data/stdlib/cgi/0/manifest.yaml +1 -0
- data/stdlib/coverage/0/coverage.rbs +50 -11
- data/stdlib/csv/0/csv.rbs +90 -119
- data/stdlib/csv/0/manifest.yaml +1 -0
- data/stdlib/date/0/date.rbs +806 -735
- data/stdlib/date/0/date_time.rbs +70 -211
- data/stdlib/dbm/0/dbm.rbs +0 -2
- data/stdlib/delegate/0/delegator.rbs +184 -0
- data/stdlib/delegate/0/kernel.rbs +47 -0
- data/stdlib/delegate/0/simple_delegator.rbs +96 -0
- data/stdlib/did_you_mean/0/did_you_mean.rbs +3 -8
- data/stdlib/digest/0/digest.rbs +48 -35
- data/stdlib/erb/0/erb.rbs +15 -39
- data/stdlib/etc/0/etc.rbs +174 -54
- data/stdlib/fileutils/0/fileutils.rbs +1234 -385
- data/stdlib/forwardable/0/forwardable.rbs +4 -4
- data/stdlib/io-console/0/io-console.rbs +82 -17
- data/stdlib/ipaddr/0/ipaddr.rbs +11 -6
- data/stdlib/json/0/json.rbs +434 -151
- data/stdlib/kconv/0/kconv.rbs +166 -0
- data/stdlib/logger/0/formatter.rbs +0 -2
- data/stdlib/logger/0/log_device.rbs +1 -3
- data/stdlib/logger/0/logger.rbs +465 -328
- data/stdlib/minitest/0/kernel.rbs +2 -2
- data/stdlib/minitest/0/minitest/abstract_reporter.rbs +4 -1
- data/stdlib/minitest/0/minitest/assertion.rbs +1 -0
- data/stdlib/minitest/0/minitest/assertions.rbs +58 -13
- data/stdlib/minitest/0/minitest/backtrace_filter.rbs +7 -0
- data/stdlib/minitest/0/minitest/bench_spec.rbs +8 -8
- data/stdlib/minitest/0/minitest/benchmark.rbs +17 -16
- data/stdlib/minitest/0/minitest/compress.rbs +13 -0
- data/stdlib/minitest/0/minitest/error_on_warning.rbs +3 -0
- data/stdlib/minitest/0/minitest/mock.rbs +9 -5
- data/stdlib/minitest/0/minitest/parallel/executor.rbs +4 -0
- data/stdlib/minitest/0/minitest/parallel/test/class_methods.rbs +0 -1
- data/stdlib/minitest/0/minitest/pride_io.rbs +8 -0
- data/stdlib/minitest/0/minitest/pride_lol.rbs +2 -0
- data/stdlib/minitest/0/minitest/progress_reporter.rbs +1 -1
- data/stdlib/minitest/0/minitest/reportable.rbs +2 -0
- data/stdlib/minitest/0/minitest/runnable.rbs +33 -1
- data/stdlib/minitest/0/minitest/spec/dsl/instance_methods.rbs +1 -1
- data/stdlib/minitest/0/minitest/spec/dsl.rbs +10 -6
- data/stdlib/minitest/0/minitest/spec.rbs +1 -1
- data/stdlib/minitest/0/minitest/statistics_reporter.rbs +5 -0
- data/stdlib/minitest/0/minitest/summary_reporter.rbs +0 -7
- data/stdlib/minitest/0/minitest/test/lifecycle_hooks.rbs +7 -7
- data/stdlib/minitest/0/minitest/test.rbs +7 -14
- data/stdlib/minitest/0/minitest/unexpected_error.rbs +2 -0
- data/stdlib/minitest/0/minitest/unexpected_warning.rbs +6 -0
- data/stdlib/minitest/0/minitest/unit.rbs +1 -2
- data/stdlib/minitest/0/minitest.rbs +41 -892
- data/stdlib/monitor/0/monitor.rbs +91 -10
- data/stdlib/mutex_m/0/mutex_m.rbs +0 -2
- data/stdlib/net-http/0/manifest.yaml +1 -1
- data/stdlib/net-http/0/net-http.rbs +3858 -964
- data/stdlib/net-protocol/0/manifest.yaml +2 -0
- data/stdlib/net-protocol/0/net-protocol.rbs +56 -0
- data/stdlib/net-smtp/0/manifest.yaml +2 -0
- data/stdlib/net-smtp/0/net-smtp.rbs +55 -0
- data/stdlib/nkf/0/nkf.rbs +35 -5
- data/stdlib/objspace/0/objspace.rbs +40 -18
- data/stdlib/observable/0/observable.rbs +217 -0
- data/stdlib/open-uri/0/manifest.yaml +4 -0
- data/stdlib/open-uri/0/open-uri.rbs +393 -0
- data/stdlib/open3/0/open3.rbs +147 -0
- data/stdlib/openssl/0/manifest.yaml +1 -0
- data/stdlib/openssl/0/openssl.rbs +681 -316
- data/stdlib/optparse/0/optparse.rbs +100 -65
- data/stdlib/pathname/0/pathname.rbs +24 -15
- data/stdlib/pp/0/manifest.yaml +2 -0
- data/stdlib/pp/0/pp.rbs +300 -0
- data/stdlib/prettyprint/0/prettyprint.rbs +2 -6
- data/stdlib/pstore/0/pstore.rbs +370 -156
- data/stdlib/psych/0/core_ext.rbs +12 -0
- data/stdlib/{yaml → psych}/0/dbm.rbs +3 -3
- data/stdlib/psych/0/manifest.yaml +3 -0
- data/stdlib/psych/0/psych.rbs +402 -0
- data/stdlib/{yaml → psych}/0/store.rbs +2 -2
- data/stdlib/pty/0/pty.rbs +63 -11
- data/stdlib/rdoc/0/code_object.rbs +51 -0
- data/stdlib/rdoc/0/comment.rbs +59 -0
- data/stdlib/rdoc/0/context.rbs +153 -0
- data/stdlib/rdoc/0/markup.rbs +117 -0
- data/stdlib/rdoc/0/parser.rbs +56 -0
- data/stdlib/rdoc/0/rdoc.rbs +13 -380
- data/stdlib/rdoc/0/ri.rbs +17 -0
- data/stdlib/rdoc/0/store.rbs +48 -0
- data/stdlib/rdoc/0/top_level.rbs +97 -0
- data/stdlib/resolv/0/resolv.rbs +16 -79
- data/stdlib/ripper/0/ripper.rbs +1648 -0
- data/stdlib/securerandom/0/securerandom.rbs +7 -2
- data/stdlib/shellwords/0/shellwords.rbs +11 -12
- data/stdlib/singleton/0/singleton.rbs +0 -3
- data/stdlib/socket/0/addrinfo.rbs +13 -18
- data/stdlib/socket/0/basic_socket.rbs +5 -10
- data/stdlib/socket/0/ip_socket.rbs +0 -2
- data/stdlib/socket/0/socket.rbs +77 -46
- data/stdlib/socket/0/tcp_server.rbs +0 -5
- data/stdlib/socket/0/tcp_socket.rbs +36 -3
- data/stdlib/socket/0/udp_socket.rbs +4 -5
- data/stdlib/socket/0/unix_server.rbs +0 -5
- data/stdlib/socket/0/unix_socket.rbs +2 -4
- data/{core/string_io.rbs → stdlib/stringio/0/stringio.rbs} +188 -107
- data/stdlib/strscan/0/string_scanner.rbs +1269 -425
- data/stdlib/tempfile/0/tempfile.rbs +224 -61
- data/stdlib/time/0/time.rbs +48 -35
- data/stdlib/timeout/0/timeout.rbs +17 -8
- data/stdlib/tmpdir/0/tmpdir.rbs +10 -3
- data/stdlib/tsort/0/tsort.rbs +0 -4
- data/stdlib/uri/0/common.rbs +271 -144
- data/stdlib/uri/0/file.rbs +5 -0
- data/stdlib/uri/0/ftp.rbs +1 -1
- data/stdlib/uri/0/generic.rbs +26 -22
- data/stdlib/uri/0/http.rbs +4 -4
- data/stdlib/uri/0/ldap.rbs +1 -1
- data/stdlib/uri/0/mailto.rbs +84 -0
- data/stdlib/uri/0/rfc2396_parser.rbs +3 -0
- data/stdlib/yaml/0/manifest.yaml +1 -2
- data/stdlib/yaml/0/yaml.rbs +1 -199
- data/stdlib/zlib/0/buf_error.rbs +10 -0
- data/stdlib/zlib/0/data_error.rbs +10 -0
- data/stdlib/zlib/0/deflate.rbs +210 -0
- data/stdlib/zlib/0/error.rbs +20 -0
- data/stdlib/zlib/0/gzip_file/crc_error.rbs +12 -0
- data/stdlib/zlib/0/gzip_file/error.rbs +23 -0
- data/stdlib/zlib/0/gzip_file/length_error.rbs +12 -0
- data/stdlib/zlib/0/gzip_file/no_footer.rbs +11 -0
- data/stdlib/zlib/0/gzip_file.rbs +156 -0
- data/stdlib/zlib/0/gzip_reader.rbs +293 -0
- data/stdlib/zlib/0/gzip_writer.rbs +166 -0
- data/stdlib/zlib/0/inflate.rbs +180 -0
- data/stdlib/zlib/0/mem_error.rbs +10 -0
- data/stdlib/zlib/0/need_dict.rbs +13 -0
- data/stdlib/zlib/0/stream_end.rbs +11 -0
- data/stdlib/zlib/0/stream_error.rbs +11 -0
- data/stdlib/zlib/0/version_error.rbs +11 -0
- data/stdlib/zlib/0/zlib.rbs +1 -3
- data/stdlib/zlib/0/zstream.rbs +200 -0
- data/templates/include/rbs/constants.h.erb +20 -0
- data/templates/include/rbs/ruby_objs.h.erb +10 -0
- data/templates/src/constants.c.erb +36 -0
- data/templates/src/ruby_objs.c.erb +27 -0
- data/templates/template.rb +122 -0
- metadata +136 -36
- data/Gemfile +0 -33
- data/Gemfile.lock +0 -118
- data/core/deprecated.rbs +0 -9
- data/ext/rbs_extension/constants.c +0 -135
- data/ext/rbs_extension/ruby_objs.c +0 -525
- data/ext/rbs_extension/ruby_objs.h +0 -43
- data/lib/rbs/constant_table.rb +0 -167
- data/lib/rbs/parser_compat/lexer_error.rb +0 -6
- data/lib/rbs/parser_compat/located_value.rb +0 -7
- data/lib/rbs/parser_compat/semantics_error.rb +0 -6
- data/lib/rbs/parser_compat/syntax_error.rb +0 -6
- data/lib/rbs/test/spy.rb +0 -6
- data/lib/rbs/type_name_resolver.rb +0 -67
- data/sig/constant_table.rbs +0 -30
- data/sig/shims/abstract_syntax_tree.rbs +0 -25
- data/sig/shims/pp.rbs +0 -3
- data/sig/shims/ripper.rbs +0 -8
- data/sig/shims.rbs +0 -69
- data/sig/type_name_resolver.rbs +0 -26
- data/stdlib/minitest/0/manifest.yaml +0 -2
- data/stdlib/prime/0/integer-extension.rbs +0 -41
- data/stdlib/prime/0/manifest.yaml +0 -2
- data/stdlib/prime/0/prime.rbs +0 -372
@@ -0,0 +1,153 @@
|
|
1
|
+
%a{annotate:rdoc:skip}
|
2
|
+
module RDoc
|
3
|
+
# <!-- rdoc-file=lib/rdoc/context.rb -->
|
4
|
+
# A Context is something that can hold modules, classes, methods, attributes,
|
5
|
+
# aliases, requires, and includes. Classes, modules, and files are all Contexts.
|
6
|
+
#
|
7
|
+
class Context < CodeObject
|
8
|
+
include Comparable
|
9
|
+
|
10
|
+
# <!-- rdoc-file=lib/rdoc/context.rb -->
|
11
|
+
# Types of methods
|
12
|
+
#
|
13
|
+
TYPES: ::Array["class" | "instance"]
|
14
|
+
|
15
|
+
TOMDOC_TITLES: ::Array[nil | "Public" | "Internal" | "Deprecated"]
|
16
|
+
|
17
|
+
type class_types = singleton(RDoc::NormalClass) | singleton(RDoc::SingleClass)
|
18
|
+
|
19
|
+
# <!--
|
20
|
+
# rdoc-file=lib/rdoc/context.rb
|
21
|
+
# - new()
|
22
|
+
# -->
|
23
|
+
# Creates an unnamed empty context with public current visibility
|
24
|
+
#
|
25
|
+
def initialize: () -> void
|
26
|
+
|
27
|
+
# <!--
|
28
|
+
# rdoc-file=lib/rdoc/context.rb
|
29
|
+
# - add_alias(an_alias)
|
30
|
+
# -->
|
31
|
+
# Adds `an_alias` that is automatically resolved
|
32
|
+
#
|
33
|
+
def add_alias: (RDoc::Alias an_alias) -> RDoc::Alias
|
34
|
+
|
35
|
+
# <!--
|
36
|
+
# rdoc-file=lib/rdoc/context.rb
|
37
|
+
# - add_attribute(attribute)
|
38
|
+
# -->
|
39
|
+
# Adds `attribute` if not already there. If it is (as method(s) or attribute),
|
40
|
+
# updates the comment if it was empty.
|
41
|
+
#
|
42
|
+
# The attribute is registered only if it defines a new method. For instance,
|
43
|
+
# `attr_reader :foo` will not be registered if method `foo` exists, but
|
44
|
+
# `attr_accessor :foo` will be registered if method `foo` exists, but `foo=`
|
45
|
+
# does not.
|
46
|
+
#
|
47
|
+
def add_attribute: (RDoc::Attr attribute) -> RDoc::Attr
|
48
|
+
|
49
|
+
# <!--
|
50
|
+
# rdoc-file=lib/rdoc/context.rb
|
51
|
+
# - add_class(class_type, given_name, superclass = '::Object')
|
52
|
+
# -->
|
53
|
+
# Adds a class named `given_name` with `superclass`.
|
54
|
+
#
|
55
|
+
# Both `given_name` and `superclass` may contain '::', and are interpreted
|
56
|
+
# relative to the `self` context. This allows handling correctly examples like
|
57
|
+
# these:
|
58
|
+
# class RDoc::Gauntlet < Gauntlet
|
59
|
+
# module Mod
|
60
|
+
# class Object # implies < ::Object
|
61
|
+
# class SubObject < Object # this is _not_ ::Object
|
62
|
+
#
|
63
|
+
# Given `class Container::Item` RDoc assumes `Container` is a module unless it
|
64
|
+
# later sees `class Container`. `add_class` automatically upgrades `given_name`
|
65
|
+
# to a class in this case.
|
66
|
+
#
|
67
|
+
def add_class: (class_types class_type, ::String given_name, ?::String superclass) -> (RDoc::NormalClass | RDoc::SingleClass)
|
68
|
+
|
69
|
+
# <!--
|
70
|
+
# rdoc-file=lib/rdoc/context.rb
|
71
|
+
# - add_constant(constant)
|
72
|
+
# -->
|
73
|
+
# Adds `constant` if not already there. If it is, updates the comment, value
|
74
|
+
# and/or is_alias_for of the known constant if they were empty/nil.
|
75
|
+
#
|
76
|
+
def add_constant: (RDoc::Constant constant) -> RDoc::Constant
|
77
|
+
|
78
|
+
# <!--
|
79
|
+
# rdoc-file=lib/rdoc/context.rb
|
80
|
+
# - add_include(include)
|
81
|
+
# -->
|
82
|
+
# Adds included module `include` which should be an RDoc::Include
|
83
|
+
#
|
84
|
+
def add_include: (RDoc::Include `include`) -> RDoc::Include
|
85
|
+
|
86
|
+
# <!--
|
87
|
+
# rdoc-file=lib/rdoc/context.rb
|
88
|
+
# - add_extend(ext)
|
89
|
+
# -->
|
90
|
+
# Adds extension module `ext` which should be an RDoc::Extend
|
91
|
+
#
|
92
|
+
def add_extend: (RDoc::Extend ext) -> RDoc::Extend
|
93
|
+
|
94
|
+
# <!--
|
95
|
+
# rdoc-file=lib/rdoc/context.rb
|
96
|
+
# - add_method(method)
|
97
|
+
# -->
|
98
|
+
# Adds `method` if not already there. If it is (as method or attribute), updates
|
99
|
+
# the comment if it was empty.
|
100
|
+
#
|
101
|
+
def add_method: (RDoc::AnyMethod method) -> RDoc::AnyMethod
|
102
|
+
|
103
|
+
# <!--
|
104
|
+
# rdoc-file=lib/rdoc/context.rb
|
105
|
+
# - add_module(class_type, name)
|
106
|
+
# -->
|
107
|
+
# Adds a module named `name`. If RDoc already knows `name` is a class then that
|
108
|
+
# class is returned instead. See also #add_class.
|
109
|
+
#
|
110
|
+
def add_module: (singleton(RDoc::NormalModule) class_type, String name) -> RDoc::NormalModule
|
111
|
+
|
112
|
+
# <!-- rdoc-file=lib/rdoc/context.rb -->
|
113
|
+
# All attr* methods
|
114
|
+
#
|
115
|
+
def attributes: () -> Array[Attr]
|
116
|
+
|
117
|
+
# <!-- rdoc-file=lib/rdoc/context.rb -->
|
118
|
+
# Constants defined
|
119
|
+
#
|
120
|
+
def constants: () -> Array[Constant]
|
121
|
+
|
122
|
+
# <!--
|
123
|
+
# rdoc-file=lib/rdoc/context.rb
|
124
|
+
# - find_module_named(name)
|
125
|
+
# -->
|
126
|
+
# Find a module with `name` using ruby's scoping rules
|
127
|
+
#
|
128
|
+
def find_module_named: (untyped name) -> (untyped | self)
|
129
|
+
|
130
|
+
# <!--
|
131
|
+
# rdoc-file=lib/rdoc/context.rb
|
132
|
+
# - full_name()
|
133
|
+
# -->
|
134
|
+
# The full name for this context. This method is overridden by subclasses.
|
135
|
+
#
|
136
|
+
def full_name: () -> "(unknown)"
|
137
|
+
|
138
|
+
# <!-- rdoc-file=lib/rdoc/context.rb -->
|
139
|
+
# Methods defined in this context
|
140
|
+
#
|
141
|
+
def method_list: () -> Array[AnyMethod]
|
142
|
+
|
143
|
+
def to_s: () -> ::String
|
144
|
+
|
145
|
+
# <!--
|
146
|
+
# rdoc-file=lib/rdoc/context.rb
|
147
|
+
# - top_level()
|
148
|
+
# -->
|
149
|
+
# Return the TopLevel that owns us
|
150
|
+
#
|
151
|
+
def top_level: () -> RDoc::TopLevel
|
152
|
+
end
|
153
|
+
end
|
@@ -0,0 +1,117 @@
|
|
1
|
+
%a{annotate:rdoc:skip}
|
2
|
+
module RDoc
|
3
|
+
# <!-- rdoc-file=lib/rdoc/markup.rb -->
|
4
|
+
# RDoc::Markup parses plain text documents and attempts to decompose them into
|
5
|
+
# their constituent parts. Some of these parts are high-level: paragraphs,
|
6
|
+
# chunks of verbatim text, list entries and the like. Other parts happen at the
|
7
|
+
# character level: a piece of bold text, a word in code font. This markup is
|
8
|
+
# similar in spirit to that used on WikiWiki webs, where folks create web pages
|
9
|
+
# using a simple set of formatting rules.
|
10
|
+
#
|
11
|
+
# RDoc::Markup and other markup formats do no output formatting, this is handled
|
12
|
+
# by the RDoc::Markup::Formatter subclasses.
|
13
|
+
#
|
14
|
+
# # Markup Formats
|
15
|
+
#
|
16
|
+
# `RDoc` supports these markup formats:
|
17
|
+
#
|
18
|
+
# * `rdoc`: the `RDoc` markup format; see RDoc::MarkupReference.
|
19
|
+
# * `markdown`: The `markdown` markup format as described in the [Markdown
|
20
|
+
# Guide](https://www.markdownguide.org); see RDoc::Markdown.
|
21
|
+
# * `rd`: the `rd` markup format format; see RDoc::RD.
|
22
|
+
# * `tomdoc`: the TomDoc format as described in [TomDoc for
|
23
|
+
# Ruby](http://tomdoc.org); see RDoc::TomDoc.
|
24
|
+
#
|
25
|
+
# You can choose a markup format using the following methods:
|
26
|
+
#
|
27
|
+
# per project
|
28
|
+
# : If you build your documentation with rake use RDoc::Task#markup.
|
29
|
+
#
|
30
|
+
# If you build your documentation by hand run:
|
31
|
+
#
|
32
|
+
# rdoc --markup your_favorite_format --write-options
|
33
|
+
#
|
34
|
+
# and commit `.rdoc_options` and ship it with your packaged gem.
|
35
|
+
#
|
36
|
+
# per file
|
37
|
+
# : At the top of the file use the `:markup:` directive to set the default
|
38
|
+
# format for the rest of the file.
|
39
|
+
#
|
40
|
+
# per comment
|
41
|
+
# : Use the `:markup:` directive at the top of a comment you want to write in
|
42
|
+
# a different format.
|
43
|
+
#
|
44
|
+
#
|
45
|
+
# # RDoc::Markup
|
46
|
+
#
|
47
|
+
# RDoc::Markup is extensible at runtime: you can add new markup elements to be
|
48
|
+
# recognized in the documents that RDoc::Markup parses.
|
49
|
+
#
|
50
|
+
# RDoc::Markup is intended to be the basis for a family of tools which share the
|
51
|
+
# common requirement that simple, plain-text should be rendered in a variety of
|
52
|
+
# different output formats and media. It is envisaged that RDoc::Markup could
|
53
|
+
# be the basis for formatting RDoc style comment blocks, Wiki entries, and
|
54
|
+
# online FAQs.
|
55
|
+
#
|
56
|
+
# ## Synopsis
|
57
|
+
#
|
58
|
+
# This code converts `input_string` to HTML. The conversion takes place in the
|
59
|
+
# `convert` method, so you can use the same RDoc::Markup converter to convert
|
60
|
+
# multiple input strings.
|
61
|
+
#
|
62
|
+
# require 'rdoc'
|
63
|
+
#
|
64
|
+
# h = RDoc::Markup::ToHtml.new(RDoc::Options.new)
|
65
|
+
#
|
66
|
+
# puts h.convert(input_string)
|
67
|
+
#
|
68
|
+
# You can extend the RDoc::Markup parser to recognize new markup sequences, and
|
69
|
+
# to add regexp handling. Here we make WikiWords significant to the parser, and
|
70
|
+
# also make the sequences {word} and <no>text...</no> signify strike-through
|
71
|
+
# text. We then subclass the HTML output class to deal with these:
|
72
|
+
#
|
73
|
+
# require 'rdoc'
|
74
|
+
#
|
75
|
+
# class WikiHtml < RDoc::Markup::ToHtml
|
76
|
+
# def handle_regexp_WIKIWORD(target)
|
77
|
+
# "<font color=red>" + target.text + "</font>"
|
78
|
+
# end
|
79
|
+
# end
|
80
|
+
#
|
81
|
+
# markup = RDoc::Markup.new
|
82
|
+
# markup.add_word_pair("{", "}", :STRIKE)
|
83
|
+
# markup.add_html("no", :STRIKE)
|
84
|
+
#
|
85
|
+
# markup.add_regexp_handling(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
|
86
|
+
#
|
87
|
+
# wh = WikiHtml.new RDoc::Options.new, markup
|
88
|
+
# wh.add_tag(:STRIKE, "<strike>", "</strike>")
|
89
|
+
#
|
90
|
+
# puts "<body>#{wh.convert ARGF.read}</body>"
|
91
|
+
#
|
92
|
+
# ## Encoding
|
93
|
+
#
|
94
|
+
# Where Encoding support is available, RDoc will automatically convert all
|
95
|
+
# documents to the same output encoding. The output encoding can be set via
|
96
|
+
# RDoc::Options#encoding and defaults to Encoding.default_external.
|
97
|
+
#
|
98
|
+
# # RDoc Markup Reference
|
99
|
+
#
|
100
|
+
# See RDoc::MarkupReference.
|
101
|
+
#
|
102
|
+
class Markup
|
103
|
+
class Document
|
104
|
+
include Enumerable[Document]
|
105
|
+
|
106
|
+
def each: () { (Document) -> void } -> void
|
107
|
+
| () -> Enumerator[Document, void]
|
108
|
+
|
109
|
+
def file: () -> String?
|
110
|
+
|
111
|
+
def accept: (untyped) -> String
|
112
|
+
end
|
113
|
+
|
114
|
+
class ToMarkdown
|
115
|
+
end
|
116
|
+
end
|
117
|
+
end
|
@@ -0,0 +1,56 @@
|
|
1
|
+
%a{annotate:rdoc:skip}
|
2
|
+
module RDoc
|
3
|
+
# <!-- rdoc-file=lib/rdoc/parser.rb -->
|
4
|
+
# A parser is simple a class that subclasses RDoc::Parser and implements #scan
|
5
|
+
# to fill in an RDoc::TopLevel with parsed data.
|
6
|
+
#
|
7
|
+
# The initialize method takes an RDoc::TopLevel to fill with parsed content, the
|
8
|
+
# name of the file to be parsed, the content of the file, an RDoc::Options
|
9
|
+
# object and an RDoc::Stats object to inform the user of parsed items. The scan
|
10
|
+
# method is then called to parse the file and must return the RDoc::TopLevel
|
11
|
+
# object. By calling super these items will be set for you.
|
12
|
+
#
|
13
|
+
# In order to be used by RDoc the parser needs to register the file extensions
|
14
|
+
# it can parse. Use ::parse_files_matching to register extensions.
|
15
|
+
#
|
16
|
+
# require 'rdoc'
|
17
|
+
#
|
18
|
+
# class RDoc::Parser::Xyz < RDoc::Parser
|
19
|
+
# parse_files_matching /\.xyz$/
|
20
|
+
#
|
21
|
+
# def initialize top_level, file_name, content, options, stats
|
22
|
+
# super
|
23
|
+
#
|
24
|
+
# # extra initialization if needed
|
25
|
+
# end
|
26
|
+
#
|
27
|
+
# def scan
|
28
|
+
# # parse file and fill in @top_level
|
29
|
+
# end
|
30
|
+
# end
|
31
|
+
#
|
32
|
+
class Parser
|
33
|
+
# <!--
|
34
|
+
# rdoc-file=lib/rdoc/parser.rb
|
35
|
+
# - parse_files_matching(regexp)
|
36
|
+
# -->
|
37
|
+
# Record which file types this parser can understand.
|
38
|
+
#
|
39
|
+
# It is ok to call this multiple times.
|
40
|
+
#
|
41
|
+
def self?.parse_files_matching: (Regexp path) -> void
|
42
|
+
|
43
|
+
# <!--
|
44
|
+
# rdoc-file=lib/rdoc/parser.rb
|
45
|
+
# - new(top_level, file_name, content, options, stats)
|
46
|
+
# -->
|
47
|
+
# Creates a new Parser storing `top_level`, `file_name`, `content`, `options`
|
48
|
+
# and `stats` in instance variables. In +@preprocess+ an
|
49
|
+
# RDoc::Markup::PreProcess object is created which allows processing of
|
50
|
+
# directives.
|
51
|
+
#
|
52
|
+
def initialize: (RDoc::TopLevel top_level, String filename, String content, Hash[untyped, untyped] options, RDoc::Stats stats) -> void
|
53
|
+
|
54
|
+
def scan: () -> RDoc::TopLevel
|
55
|
+
end
|
56
|
+
end
|