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,92 @@
|
|
1
|
+
%a{annotate:rdoc:skip}
|
2
|
+
class Enumerator[unchecked out Elem, out Return = void]
|
3
|
+
# <!-- rdoc-file=enumerator.c -->
|
4
|
+
# Enumerator::Product generates a Cartesian product of any number of enumerable
|
5
|
+
# objects. Iterating over the product of enumerable objects is roughly
|
6
|
+
# equivalent to nested each_entry loops where the loop for the rightmost object
|
7
|
+
# is put innermost.
|
8
|
+
#
|
9
|
+
# innings = Enumerator::Product.new(1..9, ['top', 'bottom'])
|
10
|
+
#
|
11
|
+
# innings.each do |i, h|
|
12
|
+
# p [i, h]
|
13
|
+
# end
|
14
|
+
# # [1, "top"]
|
15
|
+
# # [1, "bottom"]
|
16
|
+
# # [2, "top"]
|
17
|
+
# # [2, "bottom"]
|
18
|
+
# # [3, "top"]
|
19
|
+
# # [3, "bottom"]
|
20
|
+
# # ...
|
21
|
+
# # [9, "top"]
|
22
|
+
# # [9, "bottom"]
|
23
|
+
#
|
24
|
+
# The method used against each enumerable object is `each_entry` instead of
|
25
|
+
# `each` so that the product of N enumerable objects yields an array of exactly
|
26
|
+
# N elements in each iteration.
|
27
|
+
#
|
28
|
+
# When no enumerator is given, it calls a given block once yielding an empty
|
29
|
+
# argument list.
|
30
|
+
#
|
31
|
+
# This type of objects can be created by Enumerator.product.
|
32
|
+
#
|
33
|
+
class Product[unchecked out Elem] < Enumerator[Array[Elem], Product[Elem]]
|
34
|
+
# <!--
|
35
|
+
# rdoc-file=enumerator.c
|
36
|
+
# - Enumerator::Product.new(*enums) -> enum
|
37
|
+
# -->
|
38
|
+
# Generates a new enumerator object that generates a Cartesian product of given
|
39
|
+
# enumerable objects.
|
40
|
+
#
|
41
|
+
# e = Enumerator::Product.new(1..3, [4, 5])
|
42
|
+
# e.to_a #=> [[1, 4], [1, 5], [2, 4], [2, 5], [3, 4], [3, 5]]
|
43
|
+
# e.size #=> 6
|
44
|
+
#
|
45
|
+
def initialize: (*_EachEntry[Elem]) -> void
|
46
|
+
|
47
|
+
# <!--
|
48
|
+
# rdoc-file=enumerator.c
|
49
|
+
# - obj.each { |...| ... } -> obj
|
50
|
+
# - obj.each -> enumerator
|
51
|
+
# -->
|
52
|
+
# Iterates over the elements of the first enumerable by calling the "each_entry"
|
53
|
+
# method on it with the given arguments, then proceeds to the following
|
54
|
+
# enumerables in sequence until all of the enumerables are exhausted.
|
55
|
+
#
|
56
|
+
# If no block is given, returns an enumerator. Otherwise, returns self.
|
57
|
+
#
|
58
|
+
def each: () { (Array[Elem]) -> void } -> self
|
59
|
+
|
60
|
+
# <!--
|
61
|
+
# rdoc-file=enumerator.c
|
62
|
+
# - obj.inspect -> string
|
63
|
+
# -->
|
64
|
+
# Returns a printable version of the product enumerator.
|
65
|
+
#
|
66
|
+
def inspect: () -> String
|
67
|
+
|
68
|
+
# <!--
|
69
|
+
# rdoc-file=enumerator.c
|
70
|
+
# - obj.rewind -> obj
|
71
|
+
# -->
|
72
|
+
# Rewinds the product enumerator by calling the "rewind" method on each
|
73
|
+
# enumerable in reverse order. Each call is performed only if the enumerable
|
74
|
+
# responds to the method.
|
75
|
+
#
|
76
|
+
def rewind: () -> self
|
77
|
+
|
78
|
+
# <!--
|
79
|
+
# rdoc-file=enumerator.c
|
80
|
+
# - obj.size -> int, Float::INFINITY or nil
|
81
|
+
# -->
|
82
|
+
# Returns the total size of the enumerator product calculated by multiplying the
|
83
|
+
# sizes of enumerables in the product. If any of the enumerables reports its
|
84
|
+
# size as nil or Float::INFINITY, that value is returned as the size.
|
85
|
+
#
|
86
|
+
def size: () -> (Integer | Float | nil)
|
87
|
+
|
88
|
+
private
|
89
|
+
|
90
|
+
def initialize_copy: (Product[Elem]) -> void
|
91
|
+
end
|
92
|
+
end
|
data/core/enumerator.rbs
CHANGED
@@ -6,7 +6,6 @@
|
|
6
6
|
# * Object#enum_for
|
7
7
|
# * Enumerator.new
|
8
8
|
#
|
9
|
-
#
|
10
9
|
# Most methods have two forms: a block form where the contents are evaluated for
|
11
10
|
# each item in the enumeration, and a non-block form which returns a new
|
12
11
|
# Enumerator wrapping the iteration.
|
@@ -40,6 +39,8 @@
|
|
40
39
|
# puts %w[foo bar baz].map.with_index { |w, i| "#{i}:#{w}" }
|
41
40
|
# # => ["0:foo", "1:bar", "2:baz"]
|
42
41
|
#
|
42
|
+
# ## External Iteration
|
43
|
+
#
|
43
44
|
# An Enumerator can also be used as an external iterator. For example,
|
44
45
|
# Enumerator#next returns the next value of the iterator or raises StopIteration
|
45
46
|
# if the Enumerator is at the end.
|
@@ -50,14 +51,49 @@
|
|
50
51
|
# puts e.next # => 3
|
51
52
|
# puts e.next # raises StopIteration
|
52
53
|
#
|
53
|
-
#
|
54
|
-
#
|
54
|
+
# `next`, `next_values`, `peek`, and `peek_values` are the only methods which
|
55
|
+
# use external iteration (and Array#zip(Enumerable-not-Array) which uses `next`
|
56
|
+
# internally).
|
57
|
+
#
|
58
|
+
# These methods do not affect other internal enumeration methods, unless the
|
55
59
|
# underlying iteration method itself has side-effect, e.g. IO#each_line.
|
56
60
|
#
|
57
|
-
#
|
58
|
-
# and
|
61
|
+
# FrozenError will be raised if these methods are called against a frozen
|
62
|
+
# enumerator. Since `rewind` and `feed` also change state for external
|
63
|
+
# iteration, these methods may raise FrozenError too.
|
64
|
+
#
|
65
|
+
# External iteration differs **significantly** from internal iteration due to
|
66
|
+
# using a Fiber:
|
67
|
+
# * The Fiber adds some overhead compared to internal enumeration.
|
68
|
+
# * The stacktrace will only include the stack from the Enumerator, not above.
|
69
|
+
# * Fiber-local variables are **not** inherited inside the Enumerator Fiber,
|
70
|
+
# which instead starts with no Fiber-local variables.
|
71
|
+
# * Fiber storage variables **are** inherited and are designed to handle
|
72
|
+
# Enumerator Fibers. Assigning to a Fiber storage variable only affects the
|
73
|
+
# current Fiber, so if you want to change state in the caller Fiber of the
|
74
|
+
# Enumerator Fiber, you need to use an extra indirection (e.g., use some
|
75
|
+
# object in the Fiber storage variable and mutate some ivar of it).
|
76
|
+
#
|
77
|
+
# Concretely:
|
78
|
+
#
|
79
|
+
# Thread.current[:fiber_local] = 1
|
80
|
+
# Fiber[:storage_var] = 1
|
81
|
+
# e = Enumerator.new do |y|
|
82
|
+
# p Thread.current[:fiber_local] # for external iteration: nil, for internal iteration: 1
|
83
|
+
# p Fiber[:storage_var] # => 1, inherited
|
84
|
+
# Fiber[:storage_var] += 1
|
85
|
+
# y << 42
|
86
|
+
# end
|
87
|
+
#
|
88
|
+
# p e.next # => 42
|
89
|
+
# p Fiber[:storage_var] # => 1 (it ran in a different Fiber)
|
90
|
+
#
|
91
|
+
# e.each { p _1 }
|
92
|
+
# p Fiber[:storage_var] # => 2 (it ran in the same Fiber/"stack" as the current Fiber)
|
93
|
+
#
|
94
|
+
# ## Convert External Iteration to Internal Iteration
|
59
95
|
#
|
60
|
-
# You can use
|
96
|
+
# You can use an external iterator to implement an internal iterator as follows:
|
61
97
|
#
|
62
98
|
# def ext_each(e)
|
63
99
|
# while true
|
@@ -89,9 +125,70 @@
|
|
89
125
|
# puts ext_each(o.to_enum) {|*x| puts x; [:b, *x] }
|
90
126
|
# # => [], [:b], [1], [:b, 1], [1, 2], [:b, 1, 2], 3
|
91
127
|
#
|
92
|
-
class Enumerator[unchecked out Elem, out Return] < Object
|
128
|
+
class Enumerator[unchecked out Elem, out Return = void] < Object
|
93
129
|
include Enumerable[Elem]
|
94
130
|
|
131
|
+
# A convenience interface for `each` with optional block
|
132
|
+
#
|
133
|
+
interface _Each[out E, out R]
|
134
|
+
def each: () { (E) -> void } -> R
|
135
|
+
| () -> Enumerator[E, R]
|
136
|
+
end
|
137
|
+
|
138
|
+
# <!--
|
139
|
+
# rdoc-file=enumerator.c
|
140
|
+
# - Enumerator.produce(initial = nil) { |prev| block } -> enumerator
|
141
|
+
# -->
|
142
|
+
# Creates an infinite enumerator from any block, just called over and over. The
|
143
|
+
# result of the previous iteration is passed to the next one. If `initial` is
|
144
|
+
# provided, it is passed to the first iteration, and becomes the first element
|
145
|
+
# of the enumerator; if it is not provided, the first iteration receives `nil`,
|
146
|
+
# and its result becomes the first element of the iterator.
|
147
|
+
#
|
148
|
+
# Raising StopIteration from the block stops an iteration.
|
149
|
+
#
|
150
|
+
# Enumerator.produce(1, &:succ) # => enumerator of 1, 2, 3, 4, ....
|
151
|
+
#
|
152
|
+
# Enumerator.produce { rand(10) } # => infinite random number sequence
|
153
|
+
#
|
154
|
+
# ancestors = Enumerator.produce(node) { |prev| node = prev.parent or raise StopIteration }
|
155
|
+
# enclosing_section = ancestors.find { |n| n.type == :section }
|
156
|
+
#
|
157
|
+
# Using ::produce together with Enumerable methods like Enumerable#detect,
|
158
|
+
# Enumerable#slice_after, Enumerable#take_while can provide Enumerator-based
|
159
|
+
# alternatives for `while` and `until` cycles:
|
160
|
+
#
|
161
|
+
# # Find next Tuesday
|
162
|
+
# require "date"
|
163
|
+
# Enumerator.produce(Date.today, &:succ).detect(&:tuesday?)
|
164
|
+
#
|
165
|
+
# # Simple lexer:
|
166
|
+
# require "strscan"
|
167
|
+
# scanner = StringScanner.new("7+38/6")
|
168
|
+
# PATTERN = %r{\d+|[-/+*]}
|
169
|
+
# Enumerator.produce { scanner.scan(PATTERN) }.slice_after { scanner.eos? }.first
|
170
|
+
# # => ["7", "+", "38", "/", "6"]
|
171
|
+
#
|
172
|
+
def self.produce: [T] () { (T? prev) -> T } -> Enumerator[T, bot]
|
173
|
+
| [T] (T initial) { (T prev) -> T } -> Enumerator[T, bot]
|
174
|
+
|
175
|
+
# <!--
|
176
|
+
# rdoc-file=enumerator.c
|
177
|
+
# - Enumerator.product(*enums) -> enumerator
|
178
|
+
# - Enumerator.product(*enums) { |elts| ... } -> enumerator
|
179
|
+
# -->
|
180
|
+
# Generates a new enumerator object that generates a Cartesian product of given
|
181
|
+
# enumerable objects. This is equivalent to Enumerator::Product.new.
|
182
|
+
#
|
183
|
+
# e = Enumerator.product(1..3, [4, 5])
|
184
|
+
# e.to_a #=> [[1, 4], [1, 5], [2, 4], [2, 5], [3, 4], [3, 5]]
|
185
|
+
# e.size #=> 6
|
186
|
+
#
|
187
|
+
# When a block is given, calls the block with each N-element array generated and
|
188
|
+
# returns `nil`.
|
189
|
+
#
|
190
|
+
def self.product: [Elem] (*_EachEntry[Elem]) -> Product[Elem]
|
191
|
+
|
95
192
|
# <!--
|
96
193
|
# rdoc-file=enumerator.c
|
97
194
|
# - enum.each { |elm| block } -> obj
|
@@ -201,7 +298,7 @@ class Enumerator[unchecked out Elem, out Return] < Object
|
|
201
298
|
# lazy fashion (see Enumerator#size). It can either be a value or a callable
|
202
299
|
# object.
|
203
300
|
#
|
204
|
-
def initialize: (?Integer arg0) { (Enumerator::Yielder arg0) ->
|
301
|
+
def initialize: (?Integer arg0) { (Enumerator::Yielder arg0) -> Return } -> void
|
205
302
|
|
206
303
|
# <!--
|
207
304
|
# rdoc-file=enumerator.c
|
@@ -468,7 +565,7 @@ end
|
|
468
565
|
# # This returns an array of items like a normal enumerator does.
|
469
566
|
# all_checked = active_items.select(&:checked)
|
470
567
|
#
|
471
|
-
class Enumerator::Lazy[out Elem, out Return] < Enumerator[Elem, Return]
|
568
|
+
class Enumerator::Lazy[out Elem, out Return = void] < Enumerator[Elem, Return]
|
472
569
|
# <!-- rdoc-file=enumerator.c -->
|
473
570
|
# Expands `lazy` enumerator to an array. See Enumerable#to_a.
|
474
571
|
#
|
data/core/env.rbs
CHANGED