yard 0.5.3 → 0.5.4

data/lib/yard/templates/helpers/method_helper.rb

@@ -3,8 +3,16 @@ module YARD
     module MethodHelper
       def format_args(object)
         return if object.parameters.nil?
-        unless object.parameters.empty?
-          args = object.parameters.map {|n, v| v ? "#{n} = #{v}" : n.to_s }.join(", ")
+        params = object.parameters
+        if object.has_tag?(:yield) || object.has_tag?(:yieldparam)
+          params.reject! do |param|
+            param[0][0,1] == "&" && 
+              !object.tags(:param).any? {|t| t.name == param[0][1..-1] }
+          end
+        end
+        
+        unless params.empty?
+          args = params.map {|n, v| v ? "#{n} = #{v}" : n.to_s }.join(", ")
           h("(#{args})")
         else
           ""

data/lib/yard/templates/template.rb

@@ -18,6 +18,7 @@ module YARD
       
       self.extra_includes = []
       
+      include ErbCache
       include Helpers::BaseHelper
       include Helpers::MethodHelper
 
@@ -109,7 +110,7 @@ module YARD
         end
         
         def include_inherited(full_paths)
-          full_paths.each do |full_path|
+          full_paths.reverse.each do |full_path|
             include Engine.template!(path, full_path)
           end
         end
@@ -226,8 +227,10 @@ module YARD
       # @yield calls subsections to be rendered
       # @return [String] the contents of the ERB rendered section
       def erb(section, &block)
-        erb = erb_with(cache(section), cache_filename(section))
-        erb.result(binding, &block)
+        method_name = ErbCache.method_for(cache_filename(section)) do
+          erb_with(cache(section), cache_filename(section))
+        end
+        send(method_name, &block)
       end
       
       # Returns the contents of a file. If +allow_inherited+ is set to +true+,
@@ -271,8 +274,8 @@ module YARD
       def superb(section = section, &block)
         filename = self.class.find_nth_file(erb_file_for(section), 2)
         return "" unless filename
-        erb = erb_with(IO.read(filename), filename)
-        erb.result(binding, &block)
+        method_name = ErbCache.method_for(filename) { erb_with(IO.read(filename), filename) }
+        send(method_name, &block)
       end
       
       def options=(value)
@@ -319,14 +322,15 @@ module YARD
         content = @cache[section.to_sym]
         return content if content
       
-        file = self.class.find_file(erb_file_for(section))
+        file = cache_filename(section)
         @cache_filename[section.to_sym] = file
         raise ArgumentError, "no template for section '#{section}' in #{self.class.path}" unless file
         @cache[section.to_sym] = IO.read(file)
       end
       
       def cache_filename(section)
-        @cache_filename[section.to_sym]
+        @cache_filename[section.to_sym] ||=
+          self.class.find_file(erb_file_for(section))
       end
       
       def set_ivars

data/spec/code_objects/class_object_spec.rb

@@ -23,7 +23,7 @@ describe YARD::CodeObjects::ClassObject do
     end
 
     it "should show proper inheritance tree when mixins are included" do
-      @yard.inheritance_tree(true).should == [@yard, @mixin, @superyard, @mixin2, @mixin3, P(:String)]
+      @yard.inheritance_tree(true).should == [@yard, @mixin, @superyard, @mixin4, @mixin2, @mixin3, P(:String)]
     end
 
     it "should not modify the object's mixin list when mixins are included" do
@@ -34,6 +34,13 @@ describe YARD::CodeObjects::ClassObject do
       @class2.inheritance_tree(true)
       @class2.mixins.should == []
     end
+    
+    it "should list class mixins in inheritance tree" do
+      mod = ModuleObject.new(:root, :ClassMethods)
+      klass = ClassObject.new(:root, :ReceivingClass)
+      klass.class_mixins << mod
+      klass.inheritance_tree(true).should == [klass, mod]
+    end
   end
 
   describe "#meths / #inherited_meths" do

data/spec/code_objects/module_object_spec.rb

