RubyGems - yard - Versions diffs - 0.8.7.6 → 0.9.0 - Mend

yard 0.8.7.6 → 0.9.0

Potentially problematic release.

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

Files changed (225) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +20 -1
data/LICENSE +2 -2
data/README.md +2 -2
data/Rakefile +1 -1
data/bin/yard +0 -0
data/bin/yardoc +0 -0
data/bin/yri +0 -0
data/docs/GettingStarted.md +88 -6
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/templates/default/fulldoc/html/full_list_tag.erb +6 -4
data/lib/yard/autoload.rb +3 -0
data/lib/yard/cli/yardoc.rb +1 -1
data/lib/yard/code_objects/base.rb +4 -1
data/lib/yard/code_objects/extra_file_object.rb +3 -1
data/lib/yard/code_objects/proxy.rb +2 -2
data/lib/yard/docstring.rb +11 -6
data/lib/yard/handlers/base.rb +1 -2
data/lib/yard/handlers/c/base.rb +19 -0
data/lib/yard/handlers/c/handler_methods.rb +42 -8
data/lib/yard/handlers/c/init_handler.rb +1 -1
data/lib/yard/handlers/c/method_handler.rb +3 -3
data/lib/yard/handlers/ruby/decorator_handler_methods.rb +132 -0
data/lib/yard/handlers/ruby/legacy/private_class_method_handler.rb +1 -1
data/lib/yard/handlers/ruby/private_class_method_handler.rb +6 -39
data/lib/yard/handlers/ruby/private_constant_handler.rb +36 -30
data/lib/yard/handlers/ruby/public_class_method_handler.rb +13 -0
data/lib/yard/handlers/ruby/struct_handler_methods.rb +1 -0
data/lib/yard/handlers/ruby/visibility_handler.rb +5 -8
data/lib/yard/logging.rb +1 -0
data/lib/yard/parser/ruby/ruby_parser.rb +2 -2
data/lib/yard/parser/source_parser.rb +6 -6
data/lib/yard/rake/yardoc_task.rb +2 -2
data/lib/yard/serializers/file_system_serializer.rb +33 -1
data/lib/yard/server/commands/display_file_command.rb +8 -3
data/lib/yard/server/commands/display_object_command.rb +7 -3
data/lib/yard/server/doc_server_helper.rb +2 -8
data/lib/yard/server/doc_server_serializer.rb +2 -4
data/lib/yard/server/router.rb +1 -1
data/lib/yard/server/templates/default/fulldoc/html/css/custom.css +57 -8
data/lib/yard/server/templates/default/layout/html/breadcrumb.erb +2 -10
data/lib/yard/server/templates/default/layout/html/script_setup.erb +1 -2
data/lib/yard/server/templates/default/method_details/html/permalink.erb +3 -3
data/lib/yard/server/templates/doc_server/processing/html/processing.erb +4 -4
data/lib/yard/tags/directives.rb +1 -0
data/lib/yard/tags/library.rb +9 -7
data/lib/yard/tags/overload_tag.rb +4 -1
data/lib/yard/templates/helpers/html_helper.rb +4 -3
data/lib/yard/templates/template_options.rb +3 -0
data/lib/yard/version.rb +1 -1
data/spec/cli/command_parser_spec.rb +14 -14
data/spec/cli/command_spec.rb +11 -11
data/spec/cli/config_spec.rb +32 -32
data/spec/cli/diff_spec.rb +86 -90
data/spec/cli/display_spec.rb +6 -6
data/spec/cli/gems_spec.rb +28 -28
data/spec/cli/graph_spec.rb +8 -8
data/spec/cli/help_spec.rb +8 -8
data/spec/cli/i18n_spec.rb +33 -37
data/spec/cli/list_spec.rb +2 -2
data/spec/cli/markup_types_spec.rb +3 -3
data/spec/cli/server_spec.rb +74 -88
data/spec/cli/stats_spec.rb +14 -14
data/spec/cli/yardoc_spec.rb +316 -321
data/spec/cli/yri_spec.rb +45 -45
data/spec/code_objects/base_spec.rb +174 -173
data/spec/code_objects/class_object_spec.rb +65 -65
data/spec/code_objects/code_object_list_spec.rb +13 -11
data/spec/code_objects/constants_spec.rb +68 -58
data/spec/code_objects/extra_file_object_spec.rb +71 -59
data/spec/code_objects/macro_object_spec.rb +64 -64
data/spec/code_objects/method_object_spec.rb +80 -72
data/spec/code_objects/module_object_spec.rb +47 -47
data/spec/code_objects/namespace_object_spec.rb +51 -51
data/spec/code_objects/proxy_spec.rb +54 -54
data/spec/config_spec.rb +104 -104
data/spec/core_ext/array_spec.rb +5 -5
data/spec/core_ext/file_spec.rb +33 -33
data/spec/core_ext/hash_spec.rb +5 -5
data/spec/core_ext/insertion_spec.rb +18 -18
data/spec/core_ext/module_spec.rb +6 -6
data/spec/core_ext/string_spec.rb +17 -17
data/spec/core_ext/symbol_hash_spec.rb +42 -39
data/spec/docstring_parser_spec.rb +65 -65
data/spec/docstring_spec.rb +137 -130
data/spec/handlers/alias_handler_spec.rb +39 -39
data/spec/handlers/attribute_handler_spec.rb +35 -35
data/spec/handlers/base_spec.rb +60 -51
data/spec/handlers/c/alias_handler_spec.rb +6 -6
data/spec/handlers/c/attribute_handler_spec.rb +12 -12
data/spec/handlers/c/class_handler_spec.rb +35 -22
data/spec/handlers/c/constant_handler_spec.rb +24 -22
data/spec/handlers/c/init_handler_spec.rb +10 -10
data/spec/handlers/c/method_handler_spec.rb +150 -65
data/spec/handlers/c/mixin_handler_spec.rb +5 -5
data/spec/handlers/c/module_handler_spec.rb +27 -15
data/spec/handlers/c/override_comment_handler_spec.rb +14 -14
data/spec/handlers/c/path_handler_spec.rb +8 -8
data/spec/handlers/c/spec_helper.rb +10 -0
data/spec/handlers/c/struct_handler_spec.rb +3 -3
data/spec/handlers/class_condition_handler_spec.rb +18 -18
data/spec/handlers/class_handler_spec.rb +97 -97
data/spec/handlers/class_method_handler_shared_examples.rb +132 -0
data/spec/handlers/class_variable_handler_spec.rb +3 -3
data/spec/handlers/constant_handler_spec.rb +32 -29
data/spec/handlers/decorator_handler_methods_spec.rb +405 -0
data/spec/handlers/dsl_handler_spec.rb +108 -109
data/spec/handlers/examples/constant_handler_001.rb.txt +4 -1
data/spec/handlers/examples/visibility_handler_001.rb.txt +4 -0
data/spec/handlers/exception_handler_spec.rb +23 -23
data/spec/handlers/extend_handler_spec.rb +9 -9
data/spec/handlers/legacy_base_spec.rb +60 -60
data/spec/handlers/method_condition_handler_spec.rb +5 -5
data/spec/handlers/method_handler_spec.rb +92 -92
data/spec/handlers/mixin_handler_spec.rb +25 -25
data/spec/handlers/module_function_handler_spec.rb +24 -24
data/spec/handlers/module_handler_spec.rb +15 -15
data/spec/handlers/private_class_method_handler_spec.rb +4 -48
data/spec/handlers/private_constant_handler_spec.rb +8 -8
data/spec/handlers/processor_spec.rb +12 -12
data/spec/handlers/public_class_method_handler_spec.rb +10 -0
data/spec/handlers/ruby/base_spec.rb +16 -16
data/spec/handlers/ruby/legacy/base_spec.rb +20 -18
data/spec/handlers/spec_helper.rb +1 -1
data/spec/handlers/visibility_handler_spec.rb +25 -21
data/spec/handlers/yield_handler_spec.rb +28 -28
data/spec/i18n/locale_spec.rb +16 -16
data/spec/i18n/message_spec.rb +8 -8
data/spec/i18n/messages_spec.rb +14 -14
data/spec/i18n/pot_generator_spec.rb +32 -32
data/spec/i18n/text_spec.rb +22 -22
data/spec/logging_spec.rb +12 -12
data/spec/options_spec.rb +56 -56
data/spec/parser/base_spec.rb +9 -9
data/spec/parser/c_parser_spec.rb +50 -50
data/spec/parser/ruby/ast_node_spec.rb +7 -7
data/spec/parser/ruby/legacy/statement_list_spec.rb +106 -106
data/spec/parser/ruby/legacy/token_list_spec.rb +27 -27
data/spec/parser/ruby/ruby_parser_spec.rb +123 -113
data/spec/parser/source_parser_spec.rb +224 -224
data/spec/parser/tag_parsing_spec.rb +6 -7
data/spec/rake/yardoc_task_spec.rb +38 -48
data/spec/registry_spec.rb +143 -143
data/spec/registry_store_spec.rb +165 -165
data/spec/rubygems/doc_manager_spec.rb +38 -38
data/spec/serializers/file_system_serializer_spec.rb +53 -33
data/spec/serializers/yardoc_serializer_spec.rb +15 -15
data/spec/server/adapter_spec.rb +15 -15
data/spec/server/commands/base_spec.rb +29 -29
data/spec/server/commands/library_command_spec.rb +12 -12
data/spec/server/commands/static_file_command_spec.rb +28 -28
data/spec/server/doc_server_helper_spec.rb +8 -8
data/spec/server/doc_server_serializer_spec.rb +23 -18
data/spec/server/rack_adapter_spec.rb +6 -6
data/spec/server/router_spec.rb +39 -39
data/spec/server/static_caching_spec.rb +16 -16
data/spec/server/webrick_servlet_spec.rb +6 -7
data/spec/server_spec.rb +3 -3
data/spec/spec_helper.rb +11 -2
data/spec/tags/default_factory_spec.rb +64 -64
data/spec/tags/default_tag_spec.rb +5 -5
data/spec/tags/directives_spec.rb +121 -121
data/spec/tags/library_spec.rb +14 -14
data/spec/tags/overload_tag_spec.rb +24 -24
data/spec/tags/ref_tag_list_spec.rb +12 -12
data/spec/templates/class_spec.rb +3 -3
data/spec/templates/constant_spec.rb +4 -4
data/spec/templates/engine_spec.rb +47 -48
data/spec/templates/examples/class001.html +129 -101
data/spec/templates/examples/class002.html +31 -27
data/spec/templates/examples/method001.html +54 -47
data/spec/templates/examples/method002.html +33 -28
data/spec/templates/examples/method003.html +70 -64
data/spec/templates/examples/method004.html +13 -9
data/spec/templates/examples/method005.html +38 -32
data/spec/templates/examples/module001.html +343 -339
data/spec/templates/examples/module002.html +147 -124
data/spec/templates/examples/module003.html +94 -81
data/spec/templates/examples/module004.html +40 -33
data/spec/templates/helpers/base_helper_spec.rb +91 -95
data/spec/templates/helpers/html_helper_spec.rb +276 -279
data/spec/templates/helpers/html_syntax_highlight_helper_spec.rb +16 -15
data/spec/templates/helpers/markup/rdoc_markup_spec.rb +27 -34
data/spec/templates/helpers/markup_helper_spec.rb +57 -57
data/spec/templates/helpers/method_helper_spec.rb +20 -20
data/spec/templates/helpers/shared_signature_examples.rb +33 -31
data/spec/templates/helpers/text_helper_spec.rb +6 -6
data/spec/templates/method_spec.rb +7 -7
data/spec/templates/module_spec.rb +7 -7
data/spec/templates/onefile_spec.rb +7 -7
data/spec/templates/section_spec.rb +66 -69
data/spec/templates/spec_helper.rb +1 -1
data/spec/templates/tag_spec.rb +5 -5
data/spec/templates/template_spec.rb +158 -158
data/spec/verifier_spec.rb +52 -52
data/templates/default/fulldoc/html/css/full_list.css +32 -31
data/templates/default/fulldoc/html/css/style.css +212 -77
data/templates/default/fulldoc/html/frames.erb +6 -15
data/templates/default/fulldoc/html/full_list.erb +14 -21
data/templates/default/fulldoc/html/full_list_class.erb +1 -1
data/templates/default/fulldoc/html/full_list_file.erb +6 -4
data/templates/default/fulldoc/html/full_list_method.erb +8 -6
data/templates/default/fulldoc/html/js/app.js +100 -76
data/templates/default/fulldoc/html/js/full_list.js +170 -135
data/templates/default/fulldoc/html/setup.rb +50 -7
data/templates/default/layout/html/breadcrumb.erb +0 -2
data/templates/default/layout/html/headers.erb +2 -1
data/templates/default/layout/html/layout.erb +16 -10
data/templates/default/layout/html/script_setup.erb +1 -2
data/templates/default/layout/html/search.erb +7 -2
data/templates/default/layout/html/setup.rb +16 -0
data/templates/default/method/html/header.erb +7 -6
data/templates/default/module/html/attribute_summary.erb +1 -1
data/templates/default/module/html/box_info.erb +24 -18
data/templates/default/module/html/constant_summary.erb +9 -11
data/templates/default/module/html/item_summary.erb +1 -1
data/templates/default/module/html/method_summary.erb +1 -1
data/templates/guide/fulldoc/html/setup.rb +1 -1
data/yard.gemspec +1 -2
metadata +10 -7
data/spec/handlers/examples/private_class_method_handler_001.rb.txt +0 -9
data/spec/handlers/examples/private_class_method_handler_002.rb.txt +0 -18
data/spec/handlers/examples/private_class_method_handler_003.rb.txt +0 -11

