mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-17 21:41:49 +03:00
243b387063
refs #8126, #8221, #8223 ✨ New 'Proxy' for all helper requires - this is not currently enforced, but could be, much like apps - the proxy object is HUGE - changed date to use SafeString, this should have been there anyway - use the proxy for all helpers, including those in apps 😁 ✨ 🎨 Single instance of hbs for theme + for errors - we now have theme/engine instead of requiring express-hbs everywhere - only error-handler still also requires express-hbs, this is so that we can render errors without extra crud - TODO: remove the asset helper after #8126 IF it is not needed, or else remove the TODO 🎨 Cleanup visibility utils 🎨 Clean up the proxy a little bit 🚨 Unskip test as it now works! 🎨 Minor amends as per comments
113 lines
3.7 KiB
JavaScript
113 lines
3.7 KiB
JavaScript
'use strict';
|
|
|
|
/**
|
|
* # Active Theme
|
|
*
|
|
* This file defines a class of active theme, and also controls the getting and setting a single instance, as there
|
|
* can only ever be one active theme. Unlike a singleton, the active theme can change, however only in a controlled way.
|
|
*
|
|
* I've made use of the new class & constructor syntax here, as we are now only supporting Node v4 and above, which has
|
|
* full support for these features.
|
|
*
|
|
* There are several different patterns available for keeping data private. Elsewhere in Ghost we use the
|
|
* naming convention of the _ prefix. Even though this has the downside of not being truly private, it is still one
|
|
* of the preferred options for keeping data private with the new class syntax, therefore I have kept it.
|
|
*
|
|
* No properties marked with an _ should be used directly.
|
|
*
|
|
*/
|
|
var _ = require('lodash'),
|
|
join = require('path').join,
|
|
themeConfig = require('./config'),
|
|
config = require('../config'),
|
|
engine = require('./engine'),
|
|
// Current instance of ActiveTheme
|
|
currentActiveTheme;
|
|
|
|
class ActiveTheme {
|
|
/**
|
|
* @TODO this API needs to be simpler, but for now should work!
|
|
* @param {object} loadedTheme - the loaded theme object from the theme list
|
|
* @param {object} checkedTheme - the result of gscan.format for the theme we're activating
|
|
*/
|
|
constructor(loadedTheme, checkedTheme) {
|
|
// Assign some data, mark it all as pseudo-private
|
|
this._name = loadedTheme.name;
|
|
this._path = loadedTheme.path;
|
|
this._mounted = false;
|
|
|
|
// @TODO: get gscan to return validated, useful package.json fields for us!
|
|
this._packageInfo = loadedTheme['package.json'];
|
|
this._partials = checkedTheme.partials;
|
|
// @TODO: get gscan to return a template collection for us
|
|
this._templates = _.reduce(checkedTheme.files, function (templates, entry) {
|
|
var tplMatch = entry.file.match(/(^[^\/]+).hbs$/);
|
|
if (tplMatch) {
|
|
templates.push(tplMatch[1]);
|
|
}
|
|
return templates;
|
|
}, []);
|
|
|
|
// Create a theme config object
|
|
this._config = themeConfig.create(this._packageInfo);
|
|
}
|
|
|
|
get name() {
|
|
return this._name;
|
|
}
|
|
|
|
get path() {
|
|
return this._path;
|
|
}
|
|
|
|
get partialsPath() {
|
|
return this._partials.length > 0 ? join(this.path, 'partials') : null;
|
|
}
|
|
|
|
get mounted() {
|
|
return this._mounted;
|
|
}
|
|
|
|
hasTemplate(templateName) {
|
|
return this._templates.indexOf(templateName) > -1;
|
|
}
|
|
|
|
config(key) {
|
|
return this._config[key];
|
|
}
|
|
|
|
mount(blogApp) {
|
|
// reset the asset hash
|
|
// @TODO: set this on the theme instead of globally, or use proper file-based hash
|
|
config.set('assetHash', null);
|
|
// clear the view cache
|
|
blogApp.cache = {};
|
|
// Set the views and engine
|
|
blogApp.set('views', this.path);
|
|
blogApp.engine('hbs', engine.configure(this.partialsPath));
|
|
|
|
this._mounted = true;
|
|
}
|
|
}
|
|
|
|
module.exports = {
|
|
get() {
|
|
return currentActiveTheme;
|
|
},
|
|
/**
|
|
* Set theme
|
|
*
|
|
* At this point we trust that the theme has been validated.
|
|
* Any handling for invalid themes should happen before we get here
|
|
*
|
|
* @TODO this API needs to be simpler, but for now should work!
|
|
* @param {object} loadedTheme - the loaded theme object from the theme list
|
|
* @param {object} checkedTheme - the result of gscan.format for the theme we're activating
|
|
* @return {ActiveTheme}
|
|
*/
|
|
set(loadedTheme, checkedTheme) {
|
|
currentActiveTheme = new ActiveTheme(loadedTheme, checkedTheme);
|
|
return currentActiveTheme;
|
|
}
|
|
};
|