yard 0.9.5 → 0.9.6

data/templates/default/class/setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 include T('default/module')
 
 def init
@@ -8,7 +9,8 @@ end
 
 def constructor_details
   ctors = object.meths(:inherited => true, :included => true)
-  return unless @ctor = ctors.find {|o| o.constructor? }
+  @ctor = ctors.find(&:constructor?)
+  return unless @ctor
   return if prune_method_listing([@ctor]).empty?
   erb(:constructor_details)
 end
@@ -25,12 +27,10 @@ def subclasses
 
   @subclasses = globals.subclasses[object.path]
   return if @subclasses.nil? || @subclasses.empty?
-  @subclasses = @subclasses.sort_by {|o| o.path }.map do |child|
+  @subclasses = @subclasses.sort_by(&:path).map do |child|
     name = child.path
-    if object.namespace
-      name = object.relative_path(child)
-    end
+    name = object.relative_path(child) if object.namespace
     [name, child]
   end
   erb(:subclasses)
-end
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 include T('default/module/text')
 
 def init
@@ -8,4 +9,4 @@ end
 
 def format_object_title(object)
   "Class: #{object.title} < #{object.superclass.title}"
-end
+end

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

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

data/templates/default/docstring/setup.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 def init
   return if object.docstring.blank? && !object.has_tag?(:api)
   sections :index, [:private, :deprecated, :abstract, :todo, :note, :returns_void, :text], T('tags')
@@ -42,10 +43,10 @@ def docstring_text
   end
 
   if text.strip.empty? && object.tags(:return).size == 1 && object.tag(:return).text
-    text = object.tag(:return).text.gsub(/\A([a-z])/) {|x| x.downcase }
+    text = object.tag(:return).text.gsub(/\A([a-z])/, &:downcase)
     text = "Returns #{text}" unless text.empty? || text =~ /^\s*return/i
-    text = text.gsub(/\A([a-z])/) {|x| x.upcase }
+    text = text.gsub(/\A([a-z])/, &:upcase)
   end
 
   text.strip
-end
+end

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

@@ -55,14 +55,30 @@ body {
 }
 
 @media (max-width: 920px) {
-  .nav_wrap { display: none; }
+  .nav_wrap { width: 100%; top: 0; right: 0; overflow: visible; position: absolute; }
+  #resizer { display: none; }
+  #nav {
+    z-index: 9999;
+    background: #fff;
+    display: none;
+    position: absolute;
+    top: 40px;
+    right: 12px;
+    width: 500px;
+    max-width: 80%;
+    height: 80%;
+    overflow-y: scroll;
+    border: 1px solid #999;
+    border-collapse: collapse;
+    box-shadow: -7px 5px 25px #aaa;
+    border-radius: 2px;
+  }
 }
 
 @media (min-width: 920px) {
   body { height: 100%; overflow: hidden; }
   #main { height: 100%; overflow: auto; }
   #search { display: none; }
-  #search_frame { display: none; }
 }
 
 #main img { max-width: 100%; }
@@ -108,6 +124,9 @@ h2 small a {
 }
 .rdoc-term { padding-right: 25px; font-weight: bold; }
 .rdoc-list p { margin: 0; padding: 0; margin-bottom: 4px; }
+.summary_desc pre.code .object_link a, .docstring pre.code .object_link a {
+  padding: 0px; background: inherit; color: inherit; border-radius: inherit;
+}
 
 /* style for <table> */
 #filecontents table, .docstring table { border-collapse: collapse; }