data/spec/templates/examples/module002.html CHANGED

@@ -1,182 +1,196 @@
 <h1>Module: A
 </h1>
+<div class="box_info">
+  <dl>
+    <dt>Defined in:</dt>
+    <dd>(stdin)</dd>
+  </dl>
+</div>
-<dl class="box">
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">(stdin)</dd>
-</dl>
-<div class="clear"></div>
-  <h2>Foo <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+  <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>
-      <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>
+      <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>
-      <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>
-      <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>
+      <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>
-      <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>
+      <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>
-      <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>
-    - <strong>foo_attr</strong>
 </h3><div class="docstring">
   <div class="discussion">
     Returns the value of attribute foo_attr
@@ -184,6 +198,7 @@
   </div>
 </div>
 <div class="tags">
 </div><table class="source_code">
   <tr>
@@ -205,21 +220,23 @@ end</pre>
   </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>
-    + <strong>bar</strong>
 </h3><table class="source_code">
   <tr>
     <td>
@@ -236,14 +253,16 @@ def self.bar; end</pre>
   </tr>
 </table>
 </div>
       <div class="method_details ">
   <h3 class="signature " id="baz-class_method">
+    .<strong>baz</strong>
-    + <strong>baz</strong>
 </h3><table class="source_code">
   <tr>
     <td>
