deg-yard 0.8.7.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.travis.yml +39 -0
- data/.yardopts +25 -0
- data/.yardopts_guide +19 -0
- data/.yardopts_i18n +22 -0
- data/Gemfile +35 -0
- data/LEGAL +66 -0
- data/LICENSE +22 -0
- data/README.md +609 -0
- data/Rakefile +66 -0
- data/benchmarks/builtins_vs_eval.rb +23 -0
- data/benchmarks/concat_vs_join.rb +12 -0
- data/benchmarks/erb_vs_erubis.rb +53 -0
- data/benchmarks/format_args.rb +46 -0
- data/benchmarks/generation.rb +37 -0
- data/benchmarks/marshal_vs_dbm.rb +63 -0
- data/benchmarks/parsing.rb +46 -0
- data/benchmarks/pathname_vs_string.rb +50 -0
- data/benchmarks/rdoc_vs_yardoc.rb +10 -0
- data/benchmarks/registry_store_types.rb +48 -0
- data/benchmarks/ri_vs_yri.rb +18 -0
- data/benchmarks/ripper_parser.rb +12 -0
- data/benchmarks/splat_vs_flatten.rb +12 -0
- data/benchmarks/template_erb.rb +22 -0
- data/benchmarks/template_format.rb +6 -0
- data/benchmarks/template_profile.rb +17 -0
- data/benchmarks/yri_cache.rb +19 -0
- data/bin/yard +12 -0
- data/bin/yardoc +12 -0
- data/bin/yri +12 -0
- data/docs/CodeObjects.md +115 -0
- data/docs/GettingStarted.md +592 -0
- data/docs/Handlers.md +152 -0
- data/docs/Overview.md +61 -0
- data/docs/Parser.md +191 -0
- data/docs/Tags.md +282 -0
- data/docs/TagsArch.md +123 -0
- data/docs/Templates.md +496 -0
- data/docs/WhatsNew.md +1244 -0
- data/docs/images/code-objects-class-diagram.png +0 -0
- data/docs/images/handlers-class-diagram.png +0 -0
- data/docs/images/overview-class-diagram.png +0 -0
- data/docs/images/parser-class-diagram.png +0 -0
- data/docs/images/tags-class-diagram.png +0 -0
- data/docs/templates/default/fulldoc/html/full_list_tag.erb +7 -0
- data/docs/templates/default/fulldoc/html/setup.rb +6 -0
- data/docs/templates/default/layout/html/setup.rb +8 -0
- data/docs/templates/default/layout/html/tag_list.erb +11 -0
- data/docs/templates/default/yard_tags/html/list.erb +18 -0
- data/docs/templates/default/yard_tags/html/setup.rb +27 -0
- data/docs/templates/plugin.rb +65 -0
- data/lib/rubygems_plugin.rb +4 -0
- data/lib/yard/autoload.rb +290 -0
- data/lib/yard/cli/command.rb +84 -0
- data/lib/yard/cli/command_parser.rb +92 -0
- data/lib/yard/cli/config.rb +136 -0
- data/lib/yard/cli/diff.rb +270 -0
- data/lib/yard/cli/display.rb +68 -0
- data/lib/yard/cli/gems.rb +83 -0
- data/lib/yard/cli/graph.rb +126 -0
- data/lib/yard/cli/help.rb +18 -0
- data/lib/yard/cli/i18n.rb +69 -0
- data/lib/yard/cli/list.rb +22 -0
- data/lib/yard/cli/markup_types.rb +33 -0
- data/lib/yard/cli/server.rb +253 -0
- data/lib/yard/cli/stats.rb +213 -0
- data/lib/yard/cli/yardoc.rb +752 -0
- data/lib/yard/cli/yardopts_command.rb +109 -0
- data/lib/yard/cli/yri.rb +214 -0
- data/lib/yard/code_objects/base.rb +585 -0
- data/lib/yard/code_objects/class_object.rb +143 -0
- data/lib/yard/code_objects/class_variable_object.rb +8 -0
- data/lib/yard/code_objects/constant_object.rb +13 -0
- data/lib/yard/code_objects/extended_method_object.rb +23 -0
- data/lib/yard/code_objects/extra_file_object.rb +128 -0
- data/lib/yard/code_objects/macro_object.rb +172 -0
- data/lib/yard/code_objects/method_object.rb +191 -0
- data/lib/yard/code_objects/module_object.rb +18 -0
- data/lib/yard/code_objects/namespace_object.rb +200 -0
- data/lib/yard/code_objects/proxy.rb +258 -0
- data/lib/yard/code_objects/root_object.rb +17 -0
- data/lib/yard/config.rb +269 -0
- data/lib/yard/core_ext/array.rb +15 -0
- data/lib/yard/core_ext/file.rb +65 -0
- data/lib/yard/core_ext/hash.rb +15 -0
- data/lib/yard/core_ext/insertion.rb +60 -0
- data/lib/yard/core_ext/module.rb +19 -0
- data/lib/yard/core_ext/string.rb +67 -0
- data/lib/yard/core_ext/symbol_hash.rb +73 -0
- data/lib/yard/docstring.rb +362 -0
- data/lib/yard/docstring_parser.rb +321 -0
- data/lib/yard/globals.rb +18 -0
- data/lib/yard/handlers/base.rb +597 -0
- data/lib/yard/handlers/c/alias_handler.rb +15 -0
- data/lib/yard/handlers/c/attribute_handler.rb +13 -0
- data/lib/yard/handlers/c/base.rb +110 -0
- data/lib/yard/handlers/c/class_handler.rb +26 -0
- data/lib/yard/handlers/c/constant_handler.rb +12 -0
- data/lib/yard/handlers/c/handler_methods.rb +166 -0
- data/lib/yard/handlers/c/init_handler.rb +18 -0
- data/lib/yard/handlers/c/method_handler.rb +35 -0
- data/lib/yard/handlers/c/mixin_handler.rb +13 -0
- data/lib/yard/handlers/c/module_handler.rb +16 -0
- data/lib/yard/handlers/c/override_comment_handler.rb +30 -0
- data/lib/yard/handlers/c/path_handler.rb +10 -0
- data/lib/yard/handlers/c/struct_handler.rb +12 -0
- data/lib/yard/handlers/c/symbol_handler.rb +7 -0
- data/lib/yard/handlers/processor.rb +201 -0
- data/lib/yard/handlers/ruby/alias_handler.rb +41 -0
- data/lib/yard/handlers/ruby/attribute_handler.rb +82 -0
- data/lib/yard/handlers/ruby/base.rb +164 -0
- data/lib/yard/handlers/ruby/class_condition_handler.rb +86 -0
- data/lib/yard/handlers/ruby/class_handler.rb +121 -0
- data/lib/yard/handlers/ruby/class_variable_handler.rb +16 -0
- data/lib/yard/handlers/ruby/comment_handler.rb +9 -0
- data/lib/yard/handlers/ruby/constant_handler.rb +45 -0
- data/lib/yard/handlers/ruby/dsl_handler.rb +14 -0
- data/lib/yard/handlers/ruby/dsl_handler_methods.rb +77 -0
- data/lib/yard/handlers/ruby/exception_handler.rb +26 -0
- data/lib/yard/handlers/ruby/extend_handler.rb +21 -0
- data/lib/yard/handlers/ruby/legacy/alias_handler.rb +34 -0
- data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +60 -0
- data/lib/yard/handlers/ruby/legacy/base.rb +250 -0
- data/lib/yard/handlers/ruby/legacy/class_condition_handler.rb +83 -0
- data/lib/yard/handlers/ruby/legacy/class_handler.rb +111 -0
- data/lib/yard/handlers/ruby/legacy/class_variable_handler.rb +14 -0
- data/lib/yard/handlers/ruby/legacy/comment_handler.rb +9 -0
- data/lib/yard/handlers/ruby/legacy/constant_handler.rb +28 -0
- data/lib/yard/handlers/ruby/legacy/dsl_handler.rb +16 -0
- data/lib/yard/handlers/ruby/legacy/exception_handler.rb +12 -0
- data/lib/yard/handlers/ruby/legacy/extend_handler.rb +20 -0
- data/lib/yard/handlers/ruby/legacy/method_handler.rb +85 -0
- data/lib/yard/handlers/ruby/legacy/mixin_handler.rb +39 -0
- data/lib/yard/handlers/ruby/legacy/module_function_handler.rb +18 -0
- data/lib/yard/handlers/ruby/legacy/module_handler.rb +11 -0
- data/lib/yard/handlers/ruby/legacy/private_constant_handler.rb +21 -0
- data/lib/yard/handlers/ruby/legacy/visibility_handler.rb +16 -0
- data/lib/yard/handlers/ruby/legacy/yield_handler.rb +28 -0
- data/lib/yard/handlers/ruby/method_condition_handler.rb +8 -0
- data/lib/yard/handlers/ruby/method_handler.rb +92 -0
- data/lib/yard/handlers/ruby/mixin_handler.rb +36 -0
- data/lib/yard/handlers/ruby/module_function_handler.rb +26 -0
- data/lib/yard/handlers/ruby/module_handler.rb +11 -0
- data/lib/yard/handlers/ruby/private_constant_handler.rb +36 -0
- data/lib/yard/handlers/ruby/struct_handler_methods.rb +141 -0
- data/lib/yard/handlers/ruby/visibility_handler.rb +24 -0
- data/lib/yard/handlers/ruby/yield_handler.rb +30 -0
- data/lib/yard/i18n/locale.rb +74 -0
- data/lib/yard/i18n/message.rb +56 -0
- data/lib/yard/i18n/messages.rb +55 -0
- data/lib/yard/i18n/pot_generator.rb +280 -0
- data/lib/yard/i18n/text.rb +173 -0
- data/lib/yard/logging.rb +190 -0
- data/lib/yard/options.rb +216 -0
- data/lib/yard/parser/base.rb +56 -0
- data/lib/yard/parser/c/c_parser.rb +231 -0
- data/lib/yard/parser/c/comment_parser.rb +131 -0
- data/lib/yard/parser/c/statement.rb +63 -0
- data/lib/yard/parser/ruby/ast_node.rb +496 -0
- data/lib/yard/parser/ruby/legacy/ruby_lex.rb +1378 -0
- data/lib/yard/parser/ruby/legacy/ruby_parser.rb +31 -0
- data/lib/yard/parser/ruby/legacy/statement.rb +65 -0
- data/lib/yard/parser/ruby/legacy/statement_list.rb +384 -0
- data/lib/yard/parser/ruby/legacy/token_list.rb +71 -0
- data/lib/yard/parser/ruby/ruby_parser.rb +625 -0
- data/lib/yard/parser/source_parser.rb +517 -0
- data/lib/yard/rake/yardoc_task.rb +74 -0
- data/lib/yard/registry.rb +438 -0
- data/lib/yard/registry_store.rb +319 -0
- data/lib/yard/rubygems/backports/LICENSE.txt +57 -0
- data/lib/yard/rubygems/backports/MIT.txt +20 -0
- data/lib/yard/rubygems/backports/gem.rb +9 -0
- data/lib/yard/rubygems/backports/source_index.rb +370 -0
- data/lib/yard/rubygems/backports.rb +8 -0
- data/lib/yard/rubygems/doc_manager.rb +88 -0
- data/lib/yard/rubygems/specification.rb +41 -0
- data/lib/yard/serializers/base.rb +80 -0
- data/lib/yard/serializers/file_system_serializer.rb +90 -0
- data/lib/yard/serializers/process_serializer.rb +24 -0
- data/lib/yard/serializers/stdout_serializer.rb +32 -0
- data/lib/yard/serializers/yardoc_serializer.rb +124 -0
- data/lib/yard/server/adapter.rb +100 -0
- data/lib/yard/server/commands/base.rb +192 -0
- data/lib/yard/server/commands/display_file_command.rb +24 -0
- data/lib/yard/server/commands/display_object_command.rb +58 -0
- data/lib/yard/server/commands/frames_command.rb +15 -0
- data/lib/yard/server/commands/library_command.rb +148 -0
- data/lib/yard/server/commands/library_index_command.rb +24 -0
- data/lib/yard/server/commands/list_command.rb +24 -0
- data/lib/yard/server/commands/search_command.rb +78 -0
- data/lib/yard/server/commands/static_file_command.rb +57 -0
- data/lib/yard/server/doc_server_helper.rb +76 -0
- data/lib/yard/server/doc_server_serializer.rb +33 -0
- data/lib/yard/server/library_version.rb +227 -0
- data/lib/yard/server/rack_adapter.rb +88 -0
- data/lib/yard/server/router.rb +176 -0
- data/lib/yard/server/static_caching.rb +45 -0
- data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +78 -0
- data/lib/yard/server/templates/default/fulldoc/html/images/processing.gif +0 -0
- data/lib/yard/server/templates/default/fulldoc/html/js/autocomplete.js +12 -0
- data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +46 -0
- data/lib/yard/server/templates/default/layout/html/script_setup.erb +8 -0
- data/lib/yard/server/templates/default/layout/html/setup.rb +7 -0
- data/lib/yard/server/templates/default/method_details/html/permalink.erb +4 -0
- data/lib/yard/server/templates/default/method_details/html/setup.rb +4 -0
- data/lib/yard/server/templates/doc_server/library_list/html/contents.erb +13 -0
- data/lib/yard/server/templates/doc_server/library_list/html/headers.erb +26 -0
- data/lib/yard/server/templates/doc_server/library_list/html/library_list.erb +12 -0
- data/lib/yard/server/templates/doc_server/library_list/html/setup.rb +3 -0
- data/lib/yard/server/templates/doc_server/library_list/html/title.erb +2 -0
- data/lib/yard/server/templates/doc_server/processing/html/processing.erb +51 -0
- data/lib/yard/server/templates/doc_server/processing/html/setup.rb +3 -0
- data/lib/yard/server/templates/doc_server/search/html/search.erb +18 -0
- data/lib/yard/server/templates/doc_server/search/html/setup.rb +8 -0
- data/lib/yard/server/webrick_adapter.rb +43 -0
- data/lib/yard/server.rb +11 -0
- data/lib/yard/tags/default_factory.rb +176 -0
- data/lib/yard/tags/default_tag.rb +12 -0
- data/lib/yard/tags/directives.rb +599 -0
- data/lib/yard/tags/library.rb +630 -0
- data/lib/yard/tags/option_tag.rb +12 -0
- data/lib/yard/tags/overload_tag.rb +66 -0
- data/lib/yard/tags/ref_tag.rb +7 -0
- data/lib/yard/tags/ref_tag_list.rb +27 -0
- data/lib/yard/tags/tag.rb +57 -0
- data/lib/yard/tags/tag_format_error.rb +6 -0
- data/lib/yard/templates/engine.rb +185 -0
- data/lib/yard/templates/erb_cache.rb +22 -0
- data/lib/yard/templates/helpers/base_helper.rb +212 -0
- data/lib/yard/templates/helpers/filter_helper.rb +26 -0
- data/lib/yard/templates/helpers/html_helper.rb +599 -0
- data/lib/yard/templates/helpers/html_syntax_highlight_helper.rb +59 -0
- data/lib/yard/templates/helpers/markup/rdoc_markdown.rb +22 -0
- data/lib/yard/templates/helpers/markup/rdoc_markup.rb +106 -0
- data/lib/yard/templates/helpers/markup_helper.rb +169 -0
- data/lib/yard/templates/helpers/method_helper.rb +74 -0
- data/lib/yard/templates/helpers/module_helper.rb +19 -0
- data/lib/yard/templates/helpers/text_helper.rb +95 -0
- data/lib/yard/templates/helpers/uml_helper.rb +46 -0
- data/lib/yard/templates/section.rb +106 -0
- data/lib/yard/templates/template.rb +407 -0
- data/lib/yard/templates/template_options.rb +88 -0
- data/lib/yard/verifier.rb +148 -0
- data/lib/yard/version.rb +3 -0
- data/lib/yard.rb +71 -0
- data/po/ja.po +31118 -0
- data/spec/cli/command_parser_spec.rb +43 -0
- data/spec/cli/command_spec.rb +36 -0
- data/spec/cli/config_spec.rb +92 -0
- data/spec/cli/diff_spec.rb +260 -0
- data/spec/cli/display_spec.rb +30 -0
- data/spec/cli/gems_spec.rb +81 -0
- data/spec/cli/graph_spec.rb +17 -0
- data/spec/cli/help_spec.rb +22 -0
- data/spec/cli/i18n_spec.rb +111 -0
- data/spec/cli/list_spec.rb +8 -0
- data/spec/cli/markup_types_spec.rb +22 -0
- data/spec/cli/server_spec.rb +327 -0
- data/spec/cli/stats_spec.rb +90 -0
- data/spec/cli/yardoc_spec.rb +804 -0
- data/spec/cli/yri_spec.rb +99 -0
- data/spec/code_objects/base_spec.rb +438 -0
- data/spec/code_objects/class_object_spec.rb +225 -0
- data/spec/code_objects/code_object_list_spec.rb +33 -0
- data/spec/code_objects/constants_spec.rb +82 -0
- data/spec/code_objects/extra_file_object_spec.rb +147 -0
- data/spec/code_objects/macro_object_spec.rb +148 -0
- data/spec/code_objects/method_object_spec.rb +175 -0
- data/spec/code_objects/module_object_spec.rb +141 -0
- data/spec/code_objects/namespace_object_spec.rb +170 -0
- data/spec/code_objects/proxy_spec.rb +140 -0
- data/spec/code_objects/spec_helper.rb +3 -0
- data/spec/config_spec.rb +176 -0
- data/spec/core_ext/array_spec.rb +14 -0
- data/spec/core_ext/file_spec.rb +68 -0
- data/spec/core_ext/hash_spec.rb +14 -0
- data/spec/core_ext/insertion_spec.rb +37 -0
- data/spec/core_ext/module_spec.rb +15 -0
- data/spec/core_ext/string_spec.rb +42 -0
- data/spec/core_ext/symbol_hash_spec.rb +86 -0
- data/spec/docstring_parser_spec.rb +228 -0
- data/spec/docstring_spec.rb +335 -0
- data/spec/handlers/alias_handler_spec.rb +80 -0
- data/spec/handlers/attribute_handler_spec.rb +94 -0
- data/spec/handlers/base_spec.rb +206 -0
- data/spec/handlers/c/alias_handler_spec.rb +33 -0
- data/spec/handlers/c/attribute_handler_spec.rb +40 -0
- data/spec/handlers/c/class_handler_spec.rb +63 -0
- data/spec/handlers/c/constant_handler_spec.rb +68 -0
- data/spec/handlers/c/init_handler_spec.rb +47 -0
- data/spec/handlers/c/method_handler_spec.rb +229 -0
- data/spec/handlers/c/mixin_handler_spec.rb +27 -0
- data/spec/handlers/c/module_handler_spec.rb +38 -0
- data/spec/handlers/c/override_comment_handler_spec.rb +46 -0
- data/spec/handlers/c/path_handler_spec.rb +35 -0
- data/spec/handlers/c/spec_helper.rb +13 -0
- data/spec/handlers/c/struct_handler_spec.rb +15 -0
- data/spec/handlers/class_condition_handler_spec.rb +67 -0
- data/spec/handlers/class_handler_spec.rb +246 -0
- data/spec/handlers/class_variable_handler_spec.rb +11 -0
- data/spec/handlers/constant_handler_spec.rb +64 -0
- data/spec/handlers/dsl_handler_spec.rb +197 -0
- data/spec/handlers/examples/alias_handler_001.rb.txt +44 -0
- data/spec/handlers/examples/attribute_handler_001.rb.txt +32 -0
- data/spec/handlers/examples/class_condition_handler_001.rb.txt +69 -0
- data/spec/handlers/examples/class_handler_001.rb.txt +120 -0
- data/spec/handlers/examples/class_variable_handler_001.rb.txt +10 -0
- data/spec/handlers/examples/constant_handler_001.rb.txt +25 -0
- data/spec/handlers/examples/dsl_handler_001.rb.txt +125 -0
- data/spec/handlers/examples/exception_handler_001.rb.txt +59 -0
- data/spec/handlers/examples/extend_handler_001.rb.txt +16 -0
- data/spec/handlers/examples/method_condition_handler_001.rb.txt +10 -0
- data/spec/handlers/examples/method_handler_001.rb.txt +126 -0
- data/spec/handlers/examples/mixin_handler_001.rb.txt +37 -0
- data/spec/handlers/examples/module_handler_001.rb.txt +29 -0
- data/spec/handlers/examples/private_constant_handler_001.rb.txt +8 -0
- data/spec/handlers/examples/process_handler_001.rb.txt +11 -0
- data/spec/handlers/examples/visibility_handler_001.rb.txt +32 -0
- data/spec/handlers/examples/yield_handler_001.rb.txt +54 -0
- data/spec/handlers/exception_handler_spec.rb +48 -0
- data/spec/handlers/extend_handler_spec.rb +23 -0
- data/spec/handlers/legacy_base_spec.rb +128 -0
- data/spec/handlers/method_condition_handler_spec.rb +14 -0
- data/spec/handlers/method_handler_spec.rb +184 -0
- data/spec/handlers/mixin_handler_spec.rb +55 -0
- data/spec/handlers/module_function_handler_spec.rb +105 -0
- data/spec/handlers/module_handler_spec.rb +34 -0
- data/spec/handlers/private_constant_handler_spec.rb +24 -0
- data/spec/handlers/processor_spec.rb +34 -0
- data/spec/handlers/ruby/base_spec.rb +94 -0
- data/spec/handlers/ruby/legacy/base_spec.rb +82 -0
- data/spec/handlers/spec_helper.rb +33 -0
- data/spec/handlers/visibility_handler_spec.rb +39 -0
- data/spec/handlers/yield_handler_spec.rb +51 -0
- data/spec/i18n/locale_spec.rb +68 -0
- data/spec/i18n/message_spec.rb +52 -0
- data/spec/i18n/messages_spec.rb +67 -0
- data/spec/i18n/pot_generator_spec.rb +262 -0
- data/spec/i18n/text_spec.rb +180 -0
- data/spec/logging_spec.rb +35 -0
- data/spec/options_spec.rb +171 -0
- data/spec/parser/base_spec.rb +24 -0
- data/spec/parser/c_parser_spec.rb +171 -0
- data/spec/parser/examples/array.c.txt +3887 -0
- data/spec/parser/examples/example1.rb.txt +8 -0
- data/spec/parser/examples/extrafile.c.txt +8 -0
- data/spec/parser/examples/multifile.c.txt +22 -0
- data/spec/parser/examples/override.c.txt +424 -0
- data/spec/parser/examples/parse_in_order_001.rb.txt +2 -0
- data/spec/parser/examples/parse_in_order_002.rb.txt +2 -0
- data/spec/parser/examples/tag_handler_001.rb.txt +8 -0
- data/spec/parser/ruby/ast_node_spec.rb +33 -0
- data/spec/parser/ruby/legacy/statement_list_spec.rb +299 -0
- data/spec/parser/ruby/legacy/token_list_spec.rb +77 -0
- data/spec/parser/ruby/ruby_parser_spec.rb +334 -0
- data/spec/parser/source_parser_spec.rb +717 -0
- data/spec/parser/tag_parsing_spec.rb +18 -0
- data/spec/rake/yardoc_task_spec.rb +101 -0
- data/spec/registry_spec.rb +393 -0
- data/spec/registry_store_spec.rb +315 -0
- data/spec/rubygems/doc_manager_spec.rb +112 -0
- data/spec/serializers/data/serialized_yardoc/checksums +1 -0
- data/spec/serializers/data/serialized_yardoc/objects/Foo/bar_i.dat +0 -0
- data/spec/serializers/data/serialized_yardoc/objects/Foo/baz_i.dat +0 -0
- data/spec/serializers/data/serialized_yardoc/objects/Foo.dat +0 -0
- data/spec/serializers/data/serialized_yardoc/objects/root.dat +0 -0
- data/spec/serializers/data/serialized_yardoc/proxy_types +2 -0
- data/spec/serializers/file_system_serializer_spec.rb +124 -0
- data/spec/serializers/spec_helper.rb +2 -0
- data/spec/serializers/yardoc_serializer_spec.rb +46 -0
- data/spec/server/adapter_spec.rb +38 -0
- data/spec/server/commands/base_spec.rb +87 -0
- data/spec/server/commands/library_command_spec.rb +39 -0
- data/spec/server/commands/static_file_command_spec.rb +84 -0
- data/spec/server/doc_server_helper_spec.rb +53 -0
- data/spec/server/doc_server_serializer_spec.rb +45 -0
- data/spec/server/rack_adapter_spec.rb +20 -0
- data/spec/server/router_spec.rb +122 -0
- data/spec/server/spec_helper.rb +17 -0
- data/spec/server/static_caching_spec.rb +39 -0
- data/spec/server/webrick_servlet_spec.rb +20 -0
- data/spec/server_spec.rb +10 -0
- data/spec/spec_helper.rb +128 -0
- data/spec/tags/default_factory_spec.rb +152 -0
- data/spec/tags/default_tag_spec.rb +11 -0
- data/spec/tags/directives_spec.rb +453 -0
- data/spec/tags/library_spec.rb +34 -0
- data/spec/tags/overload_tag_spec.rb +53 -0
- data/spec/tags/ref_tag_list_spec.rb +53 -0
- data/spec/templates/class_spec.rb +44 -0
- data/spec/templates/constant_spec.rb +40 -0
- data/spec/templates/engine_spec.rb +121 -0
- data/spec/templates/examples/class001.html +280 -0
- data/spec/templates/examples/class001.txt +36 -0
- data/spec/templates/examples/class002.html +35 -0
- data/spec/templates/examples/constant001.txt +25 -0
- data/spec/templates/examples/constant002.txt +7 -0
- data/spec/templates/examples/constant003.txt +11 -0
- data/spec/templates/examples/method001.html +130 -0
- data/spec/templates/examples/method001.txt +35 -0
- data/spec/templates/examples/method002.html +86 -0
- data/spec/templates/examples/method002.txt +20 -0
- data/spec/templates/examples/method003.html +159 -0
- data/spec/templates/examples/method003.txt +45 -0
- data/spec/templates/examples/method004.html +44 -0
- data/spec/templates/examples/method004.txt +10 -0
- data/spec/templates/examples/method005.html +99 -0
- data/spec/templates/examples/method005.txt +33 -0
- data/spec/templates/examples/module001.dot +33 -0
- data/spec/templates/examples/module001.html +825 -0
- data/spec/templates/examples/module001.txt +33 -0
- data/spec/templates/examples/module002.html +318 -0
- data/spec/templates/examples/module003.html +185 -0
- data/spec/templates/examples/module004.html +387 -0
- data/spec/templates/examples/tag001.txt +82 -0
- data/spec/templates/helpers/base_helper_spec.rb +175 -0
- data/spec/templates/helpers/html_helper_spec.rb +612 -0
- data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +48 -0
- data/spec/templates/helpers/markup/rdoc_markup_spec.rb +93 -0
- data/spec/templates/helpers/markup_helper_spec.rb +135 -0
- data/spec/templates/helpers/method_helper_spec.rb +82 -0
- data/spec/templates/helpers/shared_signature_examples.rb +123 -0
- data/spec/templates/helpers/text_helper_spec.rb +44 -0
- data/spec/templates/method_spec.rb +102 -0
- data/spec/templates/module_spec.rb +181 -0
- data/spec/templates/onefile_spec.rb +64 -0
- data/spec/templates/section_spec.rb +146 -0
- data/spec/templates/spec_helper.rb +73 -0
- data/spec/templates/tag_spec.rb +51 -0
- data/spec/templates/template_spec.rb +409 -0
- data/spec/verifier_spec.rb +106 -0
- data/templates/default/class/dot/setup.rb +6 -0
- data/templates/default/class/dot/superklass.erb +3 -0
- data/templates/default/class/html/constructor_details.erb +8 -0
- data/templates/default/class/html/setup.rb +1 -0
- data/templates/default/class/html/subclasses.erb +4 -0
- data/templates/default/class/setup.rb +36 -0
- data/templates/default/class/text/setup.rb +11 -0
- data/templates/default/class/text/subclasses.erb +5 -0
- data/templates/default/constant/text/header.erb +11 -0
- data/templates/default/constant/text/setup.rb +3 -0
- data/templates/default/docstring/html/abstract.erb +4 -0
- data/templates/default/docstring/html/deprecated.erb +1 -0
- data/templates/default/docstring/html/index.erb +5 -0
- data/templates/default/docstring/html/note.erb +6 -0
- data/templates/default/docstring/html/private.erb +4 -0
- data/templates/default/docstring/html/returns_void.erb +1 -0
- data/templates/default/docstring/html/text.erb +1 -0
- data/templates/default/docstring/html/todo.erb +6 -0
- data/templates/default/docstring/setup.rb +51 -0
- data/templates/default/docstring/text/abstract.erb +2 -0
- data/templates/default/docstring/text/deprecated.erb +2 -0
- data/templates/default/docstring/text/index.erb +2 -0
- data/templates/default/docstring/text/note.erb +4 -0
- data/templates/default/docstring/text/private.erb +2 -0
- data/templates/default/docstring/text/returns_void.erb +1 -0
- data/templates/default/docstring/text/text.erb +1 -0
- data/templates/default/docstring/text/todo.erb +4 -0
- data/templates/default/fulldoc/html/css/common.css +1 -0
- data/templates/default/fulldoc/html/css/full_list.css +57 -0
- data/templates/default/fulldoc/html/css/style.css +338 -0
- data/templates/default/fulldoc/html/frames.erb +28 -0
- data/templates/default/fulldoc/html/full_list.erb +40 -0
- data/templates/default/fulldoc/html/full_list_class.erb +2 -0
- data/templates/default/fulldoc/html/full_list_file.erb +5 -0
- data/templates/default/fulldoc/html/full_list_method.erb +8 -0
- data/templates/default/fulldoc/html/js/app.js +214 -0
- data/templates/default/fulldoc/html/js/full_list.js +178 -0
- data/templates/default/fulldoc/html/js/jquery.js +4 -0
- data/templates/default/fulldoc/html/setup.rb +199 -0
- data/templates/default/layout/dot/header.erb +6 -0
- data/templates/default/layout/dot/setup.rb +14 -0
- data/templates/default/layout/html/breadcrumb.erb +13 -0
- data/templates/default/layout/html/files.erb +11 -0
- data/templates/default/layout/html/footer.erb +5 -0
- data/templates/default/layout/html/headers.erb +14 -0
- data/templates/default/layout/html/index.erb +2 -0
- data/templates/default/layout/html/layout.erb +20 -0
- data/templates/default/layout/html/listing.erb +4 -0
- data/templates/default/layout/html/objects.erb +32 -0
- data/templates/default/layout/html/script_setup.erb +5 -0
- data/templates/default/layout/html/search.erb +8 -0
- data/templates/default/layout/html/setup.rb +71 -0
- data/templates/default/method/html/header.erb +16 -0
- data/templates/default/method/setup.rb +3 -0
- data/templates/default/method/text/header.erb +1 -0
- data/templates/default/method_details/html/header.erb +3 -0
- data/templates/default/method_details/html/method_signature.erb +25 -0
- data/templates/default/method_details/html/source.erb +10 -0
- data/templates/default/method_details/setup.rb +10 -0
- data/templates/default/method_details/text/header.erb +10 -0
- data/templates/default/method_details/text/method_signature.erb +12 -0
- data/templates/default/method_details/text/setup.rb +10 -0
- data/templates/default/module/dot/child.erb +1 -0
- data/templates/default/module/dot/dependencies.erb +3 -0
- data/templates/default/module/dot/header.erb +6 -0
- data/templates/default/module/dot/info.erb +14 -0
- data/templates/default/module/dot/setup.rb +14 -0
- data/templates/default/module/html/attribute_details.erb +10 -0
- data/templates/default/module/html/attribute_summary.erb +8 -0
- data/templates/default/module/html/box_info.erb +37 -0
- data/templates/default/module/html/children.erb +8 -0
- data/templates/default/module/html/constant_summary.erb +13 -0
- data/templates/default/module/html/defines.erb +3 -0
- data/templates/default/module/html/header.erb +5 -0
- data/templates/default/module/html/inherited_attributes.erb +14 -0
- data/templates/default/module/html/inherited_constants.erb +8 -0
- data/templates/default/module/html/inherited_methods.erb +19 -0
- data/templates/default/module/html/item_summary.erb +40 -0
- data/templates/default/module/html/method_details_list.erb +9 -0
- data/templates/default/module/html/method_summary.erb +14 -0
- data/templates/default/module/html/methodmissing.erb +12 -0
- data/templates/default/module/html/pre_docstring.erb +1 -0
- data/templates/default/module/setup.rb +164 -0
- data/templates/default/module/text/children.erb +10 -0
- data/templates/default/module/text/class_meths_list.erb +8 -0
- data/templates/default/module/text/extends.erb +8 -0
- data/templates/default/module/text/header.erb +7 -0
- data/templates/default/module/text/includes.erb +8 -0
- data/templates/default/module/text/instance_meths_list.erb +8 -0
- data/templates/default/module/text/setup.rb +12 -0
- data/templates/default/onefile/html/files.erb +5 -0
- data/templates/default/onefile/html/headers.erb +6 -0
- data/templates/default/onefile/html/layout.erb +17 -0
- data/templates/default/onefile/html/readme.erb +3 -0
- data/templates/default/onefile/html/setup.rb +61 -0
- data/templates/default/root/dot/child.erb +3 -0
- data/templates/default/root/dot/setup.rb +5 -0
- data/templates/default/root/html/setup.rb +1 -0
- data/templates/default/tags/html/example.erb +11 -0
- data/templates/default/tags/html/index.erb +3 -0
- data/templates/default/tags/html/option.erb +24 -0
- data/templates/default/tags/html/overload.erb +14 -0
- data/templates/default/tags/html/see.erb +8 -0
- data/templates/default/tags/html/tag.erb +20 -0
- data/templates/default/tags/setup.rb +55 -0
- data/templates/default/tags/text/example.erb +12 -0
- data/templates/default/tags/text/index.erb +1 -0
- data/templates/default/tags/text/option.erb +20 -0
- data/templates/default/tags/text/overload.erb +19 -0
- data/templates/default/tags/text/see.erb +11 -0
- data/templates/default/tags/text/tag.erb +13 -0
- data/templates/guide/class/html/setup.rb +1 -0
- data/templates/guide/docstring/html/setup.rb +1 -0
- data/templates/guide/fulldoc/html/css/style.css +108 -0
- data/templates/guide/fulldoc/html/js/app.js +33 -0
- data/templates/guide/fulldoc/html/setup.rb +73 -0
- data/templates/guide/layout/html/layout.erb +81 -0
- data/templates/guide/layout/html/setup.rb +28 -0
- data/templates/guide/method/html/header.erb +18 -0
- data/templates/guide/method/html/setup.rb +21 -0
- data/templates/guide/module/html/header.erb +7 -0
- data/templates/guide/module/html/method_list.erb +5 -0
- data/templates/guide/module/html/setup.rb +26 -0
- data/templates/guide/onefile/html/files.erb +4 -0
- data/templates/guide/onefile/html/setup.rb +5 -0
- data/templates/guide/onefile/html/toc.erb +3 -0
- data/templates/guide/tags/html/setup.rb +8 -0
- metadata +689 -0
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
include Helpers::ModuleHelper
|
|
2
|
+
|
|
3
|
+
def init
|
|
4
|
+
options.objects = objects = run_verifier(options.objects)
|
|
5
|
+
|
|
6
|
+
return serialize_onefile if options.onefile
|
|
7
|
+
generate_assets
|
|
8
|
+
serialize('_index.html')
|
|
9
|
+
options.files.each_with_index do |file, i|
|
|
10
|
+
serialize_file(file, file.title)
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
options.delete(:objects)
|
|
14
|
+
options.delete(:files)
|
|
15
|
+
|
|
16
|
+
objects.each do |object|
|
|
17
|
+
begin
|
|
18
|
+
serialize(object)
|
|
19
|
+
rescue => e
|
|
20
|
+
path = options.serializer.serialized_path(object)
|
|
21
|
+
log.error "Exception occurred while generating '#{path}'"
|
|
22
|
+
log.backtrace(e)
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
# Generate an HTML document for the specified object. This method is used by
|
|
28
|
+
# most of the objects found in the Registry.
|
|
29
|
+
# @param [CodeObject] object to be saved to HTML
|
|
30
|
+
def serialize(object)
|
|
31
|
+
options.object = object
|
|
32
|
+
serialize_index(options) if object == '_index.html' && options.files.empty?
|
|
33
|
+
Templates::Engine.with_serializer(object, options.serializer) do
|
|
34
|
+
T('layout').run(options)
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Generate the documentation output in one file (--one-file) which will load the
|
|
39
|
+
# contents of all the javascript and css and output the entire contents without
|
|
40
|
+
# depending on any additional files
|
|
41
|
+
def serialize_onefile
|
|
42
|
+
Templates::Engine.with_serializer('index.html', options.serializer) do
|
|
43
|
+
T('onefile').run(options)
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
# Generate the index document for the output
|
|
48
|
+
# @params [Hash] options contains data and flags that influence the output
|
|
49
|
+
def serialize_index(options)
|
|
50
|
+
Templates::Engine.with_serializer('index.html', options.serializer) do
|
|
51
|
+
T('layout').run(options)
|
|
52
|
+
end
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
# Generate a single HTML file with the layout template applied. This is generally
|
|
56
|
+
# the README file or files specified on the command-line.
|
|
57
|
+
#
|
|
58
|
+
# @param [File] file object to be saved to the output
|
|
59
|
+
# @param [String] title currently unused
|
|
60
|
+
#
|
|
61
|
+
# @see layout#diskfile
|
|
62
|
+
def serialize_file(file, title = nil)
|
|
63
|
+
options.object = Registry.root
|
|
64
|
+
options.file = file
|
|
65
|
+
outfile = 'file.' + file.name + '.html'
|
|
66
|
+
|
|
67
|
+
serialize_index(options) if file == options.readme
|
|
68
|
+
Templates::Engine.with_serializer(outfile, options.serializer) do
|
|
69
|
+
T('layout').run(options)
|
|
70
|
+
end
|
|
71
|
+
options.delete(:file)
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
#
|
|
75
|
+
# Generates a file to the output with the specified contents.
|
|
76
|
+
#
|
|
77
|
+
# @example saving a custom html file to the documenation root
|
|
78
|
+
#
|
|
79
|
+
# asset('my_custom.html','<html><body>Custom File</body></html>')
|
|
80
|
+
#
|
|
81
|
+
# @param [String] path relative to the document output where the file will be
|
|
82
|
+
# created.
|
|
83
|
+
# @param [String] content the contents that are saved to the file.
|
|
84
|
+
def asset(path, content)
|
|
85
|
+
if options.serializer
|
|
86
|
+
log.capture("Generating asset #{path}") do
|
|
87
|
+
options.serializer.serialize(path, content)
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
|
|
92
|
+
# @return [Array<String>] Stylesheet files that are additionally loaded for the
|
|
93
|
+
# searchable full lists, e.g., Class List, Method List, File List
|
|
94
|
+
# @since 0.7.0
|
|
95
|
+
def stylesheets_full_list
|
|
96
|
+
%w(css/full_list.css css/common.css)
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# @return [Array<String>] Javascript files that are additionally loaded for the
|
|
100
|
+
# searchable full lists, e.g., Class List, Method List, File List.
|
|
101
|
+
# @since 0.7.0
|
|
102
|
+
def javascripts_full_list
|
|
103
|
+
%w(js/jquery.js js/full_list.js)
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
def menu_lists
|
|
107
|
+
Object.new.extend(T('layout')).menu_lists
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Generates all the javascript files, stylesheet files, menu lists
|
|
111
|
+
# (i.e. class, method, and file) based on the the values returned from the
|
|
112
|
+
# layout's menu_list method, and the frameset in the documentation output
|
|
113
|
+
#
|
|
114
|
+
def generate_assets
|
|
115
|
+
@object = Registry.root
|
|
116
|
+
|
|
117
|
+
layout = Object.new.extend(T('layout'))
|
|
118
|
+
(layout.javascripts + javascripts_full_list +
|
|
119
|
+
layout.stylesheets + stylesheets_full_list).uniq.each do |file|
|
|
120
|
+
asset(file, file(file, true))
|
|
121
|
+
end
|
|
122
|
+
layout.menu_lists.each do |list|
|
|
123
|
+
list_generator_method = "generate_#{list[:type]}_list"
|
|
124
|
+
if respond_to?(list_generator_method)
|
|
125
|
+
send(list_generator_method)
|
|
126
|
+
else
|
|
127
|
+
log.error "Unable to generate '#{list[:title]}' list because no method " +
|
|
128
|
+
"'#{list_generator_method}' exists"
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
|
|
132
|
+
generate_frameset
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# Generate a searchable method list in the output
|
|
136
|
+
# @see ModuleHelper#prune_method_listing
|
|
137
|
+
def generate_method_list
|
|
138
|
+
@items = prune_method_listing(Registry.all(:method), false)
|
|
139
|
+
@items = @items.reject {|m| m.name.to_s =~ /=$/ && m.is_attribute? }
|
|
140
|
+
@items = @items.sort_by {|m| m.name.to_s }
|
|
141
|
+
@list_title = "Method List"
|
|
142
|
+
@list_type = "method"
|
|
143
|
+
generate_list_contents
|
|
144
|
+
end
|
|
145
|
+
|
|
146
|
+
# Generate a searchable class list in the output
|
|
147
|
+
def generate_class_list
|
|
148
|
+
@items = options.objects if options.objects
|
|
149
|
+
@list_title = "Class List"
|
|
150
|
+
@list_type = "class"
|
|
151
|
+
generate_list_contents
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# Generate a searchable file list in the output
|
|
155
|
+
def generate_file_list
|
|
156
|
+
@file_list = true
|
|
157
|
+
@items = options.files
|
|
158
|
+
@list_title = "File List"
|
|
159
|
+
@list_type = "file"
|
|
160
|
+
generate_list_contents
|
|
161
|
+
@file_list = nil
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
def generate_list_contents
|
|
165
|
+
asset(url_for_list(@list_type), erb(:full_list))
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# Generate the frame documentation in the output
|
|
169
|
+
def generate_frameset
|
|
170
|
+
@javascripts = javascripts_full_list
|
|
171
|
+
@stylesheets = stylesheets_full_list
|
|
172
|
+
asset(url_for_frameset, erb(:frames))
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# @return [String] HTML output of the classes to be displayed in the
|
|
176
|
+
# full_list_class template.
|
|
177
|
+
def class_list(root = Registry.root)
|
|
178
|
+
out = ""
|
|
179
|
+
children = run_verifier(root.children)
|
|
180
|
+
if root == Registry.root
|
|
181
|
+
children += @items.select {|o| o.namespace.is_a?(CodeObjects::Proxy) }
|
|
182
|
+
end
|
|
183
|
+
children.reject {|c| c.nil? }.sort_by {|child| child.path }.map do |child|
|
|
184
|
+
if child.is_a?(CodeObjects::NamespaceObject)
|
|
185
|
+
name = child.namespace.is_a?(CodeObjects::Proxy) ? child.path : child.name
|
|
186
|
+
has_children = run_verifier(child.children).any? {|o| o.is_a?(CodeObjects::NamespaceObject) }
|
|
187
|
+
out << "<li>"
|
|
188
|
+
out << "<a class='toggle'></a> " if has_children
|
|
189
|
+
out << linkify(child, name)
|
|
190
|
+
out << " < #{child.superclass.name}" if child.is_a?(CodeObjects::ClassObject) && child.superclass
|
|
191
|
+
out << "<small class='search_info'>"
|
|
192
|
+
out << child.namespace.title
|
|
193
|
+
out << "</small>"
|
|
194
|
+
out << "</li>"
|
|
195
|
+
out << "<ul>#{class_list(child)}</ul>" if has_children
|
|
196
|
+
end
|
|
197
|
+
end
|
|
198
|
+
out
|
|
199
|
+
end
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<div id="menu">
|
|
2
|
+
<% if @contents || @file %>
|
|
3
|
+
<% if object != '_index.html' %><a href="<%= url_for_index %>">Index</a> » <% end %>
|
|
4
|
+
<span class="title"><%= @breadcrumb_title %></span>
|
|
5
|
+
<% elsif object.is_a?(CodeObjects::Base) %>
|
|
6
|
+
<a href="<%= url_for_index %>"><% if object.root? || object.type == :method %>Index<% else %>Index (<%= object.name.to_s[0,1] %>)<% end %></a> »
|
|
7
|
+
<%= @breadcrumb.map {|obj| "<span class='title'>" + linkify(obj, obj.name) + "</span>" }.join(" » ") %>
|
|
8
|
+
<%= @breadcrumb.size > 0 ? " » " : "" %>
|
|
9
|
+
<span class="title"><%= object.root? ? "Top Level Namespace" : object.name(true) %></span>
|
|
10
|
+
<% end %>
|
|
11
|
+
|
|
12
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
13
|
+
</div>
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<% if @files && @files.size > 0 %>
|
|
2
|
+
<h2>File Listing</h2>
|
|
3
|
+
<ul id="files" class="index_inline_list">
|
|
4
|
+
<% n = 1 %>
|
|
5
|
+
<% @files.each_with_index do |file, i| %>
|
|
6
|
+
<li class="r<%= n %>"><%= link_file(file) %></li>
|
|
7
|
+
<% n = n == 2 ? 1 : 2 %>
|
|
8
|
+
<% end %>
|
|
9
|
+
</ul>
|
|
10
|
+
<% end %>
|
|
11
|
+
<div class="clear"></div>
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
<meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>" />
|
|
2
|
+
<title>
|
|
3
|
+
<%= h @page_title %>
|
|
4
|
+
<% if options.title && @page_title != options.title %>
|
|
5
|
+
— <%= h options.title %>
|
|
6
|
+
<% end %>
|
|
7
|
+
</title>
|
|
8
|
+
<% stylesheets.each do |stylesheet| %>
|
|
9
|
+
<link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" charset="utf-8" />
|
|
10
|
+
<% end %>
|
|
11
|
+
<%= erb :script_setup %>
|
|
12
|
+
<% javascripts.each do |javascript| %>
|
|
13
|
+
<script type="text/javascript" charset="utf-8" src="<%= url_for(javascript) %>"></script>
|
|
14
|
+
<% end %>
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<%= erb(:headers) %>
|
|
6
|
+
</head>
|
|
7
|
+
<body>
|
|
8
|
+
<div id="header">
|
|
9
|
+
<%= erb(:breadcrumb) %>
|
|
10
|
+
<%= erb(:search) %>
|
|
11
|
+
<div class="clear"></div>
|
|
12
|
+
</div>
|
|
13
|
+
|
|
14
|
+
<iframe id="search_frame"></iframe>
|
|
15
|
+
|
|
16
|
+
<div id="content"><%= yieldall %></div>
|
|
17
|
+
|
|
18
|
+
<%= erb(:footer) %>
|
|
19
|
+
</body>
|
|
20
|
+
</html>
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
<h2>Namespace Listing A-Z</h2>
|
|
2
|
+
|
|
3
|
+
<% if Registry.root.meths(:included => false).size > 0 %>
|
|
4
|
+
<ul class="toplevel"><li><%= linkify(Registry.root) %></li></ul>
|
|
5
|
+
<% end %>
|
|
6
|
+
|
|
7
|
+
<% i = 0 %>
|
|
8
|
+
<table>
|
|
9
|
+
<tr>
|
|
10
|
+
<td valign='top' width="33%">
|
|
11
|
+
<% @objects_by_letter.sort_by {|l,o| l.to_s }.each do |letter, objects| %>
|
|
12
|
+
<% if (i += 1) % 8 == 0 %>
|
|
13
|
+
</td><td valign='top' width="33%">
|
|
14
|
+
<% i = 0 %>
|
|
15
|
+
<% end %>
|
|
16
|
+
<ul id="alpha_<%= letter %>" class="alpha">
|
|
17
|
+
<li class="letter"><%= letter %></li>
|
|
18
|
+
<ul>
|
|
19
|
+
<% objects.each do |obj| %>
|
|
20
|
+
<li>
|
|
21
|
+
<%= linkify obj, obj.name %>
|
|
22
|
+
<% if !obj.namespace.root? %>
|
|
23
|
+
<small>(<%= obj.namespace.path %>)</small>
|
|
24
|
+
<% end %>
|
|
25
|
+
</li>
|
|
26
|
+
<% end %>
|
|
27
|
+
</ul>
|
|
28
|
+
</ul>
|
|
29
|
+
<% end %>
|
|
30
|
+
</td>
|
|
31
|
+
</tr>
|
|
32
|
+
</table>
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
def init
|
|
2
|
+
@breadcrumb = []
|
|
3
|
+
if @onefile
|
|
4
|
+
sections :layout
|
|
5
|
+
elsif @file
|
|
6
|
+
if @file.attributes[:namespace]
|
|
7
|
+
@object = options.object = Registry.at(@file.attributes[:namespace]) || Registry.root
|
|
8
|
+
end
|
|
9
|
+
@breadcrumb_title = "File: " + @file.title
|
|
10
|
+
@page_title = @breadcrumb_title
|
|
11
|
+
sections :layout, [:diskfile]
|
|
12
|
+
elsif @contents
|
|
13
|
+
sections :layout, [:contents]
|
|
14
|
+
else
|
|
15
|
+
case object
|
|
16
|
+
when '_index.html'
|
|
17
|
+
@page_title = options.title
|
|
18
|
+
sections :layout, [:index, [:listing, [:files, :objects]]]
|
|
19
|
+
when CodeObjects::Base
|
|
20
|
+
unless object.root?
|
|
21
|
+
cur = object.namespace
|
|
22
|
+
while !cur.root?
|
|
23
|
+
@breadcrumb.unshift(cur)
|
|
24
|
+
cur = cur.namespace
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
@page_title = format_object_title(object)
|
|
29
|
+
type = object.root? ? :module : object.type
|
|
30
|
+
sections :layout, [T(type)]
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
def contents
|
|
36
|
+
@contents
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
def index
|
|
40
|
+
@objects_by_letter = {}
|
|
41
|
+
objects = Registry.all(:class, :module).sort_by {|o| o.name.to_s }
|
|
42
|
+
objects = run_verifier(objects)
|
|
43
|
+
objects.each {|o| (@objects_by_letter[o.name.to_s[0,1].upcase] ||= []) << o }
|
|
44
|
+
erb(:index)
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
def diskfile
|
|
48
|
+
@file.attributes[:markup] ||= markup_for_file('', @file.filename)
|
|
49
|
+
data = htmlify(@file.contents, @file.attributes[:markup])
|
|
50
|
+
"<div id='filecontents'>" + data + "</div>"
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
# @return [Array<String>] core javascript files for layout
|
|
54
|
+
# @since 0.7.0
|
|
55
|
+
def javascripts
|
|
56
|
+
%w(js/jquery.js js/app.js)
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# @return [Array<String>] core stylesheets for the layout
|
|
60
|
+
# @since 0.7.0
|
|
61
|
+
def stylesheets
|
|
62
|
+
%w(css/style.css css/common.css)
|
|
63
|
+
end
|
|
64
|
+
|
|
65
|
+
# @return [Array<Hash{Symbol=>String}>] the list of search links and drop-down menus
|
|
66
|
+
# @since 0.7.0
|
|
67
|
+
def menu_lists
|
|
68
|
+
[ { :type => 'class', :title => 'Classes', :search_title => 'Class List' },
|
|
69
|
+
{ :type => 'method', :title => 'Methods', :search_title => 'Method List' },
|
|
70
|
+
{ :type => 'file', :title => 'Files', :search_title => 'File List' } ]
|
|
71
|
+
end
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
<h1>Method: <%= object.path %></h1>
|
|
2
|
+
<dl class="box">
|
|
3
|
+
<dt class="r1 last">Defined in:</dt>
|
|
4
|
+
<dd class="r1 last">
|
|
5
|
+
<%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
|
|
6
|
+
<%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
|
|
7
|
+
<% end %>
|
|
8
|
+
</dd>
|
|
9
|
+
</dl>
|
|
10
|
+
<div class="clear"></div>
|
|
11
|
+
|
|
12
|
+
<div class="method_details_list">
|
|
13
|
+
<div id="method_details">
|
|
14
|
+
<%= yieldall :index => 0 %>
|
|
15
|
+
</div>
|
|
16
|
+
</div>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<%= yieldall %>
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<h3 class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
|
|
2
|
+
<% if object.tags(:overload).size == 1 %>
|
|
3
|
+
<%= signature(object.tag(:overload), false) %>
|
|
4
|
+
<% elsif object.tags(:overload).size > 1 %>
|
|
5
|
+
<% object.tags(:overload).each do |overload| %>
|
|
6
|
+
<span class="overload"><%= signature(overload, false) %></span>
|
|
7
|
+
<% end %>
|
|
8
|
+
<% else %>
|
|
9
|
+
<%= signature(object, false) %>
|
|
10
|
+
<% end %>
|
|
11
|
+
|
|
12
|
+
<% if object.aliases.size > 0 %>
|
|
13
|
+
<span class="aliases">Also known as:
|
|
14
|
+
<span class="names"><%= object.aliases.map {|o|
|
|
15
|
+
"<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
|
|
16
|
+
</span>
|
|
17
|
+
<% end %>
|
|
18
|
+
|
|
19
|
+
<% if owner != object.namespace %>
|
|
20
|
+
<span class="not_defined_here">
|
|
21
|
+
Originally defined in <%= object.namespace.type %>
|
|
22
|
+
<%= linkify object, owner.relative_path(object.namespace) %>
|
|
23
|
+
</span>
|
|
24
|
+
<% end %>
|
|
25
|
+
</h3>
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<table class="source_code">
|
|
2
|
+
<tr>
|
|
3
|
+
<td>
|
|
4
|
+
<pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
|
|
5
|
+
</td>
|
|
6
|
+
<td>
|
|
7
|
+
<pre class="code"><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
|
|
8
|
+
</td>
|
|
9
|
+
</tr>
|
|
10
|
+
</table>
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<%= title_align_right format_object_title(object) %>
|
|
2
|
+
|
|
3
|
+
<%= align_right "(Defined in: #{object.file})" %>
|
|
4
|
+
<% if object.aliases.size > 0 %>
|
|
5
|
+
|
|
6
|
+
<%= align_right "(Also known as: #{object.aliases.map {|o| o.name(true).to_s }.join(',')})" %>
|
|
7
|
+
<% end %>
|
|
8
|
+
|
|
9
|
+
<%= yieldall %>
|
|
10
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
|
|
2
|
+
<% if object.tags(:overload).size == 1 %>
|
|
3
|
+
<%= indent wrap(signature(object.tag(:overload))) %>
|
|
4
|
+
<% elsif object.tags(:overload).size > 1 %>
|
|
5
|
+
<% object.tags(:overload).each do |overload| %>
|
|
6
|
+
<%= indent wrap(signature(overload)) %>
|
|
7
|
+
<% end %>
|
|
8
|
+
<% else %>
|
|
9
|
+
<%= indent wrap(signature(object)) %>
|
|
10
|
+
<% end %>
|
|
11
|
+
<%= hr %>
|
|
12
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<%= format_path object %> [label="{<%= yieldall.gsub("\n", '') %>}" rank=sink];
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
<%= object.type %> <%= h object.name %>
|
|
2
|
+
<% if options.full %>
|
|
3
|
+
|
|
|
4
|
+
<% object.attributes.each do |scope, list| %>
|
|
5
|
+
<% list.sort_by {|name, rw| name.to_s }.each do |name, rw| %>
|
|
6
|
+
<%= uml_visibility(rw.values.compact.first) %> <%= h (rw[:read]||rw[:write]).name(true).gsub(/=$/,'') %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
|
|
7
|
+
<% end %>
|
|
8
|
+
<% end %>
|
|
9
|
+
|
|
|
10
|
+
<% method_listing.each do |obj| %>
|
|
11
|
+
<%= uml_visibility obj %> <%= h obj.name(true) %>
|
|
12
|
+
<%= h(" : #{obj.tag(:return).types.first}") if obj.has_tag?(:return) && obj.tag(:return).types && obj.tag(:return).types.size > 0 %>\l
|
|
13
|
+
<% end %>
|
|
14
|
+
<% end %>
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
def init
|
|
2
|
+
@modules = object.children.select {|o| o.type == :module }
|
|
3
|
+
@classes = object.children.select {|o| o.type == :class }
|
|
4
|
+
sections :child, [:info], :classes, [T('class')], :header, [T('module')], :dependencies
|
|
5
|
+
end
|
|
6
|
+
|
|
7
|
+
def dependencies
|
|
8
|
+
return unless options.dependencies
|
|
9
|
+
erb(:dependencies)
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
def classes
|
|
13
|
+
@classes.map {|k| yieldall :object => k }.join("\n")
|
|
14
|
+
end
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<% scopes(attr_listing) do |list, scope| %>
|
|
2
|
+
<div id="<%= scope %>_attr_details" class="attr_details">
|
|
3
|
+
<h2><%= scope.to_s.capitalize %> Attribute Details</h2>
|
|
4
|
+
<% list.each_with_index do |meth, i| %>
|
|
5
|
+
<% rw = meth.attr_info %>
|
|
6
|
+
<span id="<%= anchor_for(rw[meth.reader? ? :write : :read]) %>"></span>
|
|
7
|
+
<%= yieldall :object => meth, :owner => object, :index => i %>
|
|
8
|
+
<% end %>
|
|
9
|
+
</div>
|
|
10
|
+
<% end %>
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
<% n = 1 %>
|
|
2
|
+
<dl class="box">
|
|
3
|
+
<% if CodeObjects::ClassObject === object && object.superclass %>
|
|
4
|
+
<dt class="r<%=n%>">Inherits:</dt>
|
|
5
|
+
<dd class="r<%=n%>">
|
|
6
|
+
<span class="inheritName"><%= linkify object.superclass %></span>
|
|
7
|
+
<% if object.superclass.name != :BasicObject %>
|
|
8
|
+
<ul class="fullTree">
|
|
9
|
+
<li><%= linkify P(:Object) %></li>
|
|
10
|
+
<% object.inheritance_tree.reverse.each_with_index do |obj, i| %>
|
|
11
|
+
<li class="next"><%= obj == object ? obj.path : linkify(obj) %></li>
|
|
12
|
+
<% end %>
|
|
13
|
+
</ul>
|
|
14
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
15
|
+
<% end %>
|
|
16
|
+
</dd>
|
|
17
|
+
<% n = 2 %>
|
|
18
|
+
<% end %>
|
|
19
|
+
<% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
|
|
20
|
+
<% if (mix = run_verifier(object.mixins(scope))).size > 0 %>
|
|
21
|
+
<dt class="r<%=n%>"><%= name %>:</dt>
|
|
22
|
+
<dd class="r<%=n%>"><%= mix.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
|
|
23
|
+
<% n = n == 2 ? 1 : 2 %>
|
|
24
|
+
<% end %>
|
|
25
|
+
<% end %>
|
|
26
|
+
<% if (mixed_into = mixed_into(object)).size > 0 %>
|
|
27
|
+
<dt class="r<%=n%>">Included in:</dt>
|
|
28
|
+
<dd class="r<%=n%>"><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
|
|
29
|
+
<% n = n == 2 ? 1 : 2 %>
|
|
30
|
+
<% end %>
|
|
31
|
+
<% unless object.root? %>
|
|
32
|
+
<dt class="r<%=n%> last">Defined in:</dt>
|
|
33
|
+
<dd class="r<%=n%> last"><%= erb(:defines) %></dd>
|
|
34
|
+
<% end %>
|
|
35
|
+
</dl>
|
|
36
|
+
<div class="clear"></div>
|
|
37
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
<h2>Defined Under Namespace</h2>
|
|
2
|
+
<p class="children">
|
|
3
|
+
<% @inner.each do |name, list| %>
|
|
4
|
+
<% if list.size > 0 %>
|
|
5
|
+
<strong class="<%= name %>"><%= name.to_s.capitalize %>:</strong> <%= list.map {|child| linkify(child, child.name(true)) }.join(", ") %>
|
|
6
|
+
<% end %>
|
|
7
|
+
<% end %>
|
|
8
|
+
</p>
|