yard 0.5.4 → 0.5.5

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

@@ -74,4 +74,8 @@ end
 
   attr_reader :attr_name2
   def attr_name2=; end
+
+  # @option opts :bar [String] It's bar!
+  def auto_opts(opts)
+  end
 end

data/spec/handlers/method_handler_spec.rb

@@ -115,4 +115,11 @@ describe "YARD::Handlers::Ruby::#{RUBY18 ? "Legacy::" : ""}MethodHandler" do
     Registry.at('Foo#attr_name2').should be_reader
     Registry.at('Foo#attr_name2=').should be_writer
   end
+  
+  it "should generate an options parameter if @option refers to an undocumented parameter" do
+    meth = P('Foo#auto_opts')
+    meth.should have_tag(:param)
+    meth.tag(:param).name.should == "opts"
+    meth.tag(:param).types.should == ["Hash"]
+  end
 end

data/spec/parser/ruby/legacy/statement_list_spec.rb

@@ -256,4 +256,18 @@ eof
     s = stmts("require 'foo'\r\n\r\n# Test Test\r\n# \r\n# Example:\r\n#   example code\r\ndef test\r\nend\r\n")
     s[1].comments.should == ['Test Test', '', 'Example:', '  example code']
   end
+  
+  it "should handle elsif blocks" do
+    s = stmts(stmt("if 0\n  foo\nelsif 2\n  bar\nend\nbaz").block)
+    s.size.should == 2
+    s[1].tokens.to_s.should == "elsif 2"
+    s[1].block.to_s.should == "bar"
+  end
+  
+  it "should handle else blocks" do
+    s = stmts(stmt("if 0\n  foo\nelse\n  bar\nend\nbaz").block)
+    s.size.should == 2
+    s[1].tokens.to_s.should == "else"
+    s[1].block.to_s.should == "bar"
+  end
 end

data/spec/parser/source_parser_spec.rb

@@ -89,6 +89,13 @@ describe YARD::Parser::SourceParser do
       File.should_receive(:read_binary).with('/path/to/file').and_return("")
       YARD.parse('/path/to/file')
     end
+    
+    it "should clean paths before parsing" do
+      File.should_receive(:open).and_return("")
+      parser = Parser::SourceParser.new(:ruby, true)
+      parser.parse('a//b//c')
+      parser.file.should == 'a/b/c'
+    end
 
     it "should parse files with '*' in them as globs and others as absolute paths" do
       Dir.should_receive(:[]).with('*.rb').and_return(['a.rb', 'b.rb'])

data/spec/tags/default_factory_spec.rb

@@ -17,6 +17,7 @@ describe YARD::Tags::DefaultFactory, "extract_types_and_name_from_text" do
   
   it "should return the text before and after the type list" do
     parse_types(' b <String> description').should == ['b', ['String'], 'description']
+    parse_types('b c <String> description (test)').should == [nil, nil, 'b c <String> description (test)']
   end
   
   it "should handle a complex list of types" do

data/spec/templates/examples/class001.html

@@ -36,10 +36,10 @@
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p class="note abstract">
+    <div class="note abstract">
   <strong>This class is abstract.</strong> 
   <div class='inline'>override this class</div>
-</p>
+</div>
 Comments
 
   </div>
@@ -51,7 +51,7 @@ Comments
     
       <li>A</li>
     
-      <li><a href="http://example.com" title="Example">Example</a></li>
+      <li><a href="http://example.com" target="_parent" title="Example">Example</a></li>
     
   </ul>
 <h3>Author:</h3>
@@ -92,7 +92,7 @@ Comments
   
 
   
-    <h2>Instance Method Summary</h2>
+    <h2>Instance Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
 
     <ul class="summary">
       
@@ -253,7 +253,7 @@ def method_missing(*args) end</pre>
   
 </p><div class="docstring">
   <div class="discussion">
-    <p class="note deprecated"><strong>Deprecated.</strong> <div class='inline'></div></p>
+    <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'></div></div>
 
 
   </div>

data/spec/templates/examples/method001.html

@@ -22,7 +22,7 @@
   
 </p><div class="docstring">
   <div class="discussion">
-    <p class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>for great justice</div></p>
+    <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'>for great justice</div></div>
 Comments
 
   </div>