@@ -385,23 +404,6 @@ ul.fullTree li:last-child { padding-bottom: 0; }
 li.r1 { background: #f0f0f0; }
 li.r2 { background: #fafafa; }
 
-#search_frame {
-  z-index: 9999;
-  background: #fff;
-  display: none;
-  position: absolute;
-  top: 40px;
-  right: 12px;
-  width: 500px;
-  max-width: 80%;
-  height: 80%;
-  overflow-y: scroll;
-  border: 1px solid #999;
-  border-collapse: collapse;
-  box-shadow: -7px 5px 25px #aaa;
-  border-radius: 2px;
-}
-
 #content ul.summary li.deprecated .summary_signature a,
 #content ul.summary li.deprecated .summary_signature a:visited { text-decoration: line-through; font-style: italic; }
 
@@ -459,7 +461,10 @@ pre.code .info.file { color: #555; }
 pre.code .val { color: #036A07; }
 pre.code .tstring_content,
 pre.code .heredoc_beg, pre.code .heredoc_end,
-pre.code .qwords_beg, pre.code .qwords_end,
+pre.code .qwords_beg, pre.code .qwords_end, pre.code .qwords_sep,
+pre.code .words_beg, pre.code .words_end, pre.code .words_sep,
+pre.code .qsymbols_beg, pre.code .qsymbols_end, pre.code .qsymbols_sep,
+pre.code .symbols_beg, pre.code .symbols_end, pre.code .symbols_sep,
 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,
@@ -479,3 +484,9 @@ 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; }
+
+/* Color fix for links */
+#content .summary_desc pre.code .id > .object_link a, /* identifier */
+#content .docstring pre.code .id > .object_link a { color: #0085FF; }
+#content .summary_desc pre.code .const > .object_link a, /* constant */
+#content .docstring pre.code .const > .object_link a { color: #585CF6; }

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

@@ -4,11 +4,11 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta charset="<%= charset %>" />
     <% stylesheets_full_list.each do |stylesheet| %>
-      <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="<%= mtime_url(stylesheet) %>" type="text/css" media="screen" charset="utf-8" />
     <% end %>
 
     <% javascripts_full_list.each do |javascript| %>
-      <script type="text/javascript" charset="utf-8" src="<%= url_for(javascript) %>"></script>
+      <script type="text/javascript" charset="utf-8" src="<%= mtime_url(javascript) %>"></script>
     <% end %>
 
     <title><%= @list_title %></title>

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

@@ -55,7 +55,7 @@ function searchFrameButtons() {
   });
   window.addEventListener('message', function(e) {
     if (e.data === 'navEscape') {
-      $('#search_frame').slideUp(100);
+      $('#nav').slideUp(100);
       $('#search a').removeClass('active inactive');
       $(window).focus();
     }
@@ -63,7 +63,7 @@ function searchFrameButtons() {
 
   $(window).resize(function() {
     if ($('#search:visible').length === 0) {
-      $('#search_frame').slideUp(100);
+      $('#nav').removeAttr('style');
       $('#search a').removeClass('active inactive');
       $(window).focus();
     }
@@ -71,7 +71,7 @@ function searchFrameButtons() {
 }
 
 function toggleSearchFrame(id, link) {
-  var frame = $('#search_frame');
+  var frame = $('#nav');
   $('#search a').removeClass('active').addClass('inactive');
   if (frame.attr('src') === link && frame.css('display') !== "none") {
     frame.slideUp(100);

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 include Helpers::ModuleHelper
 
 def init
@@ -6,7 +7,7 @@ def init
   return serialize_onefile if options.onefile
   generate_assets
   serialize('_index.html')
-  options.files.each_with_index do |file, i|
+  options.files.each_with_index do |file, _i|
     serialize_file(file, file.title)
   end
 
@@ -59,7 +60,7 @@ end
 # @param [String] title currently unused
 #
 # @see layout#diskfile
-def serialize_file(file, title = nil)
+def serialize_file(file, title = nil) # rubocop:disable Lint/UnusedMethodArgument
   options.object = Registry.root
   options.file = file
   outfile = 'file.' + file.name + '.html'
@@ -124,8 +125,8 @@ def generate_assets
     if respond_to?(list_generator_method)
       send(list_generator_method)
     else
-      log.error "Unable to generate '#{list[:title]}' list because no method " +
-        "'#{list_generator_method}' exists"
+      log.error "Unable to generate '#{list[:title]}' list because no method " \
+                "'#{list_generator_method}' exists"
     end
   end
 
@@ -174,7 +175,6 @@ end
 
 # @api private
 class TreeContext
-
   def initialize
     @depth = 0
     @even_odd = Alternator.new(:even, :odd)
@@ -203,40 +203,39 @@ class TreeContext
       @next = first
       @after = second
     end
+
     def next
       @next, @after = @after, @next
       @after
     end
   end
-
 end
 
 # @return [String] HTML output of the classes to be displayed in the
 #    full_list_class template.
 def class_list(root = Registry.root, tree = TreeContext.new)
-  out = ""
+  out = String.new("")
   children = run_verifier(root.children)
   if root == Registry.root
     children += @items.select {|o| o.namespace.is_a?(CodeObjects::Proxy) }
   end
   children.compact.sort_by(&:path).each do |child|
-    if child.is_a?(CodeObjects::NamespaceObject)
-      name = child.namespace.is_a?(CodeObjects::Proxy) ? child.path : child.name
-      has_children = run_verifier(child.children).any? {|o| o.is_a?(CodeObjects::NamespaceObject) }
-      out << "<li id='object_#{child.path}' class='#{tree.classes.join(' ')}'>"
-      out << "<div class='item' style='padding-left:#{tree.indent}'>"
-      out << "<a class='toggle'></a> " if has_children
-      out << linkify(child, name)
-      out << " &lt; #{child.superclass.name}" if child.is_a?(CodeObjects::ClassObject) && child.superclass
-      out << "<small class='search_info'>"
-      out << child.namespace.title
-      out << "</small>"
-      out << "</div>"
-      tree.nest do
-        out << "<ul>#{class_list(child, tree)}</ul>" if has_children
-      end
-      out << "</li>"
+    next unless child.is_a?(CodeObjects::NamespaceObject)
+    name = child.namespace.is_a?(CodeObjects::Proxy) ? child.path : child.name
+    has_children = run_verifier(child.children).any? {|o| o.is_a?(CodeObjects::NamespaceObject) }
+    out << "<li id='object_#{child.path}' class='#{tree.classes.join(' ')}'>"
+    out << "<div class='item' style='padding-left:#{tree.indent}'>"
+    out << "<a class='toggle'></a> " if has_children
+    out << linkify(child, name)
+    out << " &lt; #{child.superclass.name}" if child.is_a?(CodeObjects::ClassObject) && child.superclass
+    out << "<small class='search_info'>"
+    out << child.namespace.title
+    out << "</small>"
+    out << "</div>"
+    tree.nest do
+      out << "<ul>#{class_list(child, tree)}</ul>" if has_children
     end
+    out << "</li>"
   end
   out
 end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 attr_reader :contents
 
 def init

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

@@ -7,9 +7,9 @@
   <% end %>
 </title>
 <% stylesheets.each do |stylesheet| %>
-  <link rel="stylesheet" href="<%= url_for(stylesheet) %>" type="text/css" charset="utf-8" />
+  <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="<%= url_for(javascript) %>"></script>
+  <script type="text/javascript" charset="utf-8" src="<%= mtime_url(javascript) %>"></script>
 <% end %>

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

@@ -5,7 +5,7 @@
   </head>
   <body>
     <div class="nav_wrap">
-      <iframe id="nav" src="<%= @nav_url %>"></iframe>
+      <iframe id="nav" src="<%= @nav_url %>?1"></iframe>
       <div id="resizer"></div>
     </div>
 
@@ -16,8 +16,6 @@
         <div class="clear"></div>
       </div>
 
-      <iframe id="search_frame" src="<%= @nav_url %>"></iframe>
-
       <div id="content"><%= yieldall %></div>
 
       <%= erb(:footer) %>

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

@@ -1,8 +1,11 @@
+# frozen_string_literal: true
 def init
   @breadcrumb = []
+  @page_title = ''
+  @breadcrumb_title = ''
   if @onefile
     sections :layout
-  elsif @file
+  elsif defined?(@file) && @file
     if @file.attributes[:namespace]
       @object = options.object = Registry.at(@file.attributes[:namespace]) || Registry.root
     end
@@ -19,7 +22,7 @@ def init
     when CodeObjects::Base
       unless object.root?
         cur = object.namespace
-        while !cur.root?
+        until cur.root?
           @breadcrumb.unshift(cur)
           cur = cur.namespace
         end
@@ -32,30 +35,29 @@ def init
   end
 end
 
-def contents
-  @contents
-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 }
+  objects.each {|o| (@objects_by_letter[o.name.to_s[0, 1].upcase] ||= []) << o }
   erb(:index)
 end
 
 def layout
-  @nav_url = url_for_list(!@file || options.index ? 'class' : 'file')
+  @nav_url = url_for_list(!(defined?(@file) && @file) || options.index ? 'class' : 'file')
 
-  if !object || object.is_a?(String)
-    @path = nil
-  elsif @file
-    @path = @file.path
-  elsif !object.is_a?(YARD::CodeObjects::NamespaceObject)
-    @path = object.parent.path
-  else
-    @path = object.path
-  end
+  @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
@@ -81,7 +83,7 @@ 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' } ]
+  [{: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