yard 0.7.5 → 0.8.0

data/templates/default/method_details/setup.rb

@@ -3,6 +3,7 @@ def init
 end
 
 def source
+  return if owner != object.namespace
   return if Tags::OverloadTag === object
   return if object.source.nil?
   erb(:source)

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

@@ -1,5 +1,5 @@
 <%= object.type %> <%= h object.name %>
-<% if options[:full] %>
+<% if options.full %>
 |
 <% object.attributes.each do |scope, list| %>
 <% list.sort_by {|name, rw| name.to_s }.each do |name, rw| %>

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

@@ -1,11 +1,11 @@
 def init
   @modules = object.children.select {|o| o.type == :module }
-  @classes = object.children.select {|o| o.type == :class } 
+  @classes = object.children.select {|o| o.type == :class }
   sections :child, [:info], :classes, [T('class')], :header, [T('module')], :dependencies
 end
 
 def dependencies
-  return unless options[:dependencies]
+  return unless options.dependencies
   erb(:dependencies)
 end
 

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

@@ -5,7 +5,7 @@
       <% rw = meth.attr_info %>
       <span id="<%= anchor_for(rw[:write]) %>"></span>
       <span id="<%= anchor_for(rw[:read]) %>"></span>
-      <%= yieldall :object => meth, :index => i %>
+      <%= yieldall :object => meth, :owner => object, :index => i %>
     <% end %>
   </div>
 <% end %>

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

@@ -1,6 +1,6 @@
 <h2>Defined Under Namespace</h2>
 <p class="children">
-  <% @inner.each do |name, list| %> 
+  <% @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 %>

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

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

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

@@ -1,6 +1,7 @@
 <% found_method = false %>
 <% object.inheritance_tree(true)[1..-1].each do |superclass| %>
   <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
+  <% next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != 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? } %>
@@ -8,11 +9,11 @@
   <% 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 do |m| 
+  <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(", ") 
+      linkify(m, name)
+    end.join(", ")
   %></p>
 <% end %>

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

@@ -10,17 +10,27 @@
       (also: <%= @item.aliases.map {|o| h(o.name(true)) }.join(", ") %>)
     <% end %>
   </span>
+  <% if object != @item.namespace %>
+    <span class="note title not_defined_here">
+      <%= @item.namespace.type == :class ? 'inherited' : (@item.scope == :class ? 'extended' : 'included') %>
+      from <%= linkify @item, object.relative_path(@item.namespace) %>
+    </span>
+  <% end %>
   <% if @item.constructor? %>
     <span class="note title constructor">constructor</span>
   <% end %>
   <% if rw = @item.attr_info %>
-    <% 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 %>
+    <% if !run_verifier([rw[:read]].compact).empty? && run_verifier([rw[:write]].compact).empty? %>
+      <span class="note title readonly">readonly</span>
+    <% end %>
+    <% if !run_verifier([rw[:write]].compact).empty? && run_verifier([rw[:read]].compact).empty? %>
+      <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?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">Private</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?(:api) && @item.tag(:api).text == 'private' %><span class="private note title">private</span><% end %>
 
   <% if @item.has_tag?(:deprecated) %>
     <span class="summary_desc"><strong>Deprecated.</strong> <%= htmlify_line @item.tag(:deprecated).text %></span>

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

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

data/templates/default/module/setup.rb

@@ -1,12 +1,12 @@
 include Helpers::ModuleHelper
 
 def init
-  sections :header, :box_info, :pre_docstring, T('docstring'), :children, 
-    :constant_summary, [T('docstring')], :inherited_constants, 
+  sections :header, :box_info, :pre_docstring, T('docstring'), :children,
+    :constant_summary, [T('docstring')], :inherited_constants,
     :attribute_summary, [:item_summary], :inherited_attributes,
     :method_summary, [:item_summary], :inherited_methods,
     :methodmissing, [T('method_details')],
-    :attribute_details, [T('method_details')], 
+    :attribute_details, [T('method_details')],
     :method_details_list, [T('method_details')]
 end
 
@@ -35,7 +35,10 @@ end
 def method_listing(include_specials = true)
   return @smeths ||= method_listing.reject {|o| special_method?(o) } unless include_specials
   return @meths if @meths
-  @meths = object.meths(:inherited => false, :included => false)
+  @meths = object.meths(:inherited => false, :included => !options.embed_mixins.empty?)
+  if options.embed_mixins.size > 0
+    @meths = @meths.reject {|m| options.embed_mixins_match?(m.namespace) == false }
+  end
   @meths = sort_listing(prune_method_listing(@meths))
   @meths
 end