data/spec/templates/examples/module001.html

@@ -68,7 +68,7 @@ and newlines.
         <dt id="cvar-classvariable" class="deprecated">@@cvar =
           <div class="docstring">
   <div class="discussion">
-    <p class="note deprecated"><strong>Deprecated.</strong> <div class='inline'></div></p>
+    <div class="note deprecated"><strong>Deprecated.</strong> <div class='inline'></div></div>
 
 
   </div>
@@ -87,7 +87,7 @@ and newlines.
   
   
   
-  <h2>Instance Attribute Summary</h2>
+  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
   <ul class="summary">
     
       <li class="public ">
@@ -186,7 +186,7 @@ and newlines.
 
 
   
-    <h2>Class Method Summary</h2>
+    <h2>Class Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
 
     <ul class="summary">
       
@@ -212,7 +212,7 @@ and newlines.
       
     </ul>
   
-    <h2>Instance Method Summary</h2>
+    <h2>Instance Method Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
 
     <ul class="summary">
       

data/spec/templates/helpers/base_helper_spec.rb

@@ -63,6 +63,23 @@ describe YARD::Templates::Helpers::BaseHelper do
     end
   end
   
+  describe '#linkify' do
+    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', 'Filename', 'anchor')
+      linkify("file:Filename#anchor")
+    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)'
@@ -122,7 +139,7 @@ describe YARD::Templates::Helpers::BaseHelper do
   
     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)
+      should_receive(:link_url).with(url, nil, {:target => '_parent'})
       linkify url
     end
   end

data/spec/templates/helpers/html_helper_spec.rb

@@ -2,6 +2,7 @@ require File.dirname(__FILE__) + '/../../spec_helper'
 require File.dirname(__FILE__) + "/shared_signature_examples"
 
 describe YARD::Templates::Helpers::HtmlHelper do
+  include YARD::Templates::Helpers::BaseHelper
   include YARD::Templates::Helpers::HtmlHelper
   include YARD::Templates::Helpers::MethodHelper
 
@@ -100,7 +101,7 @@ describe YARD::Templates::Helpers::HtmlHelper do
       htmlify("A\nB", :textile).should_not include("<br")
     end
   end
-
+  
   describe "#link_object" do
     before do
       stub!(:object).and_return(CodeObjects::NamespaceObject.new(nil, :YARD))

data/spec/templates/module_spec.rb

@@ -63,7 +63,10 @@ describe YARD::Templates::Engine.template(:default, :module) do
   end
 
   it "should render html format correctly" do
-    html_equals(Registry.at('A').format(:format => :html, :no_highlight => true, :hide_void_return => true, :visibilities => [:public]), :module001)
+    html_equals(Registry.at('A').format(
+          :format => :html, :no_highlight => true, :hide_void_return => true,
+          :verifier => Verifier.new('object.type != :method || object.visibility == :public')),
+        :module001)
   end
 
   it "should render text format correctly" do
@@ -79,4 +82,4 @@ describe YARD::Templates::Engine.template(:default, :module) do
   it "should render dot format correctly" do
     Registry.at('A').format(:format => :dot, :dependencies => true, :full => true).should == example(:module001, 'dot')
   end
-end
+end

data/templates/default/docstring/html/abstract.erb

@@ -1,4 +1,4 @@
-<p class="note abstract">
+<div class="note abstract">
   <strong>This <%= object.type %> is abstract.</strong> 
   <%= htmlify_line object.tag(:abstract).text %>
-</p>
+</div>

data/templates/default/docstring/html/deprecated.erb

@@ -1 +1 @@
-<p class="note deprecated"><strong>Deprecated.</strong> <%= htmlify_line object.tag(:deprecated).text %></p>
+<div class="note deprecated"><strong>Deprecated.</strong> <%= htmlify_line object.tag(:deprecated).text %></div>

data/templates/default/docstring/html/note.erb

@@ -1,6 +1,6 @@
 <% object.tags(:note).each do |tag| %>
-  <p class="note notetag">
+  <div class="note notetag">
     <strong>Note:</strong> 
     <%= htmlify_line tag.text %>
-  </p>
+  </div>
 <% end %>

data/templates/default/docstring/html/private.erb

