rbs-relaxed 3.9.0.1
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.
- checksums.yaml +7 -0
- data/.github/dependabot.yml +22 -0
- data/.github/workflows/comments.yml +35 -0
- data/.github/workflows/dependabot.yml +30 -0
- data/.github/workflows/ruby.yml +82 -0
- data/.github/workflows/typecheck.yml +38 -0
- data/.github/workflows/windows.yml +43 -0
- data/.gitignore +23 -0
- data/.rubocop.yml +68 -0
- data/BSDL +22 -0
- data/CHANGELOG.md +1868 -0
- data/COPYING +56 -0
- data/README.md +203 -0
- data/Rakefile +417 -0
- data/Steepfile +44 -0
- data/config.yml +313 -0
- data/core/array.rbs +4062 -0
- data/core/basic_object.rbs +375 -0
- data/core/binding.rbs +150 -0
- data/core/builtin.rbs +277 -0
- data/core/class.rbs +220 -0
- data/core/comparable.rbs +171 -0
- data/core/complex.rbs +786 -0
- data/core/constants.rbs +96 -0
- data/core/data.rbs +415 -0
- data/core/dir.rbs +981 -0
- data/core/encoding.rbs +1371 -0
- data/core/enumerable.rbs +2405 -0
- data/core/enumerator/product.rbs +92 -0
- data/core/enumerator.rbs +630 -0
- data/core/env.rbs +6 -0
- data/core/errno.rbs +673 -0
- data/core/errors.rbs +760 -0
- data/core/exception.rbs +485 -0
- data/core/false_class.rbs +82 -0
- data/core/fiber.rbs +550 -0
- data/core/fiber_error.rbs +11 -0
- data/core/file.rbs +2936 -0
- data/core/file_test.rbs +331 -0
- data/core/float.rbs +1151 -0
- data/core/gc.rbs +644 -0
- data/core/global_variables.rbs +184 -0
- data/core/hash.rbs +1861 -0
- data/core/integer.rbs +1413 -0
- data/core/io/buffer.rbs +984 -0
- data/core/io/wait.rbs +70 -0
- data/core/io.rbs +3406 -0
- data/core/kernel.rbs +3096 -0
- data/core/marshal.rbs +207 -0
- data/core/match_data.rbs +635 -0
- data/core/math.rbs +729 -0
- data/core/method.rbs +386 -0
- data/core/module.rbs +1704 -0
- data/core/nil_class.rbs +209 -0
- data/core/numeric.rbs +818 -0
- data/core/object.rbs +110 -0
- data/core/object_space/weak_key_map.rbs +166 -0
- data/core/object_space.rbs +190 -0
- data/core/proc.rbs +868 -0
- data/core/process.rbs +2296 -0
- data/core/ractor.rbs +1068 -0
- data/core/random.rbs +237 -0
- data/core/range.rbs +1107 -0
- data/core/rational.rbs +531 -0
- data/core/rb_config.rbs +88 -0
- data/core/rbs/unnamed/argf.rbs +1229 -0
- data/core/rbs/unnamed/env_class.rbs +1209 -0
- data/core/rbs/unnamed/random.rbs +293 -0
- data/core/refinement.rbs +59 -0
- data/core/regexp.rbs +1930 -0
- data/core/ruby_vm.rbs +765 -0
- data/core/rubygems/basic_specification.rbs +6 -0
- data/core/rubygems/config_file.rbs +38 -0
- data/core/rubygems/dependency_installer.rbs +6 -0
- data/core/rubygems/errors.rbs +176 -0
- data/core/rubygems/installer.rbs +15 -0
- data/core/rubygems/path_support.rbs +6 -0
- data/core/rubygems/platform.rbs +7 -0
- data/core/rubygems/request_set.rbs +49 -0
- data/core/rubygems/requirement.rbs +148 -0
- data/core/rubygems/rubygems.rbs +1171 -0
- data/core/rubygems/source_list.rbs +15 -0
- data/core/rubygems/specification.rbs +23 -0
- data/core/rubygems/stream_ui.rbs +5 -0
- data/core/rubygems/uninstaller.rbs +10 -0
- data/core/rubygems/version.rbs +294 -0
- data/core/set.rbs +621 -0
- data/core/signal.rbs +100 -0
- data/core/string.rbs +3583 -0
- data/core/struct.rbs +667 -0
- data/core/symbol.rbs +475 -0
- data/core/thread.rbs +1765 -0
- data/core/thread_group.rbs +79 -0
- data/core/time.rbs +1762 -0
- data/core/trace_point.rbs +477 -0
- data/core/true_class.rbs +98 -0
- data/core/unbound_method.rbs +329 -0
- data/core/warning.rbs +87 -0
- data/docs/CONTRIBUTING.md +106 -0
- data/docs/architecture.md +110 -0
- data/docs/collection.md +192 -0
- data/docs/data_and_struct.md +86 -0
- data/docs/gem.md +57 -0
- data/docs/rbs_by_example.md +309 -0
- data/docs/repo.md +125 -0
- data/docs/sigs.md +167 -0
- data/docs/stdlib.md +147 -0
- data/docs/syntax.md +910 -0
- data/docs/tools.md +17 -0
- data/exe/rbs +7 -0
- data/ext/rbs_extension/extconf.rb +15 -0
- data/ext/rbs_extension/lexer.c +2728 -0
- data/ext/rbs_extension/lexer.h +179 -0
- data/ext/rbs_extension/lexer.re +147 -0
- data/ext/rbs_extension/lexstate.c +175 -0
- data/ext/rbs_extension/location.c +325 -0
- data/ext/rbs_extension/location.h +85 -0
- data/ext/rbs_extension/main.c +33 -0
- data/ext/rbs_extension/parser.c +2973 -0
- data/ext/rbs_extension/parser.h +18 -0
- data/ext/rbs_extension/parserstate.c +397 -0
- data/ext/rbs_extension/parserstate.h +163 -0
- data/ext/rbs_extension/rbs_extension.h +31 -0
- data/ext/rbs_extension/unescape.c +32 -0
- data/goodcheck.yml +91 -0
- data/include/rbs/constants.h +82 -0
- data/include/rbs/ruby_objs.h +72 -0
- data/include/rbs/util/rbs_constant_pool.h +219 -0
- data/include/rbs.h +7 -0
- data/lib/rbs/ancestor_graph.rb +92 -0
- data/lib/rbs/annotate/annotations.rb +199 -0
- data/lib/rbs/annotate/formatter.rb +92 -0
- data/lib/rbs/annotate/rdoc_annotator.rb +400 -0
- data/lib/rbs/annotate/rdoc_source.rb +131 -0
- data/lib/rbs/annotate.rb +8 -0
- data/lib/rbs/ast/annotation.rb +29 -0
- data/lib/rbs/ast/comment.rb +29 -0
- data/lib/rbs/ast/declarations.rb +467 -0
- data/lib/rbs/ast/directives.rb +49 -0
- data/lib/rbs/ast/members.rb +451 -0
- data/lib/rbs/ast/type_param.rb +225 -0
- data/lib/rbs/ast/visitor.rb +137 -0
- data/lib/rbs/buffer.rb +67 -0
- data/lib/rbs/builtin_names.rb +58 -0
- data/lib/rbs/cli/colored_io.rb +48 -0
- data/lib/rbs/cli/diff.rb +83 -0
- data/lib/rbs/cli/validate.rb +357 -0
- data/lib/rbs/cli.rb +1223 -0
- data/lib/rbs/collection/cleaner.rb +38 -0
- data/lib/rbs/collection/config/lockfile.rb +92 -0
- data/lib/rbs/collection/config/lockfile_generator.rb +218 -0
- data/lib/rbs/collection/config.rb +81 -0
- data/lib/rbs/collection/installer.rb +32 -0
- data/lib/rbs/collection/sources/base.rb +14 -0
- data/lib/rbs/collection/sources/git.rb +258 -0
- data/lib/rbs/collection/sources/local.rb +81 -0
- data/lib/rbs/collection/sources/rubygems.rb +48 -0
- data/lib/rbs/collection/sources/stdlib.rb +50 -0
- data/lib/rbs/collection/sources.rb +38 -0
- data/lib/rbs/collection.rb +16 -0
- data/lib/rbs/constant.rb +28 -0
- data/lib/rbs/definition.rb +401 -0
- data/lib/rbs/definition_builder/ancestor_builder.rb +620 -0
- data/lib/rbs/definition_builder/method_builder.rb +254 -0
- data/lib/rbs/definition_builder.rb +845 -0
- data/lib/rbs/diff.rb +125 -0
- data/lib/rbs/environment/use_map.rb +77 -0
- data/lib/rbs/environment.rb +829 -0
- data/lib/rbs/environment_loader.rb +173 -0
- data/lib/rbs/environment_walker.rb +155 -0
- data/lib/rbs/errors.rb +645 -0
- data/lib/rbs/factory.rb +18 -0
- data/lib/rbs/file_finder.rb +28 -0
- data/lib/rbs/location_aux.rb +138 -0
- data/lib/rbs/locator.rb +243 -0
- data/lib/rbs/method_type.rb +143 -0
- data/lib/rbs/namespace.rb +125 -0
- data/lib/rbs/parser/lex_result.rb +15 -0
- data/lib/rbs/parser/token.rb +23 -0
- data/lib/rbs/parser_aux.rb +114 -0
- data/lib/rbs/prototype/helpers.rb +140 -0
- data/lib/rbs/prototype/node_usage.rb +99 -0
- data/lib/rbs/prototype/rb.rb +840 -0
- data/lib/rbs/prototype/rbi.rb +641 -0
- 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 +667 -0
- data/lib/rbs/repository.rb +127 -0
- data/lib/rbs/resolver/constant_resolver.rb +219 -0
- data/lib/rbs/resolver/type_name_resolver.rb +91 -0
- data/lib/rbs/sorter.rb +198 -0
- data/lib/rbs/substitution.rb +83 -0
- data/lib/rbs/subtractor.rb +201 -0
- data/lib/rbs/test/errors.rb +80 -0
- data/lib/rbs/test/guaranteed.rb +30 -0
- data/lib/rbs/test/hook.rb +212 -0
- data/lib/rbs/test/observer.rb +19 -0
- data/lib/rbs/test/setup.rb +84 -0
- data/lib/rbs/test/setup_helper.rb +50 -0
- data/lib/rbs/test/tester.rb +167 -0
- data/lib/rbs/test/type_check.rb +435 -0
- data/lib/rbs/test.rb +112 -0
- data/lib/rbs/type_alias_dependency.rb +100 -0
- data/lib/rbs/type_alias_regularity.rb +126 -0
- data/lib/rbs/type_name.rb +109 -0
- data/lib/rbs/types.rb +1596 -0
- data/lib/rbs/unit_test/convertibles.rb +176 -0
- data/lib/rbs/unit_test/spy.rb +138 -0
- data/lib/rbs/unit_test/type_assertions.rb +347 -0
- data/lib/rbs/unit_test/with_aliases.rb +143 -0
- data/lib/rbs/unit_test.rb +6 -0
- data/lib/rbs/validator.rb +186 -0
- data/lib/rbs/variance_calculator.rb +189 -0
- data/lib/rbs/vendorer.rb +71 -0
- data/lib/rbs/version.rb +5 -0
- data/lib/rbs/writer.rb +424 -0
- data/lib/rbs.rb +94 -0
- data/lib/rdoc/discover.rb +20 -0
- data/lib/rdoc_plugin/parser.rb +163 -0
- data/rbs-relaxed.gemspec +48 -0
- data/schema/annotation.json +14 -0
- data/schema/comment.json +26 -0
- data/schema/decls.json +326 -0
- data/schema/function.json +87 -0
- data/schema/location.json +56 -0
- data/schema/members.json +266 -0
- data/schema/methodType.json +50 -0
- data/schema/typeParam.json +36 -0
- data/schema/types.json +317 -0
- data/sig/ancestor_builder.rbs +163 -0
- data/sig/ancestor_graph.rbs +60 -0
- data/sig/annotate/annotations.rbs +102 -0
- data/sig/annotate/formatter.rbs +24 -0
- data/sig/annotate/rdoc_annotater.rbs +82 -0
- data/sig/annotate/rdoc_source.rbs +30 -0
- data/sig/annotation.rbs +27 -0
- data/sig/buffer.rbs +32 -0
- data/sig/builtin_names.rbs +44 -0
- 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 +87 -0
- data/sig/collection/cleaner.rbs +13 -0
- data/sig/collection/config/lockfile.rbs +74 -0
- data/sig/collection/config/lockfile_generator.rbs +66 -0
- data/sig/collection/config.rbs +46 -0
- data/sig/collection/installer.rbs +17 -0
- data/sig/collection/sources.rbs +214 -0
- data/sig/collection.rbs +4 -0
- data/sig/comment.rbs +26 -0
- data/sig/constant.rbs +21 -0
- data/sig/declarations.rbs +267 -0
- data/sig/definition.rbs +173 -0
- data/sig/definition_builder.rbs +165 -0
- data/sig/diff.rbs +28 -0
- data/sig/directives.rbs +77 -0
- data/sig/environment.rbs +279 -0
- data/sig/environment_loader.rbs +111 -0
- data/sig/environment_walker.rbs +65 -0
- data/sig/errors.rbs +405 -0
- data/sig/factory.rbs +5 -0
- data/sig/file_finder.rbs +28 -0
- data/sig/location.rbs +110 -0
- data/sig/locator.rbs +58 -0
- data/sig/manifest.yaml +7 -0
- data/sig/members.rbs +258 -0
- data/sig/method_builder.rbs +84 -0
- data/sig/method_types.rbs +58 -0
- data/sig/namespace.rbs +146 -0
- data/sig/parser.rbs +100 -0
- data/sig/prototype/helpers.rbs +27 -0
- data/sig/prototype/node_usage.rbs +20 -0
- data/sig/prototype/rb.rbs +96 -0
- data/sig/prototype/rbi.rbs +75 -0
- data/sig/prototype/runtime.rbs +182 -0
- data/sig/rbs.rbs +21 -0
- data/sig/rdoc/rbs.rbs +67 -0
- data/sig/repository.rbs +85 -0
- data/sig/resolver/constant_resolver.rbs +92 -0
- data/sig/resolver/context.rbs +34 -0
- data/sig/resolver/type_name_resolver.rbs +35 -0
- data/sig/shims/bundler.rbs +38 -0
- data/sig/shims/enumerable.rbs +5 -0
- data/sig/shims/rubygems.rbs +19 -0
- data/sig/sorter.rbs +41 -0
- data/sig/substitution.rbs +48 -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 +53 -0
- data/sig/type_alias_regularity.rbs +98 -0
- data/sig/type_param.rbs +110 -0
- data/sig/typename.rbs +79 -0
- data/sig/types.rbs +579 -0
- data/sig/unit_test/convertibles.rbs +154 -0
- data/sig/unit_test/spy.rbs +30 -0
- data/sig/unit_test/type_assertions.rbs +196 -0
- data/sig/unit_test/with_aliases.rbs +136 -0
- data/sig/use_map.rbs +35 -0
- data/sig/util.rbs +9 -0
- data/sig/validator.rbs +63 -0
- data/sig/variance_calculator.rbs +87 -0
- data/sig/vendorer.rbs +51 -0
- data/sig/version.rbs +3 -0
- data/sig/visitor.rbs +47 -0
- data/sig/writer.rbs +127 -0
- data/src/constants.c +153 -0
- data/src/ruby_objs.c +795 -0
- data/src/util/rbs_constant_pool.c +342 -0
- data/stdlib/abbrev/0/abbrev.rbs +66 -0
- data/stdlib/abbrev/0/array.rbs +26 -0
- data/stdlib/base64/0/base64.rbs +355 -0
- data/stdlib/benchmark/0/benchmark.rbs +452 -0
- data/stdlib/bigdecimal/0/big_decimal.rbs +1629 -0
- data/stdlib/bigdecimal-math/0/big_math.rbs +119 -0
- data/stdlib/bigdecimal-math/0/manifest.yaml +2 -0
- data/stdlib/cgi/0/core.rbs +1285 -0
- data/stdlib/cgi/0/manifest.yaml +3 -0
- data/stdlib/coverage/0/coverage.rbs +263 -0
- data/stdlib/csv/0/csv.rbs +3776 -0
- data/stdlib/csv/0/manifest.yaml +3 -0
- data/stdlib/date/0/date.rbs +1585 -0
- data/stdlib/date/0/date_time.rbs +616 -0
- data/stdlib/date/0/time.rbs +26 -0
- data/stdlib/dbm/0/dbm.rbs +421 -0
- 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 +343 -0
- data/stdlib/digest/0/digest.rbs +577 -0
- data/stdlib/erb/0/erb.rbs +532 -0
- data/stdlib/etc/0/etc.rbs +865 -0
- data/stdlib/fileutils/0/fileutils.rbs +1734 -0
- data/stdlib/find/0/find.rbs +49 -0
- data/stdlib/forwardable/0/forwardable.rbs +268 -0
- data/stdlib/io-console/0/io-console.rbs +414 -0
- data/stdlib/ipaddr/0/ipaddr.rbs +428 -0
- data/stdlib/json/0/json.rbs +1916 -0
- data/stdlib/kconv/0/kconv.rbs +166 -0
- data/stdlib/logger/0/formatter.rbs +45 -0
- data/stdlib/logger/0/log_device.rbs +100 -0
- data/stdlib/logger/0/logger.rbs +796 -0
- data/stdlib/logger/0/manifest.yaml +2 -0
- data/stdlib/logger/0/period.rbs +17 -0
- data/stdlib/logger/0/severity.rbs +34 -0
- data/stdlib/minitest/0/kernel.rbs +42 -0
- data/stdlib/minitest/0/minitest/abstract_reporter.rbs +52 -0
- data/stdlib/minitest/0/minitest/assertion.rbs +17 -0
- data/stdlib/minitest/0/minitest/assertions.rbs +590 -0
- data/stdlib/minitest/0/minitest/backtrace_filter.rbs +23 -0
- data/stdlib/minitest/0/minitest/bench_spec.rbs +102 -0
- data/stdlib/minitest/0/minitest/benchmark.rbs +259 -0
- data/stdlib/minitest/0/minitest/composite_reporter.rbs +25 -0
- 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/expectation.rbs +2 -0
- data/stdlib/minitest/0/minitest/expectations.rbs +21 -0
- data/stdlib/minitest/0/minitest/guard.rbs +64 -0
- data/stdlib/minitest/0/minitest/mock.rbs +64 -0
- data/stdlib/minitest/0/minitest/parallel/executor.rbs +46 -0
- data/stdlib/minitest/0/minitest/parallel/test/class_methods.rbs +5 -0
- data/stdlib/minitest/0/minitest/parallel/test.rbs +3 -0
- data/stdlib/minitest/0/minitest/parallel.rbs +2 -0
- data/stdlib/minitest/0/minitest/pride_io.rbs +62 -0
- data/stdlib/minitest/0/minitest/pride_lol.rbs +19 -0
- data/stdlib/minitest/0/minitest/progress_reporter.rbs +11 -0
- data/stdlib/minitest/0/minitest/reportable.rbs +53 -0
- data/stdlib/minitest/0/minitest/reporter.rbs +5 -0
- data/stdlib/minitest/0/minitest/result.rbs +28 -0
- data/stdlib/minitest/0/minitest/runnable.rbs +163 -0
- data/stdlib/minitest/0/minitest/skip.rbs +6 -0
- data/stdlib/minitest/0/minitest/spec/dsl/instance_methods.rbs +48 -0
- data/stdlib/minitest/0/minitest/spec/dsl.rbs +129 -0
- data/stdlib/minitest/0/minitest/spec.rbs +11 -0
- data/stdlib/minitest/0/minitest/statistics_reporter.rbs +81 -0
- data/stdlib/minitest/0/minitest/summary_reporter.rbs +18 -0
- data/stdlib/minitest/0/minitest/test/lifecycle_hooks.rbs +92 -0
- data/stdlib/minitest/0/minitest/test.rbs +69 -0
- data/stdlib/minitest/0/minitest/unexpected_error.rbs +12 -0
- data/stdlib/minitest/0/minitest/unexpected_warning.rbs +6 -0
- data/stdlib/minitest/0/minitest/unit/test_case.rbs +3 -0
- data/stdlib/minitest/0/minitest/unit.rbs +4 -0
- data/stdlib/minitest/0/minitest.rbs +115 -0
- data/stdlib/monitor/0/monitor.rbs +363 -0
- data/stdlib/mutex_m/0/mutex_m.rbs +104 -0
- data/stdlib/net-http/0/manifest.yaml +3 -0
- data/stdlib/net-http/0/net-http.rbs +5552 -0
- 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 +402 -0
- data/stdlib/objspace/0/objspace.rbs +487 -0
- 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 +3 -0
- data/stdlib/openssl/0/openssl.rbs +12113 -0
- data/stdlib/optparse/0/optparse.rbs +1725 -0
- data/stdlib/pathname/0/pathname.rbs +1406 -0
- data/stdlib/pp/0/manifest.yaml +2 -0
- data/stdlib/pp/0/pp.rbs +300 -0
- data/stdlib/prettyprint/0/prettyprint.rbs +383 -0
- data/stdlib/pstore/0/pstore.rbs +603 -0
- data/stdlib/psych/0/core_ext.rbs +12 -0
- data/stdlib/psych/0/dbm.rbs +237 -0
- data/stdlib/psych/0/manifest.yaml +3 -0
- data/stdlib/psych/0/psych.rbs +402 -0
- data/stdlib/psych/0/store.rbs +59 -0
- data/stdlib/pty/0/pty.rbs +237 -0
- 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 +391 -0
- 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/manifest.yaml +3 -0
- data/stdlib/resolv/0/resolv.rbs +1830 -0
- data/stdlib/ripper/0/ripper.rbs +1648 -0
- data/stdlib/securerandom/0/securerandom.rbs +62 -0
- data/stdlib/shellwords/0/shellwords.rbs +229 -0
- data/stdlib/singleton/0/singleton.rbs +131 -0
- data/stdlib/socket/0/addrinfo.rbs +666 -0
- data/stdlib/socket/0/basic_socket.rbs +590 -0
- data/stdlib/socket/0/constants.rbs +2295 -0
- data/stdlib/socket/0/ip_socket.rbs +92 -0
- data/stdlib/socket/0/socket.rbs +4157 -0
- data/stdlib/socket/0/socket_error.rbs +5 -0
- data/stdlib/socket/0/tcp_server.rbs +192 -0
- data/stdlib/socket/0/tcp_socket.rbs +79 -0
- data/stdlib/socket/0/udp_socket.rbs +133 -0
- data/stdlib/socket/0/unix_server.rbs +169 -0
- data/stdlib/socket/0/unix_socket.rbs +172 -0
- data/stdlib/stringio/0/stringio.rbs +567 -0
- data/stdlib/strscan/0/string_scanner.rbs +1627 -0
- data/stdlib/tempfile/0/tempfile.rbs +479 -0
- data/stdlib/time/0/time.rbs +432 -0
- data/stdlib/timeout/0/timeout.rbs +81 -0
- data/stdlib/tmpdir/0/tmpdir.rbs +69 -0
- data/stdlib/tsort/0/cyclic.rbs +5 -0
- data/stdlib/tsort/0/interfaces.rbs +20 -0
- data/stdlib/tsort/0/tsort.rbs +409 -0
- data/stdlib/uri/0/common.rbs +582 -0
- data/stdlib/uri/0/file.rbs +118 -0
- data/stdlib/uri/0/ftp.rbs +13 -0
- data/stdlib/uri/0/generic.rbs +1108 -0
- data/stdlib/uri/0/http.rbs +104 -0
- data/stdlib/uri/0/https.rbs +14 -0
- data/stdlib/uri/0/ldap.rbs +230 -0
- data/stdlib/uri/0/ldaps.rbs +14 -0
- data/stdlib/uri/0/mailto.rbs +92 -0
- data/stdlib/uri/0/rfc2396_parser.rbs +189 -0
- data/stdlib/uri/0/rfc3986_parser.rbs +2 -0
- data/stdlib/uri/0/ws.rbs +13 -0
- data/stdlib/uri/0/wss.rbs +9 -0
- data/stdlib/yaml/0/manifest.yaml +2 -0
- data/stdlib/yaml/0/yaml.rbs +1 -0
- 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 +449 -0
- data/stdlib/zlib/0/zstream.rbs +200 -0
- metadata +532 -0
@@ -0,0 +1,237 @@
|
|
1
|
+
%a{annotate:rdoc:skip}
|
2
|
+
module Psych
|
3
|
+
# <!-- rdoc-file=lib/yaml/dbm.rb -->
|
4
|
+
# YAML + DBM = YDBM
|
5
|
+
#
|
6
|
+
# YAML::DBM provides the same interface as ::DBM.
|
7
|
+
#
|
8
|
+
# However, while DBM only allows strings for both keys and values, this library
|
9
|
+
# allows one to use most Ruby objects for values by first converting them to
|
10
|
+
# YAML. Keys must be strings.
|
11
|
+
#
|
12
|
+
# Conversion to and from YAML is performed automatically.
|
13
|
+
#
|
14
|
+
# See the documentation for ::DBM and ::YAML for more information.
|
15
|
+
#
|
16
|
+
class DBM < ::DBM
|
17
|
+
VERSION: ::String
|
18
|
+
|
19
|
+
# <!--
|
20
|
+
# rdoc-file=lib/yaml/dbm.rb
|
21
|
+
# - ydbm[key] -> value
|
22
|
+
# -->
|
23
|
+
# Return value associated with `key` from database.
|
24
|
+
#
|
25
|
+
# Returns `nil` if there is no such `key`.
|
26
|
+
#
|
27
|
+
# See #fetch for more information.
|
28
|
+
#
|
29
|
+
def []: (String key) -> untyped
|
30
|
+
|
31
|
+
# <!--
|
32
|
+
# rdoc-file=lib/yaml/dbm.rb
|
33
|
+
# - ydbm[key] = value
|
34
|
+
# -->
|
35
|
+
# Set `key` to `value` in database.
|
36
|
+
#
|
37
|
+
# `value` will be converted to YAML before storage.
|
38
|
+
#
|
39
|
+
# See #store for more information.
|
40
|
+
#
|
41
|
+
def []=: (String key, untyped val) -> untyped
|
42
|
+
|
43
|
+
# <!--
|
44
|
+
# rdoc-file=lib/yaml/dbm.rb
|
45
|
+
# - ydbm.fetch( key, ifnone = nil )
|
46
|
+
# - ydbm.fetch( key ) { |key| ... }
|
47
|
+
# -->
|
48
|
+
# Return value associated with `key`.
|
49
|
+
#
|
50
|
+
# If there is no value for `key` and no block is given, returns `ifnone`.
|
51
|
+
#
|
52
|
+
# Otherwise, calls block passing in the given `key`.
|
53
|
+
#
|
54
|
+
# See ::DBM#fetch for more information.
|
55
|
+
#
|
56
|
+
def fetch: (String keystr, ?untyped? ifnone) { (untyped) -> untyped } -> untyped
|
57
|
+
|
58
|
+
# <!--
|
59
|
+
# rdoc-file=lib/yaml/dbm.rb
|
60
|
+
# - index( keystr )
|
61
|
+
# -->
|
62
|
+
# Deprecated, used YAML::DBM#key instead.
|
63
|
+
# ---
|
64
|
+
# Note: YAML::DBM#index makes warning from internal of ::DBM#index. It says
|
65
|
+
# 'DBM#index is deprecated; use DBM#key', but DBM#key behaves not same as
|
66
|
+
# DBM#index.
|
67
|
+
#
|
68
|
+
def index: (String keystr) -> untyped
|
69
|
+
|
70
|
+
# <!--
|
71
|
+
# rdoc-file=lib/yaml/dbm.rb
|
72
|
+
# - ydbm.key(value) -> string
|
73
|
+
# -->
|
74
|
+
# Returns the key for the specified value.
|
75
|
+
#
|
76
|
+
def key: (String keystr) -> String
|
77
|
+
|
78
|
+
# <!--
|
79
|
+
# rdoc-file=lib/yaml/dbm.rb
|
80
|
+
# - ydbm.values_at(*keys)
|
81
|
+
# -->
|
82
|
+
# Returns an array containing the values associated with the given keys.
|
83
|
+
#
|
84
|
+
def values_at: (*untyped keys) -> Array[untyped]
|
85
|
+
|
86
|
+
# <!--
|
87
|
+
# rdoc-file=lib/yaml/dbm.rb
|
88
|
+
# - ydbm.delete(key)
|
89
|
+
# -->
|
90
|
+
# Deletes value from database associated with `key`.
|
91
|
+
#
|
92
|
+
# Returns value or `nil`.
|
93
|
+
#
|
94
|
+
def delete: (String key) -> untyped
|
95
|
+
|
96
|
+
# <!--
|
97
|
+
# rdoc-file=lib/yaml/dbm.rb
|
98
|
+
# - ydbm.delete_if { |key, value| ... }
|
99
|
+
# -->
|
100
|
+
# Calls the given block once for each `key`, `value` pair in the database.
|
101
|
+
# Deletes all entries for which the block returns true.
|
102
|
+
#
|
103
|
+
# Returns `self`.
|
104
|
+
#
|
105
|
+
def delete_if: () { (untyped, untyped) -> untyped } -> untyped
|
106
|
+
|
107
|
+
# <!--
|
108
|
+
# rdoc-file=lib/yaml/dbm.rb
|
109
|
+
# - ydbm.reject { |key, value| ... }
|
110
|
+
# -->
|
111
|
+
# Converts the contents of the database to an in-memory Hash, then calls
|
112
|
+
# Hash#reject with the specified code block, returning a new Hash.
|
113
|
+
#
|
114
|
+
def reject: () { (untyped, untyped) -> untyped } -> Hash[untyped, untyped]
|
115
|
+
|
116
|
+
# <!--
|
117
|
+
# rdoc-file=lib/yaml/dbm.rb
|
118
|
+
# - ydbm.each_pair { |key, value| ... }
|
119
|
+
# -->
|
120
|
+
# Calls the given block once for each `key`, `value` pair in the database.
|
121
|
+
#
|
122
|
+
# Returns `self`.
|
123
|
+
#
|
124
|
+
def each_pair: () { (untyped, untyped) -> untyped } -> untyped
|
125
|
+
|
126
|
+
# <!--
|
127
|
+
# rdoc-file=lib/yaml/dbm.rb
|
128
|
+
# - ydbm.each_value { |value| ... }
|
129
|
+
# -->
|
130
|
+
# Calls the given block for each value in database.
|
131
|
+
#
|
132
|
+
# Returns `self`.
|
133
|
+
#
|
134
|
+
def each_value: () { (untyped) -> untyped } -> untyped
|
135
|
+
|
136
|
+
# <!--
|
137
|
+
# rdoc-file=lib/yaml/dbm.rb
|
138
|
+
# - ydbm.values
|
139
|
+
# -->
|
140
|
+
# Returns an array of values from the database.
|
141
|
+
#
|
142
|
+
def values: () -> untyped
|
143
|
+
|
144
|
+
# <!--
|
145
|
+
# rdoc-file=lib/yaml/dbm.rb
|
146
|
+
# - ydbm.has_value?(value)
|
147
|
+
# -->
|
148
|
+
# Returns true if specified `value` is found in the database.
|
149
|
+
#
|
150
|
+
def has_value?: (untyped val) -> (::TrueClass | ::FalseClass)
|
151
|
+
|
152
|
+
# <!--
|
153
|
+
# rdoc-file=lib/yaml/dbm.rb
|
154
|
+
# - ydbm.invert -> hash
|
155
|
+
# -->
|
156
|
+
# Returns a Hash (not a DBM database) created by using each value in the
|
157
|
+
# database as a key, with the corresponding key as its value.
|
158
|
+
#
|
159
|
+
# Note that all values in the hash will be Strings, but the keys will be actual
|
160
|
+
# objects.
|
161
|
+
#
|
162
|
+
def invert: () -> Hash[untyped, untyped]
|
163
|
+
|
164
|
+
# <!--
|
165
|
+
# rdoc-file=lib/yaml/dbm.rb
|
166
|
+
# - ydbm.replace(hash) -> ydbm
|
167
|
+
# -->
|
168
|
+
# Replaces the contents of the database with the contents of the specified
|
169
|
+
# object. Takes any object which implements the each_pair method, including Hash
|
170
|
+
# and DBM objects.
|
171
|
+
#
|
172
|
+
def replace: (Hash[untyped, untyped] | DBM hsh) -> Psych::DBM
|
173
|
+
|
174
|
+
# <!--
|
175
|
+
# rdoc-file=lib/yaml/dbm.rb
|
176
|
+
# - ydbm.shift -> [key, value]
|
177
|
+
# -->
|
178
|
+
# Removes a [key, value] pair from the database, and returns it. If the database
|
179
|
+
# is empty, returns `nil`.
|
180
|
+
#
|
181
|
+
# The order in which values are removed/returned is not guaranteed.
|
182
|
+
#
|
183
|
+
def shift: () -> (Array[untyped] | untyped)
|
184
|
+
|
185
|
+
# <!--
|
186
|
+
# rdoc-file=lib/yaml/dbm.rb
|
187
|
+
# - ydbm.select { |key, value| ... }
|
188
|
+
# - ydbm.select(*keys)
|
189
|
+
# -->
|
190
|
+
# If a block is provided, returns a new array containing [key, value] pairs for
|
191
|
+
# which the block returns true.
|
192
|
+
#
|
193
|
+
# Otherwise, same as #values_at
|
194
|
+
#
|
195
|
+
def select: (*untyped keys) { (untyped, untyped) -> untyped } -> Array[untyped]
|
196
|
+
|
197
|
+
# <!--
|
198
|
+
# rdoc-file=lib/yaml/dbm.rb
|
199
|
+
# - ydbm.store(key, value) -> value
|
200
|
+
# -->
|
201
|
+
# Stores `value` in database with `key` as the index. `value` is converted to
|
202
|
+
# YAML before being stored.
|
203
|
+
#
|
204
|
+
# Returns `value`
|
205
|
+
#
|
206
|
+
def store: (String key, untyped val) -> untyped
|
207
|
+
|
208
|
+
# <!--
|
209
|
+
# rdoc-file=lib/yaml/dbm.rb
|
210
|
+
# - ydbm.update(hash) -> ydbm
|
211
|
+
# -->
|
212
|
+
# Updates the database with multiple values from the specified object. Takes any
|
213
|
+
# object which implements the each_pair method, including Hash and DBM objects.
|
214
|
+
#
|
215
|
+
# Returns `self`.
|
216
|
+
#
|
217
|
+
def update: (Hash[untyped, untyped]) -> Psych::DBM
|
218
|
+
|
219
|
+
# <!--
|
220
|
+
# rdoc-file=lib/yaml/dbm.rb
|
221
|
+
# - ydbm.to_a -> array
|
222
|
+
# -->
|
223
|
+
# Converts the contents of the database to an array of [key, value] arrays, and
|
224
|
+
# returns it.
|
225
|
+
#
|
226
|
+
def to_a: () -> Array[untyped]
|
227
|
+
|
228
|
+
# <!--
|
229
|
+
# rdoc-file=lib/yaml/dbm.rb
|
230
|
+
# - ydbm.to_hash -> hash
|
231
|
+
# -->
|
232
|
+
# Converts the contents of the database to an in-memory Hash object, and returns
|
233
|
+
# it.
|
234
|
+
#
|
235
|
+
def to_hash: () -> Hash[untyped, untyped]
|
236
|
+
end
|
237
|
+
end
|
@@ -0,0 +1,402 @@
|
|
1
|
+
# <!-- rdoc-file=ext/psych/lib/psych.rb -->
|
2
|
+
# # Overview
|
3
|
+
#
|
4
|
+
# Psych is a YAML parser and emitter. Psych leverages libyaml [Home page:
|
5
|
+
# https://pyyaml.org/wiki/LibYAML] or [git repo:
|
6
|
+
# https://github.com/yaml/libyaml] for its YAML parsing and emitting
|
7
|
+
# capabilities. In addition to wrapping libyaml, Psych also knows how to
|
8
|
+
# serialize and de-serialize most Ruby objects to and from the YAML format.
|
9
|
+
#
|
10
|
+
# # I NEED TO PARSE OR EMIT YAML RIGHT NOW!
|
11
|
+
#
|
12
|
+
# # Parse some YAML
|
13
|
+
# Psych.load("--- foo") # => "foo"
|
14
|
+
#
|
15
|
+
# # Emit some YAML
|
16
|
+
# Psych.dump("foo") # => "--- foo\n...\n"
|
17
|
+
# { :a => 'b'}.to_yaml # => "---\n:a: b\n"
|
18
|
+
#
|
19
|
+
# Got more time on your hands? Keep on reading!
|
20
|
+
#
|
21
|
+
# ## YAML Parsing
|
22
|
+
#
|
23
|
+
# Psych provides a range of interfaces for parsing a YAML document ranging from
|
24
|
+
# low level to high level, depending on your parsing needs. At the lowest
|
25
|
+
# level, is an event based parser. Mid level is access to the raw YAML AST, and
|
26
|
+
# at the highest level is the ability to unmarshal YAML to Ruby objects.
|
27
|
+
#
|
28
|
+
# ## YAML Emitting
|
29
|
+
#
|
30
|
+
# Psych provides a range of interfaces ranging from low to high level for
|
31
|
+
# producing YAML documents. Very similar to the YAML parsing interfaces, Psych
|
32
|
+
# provides at the lowest level, an event based system, mid-level is building a
|
33
|
+
# YAML AST, and the highest level is converting a Ruby object straight to a YAML
|
34
|
+
# document.
|
35
|
+
#
|
36
|
+
# ## High-level API
|
37
|
+
#
|
38
|
+
# ### Parsing
|
39
|
+
#
|
40
|
+
# The high level YAML parser provided by Psych simply takes YAML as input and
|
41
|
+
# returns a Ruby data structure. For information on using the high level parser
|
42
|
+
# see Psych.load
|
43
|
+
#
|
44
|
+
# #### Reading from a string
|
45
|
+
#
|
46
|
+
# Psych.safe_load("--- a") # => 'a'
|
47
|
+
# Psych.safe_load("---\n - a\n - b") # => ['a', 'b']
|
48
|
+
# # From a trusted string:
|
49
|
+
# Psych.load("--- !ruby/range\nbegin: 0\nend: 42\nexcl: false\n") # => 0..42
|
50
|
+
#
|
51
|
+
# #### Reading from a file
|
52
|
+
#
|
53
|
+
# Psych.safe_load_file("data.yml", permitted_classes: [Date])
|
54
|
+
# Psych.load_file("trusted_database.yml")
|
55
|
+
#
|
56
|
+
# #### Exception handling
|
57
|
+
#
|
58
|
+
# begin
|
59
|
+
# # The second argument changes only the exception contents
|
60
|
+
# Psych.parse("--- `", "file.txt")
|
61
|
+
# rescue Psych::SyntaxError => ex
|
62
|
+
# ex.file # => 'file.txt'
|
63
|
+
# ex.message # => "(file.txt): found character that cannot start any token"
|
64
|
+
# end
|
65
|
+
#
|
66
|
+
# ### Emitting
|
67
|
+
#
|
68
|
+
# The high level emitter has the easiest interface. Psych simply takes a Ruby
|
69
|
+
# data structure and converts it to a YAML document. See Psych.dump for more
|
70
|
+
# information on dumping a Ruby data structure.
|
71
|
+
#
|
72
|
+
# #### Writing to a string
|
73
|
+
#
|
74
|
+
# # Dump an array, get back a YAML string
|
75
|
+
# Psych.dump(['a', 'b']) # => "---\n- a\n- b\n"
|
76
|
+
#
|
77
|
+
# # Dump an array to an IO object
|
78
|
+
# Psych.dump(['a', 'b'], StringIO.new) # => #<StringIO:0x000001009d0890>
|
79
|
+
#
|
80
|
+
# # Dump an array with indentation set
|
81
|
+
# Psych.dump(['a', ['b']], :indentation => 3) # => "---\n- a\n- - b\n"
|
82
|
+
#
|
83
|
+
# # Dump an array to an IO with indentation set
|
84
|
+
# Psych.dump(['a', ['b']], StringIO.new, :indentation => 3)
|
85
|
+
#
|
86
|
+
# #### Writing to a file
|
87
|
+
#
|
88
|
+
# Currently there is no direct API for dumping Ruby structure to file:
|
89
|
+
#
|
90
|
+
# File.open('database.yml', 'w') do |file|
|
91
|
+
# file.write(Psych.dump(['a', 'b']))
|
92
|
+
# end
|
93
|
+
#
|
94
|
+
# ## Mid-level API
|
95
|
+
#
|
96
|
+
# ### Parsing
|
97
|
+
#
|
98
|
+
# Psych provides access to an AST produced from parsing a YAML document. This
|
99
|
+
# tree is built using the Psych::Parser and Psych::TreeBuilder. The AST can be
|
100
|
+
# examined and manipulated freely. Please see Psych::parse_stream,
|
101
|
+
# Psych::Nodes, and Psych::Nodes::Node for more information on dealing with YAML
|
102
|
+
# syntax trees.
|
103
|
+
#
|
104
|
+
# #### Reading from a string
|
105
|
+
#
|
106
|
+
# # Returns Psych::Nodes::Stream
|
107
|
+
# Psych.parse_stream("---\n - a\n - b")
|
108
|
+
#
|
109
|
+
# # Returns Psych::Nodes::Document
|
110
|
+
# Psych.parse("---\n - a\n - b")
|
111
|
+
#
|
112
|
+
# #### Reading from a file
|
113
|
+
#
|
114
|
+
# # Returns Psych::Nodes::Stream
|
115
|
+
# Psych.parse_stream(File.read('database.yml'))
|
116
|
+
#
|
117
|
+
# # Returns Psych::Nodes::Document
|
118
|
+
# Psych.parse_file('database.yml')
|
119
|
+
#
|
120
|
+
# #### Exception handling
|
121
|
+
#
|
122
|
+
# begin
|
123
|
+
# # The second argument changes only the exception contents
|
124
|
+
# Psych.parse("--- `", "file.txt")
|
125
|
+
# rescue Psych::SyntaxError => ex
|
126
|
+
# ex.file # => 'file.txt'
|
127
|
+
# ex.message # => "(file.txt): found character that cannot start any token"
|
128
|
+
# end
|
129
|
+
#
|
130
|
+
# ### Emitting
|
131
|
+
#
|
132
|
+
# At the mid level is building an AST. This AST is exactly the same as the AST
|
133
|
+
# used when parsing a YAML document. Users can build an AST by hand and the AST
|
134
|
+
# knows how to emit itself as a YAML document. See Psych::Nodes,
|
135
|
+
# Psych::Nodes::Node, and Psych::TreeBuilder for more information on building a
|
136
|
+
# YAML AST.
|
137
|
+
#
|
138
|
+
# #### Writing to a string
|
139
|
+
#
|
140
|
+
# # We need Psych::Nodes::Stream (not Psych::Nodes::Document)
|
141
|
+
# stream = Psych.parse_stream("---\n - a\n - b")
|
142
|
+
#
|
143
|
+
# stream.to_yaml # => "---\n- a\n- b\n"
|
144
|
+
#
|
145
|
+
# #### Writing to a file
|
146
|
+
#
|
147
|
+
# # We need Psych::Nodes::Stream (not Psych::Nodes::Document)
|
148
|
+
# stream = Psych.parse_stream(File.read('database.yml'))
|
149
|
+
#
|
150
|
+
# File.open('database.yml', 'w') do |file|
|
151
|
+
# file.write(stream.to_yaml)
|
152
|
+
# end
|
153
|
+
#
|
154
|
+
# ## Low-level API
|
155
|
+
#
|
156
|
+
# ### Parsing
|
157
|
+
#
|
158
|
+
# The lowest level parser should be used when the YAML input is already known,
|
159
|
+
# and the developer does not want to pay the price of building an AST or
|
160
|
+
# automatic detection and conversion to Ruby objects. See Psych::Parser for
|
161
|
+
# more information on using the event based parser.
|
162
|
+
#
|
163
|
+
# #### Reading to Psych::Nodes::Stream structure
|
164
|
+
#
|
165
|
+
# parser = Psych::Parser.new(TreeBuilder.new) # => #<Psych::Parser>
|
166
|
+
# parser = Psych.parser # it's an alias for the above
|
167
|
+
#
|
168
|
+
# parser.parse("---\n - a\n - b") # => #<Psych::Parser>
|
169
|
+
# parser.handler # => #<Psych::TreeBuilder>
|
170
|
+
# parser.handler.root # => #<Psych::Nodes::Stream>
|
171
|
+
#
|
172
|
+
# #### Receiving an events stream
|
173
|
+
#
|
174
|
+
# recorder = Psych::Handlers::Recorder.new
|
175
|
+
# parser = Psych::Parser.new(recorder)
|
176
|
+
#
|
177
|
+
# parser.parse("---\n - a\n - b")
|
178
|
+
# recorder.events # => [list of [event, args] lists]
|
179
|
+
# # event is one of: Psych::Handler::EVENTS
|
180
|
+
# # args are the arguments passed to the event
|
181
|
+
#
|
182
|
+
# ### Emitting
|
183
|
+
#
|
184
|
+
# The lowest level emitter is an event based system. Events are sent to a
|
185
|
+
# Psych::Emitter object. That object knows how to convert the events to a YAML
|
186
|
+
# document. This interface should be used when document format is known in
|
187
|
+
# advance or speed is a concern. See Psych::Emitter for more information.
|
188
|
+
#
|
189
|
+
# #### Writing to a Ruby structure
|
190
|
+
#
|
191
|
+
# Psych.parser.parse("--- a") # => #<Psych::Parser>
|
192
|
+
#
|
193
|
+
# parser.handler.first # => #<Psych::Nodes::Stream>
|
194
|
+
# parser.handler.first.to_ruby # => ["a"]
|
195
|
+
#
|
196
|
+
# parser.handler.root.first # => #<Psych::Nodes::Document>
|
197
|
+
# parser.handler.root.first.to_ruby # => "a"
|
198
|
+
#
|
199
|
+
# # You can instantiate an Emitter manually
|
200
|
+
# Psych::Visitors::ToRuby.new.accept(parser.handler.root.first)
|
201
|
+
# # => "a"
|
202
|
+
#
|
203
|
+
module Psych
|
204
|
+
# <!--
|
205
|
+
# rdoc-file=ext/psych/lib/psych.rb
|
206
|
+
# - Psych.dump(o) -> string of yaml
|
207
|
+
# - Psych.dump(o, options) -> string of yaml
|
208
|
+
# - Psych.dump(o, io) -> io object passed in
|
209
|
+
# - Psych.dump(o, io, options) -> io object passed in
|
210
|
+
# -->
|
211
|
+
# Dump Ruby object `o` to a YAML string. Optional `options` may be passed in to
|
212
|
+
# control the output format. If an IO object is passed in, the YAML will be
|
213
|
+
# dumped to that IO object.
|
214
|
+
#
|
215
|
+
# Currently supported options are:
|
216
|
+
#
|
217
|
+
# `:indentation`
|
218
|
+
# : Number of space characters used to indent. Acceptable value should be in
|
219
|
+
# `0..9` range, otherwise option is ignored.
|
220
|
+
#
|
221
|
+
# Default: `2`.
|
222
|
+
#
|
223
|
+
# `:line_width`
|
224
|
+
# : Max character to wrap line at. For unlimited line width use `-1`.
|
225
|
+
#
|
226
|
+
# Default: `0` (meaning "wrap at 81").
|
227
|
+
#
|
228
|
+
# `:canonical`
|
229
|
+
# : Write "canonical" YAML form (very verbose, yet strictly formal).
|
230
|
+
#
|
231
|
+
# Default: `false`.
|
232
|
+
#
|
233
|
+
# `:header`
|
234
|
+
# : Write `%YAML [version]` at the beginning of document.
|
235
|
+
#
|
236
|
+
# Default: `false`.
|
237
|
+
#
|
238
|
+
#
|
239
|
+
# `:stringify_names`
|
240
|
+
# : Dump symbol keys in Hash objects as string.
|
241
|
+
#
|
242
|
+
# Default: `false`.
|
243
|
+
#
|
244
|
+
#
|
245
|
+
# Example:
|
246
|
+
#
|
247
|
+
# # Dump an array, get back a YAML string
|
248
|
+
# Psych.dump(['a', 'b']) # => "---\n- a\n- b\n"
|
249
|
+
#
|
250
|
+
# # Dump an array to an IO object
|
251
|
+
# Psych.dump(['a', 'b'], StringIO.new) # => #<StringIO:0x000001009d0890>
|
252
|
+
#
|
253
|
+
# # Dump an array with indentation set
|
254
|
+
# Psych.dump(['a', ['b']], indentation: 3) # => "---\n- a\n- - b\n"
|
255
|
+
#
|
256
|
+
# # Dump an array to an IO with indentation set
|
257
|
+
# Psych.dump(['a', ['b']], StringIO.new, indentation: 3)
|
258
|
+
#
|
259
|
+
# # Dump hash with symbol keys as string
|
260
|
+
# Psych.dump({a: "b"}, stringify_names: true) # => "---\na: b\n"
|
261
|
+
#
|
262
|
+
%a{annotate:rdoc:copy:Psych.dump}
|
263
|
+
def self.dump: (untyped o, ?indentation: Integer, ?line_width: Integer, ?canonical: bool, ?header: bool) -> String
|
264
|
+
| [IO] (untyped o, IO, ?indentation: Integer, ?line_width: Integer, ?canonical: bool, ?header: bool) -> IO
|
265
|
+
|
266
|
+
# <!--
|
267
|
+
# rdoc-file=ext/psych/lib/psych.rb
|
268
|
+
# - load(yaml, permitted_classes: [Symbol], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false)
|
269
|
+
# -->
|
270
|
+
# Load `yaml` in to a Ruby data structure. If multiple documents are provided,
|
271
|
+
# the object contained in the first document will be returned. `filename` will
|
272
|
+
# be used in the exception message if any exception is raised while parsing. If
|
273
|
+
# `yaml` is empty, it returns the specified `fallback` return value, which
|
274
|
+
# defaults to `nil`.
|
275
|
+
#
|
276
|
+
# Raises a Psych::SyntaxError when a YAML syntax error is detected.
|
277
|
+
#
|
278
|
+
# Example:
|
279
|
+
#
|
280
|
+
# Psych.load("--- a") # => 'a'
|
281
|
+
# Psych.load("---\n - a\n - b") # => ['a', 'b']
|
282
|
+
#
|
283
|
+
# begin
|
284
|
+
# Psych.load("--- `", filename: "file.txt")
|
285
|
+
# rescue Psych::SyntaxError => ex
|
286
|
+
# ex.file # => 'file.txt'
|
287
|
+
# ex.message # => "(file.txt): found character that cannot start any token"
|
288
|
+
# end
|
289
|
+
#
|
290
|
+
# When the optional `symbolize_names` keyword argument is set to a true value,
|
291
|
+
# returns symbols for keys in Hash objects (default: strings).
|
292
|
+
#
|
293
|
+
# Psych.load("---\n foo: bar") # => {"foo"=>"bar"}
|
294
|
+
# Psych.load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
|
295
|
+
#
|
296
|
+
# Raises a TypeError when `yaml` parameter is NilClass. This method is similar
|
297
|
+
# to `safe_load` except that `Symbol` objects are allowed by default.
|
298
|
+
#
|
299
|
+
%a{annotate:rdoc:copy:Psych.load}
|
300
|
+
def self.load: (String yaml, ?filename: String | _ToStr | _ToS?, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
|
301
|
+
|
302
|
+
# <!--
|
303
|
+
# rdoc-file=ext/psych/lib/psych.rb
|
304
|
+
# - load_file(filename, **kwargs)
|
305
|
+
# -->
|
306
|
+
# Loads the document contained in `filename`. Returns the yaml contained in
|
307
|
+
# `filename` as a Ruby object, or if the file is empty, it returns the specified
|
308
|
+
# `fallback` return value, which defaults to `nil`. See load for options.
|
309
|
+
#
|
310
|
+
%a{annotate:rdoc:copy:Psych.load_file}
|
311
|
+
def self.load_file: (string | _ToPath, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
|
312
|
+
|
313
|
+
# <!--
|
314
|
+
# rdoc-file=ext/psych/lib/psych.rb
|
315
|
+
# - safe_load(yaml, permitted_classes: [], permitted_symbols: [], aliases: false, filename: nil, fallback: nil, symbolize_names: false, freeze: false, strict_integer: false)
|
316
|
+
# -->
|
317
|
+
# Safely load the yaml string in `yaml`. By default, only the following classes
|
318
|
+
# are allowed to be deserialized:
|
319
|
+
#
|
320
|
+
# * TrueClass
|
321
|
+
# * FalseClass
|
322
|
+
# * NilClass
|
323
|
+
# * Integer
|
324
|
+
# * Float
|
325
|
+
# * String
|
326
|
+
# * Array
|
327
|
+
# * Hash
|
328
|
+
#
|
329
|
+
# Recursive data structures are not allowed by default. Arbitrary classes can
|
330
|
+
# be allowed by adding those classes to the `permitted_classes` keyword
|
331
|
+
# argument. They are additive. For example, to allow Date deserialization:
|
332
|
+
#
|
333
|
+
# Psych.safe_load(yaml, permitted_classes: [Date])
|
334
|
+
#
|
335
|
+
# Now the Date class can be loaded in addition to the classes listed above.
|
336
|
+
#
|
337
|
+
# Aliases can be explicitly allowed by changing the `aliases` keyword argument.
|
338
|
+
# For example:
|
339
|
+
#
|
340
|
+
# x = []
|
341
|
+
# x << x
|
342
|
+
# yaml = Psych.dump x
|
343
|
+
# Psych.safe_load yaml # => raises an exception
|
344
|
+
# Psych.safe_load yaml, aliases: true # => loads the aliases
|
345
|
+
#
|
346
|
+
# A Psych::DisallowedClass exception will be raised if the yaml contains a class
|
347
|
+
# that isn't in the `permitted_classes` list.
|
348
|
+
#
|
349
|
+
# A Psych::AliasesNotEnabled exception will be raised if the yaml contains
|
350
|
+
# aliases but the `aliases` keyword argument is set to false.
|
351
|
+
#
|
352
|
+
# `filename` will be used in the exception message if any exception is raised
|
353
|
+
# while parsing.
|
354
|
+
#
|
355
|
+
# When the optional `symbolize_names` keyword argument is set to a true value,
|
356
|
+
# returns symbols for keys in Hash objects (default: strings).
|
357
|
+
#
|
358
|
+
# Psych.safe_load("---\n foo: bar") # => {"foo"=>"bar"}
|
359
|
+
# Psych.safe_load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
|
360
|
+
#
|
361
|
+
%a{annotate:rdoc:copy:Psych.safe_load}
|
362
|
+
def self.safe_load: (String yaml, ?permitted_classes: Array[Class], ?permitted_symbols: Array[Symbol], ?aliases: bool, ?filename: String | _ToStr | _ToS?, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool) -> untyped
|
363
|
+
|
364
|
+
# <!--
|
365
|
+
# rdoc-file=ext/psych/lib/psych.rb
|
366
|
+
# - unsafe_load(yaml, filename: nil, fallback: false, symbolize_names: false, freeze: false, strict_integer: false)
|
367
|
+
# -->
|
368
|
+
# Load `yaml` in to a Ruby data structure. If multiple documents are provided,
|
369
|
+
# the object contained in the first document will be returned. `filename` will
|
370
|
+
# be used in the exception message if any exception is raised while parsing. If
|
371
|
+
# `yaml` is empty, it returns the specified `fallback` return value, which
|
372
|
+
# defaults to `false`.
|
373
|
+
#
|
374
|
+
# Raises a Psych::SyntaxError when a YAML syntax error is detected.
|
375
|
+
#
|
376
|
+
# Example:
|
377
|
+
#
|
378
|
+
# Psych.unsafe_load("--- a") # => 'a'
|
379
|
+
# Psych.unsafe_load("---\n - a\n - b") # => ['a', 'b']
|
380
|
+
#
|
381
|
+
# begin
|
382
|
+
# Psych.unsafe_load("--- `", filename: "file.txt")
|
383
|
+
# rescue Psych::SyntaxError => ex
|
384
|
+
# ex.file # => 'file.txt'
|
385
|
+
# ex.message # => "(file.txt): found character that cannot start any token"
|
386
|
+
# end
|
387
|
+
#
|
388
|
+
# When the optional `symbolize_names` keyword argument is set to a true value,
|
389
|
+
# returns symbols for keys in Hash objects (default: strings).
|
390
|
+
#
|
391
|
+
# Psych.unsafe_load("---\n foo: bar") # => {"foo"=>"bar"}
|
392
|
+
# Psych.unsafe_load("---\n foo: bar", symbolize_names: true) # => {:foo=>"bar"}
|
393
|
+
#
|
394
|
+
# Raises a TypeError when `yaml` parameter is NilClass
|
395
|
+
#
|
396
|
+
# NOTE: This method *should not* be used to parse untrusted documents, such as
|
397
|
+
# YAML documents that are supplied via user input. Instead, please use the load
|
398
|
+
# method or the safe_load method.
|
399
|
+
#
|
400
|
+
%a{annotate:rdoc:copy:Psych.unsafe_load}
|
401
|
+
def self.unsafe_load: (String yaml, ?filename: String | _ToStr | _ToS?, ?fallback: untyped, ?symbolize_names: bool, ?freeze: bool, ?strict_integer: bool) -> untyped
|
402
|
+
end
|
@@ -0,0 +1,59 @@
|
|
1
|
+
# <!-- rdoc-file=lib/yaml/store.rb -->
|
2
|
+
# YAML::Store provides the same functionality as PStore, except it uses YAML to
|
3
|
+
# dump objects instead of Marshal.
|
4
|
+
#
|
5
|
+
# ## Example
|
6
|
+
#
|
7
|
+
# require 'yaml/store'
|
8
|
+
#
|
9
|
+
# Person = Struct.new :first_name, :last_name
|
10
|
+
#
|
11
|
+
# people = [Person.new("Bob", "Smith"), Person.new("Mary", "Johnson")]
|
12
|
+
#
|
13
|
+
# store = YAML::Store.new "test.store"
|
14
|
+
#
|
15
|
+
# store.transaction do
|
16
|
+
# store["people"] = people
|
17
|
+
# store["greeting"] = { "hello" => "world" }
|
18
|
+
# end
|
19
|
+
#
|
20
|
+
# After running the above code, the contents of "test.store" will be:
|
21
|
+
#
|
22
|
+
# ---
|
23
|
+
# people:
|
24
|
+
# - !ruby/struct:Person
|
25
|
+
# first_name: Bob
|
26
|
+
# last_name: Smith
|
27
|
+
# - !ruby/struct:Person
|
28
|
+
# first_name: Mary
|
29
|
+
# last_name: Johnson
|
30
|
+
# greeting:
|
31
|
+
# hello: world
|
32
|
+
#
|
33
|
+
class Psych::Store < ::PStore
|
34
|
+
# <!--
|
35
|
+
# rdoc-file=lib/yaml/store.rb
|
36
|
+
# - initialize( file_name, yaml_opts = {} )
|
37
|
+
# - initialize( file_name, thread_safe = false, yaml_opts = {} )
|
38
|
+
# -->
|
39
|
+
# Creates a new YAML::Store object, which will store data in `file_name`. If the
|
40
|
+
# file does not already exist, it will be created.
|
41
|
+
#
|
42
|
+
# YAML::Store objects are always reentrant. But if *thread_safe* is set to true,
|
43
|
+
# then it will become thread-safe at the cost of a minor performance hit.
|
44
|
+
#
|
45
|
+
# Options passed in through `yaml_opts` will be used when converting the store
|
46
|
+
# to YAML via Hash#to_yaml().
|
47
|
+
#
|
48
|
+
def initialize: (*untyped o) -> void
|
49
|
+
|
50
|
+
def dump: (untyped table) -> String
|
51
|
+
|
52
|
+
def empty_marshal_checksum: () -> String
|
53
|
+
|
54
|
+
def empty_marshal_data: () -> String
|
55
|
+
|
56
|
+
def load: (String) -> untyped
|
57
|
+
|
58
|
+
def marshal_dump_supports_canonical_option?: () -> ::FalseClass
|
59
|
+
end
|