yard 0.7.5 → 0.8.0

data/spec/verifier_spec.rb

@@ -32,7 +32,7 @@ describe YARD::Verifier do
       Verifier.new('@return', '@param').call(obj).should == false
     end
   end
-  
+
   describe '#o' do
     it "should alias object to o" do
       obj = mock(:object)
@@ -47,17 +47,17 @@ describe YARD::Verifier do
       obj.should_receive(:tag).and_return(nil)
       Verifier.new('@return.text').call(obj).should == false
     end
-    
+
     it "should not fail if no expressions were added" do
       lambda { Verifier.new.call(nil) }.should_not raise_error
     end
-    
+
     it "should always ignore proxy objects and return true" do
       v = Verifier.new('tag(:x)')
       lambda { v.call(P('foo')).should == true }.should_not raise_error
     end
   end
-  
+
   describe '#expressions' do
     it "should maintain a list of all unparsed expressions" do
       Verifier.new('@return.text', '@private').expressions.should == ['@return.text', '@private']
@@ -73,7 +73,7 @@ describe YARD::Verifier do
       v.call(obj)
     end
   end
-  
+
   describe '#add_expressions' do
     it "should add new expressions and recompile" do
       obj = mock(:object)

data/templates/default/class/setup.rb

@@ -18,11 +18,11 @@ def subclasses
   unless globals.subclasses
     globals.subclasses = {}
     list = run_verifier Registry.all(:class)
-    list.each do |o| 
+    list.each do |o|
       (globals.subclasses[o.superclass.path] ||= []) << o if o.superclass
     end
   end
-  
+
   @subclasses = globals.subclasses[object.path]
   return if @subclasses.nil? || @subclasses.empty?
   @subclasses = @subclasses.sort_by {|o| o.path }.map do |child|

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

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

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

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

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

@@ -1,4 +1,4 @@
 <p class="note private">
-  <strong>This <%= object.type %> is part of a private API.</strong> 
+  <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| %>
   <div class="note todo">
-    <strong>TODO:</strong> 
+    <strong>TODO:</strong>
     <%= htmlify_line tag.text %>
   </div>
 <% end %>

data/templates/default/docstring/setup.rb

@@ -40,10 +40,10 @@ def docstring_text
   unless object.tags(:overload).size == 1 && object.docstring.empty?
     text = object.docstring
   end
-  
+
   if text.strip.empty? && object.tags(:return).size == 1 && object.tag(:return).text
     text = object.tag(:return).text.gsub(/\A([a-z])/) {|x| x.upcase }
   end
-  
+
   text.strip
 end

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

