yard 0.9.16 → 0.9.17

data/templates/default/layout/dot/header.erb

@@ -1,6 +1,6 @@
-digraph yard {
-  graph [rankdir=BT rank=sink outputMode=nodesfirst packMode="graph" splines=true];
-  node [shape=record rank=sink rankType=sink];
-
-  <%= yieldall %>
+digraph yard {
+  graph [rankdir=BT rank=sink outputMode=nodesfirst packMode="graph" splines=true];
+  node [shape=record rank=sink rankType=sink];
+
+  <%= yieldall %>
 }

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

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-attr_reader :contents
-
-def init
-  if object
-    type = object.root? ? :module : object.type
-    sections :header, [T(type)]
-  else
-    sections :header, [:contents]
-  end
-end
-
-def header
-  tidy erb(:header)
-end
+# frozen_string_literal: true
+attr_reader :contents
+
+def init
+  if object
+    type = object.root? ? :module : object.type
+    sections :header, [T(type)]
+  else
+    sections :header, [:contents]
+  end
+end
+
+def header
+  tidy erb(:header)
+end

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

@@ -1,11 +1,11 @@
-<div id="menu">
-  <% if @contents || @file %>
-    <% if object != '_index.html' %><a href="<%= url_for_index %>">Index</a> &raquo; <% end %>
-    <span class="title"><%= @breadcrumb_title %></span>
-  <% elsif object.is_a?(CodeObjects::Base) %>
-    <a href="<%= url_for_index %>"><% if object.root? || object.type == :method %>Index<% else %>Index (<%= object.name.to_s[0,1] %>)<% end %></a> &raquo;
-    <%= @breadcrumb.map {|obj| "<span class='title'>" + linkify(obj, obj.name) + "</span>" }.join(" &raquo; ") %>
-    <%= @breadcrumb.size > 0 ? " &raquo; " : "" %>
-    <span class="title"><%= object.root? ? "Top Level Namespace" : object.name(true) %></span>
-  <% end %>
-</div>
+<div id="menu">
+  <% if @contents || @file %>
+    <% if object != '_index.html' %><a href="<%= url_for_index %>">Index</a> &raquo; <% end %>
+    <span class="title"><%= @breadcrumb_title %></span>
+  <% elsif object.is_a?(CodeObjects::Base) %>
+    <a href="<%= url_for_index %>"><% if object.root? || object.type == :method %>Index<% else %>Index (<%= object.name.to_s[0,1] %>)<% end %></a> &raquo;
+    <%= @breadcrumb.map {|obj| "<span class='title'>" + linkify(obj, obj.name) + "</span>" }.join(" &raquo; ") %>
+    <%= @breadcrumb.size > 0 ? " &raquo; " : "" %>
+    <span class="title"><%= object.root? ? "Top Level Namespace" : object.name(true) %></span>
+  <% end %>
+</div>

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

@@ -1,11 +1,11 @@
-<% if @files && @files.size > 0 %>
-  <h2>File Listing</h2>
-  <ul id="files" class="index_inline_list">
-  <% n = 1 %>
-  <% @files.each_with_index do |file, i| %>
-    <li class="r<%= n %>"><%= link_file(file) %></li>
-    <% n = n == 2 ? 1 : 2 %>
-  <% end %>
-  </ul>
-<% end %>
-<div class="clear"></div>
+<% if @files && @files.size > 0 %>
+  <h2>File Listing</h2>
+  <ul id="files" class="index_inline_list">
+  <% n = 1 %>
+  <% @files.each_with_index do |file, i| %>
+    <li class="r<%= n %>"><%= link_file(file) %></li>
+    <% n = n == 2 ? 1 : 2 %>
+  <% end %>
+  </ul>
+<% end %>
+<div class="clear"></div>

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

@@ -1,5 +1,5 @@
-<div id="footer">
-  Generated on <%= Time.now.strftime("%c") %> by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
-</div>
+<div id="footer">
+  Generated on <%= Time.now.strftime("%c") %> by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
+</div>

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

@@ -1,15 +1,15 @@
-<meta charset="<%= charset %>">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  <%= h @page_title %>
-  <% if options.title && @page_title != options.title %>
-    &mdash; <%= h options.title %>
-  <% end %>
-</title>
-<% stylesheets.each do |stylesheet| %>
-  <link rel="stylesheet" href="<%= mtime_url(stylesheet) %>" type="text/css" charset="utf-8" />
-<% end %>
-<%= erb :script_setup %>
-<% javascripts.each do |javascript| %>
-  <script type="text/javascript" charset="utf-8" src="<%= mtime_url(javascript) %>"></script>
-<% end %>
+<meta charset="<%= charset %>">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  <%= h @page_title %>
+  <% if options.title && @page_title != options.title %>
+    &mdash; <%= h options.title %>
+  <% end %>
+</title>
+<% stylesheets.each do |stylesheet| %>
+  <link rel="stylesheet" href="<%= mtime_url(stylesheet) %>" type="text/css" charset="utf-8" />
+<% end %>
+<%= erb :script_setup %>
+<% javascripts.each do |javascript| %>
+  <script type="text/javascript" charset="utf-8" src="<%= mtime_url(javascript) %>"></script>
+<% end %>

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

@@ -1,2 +1,2 @@
-<h1 class="noborder title"><%= options.title %></h1>
-<%= yieldall %>
+<h1 class="noborder title"><%= options.title %></h1>
+<%= yieldall %>

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

@@ -1,24 +1,24 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <%= erb(:headers) %>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="<%= @nav_url %>?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <%= erb(:breadcrumb) %>
-        <%= erb(:search) %>
-        <div class="clear"></div>
-      </div>
-
-      <div id="content"><%= yieldall %></div>
-
-      <%= erb(:footer) %>
-    </div>
-  </body>
+<!DOCTYPE html>
+<html>
+  <head>
+    <%= erb(:headers) %>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="<%= @nav_url %>?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <%= erb(:breadcrumb) %>
+        <%= erb(:search) %>
+        <div class="clear"></div>
+      </div>
+
+      <div id="content"><%= yieldall %></div>
+
+      <%= erb(:footer) %>
+    </div>
+  </body>
 </html>

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

@@ -1,4 +1,4 @@
-<div id="listing">
-  <h1 class="alphaindex">Alphabetic Index</h1>
-  <%= yieldall %>
-</div>
+<div id="listing">
+  <h1 class="alphaindex">Alphabetic Index</h1>
+  <%= yieldall %>
+</div>

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

@@ -1,32 +1,32 @@
-<h2>Namespace Listing A-Z</h2>
-
-<% if Registry.root.meths(:included => false).size > 0 %>
-  <ul class="toplevel"><li><%= linkify(Registry.root) %></li></ul>
-<% end %>
-
-<% i = 0 %>
-<table>
-  <tr>
-    <td valign='top' width="33%">
-      <% @objects_by_letter.sort_by {|l,o| l.to_s }.each do |letter, objects| %>
-        <% if (i += 1) % 8 == 0 %>
-          </td><td valign='top' width="33%">
-          <% i = 0 %>
-        <% end %>
-        <ul id="alpha_<%= letter %>" class="alpha">
-          <li class="letter"><%= letter %></li>
-          <ul>
-            <% objects.each do |obj| %>
-              <li>
-                <%= linkify obj, obj.name %>
-                <% if !obj.namespace.root? %>
-                  <small>(<%= obj.namespace.path %>)</small>
-                <% end %>
-              </li>
-            <% end %>
-          </ul>
-        </ul>
-      <% end %>
-    </td>
-  </tr>
-</table>
+<h2>Namespace Listing A-Z</h2>
+
+<% if Registry.root.meths(:included => false).size > 0 %>
+  <ul class="toplevel"><li><%= linkify(Registry.root) %></li></ul>
+<% end %>
+
+<% i = 0 %>
+<table>
+  <tr>
+    <td valign='top' width="33%">
+      <% @objects_by_letter.sort_by {|l,o| l.to_s }.each do |letter, objects| %>
+        <% if (i += 1) % 8 == 0 %>
+          </td><td valign='top' width="33%">
+          <% i = 0 %>
+        <% end %>
+        <ul id="alpha_<%= letter %>" class="alpha">
+          <li class="letter"><%= letter %></li>
+          <ul>
+            <% objects.each do |obj| %>
+              <li>
+                <%= linkify obj, obj.name %>
+                <% if !obj.namespace.root? %>
+                  <small>(<%= obj.namespace.path %>)</small>
+                <% end %>
+              </li>
+            <% end %>
+          </ul>
+        </ul>
+      <% end %>
+    </td>
+  </tr>
+</table>

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

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

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

@@ -1,13 +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 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

@@ -1,89 +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
+# 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