yard 0.9.39 → 0.9.41

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

@@ -1,245 +1,372 @@
 (function() {
+  var clicked = null;
+  var searchTimeout = null;
+  var searchCache = [];
+  var caseSensitiveMatch = false;
+  var ignoreKeyCodeMin = 8;
+  var ignoreKeyCodeMax = 46;
+  var commandKey = 91;
 
-var $clicked = $(null);
-var searchTimeout = null;
-var searchCache = [];
-var caseSensitiveMatch = false;
-var ignoreKeyCodeMin = 8;
-var ignoreKeyCodeMax = 46;
-var commandKey = 91;
+  function query(selector, root) {
+    return (root || document).querySelector(selector);
+  }
 
-RegExp.escape = function(text) {
-    return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
-}
+  function queryAll(selector, root) {
+    return Array.prototype.slice.call(
+      (root || document).querySelectorAll(selector)
+    );
+  }
 
-function escapeShortcut() {
-  $(document).keydown(function(evt) {
-    if (evt.which == 27) {
-      window.parent.postMessage('navEscape', '*');
+  function isVisible(element) {
+    if (!element) return false;
+    if (window.getComputedStyle(element).display === "none") return false;
+    if (element.parentElement && element.parentElement !== document.body) {
+      return isVisible(element.parentElement);
     }
-  });
-}
-
-function clearSearchTimeout() {
-  clearTimeout(searchTimeout);
-  searchTimeout = null;
-}
-
-function enableLinks() {
-  // load the target page in the parent window
-  $('#full_list li').on('click', function(evt) {
-    $('#full_list li').removeClass('clicked');
-    $clicked = $(this);
-    $clicked.addClass('clicked');
-    evt.stopPropagation();
-
-    if (window.origin === "null") {
-      if (evt.target.tagName === 'A') return true;
-
-      var elem = $clicked.find('> .item .object_link a')[0];
-      var e = evt.originalEvent;
-      var newEvent = new MouseEvent(evt.originalEvent.type);
-      newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
-      elem.dispatchEvent(newEvent);
-      evt.preventDefault();
+    return true;
+  }
+
+  RegExp.escape = function(text) {
+    return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+  };
+
+  function ready(callback) {
+    if (document.readyState === "loading") {
+      document.addEventListener("DOMContentLoaded", callback, { once: true });
     } else {
-      let url = $clicked.find('.object_link a').attr('href');
-      try {
-        url = new URL(url, window.location.href).href;
-      } catch { }
-      window.top.postMessage({ action: "navigate", url: url }, "*");
+      callback();
     }
-    return false;
-  });
-}
-
-function enableToggles() {
-  // show/hide nested classes on toggle click
-  $('#full_list a.toggle').on('click', function(evt) {
-    evt.stopPropagation();
-    evt.preventDefault();
-    $(this).parent().parent().toggleClass('collapsed');
-    $(this).attr('aria-expanded', function (i, attr) {
-        return attr == 'true' ? 'false' : 'true'
+  }
+
+  function escapeShortcut() {
+    document.addEventListener("keydown", function(event) {
+      if (event.key === "Escape") {
+        window.parent.postMessage("navEscape", "*");
+      }
     });
+  }
+
+  function clearSearchTimeout() {
+    clearTimeout(searchTimeout);
+    searchTimeout = null;
+  }
+
+  function setClicked(item) {
+    queryAll("#full_list li.clicked").forEach(function(node) {
+      node.classList.remove("clicked");
+    });
+    clicked = item;
+    if (clicked) clicked.classList.add("clicked");
+  }
+
+  function pathForItem(item) {
+    if (!item || !item.id || item.id.indexOf("object_") !== 0) return null;
+    return item.id.substring("object_".length);
+  }
+
+  function enableLinks() {
+    queryAll("#full_list li").forEach(function(item) {
+      var itemRow = item.querySelector(":scope > .item");
+
+      if (!itemRow) return;
+
+      itemRow.addEventListener("click", function(event) {
+        var targetLink;
+        var mouseEvent;
+        var url;
+
+        if (
+          event.defaultPrevented ||
+          event.button !== 0 ||
+          event.metaKey ||
+          event.ctrlKey ||
+          event.shiftKey ||
+          event.altKey
+        ) {
+          return true;
+        }
+
+        setClicked(item);
+        event.stopPropagation();
+        targetLink = event.target.closest("a");
+
+        if (window.origin === "null") {
+          if (targetLink) return true;
+
+          targetLink = item.querySelector(":scope > .item .object_link a");
+          if (!targetLink) return false;
+          mouseEvent = new MouseEvent("click", {
+            bubbles: true,
+            cancelable: true,
+            view: event.view || window,
+            detail: event.detail,
+            screenX: event.screenX,
+            screenY: event.screenY,
+            clientX: event.clientX,
+            clientY: event.clientY,
+            ctrlKey: event.ctrlKey,
+            shiftKey: event.shiftKey,
+            altKey: event.altKey,
+            metaKey: event.metaKey,
+            button: event.button,
+            buttons: event.buttons,
+            relatedTarget: event.relatedTarget
+          });
+          targetLink.dispatchEvent(mouseEvent);
+          event.preventDefault();
+        } else {
+          if (!targetLink || !targetLink.matches(".object_link a")) {
+            targetLink = item.querySelector(":scope > .item .object_link a");
+          }
+          if (!targetLink) return false;
+
+          event.preventDefault();
+          url = targetLink.getAttribute("href");
+          try {
+            url = new URL(url, window.location.href).href;
+          } catch (error) {}
+          window.top.postMessage(
+            { action: "navigate", url: url, path: pathForItem(item) },
+            "*"
+          );
+        }
+        return false;
+      });
+    });
+  }
+
+  function toggleItem(toggle) {
+    var item = toggle.parentElement.parentElement;
+    var expanded = item.classList.contains("collapsed");
+
+    item.classList.toggle("collapsed");
+    toggle.setAttribute("aria-expanded", expanded ? "true" : "false");
     highlight();
-  });
+  }
 
-  // navigation of nested classes using keyboard
-  $('#full_list a.toggle').on('keypress',function(evt) {
-    // enter key is pressed
-    if (evt.which == 13) {
-      evt.stopPropagation();
-      evt.preventDefault();
-      $(this).parent().parent().toggleClass('collapsed');
-      $(this).attr('aria-expanded', function (i, attr) {
-          return attr == 'true' ? 'false' : 'true'
+  function enableToggles() {
+    queryAll("#full_list a.toggle").forEach(function(toggle) {
+      toggle.addEventListener("click", function(event) {
+        event.stopPropagation();
+        event.preventDefault();
+        toggleItem(toggle);
       });
-      highlight();
-    }
-  });
-}
 
-function populateSearchCache() {
-  $('#full_list li .item').each(function() {
-    var $node = $(this);
-    var $link = $node.find('.object_link a');
-    if ($link.length > 0) {
+      toggle.addEventListener("keypress", function(event) {
+        if (event.key !== "Enter") return;
+        event.stopPropagation();
+        event.preventDefault();
+        toggleItem(toggle);
+      });
+    });
+  }
+
+  function populateSearchCache() {
+    queryAll("#full_list li .item").forEach(function(node) {
+      var link = query(".object_link a", node);
+      if (!link) return;
+
       searchCache.push({
-        node: $node,
-        link: $link,
-        name: $link.text(),
-        fullName: $link.attr('title').split(' ')[0]
+        node: node,
+        link: link,
+        name: link.textContent,
+        fullName: link.getAttribute("title").split(" ")[0]
       });
+    });
+  }
+
+  function enableSearch() {
+    var input = query("#search input");
+    var fullList = query("#full_list");
+
+    if (!input || !fullList) return;
+
+    input.addEventListener("keyup", function(event) {
+      if (ignoredKeyPress(event)) return;
+      if (input.value === "") {
+        clearSearch();
+      } else {
+        performSearch(input.value);
+      }
+    });
+
+    fullList.insertAdjacentHTML(
+      "afterend",
+      "<div id='noresults' role='status' style='display: none'></div>"
+    );
+  }
+
+  function ignoredKeyPress(event) {
+    return (
+      (event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
+      event.keyCode === commandKey
+    );
+  }
+
+  function clearSearch() {
+    clearSearchTimeout();
+    queryAll("#full_list .found").forEach(function(node) {
+      var link = query(".object_link a", node);
+      node.classList.remove("found");
+      link.textContent = link.textContent;
+    });
+    query("#full_list").classList.remove("insearch");
+    query("#content").classList.remove("insearch");
+    if (clicked) {
+      var current = clicked.parentElement;
+      while (current) {
+        if (current.tagName === "LI") current.classList.remove("collapsed");
+        if (current.id === "full_list") break;
+        current = current.parentElement;
+      }
     }
-  });
-}
+    highlight();
+  }
+
+  function performSearch(searchString) {
+    clearSearchTimeout();
+    query("#full_list").classList.add("insearch");
+    query("#content").classList.add("insearch");
+    query("#noresults").textContent = "";
+    query("#noresults").style.display = "none";
+    partialSearch(searchString, 0);
+  }
 
-function enableSearch() {
-  $('#search input').keyup(function(event) {
-    if (ignoredKeyPress(event)) return;
-    if (this.value === "") {
-      clearSearch();
+  function partialSearch(searchString, offset) {
+    var lastRowClass = "";
+    var i;
+
+    for (i = offset; i < Math.min(offset + 50, searchCache.length); i += 1) {
+      var item = searchCache[i];
+      var searchName =
+        searchString.indexOf("::") !== -1 ? item.fullName : item.name;
+      var matchRegexp = new RegExp(
+        buildMatchString(searchString),
+        caseSensitiveMatch ? "" : "i"
+      );
+
+      if (!searchName.match(matchRegexp)) {
+        item.node.classList.remove("found");
+        item.link.textContent = item.link.textContent;
+      } else {
+        item.node.classList.add("found");
+        if (lastRowClass) item.node.classList.remove(lastRowClass);
+        item.node.classList.add(lastRowClass === "r1" ? "r2" : "r1");
+        lastRowClass = item.node.classList.contains("r1") ? "r1" : "r2";
+        item.link.innerHTML = item.name.replace(matchRegexp, "<strong>$&</strong>");
+      }
+    }
+
+    if (i === searchCache.length) {
+      searchDone();
     } else {
-      performSearch(this.value);
+      searchTimeout = setTimeout(function() {
+        partialSearch(searchString, i);
+      }, 0);
     }
-  });
+  }
 
-  $('#full_list').after("<div id='noresults' role='status' style='display: none'></div>");
-}
+  function searchDone() {
+    var found = queryAll("#full_list li").filter(isVisible).length;
 
-function ignoredKeyPress(event) {
-  if (
-    (event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
-    (event.keyCode == commandKey)
-  ) {
-    return true;
-  } else {
-    return false;
-  }
-}
+    searchTimeout = null;
+    highlight();
 
-function clearSearch() {
-  clearSearchTimeout();
-  $('#full_list .found').removeClass('found').each(function() {
-    var $link = $(this).find('.object_link a');
-    $link.text($link.text());
-  });
-  $('#full_list, #content').removeClass('insearch');
-  $clicked.parents().removeClass('collapsed');
-  highlight();
-}
-
-function performSearch(searchString) {
-  clearSearchTimeout();
-  $('#full_list, #content').addClass('insearch');
-  $('#noresults').text('').hide();
-  partialSearch(searchString, 0);
-}
-
-function partialSearch(searchString, offset) {
-  var lastRowClass = '';
-  var i = null;
-  for (i = offset; i < Math.min(offset + 50, searchCache.length); i++) {
-    var item = searchCache[i];
-    var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
-    var matchString = buildMatchString(searchString);
-    var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
-    if (searchName.match(matchRegexp) == null) {
-      item.node.removeClass('found');
-      item.link.text(item.link.text());
+    if (found === 0) {
+      query("#noresults").textContent = "No results were found.";
+    } else {
+      query("#noresults").textContent = "There are " + found + " results.";
     }
-    else {
-      item.node.addClass('found');
-      item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
-      lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
-      item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
+    query("#noresults").style.display = "block";
+    query("#content").classList.remove("insearch");
+  }
+
+  function buildMatchString(searchString) {
+    var regexSearchString;
+
+    caseSensitiveMatch = /[A-Z]/.test(searchString);
+    regexSearchString = RegExp.escape(searchString);
+    if (caseSensitiveMatch) {
+      regexSearchString +=
+        "|" +
+        searchString
+          .split("")
+          .map(function(character) {
+            return RegExp.escape(character);
+          })
+          .join(".+?");
     }
+    return regexSearchString;
   }
-  if(i == searchCache.length) {
-    searchDone();
-  } else {
-    searchTimeout = setTimeout(function() {
-      partialSearch(searchString, i);
-    }, 0);
-  }
-}
-
-function searchDone() {
-  searchTimeout = null;
-  highlight();
-  var found = $('#full_list li:visible').size();
-  if (found === 0) {
-    $('#noresults').text('No results were found.');
-  } else {
-    // This is read out to screen readers
-    $('#noresults').text('There are ' + found + ' results.');
-  }
-  $('#noresults').show();
-  $('#content').removeClass('insearch');
-}
-
-function buildMatchString(searchString, event) {
-  caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
-  var regexSearchString = RegExp.escape(searchString);
-  if (caseSensitiveMatch) {
-    regexSearchString += "|" +
-      $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
-      join('.+?');
-  }
-  return regexSearchString;
-}
-
-function highlight() {
-  $('#full_list li:visible').each(function(n) {
-    $(this).removeClass('even odd').addClass(n % 2 == 0 ? 'odd' : 'even');
-  });
-}
-
-function isInView(element) {
-  const rect = element.getBoundingClientRect();
-  const windowHeight =
-    window.innerHeight || document.documentElement.clientHeight;
-  return rect.left >= 0 && rect.bottom <= windowHeight;
-}
-
-/**
- * Expands the tree to the target element and its immediate
- * children.
- */
-function expandTo(path) {
-  var $target = $(document.getElementById('object_' + path));
-  $target.addClass('clicked');
-  $target.removeClass('collapsed');
-  $target.parentsUntil('#full_list', 'li').removeClass('collapsed');
-
-  $target.find('a.toggle').attr('aria-expanded', 'true')
-  $target.parentsUntil('#full_list', 'li').each(function(i, el) {
-    $(el).find('> div > a.toggle').attr('aria-expanded', 'true');
-  });
 
-  if($target[0] && !isInView($target[0])) {
-    window.scrollTo(window.scrollX, $target.offset().top - 250);
-    highlight();
+  function highlight() {
+    queryAll("#full_list li")
+      .filter(isVisible)
+      .forEach(function(item, index) {
+        item.classList.remove("even");
+        item.classList.remove("odd");
+        item.classList.add(index % 2 === 0 ? "odd" : "even");
+      });
+  }
+
+  function isInView(element) {
+    var rect = element.getBoundingClientRect();
+    var windowHeight =
+      window.innerHeight || document.documentElement.clientHeight;
+    return rect.left >= 0 && rect.bottom <= windowHeight;
   }
-}
 
-function windowEvents(event) {
-  var msg = event.data;
-  if (msg.action === "expand") {
-    expandTo(msg.path);
+  function expandTo(path) {
+    var target = document.getElementById("object_" + path);
+
+    if (!target) return;
+
+    setClicked(target);
+    target.classList.remove("collapsed");
+
+    var current = target.parentElement;
+    while (current && current.id !== "full_list") {
+      if (current.tagName === "LI") current.classList.remove("collapsed");
+      current = current.parentElement;
+    }
+
+    queryAll("a.toggle", target).forEach(function(toggle) {
+      toggle.setAttribute("aria-expanded", "true");
+    });
+
+    current = target.parentElement;
+    while (current && current.id !== "full_list") {
+      if (current.tagName === "LI") {
+        var toggle = current.querySelector(":scope > div > a.toggle");
+        if (toggle) toggle.setAttribute("aria-expanded", "true");
+      }
+      current = current.parentElement;
+    }
+
+    if (!isInView(target)) {
+      window.scrollTo(
+        window.scrollX,
+        target.getBoundingClientRect().top + window.scrollY - 250
+      );
+      highlight();
+    }
   }
-  return false;
-}
 
-window.addEventListener("message", windowEvents, false);
+  function windowEvents(event) {
+    var msg = event.data;
+    if (msg.action === "expand") {
+      expandTo(msg.path);
+    }
+    return false;
+  }
 
-$(document).ready(function() {
-  escapeShortcut();
-  enableLinks();
-  enableToggles();
-  populateSearchCache();
-  enableSearch();
-});
+  window.addEventListener("message", windowEvents, false);
 
+  ready(function() {
+    escapeShortcut();
+    enableLinks();
+    enableToggles();
+    populateSearchCache();
+    enableSearch();
+  });
 })();

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

@@ -7,7 +7,7 @@
   <% end %>
 </title>
 <% stylesheets.each do |stylesheet| %>
-  <link rel="stylesheet" href="<%= mtime_url(stylesheet) %>" type="text/css" />
+  <link rel="stylesheet" href="<%= mtime_url(stylesheet) %>" type="text/css">
 <% end %>
 <%= erb :script_setup %>
 <% javascripts.each do |javascript| %>

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

@@ -10,6 +10,7 @@
     </div>
 
     <div id="main" tabindex="-1">
+      <div id="main_progress" aria-hidden="true"></div>
       <div id="header">
         <%= erb(:breadcrumb) %>
         <%= erb(:search) %>
@@ -21,4 +22,4 @@
       <%= erb(:footer) %>
     </div>
   </body>
-</html>
+</html>

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

@@ -3,8 +3,8 @@
   <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>
+    <%= 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>
@@ -14,4 +14,4 @@
   <div id="method_details">
     <%= yieldall :index => 0 %>
   </div>
-</div>
+</div>

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

@@ -1,3 +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 %>
+<%= 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

@@ -5,6 +5,7 @@
   <% 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? } %>
+  <% meths.reject! {|m| m.group && object.groups && object.groups.include?(m.group) } %>
   <% next if meths.size == 0 %>
   <% if method_listing.size == 0 && !found_method %><h2>Method Summary</h2><% end %>
   <% found_method = true %>

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

@@ -10,5 +10,13 @@
         <%= yieldall :item => meth %>
       <% end %>
     </ul>
+    <% (inherited_methods_by_group[name] || {}).each do |superclass, meths| %>
+      <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|
+        mname = m.name(true)
+        mname = mname.gsub(/^#/, '') if superclass.type == :module && object.class_mixins.include?(superclass)
+        linkify(m, mname)
+      }.join(", ") %></p>
+    <% end %>
   <% end %>
 <% end %>

data/templates/default/module/setup.rb

@@ -104,6 +104,26 @@ def inherited_constant_list
   end
 end
 
+def inherited_methods_by_group
+  return @inherited_meths_by_group if defined?(@inherited_meths_by_group)
+  @inherited_meths_by_group = {}
+  return @inherited_meths_by_group unless object.groups
+
+  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? }
+    meths.each do |m|
+      next unless m.group && object.groups.include?(m.group)
+      (@inherited_meths_by_group[m.group] ||= {})[superclass] ||= []
+      @inherited_meths_by_group[m.group][superclass] << m
+    end
+  end
+  @inherited_meths_by_group
+end
+
 def docstring_full(obj)
   docstring = obj.tags(:overload).size == 1 && obj.docstring.empty? ?
     obj.tag(:overload).docstring : obj.docstring