@@ -128,6 +128,13 @@ describe YARD::CodeObjects::ModuleObject do
     it "should not list inheritance tree of proxy objects in inheritance tree" do
       @proxy.should_not_receive(:inheritance_tree)
       @mod5.instance_mixins.should == [@proxy]
-    end  
+    end
+    
+    it "should list class mixins in inheritance tree" do
+      mod = ModuleObject.new(:root, :ClassMethods)
+      recvmod = ModuleObject.new(:root, :ReceivingModule)
+      recvmod.class_mixins << mod
+      recvmod.inheritance_tree(true).should == [recvmod, mod]
+    end
   end
 end

data/spec/core_ext/file_spec.rb

@@ -41,9 +41,13 @@ describe File do
       File.cleanpath('A/B/C/D/..').should == "A/B/C"
     end
     
-    it "should not pass the initial directory" do
+    it "should pass the initial directory" do
       File.cleanpath('C/../../D').should == "../D"
     end
+    
+    it "should not remove multiple '../' at the beginning" do
+      File.cleanpath('../../A/B').should == '../../A/B'
+    end
   end
   
   describe '.open!' do

data/spec/docstring_spec.rb

@@ -4,51 +4,9 @@ describe YARD::Docstring do
   before { YARD::Registry.clear }
   
   describe '#initialize' do
-    it "should parse comments into tags" do
-      doc = Docstring.new(<<-eof)
-        @param name Hello world
-          how are you?
-        @param name2 
-          this is a new line
-        @param name3 and this
-          is a new paragraph:
-
-          right here.
-      eof
-      doc.tags("param").each do |tag|
-        if tag.name == "name"
-          tag.text.should == "Hello world how are you?"
-        elsif tag.name == "name2"
-          tag.text.should == "this is a new line"
-        elsif tag.name == "name3"
-          tag.text.should == "and this is a new paragraph:\n\nright here."
-        end
-      end
-    end
-  
     it "should handle docstrings with empty newlines" do
       Docstring.new("\n\n").should == ""
     end
-
-    it "should only parse tags with charset [A-Za-z_]" do
-      doc = Docstring.new
-      valid = %w( @testing @valid @is_a @is_A @__ )
-      invalid = %w( @ @return@ @param, @x.y @x-y )
-
-      log.enter_level(Logger::FATAL) do
-        {valid => 1, invalid => 0}.each do |tags, size|
-          tags.each do |tag|
-            class << doc
-              def create_tag(tag_name, *args)
-                add_tag Tags::Tag.new(tag_name, *args)
-              end
-            end
-            doc.all = tag
-            doc.tags(tag[1..-1]).size.should == size
-          end
-        end
-      end
-    end
   end
   
   describe '#summary' do
@@ -187,4 +145,84 @@ describe YARD::Docstring do
       d.should_not be_blank
     end
   end
+  
+  describe '#add_tag' do
+    it "should only parse tags with charset [A-Za-z_]" do
+      doc = Docstring.new
+      valid = %w( @testing @valid @is_a @is_A @__ )
+      invalid = %w( @ @return@ @param, @x.y @x-y )
+
+      log.enter_level(Logger::FATAL) do
+        {valid => 1, invalid => 0}.each do |tags, size|
+          tags.each do |tag|
+            class << doc
+              def create_tag(tag_name, *args)
+                add_tag Tags::Tag.new(tag_name, *args)
+              end
+            end
+            doc.all = tag
+            doc.tags(tag[1..-1]).size.should == size
+          end
+        end
+      end
+    end
+  end
+  
+  describe '#parse_comments' do
+    it "should parse comments into tags" do
+      doc = Docstring.new(<<-eof)
+@param name Hello world
+  how are you?
+@param name2 
+  this is a new line
+@param name3 and this
+  is a new paragraph:
+
+  right here.
+      eof
+      tags = doc.tags(:param)
+      tags[0].name.should == "name"
+      tags[0].text.should == "Hello world\nhow are you?"
+      tags[1].name.should == "name2"
+      tags[1].text.should == "this is a new line"
+      tags[2].name.should == "name3"
+      tags[2].text.should == "and this\nis a new paragraph:\n\nright here."
+    end
+
+    it "should end parsing a tag on de-dent" do
+      doc = Docstring.new(<<-eof)
+@note test
+  one two three
+rest of docstring
+      eof
+      doc.tag(:note).text.should == "test\none two three"
+      doc.should == "rest of docstring"
+    end
+    
+    it "should parse examples embedded in doc" do
+      doc = Docstring.new(<<-eof)
+test string here
+@example code
+  
+  def foo(x, y, z)
+  end
+  
+  class A; end
+
+more stuff
+eof
+      doc.should == "test string here\nmore stuff"
+      doc.tag(:example).text.should == "\ndef foo(x, y, z)\nend\n\nclass A; end"
+    end
+    
+    it "should remove only original indentation from beginning of line in tags" do
+      doc = Docstring.new(<<-eof)
+@param name
+  some value
+  foo bar
+   baz
+eof
+      doc.tag(:param).text.should == "some value\nfoo bar\n baz"
+    end
+  end
 end