@@ -49,12 +52,19 @@ 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])
+  object.inheritance_tree(true).each do |superclass|
+    next if superclass.is_a?(CodeObjects::Proxy)
+    next if options.embed_mixins.size > 0 &&
+      options.embed_mixins_match?(superclass) == false
+    [:class, :instance].each do |scope|
+      superclass.attributes[scope].each do |name, rw|
+        attr = prune_method_listing([rw[:read], rw[:write]].compact, false).first
+        @attrs << attr if attr
+      end
     end
+    break if options.embed_mixins.empty?
   end
-  @attrs = sort_listing(prune_method_listing(@attrs, false))
+  @attrs = sort_listing(@attrs)
 end
 
 def constant_listing
@@ -72,6 +82,7 @@ end
 def inherited_attr_list(&block)
   object.inheritance_tree(true)[1..-1].each do |superclass|
     next if superclass.is_a?(YARD::CodeObjects::Proxy)
+    next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false
     attribs = superclass.attributes[:instance]
     attribs = attribs.reject {|name, rw| object.child(:scope => :instance, :name => name) != nil }
     attribs = attribs.sort_by {|args| args.first.to_s }.map {|n, m| m[:read] || m[:write] }
@@ -83,6 +94,7 @@ end
 def inherited_constant_list(&block)
   object.inheritance_tree(true)[1..-1].each do |superclass|
     next if superclass.is_a?(YARD::CodeObjects::Proxy)
+    next if options.embed_mixins.size > 0 && options.embed_mixins_match?(superclass) != false
     consts = superclass.constants(:included => false, :inherited => false)
     consts = consts.reject {|const| object.child(:type => :constant, :name => const.name) != nil }
     consts = consts.sort_by {|const| const.name.to_s }
