RubyGems - yard - Versions diffs - 0.9.23 → 0.9.27 - Mend

yard 0.9.23 → 0.9.27

Potentially problematic release.

This version of yard might be problematic. Click here for more details.

Files changed (257) hide show

checksums.yaml +4 -4
data/.dockerignore +0 -0
data/.gitattributes +4 -0
data/.github/FUNDING.yml +3 -0
data/.github/ISSUE_TEMPLATE.md +6 -6
data/.github/PULL_REQUEST_TEMPLATE.md +5 -5
data/.github/workflows/ci.yml +30 -0
data/.github/workflows/gem.yml +19 -0
data/.gitignore +0 -0
data/.rspec +0 -0
data/.rubocop.yml +37 -24
data/.yardopts +0 -0
data/.yardopts_guide +0 -0
data/.yardopts_i18n +0 -0
data/CHANGELOG.md +50 -4
data/CONTRIBUTING.md +2 -2
data/Gemfile +5 -3
data/README.md +97 -102
data/Rakefile +2 -3
data/lib/yard/cli/diff.rb +4 -1
data/lib/yard/cli/server.rb +22 -13
data/lib/yard/cli/stats.rb +2 -0
data/lib/yard/cli/yardoc.rb +2 -1
data/lib/yard/code_objects/method_object.rb +1 -1
data/lib/yard/code_objects/namespace_mapper.rb +30 -3
data/lib/yard/code_objects/proxy.rb +2 -1
data/lib/yard/globals.rb +1 -1
data/lib/yard/handlers/c/base.rb +35 -0
data/lib/yard/handlers/ruby/method_handler.rb +1 -1
data/lib/yard/handlers/ruby/mixin_handler.rb +7 -2
data/lib/yard/handlers/ruby/module_function_handler.rb +15 -3
data/lib/yard/parser/ruby/ast_node.rb +2 -2
data/lib/yard/parser/ruby/ruby_parser.rb +7 -5
data/lib/yard/parser/ruby/token_resolver.rb +3 -1
data/lib/yard/parser/source_parser.rb +1 -1
data/lib/yard/registry_resolver.rb +10 -24
data/lib/yard/registry_store.rb +1 -1
data/lib/yard/serializers/yardoc_serializer.rb +1 -1
data/lib/yard/server/commands/base.rb +2 -2
data/lib/yard/server/commands/library_command.rb +1 -1
data/lib/yard/tags/directives.rb +10 -1
data/lib/yard/templates/helpers/html_helper.rb +15 -5
data/lib/yard/templates/helpers/markup/rdoc_markup.rb +5 -4
data/lib/yard/templates/helpers/markup_helper.rb +2 -1
data/lib/yard/templates/section.rb +1 -3
data/lib/yard/version.rb +1 -1
data/lib/yard.rb +3 -0
data/samus.json +15 -46
data/tasks/prepare_tag.rake +45 -0
data/tasks/update_error_map.rake +53 -0
data/templates/default/fulldoc/html/css/style.css +1 -0
data/yard.gemspec +3 -2
metadata +23 -207
data/.travis.yml +0 -52
data/spec/cli/command_parser_spec.rb +0 -43
data/spec/cli/command_spec.rb +0 -36
data/spec/cli/config_spec.rb +0 -148
data/spec/cli/diff_spec.rb +0 -254
data/spec/cli/display_spec.rb +0 -30
data/spec/cli/gems_spec.rb +0 -81
data/spec/cli/graph_spec.rb +0 -18
data/spec/cli/help_spec.rb +0 -22
data/spec/cli/i18n_spec.rb +0 -107
data/spec/cli/list_spec.rb +0 -8
data/spec/cli/markup_types_spec.rb +0 -22
data/spec/cli/server_spec.rb +0 -324
data/spec/cli/stats_spec.rb +0 -96
data/spec/cli/yard_on_yard_spec.rb +0 -38
data/spec/cli/yardoc_spec.rb +0 -896
data/spec/cli/yri_spec.rb +0 -101
data/spec/code_objects/base_spec.rb +0 -485
data/spec/code_objects/class_object_spec.rb +0 -226
data/spec/code_objects/code_object_list_spec.rb +0 -36
data/spec/code_objects/constants_spec.rb +0 -116
data/spec/code_objects/extra_file_object_spec.rb +0 -161
data/spec/code_objects/macro_object_spec.rb +0 -150
data/spec/code_objects/method_object_spec.rb +0 -184
data/spec/code_objects/module_object_spec.rb +0 -142
data/spec/code_objects/namespace_object_spec.rb +0 -171
data/spec/code_objects/proxy_spec.rb +0 -147
data/spec/code_objects/spec_helper.rb +0 -3
data/spec/config_spec.rb +0 -171
data/spec/core_ext/array_spec.rb +0 -13
data/spec/core_ext/file_spec.rb +0 -72
data/spec/core_ext/hash_spec.rb +0 -14
data/spec/core_ext/insertion_spec.rb +0 -37
data/spec/core_ext/module_spec.rb +0 -9
data/spec/core_ext/string_spec.rb +0 -42
data/spec/core_ext/symbol_hash_spec.rb +0 -89
data/spec/docstring_parser_spec.rb +0 -280
data/spec/docstring_spec.rb +0 -373
data/spec/handlers/alias_handler_spec.rb +0 -82
data/spec/handlers/attribute_handler_spec.rb +0 -96
data/spec/handlers/base_spec.rb +0 -216
data/spec/handlers/c/alias_handler_spec.rb +0 -34
data/spec/handlers/c/attribute_handler_spec.rb +0 -41
data/spec/handlers/c/class_handler_spec.rb +0 -78
data/spec/handlers/c/constant_handler_spec.rb +0 -71
data/spec/handlers/c/init_handler_spec.rb +0 -48
data/spec/handlers/c/method_handler_spec.rb +0 -327
data/spec/handlers/c/mixin_handler_spec.rb +0 -44
data/spec/handlers/c/module_handler_spec.rb +0 -71
data/spec/handlers/c/override_comment_handler_spec.rb +0 -47
data/spec/handlers/c/path_handler_spec.rb +0 -36
data/spec/handlers/c/spec_helper.rb +0 -23
data/spec/handlers/c/struct_handler_spec.rb +0 -16
data/spec/handlers/class_condition_handler_spec.rb +0 -87
data/spec/handlers/class_handler_spec.rb +0 -247
data/spec/handlers/class_method_handler_shared_examples.rb +0 -133
data/spec/handlers/class_variable_handler_spec.rb +0 -12
data/spec/handlers/constant_handler_spec.rb +0 -112
data/spec/handlers/decorator_handler_methods_spec.rb +0 -393
data/spec/handlers/dsl_handler_spec.rb +0 -226
data/spec/handlers/examples/alias_handler_001.rb.txt +0 -46
data/spec/handlers/examples/attribute_handler_001.rb.txt +0 -32
data/spec/handlers/examples/class_condition_handler_001.rb.txt +0 -69
data/spec/handlers/examples/class_handler_001.rb.txt +0 -120
data/spec/handlers/examples/class_variable_handler_001.rb.txt +0 -10
data/spec/handlers/examples/constant_handler_001.rb.txt +0 -35
data/spec/handlers/examples/dsl_handler_001.rb.txt +0 -156
data/spec/handlers/examples/exception_handler_001.rb.txt +0 -59
data/spec/handlers/examples/extend_handler_001.rb.txt +0 -19
data/spec/handlers/examples/method_condition_handler_001.rb.txt +0 -10
data/spec/handlers/examples/method_handler_001.rb.txt +0 -128
data/spec/handlers/examples/mixin_handler_001.rb.txt +0 -40
data/spec/handlers/examples/module_handler_001.rb.txt +0 -29
data/spec/handlers/examples/private_constant_handler_001.rb.txt +0 -8
data/spec/handlers/examples/process_handler_001.rb.txt +0 -11
data/spec/handlers/examples/visibility_handler_001.rb.txt +0 -36
data/spec/handlers/examples/yield_handler_001.rb.txt +0 -54
data/spec/handlers/exception_handler_spec.rb +0 -49
data/spec/handlers/extend_handler_spec.rb +0 -28
data/spec/handlers/legacy_base_spec.rb +0 -128
data/spec/handlers/method_condition_handler_spec.rb +0 -15
data/spec/handlers/method_handler_spec.rb +0 -214
data/spec/handlers/mixin_handler_spec.rb +0 -60
data/spec/handlers/module_function_handler_spec.rb +0 -106
data/spec/handlers/module_handler_spec.rb +0 -35
data/spec/handlers/private_class_method_handler_spec.rb +0 -11
data/spec/handlers/private_constant_handler_spec.rb +0 -25
data/spec/handlers/processor_spec.rb +0 -35
data/spec/handlers/public_class_method_handler_spec.rb +0 -11
data/spec/handlers/ruby/base_spec.rb +0 -95
data/spec/handlers/ruby/legacy/base_spec.rb +0 -84
data/spec/handlers/spec_helper.rb +0 -33
data/spec/handlers/visibility_handler_spec.rb +0 -44
data/spec/handlers/yield_handler_spec.rb +0 -52
data/spec/i18n/locale_spec.rb +0 -81
data/spec/i18n/message_spec.rb +0 -52
data/spec/i18n/messages_spec.rb +0 -67
data/spec/i18n/pot_generator_spec.rb +0 -295
data/spec/i18n/text_spec.rb +0 -184
data/spec/logging_spec.rb +0 -44
data/spec/options_spec.rb +0 -171
data/spec/parser/base_spec.rb +0 -24
data/spec/parser/c_parser_spec.rb +0 -236
data/spec/parser/examples/array.c.txt +0 -6267
data/spec/parser/examples/example1.rb.txt +0 -8
data/spec/parser/examples/extrafile.c.txt +0 -8
data/spec/parser/examples/file.c.txt +0 -28
data/spec/parser/examples/multifile.c.txt +0 -22
data/spec/parser/examples/namespace.cpp.txt +0 -68
data/spec/parser/examples/override.c.txt +0 -424
data/spec/parser/examples/parse_in_order_001.rb.txt +0 -2
data/spec/parser/examples/parse_in_order_002.rb.txt +0 -2
data/spec/parser/examples/tag_handler_001.rb.txt +0 -8
data/spec/parser/ruby/ast_node_spec.rb +0 -33
data/spec/parser/ruby/legacy/statement_list_spec.rb +0 -299
data/spec/parser/ruby/legacy/token_list_spec.rb +0 -79
data/spec/parser/ruby/ruby_parser_spec.rb +0 -508
data/spec/parser/ruby/token_resolver_spec.rb +0 -165
data/spec/parser/source_parser_spec.rb +0 -727
data/spec/parser/tag_parsing_spec.rb +0 -17
data/spec/rake/yardoc_task_spec.rb +0 -118
data/spec/registry_spec.rb +0 -463
data/spec/registry_store_spec.rb +0 -327
data/spec/rubygems/doc_manager_spec.rb +0 -112
data/spec/serializers/data/serialized_yardoc/checksums +0 -1
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 +0 -2
data/spec/serializers/file_system_serializer_spec.rb +0 -145
data/spec/serializers/spec_helper.rb +0 -2
data/spec/serializers/yardoc_serializer_spec.rb +0 -78
data/spec/server/adapter_spec.rb +0 -39
data/spec/server/commands/base_spec.rb +0 -91
data/spec/server/commands/library_command_spec.rb +0 -39
data/spec/server/doc_server_helper_spec.rb +0 -72
data/spec/server/doc_server_serializer_spec.rb +0 -60
data/spec/server/rack_adapter_spec.rb +0 -21
data/spec/server/router_spec.rb +0 -123
data/spec/server/spec_helper.rb +0 -22
data/spec/server/static_caching_spec.rb +0 -47
data/spec/server/webrick_servlet_spec.rb +0 -20
data/spec/server_spec.rb +0 -19
data/spec/spec_helper.rb +0 -212
data/spec/tags/default_factory_spec.rb +0 -168
data/spec/tags/default_tag_spec.rb +0 -11
data/spec/tags/directives_spec.rb +0 -463
data/spec/tags/library_spec.rb +0 -48
data/spec/tags/overload_tag_spec.rb +0 -53
data/spec/tags/ref_tag_list_spec.rb +0 -53
data/spec/tags/types_explainer_spec.rb +0 -203
data/spec/templates/class_spec.rb +0 -45
data/spec/templates/constant_spec.rb +0 -41
data/spec/templates/engine_spec.rb +0 -131
data/spec/templates/examples/class001.html +0 -308
data/spec/templates/examples/class001.txt +0 -36
data/spec/templates/examples/class002.html +0 -39
data/spec/templates/examples/constant001.txt +0 -25
data/spec/templates/examples/constant002.txt +0 -7
data/spec/templates/examples/constant003.txt +0 -11
data/spec/templates/examples/method001.html +0 -137
data/spec/templates/examples/method001.txt +0 -35
data/spec/templates/examples/method002.html +0 -91
data/spec/templates/examples/method002.txt +0 -20
data/spec/templates/examples/method003.html +0 -165
data/spec/templates/examples/method003.txt +0 -45
data/spec/templates/examples/method004.html +0 -48
data/spec/templates/examples/method004.txt +0 -10
data/spec/templates/examples/method005.html +0 -105
data/spec/templates/examples/method005.txt +0 -33
data/spec/templates/examples/method006.html +0 -108
data/spec/templates/examples/method006.txt +0 -20
data/spec/templates/examples/module001.dot +0 -33
data/spec/templates/examples/module001.html +0 -833
data/spec/templates/examples/module001.txt +0 -33
data/spec/templates/examples/module002.html +0 -341
data/spec/templates/examples/module003.html +0 -202
data/spec/templates/examples/module004.html +0 -394
data/spec/templates/examples/module005.html +0 -82
data/spec/templates/examples/tag001.txt +0 -82
data/spec/templates/helpers/base_helper_spec.rb +0 -171
data/spec/templates/helpers/html_helper_spec.rb +0 -687
data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +0 -65
data/spec/templates/helpers/markup/rdoc_markup_spec.rb +0 -84
data/spec/templates/helpers/markup_helper_spec.rb +0 -136
data/spec/templates/helpers/method_helper_spec.rb +0 -107
data/spec/templates/helpers/module_helper_spec.rb +0 -35
data/spec/templates/helpers/shared_signature_examples.rb +0 -126
data/spec/templates/helpers/text_helper_spec.rb +0 -65
data/spec/templates/markup_processor_integrations/asciidoctor_spec.rb +0 -60
data/spec/templates/markup_processor_integrations/integration_spec_helper.rb +0 -46
data/spec/templates/markup_processor_integrations/rdoc_markdown_spec.rb +0 -59
data/spec/templates/markup_processor_integrations/rdoc_spec.rb +0 -39
data/spec/templates/markup_processor_integrations/redcarpet_spec.rb +0 -59
data/spec/templates/markup_processor_integrations/redcloth_spec.rb +0 -48
data/spec/templates/method_spec.rb +0 -118
data/spec/templates/module_spec.rb +0 -203
data/spec/templates/onefile_spec.rb +0 -66
data/spec/templates/section_spec.rb +0 -144
data/spec/templates/spec_helper.rb +0 -76
data/spec/templates/tag_spec.rb +0 -52
data/spec/templates/template_spec.rb +0 -410
data/spec/verifier_spec.rb +0 -106