@@ -0,0 +1,4 @@
+<p class="note private">
+  <strong>This <%= object.type %> is part of a private API.</strong> 
+  You should avoid using this <%= object.type %> if possible, as it may be removed or be changed in the future.
+</p>

data/templates/default/docstring/html/todo.erb

@@ -1,6 +1,6 @@
 <% object.tags(:todo).each do |tag| %>
-  <p class="note todo">
+  <div class="note todo">
     <strong>TODO:</strong> 
     <%= htmlify_line tag.text %>
-  </p>
+  </div>
 <% end %>

data/templates/default/docstring/setup.rb

@@ -1,6 +1,11 @@
 def init
   return if object.docstring.blank?
-  sections :index, [:deprecated, :abstract, :todo, :note, :returns_void, :text], T('tags')
+  sections :index, [:private, :deprecated, :abstract, :todo, :note, :returns_void, :text], T('tags')
+end
+
+def private
+  return unless object.has_tag?(:api) && object.tag(:api).text == 'private'
+  erb(:private)
 end
 
 def abstract

data/templates/default/docstring/text/private.erb

@@ -0,0 +1,2 @@
+<%= indent(wrap("This #{object.type} is part of a private API.")) %>
+

data/templates/default/fulldoc/html/css/style.css

@@ -15,6 +15,7 @@ h2 {
   font-size: 1.4em;
   margin: 1.8em 0 0.5em;
 }
+h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; }
 .clear { clear: both; }
 .inline { display: inline; }
 .inline p:first-child { display: inline; }
