yard 0.7.5 → 0.8.0

data/spec/templates/examples/module004.html

@@ -0,0 +1,388 @@
+<h1>Class: A
+
+
+
+</h1>
+
+<dl class="box">
+
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">Object</span>
+
+        <ul class="fullTree">
+          <li>Object</li>
+
+            <li class="next">A</li>
+
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+
+      </dd>
+
+
+
+
+      <dt class="r2">Extended by:</dt>
+      <dd class="r2">Bar</dd>
+
+
+
+
+      <dt class="r1">Includes:</dt>
+      <dd class="r1">BarFooBar, Baz::ABC, Baz::XYZ, Foo</dd>
+
+
+
+
+
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">(stdin)</dd>
+
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+  <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_attr (instance method)">- <strong>bar_attr</strong> </a>
+
+
+
+  </span>
+
+    <span class="note title not_defined_here">
+      included
+      from Foo
+    </span>
+
+
+
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>Docs for bar_attr.</div></span>
+
+</li>
+
+
+  </ul>
+
+
+
+
+
+    <h2>
+      Booya
+      <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="note title not_defined_here">
+      extended
+      from Bar
+    </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>Docs for baz in Booya group.</div></span>
+
+</li>
+
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a  title="#baz_abc (instance method)">- <strong>baz_abc</strong> </a>
+
+
+
+  </span>
+
+    <span class="note title not_defined_here">
+      included
+      from Baz::ABC
+    </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'></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'>This method is in A.</div></span>
+
+</li>
+
+
+        <li class="public ">
+  <span class="summary_signature">
+
+      <a  title="#xyz (instance method)">- <strong>xyz</strong> </a>
+
+
+
+  </span>
+
+    <span class="note title not_defined_here">
+      included
+      from Foo
+    </span>
+
+
+
+
+
+
+
+
+
+    <span class="summary_desc"><div class='inline'>Docs for xyz.</div></span>
+
+</li>
+
+
+    </ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+  <h3 class="inherited">Methods included from Baz::XYZ</h3>
+  <p class="inherited">#baz_xyz</p>
+
+
+
+
+
+
+
+
+
+  <h3 class="inherited">Methods included from BarFooBar</h3>
+  <p class="inherited">#bar_foo_bar</p>
+
+
+
+  <div id="instance_attr_details" class="attr_details">
+    <h2>Instance Attribute Details</h2>
+
+
+      <span id="bar_attr=-instance_method"></span>
+      <span id="bar_attr-instance_method"></span>
+      <div class="method_details first">
+  <h3 class="signature first" id="bar_attr-instance_method">
+
+    - <strong>bar_attr</strong>
+
+
+
+
+
+    <span class="not_defined_here">
+      Originally defined in module
+        Foo
+    </span>
+
+</h3><div class="docstring">
+  <div class="discussion">
+    Docs for bar_attr
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div>
+</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="baz-class_method">
+
+    + <strong>baz</strong>
+
+
+
+
+
+    <span class="not_defined_here">
+      Originally defined in module
+        Bar
+    </span>
+
+</h3><div class="docstring">
+  <div class="discussion">
+    Docs for baz in Booya group
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div>
+</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_abc-instance_method">
+
+    - <strong>baz_abc</strong>
+
+
+
+
+
+    <span class="not_defined_here">
+      Originally defined in module
+        Baz::ABC
+    </span>
+
+</h3>
+</div>
+
+      <div class="method_details ">
+  <h3 class="signature " id="foo-instance_method">
+
+    - <strong>foo</strong>
+
+
+
+
+
+</h3><div class="docstring">
+  <div class="discussion">
+    This method is in A
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+3</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 3</span>
+
+def foo; end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+
+      <div class="method_details ">
+  <h3 class="signature " id="xyz-instance_method">
+
+    - <strong>xyz</strong>
+
+
+
+
+
+    <span class="not_defined_here">
+      Originally defined in module
+        Foo
+    </span>
+
+</h3><div class="docstring">
+  <div class="discussion">
+    Docs for xyz
+
+  </div>
+</div>
+<div class="tags">
+
+
+</div>
+</div>
+
+  </div>

data/spec/templates/helpers/base_helper_spec.rb

@@ -2,142 +2,142 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe YARD::Templates::Helpers::BaseHelper do
   include YARD::Templates::Helpers::BaseHelper
-  
+
   describe '#run_verifier' do
     it "should run verifier proc against list if provided" do
       mock = Verifier.new
       mock.should_receive(:call).with(1)
       mock.should_receive(:call).with(2)
       mock.should_receive(:call).with(3)
-      should_receive(:options).at_least(1).times.and_return(:verifier => mock)
-      run_verifier [1, 2, 3]      
+      should_receive(:options).at_least(1).times.and_return(Options.new.update(:verifier => mock))
+      run_verifier [1, 2, 3]
     end
-    
+
     it "should prune list if lambda returns false and only false" do
       mock = Verifier.new
