Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor baseUrl into variablePreprocessor #1239

Merged
merged 2 commits into from
Jun 26, 2020
Merged

Refactor baseUrl into variablePreprocessor #1239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a633690
Refactor baseUrl into variablePreprocessor
ang-zeyu Jun 25, 2020
ca8b330
Remove xmlMode reliance
ang-zeyu Jun 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 36 additions & 64 deletions src/Page.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const cheerio = require('cheerio');
const cheerio = require('cheerio'); require('./lib/markbind/src/patches/htmlparser2');
const fm = require('fastmatter');
const fs = require('fs-extra-promise');
const htmlBeautify = require('js-beautify').html;
Expand All @@ -18,7 +18,6 @@ const logger = require('./util/logger');
const MarkBind = require('./lib/markbind/src/parser');
const md = require('./lib/markbind/src/lib/markdown-it');
const utils = require('./lib/markbind/src/utils');
const urlUtils = require('./lib/markbind/src/utils/urls');

const CLI_VERSION = require('../package.json').version;

Expand Down Expand Up @@ -57,7 +56,6 @@ const {
TEMP_DROPDOWN_PLACEHOLDER_CLASS,
} = require('./constants');

cheerio.prototype.options.xmlMode = true; // Enable xml mode for self-closing tag
cheerio.prototype.options.decodeEntities = false; // Don't escape HTML entities

class Page {
Expand Down Expand Up @@ -597,7 +595,7 @@ class Page {
// Insert content
.then(result => njUtil.renderRaw(result, {
[LAYOUT_PAGE_BODY_VARIABLE]: pageData,
}, {}, false));
}));
}