@@ -31,6 +32,7 @@ h2 {
 .note.todo { background: #ffffc5; border-color: #ececaa; }
 .note.returns_void { background: #efefef; }
 .note.deprecated { background: #ffe5e5; border-color: #e9dada; }
+.note.private { background: #ffffc5; border-color: #ececaa; }
 .note.title { text-transform: lowercase; padding: 1px 5px; margin-left: 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; }
 h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
 .note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; } 
@@ -118,7 +120,7 @@ p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace;
 .tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
 .tags ul li { margin-bottom: 3px; }
 .tags ul .name { font-family: monospace; font-weight: bold; }
-.tags ul p.note { padding: 3px 6px; }
+.tags ul .note { padding: 3px 6px; }
 .tags { margin-bottom: 12px; }
 
 .tags .examples h3 { margin-bottom: 10px; }
@@ -159,6 +161,8 @@ ul.summary li { margin-bottom: 5px; }
   -moz-border-radius: 3px; -webkit-border-radius: 3px; 
 }
 .summary_signature:hover { background: #eeeeff; cursor: pointer; }
+ul.summary.compact li { display: inline; margin-right: 5px; line-height: 2.6em;}
+ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
 #content .summary_signature:hover a:link, 
 #content .summary_signature:hover a:visited {
   background: transparent;
@@ -229,8 +233,8 @@ li.r2 { background: #fafafa; }
   overflow-y: scroll;
   border: 1px solid #999;
   border-collapse: collapse;
-  -webkit-box-shadow: -2px 5px 25px #aaa;
-  -moz-box-shadow: -2px 5px 25px #aaa;
+  -webkit-box-shadow: -7px 5px 25px #aaa;
+  -moz-box-shadow: -7px 5px 25px #aaa;
   -moz-border-radius: 2px;
   -webkit-border-radius: 2px;
 }

data/templates/default/fulldoc/html/js/app.js

@@ -91,8 +91,11 @@ function framesInit() {
 }
 
 function keyboardShortcuts() {
+  if (window.top.frames.main) return;
   $(document).keypress(function(evt) {
     if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
+    if (evt.originalTarget.nodeName == "INPUT" || 
+        evt.originalTarget.nodeName == "TEXTAREA") return;
     switch (evt.charCode) {
       case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
       case 77: case 109: $('#method_list_link').click(); break; // 'm'
@@ -101,6 +104,29 @@ function keyboardShortcuts() {
   });
 }
 
+function summaryToggle() {
+  $('.summary_toggle').click(function() {
+    $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+    var next = $(this).parent().parent().next();
+    if (next.hasClass('compact')) {
+      next.toggle();
+      next.next().toggle();
+    } 
+    else if (next.hasClass('summary')) {
+      var list = $('<ul class="summary compact" />');
+      list.html(next.html());
+      list.find('.summary_desc, .note').remove();
+      list.find('a').each(function() {
+        $(this).html($(this).find('strong').html());
+        $(this).parent().html($(this)[0].outerHTML);
+      });
+      next.before(list);
+      next.toggle();
+    }
+    return false;
+  })
+}
+
 $(framesInit);
 $(createSourceLinks);
 $(createDefineLinks);
@@ -109,3 +135,4 @@ $(fixBoxInfoHeights);
 $(searchFrameLinks);
 $(linkSummaries);
 $(keyboardShortcuts);
+$(summaryToggle);

data/templates/default/fulldoc/html/setup.rb

@@ -107,7 +107,7 @@ def class_list(root = Registry.root)
   if root == Registry.root
     children += @items.select {|o| o.namespace.is_a?(CodeObjects::Proxy) }
   end
-  children.sort_by {|child| child.path }.map do |child|
+  children.reject {|c| c.nil? }.sort_by {|child| child.path }.map do |child|
     if child.is_a?(CodeObjects::NamespaceObject)
       name = child.namespace.is_a?(CodeObjects::Proxy) ? child.path : child.name
       has_children = child.children.any? {|o| o.is_a?(CodeObjects::NamespaceObject) }

data/templates/default/module/html/attribute_summary.erb

@@ -1,5 +1,5 @@
 <% scopes(attr_listing) do |list, scope| %>
-  <h2><%= scope.to_s.capitalize %> Attribute Summary</h2>
+  <h2><%= scope.to_s.capitalize %> Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
   <ul class="summary">
     <% list.each do |meth| %>
       <%= yieldall :item => meth %>

data/templates/default/module/html/box_info.erb

@@ -16,7 +16,7 @@
       </dd>
     <% n = 2 %>
   <% end %>
-  <% [[:class, "Extends"], [:instance, "Includes"]].each do |scope, name| %>
+  <% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
     <% if (mix = object.mixins(scope)).size > 0 %>
       <dt class="r<%=n%>"><%= name %>:</dt>
       <dd class="r<%=n%>"><%= mix.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>

data/templates/default/module/html/header.erb

@@ -1,4 +1,5 @@
-<h1><%= format_object_title(object) %> 
+<h1><%= format_object_title(object) %>
   <% if object.has_tag?(:abstract) %><span class="abstract note title">Abstract</span><% end %>
   <% if object.has_tag?(:deprecated) %><span class="deprecated note title">Deprecated</span><% end %>
+  <% if object.has_tag?(:api) && object.tag(:api).text == 'private' %><span class="private note title">Private</span><% end %>
 </h1>

data/templates/default/module/html/item_summary.erb

@@ -20,6 +20,7 @@
   <% if @item.visibility != :public %><span class="note title <%= @item.visibility %>"><%= @item.visibility %></span><% end %>
   <% if @item.has_tag?(:abstract) %><span class="abstract note title">Abstract</span><% end %>
   <% if @item.has_tag?(:deprecated) %><span class="deprecated note title">Deprecated</span><% end %>
+  <% if @item.has_tag?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">Private</span><% end %>
 
   <% if @item.has_tag?(:deprecated) %>
     <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>

data/templates/default/module/html/method_summary.erb

@@ -1,6 +1,9 @@
 <% if method_listing.size > 0 %>
   <% scopes(method_listing) do |list, scope| %>
-    <h2><%= scope.to_s.capitalize %> Method Summary</h2>
+    <h2>
+      <%= scope.to_s.capitalize %> Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
 
     <ul class="summary">
       <% list.each do |meth| %>

data/templates/default/module/text/extends.erb

@@ -1,6 +1,6 @@
 <% if object.mixins(:class).size > 0 %>
-Extends:
---------
+Extended by:
+------------
 
 <%= indent wrap(object.mixins(:class).join(", "), 68) %>
 

data/templates/default/tags/html/see.erb

@@ -2,7 +2,7 @@
   <h3>See Also:</h3>
   <ul class="see">
     <% for tag in object.tags(:see) %>
-      <li><%= linkify(tag.name, tag.text || tag.name) %></li>
+      <li><%= linkify(tag.name, tag.text) %></li>
     <% end %>
   </ul>
 <% end %>