@@ -102,7 +114,7 @@ def docstring_full(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
 
@@ -112,7 +124,8 @@ end
 
 def groups(list, type = "Method")
   if groups_data = object.groups
-    others = list.select {|m| !m.group }
+    list.each {|m| groups_data |= [m.group] if m.group && owner != m.namespace }
+    others = list.select {|m| !m.group || !groups_data.include?(m.group) }
     groups_data.each do |name|
       items = list.select {|m| m.group == name }
       yield(items, name) unless items.empty?
@@ -129,7 +142,7 @@ def groups(list, type = "Method")
     end
     group_data.each {|group, items| yield(items, group) unless items.empty? }
   end
-  
+
   scopes(others) {|items, scope| yield(items, "#{scope.to_s.capitalize} #{type} Summary") }
 end
 
@@ -146,6 +159,6 @@ def mixed_into(object)
     list = run_verifier Registry.all(:class, :module)
     list.each {|o| o.mixins.each {|m| (globals.mixed_into[m.path] ||= []) << o } }
   end
-  
+
   globals.mixed_into[object.path] || []
 end

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

@@ -1,5 +1,5 @@
 def init
-  sections :header, [T('docstring')], :children, :includes, :extends, 
+  sections :header, [T('docstring')], :children, :includes, :extends,
     :class_meths_list, :instance_meths_list
 end
 

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

@@ -16,7 +16,7 @@
       <h1><%= @title %></h1>
       <%= yieldall %>
     </div>
-    
+
     <%= erb(:footer) %>
   </body>
 </html>

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

@@ -2,7 +2,7 @@ include T('default/layout/html')
 include YARD::Parser::Ruby::Legacy
 
 def init
-  override_serializer  
+  override_serializer
   @object = YARD::Registry.root
   @files.shift
   @objects.delete(YARD::Registry.root)
@@ -34,7 +34,7 @@ def override_serializer
       return unless object == 'index.html'
       super
     end
-    
+
     def serialized_path(object)
       return object if object.is_a?(String)
       return 'index.html'

data/templates/default/tags/html/example.erb

@@ -1,8 +1,10 @@
 <% if object.has_tag?(:example) %>
   <div class="examples">
-    <h3>Examples:</h3>
+    <p class="tag_title">Examples:</p>
     <% object.tags(:example).each do |tag| %>
-      <h4><%= htmlify_line(tag.name) %></h4>
+      <% unless tag.name.empty? %>
+        <p class="example_title"><%= htmlify_line(tag.name) %></p>
+      <% end %>
       <pre class="example code"><%= html_syntax_highlight(tag.text) %></pre>
     <% end %>
   </div>

data/templates/default/tags/html/option.erb

@@ -2,7 +2,7 @@
   <% object.parameters.each do |param, default| %>
     <% tags = object.tags(:option).select {|x| x.name.to_s == param.to_s } %>
     <% next if tags.empty? %>
-    <h3>Options Hash (<tt><%= param %></tt>):</h3>
+    <p class="tag_title">Options Hash (<tt><%= param %></tt>):</p>
     <ul class="option">
       <% for tag in tags %>
         <li>

data/templates/default/tags/html/overload.erb

@@ -1,7 +1,7 @@
 <% if object.tags(:overload).size == 1 %>
   <%= yieldall :object => object.tag(:overload) %>
 <% elsif object.has_tag?(:overload) && object.tags(:overload).any? {|o| !o.docstring.blank? } %>
-  <h3>Overloads:</h3>
+  <p class="tag_title">Overloads:</p>
   <ul class="overload">
     <% object.tags(:overload).each do |overload| %>
       <% next if overload.docstring.blank? %>

data/templates/default/tags/html/see.erb

@@ -1,5 +1,5 @@
 <% if object.has_tag?(:see) %>
-  <h3>See Also:</h3>
+  <p class="tag_title">See Also:</p>
   <ul class="see">
     <% for tag in object.tags(:see) %>
       <li><%= linkify(tag.name, tag.text) %></li>

data/templates/default/tags/html/tag.erb

@@ -1,4 +1,4 @@
-<h3><%= @label ? @label : YARD::Tags::Library.labels[@name] %>:</h3>
+<p class="tag_title"><%= @label ? @label : YARD::Tags::Library.labels[@name] %>:</p>
 <ul class="<%= @name %>">
   <% object.tags(@name).each do |tag| %>
     <li>

data/templates/default/tags/setup.rb

@@ -1,7 +1,7 @@
 def init
   tags = Tags::Library.visible_tags - [:abstract, :deprecated, :note, :todo]
   create_tag_methods(tags - [:example, :option, :overload, :see])
-  sections :index, tags
+  sections :index, tags.map {|t| t.to_s.gsub('.', '_').to_sym }
   sections.any(:overload).push(T('docstring'))
 end
 
@@ -32,9 +32,10 @@ end
 
 def create_tag_methods(tags)
   tags.each do |tag|
-    next if respond_to?(tag)
+    tag_meth = tag.to_s.gsub('.', '_')
+    next if respond_to?(tag_meth)
     instance_eval(<<-eof, __FILE__, __LINE__ + 1)
-      def #{tag}; tag(#{tag.inspect}) end
+      def #{tag_meth}; tag(#{tag.inspect}) end
     eof
   end
 end

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

@@ -56,8 +56,8 @@ a:hover { color: #060; background: #8e0; }
 #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, 
-.tags pre.example { 
+#filecontents pre.code, .docstring pre.code,
+.tags pre.example {
   font-size: 0.9em;
   padding: 7px 30px;
   margin: 15px -30px;
@@ -73,21 +73,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/guide/fulldoc/html/js/app.js

@@ -16,13 +16,13 @@ function generateTOC() {
       if ($('#' + proposedId).length > 0) proposedId += counter++;
       this.id = proposedId;
     }
-    if (thisTag > lastTag) { 
-      for (var i = 0; i < thisTag - lastTag; i++) { 
-        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp; 
-      } 
+    if (thisTag > lastTag) {
+      for (var i = 0; i < thisTag - lastTag; i++) {
+        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+      }
     }
-    if (thisTag < lastTag) { 
-      for (var i = 0; i < lastTag - thisTag; i++) toc = toc.parent(); 
+    if (thisTag < lastTag) {
+      for (var i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
     }
     toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
     lastTag = thisTag;

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

@@ -11,7 +11,7 @@ end
 Template.extra_includes << OverrideFileLinks
 
 def init
-  class << options[:serializer]
+  class << options.serializer
     def serialized_path(object)
       if CodeObjects::ExtraFileObject === object
         super.sub(/^file\./, '')
@@ -19,12 +19,12 @@ def init
         super
       end
     end
-  end if options[:serializer]
-  
+  end if options.serializer
+
   generate_assets
   options.delete(:objects)
-  options[:files].each {|file| serialize_file(file) }
-  serialize_file(options[:readme])
+  options.files.each {|file| serialize_file(file) }
+  serialize_file(options.readme)
 end
 
 def generate_assets
@@ -34,19 +34,19 @@ def generate_assets
 end
 
 def serialize_file(file)
-  index = options[:files].index(file)
+  index = options.files.index(file)
   outfile = file.name + '.html'
-  options[:file] = file
+  options.file = file
   if file.attributes[:namespace]
-    options[:object] = Registry.at(file.attributes[:namespace])
+    options.object = Registry.at(file.attributes[:namespace])
   end
-  options[:object] ||= Registry.root
+  options.object ||= Registry.root
 
-  if file == options[:readme]
+  if file == options.readme
     serialize_index(options)
   else
-    serialize_index(options) if !options[:readme] && index == 0
-    Templates::Engine.with_serializer(outfile, options[:serializer]) do
+    serialize_index(options) if !options.readme && index == 0
+    Templates::Engine.with_serializer(outfile, options.serializer) do
       T('layout').run(options)
     end
   end