-      should_receive(:options).at_least(1).times.and_return(:verifier => mock)
+      should_receive(:options).at_least(1).times.and_return(Options.new.update(:verifier => mock))
       mock.should_receive(:call).with(1).and_return(false)
       mock.should_receive(:call).with(2).and_return(true)
       mock.should_receive(:call).with(3).and_return(nil)
       mock.should_receive(:call).with(4).and_return("value")
       run_verifier([1, 2, 3, 4]).should == [2, 3, 4]
     end
-    
+
     it "should return list if no verifier exists" do
-      should_receive(:options).at_least(1).times.and_return({})
+      should_receive(:options).at_least(1).times.and_return(Options.new)
       run_verifier([1, 2, 3]).should == [1, 2, 3]
     end
   end
-  
+
   describe '#h' do
     it "should return just the text" do
       h("hello world").should == "hello world"
       h(nil).should == nil
     end
   end
-  
+
   describe '#link_object' do
     it "should return the title if provided" do
       link_object(1, "title").should == "title"
       link_object(Registry.root, "title").should == "title"
     end
-    
+
     it "should return a path if argument is a Proxy or object" do
       link_object(Registry.root).should == ""
       link_object(P("Array")).should == "Array"
     end
-    
+
     it "should should return path of Proxified object if argument is a String or Symbol" do
       link_object("Array").should == "Array"
       link_object(:"A::B").should == "A::B"
     end
-    
+
     it "should return the argument if not an object, proxy, String or Symbol" do
       link_object(1).should == 1
     end
   end
-  
+
   describe '#link_url' do
     it "should return the URL" do
       link_url("http://url").should == "http://url"
     end
   end
-  
+
   describe '#linkify' do
     before do
       stub!(:object).and_return(Registry.root)
     end
-    
+
     it "should call #link_url for mailto: links" do
       should_receive(:link_url)
       linkify("mailto:steve@example.com")
     end
-    
+
     it "should call #link_url for URL schemes (http://)" do
       should_receive(:link_url)
       linkify("http://example.com")
     end
-    
+
     it "should call #link_file for file: links" do
       should_receive(:link_file).with('Filename', nil, 'anchor')
       linkify("file:Filename#anchor")
     end
-    
+
     it "should pass off to #link_object if argument is an object" do
       obj = CodeObjects::NamespaceObject.new(nil, :YARD)
       should_receive(:link_object).with(obj)
       linkify obj
     end
-    
+
     it "should return empty string and warn if object does not exist" do
       log.should_receive(:warn).with(/Cannot find object .* for inclusion/)
       linkify('include:NotExist').should == ''
     end
-  
+
     it "should pass off to #link_url if argument is recognized as a URL" do
       url = "http://yardoc.org/"
       should_receive(:link_url).with(url, nil, {:target => '_parent'})
       linkify url
     end
-    
+
     it "should call #link_include_object for include:ObjectName" do
       obj = CodeObjects::NamespaceObject.new(:root, :Foo)
       should_receive(:link_include_object).with(obj)
       linkify 'include:Foo'
     end
-    
+
     it "should call #link_include_file for include:file:path/to/file" do
       File.should_receive(:file?).with('path/to/file').and_return(true)
       File.should_receive(:read).with('path/to/file').and_return('FOO')
       linkify('include:file:path/to/file').should == 'FOO'
     end
-    
+
     it "should not allow include:file for path above pwd" do
       log.should_receive(:warn).with("Cannot include file from path `a/b/../../../../file'")
       linkify('include:file:a/b/../../../../file').should == ''
     end
-    
+
     it "should warn if include:file:path does not exist" do
       log.should_receive(:warn).with(/Cannot find file .+ for inclusion/)
       linkify('include:file:notexist').should == ''
     end
   end
-  
+
   describe '#format_types' do
     it "should return the list of types separated by commas surrounded by brackets" do
       format_types(['a', 'b', 'c']).should == '(a, b, c)'
     end
-    
+
     it "should return the list of types without brackets if brackets=false" do
       format_types(['a', 'b', 'c'], false).should == 'a, b, c'
     end
-    
+
     it "should should return an empty string if list is empty or nil" do
       format_types(nil).should == ""
       format_types([]).should == ""
     end
   end
-  
+
   describe '#format_object_type' do
     it "should return Exception if type is Exception" do
       obj = mock(:object)
@@ -145,26 +145,26 @@ describe YARD::Templates::Helpers::BaseHelper do
       obj.stub!(:is_exception?).and_return(true)
       format_object_type(obj).should == "Exception"
     end
-    
+
     it "should return Class if type is Class" do
       obj = mock(:object)
       obj.stub!(:is_a?).with(YARD::CodeObjects::ClassObject).and_return(true)
       obj.stub!(:is_exception?).and_return(false)
       format_object_type(obj).should == "Class"
     end
-    
+
     it "should return object type in other cases" do
       obj = mock(:object)
       obj.stub!(:type).and_return("value")
       format_object_type(obj).should == "Value"
     end
   end
-  
+
   describe '#format_object_title' do
     it "should return Top Level Namespace for root object" do
       format_object_title(Registry.root).should == "Top Level Namespace"
     end
-    
+
     it "should return 'type: path' in other cases" do
       obj = mock(:object)
       obj.stub!(:type).and_return(:class)