Expand Down Expand Up @@ -707,11 +705,11 @@ class Page {
const siteNavHtml = md.render(navigationElements.length === 0
? siteNavMappedData.replace(SITE_NAV_EMPTY_LINE_REGEX, '\n')
: navigationElements.html().replace(SITE_NAV_EMPTY_LINE_REGEX, '\n'));
const $nav = cheerio.load(siteNavHtml, { xmlMode: false });
const $nav = cheerio.load(siteNavHtml);

// Add anchor classes and highlight current page's anchor, if any.
const currentPageHtmlPath = this.src.replace(/\.(md|mbd)$/, '.html');
const currentPageRegex = new RegExp(`{{ *baseUrl *}}/${currentPageHtmlPath}`);
const currentPageRegex = new RegExp(`${this.baseUrl}/${currentPageHtmlPath}`);
$nav('a[href]').each((i, elem) => {
if (currentPageRegex.test($nav(elem).attr('href'))) {
$nav(elem).addClass('current');
Expand Down Expand Up @@ -845,7 +843,7 @@ class Page {
*/
buildPageNav() {
if (this.isPageNavigationSpecifierValid()) {
const $ = cheerio.load(this.content, { xmlMode: false });
const $ = cheerio.load(this.content);
this.navigableHeadings = {};
this.collectNavigableHeadings($(`#${CONTENT_WRAPPER_ID}`).html());
const pageNavTitleHtml = this.generatePageNavTitleHtml();
Expand All @@ -862,7 +860,7 @@ class Page {
}
}

collectHeadFiles(baseUrl, hostBaseUrl) {
collectHeadFiles() {
const { head } = this.frontMatter;
if (head === FRONT_MATTER_NONE_ATTR) {
this.headFileTopContent = '';
Expand Down Expand Up @@ -890,18 +888,13 @@ class Page {
const headFileMappedData = this.variablePreprocessor.renderSiteVariables(this.sourcePath,
headFileContent).trim();
// Split top and bottom contents
const $ = cheerio.load(headFileMappedData, { xmlMode: false });
const $ = cheerio.load(headFileMappedData);
if ($('head-top').length) {
collectedTopContent.push(njUtil.renderRaw($('head-top').html(), {
baseUrl,
hostBaseUrl,
}).trim().replace(/\n\s*\n/g, '\n').replace(/\n/g, '\n '));
collectedTopContent.push($('head-top').html().trim().replace(/\n\s*\n/g, '\n')
.replace(/\n/g, '\n '));
$('head-top').remove();
}
collectedBottomContent.push(njUtil.renderRaw($.html(), {
baseUrl,
hostBaseUrl,
}).trim().replace(/\n\s*\n/g, '\n').replace(/\n/g, '\n '));
collectedBottomContent.push($.html().trim().replace(/\n\s*\n/g, '\n').replace(/\n/g, '\n '));
});
this.headFileTopContent = collectedTopContent.join('\n ');
this.headFileBottomContent = collectedBottomContent.join('\n ');
Expand All @@ -924,7 +917,7 @@ class Page {
}

collectPageSection(section) {
const $ = cheerio.load(this.content, { xmlMode: false });
const $ = cheerio.load(this.content);
const pageSection = $(section);
if (pageSection.length === 0) {
return;
Expand Down Expand Up @@ -962,6 +955,7 @@ class Page {
*/
const fileConfig = {
baseUrlMap: this.baseUrlMap,
baseUrl: this.baseUrl,
rootPath: this.rootPath,
headerIdMap: this.headerIdMap,
fixedHeader: this.fixedHeader,
Expand All @@ -981,27 +975,16 @@ class Page {
.then(result => this.insertHeaderFile(result, fileConfig))
.then(result => this.insertFooterFile(result))
.then(result => Page.insertTemporaryStyles(result))
.then(result => markbinder.resolveBaseUrl(result, fileConfig))
.then(result => markbinder.render(result, this.sourcePath, fileConfig))
.then(result => this.postRender(result))
.then(result => this.collectPluginsAssets(result))
.then(result => markbinder.processDynamicResources(this.sourcePath, result))
.then(result => MarkBind.processDynamicResources(this.sourcePath, result, fileConfig))
.then(result => MarkBind.unwrapIncludeSrc(result))
.then((result) => {
this.content = result;

const { relative } = urlUtils.getParentSiteAbsoluteAndRelativePaths(this.sourcePath, this.rootPath,
this.baseUrlMap);
const baseUrl = relative ? `${this.baseUrl}/${utils.ensurePosix(relative)}` : this.baseUrl;
const hostBaseUrl = this.baseUrl;
this.addLayoutScriptsAndStyles();
this.collectHeadFiles();

this.addLayoutFiles();
this.collectHeadFiles(baseUrl, hostBaseUrl);

this.content = njUtil.renderString(this.content, {
baseUrl,
hostBaseUrl,
});
this.content = result;

this.collectAllPageSections();
this.buildPageNav();
Expand Down Expand Up @@ -1089,7 +1072,7 @@ class Page {
pageContextSources.forEach((src) => {
if (src === undefined || src === '' || utils.isUrl(src)) {
return;
} else if (utils.isAbsolutePath(src)) {
} else if (path.isAbsolute(src)) {
self.pluginSourceFiles.add(path.resolve(src));
return;
}
Expand All @@ -1103,7 +1086,7 @@ class Page {
}

if (domTagSourcesMap) {
const $ = cheerio.load(content, { xmlMode: true });
const $ = cheerio.load(content);

domTagSourcesMap.forEach(([tagName, attrName]) => {
if (!_.isString(tagName) || !_.isString(attrName)) {
Expand All @@ -1121,7 +1104,7 @@ class Page {
src = ensurePosix(src);
if (src === '' || utils.isUrl(src)) {
return;
} else if (utils.isAbsolutePath(src)) {
} else if (path.isAbsolute(src)) {
self.pluginSourceFiles.add(path.resolve(src));
return;
}
Expand Down Expand Up @@ -1182,7 +1165,7 @@ class Page {
* @return String html of the element, with the attribute's asset resolved
*/
getResolvedAssetElement(assetElementHtml, tagName, attrName, plugin, pluginName) {
const $ = cheerio.load(assetElementHtml, { xmlMode: false });
const $ = cheerio.load(assetElementHtml);
const el = $(`${tagName}[${attrName}]`);

el.attr(attrName, (i, assetPath) => {
Expand Down Expand Up @@ -1245,7 +1228,7 @@ class Page {
/**
* Adds linked layout files to page assets
*/
addLayoutFiles() {
addLayoutScriptsAndStyles() {
this.asset.layoutScript = path.join(this.layoutsAssetPath, this.frontMatter.layout, 'scripts.js');
this.asset.layoutStyle = path.join(this.layoutsAssetPath, this.frontMatter.layout, 'styles.css');
}
Expand All @@ -1272,41 +1255,30 @@ class Page {
const markbinder = new MarkBind({
variablePreprocessor: this.variablePreprocessor,
});
/**
* @type {FileConfig}
*/
const fileConfig = {
baseUrlMap: this.baseUrlMap,
baseUrl: this.baseUrl,
rootPath: this.rootPath,
headerIdMap: {},
cwf: file,
};
return fs.readFileAsync(dependency.to, 'utf-8')
.then(result => markbinder.includeFile(dependency.to, result, {
baseUrlMap: this.baseUrlMap,
rootPath: this.rootPath,
cwf: file,
}))
.then(result => markbinder.includeFile(dependency.to, result, fileConfig))
.then(result => Page.removeFrontMatter(result))
.then(result => this.collectPluginSources(result))
.then(result => this.preRender(result))
.then(result => markbinder.resolveBaseUrl(result, {
baseUrlMap: this.baseUrlMap,
rootPath: this.rootPath,
}))
.then(result => markbinder.render(result, this.sourcePath, {
baseUrlMap: this.baseUrlMap,
rootPath: this.rootPath,
headerIdMap: {},
}))
.then(result => markbinder.render(result, this.sourcePath, fileConfig))
.then(result => this.postRender(result))
.then(result => this.collectPluginsAssets(result))
.then(result => markbinder.processDynamicResources(file, result))
.then(result => MarkBind.processDynamicResources(file, result, fileConfig))
.then(result => MarkBind.unwrapIncludeSrc(result))
.then((result) => {
// resolve the site base url here
const { relative } = urlUtils.getParentSiteAbsoluteAndRelativePaths(file, this.rootPath,
this.baseUrlMap);
const baseUrl = relative ? `${this.baseUrl}/${utils.ensurePosix(relative)}` : this.baseUrl;
const hostBaseUrl = this.baseUrl;
const content = njUtil.renderString(result, {
baseUrl,
hostBaseUrl,
});
const outputContentHTML = this.disableHtmlBeautify
? content
: htmlBeautify(content, Page.htmlBeautifyOptions);
? result
: htmlBeautify(result, Page.htmlBeautifyOptions);
return fs.outputFileAsync(resultPath, outputContentHTML);
})
.then(() => {
Expand Down
17 changes: 10 additions & 7 deletions src/Site.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
const cheerio = require('cheerio');
const cheerio = require('cheerio'); require('./lib/markbind/src/patches/htmlparser2');
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added this in all files to ensure unit tests load the patch, which is more than ever important with the extra 2 "patches" for recognizeSelfClosing and lowerCaseAttributeNames

const fs = require('fs-extra-promise');
const ghpages = require('gh-pages');
const ignore = require('ignore');
Expand All @@ -11,6 +11,7 @@ const njUtil = require('./lib/markbind/src/utils/nunjuckUtils');
const injectHtmlParser2SpecialTags = require('./lib/markbind/src/patches/htmlparser2');
const injectMarkdownItSpecialTags = require(
'./lib/markbind/src/lib/markdown-it/markdown-it-escape-special-tags');
const utils = require('./lib/markbind/src/utils');

const _ = {};
_.difference = require('lodash/difference');
Expand Down Expand Up @@ -524,8 +525,6 @@ class Site {
* Collects the user defined variables map in the site/subsites
*/
collectUserDefinedVariablesMap() {
// The key is the base directory of the site/subsites,
// while the value is a mapping of user defined variables
this.variablePreprocessor.resetUserDefinedVariablesMap();

this.baseUrlMap.forEach((base) => {
Expand All @@ -540,13 +539,17 @@ class Site {
}

/*
This is to prevent the first nunjuck call from converting {{baseUrl}} to an empty string
and let the baseUrl value be injected later.
We retrieve the baseUrl of the (sub)site by appending the relative to the configured base url
i.e. We ignore the configured baseUrl of the sub sites.
*/
this.variablePreprocessor.addUserDefinedVariable(base, 'baseUrl', '{{baseUrl}}');
const siteRelativePathFromRoot = utils.ensurePosix(path.relative(this.rootPath, base));
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the main functional change, the rest are just necessary changes due to the tight coupling of xmlMode/rendering order/using it to unescape escaped html from removing resolveBaseUrl

We simply add the correct baseUrl for each (sub)site as a variable directly into variablePreprocessor (previously userDefinedVariablesMap)

const siteBaseUrl = siteRelativePathFromRoot === ''
? this.siteConfig.baseUrl
: path.posix.join(this.siteConfig.baseUrl || '/', siteRelativePathFromRoot);
this.variablePreprocessor.addUserDefinedVariable(base, 'baseUrl', siteBaseUrl);
this.variablePreprocessor.addUserDefinedVariable(base, 'MarkBind', MARKBIND_LINK_HTML);

const $ = cheerio.load(content);
const $ = cheerio.load(content, { decodeEntities: false });
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

{ decodeEntities: false } here as this file dosen't have the cheerio.prototype.options.decodeEntities = false; line like the others, and is the only cheerio.load call in the file

$('variable,span').each((index, element) => {
const name = $(element).attr('name') || $(element).attr('id');
const variableSource = $(element).attr('from');
Expand Down
1 change: 0 additions & 1 deletion src/lib/markbind/src/constants.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
module.exports = {
// src/lib/markbind/src/parser.js
ATTRIB_INCLUDE_PATH: 'include-path',
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

previously used for _rebaseReference

ATTRIB_CWF: 'cwf',

BOILERPLATE_FOLDER_NAME: '_markbind/boilerplates',
Expand Down
Loading