yard 0.5.2 → 0.5.3

data/spec/templates/helpers/html_helper_spec.rb

@@ -14,17 +14,21 @@ describe YARD::Templates::Helpers::HtmlHelper do
   describe '#fix_typewriter' do
     it "should use #fix_typewriter to convert +text+ to <tt>text</tt>" do
       fix_typewriter("Some +typewriter text+.").should == 
-        "Some <tt>t\x04y\x04p\x04e\x04w\x04r\x04i\x04t\x04e\x04r\x04" +
-        " \x04t\x04e\x04x\x04t\x04</tt>."
+        "Some <tt>typewriter" +
+        " text</tt>."
       fix_typewriter("Not +typewriter text.").should == 
         "Not +typewriter text."
       fix_typewriter("Alternating +type writer+ text +here+.").should == 
-        "Alternating <tt>t\x04y\x04p\x04e\x04 \x04w\x04r\x04i\x04t\x04e\x04r" +
-        "\x04</tt> text <tt>h\x04e\x04r\x04e\x04</tt>."
+        "Alternating <tt>type writer" +
+        "</tt> text <tt>here</tt>."
       fix_typewriter("No ++problem.").should == 
         "No ++problem."
       fix_typewriter("Math + stuff +is ok+").should == 
-        "Math + stuff <tt>i\x04s\x04 \x04o\x04k\x04</tt>"
+        "Math + stuff <tt>is ok</tt>"
+    end
+    
+    it "should not apply to code blocks" do
+      fix_typewriter("<code>+hello+</code>").should == "<code>+hello+</code>"
     end
   end
   
@@ -70,6 +74,10 @@ describe YARD::Templates::Helpers::HtmlHelper do
   end
 
   describe "#link_object" do
+    before do
+      stub!(:object).and_return(CodeObjects::NamespaceObject.new(nil, :YARD))
+    end
+    
     it "should return the object path if there's no serializer and no title" do
       stub!(:serializer).and_return nil
       link_object(CodeObjects::NamespaceObject.new(nil, :YARD)).should == "YARD"
@@ -269,4 +277,16 @@ describe YARD::Templates::Helpers::HtmlHelper do
       html_syntax_highlight("!!!NAME\ndef x; end").should == "def x; end"
     end
   end
+  
+  describe '#resolve_links' do
+    it "should resolve {Name}" do
+      should_receive(:link_file).with('TEST', 'TEST', nil).and_return('')
+      resolve_links("{file:TEST}")
+    end
+
+    it "should resolve ({Name})" do
+      should_receive(:link_file).with('TEST', 'TEST', nil).and_return('')
+      resolve_links("({file:TEST})")
+    end
+  end
 end

data/spec/templates/module_spec.rb

@@ -23,6 +23,8 @@ describe YARD::Templates::Engine.template(:default, :method) do
         #   @return [void]
         attr_accessor :attr3
         
+        attr_writer :attr4
+        
         def self.a; end
         def a; end
         alias b a
@@ -46,7 +48,7 @@ describe YARD::Templates::Engine.template(:default, :method) do
         class X; end
         module Z; end
         CONSTANT = 'value'
-        @@cvar = 'value'
+        @@cvar = 'value' # @deprecated
       end
     eof
   end

data/spec/templates/template_spec.rb

@@ -5,12 +5,22 @@ describe YARD::Templates::Template do
     YARD::Templates::Engine.template!(path, '/full/path/' + path.to_s)
   end
   
-  describe '#initialize' do
+  describe '.include_parent' do
     it "should not include parent directory if parent directory is a template root path" do
       mod = template('q')
       mod.should_not include(template(''))
     end
     
+    it "should include overridden parent directory" do
+      Engine.stub!(:template_paths).and_return(['/foo', '/bar'])
+      File.should_receive(:directory?).with('/foo/a/b').and_return(true)
+      File.should_receive(:directory?).with('/bar/a/b').and_return(false)
+      File.should_receive(:directory?).with('/foo/a').at_least(1).times.and_return(true)
+      File.should_receive(:directory?).with('/bar/a').at_least(1).times.and_return(true)
+      ancestors = Engine.template('a/b').ancestors.map {|c| c.class_name }
+      ancestors[0, 3].should == %w( Template__foo_a_b Template__bar_a Template__foo_a )
+    end
+    
     it "should include parent directory template if exists" do
       mod1 = template('x')
       mod2 = template('x/y')

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

