yard 0.9.29 → 0.9.31

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

@@ -0,0 +1,4 @@
+<script type="text/javascript">
+  pathId = <%= @path ? @path.inspect : 'null' %>;
+  relpath = '<%= u = url_for(''); u + (u != '' ? '/' : '') %>';
+</script>

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

@@ -0,0 +1,13 @@
+<div id="search">
+  <% [menu_lists.first].each do |field| %>
+    <a class="full_list_link" id="<%= field[:type] %>_list_link"
+        href="<%= url_for_list(field[:type]) %>">
+
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+  <% end %>
+</div>

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+def init
+  @breadcrumb = []
+  @page_title = ''
+  @breadcrumb_title = ''
+  if @onefile
+    sections :layout
+  elsif defined?(@file) && @file
+    if @file.attributes[:namespace]
+      @object = options.object = Registry.at(@file.attributes[:namespace]) || Registry.root
+    end
+    @breadcrumb_title = "File: " + @file.title
+    @page_title = @breadcrumb_title
+    sections :layout, [:diskfile]
+  elsif @contents
+    sections :layout, [:contents]
+  else
+    case object
+    when '_index.html'
+      @page_title = options.title
+      sections :layout, [:index, [:listing, [:files, :objects]]]
+    when CodeObjects::Base
+      unless object.root?
+        cur = object.namespace
+        until cur.root?
+          @breadcrumb.unshift(cur)
+          cur = cur.namespace
+        end
+      end
+
+      @page_title = format_object_title(object)
+      type = object.root? ? :module : object.type
+      sections :layout, [T(type)]
+    end
+  end
+end
+
+attr_reader :contents
+
+def index
+  @objects_by_letter = {}
+  objects = Registry.all(:class, :module).sort_by {|o| o.name.to_s }
+  objects = run_verifier(objects)
+  objects.each {|o| (@objects_by_letter[o.name.to_s[0, 1].upcase] ||= []) << o }
+  erb(:index)
+end
+
+def layout
+  @nav_url = url_for_list(!(defined?(@file) && @file) || options.index ? 'class' : 'file')
+
+  @path =
+    if !object || object.is_a?(String)
+      nil
+    elsif defined?(@file) && @file
+      @file.path
+    elsif !object.is_a?(YARD::CodeObjects::NamespaceObject)
+      object.parent.path
+    else
+      object.path
+    end
+
+  erb(:layout)
+end
+
+def diskfile
+  @file.attributes[:markup] ||= markup_for_file('', @file.filename)
+  data = htmlify(@file.contents, @file.attributes[:markup])
+  "<div id='filecontents'>" + data + "</div>"
+end
+
+# @return [Array<String>] core javascript files for layout
+# @since 0.7.0
+def javascripts
+  %w(js/jquery.js js/app.js)
+end
+
+# @return [Array<String>] core stylesheets for the layout
+# @since 0.7.0
+def stylesheets
+  %w(css/style.css css/common.css)
+end
+
+# @return [Array<Hash{Symbol=>String}>] the list of search links and drop-down menus
+# @since 0.7.0
+def menu_lists
+  [{:type => 'class', :title => 'Classes', :search_title => 'Class List'},
+    {:type => 'method', :title => 'Methods', :search_title => 'Method List'},
+    {:type => 'file', :title => 'Files', :search_title => 'File List'}]
+end

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

@@ -0,0 +1,17 @@
+<h1>Method: <%= object.path %></h1>
+<div class="box_info">
+  <dl>
+    <dt class="">Defined in:</dt>
+    <dd class="">
+    <%= object.file %><% if object.files.size > 1 %><span class="defines">,<br />
+      <%= object.files[1..-1].map {|f| f.first }.join(",<br /> ") %></div>
+    <% end %>
+    </dd>
+  </dl>
+</div>
+
+<div class="method_details_list">
+  <div id="method_details">
+    <%= yieldall :index => 0 %>
+  </div>
+</div>

data/templates/default/method/setup.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+def init
+  sections :header, [T('method_details')]
+end

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

@@ -0,0 +1 @@
+<%= 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,25 @@
+<h3 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|
+      "<span id='#{anchor_for(o)}'>" + h(o.name.to_s) + "</span>" }.join(", ") %></span>
+    </span>
+  <% end %>
+
+  <% if owner != object.namespace %>
+    <span class="not_defined_here">
+      Originally defined in <%= object.namespace.type %>
+        <%= linkify object, owner.relative_path(object.namespace) %>
+    </span>
+  <% end %>
+</h3>

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 %>'<% if object.line %>, line <%= object.line %><% end %></span><%= "\n\n" %><%= html_syntax_highlight object.source %></pre>
+    </td>
+  </tr>
+</table>

data/templates/default/method_details/setup.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+def init
+  sections :header, [:method_signature, T('docstring'), :source]
+end
+
+def source
+  return if owner != object.namespace
+  return if Tags::OverloadTag === object
+  return if object.source.nil?
+  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,11 @@
+# frozen_string_literal: true
+def init
+  super
+  sections.last.pop
+end
+
+def format_object_title(object)
+  title = "Method: #{object.name(true)}"
+  title += " (#{object.namespace})" unless object.namespace.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/module/dot/header.erb

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

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

