yard 0.4.0 → 0.5.0

data/spec/templates/spec_helper.rb

@@ -2,7 +2,15 @@ require File.dirname(__FILE__) + '/../spec_helper'
 
 include YARD::Templates
 
+def only_copy?(result, example, type) 
+  if $COPY == :all || $COPY == example
+    puts(result) unless $COPYT && $COPYT != type
+  end
+  $COPY ? true : false
+end
+
 def text_equals(result, expected_example)
+  return if only_copy?(result, expected_example, :text)
   text_equals_string(result, example(expected_example, :txt))
 end
 
@@ -11,6 +19,7 @@ def text_equals_string(result, expected)
 end
 
 def html_equals(result, expected_example)
+  return if only_copy?(result, expected_example, :html)
   html_equals_string(result, example(expected_example))
 end
 
@@ -19,7 +28,7 @@ def html_equals_string(result, expected)
     value.gsub!(/(>)\s+|\s+(<)/, '\1\2')
     value.strip!
   end
-  result.should == expected
+  text_equals_string(result, expected)
 end
 
 def example(filename, ext = 'html')

data/spec/yard_spec.rb

@@ -3,7 +3,7 @@ require File.join(File.dirname(__FILE__), "spec_helper")
 describe YARD do
   describe '.load_plugins' do
     it "should load any plugin starting with 'yard_' or 'yard-'" do
