yard 0.6.8 → 0.7.0

data/spec/rake/yardoc_task_spec.rb

@@ -2,7 +2,14 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe YARD::Rake::YardocTask do
   before do
-    @yardoc = mock(:cli)
+    @yardoc = YARD::CLI::Yardoc.new
+    @yardoc.statistics = false
+    @yardoc.use_document_file = false
+    @yardoc.use_yardopts_file = false
+    @yardoc.generate = false
+    Templates::Engine.stub!(:render)
+    Templates::Engine.stub!(:generate)
+    YARD.stub!(:parse)
     YARD::CLI::Yardoc.stub!(:new).and_return(@yardoc)
     ::Rake.application.clear
   end
@@ -20,21 +27,21 @@ describe YARD::Rake::YardocTask do
   
   describe '#files' do
     it "should allow files to be set" do
-      @yardoc.should_receive(:run).with('a', 'b', 'c')
       YARD::Rake::YardocTask.new do |t|
         t.files = ['a', 'b', 'c']
       end
       run
+      @yardoc.files.should == %w(a b c)
     end
   end
   
   describe '#options' do
     it "should allow extra options to be set" do
-      @yardoc.should_receive(:run).with('--extra', '--opts')
       YARD::Rake::YardocTask.new do |t|
-        t.options = ['--extra', '--opts']
+        t.options = ['--private', '--protected']
       end
       run
+      @yardoc.visibilities.should == [:public, :private, :protected]
     end
   end
   
@@ -59,24 +66,22 @@ describe YARD::Rake::YardocTask do
     
     describe '#verifier' do
       it "should allow a verifier proc to be set" do
-        proc = mock(:proc)
-        mockopts = mock(:options)
-        mockopts.should_receive(:[]=).with(:verifier, proc)
-        @yardoc.should_receive(:options).and_return(mockopts)
-        @yardoc.should_receive(:run)
-        YARD::Rake::YardocTask.new {|t| t.verifier = proc }
+        verifier = Verifier.new
+        @yardoc.should_receive(:run) do
+          @yardoc.options[:verifier].should == verifier
+        end
+        YARD::Rake::YardocTask.new {|t| t.verifier = verifier }
         run
       end
 
-      it "should only use verifier if no --query options are passed" do
-        proc = mock(:proc)
-        mockopts = mock(:options)
-        mockopts.should_receive(:[]=).with(:verifier, proc)
-        @yardoc.should_receive(:options).and_return(mockopts)
-        @yardoc.should_receive(:run)
+      it "should override --query options" do
+        verifier = Verifier.new
+        @yardoc.should_receive(:run) do
+          @yardoc.options[:verifier].should == verifier
+        end
         YARD::Rake::YardocTask.new do |t| 
           t.options += ['--query', '@return']
-          t.verifier = proc
+          t.verifier = verifier
         end
         run
       end

data/spec/serializers/file_system_serializer_spec.rb

@@ -63,6 +63,12 @@ describe YARD::Serializers::FileSystemSerializer do
         s.serialized_path(m).should == value
       end
     end
+    
+    it "should handle ExtraFileObject's" do
+      s = Serializers::FileSystemSerializer.new
+      e = CodeObjects::ExtraFileObject.new('filename.txt', '')
+      s.serialized_path(e).should == 'file.filename.html'
+    end
 
     it "should differentiate instance and class methods from serialized path" do
       s = Serializers::FileSystemSerializer.new

data/spec/server/commands/library_command_spec.rb

@@ -0,0 +1,39 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'ostruct'
+
+describe YARD::Server::Commands::LibraryCommand do
+  before do
+    Templates::Engine.stub!(:render)
+    Templates::Engine.stub!(:generate)
+    YARD.stub!(:parse)
+    Registry.stub!(:load)
+    Registry.stub!(:save)
+
+    @cmd = LibraryCommand.new(:adapter => mock_adapter)
+    @request = OpenStruct.new(:xhr? => false, :path => "/foo")
+    @library = OpenStruct.new(:source_path => '.')
+    @cmd.library = @library
+    @cmd.stub!(:load_yardoc).and_return(nil)
+  end
+  
+  def call
+    lambda { @cmd.call(@request) }.should raise_error(NotImplementedError)
+  end
+  
+  describe "#call" do
+    it "should raise NotImplementedError" do
+      call
+    end
+    
+    it "should set :rdoc as the default markup in incremental mode" do
+      @cmd.incremental = true
+      call
+      @cmd.options[:markup].should == :rdoc
+    end
+
+    it "should set :rdoc as the default markup in regular mode" do
+      call
+      @cmd.options[:markup].should == :rdoc
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -88,4 +88,18 @@ def docspec(objname = self.class.description, klass = self.class.described_type)
   end
 end
 
