yard 0.8.1 → 0.8.2

data/spec/rubygems/doc_manager_spec.rb

@@ -0,0 +1,112 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require File.join(YARD::ROOT, 'rubygems_plugin')
+require 'fileutils'
+
+describe Gem::DocManager do
+  before do
+    # Ensure filesystem integrity
+    FileUtils.stub(:mkdir_p)
+    FileUtils.stub(:rm_rf)
+    Dir.stub(:chdir)
+
+    YARD::CLI::Yardoc.stub(:run)
+
+    @spec_file = File.join(YARD::ROOT, '../yard.gemspec')
+    @spec = Gem::SourceIndex.load_specification(@spec_file)
+    @spec.has_yardoc = false # no yardoc docs for now
+    @yardopts = File.join(@spec.full_gem_path, '.yardopts')
+    @doc = Gem::DocManager.new(@spec)
+    @doc.stub(:install_ri_yard_orig)
+    @doc.stub(:install_rdoc_yard_orig)
+  end
+
+  def runs; YARD::CLI::Yardoc.should_receive(:run) end
+
+  describe '.load_yardoc' do
+    it "should properly load YARD" do
+      Gem::DocManager.should_receive(:require) do |path|
+        File.expand_path(path).should == YARD::ROOT + '/yard'
+      end
+      Gem::DocManager.load_yardoc
+    end
+  end
+
+  describe '#install_ri_yard' do
+    def install
+      msg = "Building YARD (yri) index for #{@spec.full_name}..."
+      @doc.should_receive(:say).with(msg)
+      @doc.install_ri_yard
+    end
+
+    it "should pass --quiet to all documentation" do
+      runs.with('-c', '-n', '--quiet', 'lib')
+      install
+    end
+
+    it "should pass extra_rdoc_files to documentation" do
+      @spec.extra_rdoc_files = %w(README LICENSE)
+      runs.with('-c', '-n', '--quiet', 'lib', '-', 'README', 'LICENSE')
+      install
+    end
+
+    it "should add --backtrace if Gem.configuration.backtrace" do
+      Gem.configuration.backtrace = true
+      runs.with('-c', '-n', '--quiet', '--backtrace', 'lib')
+      install
+      Gem.configuration.backtrace = false
+    end
+
+    it "should add require_paths if there is no .yardopts" do
+      File.should_receive(:file?).with(@yardopts).and_return(true)
+      runs.with('-c', '-n', '--quiet')
+      install
+    end
+
+    it "should add extra_rdoc_files if there is no .yardopts" do
+      @spec.extra_rdoc_files = %w(README LICENSE)
+      File.should_receive(:file?).with(@yardopts).and_return(true)
+      runs.with('-c', '-n', '--quiet')
+      install
+    end
+
+    it "should switch to directory before running command" do
+      old = Dir.pwd
+      Dir.should_receive(:chdir).with(@spec.full_gem_path)
+      Dir.should_receive(:chdir).with(old)
+      install
+    end
+
+    it "should ensure that directory is switched back at end of command in failure" do
+      old = Dir.pwd
+      Dir.should_receive(:chdir).with(@spec.full_gem_path)
+      Dir.should_receive(:chdir).with(old)
+      @doc.ui.errs.should_receive(:puts).with(/ERROR:\s*While generating documentation/)
+      @doc.ui.errs.should_receive(:puts).with(/MESSAGE:\s*foo/)
+      @doc.ui.errs.should_receive(:puts).with(/YARDOC args:\s*-c -n --quiet lib/)
+      @doc.ui.errs.should_receive(:puts).with("(continuing with the rest of the installation)")
+      YARD::CLI::Yardoc.should_receive(:run).and_raise(RuntimeError.new("foo"))
+      install
+    end
+
+    it "should handle permission errors" do
+      YARD::CLI::Yardoc.should_receive(:run).and_raise(Errno::EACCES.new("- dir"))
+      lambda { install }.should raise_error(Gem::FilePermissionError)
+    end
+  end
+
+  describe '#install_rdoc_yard' do
+    def install
+      msg = "Installing YARD documentation for #{@spec.full_name}..."
+      @doc.should_receive(:say).with(msg)
+      @doc.install_rdoc_yard
+    end
+
+    it "should add -o outdir when generating docs" do
+      File.should_receive(:file?).with(@yardopts).and_return(true)
+      @spec.has_yardoc = true
+      doc_dir = File.join(@doc.instance_variable_get("@doc_dir"), 'rdoc')
+      runs.with('-o', doc_dir, '--quiet')
+      install
+    end
+  end
+end

