Skip to content

Commit

Permalink
chore: add yard app.js with patch to support jQuery v3.6.0 (#3886)
Browse files Browse the repository at this point in the history
  • Loading branch information
@trivikr
trivikr authored Sep 14, 2021
1 parent c92f847 commit dca3449
Show file tree
Hide file tree
Showing 600 changed files with 321 additions and 93,297 deletions.
6 changes: 3 additions & 3 deletions Gemfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ group :documentation do
# Fix PR: https://github.com/lsegal/yard-js/pull/4
gem 'yard-js', path: './doc-src/yard-js'

# Switch to yard gem when fix is published
# Fix PR: https://github.com/lsegal/yard/pull/1399
gem 'yard', path: './doc-src/yard'
# When updating yard, override app.js from upstream to doc-src/templates/default/fulldoc/js/app.js
# and add patch from PR https://github.com/lsegal/yard/pull/1399 to support jQuery 3.6.0+
gem 'yard', '~> 0.9.26'

gem 'parsejs', path: './doc-src/parsejs'
end
Expand Down
8 changes: 2 additions & 6 deletions Gemfile.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ PATH
specs:
yard-js (0.1.3)

PATH
remote: doc-src/yard
specs:
yard (0.9.26)

GEM
remote: https://rubygems.org/
specs:
Expand All @@ -23,6 +18,7 @@ GEM
rdiscount (2.2.0.2)
redcarpet (3.5.1)
samus (3.0.9)
yard (0.9.26)
yard-sitemap (1.0.1)

PLATFORMS
Expand All @@ -34,7 +30,7 @@ DEPENDENCIES
rdiscount
redcarpet (~> 3.0)
samus
yard!
yard (~> 0.9.26)
yard-js!
yard-sitemap (~> 1.0)

Expand Down
316 changes: 316 additions & 0 deletions doc-src/templates/default/fulldoc/js/app.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,316 @@
(function() {

var localStorage = {}, sessionStorage = {};
try { localStorage = window.localStorage; } catch (e) { }
try { sessionStorage = window.sessionStorage; } catch (e) { }

function createSourceLinks() {
$('.method_details_list .source_code').
before('<span class=\'showSource\'>[<a href=\'#\' class=\'toggleSource\'>View source</a>]</span>');
$('.toggleSource').click(function() {
if ($(this).text() === 'View source') {
$(this).parent().nextAll('.source_code').slideDown(100);
$(this).text('Hide source');
} else {
$(this).parent().nextAll('.source_code').slideUp(100);
$(this).text('View source');
}
});
}

function createDefineLinks() {
var tHeight = 0;
$('.defines').after(' <a href=\'#\' class=\'toggleDefines\'>more...</a>');
$('.toggleDefines').click(function() {
if ($(this).text() === 'more...') {
tHeight = $(this).parent().prev().height();
$(this).prev().css('display', 'inline');
$(this).parent().prev().height($(this).parent().height());
$(this).text('(less)');
} else {
$(this).prev().hide();
$(this).parent().prev().height(tHeight);
$(this).text('more...');
}
});
}

function createFullTreeLinks() {
var tHeight = 0;
$('.inheritanceTree').click(function() {
if ($(this).text() === 'show all') {
tHeight = $(this).parent().prev().height();
$(this).text('(hide)');
$(this).parent().prev().height($(this).parent().height());
} else {
$(this).parent().prev().height(tHeight);
$(this).text('show all');
}
$(this).parent().toggleClass('showAll');
});
}

function searchFrameButtons() {
$('.full_list_link').click(function() {
toggleSearchFrame(this, $(this).attr('href'));
return false;
});
window.addEventListener('message', function(e) {
if (e.data === 'navEscape') {
$('#nav').slideUp(100);
$('#search a').removeClass('active inactive');
$(window).focus();
}
});

$(window).resize(function() {
if ($('#search:visible').length === 0) {
$('#nav').removeAttr('style');
$('#search a').removeClass('active inactive');
$(window).focus();
}
});
}

function toggleSearchFrame(id, link) {
var frame = $('#nav');
$('#search a').removeClass('active').addClass('inactive');
if (frame.attr('src') === link && frame.css('display') !== 'none') {
frame.slideUp(100);
$('#search a').removeClass('active inactive');
}
else {
$(id).addClass('active').removeClass('inactive');
if (frame.attr('src') !== link) frame.attr('src', link);
frame.slideDown(100);
}
}

function linkSummaries() {
$('.summary_signature').click(function() {
document.location = $(this).find('a').attr('href');
});
}

function summaryToggle() {
$('.summary_toggle').click(function(e) {
e.preventDefault();
localStorage.summaryCollapsed = $(this).text();
$('.summary_toggle').each(function() {
$(this).text($(this).text() == 'collapse' ? 'expand' : 'collapse');
var next = $(this).parent().parent().nextAll('ul.summary').first();
if (next.hasClass('compact')) {
next.toggle();
next.nextAll('ul.summary').first().toggle();
}
else if (next.hasClass('summary')) {
var list = $('<ul class="summary compact" />');
list.html(next.html());
list.find('.summary_desc, .note').remove();
list.find('a').each(function() {
$(this).html($(this).find('strong').html());
$(this).parent().html($(this)[0].outerHTML);
});
next.before(list);
next.toggle();
}
});
return false;
});
if (localStorage.summaryCollapsed == 'collapse') {
$('.summary_toggle').first().click();
} else { localStorage.summaryCollapsed = 'expand'; }
}

function constantSummaryToggle() {
$('.constants_summary_toggle').click(function(e) {
e.preventDefault();
localStorage.summaryCollapsed = $(this).text();
$('.constants_summary_toggle').each(function() {
$(this).text($(this).text() == 'collapse' ? 'expand' : 'collapse');
var next = $(this).parent().parent().nextAll('dl.constants').first();
if (next.hasClass('compact')) {
next.toggle();
next.nextAll('dl.constants').first().toggle();
}
else if (next.hasClass('constants')) {
var list = $('<dl class="constants compact" />');
list.html(next.html());
list.find('dt').each(function() {
$(this).addClass('summary_signature');
$(this).text( $(this).text().split('=')[0]);
if ($(this).has('.deprecated').length) {
$(this).addClass('deprecated');
};
});
// Add the value of the constant as "Tooltip" to the summary object
list.find('pre.code').each(function() {
console.log($(this).parent());
var dt_element = $(this).parent().prev();
var tooltip = $(this).text();
if (dt_element.hasClass('deprecated')) {
tooltip = 'Deprecated. ' + tooltip;
};
dt_element.attr('title', tooltip);
});
list.find('.docstring, .tags, dd').remove();
next.before(list);
next.toggle();
}
});
return false;
});
if (localStorage.summaryCollapsed == 'collapse') {
$('.constants_summary_toggle').first().click();
} else { localStorage.summaryCollapsed = 'expand'; }
}

function generateTOC() {
if ($('#filecontents').length === 0) return;
var _toc = $('<ol class="top"></ol>');
var show = false;
var toc = _toc;
var counter = 0;
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
var i;
var curli;
if ($('#filecontents h1').length > 1) tags.unshift('h1');
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
var lastTag = parseInt(tags[0][1], 10);
$(tags.join(', ')).each(function() {
if ($(this).parents('.method_details .docstring').length != 0) return;
if (this.id == 'filecontents') return;
show = true;
var thisTag = parseInt(this.tagName[1], 10);
if (this.id.length === 0) {
var proposedId = $(this).attr('toc-id');
if (typeof(proposedId) != 'undefined') this.id = proposedId;
else {
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
this.id = proposedId;
}
}
if (thisTag > lastTag) {
for (i = 0; i < thisTag - lastTag; i++) {
if ( typeof(curli) == 'undefined' ) {
curli = $('<li/>');
toc.append(curli);
}
toc = $('<ol/>');
curli.append(toc);
curli = undefined;
}
}
if (thisTag < lastTag) {
for (i = 0; i < lastTag - thisTag; i++) {
toc = toc.parent();
toc = toc.parent();
}
}
var title = $(this).attr('toc-title');
if (typeof(title) == 'undefined') title = $(this).text();
curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
toc.append(curli);
lastTag = thisTag;
});
if (!show) return;
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
$('#content').prepend(html);
$('#toc').append(_toc);
$('#toc .title.hide_toc').click(function() {
if ($(this).parent().hasClass('hidden')) {
$(this).next().slideDown('fast');
} else {
$(this).next().slideUp('fast');
}
$(this).parent().toggleClass('hidden');
$(this).find('small').toggle();
});
}

function navResizeFn(e) {
if (e.which !== 1) {
navResizeFnStop();
return;
}

sessionStorage.navWidth = e.pageX.toString();
$('.nav_wrap').css('width', e.pageX);
$('.nav_wrap').css('-ms-flex', 'inherit');
}

function navResizeFnStop() {
$(window).unbind('mousemove', navResizeFn);
window.removeEventListener('message', navMessageFn, false);
}

function navMessageFn(e) {
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
if (e.data.action === 'mouseup') navResizeFnStop();
}

function navResizer() {
$('#resizer').mousedown(function(e) {
e.preventDefault();
$(window).mousemove(navResizeFn);
window.addEventListener('message', navMessageFn, false);
});
$(window).mouseup(navResizeFnStop);

if (sessionStorage.navWidth) {
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
}
}

function navExpander() {
var done = false, timer = setTimeout(postMessage, 500);
function postMessage() {
if (done) return;
clearTimeout(timer);
var opts = { action: 'expand', path: pathId };
document.getElementById('nav').contentWindow.postMessage(opts, '*');
done = true;
}

window.addEventListener('message', function(event) {
if (event.data === 'navReady') postMessage();
return false;
}, false);
}

function mainFocus() {
var hash = window.location.hash;
if (hash !== '' && $(hash)[0]) {
$(hash)[0].scrollIntoView();
}

setTimeout(function() { $('#main').focus(); }, 10);
}

function navigationChange() {
// This works around the broken anchor navigation with the YARD template.
window.onpopstate = function() {
var hash = window.location.hash;
if (hash !== '' && $(hash)[0]) {
$(hash)[0].scrollIntoView();
}
};
}

$(document).ready(function() {
navResizer();
navExpander();
createSourceLinks();
createDefineLinks();
createFullTreeLinks();
searchFrameButtons();
linkSummaries();
summaryToggle();
constantSummaryToggle();
generateTOC();
mainFocus();
navigationChange();
});

})();
Loading

0 comments on commit dca3449

Please sign in to comment.