yard 0.5.3 → 0.5.4

data/spec/templates/helpers/method_helper_spec.rb

@@ -4,6 +4,34 @@ describe YARD::Templates::Helpers::MethodHelper do
   include YARD::Templates::Helpers::BaseHelper
   include YARD::Templates::Helpers::MethodHelper
   
+  describe '#format_args' do
+    it "should not show &blockarg if no @param tag and has @yield" do
+      YARD.parse_string <<-'eof'
+        # @yield blah
+        def foo(&block); end
+      eof
+      format_args(Registry.at('#foo')).should == ''
+    end
+
+    it "should not show &blockarg if no @param tag and has @yieldparam" do
+      YARD.parse_string <<-'eof'
+        # @yieldparam blah test
+        def foo(&block); end
+      eof
+      format_args(Registry.at('#foo')).should == ''
+    end
+    
+    it "should show &blockarg if @param block is documented (even with @yield)" do
+      YARD.parse_string <<-'eof'
+        # @yield [a,b]
+        # @yieldparam a test
+        # @param block test
+        def foo(&block) end
+      eof
+      format_args(Registry.at('#foo')).should == '(&block)'
+    end
+  end
+  
   describe '#format_block' do
     before { YARD::Registry.clear }
     

data/spec/templates/module_spec.rb

@@ -1,6 +1,6 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe YARD::Templates::Engine.template(:default, :method) do
+describe YARD::Templates::Engine.template(:default, :module) do
   before do 
     Registry.clear
     YARD.parse_string <<-'eof'
@@ -47,10 +47,19 @@ describe YARD::Templates::Engine.template(:default, :method) do
         class Q; end
         class X; end
         module Z; end
+        # A long docstring for the constant. With extra text
+        # and newlines.
         CONSTANT = 'value'
         @@cvar = 'value' # @deprecated
       end
+      
+      module TMP; include A end
+      class TMP2; extend A end
     eof
+    
+    # Hack to clear mixin list
+    mod = YARD::Templates::Engine.template(:default, :module)
+    mod.send(:class_variable_set, "@@mixed_into", nil)
   end
 
   it "should render html format correctly" do

data/spec/templates/template_spec.rb

@@ -4,6 +4,10 @@ describe YARD::Templates::Template do
   def template(path)
     YARD::Templates::Engine.template!(path, '/full/path/' + path.to_s)
   end
+
+  before :each do
+    YARD::Templates::ErbCache.clear!
+  end
   
   describe '.include_parent' do
     it "should not include parent directory if parent directory is a template root path" do

data/templates/default/class/setup.rb

@@ -3,13 +3,13 @@ include T('default/module')
 def init
   super
   sections.place(:subclasses).before(:children)
-  sections.delete(:children)
   sections.place([:constructor_details, [T('method_details')]]).before(:methodmissing)
 end
 
 def constructor_details
   ctors = object.meths(:inherited => true, :included => true)
   return unless @ctor = ctors.find {|o| o.name == :initialize }
+  return if prune_method_listing([@ctor]).empty?
   erb(:constructor_details)
 end
 

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

@@ -16,6 +16,8 @@ h2 {
   margin: 1.8em 0 0.5em;
 }
 .clear { clear: both; }
+.inline { display: inline; }
+.inline p:first-child { display: inline; }
 .docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
 .docstring h1 { font-size: 1.2em; }
 .docstring h2 { font-size: 1.1em; }
@@ -95,7 +97,9 @@ dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-b
 
 .summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
 .summary_desc tt { font-size: 0.9em; }
-dl.constants .summary_desc { font-size: 0.9em; font-weight: normal; }
+dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
+dl.constants .discussion *:first-child { margin-top: 0; }
+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; }
@@ -194,6 +198,7 @@ ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; di
 
 #menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
 #menu .title, #menu a { font-size: 0.7em; }
+#menu .title a { font-size: 1em; }
 #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; }

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

@@ -3,7 +3,7 @@
 
 <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"/>
+	<meta http-equiv="Content-Type" content="text/html; charset=<%= charset %>"/>
 	<title><%= options[:title] %></title>
 </head>
 <frameset cols="20%,*">

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

@@ -2,7 +2,7 @@
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html>
   <head>
-    <meta name="Content-Type" content="text/html; charset=UTF-8" />
+    <meta name="Content-Type" content="text/html; charset=<%= charset %>" />
     <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
     <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>

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

@@ -90,6 +90,17 @@ function framesInit() {
   }
 }
 
+function keyboardShortcuts() {
+  $(document).keypress(function(evt) {
+    if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
+    switch (evt.charCode) {
+      case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
+      case 77: case 109: $('#method_list_link').click(); break; // 'm'
+      case 70: case 102: $('#file_list_link').click(); break;   // 'f'
+    }
+  });
+}
+
 $(framesInit);
 $(createSourceLinks);
 $(createDefineLinks);