data/spec/templates/examples/module001.txt DELETED Viewed

@@ -1,33 +0,0 @@
--------------------------------------------------------------- Module: A
-    Comments
-------------------------------------------------------------------------
-Defined Under Namespace:
-------------------------
-    Z (modules)
-    Q, X, Y (classes)
-Includes:
----------
-    D, E, F, A::B::C, B, BaseMod
-Class methods:
---------------
-    a
-Instance methods:
------------------
-    a, test_multi_overload, test_overload, void_meth

data/spec/templates/examples/module002.html DELETED Viewed

@@ -1,341 +0,0 @@
-<h1>Module: A
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>(stdin)</dd>
-  </dl>
-</div>
-  <h2>Foo <small><a href="#" class="summary_toggle">collapse</a></small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <a  title="#foo_attr (instance method)">#<strong>foo_attr</strong>  </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Returns the value of attribute foo_attr.</div></span>
-</li>
-  </ul>
-    <h2>
-      Foo
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a  title="bar (class method)">.<strong>bar</strong>  </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a  title="#foo (instance method)">#<strong>foo</strong>  </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-    </ul>
-    <h2>
-      Bar
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a  title="#baz (instance method)">#<strong>baz</strong>  </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-    </ul>
-    <h2>
-      Class Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a  title="baz (class method)">.<strong>baz</strong>  </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-    </ul>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id="foo_attr=-instance_method"></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="foo_attr-instance_method">
-    #<strong>foo_attr</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-    Returns the value of attribute foo_attr.
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-3
-4
-5</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 3</span>
-def foo_attr
-  @foo_attr
-end</pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="bar-class_method">
-    .<strong>bar</strong>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-5</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 5</span>
-def self.bar; end</pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="baz-class_method">
-    .<strong>baz</strong>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-12</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 12</span>
-def self.baz; end</pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="baz-instance_method">
-    #<strong>baz</strong>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-8</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 8</span>
-def baz; end</pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="foo-instance_method">
-    #<strong>foo</strong>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-4</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 4</span>
-def foo; end</pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>