data/spec/tags/default_factory_spec.rb

@@ -26,8 +26,14 @@ describe YARD::Tags::DefaultFactory do
       parse_types('[#foo]').should == [nil, ['#foo'], '']
     end
 
-    it "should handle ducktypes with special method names" do
-      parse_types('[#foo=]').should == [nil, ['#foo='], '']
+    %w(#foo= #<< #<=> #>> #== #=== Array<#<=>> Array<#==>).each do |meth|
+      it "should handle ducktypes with special method name #{meth}" do
+        parse_types("[#{meth}]").should == [nil, [meth], '']
+      end
+    end
+
+    it "should only parse #ducktypes inside brackets" do
+      parse_types("#ducktype").should == [nil, nil, '#ducktype']
     end
 
     it "should return the text before and after the type list" do

data/spec/tags/directives_spec.rb

@@ -239,6 +239,13 @@ describe YARD::Tags::MethodDirective do
       end
     end
 
+    it "should define parameters from signature" do
+      YARD.parse_string <<-eof
+        # @!method foo(a, b, c = nil)
+      eof
+      Registry.at('#foo').parameters.should == [[:a, nil], [:b, nil], [:c, 'nil']]
+    end
+
     it "should be able to define method with module scope (module function)" do
       YARD.parse_string <<-eof
         # @!method foo

data/spec/templates/examples/module001.html

@@ -355,7 +355,6 @@ and newlines.
 
 
       <span id="attr1=-instance_method"></span>
-      <span id="attr1-instance_method"></span>
       <div class="method_details first">
   <h3 class="signature first" id="attr1-instance_method">
 
@@ -394,7 +393,6 @@ end</pre>
 
 
       <span id=""></span>
-      <span id="attr2-instance_method"></span>
       <div class="method_details ">
   <h3 class="signature " id="attr2-instance_method">
 
@@ -433,7 +431,6 @@ end</pre>
 
 
       <span id="attr3=-instance_method"></span>
-      <span id="attr3-instance_method"></span>
       <div class="method_details ">
   <h3 class="signature " id="attr3-instance_method">
 
@@ -542,7 +539,6 @@ end</pre>
 </div>
 
 
-      <span id="attr4=-instance_method"></span>
       <span id=""></span>
       <div class="method_details ">
   <h3 class="signature " id="attr4=-instance_method">

data/spec/templates/examples/module002.html

@@ -170,7 +170,6 @@
 
 
       <span id="foo_attr=-instance_method"></span>
-      <span id="foo_attr-instance_method"></span>
       <div class="method_details first">
   <h3 class="signature first" id="foo_attr-instance_method">
 

data/spec/templates/examples/module003.html

@@ -114,7 +114,6 @@
 
 
       <span id=""></span>
-      <span id="bar-instance_method"></span>
       <div class="method_details first">
   <h3 class="signature first" id="bar-instance_method">
 

data/spec/templates/examples/module004.html

@@ -1,44 +1,44 @@
 <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>
 
@@ -48,214 +48,213 @@
 
   <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> 
+  
 
-    - <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
@@ -263,32 +262,32 @@
   </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> 
+  
 
-    + <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
@@ -296,43 +295,43 @@
   </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> 
+  
 
-    - <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> 
+  
 
-    - <strong>foo</strong>
-
-
-
-
+  
 
+  
 </h3><div class="docstring">
   <div class="discussion">
     This method is in A
@@ -340,7 +339,7 @@
   </div>
 </div>
 <div class="tags">
-
+  
 
 </div><table class="source_code">
   <tr>
@@ -358,21 +357,21 @@ def foo; end</pre>
   </tr>
 </table>
 </div>
-
+    
       <div class="method_details ">
   <h3 class="signature " id="xyz-instance_method">
+  
+    - <strong>xyz</strong> 
+  
 
-    - <strong>xyz</strong>
-
-
-
-
+  
 
+  
     <span class="not_defined_here">
       Originally defined in module
         Foo
     </span>
-
+  
 </h3><div class="docstring">
   <div class="discussion">
     Docs for xyz
@@ -380,9 +379,9 @@ def foo; end</pre>
   </div>
 </div>
 <div class="tags">
-
+  
 
 </div>
 </div>
-
+    
   </div>