yard 0.2.3.5 → 0.4.0

data/spec/rake/yardoc_task_spec.rb

@@ -2,6 +2,8 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe YARD::Rake::YardocTask do
   before do
+    @yardoc = mock(:cli)
+    YARD::CLI::Yardoc.stub!(:new).and_return(@yardoc)
     Rake.application.clear
   end
   
@@ -9,40 +11,75 @@ describe YARD::Rake::YardocTask do
     Rake.application.tasks[0].invoke
   end
   
-  it "should allow separate rake task name to be set" do
-    YARD::Rake::YardocTask.new(:notyardoc)
-    Rake.application.tasks[0].name.should == "notyardoc"
+  describe '#initialize' do
+    it "should allow separate rake task name to be set" do
+      YARD::Rake::YardocTask.new(:notyardoc)
+      Rake.application.tasks[0].name.should == "notyardoc"
+    end
   end
   
-  it "should allow files to be set" do
-    YARD::CLI::Yardoc.should_receive(:run).with('a', 'b', 'c')
-    YARD::Rake::YardocTask.new do |t|
-      t.files = ['a', 'b', 'c']
+  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
     end
-    run
   end
   
-  it "should allow extra options to be set" do
-    YARD::CLI::Yardoc.should_receive(:run).with('--extra', '--opts')
-    YARD::Rake::YardocTask.new do |t|
-      t.options = ['--extra', '--opts']
+  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']
+      end
+      run
     end
-    run
   end
   
-  it "should allow before callback" do
-    proc = lambda { }
-    proc.should_receive(:call)
-    YARD::CLI::Yardoc.should_receive(:run)
-    YARD::Rake::YardocTask.new {|t| t.before = proc }
-    run
+  describe '#before' do
+    it "should allow before callback" do
+      proc = lambda { }
+      proc.should_receive(:call)
+      @yardoc.should_receive(:run)
+      YARD::Rake::YardocTask.new {|t| t.before = proc }
+      run
+    end
   end
   
-  it "should allow after callback" do
-    proc = lambda { }
-    proc.should_receive(:call)
-    YARD::CLI::Yardoc.should_receive(:run)
-    YARD::Rake::YardocTask.new {|t| t.after = proc }
-    run
+  describe '#after' do
+    it "should allow after callback" do
+      proc = lambda { }
+      proc.should_receive(:call)
+      @yardoc.should_receive(:run)
+      YARD::Rake::YardocTask.new {|t| t.after = proc }
+      run
+    end
+    
+    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 }
+        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)
+        YARD::Rake::YardocTask.new do |t| 
+          t.options += ['--query', '@return']
+          t.verifier = proc
+        end
+        run
+      end
+    end
   end
 end

data/spec/serializers/file_system_serializer_spec.rb

@@ -38,7 +38,7 @@ describe YARD::Serializers::FileSystemSerializer do
       'foo/FooBar/baz_i.txt' => meth2,
       'foo/FooBar.txt' => yard }.each do |path, obj|
       io = StringIO.new
-      File.should_receive(:open).with(path, 'w').and_yield(io)
+      File.should_receive(:open).with(path, 'wb').and_yield(io)
       io.should_receive(:write).with("data")
     
       s = Serializers::FileSystemSerializer.new(:basepath => 'foo', :extension => 'txt')

data/spec/templates/class_spec.rb

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe YARD::Templates::Engine.template(:default, :docstring) do
+  before do
+    YARD.parse_string <<-'eof'
+      private
+      # Comments
+      # @abstract override this class
+      # @author Test
+      # @version 1.0
+      # @see A
+      # @see http://example.com Example
+      class A < B
+        # HI
+        def method_missing(*args) end
+        # @deprecated
+        def a; end
+        
+        # constructor method!
+        def initialize(test) end
+      end
+      
+      class C < A; end
+    eof
+  end
+  
+  it "should render html format correctly" do
+    html_equals(Registry.at('A').format(:format => :html, :no_highlight => true), :class001)
+  end
+  
+  it "should render text format correctly" do
+    text_equals(Registry.at('A').format, :class001)
+  end
+end