@@ -1,4 +1,4 @@
 <div id="subclasses">
   <h2>Direct Known Subclasses</h2>
-  <p class="children"><%= @subclasses.map {|child| linkify(child) }.join(", ") %></p>
+  <p class="children"><%= @subclasses.map {|name, child| linkify(child, name) }.join(", ") %></p>
 </div>

data/templates/default/class/setup.rb

@@ -14,16 +14,23 @@ def constructor_details
 end
 
 def subclasses
+  return if object.path == "Object" # don't show subclasses for Object
   if !defined? @@subclasses
     @@subclasses = {}
     list = run_verifier Registry.all(:class)
     list.each do |o| 
-      (@@subclasses[o.superclass] ||= []) << o if o.superclass
+      (@@subclasses[o.superclass.path] ||= []) << o if o.superclass
     end
   end
   
-  @subclasses = @@subclasses[object]
+  @subclasses = @@subclasses[object.path]
   return if @subclasses.nil? || @subclasses.empty?
-  @subclasses = @subclasses.sort_by {|o| o.path }
+  @subclasses = @subclasses.sort_by {|o| o.path }.map do |child|
+    name = child.path
+    if object.namespace
+      name = object.relative_path(child)
+    end
+    [name, child]
+  end
   erb(:subclasses)
 end

data/templates/default/class/text/subclasses.erb

@@ -1,5 +1,5 @@
 Direct Known Subclasses:
 ------------------------
 
-<%= indent(wrap(@subclasses.map {|child| linkify(child) }.join(", "))) %>
+<%= indent(wrap(@subclasses.map {|name, child| name }.join(", "))) %>
 

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

@@ -3,21 +3,48 @@ body {
   font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; 
   font-size: 13px;
   height: 101%;
+  overflow-x: hidden;
 }
-html { overflow-y: scroll; }
 
-h1 { padding: 0; margin: 5px; margin-top: 12px; margin-left: 10px; margin-bottom: 0; font-size: 1.4em; }
+h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
 .clear { clear: both; }
 #search { position: absolute; right: 5px; top: 9px; }
 #full_list { padding: 0; list-style: none; margin-left: 0; }
