yard 0.4.0 → 0.5.0

data/spec/spec_helper.rb

@@ -3,9 +3,9 @@ require "spec"
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'yard'))
 
-def parse_file(file, thisfile = __FILE__, log_level = log.level)
+def parse_file(file, thisfile = __FILE__, log_level = log.level, ext = '.rb.txt')
   Registry.clear
-  path = File.join(File.dirname(thisfile), 'examples', file.to_s + '.rb.txt')
+  path = File.join(File.dirname(thisfile), 'examples', file.to_s + ext)
   YARD::Parser::SourceParser.parse(path, log_level)
 end
 

data/spec/tags/overload_tag_spec.rb

@@ -32,4 +32,22 @@ describe YARD::Tags::OverloadTag do
     @tag.tag(:param).name.should == "a"
     @tag.has_tag?(:return).should == true
   end
+  
+  it "should not be a CodeObjects::Base when not hooked up to an object" do
+    @tag.object = nil
+    @tag.is_a?(CodeObjects::Base).should == false
+  end
+  
+  it "should be a CodeObjects::Base when hooked up to an object" do
+    @tag.object = mock(:object)
+    @tag.object.should_receive(:is_a?).at_least(3).times.with(CodeObjects::Base).and_return(true)
+    @tag.is_a?(CodeObjects::Base).should == true
+    @tag.kind_of?(CodeObjects::Base).should == true
+    (CodeObjects::Base === @tag).should == true
+  end
+
+  it "should not parse 'def' out of method name" do
+    tag = Tags::OverloadTag.new(:overload, nil, "default")
+    tag.signature.should == "default"
+  end
 end

data/spec/templates/examples/class001.html

@@ -87,16 +87,22 @@ Comments
 
   
 
-  <h2>Method Summary</h2>
+  <h2>Instance Method Summary</h2>
+
   <ul class="summary">
     
       <li class="public deprecated">
-  <span class="summary_signature"><a  title="#a (instance method)">- (Object) <strong>a</strong> </a>
-  
+  <span class="summary_signature">
+    
+      <a  title="#a (instance method)">- <strong>a</strong> </a>
+    
+
+    
   </span>
   
   
   
+  
   <span class="deprecated note title">Deprecated</span>
 
   
@@ -106,10 +112,17 @@ Comments
 
     
       <li class="public ">
-  <span class="summary_signature"><a  title="#initialize (instance method)">- (A) <strong>initialize</strong>(test) </a>
-  
+  <span class="summary_signature">
+    
+      <a  title="#initialize (instance method)">- (A) <strong>initialize</strong>(test) </a>
+    
+
+    
   </span>
   
+    <span class="note title constructor">constructor</span>
+  
+  
   
   
   
@@ -121,13 +134,18 @@ Comments
 
     
       <li class="public ">
-  <span class="summary_signature"><a  title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(*args) </a>
-  
+  <span class="summary_signature">
+    
+      <a  title="#method_missing (instance method)">- <strong>method_missing</strong>(*args) </a>
+    
+
+    
   </span>
   
   
   
   
+  
 
   
     <span class="summary_desc">HI.</span>
@@ -137,8 +155,7 @@ Comments
     
   </ul>
 
-
-  <div id="constructor_details">
+  <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
   
     <div class="method_details first">
@@ -155,23 +172,7 @@ Comments
   </div>
 </div>
 <div class="tags">
-  <h3>Returns:</h3>
-<ul class="return">
-  
-    <li>
-      
-        <span class='type'>(<tt>A</tt>)</span>
-      
-      
-      
-      
-        &mdash;
-        a new instance of +A+
-      
-    </li>
   
-</ul>
-
 </div><table class="source_code">
   <tr>
     <td>
@@ -190,7 +191,7 @@ def initialize(test) end</pre>
 </div>
   
 </div>
-<div id="method_missing_details">
+<div id="method_missing_details" class="method_details_list">
   <h2>Dynamic Method Handling</h2>
   <p class="notice this">
     This class handles dynamic methods through the <tt>method_missing</tt> method
@@ -200,7 +201,7 @@ def initialize(test) end</pre>
     <div class="method_details first">
   <p class="signature first" id="method_missing-instance_method">
   