data/spec/templates/engine_spec.rb

@@ -0,0 +1,121 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe YARD::Templates::Engine do
+  describe '.register_template_path' do
+    it "should register a String path" do
+      Engine.register_template_path('.')
+      Engine.template_paths.pop.should == '.'
+    end
+  end
+  
+  describe '.template!' do
+    it "should create a module including Template" do
+      mod = Engine.template!('path/to/template')
+      mod.should include(Template)
+      mod.full_path.to_s.should == 'path/to/template'
+    end
+    
+    it "should create a module including Template with full_path" do
+      mod = Engine.template!('path/to/template2', '/full/path/to/template2')
+      mod.should include(Template)
+      mod.full_path.to_s.should == '/full/path/to/template2'
+    end
+  end
+  
+  describe '.template' do
+    it "should raise an error if the template is not found" do
+      lambda { Engine.template(:a, :b, :c) }.should raise_error(ArgumentError)
+    end
+    
+    it "should create a module including Template" do
+      mock = mock(:template)
+      Engine.should_receive(:find_template_paths).with(nil, 'template/name').and_return(['/full/path/template/name'])
+      Engine.should_receive(:template!).with('template/name', ['/full/path/template/name']).and_return(mock)
+      Engine.template('template/name').should == mock
+    end
+    
+    it "should create a Template from a relative Template path" do
+      Engine.should_receive(:template_paths).and_return([])
+      File.should_receive(:directory?).with("/full/path/template/notname").and_return(true)
+      start_template = mock(:start_template)
+      start_template.stub!(:full_path).and_return('/full/path/template/name')
+      start_template.stub!(:full_paths).and_return(['/full/path/template/name'])
+      start_template.should_receive(:is_a?).with(Template).and_return(true)
+      mod = Engine.template(start_template, '..', 'notname')
+      mod.should include(Template)
+      mod.full_path.to_s.should == "/full/path/template/notname"
+    end
+
+    it "should create a Template including other matching templates in path" do
+      paths = ['/full/path/template/name', '/full/path2/template/name']
+      Engine.should_receive(:find_template_paths).with(nil, 'template/name').and_return(paths)
+      ancestors = Engine.template('template/name').ancestors.map {|m| m.class_name }
+      ancestors.should include("Template__full_path2_template_name")
+    end
+    
+    it "should include parent directories before other template paths" do
+      paths = ['/full/path/template/name', '/full/path2/template/name']
+      Engine.should_receive(:find_template_paths).with(nil, 'template/name').and_return(paths)
+      ancestors = Engine.template('template/name').ancestors.map {|m| m.class_name }
+      ancestors[0, 4].should == ["Template__full_path_template_name", "Template__full_path_template", 
+        "Template__full_path2_template_name", "Template__full_path2_template"]
+    end
+  end
+  
+  describe '.generate' do
+    it "should generate with fulldoc template" do
+      mod = mock(:template)
+      mod.should_receive(:run).with(:format => :text, :template => :default, :objects => [:a, :b, :c])
+      Engine.should_receive(:template).with(:default, :fulldoc, :text).and_return(mod)
+      Engine.generate([:a, :b, :c])
+    end
+  end
+  
+  describe '.render' do
+    def loads_template(*args)
+      Engine.should_receive(:template).with(*args).and_return(@template)
+    end
+  
+    before(:all) do 
+      @template = mock(:template)
+      @template.stub!(:include)
+      @object = CodeObjects::MethodObject.new(:root, :method)
+    end
+  
+    it "should accept method call with no parameters" do
+      loads_template(:default, :method, :text)
+      @template.should_receive(:run).with :type => :method,
+                                          :template => :default,
+                                          :format => :text,
+                                          :object => @object
+      @object.format
+    end
+  
+    it "should allow template key to be changed" do
+      loads_template(:javadoc, :method, :text)
+      @template.should_receive(:run).with :type => :method,
+                                          :template => :javadoc,
+                                          :format => :text,
+                                          :object => @object
+      @object.format(:template => :javadoc)
+    end
+
+    it "should allow type key to be changed" do
+      loads_template(:default, :fulldoc, :text)
+      @template.should_receive(:run).with :type => :fulldoc,
+                                          :template => :default,
+                                          :format => :text,
+                                          :object => @object
+      @object.format(:type => :fulldoc)
+    end
+  
+    it "should allow format key to be changed" do
+      loads_template(:default, :method, :html)
+      @template.should_receive(:run).with :type => :method,
+                                          :template => :default,
+                                          :format => :html,
+                                          :object => @object
+      @object.format(:format => :html)
+    end
+  end
+end