@@ -1,6 +1,6 @@
-body { 
+body {
   margin: 0;
-  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; 
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
   font-size: 13px;
   height: 101%;
   overflow-x: hidden;
@@ -37,6 +37,8 @@ li.collapsed.clicked a.toggle { background-position: top right; }
 #nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; }
 #nav a:link, #nav a:visited { color: #358; }
 #nav a:hover { background: transparent; color: #5af; }
+.frames #nav span:after { content: ' | '; }
+.frames #nav span:last-child:after { content: ''; }
 
 .frames #content h1 { margin-top: 0; }
 .frames li { white-space: nowrap; cursor: normal; }

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

@@ -1,6 +1,6 @@
-body { 
+body {
   padding: 0 20px;
-  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; 
+  font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
   font-size: 13px;
 }
 body.frames { padding: 0 5px; }
@@ -8,7 +8,7 @@ h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dot
 h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
 h1.title { margin-bottom: 10px; }
 h1.alphaindex { margin-top: 0; font-size: 22px; }
-h2 { 
+h2 {
   padding: 0;
   padding-bottom: 3px;
   border-bottom: 1px #aaa solid;
@@ -36,9 +36,9 @@ h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right;
 #filecontents dd, .docstring dd { padding: 5px 0px; margin-left: 18px; }
 #filecontents dd > p, .docstring dd > p { margin: 0px; }
 
-.note { 
+.note {
   color: #222;
-  -moz-border-radius: 3px; -webkit-border-radius: 3px; 
+  -moz-border-radius: 3px; -webkit-border-radius: 3px;
   background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
   display: block;
 }
@@ -46,13 +46,14 @@ h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right;
 .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; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
+.note.title { padding: 1px 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; display: inline; }
 .summary_signature + .note.title { margin-left: 7px; }
 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.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; }
+.note.title.not_defined_here { background: transparent; border: none; font-style: italic; }
 .discussion .note { margin-top: 6px; }
 .discussion .note:first-child { margin-top: 0; }
 
@@ -106,10 +107,8 @@ p.inherited {
 #filecontents dl.box .r1, dl.box .r1 { background: #eee; }
 
 ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
-#files { padding-left: 15px; font-size: 1.1em; }
-
-#files { padding: 0; }
-#files li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
+.index_inline_list { padding-left: 0; font-size: 1.1em; }
+.index_inline_list li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
 
 dl.constants { margin-left: 40px; }
 dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
@@ -125,29 +124,36 @@ dl.constants .discussion *:last-child { margin-bottom: 0; }
 
 .method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
 .method_details.first { border: 0; }
-p.signature { 
-  font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace; 
-  padding: 6px 10px; margin-top: 18px; 
+p.signature, h3.signature {
+  font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
+  padding: 6px 10px; margin-top: 18px;
   background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
 }
-p.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
-p.signature .overload { display: block; }
-p.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
-p.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
-p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
+p.signature tt,
+h3.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
+p.signature .overload,
+h3.signature .overload { display: block; }
+p.signature .extras,
+h3.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
+p.signature .not_defined_here,
+h3.signature .not_defined_here,
+p.signature .aliases,
+h3.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
+p.signature .aliases .names,
+h3.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
 
-.tags h3 { font-size: 1em; margin-bottom: 0; }
+.tags .tag_title { font-size: 1em; margin-bottom: 0; font-weight: bold; }
 .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 .note { padding: 3px 6px; }
 .tags { margin-bottom: 12px; }
 
-.tags .examples h3 { margin-bottom: 10px; }
-.tags .examples h4 { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
+.tags .examples .tag_title { margin-bottom: 10px; font-weight: bold; }
+.tags .examples .inline p { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
 
 .tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
-.tags .overload .overload_item .signature { 
+.tags .overload .overload_item .signature {
   padding: 2px 8px;
   background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
 }
@@ -171,19 +177,19 @@ ul.summary {
   font-size: 1em;
   line-height: 1.5em;
 }
-ul.summary a:link, ul.summary a:visited { 
+ul.summary a:link, ul.summary a:visited {
   text-decoration: none; font-size: 1.1em;
 }
 ul.summary li { margin-bottom: 5px; }
-.summary .summary_signature { 
+.summary .summary_signature {
   padding: 1px 10px;
   background: #eaeaff; border: 1px solid #dfdfe5;
-  -moz-border-radius: 3px; -webkit-border-radius: 3px; 
+  -moz-border-radius: 3px; -webkit-border-radius: 3px;
 }
 .summary_signature:hover { background: #eeeeff; cursor: pointer; }
 ul.summary.compact li { display: inline-block; margin: 0px 5px 0px 0px; 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:link,
 #content .summary_signature:hover a:visited {
   background: transparent;
   color: #48f;
@@ -206,18 +212,18 @@ ul.fullTree li:last-child { padding-bottom: 0; }
 .showAll .inheritName { display: none; }
 
 #search { position: absolute; right: 14px; top: 0px; }
-#search a:link, #search a:visited { 
+#search a:link, #search a:visited {
   display: block; float: left; margin-right: 4px;
   padding: 8px 10px; text-decoration: none; color: #05a;
   border: 1px solid #d8d8e5;
-  -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px; 
+  -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px;
   -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
   background: #eaf0ff;
   -webkit-box-shadow: -1px 1px 3px #ddd;
 }
 #search a:hover { background: #f5faff; color: #06b; }
-#search a.active { 
-  background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457; 
+#search a.active {
+  background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457;
   -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
   -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
 }
@@ -231,7 +237,7 @@ ul.fullTree li:last-child { padding-bottom: 0; }
 #menu .title { color: #555; }
 #menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
 #menu a:hover { color: #05a; }
-#menu .noframes { display: none; }
+#menu .noframes { display: inline; }
 .frames #menu .noframes { display: inline; float: right; }
 
 #footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
@@ -251,8 +257,8 @@ li.r2 { background: #fafafa; }
   z-index: 9999;
   background: #fff;
   display: none;
-  position: absolute; 
-  top: 36px; 
+  position: absolute;
+  top: 36px;
   right: 18px;
   width: 500px;
   height: 80%;
@@ -268,7 +274,7 @@ li.r2 { background: #fafafa; }
 #content ul.summary li.deprecated .summary_signature a:link,
 #content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; }
 
-#toc { 
+#toc {
   padding: 20px; padding-right: 30px; border: 1px solid #ddd; float: right; background: #fff; margin-left: 20px; margin-bottom: 20px;
   max-width: 300px;
   -webkit-box-shadow: -2px 2px 6px #bbb;
@@ -293,7 +299,7 @@ li.r2 { background: #fafafa; }
 #filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
 #filecontents pre.code, .docstring pre.code { display: block; }
 .source_code .lines { padding-right: 12px; color: #555; text-align: right; }
-#filecontents pre.code, .docstring pre.code, 
+#filecontents pre.code, .docstring pre.code,
 .tags pre.example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
 pre.code { color: #000; }
 pre.code .info.file { color: #555; }
@@ -302,21 +308,21 @@ pre.code .tstring_content,
 pre.code .heredoc_beg, pre.code .heredoc_end,
 pre.code .qwords_beg, pre.code .qwords_end,
 pre.code .tstring, pre.code .dstring { color: #036A07; }
-pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s, 
-pre.code .rubyid_to_sym, pre.code .rubyid_to_f, 
+pre.code .fid, pre.code .rubyid_new, pre.code .rubyid_to_s,
+pre.code .rubyid_to_sym, pre.code .rubyid_to_f,
 pre.code .dot + pre.code .id,
 pre.code .rubyid_to_i pre.code .rubyid_each { color: #0085FF; }
 pre.code .comment { color: #0066FF; }
 pre.code .const, pre.code .constant { color: #585CF6; }
 pre.code .symbol { color: #C5060B; }
-pre.code .kw, 
+pre.code .kw,
 pre.code .label,
-pre.code .rubyid_require, 
+pre.code .rubyid_require,
 pre.code .rubyid_extend,
 pre.code .rubyid_include { color: #0000FF; }
 pre.code .ivar { color: #318495; }
-pre.code .gvar, 
-pre.code .rubyid_backref, 
+pre.code .gvar,
+pre.code .rubyid_backref,
 pre.code .rubyid_nth_ref { color: #6D79DE; }
 pre.code .regexp, .dregexp { color: #036A07; }
 pre.code a { border-bottom: 1px dotted #bbf; }

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

@@ -3,11 +3,26 @@
 
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
-	<meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>"/>
-	<title><%= options[:title] %></title>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+	<title><%= options.title %></title>
 </head>
-<frameset cols="20%,*">
-  <frame name="list" src="class_list.html" />
-  <frame name="main" src="index.html" />
-</frameset>
+<script type="text/javascript" charset="utf-8">
+window.onload = function() {
+  var match = window.location.hash.match(/^#!(.+)/);
+  var name = '<%= url_for_main %>';
+  if (match) {
+    name = unescape(match[1]);
+  }
+  document.writeln('<frameset cols="20%,*">' +
+    '<frame name="list" src="<%= url_for_list('class') %>" />' +
+    '<frame name="main" src="' + name + '" />' +
+    '</frameset>');
+}
+</script>
+<noscript>
+  <frameset cols="20%,*">
+    <frame name="list" src="<%= url_for_list('class') %>" />
+    <frame name="main" src="<%= url_for_main %>" />
+  </frameset>
+</noscript>
 </html>

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

@@ -6,11 +6,11 @@
     <% stylesheets_full_list.each do |stylesheet| %>
       <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" media="screen" charset="utf-8" />
     <% end %>
-    
+
     <% javascripts_full_list.each do |javascript| %>
       <script type="text/javascript" charset="utf-8" src="<%= url_for(javascript) %>"></script>
     <% end %>
-    
+
     <base id="base_target" target="_parent" />
   </head>
   <body>
@@ -24,7 +24,9 @@
       <h1 id="full_list_header"><%= @list_title %></h1>
       <div id="nav">
         <% menu_lists.each do |list| %>
-          <a target="_self" href="<%= list[:type] %>_list.html"><%= list[:title] %></a>
+          <span><a target="_self" href="<%= url_for_list list[:type] %>">
+            <%= list[:title] %>
+          </a></span>
         <% end %>
       </div>
       <div id="search">Search: <input type="text" /></div>

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

@@ -44,21 +44,14 @@ function createFullTreeLinks() {
 
 function fixBoxInfoHeights() {
     $('dl.box dd.r1, dl.box dd.r2').each(function() {
-       $(this).prev().height($(this).height()); 
+       $(this).prev().height($(this).height());
     });
 }
 
 function searchFrameLinks() {
-  $('#method_list_link').click(function() {
-    toggleSearchFrame(this, relpath + 'method_list.html');
-  });
-
-  $('#class_list_link').click(function() {
-    toggleSearchFrame(this, relpath + 'class_list.html');
-  });
-
-  $('#file_list_link').click(function() {
-    toggleSearchFrame(this, relpath + 'file_list.html');
+  $('.full_list_link').click(function() {
+    toggleSearchFrame(this, $(this).attr('href'));
+    return false;
   });
 }
 
@@ -82,10 +75,13 @@ function linkSummaries() {
 }
 
 function framesInit() {
-  if (window.top.frames.main) {
+  if (hasFrames) {
     document.body.className = 'frames';
     $('#menu .noframes a').attr('href', document.location);
-    $('html head title', window.parent.document).text($('html head title').text());
+    window.top.document.title = $('html head title').text();
+  }
+  else {
+    $('#menu .noframes a').text('frames').attr('href', framesUrl);
   }
 }
 
@@ -113,7 +109,7 @@ function summaryToggle() {
     if (next.hasClass('compact')) {
       next.toggle();
       next.nextAll('ul.summary').first().toggle();
-    } 
+    }
     else if (next.hasClass('summary')) {
       var list = $('<ul class="summary compact" />');
       list.html(next.html());
@@ -151,30 +147,37 @@ function generateTOC() {
   for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
   var lastTag = parseInt(tags[0][1], 10);
   $(tags.join(', ')).each(function() {
+    if ($(this).parents('.method_details .docstring').length != 0) return;
     if (this.id == "filecontents") return;
     show = true;
     var thisTag = parseInt(this.tagName[1], 10);
     if (this.id.length === 0) {
-      var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
-      if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
-      this.id = proposedId;
+      var proposedId = $(this).attr('toc-id');
+      if (typeof(proposedId) != "undefined") this.id = proposedId;
+      else {
+        var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+        if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
+        this.id = proposedId;
+      }
     }
-    if (thisTag > lastTag) { 
-      for (i = 0; i < thisTag - lastTag; i++) { 
-        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp; 
-      } 
+    if (thisTag > lastTag) {
+      for (i = 0; i < thisTag - lastTag; i++) {
+        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+      }
     }
-    if (thisTag < lastTag) { 
-      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent(); 
+    if (thisTag < lastTag) {
+      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
     }
-    toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
+    var title = $(this).attr('toc-title');
+    if (typeof(title) == "undefined") title = $(this).text();
+    toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
     lastTag = thisTag;
   });
   if (!show) return;
   html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
   $('#content').prepend(html);
   $('#toc').append(_toc);
-  $('#toc .hide_toc').toggle(function() { 
+  $('#toc .hide_toc').toggle(function() {
     $('#toc .top').slideUp('fast');
     $('#toc').toggleClass('hidden');
     $('#toc .title small').toggle();
@@ -183,7 +186,7 @@ function generateTOC() {
     $('#toc').toggleClass('hidden');
     $('#toc .title small').toggle();
   });
-  $('#toc .float_toc').toggle(function() { 
+  $('#toc .float_toc').toggle(function() {
     $(this).text('float');
     $('#toc').toggleClass('nofloat');
   }, function() {