yard 0.2.3.5 → 0.4.0

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

@@ -1,3 +1,14 @@
-<div id="<%= anchor_for object %>" class="section <%= generator_name %>">
-  <%= yield object %>
-</div>
+<h1>Method: <%= object.path %></h1>
+<dl class="box">
+  <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>
+    <% end %>
+  </dd>
+</dl>
+<div class="clear"></div>
+
+<div id="method_details">
+  <%= yieldall :index => 0 %>
+</div>

data/templates/default/method/setup.rb

@@ -0,0 +1,3 @@
+def init
+  sections :header, [T('method_details')]
+end

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

@@ -1 +1 @@
-<%= yield object %>
+<%= yieldall %>

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

@@ -0,0 +1,3 @@
+<div class="method_details <%= @index == 0 ? 'first' : '' %>">
+  <%= yieldall %>
+</div>

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

@@ -0,0 +1,17 @@
+<p class="signature <%= 'first' if @index == 0 %>" id="<%= anchor_for(object) %>">
+  <% if object.tags(:overload).size == 1 %>
+    <%= signature(object.tag(:overload), false) %>
+  <% elsif object.tags(:overload).size > 1 %>
+    <% object.tags(:overload).each do |overload| %>
+      <span class="overload"><%= signature(overload, false) %></span>
+    <% end %>
+  <% else %>
+    <%= signature(object, false) %>
+  <% end %>
+
+  <% 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>
+  <% end %>
+</p>

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

@@ -0,0 +1,10 @@
+<table class="source_code">
+  <tr>
+    <td>
+      <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>
+    </td>
+  </tr>
+</table>

data/templates/default/method_details/setup.rb

@@ -0,0 +1,8 @@
+def init
+  sections :header, [:method_signature, T('docstring'), :source]
+end
+
+def source
+  return if object.tags(:overload).size > 1
+  erb(:source)
+end

data/templates/default/method_details/text/header.erb

@@ -0,0 +1,10 @@
+<%= title_align_right format_object_title(object) %>
+
+<%= align_right "(Defined in: #{object.file})" %>
+<% if object.aliases.size > 0 %>
+
+<%= align_right "(Also known as: #{object.aliases.map {|o| o.name(true).to_s }.join(',')})" %>
+<% end %>
+
+<%= yieldall %>
+

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

@@ -0,0 +1,12 @@
+
+<% if object.tags(:overload).size == 1 %>
+<%= indent wrap(signature(object.tag(:overload))) %>
+<% elsif object.tags(:overload).size > 1 %>
+<% object.tags(:overload).each do |overload| %>
+<%= indent wrap(signature(overload)) %>
+<% end %>
+<% else %>
+<%= indent wrap(signature(object)) %>
+<% end %>
+<%= hr %>
+

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

@@ -0,0 +1,10 @@
+def init
+  super
+  sections.last.pop
+end
+
+def format_object_title(object)
+  title = "Method: #{object.name(true)}"
+  title += " (#{object.namespace})" if object.namespace != Registry.root
+  title
+end

data/templates/default/module/dot/child.erb

@@ -0,0 +1 @@
+<%= format_path object %> [label="{<%= yieldall.gsub("\n", '') %>}" rank=sink];

data/templates/default/module/dot/dependencies.erb

@@ -0,0 +1,3 @@
+<% object.mixins(:instance).each do |obj| %>
+  <%= format_path object %> -> <%= format_path obj %> [style=dotted arrowType=none];
+<% end %>

data/templates/default/{uml/dot/subgraph.erb → module/dot/header.erb}

@@ -1,6 +1,6 @@
 subgraph cluster_<%= format_path object %> {
   label = "<%= h(object.name) unless object.path == "" %>"; labelloc=b;
-  <% for obj in namespaces(object) %>
-    <%= subgraph(obj, &block) %>
+  <% for obj in @modules %>
+    <%= yieldall :object => obj %>
   <% end %>
-}
+}

data/templates/default/{uml → module}/dot/info.erb

@@ -1,13 +1,13 @@
 <%= object.type %> <%= h object.name %>
-<% if show_full_info? %>
+<% if options[:full] %>
 |
 <% object.attributes.each do |scope, list| %>
-<% list.each do |name, rw| %>
-<%= uml_visibility(rw.values.compact.first) %> <%= h rw.values.compact.first.name(true) %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
+<% list.sort_by {|name, rw| name.to_s }.each do |name, rw| %>
+<%= uml_visibility(rw.values.compact.first) %> <%= h (rw[:read]||rw[:write]).name(true) %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
 <% end %>
 <% end %>
 |