-      plugins = { 
+      plugins = {
         'yard' => mock('yard'), 
         'yard_plugin' => mock('yard_plugin'), 
         'yard-plugin' => mock('yard-plugin'),
@@ -13,8 +13,9 @@ describe YARD do
       plugins.each do |k, v|
         v.should_receive(:name).at_least(1).times.and_return(k)
       end
+      
       source_mock = mock(:source_index)
-      source_mock.should_receive(:entries).and_return(plugins)
+      source_mock.should_receive(:find_name).with('').and_return(plugins.values)
       Gem.should_receive(:source_index).and_return(source_mock)
       YARD.should_receive(:require).with('yard_plugin').and_return(true)
       YARD.should_receive(:require).with('yard-plugin').and_return(true)
@@ -34,7 +35,7 @@ describe YARD do
         v.should_receive(:name).at_least(1).times.and_return(k)
       end
       source_mock = mock(:source_index)
-      source_mock.should_receive(:entries).and_return(plugins)
+      source_mock.should_receive(:find_name).with('').and_return(plugins.values)
       File.should_receive(:file?).with(path).and_return(true)
       IO.should_receive(:read).with(path).and_return('yard-plugin yard-plugin2')
       Gem.should_receive(:source_index).and_return(source_mock)

data/templates/default/class/html/constructor_details.erb

@@ -1,4 +1,4 @@
-<div id="constructor_details">
+<div id="constructor_details" class="method_details_list">
   <h2>Constructor Details</h2>
   <% if @ctor.namespace != object %>
     <p class="notice">This class inherits a constructor from <%= linkify @ctor, @ctor.namespace.path %></p>

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

@@ -0,0 +1 @@
+<p class="note returns_void">This method returns an undefined value.</p>

data/templates/default/docstring/setup.rb

@@ -1,6 +1,6 @@
 def init
   return if object.docstring.blank?
-  sections :index, [:deprecated, :abstract, :todo, :note, :text], T('tags')
+  sections :index, [:deprecated, :abstract, :todo, :note, :returns_void, :text], T('tags')
 end
 
 def abstract
@@ -23,11 +23,16 @@ def note
   erb(:note)
 end
 
+def returns_void
+  return unless object.type == :method
+  return if object.name == :initialize && object.scope == :instance
+  return unless object.tags(:return).size == 1 && object.tag(:return).types == ['void']
+  erb(:returns_void)
+end
+
 def docstring_text
   text = ""
-  if object.tags(:overload).size == 1 && object.docstring.empty?
-    text = object.tag(:overload).docstring
-  else
+  unless object.tags(:overload).size == 1 && object.docstring.empty?
     text = object.docstring
   end
   

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

@@ -0,0 +1 @@
+<%= indent(wrap("This method returns an undefined value.")) %>

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

@@ -26,9 +26,11 @@ h2 {
   background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
 }
 .note.todo { background: #ffffc5; border-color: #ececaa; }
+.note.returns_void { background: #efefef; }
 .note.deprecated { background: #ffe5e5; border-color: #e9dada; }
 .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; } 
 .note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; } 
 .note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; } 
 .note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
@@ -111,7 +113,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 { display: inline; margin-bottom: 5px; }
+.tags ul p.note { padding: 3px 6px; }
 .tags { margin-bottom: 12px; }
 
 .tags .examples h3 { margin-bottom: 10px; }
@@ -169,7 +171,7 @@ p.children strong.modules { padding-left: 5px; }
 ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
 ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
 ul.fullTree li { text-align: center; }
-ul.fullTree li.next:before { font-size: 1.2em; content: '⬆'; color: #bbb; display: block; margin-top: 3px; }
+ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; display: block; margin-top: 3px; }
 
 #search { position: absolute; right: 14px; top: 0px; }
 #search a:link, #search a:visited { 

data/templates/default/fulldoc/html/full_list.erb

@@ -19,11 +19,11 @@
         <li class="r<%= n %> <%= item.is_a?(CodeObjects::Base) && item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
           <% if @file_list %>
             <%= link_file item, File.basename(item).gsub(/\.[^.]+$/, '') %>
-          <% elsif item == Registry.root %>
+          <% elsif item.root? %>
             <a href="top-level-namespace.html">Top Level Namespace</a>
           <% else %>
             <%= linkify item, item.name(true) %> 
-            <% if item.namespace && item.namespace != Registry.root %>
+            <% if item.namespace && !item.namespace.root? %>
               <small>(<%= item.namespace %>)</small>
             <% end %>
           <% end %>

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

@@ -1,5 +1,5 @@
 function createSourceLinks() {
-    $('#method_details .source_code, #constructor_details .source_code, #method_missing_details .source_code').
+    $('.method_details_list .source_code').
         before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
     $('.toggleSource').toggle(function() {
        $(this).parent().next().slideDown(100);

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

@@ -1,7 +1,7 @@
 include Helpers::ModuleHelper
 
 def init
-  objects = options[:objects]
+  options[:objects] = objects = run_verifier(options[:objects])
   options[:files] = ([options[:readme]] + options[:files]).compact.map {|t| t.to_s }
   options[:readme] = options[:files].first
   options[:title] ||= "Documentation by YARD #{YARD::VERSION}"
@@ -14,9 +14,15 @@ def init
 
   options.delete(:objects)
   options.delete(:files)
-  objects.each do |object|
-    next if options[:verifier] && options[:verifier].call(object).is_a?(FalseClass)
-    serialize(object)
+  
+  objects.each do |object| 
+    begin
+      serialize(object)
+    rescue => e
+      path = options[:serializer].serialized_path(object)
+      log.error "Exception occurred while generating '#{path}'"
+      log.backtrace(e)
+    end
   end
 end
 
@@ -38,7 +44,7 @@ def serialize_file(file, title = nil)
   options[:object] = Registry.root
   options[:file] = file
   options[:page_title] = title
-  options[:serialized_path] = 'file.' + File.basename(file.gsub(/\..+$/, '')) + '.html'
+  options[:serialized_path] = 'file.' + File.basename(file.gsub(/\.[^.]+$/, '')) + '.html'
 
   serialize_index(options) if file == options[:readme]
   Templates::Engine.with_serializer(options[:serialized_path], options[:serializer]) do
@@ -66,7 +72,9 @@ def generate_assets
 end
 
 def generate_method_list
-  @items = prune_method_listing(Registry.all(:method)).sort_by {|m| m.name.to_s }
+  @items = prune_method_listing(Registry.all(:method), false)
+  @items = @items.reject {|m| m.name.to_s =~ /=$/ && m.is_attribute? }
+  @items = @items.sort_by {|m| m.name.to_s }
   @list_title = "Method List"
   asset('method_list.html', erb(:full_list))
 end

data/templates/default/layout/dot/setup.rb

@@ -2,7 +2,7 @@ attr_reader :contents
 
 def init
   if object
-    type = object == Registry.root ? :module : object.type
+    type = object.root? ? :module : object.type
     sections :header, [T(type)]
   else
     sections :header, [:contents]

data/templates/default/layout/html/breadcrumb.erb

@@ -1,9 +1,9 @@
 <div id="menu">
   <% if object.is_a?(CodeObjects::Base) && @file.nil? %>
-    <a href="<%= url_for('_index.html') %>"><% if Registry.root == object || object.type == :method %>Index<% else %>Index (<%= object.name.to_s[0,1] %>)<% end %></a> &raquo; 
+    <a href="<%= url_for('_index.html') %>"><% if object.root? || object.type == :method %>Index<% else %>Index (<%= object.name.to_s[0,1] %>)<% end %></a> &raquo; 
     <%= @breadcrumb.map {|obj| linkify obj, obj.name }.join(" &raquo; ") %>
     <%= @breadcrumb.size > 0 ? " &raquo; " : "" %>
-    <span class="title"><%= Registry.root == object ? "Top Level Namespace" : object.name(true) %></span>
+    <span class="title"><%= object.root? ? "Top Level Namespace" : object.name(true) %></span>
   <% else %>
     <% if object != '_index.html' %><%= link_url('_index.html', 'Index') %> &raquo; <% end %>
     <span class="title"><%= @breadcrumb_title %></span>

data/templates/default/layout/html/index.erb

@@ -7,7 +7,7 @@
     <ul id="files">
     <% n = 1 %>
     <% @files.each_with_index do |file, i| %>
-      <li class="r<%= n %>"><%= link_file(file, File.basename(file).gsub(/\..+$/, '')) %></li>
+      <li class="r<%= n %>"><%= link_file(file, File.basename(file).gsub(/\.[^.]+$/, '')) %></li>
       <% n = n == 2 ? 1 : 2 %>
     <% end %>
     </ul>
@@ -35,7 +35,7 @@
               <% objects.each do |obj| %>
                 <li>
                   <%= linkify obj, obj.name %> 
-                  <% if obj.namespace != Registry.root %>
+                  <% if !obj.namespace.root? %>
                     <small>(<%= obj.namespace.path %>)</small>
                   <% end %>
                 </li>

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

@@ -4,7 +4,7 @@ def init
   if @file
     @contents = IO.read(@file)
     @file = File.basename(@file)
-    @fname = @file.gsub(/\..+$/, '')
+    @fname = @file.gsub(/\.[^.]+$/, '')
     @breadcrumb_title = "File: " + @fname
     @page_title ||= @breadcrumb_title
     sections :layout, [:diskfile]
@@ -14,16 +14,16 @@ def init
       @page_title = options[:title]
       sections :layout, [:index]
     when CodeObjects::Base
-      if object != Registry.root
+      unless object.root?
         cur = object.namespace
-        while cur != Registry.root
+        while !cur.root?
           @breadcrumb.unshift(cur)
           cur = cur.namespace
         end
       end
     
       @page_title = format_object_title(object)
-      type = object == Registry.root ? :module : object.type
+      type = object.root? ? :module : object.type
       sections :layout, [T(type)]
     end
   else
@@ -37,7 +37,7 @@ end
 
 def index
   @objects_by_letter = {}
-  objects = @objects.reject {|o| o == Registry.root }.sort_by {|o| o.name.to_s }
+  objects = @objects.reject {|o| o.root? }.sort_by {|o| o.name.to_s }
   objects.each {|o| (@objects_by_letter[o.name.to_s[0,1].upcase] ||= []) << o }
   erb(:index)
 end

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

@@ -3,12 +3,14 @@
   <dt class="r1 last">Defined in:</dt>
   <dd class="r1 last">
     <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
-      <%= object.files[1..-1].map(&:first).join(",<br /> ") %></div>
+      <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
     <% end %>
   </dd>
 </dl>
 <div class="clear"></div>
 
-<div id="method_details">
-  <%= yieldall :index => 0 %>
-</div>
+<div class="method_details_list">
+  <div id="method_details">
+    <%= yieldall :index => 0 %>
+  </div>
+</div>

data/templates/default/method_details/html/method_signature.erb

@@ -11,7 +11,8 @@
 
   <% if object.aliases.size > 0 %>
     <span class="aliases">Also known as:
-    <span class="names"><%= object.aliases.map {|o| h(o.name.to_s) }.join(", ") %></span>
+    <span class="names"><%= object.aliases.map {|o| 
+      "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
     </span>
   <% end %>
 </p>

data/templates/default/method_details/html/source.erb

@@ -4,7 +4,7 @@
       <pre class="lines"><%= "\n\n\n" %><%= h format_lines(object) %></pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File '<%= h object.file %>', line <%= object.line %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
+      <pre class="code"><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source, object.source_type %></pre>
     </td>
   </tr>
 </table>

data/templates/default/method_details/setup.rb

@@ -3,6 +3,7 @@ def init
 end
 
 def source
-  return if object.tags(:overload).size > 1
+  return if Tags::OverloadTag === object
+  return if object.source.nil?
   erb(:source)
 end

data/templates/default/method_details/text/setup.rb

@@ -5,6 +5,6 @@ end
 
 def format_object_title(object)
   title = "Method: #{object.name(true)}"
-  title += " (#{object.namespace})" if object.namespace != Registry.root
+  title += " (#{object.namespace})" if !object.namespace.root?
   title
 end

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

@@ -1,7 +1,7 @@
-<% if attr_listing.size > 0 %>
-  <div id="attr_details">
-    <h2>Attribute Details</h2>
-    <% attr_listing.each_with_index do |meth, i| %>
+<% scopes(attr_listing) do |list, scope| %>
+  <div id="<%= scope %>_attr_details" class="attr_details">
+    <h2><%= scope.to_s.capitalize %> Attribute Details</h2>
+    <% list.each_with_index do |meth, i| %>
       <% rw = meth.namespace.attributes[meth.scope][meth.name.to_s.gsub(/=$/, '').to_sym] %>
       <span id="<%= anchor_for(rw[:write]) %>"></span>
       <span id="<%= anchor_for(rw[:read]) %>"></span>

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

@@ -1,7 +1,7 @@
-<% if attr_listing.size > 0 %>
-  <h2>Attribute Summary</h2>
+<% scopes(attr_listing) do |list, scope| %>
+  <h2><%= scope.to_s.capitalize %> Attribute Summary</h2>
   <ul class="summary">
-    <% attr_listing.each do |meth| %>
+    <% list.each do |meth| %>
       <%= yieldall :item => meth %>
     <% end %>
   </ul>

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

@@ -4,7 +4,7 @@
     <dt class="r<%=n%>">Inherits:</dt>
     <dd class="r<%=n%>">
       <span class="inheritName"><%= linkify object.superclass %></span>
-      <% if object.superclass.name != :Object %>
+      <% if object.superclass.name != :BasicObject %>
         <ul class="fullTree">
           <li><%= linkify P(:Object) %></li>
           <% object.inheritance_tree.reverse.each_with_index do |obj, i| %>
@@ -23,7 +23,7 @@
       <% n = n == 2 ? 1 : 2 %>
     <% end %>
   <% end %>
-  <% unless object == Registry.root %>
+  <% unless object.root? %>
     <dt class="r<%=n%> last">Defined in:</dt>
     <dd class="r<%=n%> last"><%= erb(:defines) %></dd>
   <% end %>

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

@@ -1,3 +1,3 @@
 <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
-  <%= object.files[1..-1].map(&:first).join(",<br /> ") %></span>
+  <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></span>
 <% end %>

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

@@ -1,6 +1,6 @@
 <% object.inheritance_tree(true)[1..-1].each do |superclass| %>
   <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
-  <% consts = superclass.constants(:included => false, :inherited => false) %>
+  <% consts = run_verifier superclass.constants(:included => false, :inherited => false) %>
   <% consts.reject! {|m| object.child(:scope => :class, :name => m.name) != nil } %>
   <% next if consts.size == 0 %>
   <h3 class="inherited">Constants <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>

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

@@ -1,6 +1,6 @@
 <% object.inheritance_tree(true)[1..-1].each do |superclass| %>
   <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
-  <% meths = superclass.meths(:included => false, :inherited => false) %>
+  <% meths = prune_method_listing(superclass.meths(:included => false, :inherited => false)) %>
   <% meths.reject! {|m| object.child(:scope => m.scope, :name => m.name) != nil } %>
   <% meths.reject! {|m| m.is_alias? || m.is_attribute? } %>
   <% next if meths.size == 0 %>

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

@@ -1,9 +1,18 @@
 <li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
-  <span class="summary_signature"><%= signature(@item, true, false) %>
-  <% if @item.aliases.size > 0 %>
-    (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
-  <% end %>
+  <span class="summary_signature">
+    <% if @item.tags(:overload).size == 1 %>
+      <%= signature(@item.tag(:overload), true, false) %>
+    <% else %>
+      <%= signature(@item, true, false) %>
+    <% end %>
+
+    <% if @item.aliases.size > 0 %>
+      (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
+    <% end %>
   </span>
+  <% if @item.constructor? %>
+    <span class="note title constructor">constructor</span>
+  <% end %>
   <% if rw = @item.namespace.attributes[@item.scope][@item.name] %>
     <% if rw[:read] && !rw[:write] %><span class="note title readonly">readonly</span><% end %>
     <% if rw[:write] && !rw[:read] %><span class="note title writeonly">writeonly</span><% end %>

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

@@ -1,7 +1,8 @@
-<% if method_listing(false).size > 0 %>
-  <div id="method_details">
-    <h2>Method Details</h2>
-    <% method_listing(false).each_with_index do |meth, i| %>
+<% scopes(method_listing(false)) do |list, scope| %>
+  <div id="<%= scope %>_method_details" class="method_details_list">
+    <h2><%= scope.to_s.capitalize %> Method Details</h2>
+    
+    <% list.each_with_index do |meth, i| %>
       <%= yieldall :object => meth, :index => i %>
     <% end %>
   </div>