-#full_list li { padding: 7px 15px; font-size: 1.1em; }
-#noresults { display: none; padding: 7px 15px; }
-li { color: #555; }
+#full_list ul { padding: 0; }
+#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; }
+#noresults { display: none; padding: 7px 12px; }
+ul.collapsed ul, ul.collapsed li { display: none; }
+li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
+li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
+li { color: #888; cursor: pointer; }
 li.deprecated { text-decoration: line-through; font-style: italic; }
-li.r1 { background: #f0f0f0; border: 1px dotted #f0f0f0; border-left-width: 0; border-right-width: 0; }
-li.r2 { background: #fafafa; border: 1px dotted #fafafa; border-left-width: 0; border-right-width: 0; }
-li:hover { background: #ffffa5; cursor: pointer; border: 1px dotted #ddddc4; border-left-width: 0; border-right-width: 0; }
-li:hover * { position: relative; left: -3px; }
+li.r1 { background: #f0f0f0; }
+li.r2 { background: #fafafa; }
+li:hover { background: #ddd; }
+li small:before { content: "("; }
+li small:after { content: ")"; }
+li small.search_info { display: none; }
 a:link, a:visited { text-decoration: none; color: #05a; }
-a:hover { background: #ffffa5; }
-#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
+li.clicked { background: #05a; color: #ccc; }
+li.clicked a:link, li.clicked a:visited { color: #eee; }
+li.clicked a.toggle { opacity: 0.5; background-position: bottom right; }
+li.collapsed.clicked a.toggle { background-position: top right; }
+#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
+#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 #content h1 { margin-top: 0; }
+.frames li { white-space: nowrap; cursor: normal; }
+.frames li small { display: block; font-size: 0.8em; }
+.frames li small:before { content: ""; }
+.frames li small:after { content: ""; }
+.frames li small.search_info { display: none; }
+.frames #search { position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; }
+.frames #search input { width: 110px; }
+.frames #nav { display: block; }
+
+#full_list.insearch li { display: none; }
+#full_list.insearch li.found { display: list-item; padding-left: 10px; }
+#full_list.insearch li a.toggle { display: none; }
+#full_list.insearch li small.search_info { display: block; }

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

@@ -3,6 +3,7 @@ body {
   font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; 
   font-size: 13px;
 }
+body.frames { padding: 0 5px; }
 h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
 h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
 h1.title { margin-bottom: 10px; }
@@ -188,6 +189,7 @@ ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; di
   -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
 }
 #search a.inactive { color: #999; }
+.frames #search { display: none; }
 .inheritanceTree, .toggleDefines { float: right; }
 
 #menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
@@ -195,6 +197,8 @@ ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; di
 #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; }
+.frames #menu .noframes { display: inline; float: right; }
 
 #footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
 #footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
@@ -203,7 +207,7 @@ ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; di
 #listing ul.alpha { font-size: 1.1em; }
 #listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
 #listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
-#listing ul.alpha ul { margin: 0; padding: 0; }
+#listing ul.alpha ul { margin: 0; padding-left: 15px; }
 #listing ul small { color: #666; font-size: 0.7em; }
 
 li.r1 { background: #f0f0f0; }
@@ -260,4 +264,5 @@ pre.code .gvar,
 pre.code .id.backref, 
 pre.code .id.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

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<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>
+</html>

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

@@ -7,30 +7,28 @@
     <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
     <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
     <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
-    <base target="_parent" />
+    <base id="base_target" target="_parent" />
   </head>
   <body>
-    <h1 id="full_list_header"><%= @list_title %></h1>
-    <div id="search">Search: <input type="text" /></div>
-    <div class="clear"></div>
-    <ul id="full_list">
-      <% n = 1 %>
-      <% @items.each do |item| %>
-        <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.root? %>
-            <a href="top-level-namespace.html">Top Level Namespace</a>
-          <% else %>
-            <%= linkify item, item.name(true) %> 
-            <% if item.namespace && !item.namespace.root? %>
-              <small>(<%= item.namespace %>)</small>
-            <% end %>
-          <% end %>
-          <% n = n == 2 ? 1 : 2 %>
-        </li>
-      <% end %>
-    </ul>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames';
+      }
+    </script>
+    <div id="content">
+      <h1 id="full_list_header"><%= @list_title %></h1>
+      <div id="nav">
+        <a target="_self" href="class_list.html">Classes</a> | 
+        <a target="_self" href="method_list.html">Methods</a> |
+        <a target="_self" href="file_list.html">Files</a>
+      </div>
+      <div id="search">Search: <input type="text" /></div>
+
+      <ul id="full_list" class="<%= @list_type %>">
+        <%= erb "full_list_#{@list_type}" %>
+      </ul>
+    </div>
   </body>
 </html>
 

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

@@ -0,0 +1,2 @@
+<li><%= link_object(Registry.root, nil, nil, false) %></li>
+<%= class_list %>

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

@@ -0,0 +1,5 @@
+<% n = 1 %>
+<% @items.each do |item| %>
+  <li class="r<%= n %>"><%= link_file item, File.basename(item).gsub(/\.[^.]+$/, '') %></li>
+  <% n = n == 2 ? 1 : 2 %>
+<% end %>

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

@@ -0,0 +1,12 @@
+<% n = 1 %>
+<% @items.each do |item| %>
+  <li class="r<%= n %> <%= item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+    <%= linkify item, item.name(true) %> 
+    <% if item.namespace && !item.namespace.root? %>
+      <small><%= item.namespace %></small>
+    <% else %>
+      <small>Top Level Namespace</small>
+    <% end %>
+  </li>
+  <% n = n == 2 ? 1 : 2 %>
+<% end %>

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

@@ -79,13 +79,21 @@ function toggleSearchFrame(id, link) {
 
 function linkSummaries() {
   $('.summary_signature').click(function() {
-    window.parent.location = $(this).find('a').attr('href');
+    document.location = $(this).find('a').attr('href');
   });
 }
 
+function framesInit() {
+  if (window.top.frames.main) {
+    document.body.className = 'frames';
+    $('#menu .noframes a').attr('href', document.location);
+  }
+}
+
+$(framesInit);
 $(createSourceLinks);
 $(createDefineLinks);
 $(createFullTreeLinks);
 $(fixBoxInfoHeights);
 $(searchFrameLinks);
-$(linkSummaries);
+$(linkSummaries);

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

@@ -2,20 +2,36 @@ function fullListSearch() {
   $('#search input').keyup(function() {
     var value = this.value.toLowerCase();
     if (value == "") {
-      $('#full_list li').show();
+      $('#full_list').removeClass('insearch');
+      $('#full_list li').each(function() {
+        var link = $(this).children('a:last');
+        link.text(link.text()); 
+      });
+      if (clicked) {
+        clicked.parents('ul').each(function() {
+          $(this).removeClass('collapsed').prev().removeClass('collapsed');
+        });
+      }
+      highlight();
     }
     else {
+      $('#full_list').addClass('insearch');
       $('#full_list li').each(function() {
-        if ($(this).children('a').text().toLowerCase().indexOf(value) == -1) {
-          $(this).hide();
+        var link = $(this).children('a:last');
+        var text = link.text();
+        if (text.toLowerCase().indexOf(value) == -1) {
+          $(this).removeClass('found');
+          link.text(link.text());
         }
         else {
-          $(this).show();
+          $(this).css('padding-left', '10px').addClass('found');
+          link.html(link.text().replace(new RegExp("(" + 
+            value.replace(/([\/.*+?|()\[\]{}\\])/g, "\\$1") + ")", "ig"), 
+            '<strong>$1</strong>'));
         }
       });
+      highlight(true);
     }
-    $('#full_list li:even:visible').removeClass('r2').addClass('r1');
-    $('#full_list li:odd:visible').removeClass('r1').addClass('r2');
     
     if ($('#full_list li:visible').size() == 0) {
       $('#noresults').fadeIn();
@@ -29,11 +45,62 @@ function fullListSearch() {
   $('#full_list').after("<div id='noresults'>No results were found.</div>")
 }
 
+clicked = null;
 function linkList() {
-  $('#full_list li').click(function() {
-    window.parent.location = $(this).find('a').attr('href');
+  $('#full_list li, #full_list li a:last').click(function(evt) {
+    if ($(this).hasClass('toggle')) return true;
+    if (this.tagName.toLowerCase() == "li") {
+      var toggle = $(this).children('a.toggle');
+      if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
+        toggle.click();
+        return false;
+      }
+    }
+    if (clicked) clicked.removeClass('clicked');
+    var win = window.parent;
+    if (window.top.frames.main) {
+      win = window.top.frames.main;
+      var title = $('html head title', win.document).text();
+      $('html head title', window.parent.document).text(title);
+    }
+    if (this.tagName.toLowerCase() == "a") {
+      clicked = $(this).parent('li').addClass('clicked');
+      win.location = this.href;
+    }
+    else {
+      clicked = $(this).addClass('clicked');
+      win.location = $(this).find('a:last').attr('href');
+    }
+    return false;
+  });
+}
+
+function collapse() {
+  if (!$('#full_list').hasClass('class')) return;
+  $('#full_list.class a.toggle').click(function() { 
+    $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
+    highlight();
+    return false; 
+  });
+  $('#full_list.class ul').each(function() {
+    $(this).addClass('collapsed').prev().addClass('collapsed');
+  });
+  $('#full_list.class').children().removeClass('collapsed');
+  highlight();
+}
+
+function highlight(no_padding) {
+  var n = 1;
+  $('#full_list li:visible').each(function() {
+    var next = n == 1 ? 2 : 1;
+    $(this).removeClass("r" + next).addClass("r" + n);
+    if (!no_padding && $('#full_list').hasClass('class')) {
+      $(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
+    }
+    n = next;
   });
 }
 
 $(fullListSearch);
-$(linkList);
+$(linkList);
+$(collapse);