refactor(theme/book): Split into modules (#556)

Advantages:
 - Easier to reason about
 - Can easily disable some modules when debugging
 - Shared dependencies are explicit (playpen_text)
 - Enables some fancier things later one (e.g. run `codeSnippets` slightly later, to avoid blocking the page)

I'm aware that `codeSnippets` should be split into the highlighter and the editor, but I'm not sure I understand exactly how they interact so I've left it as it is for now.
This commit is contained in:
Sorin Davidoi 2018-01-21 16:01:57 +01:00 committed by Michael Bryan
parent 9fe19d8f31
commit 05e4157c2e
1 changed files with 359 additions and 354 deletions

View File

@ -1,18 +1,115 @@
var html, sidebar, sidebarLinks, sidebarToggleButton, themeToggleButton, themePopup;
document.addEventListener('DOMContentLoaded', function() {
// url
var url = window.location.pathname;
// Fix back button cache problem // Fix back button cache problem
window.onunload = function () { }; window.onunload = function () { };
// Set theme // Global variable, shared between modules
var theme = store.get('mdbook-theme'); function playpen_text(playpen) {
if (theme === null || theme === undefined) { theme = 'light'; } let code_block = playpen.querySelector("code");
set_theme(theme); if (window.ace && code_block.classList.contains("editable")) {
let editor = window.ace.edit(code_block);
return editor.getValue();
} else {
return code_block.textContent;
}
}
(function codeSnippets() {
// Hide Rust code lines prepended with a specific character
var hiding_character = "#";
var request = fetch("https://play.rust-lang.org/meta/crates", {
headers: {
'Content-Type': "application/json",
},
method: 'POST',
mode: 'cors',
});
function handle_crate_list_update(playpen_block, playground_crates) {
// update the play buttons after receiving the response
update_play_button(playpen_block, playground_crates);
// and install on change listener to dynamically update ACE editors
if (window.ace) {
let code_block = playpen_block.querySelector("code");
if (code_block.classList.contains("editable")) {
let editor = window.ace.edit(code_block);
editor.addEventListener("change", function (e) {
update_play_button(playpen_block, playground_crates);
});
}
}
}
// updates the visibility of play button based on `no_run` class and
// used crates vs ones available on http://play.rust-lang.org
function update_play_button(pre_block, playground_crates) {
var play_button = pre_block.querySelector(".play-button");
// skip if code is `no_run`
if (pre_block.querySelector('code').classList.contains("no_run")) {
play_button.classList.add("hidden");
return;
}
// get list of `extern crate`'s from snippet
var txt = playpen_text(pre_block);
var re = /extern\s+crate\s+([a-zA-Z_0-9]+)\s*;/g;
var snippet_crates = [];
while (item = re.exec(txt)) {
snippet_crates.push(item[1]);
}
// check if all used crates are available on play.rust-lang.org
var all_available = snippet_crates.every(function (elem) {
return playground_crates.indexOf(elem) > -1;
});
if (all_available) {
play_button.classList.remove("hidden");
} else {
play_button.classList.add("hidden");
}
}
function run_rust_code(code_block) {
var result_block = code_block.querySelector(".result");
if (!result_block) {
result_block = document.createElement('code');
result_block.className = 'result hljs language-bash';
code_block.append(result_block);
}
let text = playpen_text(code_block);
var params = {
channel: "stable",
mode: "debug",
crateType: "bin",
tests: false,
code: text,
}
if (text.indexOf("#![feature") !== -1) {
params.channel = "nightly";
}
result_block.innerText = "Running...";
var request = fetch("https://play.rust-lang.org/execute", {
headers: {
'Content-Type': "application/json",
},
method: 'POST',
mode: 'cors',
body: JSON.stringify(params)
});
request
.then(function (response) { return response.json(); })
.then(function (response) { result_block.innerText = response.success ? response.stdout : response.stderr; })
.catch(function (error) { result_block.innerText = "Playground communication" + error.message; });
}
// Syntax highlighting Configuration // Syntax highlighting Configuration
hljs.configure({ hljs.configure({
@ -42,143 +139,6 @@ document.addEventListener('DOMContentLoaded', function() {
.from(document.querySelectorAll('code')) .from(document.querySelectorAll('code'))
.forEach(function (block) { block.classList.add('hljs'); }); .forEach(function (block) { block.classList.add('hljs'); });
var KEY_CODES = {
PREVIOUS_KEY: 37,
NEXT_KEY: 39,
ESCAPE_KEY: 27,
};
document.addEventListener('keydown', function (e) {
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
switch (e.keyCode) {
case KEY_CODES.NEXT_KEY:
e.preventDefault();
var nextButton = document.querySelector('.nav-chapters.next');
if(nextButton) {
window.location.href = nextButton.href;
}
break;
case KEY_CODES.PREVIOUS_KEY:
e.preventDefault();
var previousButton = document.querySelector('.nav-chapters.previous');
if(previousButton) {
window.location.href = previousButton.href;
}
break;
case KEY_CODES.ESCAPE_KEY:
e.preventDefault();
hideThemes();
break;
}
});
// Interesting DOM Elements
html = document.querySelector('html');
sidebar = document.getElementById("sidebar");
sidebarLinks = document.querySelectorAll('#sidebar a');
sidebarToggleButton = document.getElementById("sidebar-toggle");
themeToggleButton = document.getElementById('theme-toggle');
themePopup = document.getElementById('theme-list');
// Toggle sidebar
sidebarToggleButton.addEventListener('click', sidebarToggle);
// Scroll sidebar to current active section
var activeSection = sidebar.querySelector(".active");
if(activeSection) {
sidebar.scrollTop = activeSection.offsetTop;
}
var firstContact = null;
document.addEventListener('touchstart', function(e) {
firstContact = {
x: e.touches[0].clientX,
time: Date.now()
};
});
document.addEventListener('touchmove', function(e) {
if (!firstContact)
return;
var curX = e.touches[0].clientX;
var xDiff = curX - firstContact.x,
tDiff = Date.now() - firstContact.time;
if (tDiff < 250 && Math.abs(xDiff) >= 150) {
if (xDiff >= 0 && firstContact.x < Math.min(document.body.clientWidth * 0.25, 300))
showSidebar();
else if (xDiff < 0 && curX < 300)
hideSidebar();
firstContact = null;
}
});
// Theme button
themeToggleButton.addEventListener('click', function(){
if (themePopup.style.display === 'block') {
hideThemes();
} else {
showThemes();
}
});
themePopup.addEventListener('click', function(e){
var theme = e.target.id || e.target.parentElement.id;
set_theme(theme);
});
// Hide theme selector popup when clicking outside of it
document.addEventListener('click', function(event){
if(themePopup.style.display === 'block' && !themeToggleButton.contains(event.target) && !themePopup.contains(event.target)) {
hideThemes();
}
});
function set_theme(theme) {
let ace_theme;
if (theme == 'coal' || theme == 'navy') {
document.querySelector("[href='ayu-highlight.css']").disabled = true;
document.querySelector("[href='tomorrow-night.css']").disabled = false;
document.querySelector("[href='highlight.css']").disabled = true;
ace_theme = "ace/theme/tomorrow_night";
} else if (theme == 'ayu') {
document.querySelector("[href='ayu-highlight.css']").disabled = false;
document.querySelector("[href='tomorrow-night.css']").disabled = true;
document.querySelector("[href='highlight.css']").disabled = true;
ace_theme = "ace/theme/tomorrow_night";
} else {
document.querySelector("[href='ayu-highlight.css']").disabled = true;
document.querySelector("[href='tomorrow-night.css']").disabled = true;
document.querySelector("[href='highlight.css']").disabled = false;
ace_theme = "ace/theme/dawn";
}
setTimeout(function() {
document.querySelector('meta[name="theme-color"]').content = getComputedStyle(document.body).backgroundColor;
}, 1);
if (window.ace && window.editors) {
window.editors.forEach(function(editor) {
editor.setTheme(ace_theme);
});
}
store.set('mdbook-theme', theme);
document.body.className = theme;
}
// Hide Rust code lines prepended with a specific character
var hiding_character = "#";
Array.from(document.querySelectorAll("code.language-rust")).forEach(function (block) { Array.from(document.querySelectorAll("code.language-rust")).forEach(function (block) {
var code_block = block; var code_block = block;
@ -260,9 +220,6 @@ document.addEventListener('DOMContentLoaded', function() {
clipButton.innerHTML = '<i class=\"tooltiptext\"></i>'; clipButton.innerHTML = '<i class=\"tooltiptext\"></i>';
buttons.prepend(clipButton); buttons.prepend(clipButton);
clipButton.addEventListener('mouseout', function(e){
hideTooltip(e.currentTarget);
});
} }
}); });
@ -292,9 +249,6 @@ document.addEventListener('DOMContentLoaded', function() {
runCodeButton.addEventListener('click', function (e) { runCodeButton.addEventListener('click', function (e) {
run_rust_code(pre_block); run_rust_code(pre_block);
}); });
copyCodeClipboardButton.addEventListener('mouseout', function(e){
hideTooltip(e.currentTarget);
});
let code_block = pre_block.querySelector("code"); let code_block = pre_block.querySelector("code");
if (window.ace && code_block.classList.contains("editable")) { if (window.ace && code_block.classList.contains("editable")) {
@ -312,29 +266,6 @@ document.addEventListener('DOMContentLoaded', function() {
} }
}); });
var clipboardSnippets = new Clipboard('.clip-button', {
text: function(trigger) {
hideTooltip(trigger);
let playpen = trigger.closest("pre");
return playpen_text(playpen);
}
});
clipboardSnippets.on('success', function(e) {
e.clearSelection();
showTooltip(e.trigger, "Copied!");
});
clipboardSnippets.on('error', function(e) {
showTooltip(e.trigger, "Clipboard error!");
});
var request = fetch("https://play.rust-lang.org/meta/crates", {
headers: {
'Content-Type': "application/json",
},
method: 'POST',
mode: 'cors',
});
request request
.then(function (response) { return response.json(); }) .then(function (response) { return response.json(); })
.then(function (response) { .then(function (response) {
@ -345,90 +276,17 @@ document.addEventListener('DOMContentLoaded', function() {
}); });
}); });
}); })();
function playpen_text(playpen) { (function themes() {
let code_block = playpen.querySelector("code"); var themeToggleButton = document.getElementById('theme-toggle');
var themePopup = document.getElementById('theme-list');
if (window.ace && code_block.classList.contains("editable")) { var themeColorMetaTag = document.querySelector('meta[name="theme-color"]');
let editor = window.ace.edit(code_block); var stylesheets = {
return editor.getValue(); ayuHighlight: document.querySelector("[href='ayu-highlight.css']"),
} else { tomorrowNight: document.querySelector("[href='tomorrow-night.css']"),
return code_block.textContent; highlight: document.querySelector("[href='highlight.css']"),
} };
}
function handle_crate_list_update(playpen_block, playground_crates) {
// update the play buttons after receiving the response
update_play_button(playpen_block, playground_crates);
// and install on change listener to dynamically update ACE editors
if (window.ace) {
let code_block = playpen_block.querySelector("code");
if (code_block.classList.contains("editable")) {
let editor = window.ace.edit(code_block);
editor.addEventListener("change", function(e){
update_play_button(playpen_block, playground_crates);
});
}
}
}
// updates the visibility of play button based on `no_run` class and
// used crates vs ones available on http://play.rust-lang.org
function update_play_button(pre_block, playground_crates) {
var play_button = pre_block.querySelector(".play-button");
// skip if code is `no_run`
if (pre_block.querySelector('code').classList.contains("no_run")) {
play_button.classList.add("hidden");
return;
}
// get list of `extern crate`'s from snippet
var txt = playpen_text(pre_block);
var re = /extern\s+crate\s+([a-zA-Z_0-9]+)\s*;/g;
var snippet_crates = [];
while (item = re.exec(txt)) {
snippet_crates.push(item[1]);
}
// check if all used crates are available on play.rust-lang.org
var all_available = snippet_crates.every(function(elem) {
return playground_crates.indexOf(elem) > -1;
});
if (all_available) {
play_button.classList.remove("hidden");
} else {
play_button.classList.add("hidden");
}
}
function hideTooltip(elem) {
elem.firstChild.innerText="";
elem.className = 'fa fa-copy clip-button';
}
function showTooltip(elem, msg) {
elem.firstChild.innerText=msg;
elem.className = 'fa fa-copy tooltipped';
}
function sidebarToggle() {
var html = document.querySelector("html");
if (html.classList.contains("sidebar-hidden")) {
showSidebar();
} else if (html.classList.contains("sidebar-visible")) {
hideSidebar();
} else {
if (getComputedStyle(sidebar)['transform'] === 'none'){
hideSidebar();
} else {
showSidebar();
}
}
}
function showThemes() { function showThemes() {
themePopup.style.display = 'block'; themePopup.style.display = 'block';
@ -440,6 +298,87 @@ function hideThemes() {
themeToggleButton.setAttribute('aria-expanded', false); themeToggleButton.setAttribute('aria-expanded', false);
} }
function set_theme(theme) {
let ace_theme;
if (theme == 'coal' || theme == 'navy') {
stylesheets.ayuHighlight.disabled = true;
stylesheets.tomorrowNight.disabled = false;
stylesheets.highlight.disabled = true;
ace_theme = "ace/theme/tomorrow_night";
} else if (theme == 'ayu') {
stylesheets.ayuHighlight.disabled = false;
stylesheets.tomorrowNight.disabled = true;
stylesheets.highlight.disabled = true;
ace_theme = "ace/theme/tomorrow_night";
} else {
stylesheets.ayuHighlight.disabled = true;
stylesheets.tomorrowNight.disabled = true;
stylesheets.highlight.disabled = false;
ace_theme = "ace/theme/dawn";
}
setTimeout(function () {
themeColorMetaTag.content = getComputedStyle(document.body).backgroundColor;
}, 1);
if (window.ace && window.editors) {
window.editors.forEach(function (editor) {
editor.setTheme(ace_theme);
});
}
store.set('mdbook-theme', theme);
document.body.className = theme;
}
// Set theme
var theme = store.get('mdbook-theme');
if (theme === null || theme === undefined) { theme = 'light'; }
set_theme(theme);
themeToggleButton.addEventListener('click', function () {
if (themePopup.style.display === 'block') {
hideThemes();
} else {
showThemes();
}
});
themePopup.addEventListener('click', function (e) {
var theme = e.target.id || e.target.parentElement.id;
set_theme(theme);
});
// Hide theme selector popup when clicking outside of it
document.addEventListener('click', function (event) {
if (themePopup.style.display === 'block' && !themeToggleButton.contains(event.target) && !themePopup.contains(event.target)) {
hideThemes();
}
});
document.addEventListener('keydown', function (e) {
switch (e.key) {
case 'Escape':
e.preventDefault();
hideThemes();
break;
}
});
})();
(function sidebar() {
var html = document.querySelector("html");
var sidebar = document.getElementById("sidebar");
var sidebarLinks = document.querySelectorAll('#sidebar a');
var sidebarToggleButton = document.getElementById("sidebar-toggle");
var firstContact = null;
function showSidebar() { function showSidebar() {
html.classList.remove('sidebar-hidden') html.classList.remove('sidebar-hidden')
html.classList.add('sidebar-visible'); html.classList.add('sidebar-visible');
@ -462,45 +401,112 @@ function hideSidebar() {
store.set('mdbook-sidebar', 'hidden'); store.set('mdbook-sidebar', 'hidden');
} }
function run_rust_code(code_block) { // Toggle sidebar
var result_block = code_block.querySelector(".result"); sidebarToggleButton.addEventListener('click', function sidebarToggle() {
if(!result_block) { if (html.classList.contains("sidebar-hidden")) {
result_block = document.createElement('code'); showSidebar();
result_block.className = 'result hljs language-bash'; } else if (html.classList.contains("sidebar-visible")) {
hideSidebar();
code_block.append(result_block); } else {
if (getComputedStyle(sidebar)['transform'] === 'none') {
hideSidebar();
} else {
showSidebar();
} }
let text = playpen_text(code_block);
var params = {
channel: "stable",
mode: "debug",
crateType: "bin",
tests: false,
code: text,
} }
if(text.indexOf("#![feature") !== -1) {
params.channel = "nightly";
}
result_block.innerText = "Running...";
var request = fetch("https://play.rust-lang.org/execute", {
headers: {
'Content-Type': "application/json",
},
method: 'POST',
mode: 'cors',
body: JSON.stringify(params)
}); });
request document.addEventListener('touchstart', function (e) {
.then(function(response) { return response.json(); }) firstContact = {
.then(function(response) { result_block.innerText = response.success ? response.stdout : response.stderr; }) x: e.touches[0].clientX,
.catch(function(error) { result_block.innerText = "Playground communication" + error.message; }); time: Date.now()
};
});
document.addEventListener('touchmove', function (e) {
if (!firstContact)
return;
var curX = e.touches[0].clientX;
var xDiff = curX - firstContact.x,
tDiff = Date.now() - firstContact.time;
if (tDiff < 250 && Math.abs(xDiff) >= 150) {
if (xDiff >= 0 && firstContact.x < Math.min(document.body.clientWidth * 0.25, 300))
showSidebar();
else if (xDiff < 0 && curX < 300)
hideSidebar();
firstContact = null;
} }
});
// Scroll sidebar to current active section
var activeSection = sidebar.querySelector(".active");
if (activeSection) {
sidebar.scrollTop = activeSection.offsetTop;
}
})();
(function chapterNavigation() {
document.addEventListener('keydown', function (e) {
if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { return; }
switch (e.key) {
case 'ArrowRight':
e.preventDefault();
var nextButton = document.querySelector('.nav-chapters.next');
if (nextButton) {
window.location.href = nextButton.href;
}
break;
case 'ArrowLeft':
e.preventDefault();
var previousButton = document.querySelector('.nav-chapters.previous');
if (previousButton) {
window.location.href = previousButton.href;
}
break;
}
});
})();
(function clipboard() {
var clipButtons = document.querySelectorAll('.clip-button');
function hideTooltip(elem) {
elem.firstChild.innerText = "";
elem.className = 'fa fa-copy clip-button';
}
function showTooltip(elem, msg) {
elem.firstChild.innerText = msg;
elem.className = 'fa fa-copy tooltipped';
}
var clipboardSnippets = new Clipboard('.clip-button', {
text: function (trigger) {
hideTooltip(trigger);
let playpen = trigger.closest("pre");
return playpen_text(playpen);
}
});
Array.from(clipButtons).forEach(function (clipButton) {
clipButton.addEventListener('mouseout', function (e) {
hideTooltip(e.currentTarget);
});
});
clipboardSnippets.on('success', function (e) {
e.clearSelection();
showTooltip(e.trigger, "Copied!");
});
clipboardSnippets.on('error', function (e) {
showTooltip(e.trigger, "Clipboard error!");
});
})();
(function autoHideMenu() { (function autoHideMenu() {
var scrollingContainer = document.querySelector('html'); var scrollingContainer = document.querySelector('html');
@ -524,6 +530,5 @@ function run_rust_code(code_block) {
} }
previousScrollTop = scrollingContainer.scrollTop; previousScrollTop = scrollingContainer.scrollTop;
hideThemes();
}, { passive: true }); }, { passive: true });
})(); })();