-<% method_list(object).each do |obj| %>
+<% method_listing.each do |obj| %>
 <%= uml_visibility obj %> <%= h obj.name(true) %>
 <%= h(" : #{obj.tag(:return).types.first}") if obj.has_tag?(:return) && obj.tag(:return).types.size > 0 %>\l
 <% end %>

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

@@ -0,0 +1,14 @@
+def init
+  @modules = object.children.select {|o| o.type == :module }
+  @classes = object.children.select {|o| o.type == :class } 
+  sections :child, [:info], :classes, [T('class')], :header, [self.class], :dependencies
+end
+
+def dependencies
+  return unless options[:dependencies]
+  erb(:dependencies)
+end
+
+def classes
+  @classes.map {|k| yieldall :object => k }.join("\n")
+end

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

@@ -0,0 +1,11 @@
+<% if attr_listing.size > 0 %>
+  <div id="attr_details">
+    <h2>Attribute Details</h2>
+    <% attr_listing.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>
+      <%= yieldall :object => meth, :index => i %>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,8 @@
+<% if attr_listing.size > 0 %>
+  <h2>Attribute Summary</h2>
+  <ul class="summary">
+    <% attr_listing.each do |meth| %>
+      <%= yieldall :item => meth %>
+    <% end %>
+  </ul>
+<% end %>

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