-    - (<tt>Object</tt>) <strong>method_missing</strong>(*args) 
+    - <strong>method_missing</strong>(*args) 
   
 
   
@@ -232,13 +233,14 @@ def method_missing(*args) end</pre>
 </div>
 
 
-  <div id="method_details">
-    <h2>Method Details</h2>
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+    
     
       <div class="method_details first">
   <p class="signature first" id="a-instance_method">
   
-    - (<tt>Object</tt>) <strong>a</strong> 
+    - <strong>a</strong> 
   
 
   

data/spec/templates/examples/method001.html

@@ -7,6 +7,7 @@
 </dl>
 <div class="clear"></div>
 
+<div class="method_details_list">
 <div id="method_details">
   <div class="method_details first">
   <p class="signature first" id="m-instance_method">
@@ -16,13 +17,14 @@
 
   
     <span class="aliases">Also known as:
-    <span class="names">x</span>
+    <span class="names"><span id='x-instance_method'>x</span></span>
     </span>
   
 </p><div class="docstring">
   <div class="discussion">
     <p class="note deprecated"><strong>Deprecated.</strong> for great justice</p>
 Comments
+
   </div>
 </div>
 <div class="tags">
@@ -94,3 +96,4 @@ def m(x) end</pre>
 </table>
 </div>
 </div>
+</div>

data/spec/templates/examples/method002.html

@@ -7,23 +7,27 @@
 </dl>
 <div class="clear"></div>
 
+<div class="method_details_list">
 <div id="method_details">
   <div class="method_details first">
   <p class="signature first" id="m-instance_method">
   
-    - (<tt>Object</tt>) <strong>m</strong>(x, y)  <span class="extras">(private)</span>
+    - <strong>m</strong>(x, y)  <span class="extras">(private)</span>
   
 
   
 </p><div class="docstring">
   <div class="discussion">
     Comments
+
   </div>
 </div>
 <div class="tags">
-    <div class="docstring">
+  
+  <div class="docstring">
   <div class="discussion">
     
+
   </div>
 </div>
 <div class="tags">
@@ -79,3 +83,4 @@ def m(x) end</pre>
 </table>
 </div>
 </div>
+</div>

data/spec/templates/examples/method002.txt

@@ -1,7 +1,7 @@
 ------------------------------------------------------------- Method: #m
                                                    (Defined in: (stdin))
 
-    root.m(x, y) -> Object (private)
+    root.m(x, y) (private)
 ------------------------------------------------------------------------
 
     Comments 

data/spec/templates/examples/method003.html

@@ -7,14 +7,15 @@
 </dl>
 <div class="clear"></div>
 
-<div id="method_details">
-  <div class="method_details first">
+<div class="method_details_list">
+  <div id="method_details">
+    <div class="method_details first">
   <p class="signature first" id="m-instance_method">
   
     
-      <span class="overload">- (<tt>Object</tt>) <strong>m</strong>(x, y)  <span class="extras">(private)</span></span>
+      <span class="overload">- <strong>m</strong>(x, y)  <span class="extras">(private)</span></span>
     
-      <span class="overload">- (<tt>Object</tt>) <strong>m</strong>(x, y, z)  <span class="extras">(private)</span></span>
+      <span class="overload">- <strong>m</strong>(x, y, z)  <span class="extras">(private)</span></span>
     
   
 
@@ -22,17 +23,21 @@
 </p><div class="docstring">
   <div class="discussion">
     Method comments
+
   </div>
 </div>
 <div class="tags">
-    <h3>Overloads:</h3>
+  
+  <h3>Overloads:</h3>
   <ul class="overload">
     
+      
       <li class="overload_item">
-        <span class="signature">- (<tt>Object</tt>) <strong>m</strong>(x, y)  <span class="extras">(private)</span></span>
+        <span class="signature">- <strong>m</strong>(x, y) </span>
         <div class="docstring">
   <div class="discussion">
     Overload docstring
+
   </div>
 </div>
 <div class="tags">
@@ -72,11 +77,13 @@
 </div>
       </li>
     
+      
       <li class="overload_item">