@@ -260,20 +279,22 @@ def self.baz; end</pre>
   </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>
-    - <strong>baz</strong>
 </h3><table class="source_code">
   <tr>
     <td>
@@ -290,14 +311,16 @@ def baz; end</pre>
   </tr>
 </table>
 </div>
       <div class="method_details ">
   <h3 class="signature " id="foo-instance_method">
+    #<strong>foo</strong>
-    - <strong>foo</strong>
 </h3><table class="source_code">
   <tr>
     <td>
@@ -314,5 +337,5 @@ def foo; end</pre>
   </tr>
 </table>
 </div>
   </div>

data/spec/templates/examples/module003.html CHANGED

@@ -1,126 +1,137 @@
 <h1>Module: A
 </h1>
-<dl class="box">
-      <dt class="r1">Includes:</dt>
-      <dd class="r1">B</dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">(stdin)</dd>
-</dl>
-<div class="clear"></div>
+<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</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>
+  <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>
-      <a  title="#bar (instance method)">- <strong>bar</strong> </a>
   </span>
-    <span class="note title readonly">readonly</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>
+      <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>
-      <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>
-    - <strong>bar</strong>  <span class="extras">(readonly)</span>
 </h3><div class="docstring">
   <div class="discussion">
     Returns the value of attribute bar
@@ -128,7 +139,7 @@
   </div>
 </div>
 <div class="tags">
 </div><table class="source_code">
   <tr>
@@ -150,21 +161,23 @@ end</pre>
   </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>
-    - <strong>foo</strong>
 </h3><table class="source_code">
   <tr>
     <td>
@@ -181,5 +194,5 @@ def foo; end</pre>
   </tr>
 </table>
 </div>
   </div>