data/spec/templates/examples/module003.html DELETED Viewed

@@ -1,202 +0,0 @@
-<h1>Module: A
-</h1>
-<div class="box_info">
-  <dl>
-      <dt>Includes:</dt>
-      <dd>B</dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>(stdin)</dd>
-  </dl>
-</div>
-  <h2>
-    Constant Summary
-    <small><a href="#" class="constants_summary_toggle">collapse</a></small>
-  </h2>
-    <dl class="constants">
-        <dt id="FOO-constant" class="">FOO =
-        </dt>
-        <dd><pre class="code">2</pre></dd>
-    </dl>
-  <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <a  title="#bar (instance method)">#<strong>bar</strong>  </a>
-  </span>
-      <span class="note title readonly">readonly</span>
-    <span class="summary_desc"><div class='inline'>Returns the value of attribute bar.</div></span>
-</li>
-  </ul>
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a  title="#foo (instance method)">#<strong>foo</strong>  </a>
-  </span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-    </ul>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id=""></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="bar-instance_method">
-    #<strong>bar</strong>   <span class="extras">(readonly)</span>
-</h3><div class="docstring">
-  <div class="discussion">
-    Returns the value of attribute bar.
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-11
-12
-13</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 11</span>
-def bar
-  @bar
-end</pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="foo-instance_method">
-    #<strong>foo</strong>
-</h3><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-10</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 10</span>
-def foo; end</pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>