@@ -0,0 +1,32 @@
+<% n = 1 %>
+<dl class="box">
+  <% if CodeObjects::ClassObject === object && object.superclass %>
+    <dt class="r<%=n%>">Inherits:</dt>
+    <dd class="r<%=n%>">
+      <span class="inheritName"><%= linkify object.superclass %></span>
+      <% if object.superclass.name != :Object %>
+        <ul class="fullTree">
+          <li><%= linkify P(:Object) %></li>
+          <% object.inheritance_tree.reverse.each_with_index do |obj, i| %>
+            <li class="next"><%= obj == object ? obj.path : linkify(obj) %></li>
+          <% end %>
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      <% end %>
+      </dd>
+    <% n = 2 %>
+  <% end %>
+  <% [[:class, "Extends"], [: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>
+      <% n = n == 2 ? 1 : 2 %>
+    <% end %>
+  <% end %>
+  <% unless object == Registry.root %>
+    <dt class="r<%=n%> last">Defined in:</dt>
+    <dd class="r<%=n%> last"><%= erb(:defines) %></dd>
+  <% end %>
+</dl>
+<div class="clear"></div>
+

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

@@ -0,0 +1,8 @@
+<h2>Defined Under Namespace</h2>
+<p class="children">
+  <% @inner.each do |name, list| %> 
+    <% if list.size > 0 %>
+      <strong class="<%= name %>"><%= name.to_s.capitalize %>:</strong> <%= list.map {|child| linkify(child, child.name) }.join(", ") %>
+    <% end %>
+  <% end %>
+</p>

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

@@ -0,0 +1,13 @@
+<% if constant_listing.size > 0 || object.constants.size > 0 %>
+  <h2>Constant Summary</h2>
+  <% if constant_listing.size > 0 %>
+    <dl class="constants">
+      <% constant_listing.each do |cnst| %>
+        <dt id="<%= anchor_for(cnst) %> <%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.name %> =
+            <span class="summary_desc"><%= htmlify_line docstring_summary(cnst) %></span>
+        </dt>
+        <dd><pre class="code"><%= format_constant cnst.value %></pre></dd>
+      <% end %>
+    </dl>
+  <% end %>
+<% end %>

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

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

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

@@ -1,4 +1,4 @@
-<div class="section module <%= object.path.gsub(/::|\.|#/, '_') %>">
-  <h1 class="title">Module: <%= h object.path %></h1>
-  <%= yield object %>
-</div>
+<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 %>
+</h1>

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

@@ -0,0 +1,8 @@
+<% 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.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>
+  <p class="inherited"><%= consts.sort_by {|o| o.name.to_s }.map {|m| linkify(m, m.name) }.join(", ") %></p>
+<% end %>

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

@@ -0,0 +1,9 @@
+<% 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.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 %>
+  <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>
+<% end %>

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

@@ -0,0 +1,20 @@
+<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>
+  <% 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 %>
+  <% end %>
+  <% 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?(:deprecated) %>
+    <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>
+  <% else %>
+    <span class="summary_desc"><%= htmlify_line docstring_summary(@item) %></span>
+  <% end %>
+</li>

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

@@ -0,0 +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| %>
+      <%= yieldall :object => meth, :index => i %>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,8 @@
+<% if method_listing.size > 0 %>
+  <h2>Method Summary</h2>
+  <ul class="summary">
+    <% method_listing.each do |meth| %>
+      <%= yieldall :item => meth %>
+    <% end %>
+  </ul>
+<% end %>

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

@@ -0,0 +1,12 @@
+<div id="method_missing_details">
+  <h2>Dynamic Method Handling</h2>
+  <p class="notice <%= @mm.namespace == object ? 'this' : 'super' %>">
+    This class handles dynamic methods through the <tt>method_missing</tt> method
+    <% if @mm.namespace != object %>
+      in the class <%= linkify @mm, @mm.namespace.path %>
+    <% end %>
+  </p>
+  <% if @mm.namespace == object %>
+    <%= yieldall :object => @mm, :index => 0 %>
+  <% end %>
+</div>

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

@@ -0,0 +1 @@
+<h2>Overview</h2>

data/templates/default/module/setup.rb

@@ -0,0 +1,83 @@
+include Helpers::ModuleHelper
+
+def init
+  sections :header, :box_info, :pre_docstring, T('docstring'), :children, 
+    :constant_summary, :inherited_constants, 
+    :attribute_summary, [:item_summary], 
+    :method_summary, [:item_summary], :inherited_methods,
+    :methodmissing, [T('method_details')],
+    :attribute_details, [T('method_details')], 
+    :method_details_list, [T('method_details')]
+end
+
+def pre_docstring
+  return if object.docstring.blank?
+  erb(:pre_docstring)
+end
+
+def children
+  @inner = [[:modules, []], [:classes, []]]
+  object.children.each do |child|
+    @inner[0][1] << child if child.type == :module
+    @inner[1][1] << child if child.type == :class
+  end
+  return if (@inner[0][1].size + @inner[1][1].size) == 0
+  @inner.map! {|v| [v[0], v[1].sort_by {|o| o.name.to_s }] }
+  erb(:children)
+end
+
+def methodmissing
+  mms = object.meths(:inherited => true, :included => true)
+  return unless @mm = mms.find {|o| o.name == :method_missing && o.scope == :instance }
+  erb(:methodmissing)
+end
+
+def method_listing(include_specials = true)
+  return @smeths ||= method_listing.reject {|o| special_methods.include? o.name(true) } unless include_specials
+  return @meths if @meths
+  @meths = object.meths(:inherited => false, :included => false)
+  @meths = sort_listing(prune_method_listing(@meths))
+  @meths
+end
+
+def special_methods
+  ["#initialize", "#method_missing"]
+end
+
+def attr_listing
+  return @attrs if @attrs
+  @attrs = []
+  [:class, :instance].each do |scope|
+    object.attributes[scope].each do |name, rw|
+      @attrs << (rw[:read] || rw[:write])
+    end
+  end
+  @attrs = sort_listing(prune_method_listing(@attrs, false))
+end
+
+def constant_listing
+  return @constants if @constants
+  @constants = object.constants(:included => false, :inherited => false)
+  @constants += object.cvars
+  @constants = run_verifier(@constants)
+  @constants
+end
+
+def sort_listing(list)
+  list.sort_by {|o| [o.scope, (options[:visibilities]||[]).index(o.visibility), o.name].join(":") }
+end
+
+def docstring_summary(obj)
+  docstring = ""
+  if obj.tags(:overload).size == 1 && obj.docstring.empty?
+    docstring = obj.tag(:overload).docstring
+  else
+    docstring = obj.docstring
+  end
+
+  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.summary
+end

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

@@ -0,0 +1,10 @@
+Defined Under Namespace:
+------------------------
+
+<% @inner.each do |name, list| %>
+<% if list.size > 0 %>
+<% text = list.map {|c| c.name }.join(", ") + " (#{name})" %>
+<%= indent(wrap(text)) %>
+
+<% end %>
+<% end %>

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

@@ -0,0 +1,8 @@
+<% if class_meths.size > 0 %>
+Class methods:
+--------------
+
+<%= indent wrap(class_meths.map {|o| o.name.to_s }.join(", "), 68) %>
+
+
+<% end %>

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

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