@@ -97,3 +108,4 @@ $(createFullTreeLinks);
 $(fixBoxInfoHeights);
 $(searchFrameLinks);
 $(linkSummaries);
+$(keyboardShortcuts);

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

@@ -101,6 +101,17 @@ function highlight(no_padding) {
   });
 }
 
+function escapeShortcut() {
+  $(document).keydown(function(evt) {
+    if (evt.which == 27) {
+      $('#search_frame', window.top.document).slideUp(100);
+      $('#search a', window.top.document).removeClass('active inactive')
+      $(window.top).focus();
+    }
+  });
+}
+
+$(escapeShortcut);
 $(fullListSearch);
 $(linkList);
 $(collapse);

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

@@ -82,6 +82,7 @@ def generate_method_list
 end
 
 def generate_class_list
+  @items = options[:objects]
   @list_title = "Class List"
   @list_type = "class"
   asset('class_list.html', erb(:full_list))
@@ -104,7 +105,7 @@ def class_list(root = Registry.root)
   out = ""
   children = run_verifier(root.children)
   if root == Registry.root
-    children += Registry.all(:class, :module).select {|o| o.namespace.is_a?(CodeObjects::Proxy) }
+    children += @items.select {|o| o.namespace.is_a?(CodeObjects::Proxy) }
   end
   children.sort_by {|child| child.path }.map do |child|
     if child.is_a?(CodeObjects::NamespaceObject)

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

@@ -1,4 +1,4 @@
-<meta name="Content-Type" content="text/html; charset=UTF-8" />
+<meta name="Content-Type" content="text/html; charset=<%= charset %>" />
 <title><%= @page_title %></title>
 <link rel="stylesheet" href="<%= url_for("css/style.css") %>" type="text/css" media="screen" charset="utf-8" />
 <link rel="stylesheet" href="<%= url_for("css/common.css") %>" type="text/css" media="screen" charset="utf-8" />

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

@@ -51,7 +51,7 @@ def diskfile
     "<pre>#{@contents}</pre>"
   when 'textile', 'txtile'
     htmlify(@contents, :textile)
-  when 'markdown', 'md', 'mdown'
+  when 'markdown', 'md', 'mdown', 'mkd'
     htmlify(@contents, :markdown)
   else
     htmlify(@contents, diskfile_shebang_or_default)

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

@@ -23,6 +23,11 @@
       <% n = n == 2 ? 1 : 2 %>
     <% end %>
   <% end %>
+  <% if (mixed_into = mixed_into(object)).size > 0 %>
+    <dt class="r<%=n%>">Included in:</dt>
+    <dd class="r<%=n%>"><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
+    <% n = n == 2 ? 1 : 2 %>
+  <% end %>
   <% unless object.root? %>
     <dt class="r<%=n%> last">Defined in:</dt>
     <dd class="r<%=n%> last"><%= erb(:defines) %></dd>

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

@@ -4,7 +4,7 @@
     <dl class="constants">
       <% constant_listing.each do |cnst| %>
         <dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.name %> =
-            <span class="summary_desc"><%= htmlify_line docstring_summary(cnst) %></span>
+          <%= yieldall :object => cnst %>
         </dt>
         <dd><pre class="code"><%= format_constant cnst.value %></pre></dd>
       <% end %>

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

@@ -1,9 +1,18 @@
+<% found_method = false %>
 <% object.inheritance_tree(true)[1..-1].each do |superclass| %>
   <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
   <% 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 %>
+  <% if method_listing.size == 0 && !found_method %><h2>Method Summary</h2><% end %>
+  <% found_method = true %>
   <h3 class="inherited">Methods <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
