yard 0.9.36 → 0.9.43

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

@@ -1,216 +1,334 @@
-(function() {
-
-var $clicked = $(null);
-var searchTimeout = null;
-var searchCache = [];
-var caseSensitiveMatch = false;
-var ignoreKeyCodeMin = 8;
-var ignoreKeyCodeMax = 46;
-var commandKey = 91;
-
-RegExp.escape = function(text) {
-    return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
-}
-
-function escapeShortcut() {
-  $(document).keydown(function(evt) {
-    if (evt.which == 27) {
-      window.parent.postMessage('navEscape', '*');
-    }
-  });
-}
-
-function navResizer() {
-  $(window).mousemove(function(e) {
-    window.parent.postMessage({
-      action: 'mousemove', event: {pageX: e.pageX, which: e.which}
-    }, '*');
-  }).mouseup(function(e) {
-    window.parent.postMessage({action: 'mouseup'}, '*');
-  });
-  window.parent.postMessage("navReady", "*");
-}
-
-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 (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 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');
-    highlight();
-  });
-}
-
-function populateSearchCache() {
-  $('#full_list li .item').each(function() {
-    var $node = $(this);
-    var $link = $node.find('.object_link a');
-    if ($link.length > 0) {
-      searchCache.push({
-        node: $node,
-        link: $link,
-        name: $link.text(),
-        fullName: $link.attr('title').split(' ')[0]
-      });
-    }
-  });
-}
-
-function enableSearch() {
-  $('#search input').keyup(function(event) {
-    if (ignoredKeyPress(event)) return;
-    if (this.value === "") {
-      clearSearch();
-    } else {
-      performSearch(this.value);
-    }
-  });
-
-  $('#full_list').after("<div id='noresults' style='display:none'></div>");
-}
-
-function ignoredKeyPress(event) {
-  if (
-    (event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
-    (event.keyCode == commandKey)
-  ) {
-    return true;
-  } else {
-    return false;
-  }
-}
-
-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());
-    }
-    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>"));
-    }
-  }
-  if(i == searchCache.length) {
-    searchDone();
-  } else {
-    searchTimeout = setTimeout(function() {
-      partialSearch(searchString, i);
-    }, 0);
-  }
-}
-
-function searchDone() {
-  searchTimeout = null;
-  highlight();
-  if ($('#full_list li:visible').size() === 0) {
-    $('#noresults').text('No results were found.').hide().fadeIn();
-  } else {
-    $('#noresults').text('').hide();
-  }
-  $('#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');
-  });
-}
-
-/**
- * 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');
-  if($target[0]) {
-    window.scrollTo(window.scrollX, $target.offset().top - 250);
-    highlight();
-  }
-}
-
-function windowEvents(event) {
-  var msg = event.data;
-  if (msg.action === "expand") {
-    expandTo(msg.path);
-  }
-  return false;
-}
-
-window.addEventListener("message", windowEvents, false);
-
-$(document).ready(function() {
-  escapeShortcut();
-  navResizer();
-  enableLinks();
-  enableToggles();
-  populateSearchCache();
-  enableSearch();
-});
+(() => {
+	let clicked = null;
+	let searchTimeout = null;
+	const searchCache = [];
+	let caseSensitiveMatch = false;
 
+	function query(selector, root) {
+		return (root || document).querySelector(selector);
+	}
+
+	function queryAll(selector, root) {
+		return Array.prototype.slice.call(
+			(root || document).querySelectorAll(selector),
+		);
+	}
+
+	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);
+		}
+		return true;
+	}
+
+	RegExp.escape = (text) => text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+
+	function ready(callback) {
+		if (document.readyState === "loading") {
+			document.addEventListener("DOMContentLoaded", callback, { once: true });
+		} else {
+			callback();
+		}
+	}
+
+	function escapeShortcut() {
+		document.addEventListener("keydown", (event) => {
+			if (event.key === "Escape") {
+				window.parent.postMessage("navEscape", "*");
+			}
+		});
+	}
+
+	function clearSearchTimeout() {
+		clearTimeout(searchTimeout);
+		searchTimeout = null;
+	}
+
+	function setClicked(item) {
+		queryAll("#full_list li.clicked").forEach((node) => {
+			node.classList.remove("clicked");
+		});
+		clicked = item;
+		if (clicked) clicked.classList.add("clicked");
+	}
+
+	function pathForItem(item) {
+		if (!item?.id || item.id.indexOf("object_") !== 0) return null;
+		return item.id.substring("object_".length);
+	}
+
+	function enableLinks() {
+		queryAll("#full_list li").forEach((item) => {
+			const itemRow = item.querySelector(":scope > .item");
+
+			if (!itemRow) return;
+
+			itemRow.addEventListener("click", (event) => {
+				let targetLink;
+				let 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 (!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) {
+		const item = toggle.parentElement.parentElement;
+		const expanded = item.classList.contains("collapsed");
+
+		item.classList.toggle("collapsed");
+		toggle.setAttribute("aria-expanded", expanded ? "true" : "false");
+		highlight();
+	}
+
+	function enableToggles() {
+		queryAll("#full_list a.toggle").forEach((toggle) => {
+			toggle.addEventListener("click", (event) => {
+				event.stopPropagation();
+				event.preventDefault();
+				toggleItem(toggle);
+			});
+
+			toggle.addEventListener("keypress", (event) => {
+				if (event.key !== "Enter") return;
+				event.stopPropagation();
+				event.preventDefault();
+				toggleItem(toggle);
+			});
+		});
+	}
+
+	function populateSearchCache() {
+		queryAll("#full_list li .item").forEach((node) => {
+			const link = query(".object_link a", node);
+			if (!link) return;
+
+			searchCache.push({
+				node: node,
+				link: link,
+				name: link.textContent,
+				fullName: link.getAttribute("title").split(" ")[0],
+			});
+		});
+	}
+
+	function enableSearch() {
+		const input = query("#search input");
+		const fullList = query("#full_list");
+
+		if (!input || !fullList) return;
+
+		function updateSearchResults() {
+			if (input.value === "") {
+				clearSearch();
+			} else {
+				performSearch(input.value);
+			}
+		}
+
+		input.addEventListener("input", updateSearchResults);
+		input.addEventListener("change", updateSearchResults);
+
+		fullList.insertAdjacentHTML(
+			"afterend",
+			"<div id='noresults' role='status' style='display: none'></div>",
+		);
+	}
+
+	function clearSearch() {
+		clearSearchTimeout();
+		queryAll("#full_list .found").forEach((node) => {
+			node.classList.remove("found");
+		});
+		query("#full_list").classList.remove("insearch");
+		query("#content").classList.remove("insearch");
+		if (clicked) {
+			let 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 partialSearch(searchString, offset) {
+		let lastRowClass = "";
+		let i;
+
+		for (i = offset; i < Math.min(offset + 50, searchCache.length); i += 1) {
+			const item = searchCache[i];
+			const searchName =
+				searchString.indexOf("::") !== -1 ? item.fullName : item.name;
+			const matchRegexp = new RegExp(
+				buildMatchString(searchString),
+				caseSensitiveMatch ? "" : "i",
+			);
+
+			if (!searchName.match(matchRegexp)) {
+				item.node.classList.remove("found");
+			} 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 {
+			searchTimeout = setTimeout(() => {
+				partialSearch(searchString, i);
+			}, 0);
+		}
+	}
+
+	function searchDone() {
+		const found = queryAll("#full_list li").filter(isVisible).length;
+
+		searchTimeout = null;
+		highlight();
+
+		if (found === 0) {
+			query("#noresults").textContent = "No results were found.";
+		} else {
+			query("#noresults").textContent = `There are ${found} results.`;
+		}
+		query("#noresults").style.display = "block";
+		query("#content").classList.remove("insearch");
+	}
+
+	function buildMatchString(searchString) {
+		let regexSearchString;
+
+		caseSensitiveMatch = /[A-Z]/.test(searchString);
+		regexSearchString = RegExp.escape(searchString);
+		if (caseSensitiveMatch) {
+			regexSearchString +=
+				"|" +
+				searchString
+					.split("")
+					.map((character) => RegExp.escape(character))
+					.join(".+?");
+		}
+		return regexSearchString;
+	}
+
+	function highlight() {
+		queryAll("#full_list li")
+			.filter(isVisible)
+			.forEach((item, index) => {
+				item.classList.remove("even");
+				item.classList.remove("odd");
+				item.classList.add(index % 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;
+	}
+
+	function expandTo(path) {
+		const target = document.getElementById(`object_${path}`);
+
+		if (!target) return;
+
+		setClicked(target);
+		target.classList.remove("collapsed");
+
+		let 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((toggle) => {
+			toggle.setAttribute("aria-expanded", "true");
+		});
+
+		current = target.parentElement;
+		while (current && current.id !== "full_list") {
+			if (current.tagName === "LI") {
+				const toggle = current.querySelector(":scope > div > a.toggle");
+				if (toggle) toggle.setAttribute("aria-expanded", "true");
+			}
+			current = current.parentElement;
+		}
+
+		highlight();
+
+		if (!isInView(target)) {
+			window.scrollTo(
+				window.scrollX,
+				target.getBoundingClientRect().top + window.scrollY - 250,
+			);
+		}
+	}
+
+	function windowEvents(event) {
+		const msg = event.data;
+		if (msg.action === "expand") {
+			expandTo(msg.path);
+		}
+		return false;
+	}
+
+	window.addEventListener("message", windowEvents, false);
+
+	ready(() => {
+		escapeShortcut();
+		enableLinks();
+		enableToggles();
+		populateSearchCache();
+		enableSearch();
+		highlight();
+	});
 })();

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

@@ -104,6 +104,12 @@ def javascripts_full_list
   %w(js/jquery.js js/full_list.js)
 end
 
+# Sets the HTML language lang="value" where value is the value returned from
+# this method. Defaults to nil which does not set the lang attribute.
+def html_lang
+  nil
+end
+
 def menu_lists
   Object.new.extend(T('layout')).menu_lists
 end
@@ -225,7 +231,8 @@ def class_list(root = Registry.root, tree = TreeContext.new)
     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
+    accessible_props = "aria-label='#{name} child nodes' aria-expanded='false' aria-controls='object_#{child.path}'"
+    out << "<a tabindex='0' class='toggle' role='button' #{accessible_props}></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'>"
@@ -233,7 +240,8 @@ def class_list(root = Registry.root, tree = TreeContext.new)
     out << "</small>"
     out << "</div>"
     tree.nest do
-      out << "<ul>#{class_list(child, tree)}</ul>" if has_children
+      labeled_by = "aria-labelledby='object_#{child.path}'"
+      out << "<div #{labeled_by}><ul>#{class_list(child, tree)}</ul></div>" if has_children
     end
     out << "</li>"
   end

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

@@ -4,6 +4,8 @@
     <%= erb(:headers) %>
   </head>
   <body>
+    <div id="main_progress" aria-hidden="true"></div>
+
     <div class="nav_wrap">
       <iframe id="nav" src="<%= @nav_url %>?1"></iframe>
       <div id="resizer"></div>
@@ -21,4 +23,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

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

@@ -1,5 +1,7 @@
 <style type="text/css">
   <%= @css_data %>
+  html { width: auto; height: auto; }
+  body { display: block; margin: 1rem; width: auto; }
 </style>
 <script type="text/javascript">
   <%= @js_data %>