data/spec/handlers/class_condition_handler_spec.rb

@@ -8,10 +8,6 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassConditionHandler
     names.each {|name| Registry.at("A##{name}not").should be_nil }
   end
   
-  it "should parse all if/elsif blocks for complex conditions" do
-    verify_method :a, :b, :c, :d
-  end
-  
   it "should parse all unless blocks for complex conditions" do
     verify_method :g
   end
@@ -24,17 +20,9 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassConditionHandler
     verify_method :p
   end
   
-  it "should only parse else block if condition is literal value `false`" do
-    verify_method :q
-  end
-
   it "should only parse then block if condition is literal integer != 0" do
     verify_method :o
   end
-
-  it "should only parse else block if condition is literal integer == 0" do
-    verify_method :n
-  end
   
   it "should invert block to parse for literal condition if it's an unless block" do
     verify_method :e
@@ -43,4 +31,18 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ClassConditionHandler
   it "should handle conditions such as 'defined? VALUE'" do
     verify_method :j, :k
   end
-end if RUBY19
+  
+  if RUBY19
+    it "should parse all if/elsif blocks for complex conditions" do
+      verify_method :a, :b, :c, :d
+    end
+
+    it "should only parse else block if condition is literal value `false`" do
+      verify_method :q
+    end
+
+    it "should only parse else block if condition is literal integer == 0" do
+      verify_method :n
+    end
+  end
+end

data/spec/handlers/examples/process_handler_001.rb.txt

@@ -0,0 +1,11 @@
+class A < NotHandler
+  process { hello }
+end
+
+class B < YARD::Handlers::Ruby::Base
+  process { test }
+end
+
+class C < YARD::Handlers::Ruby::Legacy::Base
+  process do test end
+end

data/spec/handlers/process_handler_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}ProcessHandler" do
+  before(:all) { parse_file :process_handler_001, __FILE__ }
+
+  it "should only work for classes that extend YARD::Handlers::*" do
+    Registry.at('A#process').should be_nil
+  end
+  
+  it "should work for process { }" do
+    Registry.at('B#process').should_not be_nil
+  end
+  
+  it "should work for process do ... end" do
+    Registry.at('C#process').should_not be_nil
+  end
+end

data/spec/parser/source_parser_spec.rb

@@ -57,6 +57,17 @@ describe YARD::Parser::SourceParser do
       Registry.at(:Hello2).docstring.should == "PASS"
       Registry.at('Hello2#x').docstring.should == "ANOTHER PASS"
     end
+    
+    it "should handle =begin/=end style comments" do
+      YARD.parse_string "=begin\nfoo\nbar\n=end\nclass Foo; end\n"
+      Registry.at(:Foo).docstring.should == "foo\nbar"
+
+      YARD.parse_string "=begin\n\nfoo\nbar\n=end\nclass Foo; end\n"
+      Registry.at(:Foo).docstring.should == "foo\nbar"
+
+      YARD.parse_string "=begin\nfoo\n\nbar\n=end\nclass Foo; end\n"
+      Registry.at(:Foo).docstring.should == "foo\n\nbar"
+    end
   end
 
   describe '#parse' do