@@ -0,0 +1,14 @@
+<%= object.type %> <%= h object.name %>
+<% if options.full %>
+|
+<% object.attributes.each do |scope, list| %>
+<% 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).gsub(/=$/,'') %> [<%= 'R' if rw[:read] %><%= 'W' if rw[:write] %>]\l
+<% end %>
+<% end %>
+|
+<% 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 && obj.tag(:return).types.size > 0 %>\l
+<% end %>
+<% end %>

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+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, [T('module')], :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,10 @@
+<% scopes(attr_listing) do |list, scope| %>
+  <div id="<%= scope %>_attr_details" class="attr_details">
+    <h2><%= scope.to_s.capitalize %> Attribute Details</h2>
+    <% list.each_with_index do |meth, i| %>
+      <% rw = meth.attr_info %>
+      <span id="<%= anchor_for(rw[meth.reader? ? :write : :read]) %>"></span>
+      <%= yieldall :object => meth, :owner => object, :index => i %>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,8 @@
+<% groups(attr_listing, "Attribute") do |list, name| %>
+  <h2><%= name %> <small><a href="#" class="summary_toggle">collapse</a></small></h2>
+  <ul class="summary">
+    <% list.each do |meth| %>
+      <%= yieldall :item => meth %>
+    <% end %>
+  </ul>
+<% end %>

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

@@ -0,0 +1,43 @@
+<div class="box_info">
+  <% if CodeObjects::ClassObject === object && object.superclass %>
+  <dl>
+    <dt>Inherits:</dt>
+    <dd>
+      <span class="inheritName"><%= linkify object.superclass %></span>
+      <% if object.superclass.name != :BasicObject %>
+        <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>
+  </dl>
+  <% end %>
+
+  <% [[:class, "Extended by"], [:instance, "Includes"]].each do |scope, name| %>
+  <% if (mix = run_verifier(object.mixins(scope))).size > 0 %>
+  <dl>
+      <dt><%= name %>:</dt>
+      <dd><%= mix.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
+  </dl>
+  <% end %>
+  <% end %>
+
+  <% if (mixed_into = mixed_into(object)).size > 0 %>
+  <dl>
+    <dt>Included in:</dt>
+    <dd><%= mixed_into.sort_by {|o| o.path }.map {|o| linkify(o) }.join(", ") %></dd>
+  </dl>
+  <% end %>
+
+  <% unless object.root? %>
+  <dl>
+    <dt>Defined in:</dt>
+    <dd><%= erb(:defines) %></dd>
+  </dl>
+  <% end %>
+</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(true)) }.join(", ") %>
+    <% end %>
+  <% end %>
+</p>

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

@@ -0,0 +1,17 @@
+<% if constant_listing.size > 0 %>
+  <% groups(constant_listing, "Constant") do |list, name| %>
+    <h2>
+      <%= name %>
+      <small><a href="#" class="constants_summary_toggle">collapse</a></small>
+    </h2>
+
+    <dl class="constants">
+      <% list.each do |cnst| %>
+        <dt id="<%= anchor_for(cnst) %>" class="<%= cnst.has_tag?(:deprecated) ? 'deprecated' : '' %>"><%= cnst.name %> =
+          <%= yieldall :object => cnst %>
+        </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 ? 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/header.erb

@@ -0,0 +1,5 @@
+<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 %>
+  <% if object.has_tag?(:api) && object.tag(:api).text == 'private' %><span class="private note title">Private</span><% end %>
+</h1>

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

@@ -0,0 +1,14 @@
+<% found_method = false %>
+<% inherited_attr_list do |superclass, attribs| %>
+  <% if attr_listing.size == 0 && !found_method %><h2>Instance Attribute Summary</h2><% end %>
+  <% found_method = true %>
+  <h3 class="inherited">Attributes <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
+  <p class="inherited"><%= attribs.map do |method|
+      name = method.name(true).gsub(/=$/, '')
+      if superclass.type == :module && object.instance_mixins.include?(superclass)
+        name = "##{name}" unless name =~ /^#/
+      end
+      linkify(method, name)
+    end.join(", ")
+  %></p>
+<% end %>

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

@@ -0,0 +1,8 @@
+<% found_const = false %>
+<% inherited_constant_list do |superclass, consts| %>
+  <% if constant_listing.size == 0 && !found_const %><h2>Constant Summary</h2><% end %>
+  <% found_const = true %>
+  <h3 class="inherited">Constants <%= superclass.type == :class ? 'inherited' : 'included' %>
+     from <%= linkify superclass %></h3>
+  <p class="inherited"><%= consts.map {|c| linkify c }.join(", ") %></p>
+<% end %>

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

@@ -0,0 +1,19 @@
+<% 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? } %>
+  <% 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 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/item_summary.erb

@@ -0,0 +1,40 @@
+<li class="<%= @item.visibility %> <%= @item.has_tag?(:deprecated) ? 'deprecated' : '' %>">
+  <span class="summary_signature">
+    <% if @item.tags(:overload).size == 1 %>
+      <%= signature(@item.tag(:overload), true, false, !@item.attr_info) %>
+    <% else %>
+      <%= signature(@item, true, false, !@item.attr_info) %>
+    <% end %>
+
+    <% if @item.aliases.size > 0 %>
+      (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 !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?(: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,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, :owner => object, :index => i %>
+    <% end %>
+  </div>
+<% end %>

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

@@ -0,0 +1,14 @@
+<% if method_listing.size > 0 %>
+  <% groups(method_listing) do |list, name| %>
+    <h2>
+      <%= name %>
+      <small><a href="#" class="summary_toggle">collapse</a></small>
+    </h2>
+
+    <ul class="summary">
+      <% list.each do |meth| %>
+        <%= yieldall :item => meth %>
+      <% end %>
+    </ul>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,12 @@
+<div id="method_missing_details" class="method_details_list">
+  <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>