+module Kernel
+  require 'cgi'
+
+  def p(*args)
+    puts args.map {|arg| CGI.escapeHTML(arg.inspect) }.join("<br/>\n")
+    args.first
+  end
+  
+  def puts(str)
+    STDOUT.puts str + "<br/>\n"
+    str
+  end
+end if ENV['TM_APP_PATH']
+
 include YARD

data/spec/templates/examples/method001.html

@@ -33,10 +33,10 @@ Comments
   
     <li>
       
-        <span class='type'>(<tt>Hash</tt>)</span>
+        <span class='name'>x</span>
       
       
-        <span class='name'>x</span>
+        <span class='type'>(<tt>Hash</tt>)</span>
       
       
       
@@ -54,8 +54,8 @@ Comments
     <ul class="option">
       
         <li>
-          <span class="type">(<tt>String</tt>)</span>
           <span class="name">:key1</span>
+          <span class="type">(<tt>String</tt>)</span>
           <span class="default">
             
               &mdash; default:
@@ -66,8 +66,8 @@ Comments
         </tr>
       
         <li>
-          <span class="type">(<tt>Symbol</tt>)</span>
           <span class="name">:key2</span>
+          <span class="type">(<tt>Symbol</tt>)</span>
           <span class="default">
             
           </span>
@@ -81,8 +81,8 @@ Comments
   
     <li>
       
-        <span class='type'>(<tt>String</tt>)</span>
       
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
@@ -97,8 +97,8 @@ Comments
   
     <li>
       
-        <span class='type'>(<tt>Exception</tt>)</span>
       
+        <span class='type'>(<tt>Exception</tt>)</span>
       
       
       

data/spec/templates/examples/method002.html

@@ -36,10 +36,10 @@
   
     <li>
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='name'>x</span>
       
       
-        <span class='name'>x</span>
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
@@ -50,10 +50,10 @@
   
     <li>
       
-        <span class='type'>(<tt>Boolean</tt>)</span>
+        <span class='name'>y</span>
       
       
-        <span class='name'>y</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
       
       
       

data/spec/templates/examples/method003.html

@@ -46,10 +46,10 @@
   
     <li>
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='name'>x</span>
       
       
-        <span class='name'>x</span>
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
@@ -60,10 +60,10 @@
   
     <li>
       
-        <span class='type'>(<tt>Boolean</tt>)</span>
+        <span class='name'>y</span>
       
       
-        <span class='name'>y</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
       
       
       
@@ -92,10 +92,10 @@
   
     <li>
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='name'>x</span>
       
       
-        <span class='name'>x</span>
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
@@ -106,10 +106,10 @@
   
     <li>
       
-        <span class='type'>(<tt>Boolean</tt>)</span>
+        <span class='name'>y</span>
       
       
-        <span class='name'>y</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
       
       
       
@@ -120,10 +120,10 @@
   
     <li>
       
-        <span class='type'>(<tt>Boolean</tt>)</span>
+        <span class='name'>z</span>
       
       
-        <span class='name'>z</span>
+        <span class='type'>(<tt>Boolean</tt>)</span>
       
       
       

data/spec/templates/examples/method005.html

@@ -60,10 +60,10 @@
   
     <li>
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='name'>b</span>
       
       
-        <span class='name'>b</span>
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       

data/spec/templates/examples/module001.dot

@@ -29,3 +29,5 @@ subgraph cluster_A_Z {
 }
 
   A -> B [style=dotted arrowType=none];
+
+  A -> BaseMod [style=dotted arrowType=none];

data/spec/templates/examples/module001.html

@@ -1,4 +1,5 @@
-<h1>Module: A 
+<h1>Module: A
+  
   
   
 </h1>
@@ -10,7 +11,7 @@
   
     
       <dt class="r1">Includes:</dt>
-      <dd class="r1">B</dd>
+      <dd class="r1">B, BaseMod</dd>
       
     
   
@@ -87,6 +88,10 @@ and newlines.
   
   
   
+  
+  
+  
+  
   <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
   <ul class="summary">
     