data/spec/templates/examples/class001.html

@@ -0,0 +1,271 @@
+<h1>Class: A 
+  <span class="abstract note title">Abstract</span>
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName">B</span>
+      
+        <ul class="fullTree">
+          <li>Object</li>
+          
+            <li class="next">B</li>
+          
+            <li class="next">A</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+  
+  
+    <dt class="r2 last">Defined in:</dt>
+    <dd class="r2 last">(stdin)</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    <p class="note abstract">
+  <strong>This class is abstract.</strong> 
+  override this class
+</p>
+Comments
+
+  </div>
+</div>
+<div class="tags">
+  
+  <h3>See Also:</h3>
+  <ul class="see">
+    
+      <li>A</li>
+    
+      <li><a href="http://example.com" title="Example">Example</a></li>
+    
+  </ul>
+<h3>Author:</h3>
+<ul class="author">
+  
+    <li>
+      
+      
+      
+      
+        
+        Test
+      
+    </li>
+  
+</ul>
+<h3>Version:</h3>
+<ul class="version">
+  
+    <li>
+      
+      
+      
+      
+        
+        1.0
+      
+    </li>
+  
+</ul>
+
+</div>
+
+  
+
+  <h2>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>
+  
+  
+  
+  <span class="deprecated note title">Deprecated</span>
+
+  
+    <span class="summary_desc"><strong>Deprecated.</strong> </span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature"><a  title="#initialize (instance method)">- (A) <strong>initialize</strong>(test) </a>
+  
+  </span>
+  
+  
+  
+  
+
+  
+    <span class="summary_desc">constructor method!.</span>
+  
+</li>
+
+    
+      <li class="public ">
+  <span class="summary_signature"><a  title="#method_missing (instance method)">- (Object) <strong>method_missing</strong>(*args) </a>
+  
+  </span>
+  
+  
+  
+  
+
+  
+    <span class="summary_desc">HI.</span>
+  
+</li>
+
+    
+  </ul>
+
+
+  <div id="constructor_details">
+  <h2>Constructor Details</h2>
+  
+    <div class="method_details first">
+  <p class="signature first" id="initialize-instance_method">
+  
+    - (<tt>A</tt>) <strong>initialize</strong>(test) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    constructor method!
+
+  </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>
+      <pre class="lines">
+
+
+15</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File '(stdin)', line 15</span>
+
+def initialize(test) end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+<div id="method_missing_details">
+  <h2>Dynamic Method Handling</h2>
+  <p class="notice this">
+    This class handles dynamic methods through the <tt>method_missing</tt> method
+    
+  </p>
+  
+    <div class="method_details first">
+  <p class="signature first" id="method_missing-instance_method">
+  
+    - (<tt>Object</tt>) <strong>method_missing</strong>(*args) 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    HI
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><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 method_missing(*args) end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+  
+</div>
+
+
+  <div id="method_details">
+    <h2>Method Details</h2>
+    
+      <div class="method_details first">
+  <p class="signature first" id="a-instance_method">
+  
+    - (<tt>Object</tt>) <strong>a</strong> 
+  
+
+  
+</p><div class="docstring">
+  <div class="discussion">
+    <p class="note deprecated"><strong>Deprecated.</strong> </p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+</div><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 a; end</pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>