yard 0.9.18 → 0.9.19
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of yard might be problematic. Click here for more details.
- checksums.yaml +4 -4
- data/.yardopts +26 -26
- data/CHANGELOG.md +742 -728
- data/LEGAL +66 -66
- data/LICENSE +22 -22
- data/README.md +328 -328
- data/Rakefile +42 -53
- data/benchmarks/builtins_vs_eval.rb +24 -24
- data/benchmarks/concat_vs_join.rb +13 -13
- data/benchmarks/erb_vs_erubis.rb +54 -54
- data/benchmarks/format_args.rb +47 -47
- data/benchmarks/generation.rb +38 -38
- data/benchmarks/marshal_vs_dbm.rb +64 -64
- data/benchmarks/parsing.rb +46 -46
- data/benchmarks/pathname_vs_string.rb +50 -50
- data/benchmarks/rdoc_vs_yardoc.rb +11 -11
- data/benchmarks/registry_store_types.rb +49 -49
- data/benchmarks/ri_vs_yri.rb +19 -19
- data/benchmarks/ripper_parser.rb +13 -13
- data/benchmarks/splat_vs_flatten.rb +13 -13
- data/benchmarks/template_erb.rb +23 -23
- data/benchmarks/template_format.rb +7 -7
- data/benchmarks/template_profile.rb +18 -18
- data/benchmarks/yri_cache.rb +20 -20
- data/bin/yard +13 -13
- data/bin/yardoc +13 -13
- data/bin/yri +13 -13
- data/docs/CodeObjects.md +115 -115
- data/docs/GettingStarted.md +679 -679
- data/docs/Handlers.md +152 -152
- data/docs/Overview.md +61 -61
- data/docs/Parser.md +191 -191
- data/docs/Tags.md +283 -283
- data/docs/TagsArch.md +123 -123
- data/docs/Templates.md +496 -496
- data/docs/WhatsNew.md +1245 -1245
- data/docs/templates/default/fulldoc/html/full_list_tag.erb +8 -8
- data/docs/templates/default/fulldoc/html/setup.rb +6 -6
- data/docs/templates/default/layout/html/setup.rb +9 -9
- data/docs/templates/default/layout/html/tag_list.erb +11 -11
- data/docs/templates/default/yard_tags/html/list.erb +18 -18
- data/docs/templates/default/yard_tags/html/setup.rb +26 -26
- data/docs/templates/plugin.rb +70 -70
- data/lib/rubygems_plugin.rb +9 -9
- data/lib/yard.rb +69 -69
- data/lib/yard/autoload.rb +308 -303
- data/lib/yard/cli/command.rb +85 -85
- data/lib/yard/cli/command_parser.rb +93 -93
- data/lib/yard/cli/config.rb +198 -198
- data/lib/yard/cli/diff.rb +270 -270
- data/lib/yard/cli/display.rb +69 -69
- data/lib/yard/cli/gems.rb +84 -84
- data/lib/yard/cli/graph.rb +125 -125
- data/lib/yard/cli/help.rb +20 -20
- data/lib/yard/cli/i18n.rb +70 -70
- data/lib/yard/cli/list.rb +23 -23
- data/lib/yard/cli/markup_types.rb +32 -32
- data/lib/yard/cli/server.rb +257 -257
- data/lib/yard/cli/stats.rb +231 -231
- data/lib/yard/cli/yardoc.rb +789 -788
- data/lib/yard/cli/yardopts_command.rb +110 -110
- data/lib/yard/cli/yri.rb +215 -215
- data/lib/yard/code_objects/base.rb +615 -615
- data/lib/yard/code_objects/class_object.rb +146 -146
- data/lib/yard/code_objects/class_variable_object.rb +11 -11
- data/lib/yard/code_objects/constant_object.rb +16 -16
- data/lib/yard/code_objects/extended_method_object.rb +24 -24
- data/lib/yard/code_objects/extra_file_object.rb +134 -131
- data/lib/yard/code_objects/macro_object.rb +172 -172
- data/lib/yard/code_objects/method_object.rb +196 -196
- data/lib/yard/code_objects/module_object.rb +21 -21
- data/lib/yard/code_objects/namespace_mapper.rb +114 -114
- data/lib/yard/code_objects/namespace_object.rb +200 -200
- data/lib/yard/code_objects/proxy.rb +240 -240
- data/lib/yard/code_objects/root_object.rb +19 -19
- data/lib/yard/config.rb +270 -270
- data/lib/yard/core_ext/array.rb +16 -16
- data/lib/yard/core_ext/file.rb +69 -69
- data/lib/yard/core_ext/hash.rb +16 -16
- data/lib/yard/core_ext/insertion.rb +63 -63
- data/lib/yard/core_ext/module.rb +11 -20
- data/lib/yard/core_ext/string.rb +68 -68
- data/lib/yard/core_ext/symbol_hash.rb +75 -75
- data/lib/yard/docstring.rb +386 -386
- data/lib/yard/docstring_parser.rb +345 -345
- data/lib/yard/gem_index.rb +29 -29
- data/lib/yard/globals.rb +22 -22
- data/lib/yard/handlers/base.rb +595 -595
- data/lib/yard/handlers/c/alias_handler.rb +16 -16
- data/lib/yard/handlers/c/attribute_handler.rb +13 -13
- data/lib/yard/handlers/c/base.rb +129 -129
- data/lib/yard/handlers/c/class_handler.rb +27 -27
- data/lib/yard/handlers/c/constant_handler.rb +13 -13
- data/lib/yard/handlers/c/handler_methods.rb +212 -211
- data/lib/yard/handlers/c/init_handler.rb +20 -20
- data/lib/yard/handlers/c/method_handler.rb +45 -45
- data/lib/yard/handlers/c/mixin_handler.rb +21 -21
- data/lib/yard/handlers/c/module_handler.rb +17 -17
- data/lib/yard/handlers/c/override_comment_handler.rb +31 -31
- data/lib/yard/handlers/c/path_handler.rb +11 -11
- data/lib/yard/handlers/c/struct_handler.rb +13 -13
- data/lib/yard/handlers/c/symbol_handler.rb +8 -8
- data/lib/yard/handlers/common/method_handler.rb +19 -0
- data/lib/yard/handlers/processor.rb +200 -200
- data/lib/yard/handlers/ruby/alias_handler.rb +44 -44
- data/lib/yard/handlers/ruby/attribute_handler.rb +87 -87
- data/lib/yard/handlers/ruby/base.rb +165 -165
- data/lib/yard/handlers/ruby/class_condition_handler.rb +92 -92
- data/lib/yard/handlers/ruby/class_handler.rb +119 -119
- data/lib/yard/handlers/ruby/class_variable_handler.rb +17 -17
- data/lib/yard/handlers/ruby/comment_handler.rb +10 -10
- data/lib/yard/handlers/ruby/constant_handler.rb +59 -59
- data/lib/yard/handlers/ruby/decorator_handler_methods.rb +123 -123
- data/lib/yard/handlers/ruby/dsl_handler.rb +15 -15
- data/lib/yard/handlers/ruby/dsl_handler_methods.rb +96 -96
- data/lib/yard/handlers/ruby/exception_handler.rb +27 -27
- data/lib/yard/handlers/ruby/extend_handler.rb +22 -22
- data/lib/yard/handlers/ruby/legacy/alias_handler.rb +37 -37
- data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +65 -65
- data/lib/yard/handlers/ruby/legacy/base.rb +245 -245
- data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +83 -83
- data/lib/yard/handlers/ruby/legacy/class_handler.rb +113 -113
- data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +15 -15
- data/lib/yard/handlers/ruby/legacy/comment_handler.rb +10 -10
- data/lib/yard/handlers/ruby/legacy/constant_handler.rb +29 -29
- data/lib/yard/handlers/ruby/legacy/dsl_handler.rb +17 -17
- data/lib/yard/handlers/ruby/legacy/exception_handler.rb +13 -13
- data/lib/yard/handlers/ruby/legacy/extend_handler.rb +21 -21
- data/lib/yard/handlers/ruby/legacy/method_handler.rb +90 -90
- data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +39 -39
- data/lib/yard/handlers/ruby/legacy/module_function_handler.rb +19 -19
- data/lib/yard/handlers/ruby/legacy/module_handler.rb +12 -12
- data/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +22 -22
- data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +22 -22
- data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +17 -17
- data/lib/yard/handlers/ruby/legacy/yield_handler.rb +29 -29
- data/lib/yard/handlers/ruby/method_condition_handler.rb +9 -9
- data/lib/yard/handlers/ruby/method_handler.rb +114 -118
- data/lib/yard/handlers/ruby/mixin_handler.rb +37 -37
- data/lib/yard/handlers/ruby/module_function_handler.rb +27 -27
- data/lib/yard/handlers/ruby/module_handler.rb +12 -12
- data/lib/yard/handlers/ruby/private_class_method_handler.rb +14 -14
- data/lib/yard/handlers/ruby/private_constant_handler.rb +43 -43
- data/lib/yard/handlers/ruby/public_class_method_handler.rb +14 -14
- data/lib/yard/handlers/ruby/struct_handler_methods.rb +143 -143
- data/lib/yard/handlers/ruby/visibility_handler.rb +22 -22
- data/lib/yard/handlers/ruby/yield_handler.rb +31 -31
- data/lib/yard/i18n/locale.rb +67 -67
- data/lib/yard/i18n/message.rb +57 -57
- data/lib/yard/i18n/messages.rb +56 -56
- data/lib/yard/i18n/po_parser.rb +61 -61
- data/lib/yard/i18n/pot_generator.rb +290 -290
- data/lib/yard/i18n/text.rb +173 -173
- data/lib/yard/logging.rb +205 -205
- data/lib/yard/options.rb +217 -217
- data/lib/yard/parser/base.rb +57 -57
- data/lib/yard/parser/c/c_parser.rb +235 -235
- data/lib/yard/parser/c/comment_parser.rb +134 -134
- data/lib/yard/parser/c/statement.rb +64 -64
- data/lib/yard/parser/ruby/ast_node.rb +540 -540
- data/lib/yard/parser/ruby/legacy/ruby_lex.rb +1354 -1354
- data/lib/yard/parser/ruby/legacy/ruby_parser.rb +32 -32
- data/lib/yard/parser/ruby/legacy/statement.rb +66 -66
- data/lib/yard/parser/ruby/legacy/statement_list.rb +394 -394
- data/lib/yard/parser/ruby/legacy/token_list.rb +74 -74
- data/lib/yard/parser/ruby/ruby_parser.rb +687 -687
- data/lib/yard/parser/ruby/token_resolver.rb +156 -156
- data/lib/yard/parser/source_parser.rb +526 -526
- data/lib/yard/rake/yardoc_task.rb +81 -81
- data/lib/yard/registry.rb +439 -439
- data/lib/yard/registry_resolver.rb +189 -189
- data/lib/yard/registry_store.rb +337 -337
- data/lib/yard/rubygems/backports.rb +10 -10
- data/lib/yard/rubygems/backports/LICENSE.txt +57 -57
- data/lib/yard/rubygems/backports/MIT.txt +20 -20
- data/lib/yard/rubygems/backports/gem.rb +10 -10
- data/lib/yard/rubygems/backports/source_index.rb +365 -365
- data/lib/yard/rubygems/doc_manager.rb +90 -90
- data/lib/yard/rubygems/hook.rb +197 -197
- data/lib/yard/rubygems/specification.rb +50 -50
- data/lib/yard/serializers/base.rb +83 -83
- data/lib/yard/serializers/file_system_serializer.rb +123 -123
- data/lib/yard/serializers/process_serializer.rb +24 -24
- data/lib/yard/serializers/stdout_serializer.rb +34 -34
- data/lib/yard/serializers/yardoc_serializer.rb +152 -152
- data/lib/yard/server.rb +13 -13
- data/lib/yard/server/adapter.rb +100 -100
- data/lib/yard/server/commands/base.rb +209 -209
- data/lib/yard/server/commands/display_file_command.rb +29 -29
- data/lib/yard/server/commands/display_object_command.rb +65 -65
- data/lib/yard/server/commands/frames_command.rb +16 -16
- data/lib/yard/server/commands/library_command.rb +187 -187
- data/lib/yard/server/commands/library_index_command.rb +28 -28
- data/lib/yard/server/commands/list_command.rb +25 -25
- data/lib/yard/server/commands/root_request_command.rb +15 -15
- data/lib/yard/server/commands/search_command.rb +79 -79
- data/lib/yard/server/commands/static_file_command.rb +23 -23
- data/lib/yard/server/commands/static_file_helpers.rb +62 -62
- data/lib/yard/server/doc_server_helper.rb +91 -91
- data/lib/yard/server/doc_server_serializer.rb +39 -39
- data/lib/yard/server/library_version.rb +277 -277
- data/lib/yard/server/rack_adapter.rb +89 -89
- data/lib/yard/server/router.rb +187 -187
- data/lib/yard/server/static_caching.rb +46 -46
- data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +127 -127
- data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +11 -11
- data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +37 -37
- data/lib/yard/server/templates/default/layout/html/script_setup.erb +7 -7
- data/lib/yard/server/templates/default/layout/html/setup.rb +8 -8
- data/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -4
- data/lib/yard/server/templates/default/method_details/html/setup.rb +5 -5
- data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +8 -8
- data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +14 -14
- data/lib/yard/server/templates/doc_server/library_list/html/listing.erb +13 -13
- data/lib/yard/server/templates/doc_server/library_list/html/setup.rb +6 -6
- data/lib/yard/server/templates/doc_server/library_list/html/title.erb +2 -2
- data/lib/yard/server/templates/doc_server/processing/html/processing.erb +52 -52
- data/lib/yard/server/templates/doc_server/processing/html/setup.rb +4 -4
- data/lib/yard/server/templates/doc_server/search/html/search.erb +18 -18
- data/lib/yard/server/templates/doc_server/search/html/setup.rb +9 -9
- data/lib/yard/server/webrick_adapter.rb +45 -45
- data/lib/yard/tags/default_factory.rb +191 -191
- data/lib/yard/tags/default_tag.rb +13 -13
- data/lib/yard/tags/directives.rb +616 -616
- data/lib/yard/tags/library.rb +633 -633
- data/lib/yard/tags/option_tag.rb +13 -13
- data/lib/yard/tags/overload_tag.rb +71 -71
- data/lib/yard/tags/ref_tag.rb +8 -8
- data/lib/yard/tags/ref_tag_list.rb +28 -28
- data/lib/yard/tags/tag.rb +71 -71
- data/lib/yard/tags/tag_format_error.rb +7 -7
- data/lib/yard/tags/types_explainer.rb +162 -162
- data/lib/yard/templates/engine.rb +186 -186
- data/lib/yard/templates/erb_cache.rb +23 -23
- data/lib/yard/templates/helpers/base_helper.rb +215 -215
- data/lib/yard/templates/helpers/filter_helper.rb +27 -27
- data/lib/yard/templates/helpers/html_helper.rb +646 -646
- data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +78 -78
- data/lib/yard/templates/helpers/markup/rdoc_markdown.rb +23 -23
- data/lib/yard/templates/helpers/markup/rdoc_markup.rb +109 -109
- data/lib/yard/templates/helpers/markup_helper.rb +172 -172
- data/lib/yard/templates/helpers/method_helper.rb +75 -75
- data/lib/yard/templates/helpers/module_helper.rb +21 -21
- data/lib/yard/templates/helpers/text_helper.rb +112 -112
- data/lib/yard/templates/helpers/uml_helper.rb +47 -47
- data/lib/yard/templates/section.rb +105 -105
- data/lib/yard/templates/template.rb +418 -418
- data/lib/yard/templates/template_options.rb +92 -92
- data/lib/yard/verifier.rb +151 -151
- data/lib/yard/version.rb +6 -6
- data/spec/cli/command_parser_spec.rb +43 -43
- data/spec/cli/command_spec.rb +36 -36
- data/spec/cli/config_spec.rb +148 -148
- data/spec/cli/diff_spec.rb +254 -254
- data/spec/cli/display_spec.rb +30 -30
- data/spec/cli/gems_spec.rb +81 -81
- data/spec/cli/graph_spec.rb +18 -18
- data/spec/cli/help_spec.rb +22 -22
- data/spec/cli/i18n_spec.rb +107 -107
- data/spec/cli/list_spec.rb +8 -8
- data/spec/cli/markup_types_spec.rb +22 -22
- data/spec/cli/server_spec.rb +324 -324
- data/spec/cli/stats_spec.rb +96 -96
- data/spec/cli/yard_on_yard_spec.rb +38 -38
- data/spec/cli/yardoc_spec.rb +896 -862
- data/spec/cli/yri_spec.rb +101 -101
- data/spec/code_objects/base_spec.rb +470 -470
- data/spec/code_objects/class_object_spec.rb +226 -226
- data/spec/code_objects/code_object_list_spec.rb +36 -36
- data/spec/code_objects/constants_spec.rb +116 -116
- data/spec/code_objects/extra_file_object_spec.rb +160 -160
- data/spec/code_objects/macro_object_spec.rb +150 -150
- data/spec/code_objects/method_object_spec.rb +184 -184
- data/spec/code_objects/module_object_spec.rb +142 -142
- data/spec/code_objects/namespace_object_spec.rb +171 -171
- data/spec/code_objects/proxy_spec.rb +141 -141
- data/spec/code_objects/spec_helper.rb +3 -3
- data/spec/config_spec.rb +171 -171
- data/spec/core_ext/array_spec.rb +13 -13
- data/spec/core_ext/file_spec.rb +72 -72
- data/spec/core_ext/hash_spec.rb +14 -14
- data/spec/core_ext/insertion_spec.rb +37 -37
- data/spec/core_ext/module_spec.rb +9 -15
- data/spec/core_ext/string_spec.rb +42 -42
- data/spec/core_ext/symbol_hash_spec.rb +89 -89
- data/spec/docstring_parser_spec.rb +280 -280
- data/spec/docstring_spec.rb +373 -373
- data/spec/examples.txt +1883 -1875
- data/spec/handlers/alias_handler_spec.rb +82 -82
- data/spec/handlers/attribute_handler_spec.rb +96 -96
- data/spec/handlers/base_spec.rb +216 -216
- data/spec/handlers/c/alias_handler_spec.rb +34 -34
- data/spec/handlers/c/attribute_handler_spec.rb +41 -41
- data/spec/handlers/c/class_handler_spec.rb +78 -78
- data/spec/handlers/c/constant_handler_spec.rb +71 -71
- data/spec/handlers/c/init_handler_spec.rb +48 -48
- data/spec/handlers/c/method_handler_spec.rb +327 -325
- data/spec/handlers/c/mixin_handler_spec.rb +44 -44
- data/spec/handlers/c/module_handler_spec.rb +71 -71
- data/spec/handlers/c/override_comment_handler_spec.rb +47 -47
- data/spec/handlers/c/path_handler_spec.rb +36 -36
- data/spec/handlers/c/spec_helper.rb +23 -23
- data/spec/handlers/c/struct_handler_spec.rb +16 -16
- data/spec/handlers/class_condition_handler_spec.rb +87 -87
- data/spec/handlers/class_handler_spec.rb +247 -247
- data/spec/handlers/class_method_handler_shared_examples.rb +133 -133
- data/spec/handlers/class_variable_handler_spec.rb +12 -12
- data/spec/handlers/constant_handler_spec.rb +112 -112
- data/spec/handlers/decorator_handler_methods_spec.rb +393 -393
- data/spec/handlers/dsl_handler_spec.rb +219 -219
- data/spec/handlers/examples/alias_handler_001.rb.txt +45 -45
- data/spec/handlers/examples/attribute_handler_001.rb.txt +31 -31
- data/spec/handlers/examples/class_condition_handler_001.rb.txt +68 -68
- data/spec/handlers/examples/class_handler_001.rb.txt +120 -120
- data/spec/handlers/examples/class_variable_handler_001.rb.txt +9 -9
- data/spec/handlers/examples/constant_handler_001.rb.txt +35 -35
- data/spec/handlers/examples/dsl_handler_001.rb.txt +154 -154
- data/spec/handlers/examples/exception_handler_001.rb.txt +58 -58
- data/spec/handlers/examples/extend_handler_001.rb.txt +15 -15
- data/spec/handlers/examples/method_condition_handler_001.rb.txt +9 -9
- data/spec/handlers/examples/method_handler_001.rb.txt +128 -128
- data/spec/handlers/examples/mixin_handler_001.rb.txt +37 -37
- data/spec/handlers/examples/module_handler_001.rb.txt +29 -29
- data/spec/handlers/examples/private_constant_handler_001.rb.txt +8 -8
- data/spec/handlers/examples/process_handler_001.rb.txt +11 -11
- data/spec/handlers/examples/visibility_handler_001.rb.txt +35 -35
- data/spec/handlers/examples/yield_handler_001.rb.txt +54 -54
- data/spec/handlers/exception_handler_spec.rb +49 -49
- data/spec/handlers/extend_handler_spec.rb +24 -24
- data/spec/handlers/legacy_base_spec.rb +128 -128
- data/spec/handlers/method_condition_handler_spec.rb +15 -15
- data/spec/handlers/method_handler_spec.rb +190 -190
- data/spec/handlers/mixin_handler_spec.rb +56 -56
- data/spec/handlers/module_function_handler_spec.rb +106 -106
- data/spec/handlers/module_handler_spec.rb +35 -35
- data/spec/handlers/private_class_method_handler_spec.rb +11 -11
- data/spec/handlers/private_constant_handler_spec.rb +25 -25
- data/spec/handlers/processor_spec.rb +35 -35
- data/spec/handlers/public_class_method_handler_spec.rb +11 -11
- data/spec/handlers/ruby/base_spec.rb +95 -95
- data/spec/handlers/ruby/legacy/base_spec.rb +84 -84
- data/spec/handlers/spec_helper.rb +33 -33
- data/spec/handlers/visibility_handler_spec.rb +44 -44
- data/spec/handlers/yield_handler_spec.rb +52 -52
- data/spec/i18n/locale_spec.rb +81 -81
- data/spec/i18n/message_spec.rb +52 -52
- data/spec/i18n/messages_spec.rb +67 -67
- data/spec/i18n/pot_generator_spec.rb +295 -295
- data/spec/i18n/text_spec.rb +184 -184
- data/spec/logging_spec.rb +44 -44
- data/spec/options_spec.rb +171 -171
- data/spec/parser/base_spec.rb +24 -24
- data/spec/parser/c_parser_spec.rb +236 -236
- data/spec/parser/examples/array.c.txt +6267 -6267
- data/spec/parser/examples/example1.rb.txt +7 -7
- data/spec/parser/examples/extrafile.c.txt +8 -8
- data/spec/parser/examples/file.c.txt +28 -28
- data/spec/parser/examples/multifile.c.txt +22 -22
- data/spec/parser/examples/namespace.cpp.txt +68 -68
- data/spec/parser/examples/override.c.txt +424 -424
- data/spec/parser/examples/parse_in_order_001.rb.txt +2 -2
- data/spec/parser/examples/parse_in_order_002.rb.txt +1 -1
- data/spec/parser/examples/tag_handler_001.rb.txt +7 -7
- data/spec/parser/ruby/ast_node_spec.rb +33 -33
- data/spec/parser/ruby/legacy/statement_list_spec.rb +299 -299
- data/spec/parser/ruby/legacy/token_list_spec.rb +79 -79
- data/spec/parser/ruby/ruby_parser_spec.rb +508 -508
- data/spec/parser/ruby/token_resolver_spec.rb +165 -165
- data/spec/parser/source_parser_spec.rb +727 -727
- data/spec/parser/tag_parsing_spec.rb +17 -17
- data/spec/rake/yardoc_task_spec.rb +118 -118
- data/spec/registry_spec.rb +463 -463
- data/spec/registry_store_spec.rb +316 -316
- data/spec/rubygems/doc_manager_spec.rb +112 -112
- data/spec/serializers/data/serialized_yardoc/checksums +1 -1
- data/spec/serializers/file_system_serializer_spec.rb +145 -145
- data/spec/serializers/spec_helper.rb +2 -2
- data/spec/serializers/yardoc_serializer_spec.rb +78 -78
- data/spec/server/adapter_spec.rb +39 -39
- data/spec/server/commands/base_spec.rb +91 -91
- data/spec/server/commands/library_command_spec.rb +39 -39
- data/spec/server/doc_server_helper_spec.rb +72 -72
- data/spec/server/doc_server_serializer_spec.rb +60 -60
- data/spec/server/rack_adapter_spec.rb +21 -21
- data/spec/server/router_spec.rb +123 -123
- data/spec/server/spec_helper.rb +22 -22
- data/spec/server/static_caching_spec.rb +47 -47
- data/spec/server/webrick_servlet_spec.rb +20 -20
- data/spec/server_spec.rb +19 -19
- data/spec/spec_helper.rb +212 -212
- data/spec/tags/default_factory_spec.rb +168 -168
- data/spec/tags/default_tag_spec.rb +11 -11
- data/spec/tags/directives_spec.rb +463 -463
- data/spec/tags/library_spec.rb +48 -48
- data/spec/tags/overload_tag_spec.rb +53 -53
- data/spec/tags/ref_tag_list_spec.rb +53 -53
- data/spec/tags/types_explainer_spec.rb +203 -203
- data/spec/templates/class_spec.rb +45 -45
- data/spec/templates/constant_spec.rb +41 -41
- data/spec/templates/engine_spec.rb +131 -131
- data/spec/templates/examples/class001.html +308 -308
- data/spec/templates/examples/class001.txt +36 -36
- data/spec/templates/examples/class002.html +39 -39
- data/spec/templates/examples/constant001.txt +24 -24
- data/spec/templates/examples/constant002.txt +6 -6
- data/spec/templates/examples/constant003.txt +10 -10
- data/spec/templates/examples/method001.html +137 -137
- data/spec/templates/examples/method001.txt +35 -35
- data/spec/templates/examples/method002.html +91 -91
- data/spec/templates/examples/method002.txt +20 -20
- data/spec/templates/examples/method003.html +165 -165
- data/spec/templates/examples/method003.txt +45 -45
- data/spec/templates/examples/method004.html +48 -48
- data/spec/templates/examples/method004.txt +10 -10
- data/spec/templates/examples/method005.html +105 -105
- data/spec/templates/examples/method005.txt +33 -33
- data/spec/templates/examples/method006.html +107 -107
- data/spec/templates/examples/method006.txt +20 -20
- data/spec/templates/examples/module001.dot +33 -33
- data/spec/templates/examples/module001.html +833 -833
- data/spec/templates/examples/module001.txt +33 -33
- data/spec/templates/examples/module002.html +341 -341
- data/spec/templates/examples/module003.html +202 -202
- data/spec/templates/examples/module004.html +394 -394
- data/spec/templates/examples/module005.html +81 -81
- data/spec/templates/examples/tag001.txt +82 -82
- data/spec/templates/helpers/base_helper_spec.rb +171 -171
- data/spec/templates/helpers/html_helper_spec.rb +687 -668
- data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +65 -65
- data/spec/templates/helpers/markup/rdoc_markup_spec.rb +84 -84
- data/spec/templates/helpers/markup_helper_spec.rb +136 -136
- data/spec/templates/helpers/method_helper_spec.rb +107 -107
- data/spec/templates/helpers/module_helper_spec.rb +35 -35
- data/spec/templates/helpers/shared_signature_examples.rb +126 -126
- data/spec/templates/helpers/text_helper_spec.rb +65 -65
- data/spec/templates/method_spec.rb +118 -118
- data/spec/templates/module_spec.rb +203 -203
- data/spec/templates/onefile_spec.rb +66 -66
- data/spec/templates/section_spec.rb +144 -144
- data/spec/templates/spec_helper.rb +76 -76
- data/spec/templates/tag_spec.rb +52 -52
- data/spec/templates/template_spec.rb +410 -410
- data/spec/verifier_spec.rb +106 -106
- data/templates/default/class/dot/setup.rb +7 -7
- data/templates/default/class/dot/superklass.erb +2 -2
- data/templates/default/class/html/constructor_details.erb +8 -8
- data/templates/default/class/html/setup.rb +2 -2
- data/templates/default/class/html/subclasses.erb +4 -4
- data/templates/default/class/setup.rb +36 -36
- data/templates/default/class/text/setup.rb +12 -12
- data/templates/default/class/text/subclasses.erb +5 -5
- data/templates/default/constant/text/header.erb +11 -11
- data/templates/default/constant/text/setup.rb +4 -4
- data/templates/default/docstring/html/abstract.erb +4 -4
- data/templates/default/docstring/html/deprecated.erb +1 -1
- data/templates/default/docstring/html/index.erb +5 -5
- data/templates/default/docstring/html/note.erb +6 -6
- data/templates/default/docstring/html/private.erb +4 -4
- data/templates/default/docstring/html/text.erb +1 -1
- data/templates/default/docstring/html/todo.erb +6 -6
- data/templates/default/docstring/setup.rb +52 -52
- data/templates/default/docstring/text/abstract.erb +2 -2
- data/templates/default/docstring/text/deprecated.erb +2 -2
- data/templates/default/docstring/text/index.erb +2 -2
- data/templates/default/docstring/text/note.erb +3 -3
- data/templates/default/docstring/text/private.erb +2 -2
- data/templates/default/docstring/text/text.erb +1 -1
- data/templates/default/docstring/text/todo.erb +3 -3
- data/templates/default/fulldoc/html/css/full_list.css +58 -58
- data/templates/default/fulldoc/html/css/style.css +496 -496
- data/templates/default/fulldoc/html/frames.erb +17 -17
- data/templates/default/fulldoc/html/full_list.erb +37 -37
- data/templates/default/fulldoc/html/full_list_class.erb +2 -2
- data/templates/default/fulldoc/html/full_list_file.erb +7 -7
- data/templates/default/fulldoc/html/full_list_method.erb +10 -10
- data/templates/default/fulldoc/html/js/app.js +303 -292
- data/templates/default/fulldoc/html/js/full_list.js +216 -216
- data/templates/default/fulldoc/html/js/jquery.js +3 -3
- data/templates/default/fulldoc/html/setup.rb +241 -241
- data/templates/default/layout/dot/header.erb +5 -5
- data/templates/default/layout/dot/setup.rb +15 -15
- data/templates/default/layout/html/breadcrumb.erb +11 -11
- data/templates/default/layout/html/files.erb +11 -11
- data/templates/default/layout/html/footer.erb +5 -5
- data/templates/default/layout/html/headers.erb +15 -15
- data/templates/default/layout/html/index.erb +2 -2
- data/templates/default/layout/html/layout.erb +23 -23
- data/templates/default/layout/html/listing.erb +4 -4
- data/templates/default/layout/html/objects.erb +32 -32
- data/templates/default/layout/html/script_setup.erb +4 -4
- data/templates/default/layout/html/search.erb +12 -12
- data/templates/default/layout/html/setup.rb +89 -89
- data/templates/default/method/html/header.erb +16 -16
- data/templates/default/method/setup.rb +4 -4
- data/templates/default/method_details/html/header.erb +2 -2
- data/templates/default/method_details/html/method_signature.erb +24 -24
- data/templates/default/method_details/html/source.erb +9 -9
- data/templates/default/method_details/setup.rb +11 -11
- data/templates/default/method_details/text/header.erb +10 -10
- data/templates/default/method_details/text/method_signature.erb +12 -12
- data/templates/default/method_details/text/setup.rb +11 -11
- data/templates/default/module/dot/child.erb +1 -1
- data/templates/default/module/dot/dependencies.erb +2 -2
- data/templates/default/module/dot/header.erb +6 -6
- data/templates/default/module/dot/info.erb +13 -13
- data/templates/default/module/dot/setup.rb +15 -15
- data/templates/default/module/html/attribute_details.erb +10 -10
- data/templates/default/module/html/attribute_summary.erb +8 -8
- data/templates/default/module/html/box_info.erb +43 -43
- data/templates/default/module/html/children.erb +8 -8
- data/templates/default/module/html/constant_summary.erb +17 -17
- data/templates/default/module/html/defines.erb +2 -2
- data/templates/default/module/html/header.erb +5 -5
- data/templates/default/module/html/inherited_attributes.erb +14 -14
- data/templates/default/module/html/inherited_constants.erb +8 -8
- data/templates/default/module/html/inherited_methods.erb +18 -18
- data/templates/default/module/html/item_summary.erb +40 -40
- data/templates/default/module/html/method_details_list.erb +9 -9
- data/templates/default/module/html/method_summary.erb +13 -13
- data/templates/default/module/html/methodmissing.erb +12 -12
- data/templates/default/module/setup.rb +167 -167
- data/templates/default/module/text/children.erb +9 -9
- data/templates/default/module/text/class_meths_list.erb +7 -7
- data/templates/default/module/text/extends.erb +7 -7
- data/templates/default/module/text/header.erb +7 -7
- data/templates/default/module/text/includes.erb +7 -7
- data/templates/default/module/text/instance_meths_list.erb +7 -7
- data/templates/default/module/text/setup.rb +13 -13
- data/templates/default/onefile/html/files.erb +4 -4
- data/templates/default/onefile/html/headers.erb +6 -6
- data/templates/default/onefile/html/layout.erb +17 -17
- data/templates/default/onefile/html/readme.erb +2 -2
- data/templates/default/onefile/html/setup.rb +62 -62
- data/templates/default/root/dot/child.erb +2 -2
- data/templates/default/root/dot/setup.rb +6 -6
- data/templates/default/root/html/setup.rb +2 -2
- data/templates/default/tags/html/example.erb +10 -10
- data/templates/default/tags/html/index.erb +2 -2
- data/templates/default/tags/html/option.erb +24 -24
- data/templates/default/tags/html/overload.erb +13 -13
- data/templates/default/tags/html/see.erb +7 -7
- data/templates/default/tags/html/tag.erb +20 -20
- data/templates/default/tags/setup.rb +57 -57
- data/templates/default/tags/text/example.erb +12 -12
- data/templates/default/tags/text/index.erb +1 -1
- data/templates/default/tags/text/option.erb +20 -20
- data/templates/default/tags/text/overload.erb +19 -19
- data/templates/default/tags/text/see.erb +11 -11
- data/templates/default/tags/text/tag.erb +13 -13
- data/templates/guide/class/html/setup.rb +2 -2
- data/templates/guide/docstring/html/setup.rb +2 -2
- data/templates/guide/fulldoc/html/css/style.css +108 -108
- data/templates/guide/fulldoc/html/js/app.js +33 -33
- data/templates/guide/fulldoc/html/setup.rb +74 -74
- data/templates/guide/layout/html/layout.erb +81 -81
- data/templates/guide/layout/html/setup.rb +25 -25
- data/templates/guide/method/html/header.erb +17 -17
- data/templates/guide/method/html/setup.rb +22 -22
- data/templates/guide/module/html/header.erb +6 -6
- data/templates/guide/module/html/method_list.erb +4 -4
- data/templates/guide/module/html/setup.rb +27 -27
- data/templates/guide/onefile/html/files.erb +4 -4
- data/templates/guide/onefile/html/setup.rb +6 -6
- data/templates/guide/onefile/html/toc.erb +3 -3
- data/templates/guide/tags/html/setup.rb +9 -9
- data/yard.gemspec +43 -43
- metadata +4 -3
data/spec/registry_store_spec.rb
CHANGED
@@ -1,316 +1,316 @@
|
|
1
|
-
# frozen_string_literal: true
|
2
|
-
|
3
|
-
RSpec.describe YARD::RegistryStore do
|
4
|
-
before do
|
5
|
-
FileUtils.rm_rf("foo")
|
6
|
-
@store = RegistryStore.new
|
7
|
-
@serializer = Serializers::YardocSerializer.new('foo')
|
8
|
-
@foo = CodeObjects::MethodObject.new(nil, :foo)
|
9
|
-
@bar = CodeObjects::ClassObject.new(nil, :Bar)
|
10
|
-
allow(Serializers::YardocSerializer).to receive(:new).and_return(@serializer)
|
11
|
-
end
|
12
|
-
|
13
|
-
describe "#load" do
|
14
|
-
it "loads root.dat as full object list if it is a Hash" do
|
15
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
16
|
-
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
17
|
-
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
18
|
-
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
19
|
-
expect(@serializer).to receive(:deserialize).with('root').and_return(:root => @foo, :A => @bar)
|
20
|
-
expect(@store.load('foo')).to be true
|
21
|
-
expect(@store.root).to eq @foo
|
22
|
-
expect(@store.get('A')).to eq @bar
|
23
|
-
end
|
24
|
-
|
25
|
-
it "loads old yardoc format if .yardoc is a file" do
|
26
|
-
expect(File).to receive(:directory?).with('foo').and_return(false)
|
27
|
-
expect(File).to receive(:file?).with('foo').and_return(true)
|
28
|
-
expect(File).to receive(:read_binary).with('foo').and_return('FOO')
|
29
|
-
expect(Marshal).to receive(:load).with('FOO')
|
30
|
-
|
31
|
-
@store.load('foo')
|
32
|
-
end
|
33
|
-
|
34
|
-
it "loads new yardoc format if .yardoc is a directory" do
|
35
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
36
|
-
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
37
|
-
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
38
|
-
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
39
|
-
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
40
|
-
|
41
|
-
expect(@store.load('foo')).to be true
|
42
|
-
end
|
43
|
-
|
44
|
-
it "returns true if .yardoc is loaded (file)" do
|
45
|
-
expect(File).to receive(:directory?).with('myyardoc').and_return(false)
|
46
|
-
expect(File).to receive(:file?).with('myyardoc').and_return(true)
|
47
|
-
expect(File).to receive(:read_binary).with('myyardoc').and_return(Marshal.dump(''))
|
48
|
-
expect(@store.load('myyardoc')).to be true
|
49
|
-
end
|
50
|
-
|
51
|
-
it "returns true if .yardoc is loaded (directory)" do
|
52
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
53
|
-
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
54
|
-
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
55
|
-
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
56
|
-
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
57
|
-
expect(@store.load('foo')).to be true
|
58
|
-
end
|
59
|
-
|
60
|
-
it "returns false if .yardoc does not exist" do
|
61
|
-
expect(@store.load('NONEXIST')).to be false
|
62
|
-
end
|
63
|
-
|
64
|
-
it "returns false if there is no file to load" do
|
65
|
-
expect(@store.load(nil)).to be false
|
66
|
-
end
|
67
|
-
|
68
|
-
it "loads checksums if they exist" do
|
69
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
70
|
-
expect(File).to receive(:file?).with('foo/checksums').and_return(true)
|
71
|
-
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
72
|
-
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
73
|
-
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
74
|
-
expect(File).to receive(:readlines).with('foo/checksums').and_return([
|
75
|
-
'file1 CHECKSUM1', ' file2 CHECKSUM2 '
|
76
|
-
])
|
77
|
-
expect(@store.load('foo')).to be true
|
78
|
-
expect(@store.checksums).to eq('file1' => 'CHECKSUM1', 'file2' => 'CHECKSUM2')
|
79
|
-
end
|
80
|
-
|
81
|
-
it "loads proxy_types if they exist" do
|
82
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
83
|
-
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
84
|
-
expect(File).to receive(:file?).with('foo/proxy_types').and_return(true)
|
85
|
-
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
86
|
-
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
87
|
-
expect(File).to receive(:read_binary).with('foo/proxy_types').and_return(Marshal.dump('a' => 'b'))
|
88
|
-
expect(@store.load('foo')).to be true
|
89
|
-
expect(@store.proxy_types).to eq('a' => 'b')
|
90
|
-
end
|
91
|
-
|
92
|
-
it "loads root object if it exists" do
|
93
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
94
|
-
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
95
|
-
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
96
|
-
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
97
|
-
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(true)
|
98
|
-
expect(File).to receive(:read_binary).with('foo/objects/root.dat').and_return(Marshal.dump(@foo))
|
99
|
-
expect(@store.load('foo')).to be true
|
100
|
-
expect(@store.root).to eq @foo
|
101
|
-
end
|
102
|
-
end
|
103
|
-
|
104
|
-
describe "#save" do
|
105
|
-
before do
|
106
|
-
allow(@store).to receive(:write_proxy_types)
|
107
|
-
allow(@store).to receive(:write_checksums)
|
108
|
-
allow(@store).to receive(:destroy)
|
109
|
-
end
|
110
|
-
|
111
|
-
after do
|
112
|
-
Registry.single_object_db = nil
|
113
|
-
end
|
114
|
-
|
115
|
-
def saves_to_singledb
|
116
|
-
expect(@serializer).to receive(:serialize).once.with(instance_of(Hash))
|
117
|
-
@store.save(true, 'foo')
|
118
|
-
end
|
119
|
-
|
120
|
-
def add_items(n)
|
121
|
-
n.times {|i| @store[i.to_s] = @foo }
|
122
|
-
end
|
123
|
-
|
124
|
-
def saves_to_multidb
|
125
|
-
times = @store.keys.size
|
126
|
-
expect(@serializer).to receive(:serialize).exactly(times).times
|
127
|
-
@store.save(true, 'foo')
|
128
|
-
@last = times
|
129
|
-
end
|
130
|
-
|
131
|
-
it "saves as single object db if single_object_db is nil and there are less than 3000 objects" do
|
132
|
-
Registry.single_object_db = nil
|
133
|
-
add_items(100)
|
134
|
-
saves_to_singledb
|
135
|
-
expect(@serializer.complete?).to eq true
|
136
|
-
end
|
137
|
-
|
138
|
-
it "saves as single object db if single_object_db is nil and there are more than 3000 objects" do
|
139
|
-
Registry.single_object_db = nil
|
140
|
-
add_items(5000)
|
141
|
-
saves_to_singledb
|
142
|
-
end
|
143
|
-
|
144
|
-
it "saves as single object db if single_object_db is true (and any amount of objects)" do
|
145
|
-
Registry.single_object_db = true
|
146
|
-
add_items(100)
|
147
|
-
saves_to_singledb
|
148
|
-
add_items(5000)
|
149
|
-
saves_to_singledb
|
150
|
-
end
|
151
|
-
|
152
|
-
it "never saves as single object db if single_object_db is false" do
|
153
|
-
Registry.single_object_db = false
|
154
|
-
add_items(100)
|
155
|
-
saves_to_multidb
|
156
|
-
add_items(5000)
|
157
|
-
saves_to_multidb
|
158
|
-
end
|
159
|
-
end
|
160
|
-
|
161
|
-
describe "#put" do
|
162
|
-
it "assigns values" do
|
163
|
-
@store.put(:YARD, @foo)
|
164
|
-
expect(@store.get(:YARD)).to eq @foo
|
165
|
-
end
|
166
|
-
|
167
|
-
it "treats '' as root" do
|
168
|
-
@store.put('', @foo)
|
169
|
-
expect(@store.get(:root)).to eq @foo
|
170
|
-
end
|
171
|
-
end
|
172
|
-
|
173
|
-
describe "#get" do
|
174
|
-
it "hits cache if object exists" do
|
175
|
-
@store.put(:YARD, @foo)
|
176
|
-
expect(@store.get(:YARD)).to eq @foo
|
177
|
-
end
|
178
|
-
|
179
|
-
it "hits backstore on cache miss and cache is not fully loaded" do
|
180
|
-
serializer = double(:serializer)
|
181
|
-
expect(serializer).to receive(:deserialize).once.with(:YARD).and_return(@foo)
|
182
|
-
@store.load('foo')
|
183
|
-
@store.instance_variable_set("@loaded_objects", 0)
|
184
|
-
@store.instance_variable_set("@available_objects", 100)
|
185
|
-
@store.instance_variable_set("@serializer", serializer)
|
186
|
-
expect(@store.get(:YARD)).to eq @foo
|
187
|
-
expect(@store.get(:YARD)).to eq @foo
|
188
|
-
expect(@store.instance_variable_get("@loaded_objects")).to eq 1
|
189
|
-
end
|
190
|
-
end
|
191
|
-
|
192
|
-
[:keys, :values].each do |item|
|
193
|
-
describe "##{item}" do
|
194
|
-
it "loads entire database if reload=true" do
|
195
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
196
|
-
@store.load('foo')
|
197
|
-
expect(@store).to receive(:load_all)
|
198
|
-
@store.send(item, true)
|
199
|
-
end
|
200
|
-
|
201
|
-
it "does not load entire database if reload=false" do
|
202
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
203
|
-
@store.load('foo')
|
204
|
-
expect(@store).not_to receive(:load_all)
|
205
|
-
@store.send(item, false)
|
206
|
-
end
|
207
|
-
end
|
208
|
-
end
|
209
|
-
|
210
|
-
describe "#paths_for_type" do
|
211
|
-
after { Registry.clear }
|
212
|
-
|
213
|
-
it "sets all object types if not set by object_types" do
|
214
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
215
|
-
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
216
|
-
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
217
|
-
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
218
|
-
expect(@serializer).to receive(:deserialize).with('root').and_return(:'A#foo' => @foo, :A => @bar)
|
219
|
-
@store.load('foo')
|
220
|
-
expect(@store.paths_for_type(:method)).to eq ['#foo']
|
221
|
-
expect(@store.paths_for_type(:class)).to eq ['Bar']
|
222
|
-
end
|
223
|
-
|
224
|
-
it "keeps track of types when assigning values" do
|
225
|
-
@store.put(:abc, @foo)
|
226
|
-
expect(@store.paths_for_type(@foo.type)).to eq ['abc']
|
227
|
-
end
|
228
|
-
|
229
|
-
it "reassigns path if type changes" do
|
230
|
-
foo = CodeObjects::ClassObject.new(:root, :Foo)
|
231
|
-
@store.put('Foo', foo)
|
232
|
-
expect(@store.get('Foo').type).to eq :class
|
233
|
-
expect(@store.paths_for_type(:class)).to eq ["Foo"]
|
234
|
-
foo = CodeObjects::ModuleObject.new(:root, :Foo)
|
235
|
-
@store.put('Foo', foo)
|
236
|
-
expect(@store.get('Foo').type).to eq :module
|
237
|
-
expect(@store.paths_for_type(:class)).to eq []
|
238
|
-
expect(@store.paths_for_type(:module)).to eq ["Foo"]
|
239
|
-
end
|
240
|
-
end
|
241
|
-
|
242
|
-
describe "#values_for_type" do
|
243
|
-
it "returns all objects with type" do
|
244
|
-
@store.put(:abc, @foo)
|
245
|
-
expect(@store.values_for_type(@foo.type)).to eq [@foo]
|
246
|
-
end
|
247
|
-
end
|
248
|
-
|
249
|
-
describe "#load_all" do
|
250
|
-
it "loads the entire database" do
|
251
|
-
foomock = double(:Foo)
|
252
|
-
barmock = double(:Bar)
|
253
|
-
allow(foomock).to receive(:type).and_return(:class)
|
254
|
-
allow(barmock).to receive(:type).and_return(:class)
|
255
|
-
expect(foomock).to receive(:path).and_return('Foo')
|
256
|
-
expect(barmock).to receive(:path).and_return('Bar')
|
257
|
-
expect(File).to receive(:directory?).with('foo').and_return(true)
|
258
|
-
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
259
|
-
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
260
|
-
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
261
|
-
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
262
|
-
expect(@store).to receive(:all_disk_objects).at_least(1).times.and_return(['foo/objects/foo', 'foo/objects/bar'])
|
263
|
-
@store.load('foo')
|
264
|
-
serializer = @store.instance_variable_get("@serializer")
|
265
|
-
expect(serializer).to receive(:deserialize).with('foo/objects/foo', true).and_return(foomock)
|
266
|
-
expect(serializer).to receive(:deserialize).with('foo/objects/bar', true).and_return(barmock)
|
267
|
-
@store.send(:load_all)
|
268
|
-
expect(@store.instance_variable_get("@available_objects")).to eq 2
|
269
|
-
expect(@store.instance_variable_get("@loaded_objects")).to eq 2
|
270
|
-
expect(@store[:Foo]).to eq foomock
|
271
|
-
expect(@store[:Bar]).to eq barmock
|
272
|
-
end
|
273
|
-
end
|
274
|
-
|
275
|
-
describe "#destroy" do
|
276
|
-
it "destroys file ending in .yardoc when force=false" do
|
277
|
-
expect(File).to receive(:file?).with('foo.yardoc').and_return(true)
|
278
|
-
expect(File).to receive(:unlink).with('foo.yardoc')
|
279
|
-
@store.instance_variable_set("@file", 'foo.yardoc')
|
280
|
-
expect(@store.destroy).to be true
|
281
|
-
end
|
282
|
-
|
283
|
-
it "destroys dir ending in .yardoc when force=false" do
|
284
|
-
expect(File).to receive(:directory?).with('foo.yardoc').and_return(true)
|
285
|
-
expect(FileUtils).to receive(:rm_rf).with('foo.yardoc')
|
286
|
-
@store.instance_variable_set("@file", 'foo.yardoc')
|
287
|
-
expect(@store.destroy).to be true
|
288
|
-
end
|
289
|
-
|
290
|
-
it "does not destroy file/dir not ending in .yardoc when force=false" do
|
291
|
-
expect(File).not_to receive(:file?).with('foo')
|
292
|
-
expect(File).not_to receive(:directory?).with('foo')
|
293
|
-
expect(File).not_to receive(:unlink).with('foo')
|
294
|
-
expect(FileUtils).not_to receive(:rm_rf).with('foo')
|
295
|
-
@store.instance_variable_set("@file", 'foo')
|
296
|
-
expect(@store.destroy).to be false
|
297
|
-
end
|
298
|
-
|
299
|
-
it "destroys any file/dir when force=true" do
|
300
|
-
expect(File).to receive(:file?).with('foo').and_return(true)
|
301
|
-
expect(File).to receive(:unlink).with('foo')
|
302
|
-
@store.instance_variable_set("@file", 'foo')
|
303
|
-
expect(@store.destroy(true)).to be true
|
304
|
-
end
|
305
|
-
end
|
306
|
-
|
307
|
-
describe "#locale" do
|
308
|
-
it "loads ./po/LOCALE_NAME.po" do
|
309
|
-
fr_locale = I18n::Locale.new("fr")
|
310
|
-
expect(I18n::Locale).to receive(:new).with("fr").and_return(fr_locale)
|
311
|
-
expect(Registry).to receive(:po_dir).and_return("po")
|
312
|
-
expect(fr_locale).to receive(:load).with("po")
|
313
|
-
expect(@store.locale("fr")).to eq fr_locale
|
314
|
-
end
|
315
|
-
end
|
316
|
-
end
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
RSpec.describe YARD::RegistryStore do
|
4
|
+
before do
|
5
|
+
FileUtils.rm_rf("foo")
|
6
|
+
@store = RegistryStore.new
|
7
|
+
@serializer = Serializers::YardocSerializer.new('foo')
|
8
|
+
@foo = CodeObjects::MethodObject.new(nil, :foo)
|
9
|
+
@bar = CodeObjects::ClassObject.new(nil, :Bar)
|
10
|
+
allow(Serializers::YardocSerializer).to receive(:new).and_return(@serializer)
|
11
|
+
end
|
12
|
+
|
13
|
+
describe "#load" do
|
14
|
+
it "loads root.dat as full object list if it is a Hash" do
|
15
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
16
|
+
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
17
|
+
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
18
|
+
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
19
|
+
expect(@serializer).to receive(:deserialize).with('root').and_return(:root => @foo, :A => @bar)
|
20
|
+
expect(@store.load('foo')).to be true
|
21
|
+
expect(@store.root).to eq @foo
|
22
|
+
expect(@store.get('A')).to eq @bar
|
23
|
+
end
|
24
|
+
|
25
|
+
it "loads old yardoc format if .yardoc is a file" do
|
26
|
+
expect(File).to receive(:directory?).with('foo').and_return(false)
|
27
|
+
expect(File).to receive(:file?).with('foo').and_return(true)
|
28
|
+
expect(File).to receive(:read_binary).with('foo').and_return('FOO')
|
29
|
+
expect(Marshal).to receive(:load).with('FOO')
|
30
|
+
|
31
|
+
@store.load('foo')
|
32
|
+
end
|
33
|
+
|
34
|
+
it "loads new yardoc format if .yardoc is a directory" do
|
35
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
36
|
+
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
37
|
+
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
38
|
+
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
39
|
+
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
40
|
+
|
41
|
+
expect(@store.load('foo')).to be true
|
42
|
+
end
|
43
|
+
|
44
|
+
it "returns true if .yardoc is loaded (file)" do
|
45
|
+
expect(File).to receive(:directory?).with('myyardoc').and_return(false)
|
46
|
+
expect(File).to receive(:file?).with('myyardoc').and_return(true)
|
47
|
+
expect(File).to receive(:read_binary).with('myyardoc').and_return(Marshal.dump(''))
|
48
|
+
expect(@store.load('myyardoc')).to be true
|
49
|
+
end
|
50
|
+
|
51
|
+
it "returns true if .yardoc is loaded (directory)" do
|
52
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
53
|
+
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
54
|
+
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
55
|
+
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
56
|
+
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
57
|
+
expect(@store.load('foo')).to be true
|
58
|
+
end
|
59
|
+
|
60
|
+
it "returns false if .yardoc does not exist" do
|
61
|
+
expect(@store.load('NONEXIST')).to be false
|
62
|
+
end
|
63
|
+
|
64
|
+
it "returns false if there is no file to load" do
|
65
|
+
expect(@store.load(nil)).to be false
|
66
|
+
end
|
67
|
+
|
68
|
+
it "loads checksums if they exist" do
|
69
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
70
|
+
expect(File).to receive(:file?).with('foo/checksums').and_return(true)
|
71
|
+
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
72
|
+
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
73
|
+
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
74
|
+
expect(File).to receive(:readlines).with('foo/checksums').and_return([
|
75
|
+
'file1 CHECKSUM1', ' file2 CHECKSUM2 '
|
76
|
+
])
|
77
|
+
expect(@store.load('foo')).to be true
|
78
|
+
expect(@store.checksums).to eq('file1' => 'CHECKSUM1', 'file2' => 'CHECKSUM2')
|
79
|
+
end
|
80
|
+
|
81
|
+
it "loads proxy_types if they exist" do
|
82
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
83
|
+
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
84
|
+
expect(File).to receive(:file?).with('foo/proxy_types').and_return(true)
|
85
|
+
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
86
|
+
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
87
|
+
expect(File).to receive(:read_binary).with('foo/proxy_types').and_return(Marshal.dump('a' => 'b'))
|
88
|
+
expect(@store.load('foo')).to be true
|
89
|
+
expect(@store.proxy_types).to eq('a' => 'b')
|
90
|
+
end
|
91
|
+
|
92
|
+
it "loads root object if it exists" do
|
93
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
94
|
+
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
95
|
+
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
96
|
+
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
97
|
+
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(true)
|
98
|
+
expect(File).to receive(:read_binary).with('foo/objects/root.dat').and_return(Marshal.dump(@foo))
|
99
|
+
expect(@store.load('foo')).to be true
|
100
|
+
expect(@store.root).to eq @foo
|
101
|
+
end
|
102
|
+
end
|
103
|
+
|
104
|
+
describe "#save" do
|
105
|
+
before do
|
106
|
+
allow(@store).to receive(:write_proxy_types)
|
107
|
+
allow(@store).to receive(:write_checksums)
|
108
|
+
allow(@store).to receive(:destroy)
|
109
|
+
end
|
110
|
+
|
111
|
+
after do
|
112
|
+
Registry.single_object_db = nil
|
113
|
+
end
|
114
|
+
|
115
|
+
def saves_to_singledb
|
116
|
+
expect(@serializer).to receive(:serialize).once.with(instance_of(Hash))
|
117
|
+
@store.save(true, 'foo')
|
118
|
+
end
|
119
|
+
|
120
|
+
def add_items(n)
|
121
|
+
n.times {|i| @store[i.to_s] = @foo }
|
122
|
+
end
|
123
|
+
|
124
|
+
def saves_to_multidb
|
125
|
+
times = @store.keys.size
|
126
|
+
expect(@serializer).to receive(:serialize).exactly(times).times
|
127
|
+
@store.save(true, 'foo')
|
128
|
+
@last = times
|
129
|
+
end
|
130
|
+
|
131
|
+
it "saves as single object db if single_object_db is nil and there are less than 3000 objects" do
|
132
|
+
Registry.single_object_db = nil
|
133
|
+
add_items(100)
|
134
|
+
saves_to_singledb
|
135
|
+
expect(@serializer.complete?).to eq true
|
136
|
+
end
|
137
|
+
|
138
|
+
it "saves as single object db if single_object_db is nil and there are more than 3000 objects" do
|
139
|
+
Registry.single_object_db = nil
|
140
|
+
add_items(5000)
|
141
|
+
saves_to_singledb
|
142
|
+
end
|
143
|
+
|
144
|
+
it "saves as single object db if single_object_db is true (and any amount of objects)" do
|
145
|
+
Registry.single_object_db = true
|
146
|
+
add_items(100)
|
147
|
+
saves_to_singledb
|
148
|
+
add_items(5000)
|
149
|
+
saves_to_singledb
|
150
|
+
end
|
151
|
+
|
152
|
+
it "never saves as single object db if single_object_db is false" do
|
153
|
+
Registry.single_object_db = false
|
154
|
+
add_items(100)
|
155
|
+
saves_to_multidb
|
156
|
+
add_items(5000)
|
157
|
+
saves_to_multidb
|
158
|
+
end
|
159
|
+
end
|
160
|
+
|
161
|
+
describe "#put" do
|
162
|
+
it "assigns values" do
|
163
|
+
@store.put(:YARD, @foo)
|
164
|
+
expect(@store.get(:YARD)).to eq @foo
|
165
|
+
end
|
166
|
+
|
167
|
+
it "treats '' as root" do
|
168
|
+
@store.put('', @foo)
|
169
|
+
expect(@store.get(:root)).to eq @foo
|
170
|
+
end
|
171
|
+
end
|
172
|
+
|
173
|
+
describe "#get" do
|
174
|
+
it "hits cache if object exists" do
|
175
|
+
@store.put(:YARD, @foo)
|
176
|
+
expect(@store.get(:YARD)).to eq @foo
|
177
|
+
end
|
178
|
+
|
179
|
+
it "hits backstore on cache miss and cache is not fully loaded" do
|
180
|
+
serializer = double(:serializer)
|
181
|
+
expect(serializer).to receive(:deserialize).once.with(:YARD).and_return(@foo)
|
182
|
+
@store.load('foo')
|
183
|
+
@store.instance_variable_set("@loaded_objects", 0)
|
184
|
+
@store.instance_variable_set("@available_objects", 100)
|
185
|
+
@store.instance_variable_set("@serializer", serializer)
|
186
|
+
expect(@store.get(:YARD)).to eq @foo
|
187
|
+
expect(@store.get(:YARD)).to eq @foo
|
188
|
+
expect(@store.instance_variable_get("@loaded_objects")).to eq 1
|
189
|
+
end
|
190
|
+
end
|
191
|
+
|
192
|
+
[:keys, :values].each do |item|
|
193
|
+
describe "##{item}" do
|
194
|
+
it "loads entire database if reload=true" do
|
195
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
196
|
+
@store.load('foo')
|
197
|
+
expect(@store).to receive(:load_all)
|
198
|
+
@store.send(item, true)
|
199
|
+
end
|
200
|
+
|
201
|
+
it "does not load entire database if reload=false" do
|
202
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
203
|
+
@store.load('foo')
|
204
|
+
expect(@store).not_to receive(:load_all)
|
205
|
+
@store.send(item, false)
|
206
|
+
end
|
207
|
+
end
|
208
|
+
end
|
209
|
+
|
210
|
+
describe "#paths_for_type" do
|
211
|
+
after { Registry.clear }
|
212
|
+
|
213
|
+
it "sets all object types if not set by object_types" do
|
214
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
215
|
+
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
216
|
+
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
217
|
+
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
218
|
+
expect(@serializer).to receive(:deserialize).with('root').and_return(:'A#foo' => @foo, :A => @bar)
|
219
|
+
@store.load('foo')
|
220
|
+
expect(@store.paths_for_type(:method)).to eq ['#foo']
|
221
|
+
expect(@store.paths_for_type(:class)).to eq ['Bar']
|
222
|
+
end
|
223
|
+
|
224
|
+
it "keeps track of types when assigning values" do
|
225
|
+
@store.put(:abc, @foo)
|
226
|
+
expect(@store.paths_for_type(@foo.type)).to eq ['abc']
|
227
|
+
end
|
228
|
+
|
229
|
+
it "reassigns path if type changes" do
|
230
|
+
foo = CodeObjects::ClassObject.new(:root, :Foo)
|
231
|
+
@store.put('Foo', foo)
|
232
|
+
expect(@store.get('Foo').type).to eq :class
|
233
|
+
expect(@store.paths_for_type(:class)).to eq ["Foo"]
|
234
|
+
foo = CodeObjects::ModuleObject.new(:root, :Foo)
|
235
|
+
@store.put('Foo', foo)
|
236
|
+
expect(@store.get('Foo').type).to eq :module
|
237
|
+
expect(@store.paths_for_type(:class)).to eq []
|
238
|
+
expect(@store.paths_for_type(:module)).to eq ["Foo"]
|
239
|
+
end
|
240
|
+
end
|
241
|
+
|
242
|
+
describe "#values_for_type" do
|
243
|
+
it "returns all objects with type" do
|
244
|
+
@store.put(:abc, @foo)
|
245
|
+
expect(@store.values_for_type(@foo.type)).to eq [@foo]
|
246
|
+
end
|
247
|
+
end
|
248
|
+
|
249
|
+
describe "#load_all" do
|
250
|
+
it "loads the entire database" do
|
251
|
+
foomock = double(:Foo)
|
252
|
+
barmock = double(:Bar)
|
253
|
+
allow(foomock).to receive(:type).and_return(:class)
|
254
|
+
allow(barmock).to receive(:type).and_return(:class)
|
255
|
+
expect(foomock).to receive(:path).and_return('Foo')
|
256
|
+
expect(barmock).to receive(:path).and_return('Bar')
|
257
|
+
expect(File).to receive(:directory?).with('foo').and_return(true)
|
258
|
+
expect(File).to receive(:file?).with('foo/proxy_types').and_return(false)
|
259
|
+
expect(File).to receive(:file?).with('foo/object_types').and_return(false)
|
260
|
+
expect(File).to receive(:file?).with('foo/checksums').and_return(false)
|
261
|
+
expect(File).to receive(:file?).with('foo/objects/root.dat').and_return(false)
|
262
|
+
expect(@store).to receive(:all_disk_objects).at_least(1).times.and_return(['foo/objects/foo', 'foo/objects/bar'])
|
263
|
+
@store.load('foo')
|
264
|
+
serializer = @store.instance_variable_get("@serializer")
|
265
|
+
expect(serializer).to receive(:deserialize).with('foo/objects/foo', true).and_return(foomock)
|
266
|
+
expect(serializer).to receive(:deserialize).with('foo/objects/bar', true).and_return(barmock)
|
267
|
+
@store.send(:load_all)
|
268
|
+
expect(@store.instance_variable_get("@available_objects")).to eq 2
|
269
|
+
expect(@store.instance_variable_get("@loaded_objects")).to eq 2
|
270
|
+
expect(@store[:Foo]).to eq foomock
|
271
|
+
expect(@store[:Bar]).to eq barmock
|
272
|
+
end
|
273
|
+
end
|
274
|
+
|
275
|
+
describe "#destroy" do
|
276
|
+
it "destroys file ending in .yardoc when force=false" do
|
277
|
+
expect(File).to receive(:file?).with('foo.yardoc').and_return(true)
|
278
|
+
expect(File).to receive(:unlink).with('foo.yardoc')
|
279
|
+
@store.instance_variable_set("@file", 'foo.yardoc')
|
280
|
+
expect(@store.destroy).to be true
|
281
|
+
end
|
282
|
+
|
283
|
+
it "destroys dir ending in .yardoc when force=false" do
|
284
|
+
expect(File).to receive(:directory?).with('foo.yardoc').and_return(true)
|
285
|
+
expect(FileUtils).to receive(:rm_rf).with('foo.yardoc')
|
286
|
+
@store.instance_variable_set("@file", 'foo.yardoc')
|
287
|
+
expect(@store.destroy).to be true
|
288
|
+
end
|
289
|
+
|
290
|
+
it "does not destroy file/dir not ending in .yardoc when force=false" do
|
291
|
+
expect(File).not_to receive(:file?).with('foo')
|
292
|
+
expect(File).not_to receive(:directory?).with('foo')
|
293
|
+
expect(File).not_to receive(:unlink).with('foo')
|
294
|
+
expect(FileUtils).not_to receive(:rm_rf).with('foo')
|
295
|
+
@store.instance_variable_set("@file", 'foo')
|
296
|
+
expect(@store.destroy).to be false
|
297
|
+
end
|
298
|
+
|
299
|
+
it "destroys any file/dir when force=true" do
|
300
|
+
expect(File).to receive(:file?).with('foo').and_return(true)
|
301
|
+
expect(File).to receive(:unlink).with('foo')
|
302
|
+
@store.instance_variable_set("@file", 'foo')
|
303
|
+
expect(@store.destroy(true)).to be true
|
304
|
+
end
|
305
|
+
end
|
306
|
+
|
307
|
+
describe "#locale" do
|
308
|
+
it "loads ./po/LOCALE_NAME.po" do
|
309
|
+
fr_locale = I18n::Locale.new("fr")
|
310
|
+
expect(I18n::Locale).to receive(:new).with("fr").and_return(fr_locale)
|
311
|
+
expect(Registry).to receive(:po_dir).and_return("po")
|
312
|
+
expect(fr_locale).to receive(:load).with("po")
|
313
|
+
expect(@store.locale("fr")).to eq fr_locale
|
314
|
+
end
|
315
|
+
end
|
316
|
+
end
|