@@ -106,6 +111,7 @@ and newlines.
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'>Returns the value of attribute attr1.</div></span>
@@ -129,6 +135,7 @@ and newlines.
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'>Returns the value of attribute attr2.</div></span>
@@ -152,6 +159,7 @@ and newlines.
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'></div></span>
@@ -175,6 +183,7 @@ and newlines.
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'>Sets the attribute attr4.</div></span>
@@ -185,8 +194,24 @@ and newlines.
   </ul>
 
 
+
+  
+  
+  
+  
+  
+  
+  
+  
+  <h3 class="inherited">Attributes included from BaseMod</h3>
+  <p class="inherited">base_attr1, base_attr2, base_attr3</p>
+
+
   
-    <h2>Class Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+    <h2>
+      Class Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
 
     <ul class="summary">
       
@@ -203,6 +228,7 @@ and newlines.
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'></div></span>
@@ -212,7 +238,10 @@ and newlines.
       
     </ul>
   
-    <h2>Instance Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
 
     <ul class="summary">
       
@@ -231,6 +260,7 @@ and newlines.
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'></div></span>
@@ -251,6 +281,7 @@ and newlines.
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'></div></span>
@@ -271,6 +302,7 @@ and newlines.
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'>hello2.</div></span>
@@ -291,6 +323,7 @@ and newlines.
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'></div></span>
@@ -312,6 +345,11 @@ and newlines.
   <h3 class="inherited">Methods included from B</h3>
   <p class="inherited">#c, #d</p>
 
+  
+  
+  
+  
+  
   <div id="instance_attr_details" class="attr_details">
     <h2>Instance Attribute Details</h2>
     
@@ -339,12 +377,12 @@ and newlines.
       <pre class="lines">
 
 
-10
-11
-12</pre>
+17
+18
+19</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 10</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 17</span>
 
 def attr1
   @attr1
@@ -378,12 +416,12 @@ end</pre>
       <pre class="lines">
 
 
-11
-12
-13</pre>
+18
+19
+20</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 11</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 18</span>
 
 def attr2
   @attr2
@@ -433,8 +471,8 @@ end</pre>
   
     <li>
       
-        <span class='type'>(<tt>String</tt>)</span>
       
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
@@ -463,10 +501,10 @@ end</pre>
   
     <li>
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='name'>value</span>
       
       
-        <span class='name'>value</span>
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
@@ -488,12 +526,12 @@ end</pre>
       <pre class="lines">
 
 
-18
-19
-20</pre>
+25
+26
+27</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 18</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 25</span>
 
 def attr3
   @attr3
@@ -525,10 +563,10 @@ end</pre>
   
     <li>
       
-        <span class='type'></span>
+        <span class='name'>value</span>
       
       
-        <span class='name'>value</span>
+        <span class='type'></span>
       
       
       
@@ -545,12 +583,12 @@ end</pre>
       <pre class="lines">
 
 
-20
-21
-22</pre>
+27
+28
+29</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 20</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 27</span>
 
 def attr4=(value)
   @attr4 = value
@@ -580,10 +618,10 @@ end</pre>
       <pre class="lines">
 
 
-22</pre>
+29</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 22</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 29</span>
 
 def self.a; end</pre>
     </td>
@@ -614,10 +652,10 @@ def self.a; end</pre>
       <pre class="lines">
 
 
-23</pre>
+30</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 23</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 30</span>
 
 def a; end</pre>
     </td>
@@ -650,10 +688,10 @@ def a; end</pre>
       <pre class="lines">
 
 
-33</pre>
+40</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 33</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 40</span>
 
 def test_multi_overload(*args) end</pre>
     </td>
@@ -688,10 +726,10 @@ def test_multi_overload(*args) end</pre>
   
     <li>
       
-        <span class='type'>(<tt>String</tt>)</span>
+        <span class='name'>a</span>
       
       
-        <span class='name'>a</span>
+        <span class='type'>(<tt>String</tt>)</span>
       
       
       
@@ -710,10 +748,10 @@ def test_multi_overload(*args) end</pre>
       <pre class="lines">
 
 
-29</pre>
+36</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 29</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 36</span>
 
 def test_overload(*args) end</pre>
     </td>
@@ -742,10 +780,10 @@ def test_overload(*args) end</pre>
       <pre class="lines">
 
 
-36</pre>
+43</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '(stdin)', line 36</span>
+      <pre class="code"><span class="info file"># File '(stdin)', line 43</span>
 
 def void_meth; end</pre>
     </td>
@@ -754,3 +792,4 @@ def void_meth; end</pre>
 </div>
     
   </div>
+