-        <span class="signature">- (<tt>Object</tt>) <strong>m</strong>(x, y, z)  <span class="extras">(private)</span></span>
+        <span class="signature">- <strong>m</strong>(x, y, z) </span>
         <div class="docstring">
   <div class="discussion">
     
+
   </div>
 </div>
 <div class="tags">
@@ -132,6 +139,21 @@
     
   </ul>
 
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+11</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 11</span>
+
+def m(*args) end</pre>
+    </td>
+  </tr>
+</table>
 </div>
-</div>
+  </div>
 </div>

data/spec/templates/examples/method003.txt

@@ -1,8 +1,8 @@
 ------------------------------------------------------------- Method: #m
                                                    (Defined in: (stdin))
 
-    root.m(x, y) -> Object (private)
-    root.m(x, y, z) -> Object (private)
+    root.m(x, y) (private)
+    root.m(x, y, z) (private)
 ------------------------------------------------------------------------
 
     Method comments 
@@ -11,7 +11,7 @@ Overloads:
 ----------
 
 ------------------------------------------------------------------------
-    root.m(x, y) -> Object (private)
+    root.m(x, y) (private)
 ------------------------------------------------------------------------
     
         Overload docstring 
@@ -26,7 +26,7 @@ Overloads:
     
 
 ------------------------------------------------------------------------
-    root.m(x, y, z) -> Object (private)
+    root.m(x, y, z) (private)
 ------------------------------------------------------------------------
     
         

data/spec/templates/examples/method004.html

@@ -0,0 +1,44 @@
+<h1>Method: #m</h1>
+<dl class="box">
+  <dt class="r1 last">Defined in:</dt>
+  <dd class="r1 last">
+    (stdin)
+  </dd>
+</dl>
+<div class="clear"></div>
+
+<div class="method_details_list">
+<div id="method_details">
+  <div class="method_details first">
+  <p class="signature first" id="m-instance_method">
+  
+    - (<tt>void</tt>) <strong>m</strong>(*args) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p class="note returns_void">This method returns an undefined value.</p>
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+2</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 2</span>
+
+def m(*args) end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+</div>
+</div>

data/spec/templates/examples/method004.txt

@@ -0,0 +1,10 @@
+------------------------------------------------------------- Method: #m
+                                                   (Defined in: (stdin))
+
+    root.m(*args) -> void 
+------------------------------------------------------------------------
+
+    This method returns an undefined value.
+    
+
+

data/spec/templates/examples/method005.html

@@ -0,0 +1,99 @@
+<h1>Method: #m</h1>
+<dl class="box">
+  <dt class="r1 last">Defined in:</dt>
+  <dd class="r1 last">
+    (stdin)
+  </dd>
+</dl>
+<div class="clear"></div>
+
+<div class="method_details_list">
+  <div id="method_details">
+    <div class="method_details first">
+  <p class="signature first" id="m-instance_method">
+  
+    
+      <span class="overload">- (<tt>void</tt>) <strong>m</strong>(a) </span>
+    
+      <span class="overload">- <strong>m</strong>(b) </span>
+    
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  
+  <h3>Overloads:</h3>
+  <ul class="overload">
+    
+      
+      <li class="overload_item">
+        <span class="signature">- (<tt>void</tt>) <strong>m</strong>(a) </span>
+        <div class="docstring">
+  <div class="discussion">
+    <p class="note returns_void">This method returns an undefined value.</p>
+
+  </div>
+</div>
+<div class="tags">
+  
+</div>
+      </li>
+    
+      
+      <li class="overload_item">
+        <span class="signature">- <strong>m</strong>(b) </span>
+        <div class="docstring">
+  <div class="discussion">
+    
+
+  </div>
+</div>
+<div class="tags">
+  <h3>Parameters:</h3>
+<ul class="param">
+  
+    <li>
+      
+        <span class='type'>(<tt>String</tt>)</span>
+      
+      
+        <span class='name'>b</span>
+      
+      
+      
+        &mdash;
+        hi
+      
+    </li>
+  
+</ul>
+
+</div>
+      </li>
+    
+  </ul>
+
+</div><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 m(*args) end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  </div>
+</div>