-  <p class="inherited"><%= meths.sort_by {|o| o.name.to_s }.map {|m| linkify(m, m.name(true)) }.join(", ") %></p>
+  <p class="inherited"><%= 
+    meths.sort_by {|o| o.name.to_s }.map do |m| 
+      name = m.name(true)
+      name = name.gsub(/^#/,'') if superclass.type == :module && object.class_mixins.include?(superclass)
+      linkify(m, name) 
+    end.join(", ") 
+  %></p>
 <% end %>

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

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

data/templates/default/module/setup.rb

@@ -2,7 +2,7 @@ include Helpers::ModuleHelper
 
 def init
   sections :header, :box_info, :pre_docstring, T('docstring'), :children, 
-    :constant_summary, :inherited_constants, 
+    :constant_summary, [T('docstring')], :inherited_constants, 
     :attribute_summary, [:item_summary], 
     :method_summary, [:item_summary], :inherited_methods,
     :methodmissing, [T('method_details')],
@@ -69,7 +69,7 @@ def sort_listing(list)
   list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
 end
 
-def docstring_summary(obj)
+def docstring_full(obj)
   docstring = ""
   if obj.tags(:overload).size == 1 && obj.docstring.empty?
     docstring = obj.tag(:overload).docstring
@@ -80,8 +80,12 @@ def docstring_summary(obj)
   if docstring.summary.empty? && obj.tags(:return).size == 1 && obj.tag(:return).text
     docstring = Docstring.new(obj.tag(:return).text.gsub(/\A([a-z])/) {|x| x.upcase }.strip)
   end
+  
+  docstring
+end
 
-  docstring.summary
+def docstring_summary(obj)
+  docstring_full(obj).summary
 end
 
 def scopes(list)
@@ -90,3 +94,13 @@ def scopes(list)
     yield(items, scope) unless items.empty?
   end
 end
+
+def mixed_into(object)
+  unless defined?(@@mixed_into) && @@mixed_into
+    @@mixed_into = {}
+    list = run_verifier Registry.all(:class, :module)
+    list.each {|o| o.mixins.each {|m| (@@mixed_into[m.path] ||= []) << o } }
+  end
+  
+  @@mixed_into[object.path] || []
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: yard
 version: !ruby/object:Gem::Version 
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors: 
 - Loren Segal
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-11 00:00:00 -05:00
+date: 2010-03-22 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -79,6 +79,7 @@ files:
 - lib/yard/handlers/ruby/legacy/alias_handler.rb
 - lib/yard/handlers/ruby/legacy/attribute_handler.rb
 - lib/yard/handlers/ruby/legacy/base.rb
+- lib/yard/handlers/ruby/legacy/class_condition_handler.rb
 - lib/yard/handlers/ruby/legacy/class_handler.rb
 - lib/yard/handlers/ruby/legacy/class_variable_handler.rb
 - lib/yard/handlers/ruby/legacy/constant_handler.rb
@@ -87,12 +88,14 @@ files:
 - lib/yard/handlers/ruby/legacy/method_handler.rb
 - lib/yard/handlers/ruby/legacy/mixin_handler.rb
 - lib/yard/handlers/ruby/legacy/module_handler.rb
+- lib/yard/handlers/ruby/legacy/process_handler.rb
 - lib/yard/handlers/ruby/legacy/visibility_handler.rb
 - lib/yard/handlers/ruby/legacy/yield_handler.rb
 - lib/yard/handlers/ruby/method_condition_handler.rb
 - lib/yard/handlers/ruby/method_handler.rb
 - lib/yard/handlers/ruby/mixin_handler.rb
 - lib/yard/handlers/ruby/module_handler.rb
+- lib/yard/handlers/ruby/process_handler.rb
 - lib/yard/handlers/ruby/visibility_handler.rb
 - lib/yard/handlers/ruby/yield_handler.rb
 - lib/yard/logging.rb
@@ -122,6 +125,7 @@ files:
 - lib/yard/tags/tag.rb
 - lib/yard/tags/tag_format_error.rb
 - lib/yard/templates/engine.rb
+- lib/yard/templates/erb_cache.rb
 - lib/yard/templates/helpers/base_helper.rb
 - lib/yard/templates/helpers/filter_helper.rb
 - lib/yard/templates/helpers/html_helper.rb
@@ -172,6 +176,7 @@ files:
 - spec/handlers/examples/method_handler_001.rb.txt
 - spec/handlers/examples/mixin_handler_001.rb.txt
 - spec/handlers/examples/module_handler_001.rb.txt
+- spec/handlers/examples/process_handler_001.rb.txt
 - spec/handlers/examples/visibility_handler_001.rb.txt
 - spec/handlers/examples/yield_handler_001.rb.txt
 - spec/handlers/exception_handler_spec.rb
@@ -181,6 +186,7 @@ files:
 - spec/handlers/method_handler_spec.rb
 - spec/handlers/mixin_handler_spec.rb
 - spec/handlers/module_handler_spec.rb
+- spec/handlers/process_handler_spec.rb
 - spec/handlers/processor_spec.rb
 - spec/handlers/ruby/base_spec.rb
 - spec/handlers/ruby/legacy/base_spec.rb
@@ -214,6 +220,7 @@ files:
 - spec/templates/engine_spec.rb
 - spec/templates/examples/class001.html
 - spec/templates/examples/class001.txt
+- spec/templates/examples/class002.html
 - spec/templates/examples/method001.html
 - spec/templates/examples/method001.txt
 - spec/templates/examples/method002.html