data/spec/tags/overload_tag_spec.rb

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 describe YARD::Tags::OverloadTag do
   before do
-    @tag = Tags::OverloadTag.new(:overload, nil, <<-'eof')
+    @tag = Tags::OverloadTag.new(:overload, <<-'eof')
       def bar(a, b = 1, &block)
         Hello world
         @param a [String]
@@ -47,7 +47,7 @@ describe YARD::Tags::OverloadTag do
   end
 
   it "should not parse 'def' out of method name" do
-    tag = Tags::OverloadTag.new(:overload, nil, "default")
+    tag = Tags::OverloadTag.new(:overload, "default")
     tag.signature.should == "default"
   end
 end

data/spec/templates/class_spec.rb

@@ -21,6 +21,11 @@ describe YARD::Templates::Engine.template(:default, :docstring) do
       end
       
       class C < A; end
+      
+      class D
+        # @private
+        def initialize; end
+      end
     eof
   end
   
@@ -31,4 +36,8 @@ describe YARD::Templates::Engine.template(:default, :docstring) do
   it "should render text format correctly" do
     text_equals(Registry.at('A').format, :class001)
   end
+
+  it "should hide private constructors" do
+    html_equals(Registry.at('D').format(:format => :html, :no_highlight => true, :verifier => Verifier.new("!@private")), :class002)
+  end
 end

data/spec/templates/examples/class001.html

@@ -38,7 +38,7 @@
   <div class="discussion">
     <p class="note abstract">
   <strong>This class is abstract.</strong> 
-  override this class
+  <div class='inline'>override this class</div>
 </p>
 Comments
 
@@ -63,7 +63,7 @@ Comments
       
       
         
-        Test
+        <div class='inline'>Test</div>
       
     </li>
   
@@ -77,7 +77,7 @@ Comments
       
       
         
-        1.0
+        <div class='inline'>1.0</div>
       
     </li>
   
@@ -91,11 +91,12 @@ Comments
 
   
 
-  <h2>Instance Method Summary</h2>
+  
+    <h2>Instance Method Summary</h2>
 
-  <ul class="summary">
-    
-      <li class="public deprecated">
+    <ul class="summary">
+      
+        <li class="public deprecated">
   <span class="summary_signature">
     
       <a  title="#a (instance method)">- <strong>a</strong> </a>
@@ -110,12 +111,12 @@ Comments
   <span class="deprecated note title">Deprecated</span>
 
   
-    <span class="summary_desc"><strong>Deprecated.</strong> </span>
+    <span class="summary_desc"><strong>Deprecated.</strong> <div class='inline'></div></span>
   
 </li>
 
-    
-      <li class="public ">
+      
+        <li class="public ">
   <span class="summary_signature">
     
       <a  title="#initialize (instance method)">- (A) <strong>initialize</strong>(test) </a>
@@ -132,12 +133,12 @@ Comments
   
 
   
-    <span class="summary_desc">constructor method!.</span>
+    <span class="summary_desc"><div class='inline'>constructor method!.</div></span>
   
 </li>
 
-    
-      <li class="public ">
+      
+        <li class="public ">
   <span class="summary_signature">
     
       <a  title="#method_missing (instance method)">- <strong>method_missing</strong>(*args) </a>
@@ -152,12 +153,14 @@ Comments
   
 
   
-    <span class="summary_desc">HI.</span>
+    <span class="summary_desc"><div class='inline'>HI.</div></span>
   
 </li>
 
-    
-  </ul>
+      
+    </ul>
+  
+
 
   <div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
@@ -250,7 +253,7 @@ def method_missing(*args) end</pre>
   
 </p><div class="docstring">
   <div class="discussion">
-    <p class="note deprecated"><strong>Deprecated.</strong> </p>
+    <p class="note deprecated"><strong>Deprecated.</strong> <div class='inline'></div></p>
 
 
   </div>