Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-20 22:42:53 -05:00
Code Issues Activity

🎨 🚨 Split theme tests, clean config & add tests (#8205)

Browse source 
refs #7491

- split themes_spec up into several files
- clean up the code for configuration
- ensure its tested
This commit is contained in:
Hannah Wolfe 2017-03-22 06:52:58 +00:00 • committed by Katharina Irrgang
parent e903be6679
commit 317daf5549
9 changed files with 615 additions and 536 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
core/server/themes/active.js
View file

@ -18,25 +18,13 @@
*/
var _ = require('lodash'),
join = require('path').join,
defaultConfig = require('./defaults.json'),
themeConfig = require('./config'),
config = require('../config'),
// @TODO: remove this require
hbs = require('express-hbs'),
// Current instance of ActiveTheme
currentActiveTheme;
// @TODO: will clean this code up later, honest! (and add tests)
function tempConfigHandler(packageJson) {
var config = _.cloneDeep(defaultConfig),
allowedKeys = ['posts_per_page'];
if (packageJson && packageJson.hasOwnProperty('config')) {
config = _.assign(config, _.pick(packageJson.config, allowedKeys));
}
return config;
}
class ActiveTheme {
/**
* @TODO this API needs to be simpler, but for now should work!
@ -61,8 +49,8 @@ class ActiveTheme {
return templates;
}, []);
// Do something with config here
this._config = tempConfigHandler(this._packageInfo);
// Create a theme config object
this._config = themeConfig.create(this._packageInfo);
}
get name() {

0
core/server/themes/defaults.json → core/server/themes/config/defaults.json
View file

13
core/server/themes/config/index.js Normal file
View file

@ -0,0 +1,13 @@
var _ = require('lodash'),
defaultConfig = require('./defaults'),
allowedKeys = ['posts_per_page'];
module.exports.create = function configLoader(packageJson) {
var config = _.cloneDeep(defaultConfig);
if (packageJson && packageJson.hasOwnProperty('config')) {
config = _.assign(config, _.pick(packageJson.config, allowedKeys));
}
return config;
};

104
core/test/unit/themes/active_spec.js Normal file
View file

@ -0,0 +1,104 @@
var should = require('should'), // jshint ignore:line
sinon = require('sinon'),
hbs = require('express-hbs'),
config = require('../../../server/config'),
// is only exposed via themes.getActive()
activeTheme = require('../../../server/themes/active'),
sandbox = sinon.sandbox.create();
describe('Themes', function () {
afterEach(function () {
sandbox.restore();
});
describe('Active', function () {
describe('Mount', function () {
var hbsStub, configStub,
fakeBlogApp, fakeLoadedTheme, fakeCheckedTheme;
beforeEach(function () {
hbsStub = sandbox.stub(hbs, 'express3');
configStub = sandbox.stub(config, 'set');
fakeBlogApp = {
cache: ['stuff'],
set: sandbox.stub(),
engine: sandbox.stub()
};
fakeLoadedTheme = {
name: 'casper',
path: 'my/fake/theme/path'
};
fakeCheckedTheme = {};
});
it('should mount active theme with partials', function () {
// setup partials
fakeCheckedTheme.partials = ['loop', 'navigation'];
var theme = activeTheme.set(fakeLoadedTheme, fakeCheckedTheme);
// Check the theme is not yet mounted
activeTheme.get().mounted.should.be.false();
// Call mount!
theme.mount(fakeBlogApp);
// Check the asset hash gets reset
configStub.calledOnce.should.be.true();
configStub.calledWith('assetHash', null).should.be.true();
// Check te view cache was cleared
fakeBlogApp.cache.should.eql({});
// Check the views were set correctly
fakeBlogApp.set.calledOnce.should.be.true();
fakeBlogApp.set.calledWith('views', 'my/fake/theme/path').should.be.true();
// Check handlebars was initialised correctly
hbsStub.calledOnce.should.be.true();
hbsStub.firstCall.args[0].should.be.an.Object().and.have.property('partialsDir');
hbsStub.firstCall.args[0].partialsDir.should.be.an.Array().with.lengthOf(2);
hbsStub.firstCall.args[0].partialsDir[1].should.eql('my/fake/theme/path/partials');
// Check the theme is now mounted
activeTheme.get().mounted.should.be.true();
});
it('should mount active theme without partials', function () {
// setup partials
fakeCheckedTheme.partials = [];
var theme = activeTheme.set(fakeLoadedTheme, fakeCheckedTheme);
// Check the theme is not yet mounted
activeTheme.get().mounted.should.be.false();
// Call mount!
theme.mount(fakeBlogApp);
// Check the asset hash gets reset
configStub.calledOnce.should.be.true();
configStub.calledWith('assetHash', null).should.be.true();
// Check te view cache was cleared
fakeBlogApp.cache.should.eql({});
// Check the views were set correctly
fakeBlogApp.set.calledOnce.should.be.true();
fakeBlogApp.set.calledWith('views', 'my/fake/theme/path').should.be.true();
// Check handlebars was initialised correctly
hbsStub.calledOnce.should.be.true();
hbsStub.firstCall.args[0].should.be.an.Object().and.have.property('partialsDir');
hbsStub.firstCall.args[0].partialsDir.should.have.lengthOf(1);
// Check the theme is now mounted
activeTheme.get().mounted.should.be.true();
});
});
});
});

38
core/test/unit/themes/config_spec.js Normal file
View file

@ -0,0 +1,38 @@
var should = require('should'), // jshint ignore:line
sinon = require('sinon'),
themeConfig = require('../../../server/themes/config'),
sandbox = sinon.sandbox.create();
describe('Themes', function () {
afterEach(function () {
sandbox.restore();
});
describe('Config', function () {
it('handles no package.json', function () {
var config = themeConfig.create();
config.should.eql({posts_per_page: 5});
});
it('handles package.json without config', function () {
var config = themeConfig.create({name: 'casper'});
config.should.eql({posts_per_page: 5});
});
it('handles allows package.json to overrideg default', function () {
var config = themeConfig.create({name: 'casper', config: {posts_per_page: 3}});
config.should.eql({posts_per_page: 3});
});
it('handles ignores non-allowed config', function () {
var config = themeConfig.create({name: 'casper', config: {magic: 'roundabout'}});
config.should.eql({posts_per_page: 5});
});
});
});

83
core/test/unit/themes/list_spec.js Normal file
View file

@ -0,0 +1,83 @@
var should = require('should'), // jshint ignore:line
sinon = require('sinon'),
_ = require('lodash'),
themes = require('../../../server/themes'),
themeList = themes.list,
sandbox = sinon.sandbox.create();
describe('Themes', function () {
afterEach(function () {
sandbox.restore();
});
describe('List', function () {
beforeEach(function () {
themeList.init({
casper: {foo: 'bar'},
'not-casper': {bar: 'baz'}
});
});
it('get() allows getting a single theme', function () {
themeList.get('casper').should.eql({foo: 'bar'});
});
it('get() with no args should do nothing', function () {
should.not.exist(themeList.get());
});
it('getAll() returns all themes', function () {
themeList.getAll().should.be.an.Object().with.properties('casper', 'not-casper');
Object.keys(themeList.getAll()).should.have.length(2);
});
it('set() updates an existing theme', function () {
var origCasper = _.cloneDeep(themeList.get('casper'));
themeList.set('casper', {magic: 'update'});
themeList.get('casper').should.not.eql(origCasper);
themeList.get('casper').should.eql({magic: 'update'});
});
it('set() can add a new theme', function () {
themeList.set('rasper', {color: 'red'});
themeList.get('rasper').should.eql({color: 'red'});
});
it('del() removes a key from the list', function () {
should.exist(themeList.get('casper'));
should.exist(themeList.get('not-casper'));
themeList.del('casper');
should.not.exist(themeList.get('casper'));
should.exist(themeList.get('not-casper'));
});
it('del() with no argument does nothing', function () {
should.exist(themeList.get('casper'));
should.exist(themeList.get('not-casper'));
themeList.del();
should.exist(themeList.get('casper'));
should.exist(themeList.get('not-casper'));
});
it('init() calls set for each theme', function () {
var setSpy = sandbox.spy(themeList, 'set');
themeList.init({test: {a: 'b'}, casper: {c: 'd'}});
setSpy.calledTwice.should.be.true();
setSpy.firstCall.calledWith('test', {a: 'b'}).should.be.true();
setSpy.secondCall.calledWith('casper', {c: 'd'}).should.be.true();
});
it('init() with empty object resets the list', function () {
themeList.init();
var result = themeList.getAll();
should.exist(result);
result.should.be.an.Object();
result.should.eql({});
Object.keys(result).should.have.length(0);
});
});
});

146
core/test/unit/themes/loader_spec.js Normal file
View file

@ -0,0 +1,146 @@
var should = require('should'), // jshint ignore:line
sinon = require('sinon'),
fs = require('fs'),
tmp = require('tmp'),
join = require('path').join,
config = require('../../../server/config'),
themes = require('../../../server/themes'),
themeList = themes.list,
sandbox = sinon.sandbox.create();
describe('Themes', function () {
afterEach(function () {
sandbox.restore();
});
describe('Loader', function () {
var themePath;
beforeEach(function () {
themePath = tmp.dirSync({unsafeCleanup: true});
sandbox.stub(config, 'getContentPath').withArgs('themes').returns(themePath.name);
});
afterEach(function () {
themePath.removeCallback();
});
describe('Load All', function () {
it('should load directory and include only folders', function (done) {
// create trash
fs.writeFileSync(join(themePath.name, 'casper.zip'));
fs.writeFileSync(join(themePath.name, '.DS_Store'));
// create actual theme
fs.mkdirSync(join(themePath.name, 'casper'));
fs.mkdirSync(join(themePath.name, 'casper', 'partials'));
fs.writeFileSync(join(themePath.name, 'casper', 'index.hbs'));
fs.writeFileSync(join(themePath.name, 'casper', 'partials', 'navigation.hbs'));
themes.loadAll()
.then(function (result) {
var themeResult = themeList.getAll();
// Loader doesn't return anything
should.not.exist(result);
themeResult.should.eql({
casper: {
name: 'casper',
path: join(themePath.name, 'casper'),
'package.json': null
}
});
done();
})
.catch(done);
});
it('should read directory and read package.json if present', function (done) {
// create trash
fs.writeFileSync(join(themePath.name, 'README.md'));
fs.writeFileSync(join(themePath.name, 'Thumbs.db'));
// create actual theme
fs.mkdirSync(join(themePath.name, 'casper'));
fs.mkdirSync(join(themePath.name, 'not-casper'));
fs.writeFileSync(
join(themePath.name, 'casper', 'package.json'),
JSON.stringify({name: 'casper', version: '0.1.2'})
);
themes.loadAll()
.then(function (result) {
var themeResult = themeList.getAll();
// Loader doesn't return anything
should.not.exist(result);
themeResult.should.eql({
casper: {
name: 'casper',
path: join(themePath.name, 'casper'),
'package.json': {name: 'casper', version: '0.1.2'}
},
'not-casper': {
name: 'not-casper',
path: join(themePath.name, 'not-casper'),
'package.json': null
}
});
done();
})
.catch(done);
});
});
describe('Load One', function () {
it('should read directory and include only single requested theme', function (done) {
// create trash
fs.writeFileSync(join(themePath.name, 'casper.zip'));
fs.writeFileSync(join(themePath.name, '.DS_Store'));
// create actual theme
fs.mkdirSync(join(themePath.name, 'casper'));
fs.writeFileSync(join(themePath.name, 'casper', 'index.hbs'));
fs.writeFileSync(
join(themePath.name, 'casper', 'package.json'),
JSON.stringify({name: 'casper', version: '0.1.2'})
);
fs.mkdirSync(join(themePath.name, 'not-casper'));
fs.writeFileSync(join(themePath.name, 'not-casper', 'index.hbs'));
themes.loadOne('casper')
.then(function (themeResult) {
themeResult.should.eql({
name: 'casper',
path: join(themePath.name, 'casper'),
'package.json': {name: 'casper', version: '0.1.2'}
});
done();
})
.catch(done);
});
it('should throw an error if theme cannot be found', function (done) {
// create trash
fs.writeFileSync(join(themePath.name, 'casper.zip'));
fs.writeFileSync(join(themePath.name, '.DS_Store'));
themes.loadOne('casper')
.then(function () {
done('Should have thrown an error');
})
.catch(function (err) {
err.message.should.eql('Package not found');
done();
});
});
});
});
});

228
core/test/unit/themes/middleware_spec.js Normal file
View file

@ -0,0 +1,228 @@
var should = require('should'), // jshint ignore:line
sinon = require('sinon'),
hbs = require('express-hbs'),
themes = require('../../../server/themes'),
// is only exposed via themes.getActive()
activeTheme = require('../../../server/themes/active'),
settingsCache = require('../../../server/settings/cache'),
middleware = themes.middleware,
sandbox = sinon.sandbox.create();
describe('Themes', function () {
afterEach(function () {
sandbox.restore();
});
describe('Middleware', function () {
var req, res, blogApp, getActiveThemeStub, settingsCacheStub;
beforeEach(function () {
req = sandbox.spy();
res = sandbox.spy();
blogApp = {test: 'obj'};
req.app = blogApp;
res.locals = {};
getActiveThemeStub = sandbox.stub(activeTheme, 'get');
settingsCacheStub = sandbox.stub(settingsCache, 'get');
});
describe('ensureActiveTheme', function () {
var ensureActiveTheme = middleware[0],
mountThemeSpy;
beforeEach(function () {
mountThemeSpy = sandbox.spy();
settingsCacheStub.withArgs('activeTheme').returns('casper');
});
it('mounts active theme if not yet mounted', function (done) {
getActiveThemeStub.returns({
mounted: false,
mount: mountThemeSpy
});
ensureActiveTheme(req, res, function next(err) {
// Did not throw an error
should.not.exist(err);
settingsCacheStub.called.should.be.false();
getActiveThemeStub.called.should.be.true();
mountThemeSpy.called.should.be.true();
mountThemeSpy.calledWith(blogApp).should.be.true();
done();
});
});
it('does not mounts the active theme if it is already mounted', function (done) {
getActiveThemeStub.returns({
mounted: true,
mount: mountThemeSpy
});
ensureActiveTheme(req, res, function next(err) {
// Did not throw an error
should.not.exist(err);
settingsCacheStub.called.should.be.false();
getActiveThemeStub.called.should.be.true();
mountThemeSpy.called.should.be.false();
done();
});
});
it('throws error if theme is missing', function (done) {
getActiveThemeStub.returns(undefined);
ensureActiveTheme(req, res, function next(err) {
// Did throw an error
should.exist(err);
err.message.should.eql('The currently active theme "casper" is missing.');
settingsCacheStub.calledWith('activeTheme').should.be.true();
getActiveThemeStub.called.should.be.true();
mountThemeSpy.called.should.be.false();
done();
});
});
});
describe('updateTemplateData', function () {
var updateTemplateData = middleware[1],
themeDataExpectedProps = ['posts_per_page'],
blogDataExpectedProps = [
'url', 'title', 'description', 'logo', 'cover', 'icon', 'twitter', 'facebook', 'navigation',
'permalinks', 'timezone', 'amp'
],
updateOptionsStub;
beforeEach(function () {
updateOptionsStub = sandbox.stub(hbs, 'updateTemplateOptions');
settingsCacheStub.withArgs('title').returns('Bloggy McBlogface');
settingsCacheStub.withArgs('labs').returns({});
getActiveThemeStub.returns({
config: sandbox.stub().returns(2)
});
});
it('calls updateTemplateOptions with correct data', function (done) {
updateTemplateData(req, res, function next(err) {
var templateOptions;
should.not.exist(err);
updateOptionsStub.calledOnce.should.be.true();
templateOptions = updateOptionsStub.firstCall.args[0];
templateOptions.should.be.an.Object().with.property('data');
templateOptions.data.should.be.an.Object().with.properties('blog', 'labs', 'config');
// Check Theme Config
templateOptions.data.config.should.be.an.Object()
.with.properties(themeDataExpectedProps)
.and.size(themeDataExpectedProps.length);
// posts per page should be set according to the stub
templateOptions.data.config.posts_per_page.should.eql(2);
// Check blog config
// blog should have all the right properties
templateOptions.data.blog.should.be.an.Object()
.with.properties(blogDataExpectedProps)
.and.size(blogDataExpectedProps.length);
// url should be correct
templateOptions.data.blog.url.should.eql('http://127.0.0.1:2369/');
// should get the title
templateOptions.data.blog.title.should.eql('Bloggy McBlogface');
// Check labs config
templateOptions.data.labs.should.be.an.Object();
// Check res.locals
should.not.exist(res.locals.secure);
done();
});
});
it('does not error if there is no active theme', function (done) {
getActiveThemeStub.returns(undefined);
updateTemplateData(req, res, function next(err) {
var templateOptions;
should.not.exist(err);
updateOptionsStub.calledOnce.should.be.true();
templateOptions = updateOptionsStub.firstCall.args[0];
templateOptions.should.be.an.Object().with.property('data');
templateOptions.data.should.be.an.Object().with.properties('blog', 'labs', 'config');
// Check Theme Config
templateOptions.data.config.should.be.an.Object();
// posts per page should NOT be set as there's no active theme
should.not.exist(templateOptions.data.config.posts_per_page);
// Check blog config
// blog should have all the right properties
templateOptions.data.blog.should.be.an.Object()
.with.properties(blogDataExpectedProps)
.and.size(blogDataExpectedProps.length);
// url should be correct
templateOptions.data.blog.url.should.eql('http://127.0.0.1:2369/');
// should get the title
templateOptions.data.blog.title.should.eql('Bloggy McBlogface');
// Check labs config
templateOptions.data.labs.should.be.an.Object();
done();
});
});
it('calls updateTempalateOptions with correct info for secure context', function (done) {
req.secure = true;
updateTemplateData(req, res, function next(err) {
var templateOptions;
should.not.exist(err);
updateOptionsStub.calledOnce.should.be.true();
templateOptions = updateOptionsStub.firstCall.args[0];
templateOptions.should.be.an.Object().with.property('data');
templateOptions.data.should.be.an.Object().with.properties('blog', 'labs', 'config');
// Check Theme Config
templateOptions.data.config.should.be.an.Object()
.with.properties(themeDataExpectedProps)
.and.size(themeDataExpectedProps.length);
// posts per page should be set according to the stub
templateOptions.data.config.posts_per_page.should.eql(2);
// Check blog config
// blog should have all the right properties
templateOptions.data.blog.should.be.an.Object()
.with.properties(blogDataExpectedProps)
.and.size(blogDataExpectedProps.length);
// url should be correct HTTPS!
templateOptions.data.blog.url.should.eql('https://127.0.0.1:2369/');
// should get the title
templateOptions.data.blog.title.should.eql('Bloggy McBlogface');
// Check labs config
templateOptions.data.labs.should.be.an.Object();
// Check res.locals
should.exist(res.locals.secure);
res.locals.secure.should.be.true();
done();
});
});
});
});
});

521
core/test/unit/themes_spec.js
View file

@ -1,521 +0,0 @@
var should = require('should'), // jshint ignore:line
sinon = require('sinon'),
_ = require('lodash'),
fs = require('fs'),
tmp = require('tmp'),
join = require('path').join,
hbs = require('express-hbs'),
config = require('../../server/config'),
themes = require('../../server/themes'),
// is only exposed via themes.getActive()
activeTheme = require('../../server/themes/active'),
settingsCache = require('../../server/settings/cache'),
themeList = themes.list,
middleware = themes.middleware,
sandbox = sinon.sandbox.create();
describe('Themes', function () {
afterEach(function () {
sandbox.restore();
});
describe('Loader', function () {
var themePath;
beforeEach(function () {
themePath = tmp.dirSync({unsafeCleanup: true});
sandbox.stub(config, 'getContentPath').withArgs('themes').returns(themePath.name);
});
afterEach(function () {
themePath.removeCallback();
});
describe('Load All', function () {
it('should load directory and include only folders', function (done) {
// create trash
fs.writeFileSync(join(themePath.name, 'casper.zip'));
fs.writeFileSync(join(themePath.name, '.DS_Store'));
// create actual theme
fs.mkdirSync(join(themePath.name, 'casper'));
fs.mkdirSync(join(themePath.name, 'casper', 'partials'));
fs.writeFileSync(join(themePath.name, 'casper', 'index.hbs'));
fs.writeFileSync(join(themePath.name, 'casper', 'partials', 'navigation.hbs'));
themes.loadAll()
.then(function (result) {
var themeResult = themeList.getAll();
// Loader doesn't return anything
should.not.exist(result);
themeResult.should.eql({
casper: {
name: 'casper',
path: join(themePath.name, 'casper'),
'package.json': null
}
});
done();
})
.catch(done);
});
it('should read directory and read package.json if present', function (done) {
// create trash
fs.writeFileSync(join(themePath.name, 'README.md'));
fs.writeFileSync(join(themePath.name, 'Thumbs.db'));
// create actual theme
fs.mkdirSync(join(themePath.name, 'casper'));
fs.mkdirSync(join(themePath.name, 'not-casper'));
fs.writeFileSync(
join(themePath.name, 'casper', 'package.json'),
JSON.stringify({name: 'casper', version: '0.1.2'})
);
themes.loadAll()
.then(function (result) {
var themeResult = themeList.getAll();
// Loader doesn't return anything
should.not.exist(result);
themeResult.should.eql({
casper: {
name: 'casper',
path: join(themePath.name, 'casper'),
'package.json': {name: 'casper', version: '0.1.2'}
},
'not-casper': {
name: 'not-casper',
path: join(themePath.name, 'not-casper'),
'package.json': null
}
});
done();
})
.catch(done);
});
});
describe('Load One', function () {
it('should read directory and include only single requested theme', function (done) {
// create trash
fs.writeFileSync(join(themePath.name, 'casper.zip'));
fs.writeFileSync(join(themePath.name, '.DS_Store'));
// create actual theme
fs.mkdirSync(join(themePath.name, 'casper'));
fs.writeFileSync(join(themePath.name, 'casper', 'index.hbs'));
fs.writeFileSync(
join(themePath.name, 'casper', 'package.json'),
JSON.stringify({name: 'casper', version: '0.1.2'})
);
fs.mkdirSync(join(themePath.name, 'not-casper'));
fs.writeFileSync(join(themePath.name, 'not-casper', 'index.hbs'));
themes.loadOne('casper')
.then(function (themeResult) {
themeResult.should.eql({
name: 'casper',
path: join(themePath.name, 'casper'),
'package.json': {name: 'casper', version: '0.1.2'}
});
done();
})
.catch(done);
});
it('should throw an error if theme cannot be found', function (done) {
// create trash
fs.writeFileSync(join(themePath.name, 'casper.zip'));
fs.writeFileSync(join(themePath.name, '.DS_Store'));
themes.loadOne('casper')
.then(function () {
done('Should have thrown an error');
})
.catch(function (err) {
err.message.should.eql('Package not found');
done();
});
});
});
});
describe('List', function () {
beforeEach(function () {
themeList.init({
casper: {foo: 'bar'},
'not-casper': {bar: 'baz'}
});
});
it('get() allows getting a single theme', function () {
themeList.get('casper').should.eql({foo: 'bar'});
});
it('get() with no args should do nothing', function () {
should.not.exist(themeList.get());
});
it('getAll() returns all themes', function () {
themeList.getAll().should.be.an.Object().with.properties('casper', 'not-casper');
Object.keys(themeList.getAll()).should.have.length(2);
});
it('set() updates an existing theme', function () {
var origCasper = _.cloneDeep(themeList.get('casper'));
themeList.set('casper', {magic: 'update'});
themeList.get('casper').should.not.eql(origCasper);
themeList.get('casper').should.eql({magic: 'update'});
});
it('set() can add a new theme', function () {
themeList.set('rasper', {color: 'red'});
themeList.get('rasper').should.eql({color: 'red'});
});
it('del() removes a key from the list', function () {
should.exist(themeList.get('casper'));
should.exist(themeList.get('not-casper'));
themeList.del('casper');
should.not.exist(themeList.get('casper'));
should.exist(themeList.get('not-casper'));
});
it('del() with no argument does nothing', function () {
should.exist(themeList.get('casper'));
should.exist(themeList.get('not-casper'));
themeList.del();
should.exist(themeList.get('casper'));
should.exist(themeList.get('not-casper'));
});
it('init() calls set for each theme', function () {
var setSpy = sandbox.spy(themeList, 'set');
themeList.init({test: {a: 'b'}, casper: {c: 'd'}});
setSpy.calledTwice.should.be.true();
setSpy.firstCall.calledWith('test', {a: 'b'}).should.be.true();
setSpy.secondCall.calledWith('casper', {c: 'd'}).should.be.true();
});
it('init() with empty object resets the list', function () {
themeList.init();
var result = themeList.getAll();
should.exist(result);
result.should.be.an.Object();
result.should.eql({});
Object.keys(result).should.have.length(0);
});
});
describe('Middleware', function () {
var req, res, blogApp, getActiveThemeStub, settingsCacheStub;
beforeEach(function () {
req = sandbox.spy();
res = sandbox.spy();
blogApp = {test: 'obj'};
req.app = blogApp;
res.locals = {};
getActiveThemeStub = sandbox.stub(activeTheme, 'get');
settingsCacheStub = sandbox.stub(settingsCache, 'get');
});
describe('ensureActiveTheme', function () {
var ensureActiveTheme = middleware[0],
mountThemeSpy;
beforeEach(function () {
mountThemeSpy = sandbox.spy();
settingsCacheStub.withArgs('activeTheme').returns('casper');
});
it('mounts active theme if not yet mounted', function (done) {
getActiveThemeStub.returns({
mounted: false,
mount: mountThemeSpy
});
ensureActiveTheme(req, res, function next(err) {
// Did not throw an error
should.not.exist(err);
settingsCacheStub.called.should.be.false();
getActiveThemeStub.called.should.be.true();
mountThemeSpy.called.should.be.true();
mountThemeSpy.calledWith(blogApp).should.be.true();
done();
});
});
it('does not mounts the active theme if it is already mounted', function (done) {
getActiveThemeStub.returns({
mounted: true,
mount: mountThemeSpy
});
ensureActiveTheme(req, res, function next(err) {
// Did not throw an error
should.not.exist(err);
settingsCacheStub.called.should.be.false();
getActiveThemeStub.called.should.be.true();
mountThemeSpy.called.should.be.false();
done();
});
});
it('throws error if theme is missing', function (done) {
getActiveThemeStub.returns(undefined);
ensureActiveTheme(req, res, function next(err) {
// Did throw an error
should.exist(err);
err.message.should.eql('The currently active theme "casper" is missing.');
settingsCacheStub.calledWith('activeTheme').should.be.true();
getActiveThemeStub.called.should.be.true();
mountThemeSpy.called.should.be.false();
done();
});
});
});
describe('updateTemplateData', function () {
var updateTemplateData = middleware[1],
themeDataExpectedProps = ['posts_per_page'],
blogDataExpectedProps = [
'url', 'title', 'description', 'logo', 'cover', 'icon', 'twitter', 'facebook', 'navigation',
'permalinks', 'timezone', 'amp'
],
updateOptionsStub;
beforeEach(function () {
updateOptionsStub = sandbox.stub(hbs, 'updateTemplateOptions');
settingsCacheStub.withArgs('title').returns('Bloggy McBlogface');
settingsCacheStub.withArgs('labs').returns({});
getActiveThemeStub.returns({
config: sandbox.stub().returns(2)
});
});
it('calls updateTemplateOptions with correct data', function (done) {
updateTemplateData(req, res, function next(err) {
var templateOptions;
should.not.exist(err);
updateOptionsStub.calledOnce.should.be.true();
templateOptions = updateOptionsStub.firstCall.args[0];
templateOptions.should.be.an.Object().with.property('data');
templateOptions.data.should.be.an.Object().with.properties('blog', 'labs', 'config');
// Check Theme Config
templateOptions.data.config.should.be.an.Object()
.with.properties(themeDataExpectedProps)
.and.size(themeDataExpectedProps.length);
// posts per page should be set according to the stub
templateOptions.data.config.posts_per_page.should.eql(2);
// Check blog config
// blog should have all the right properties
templateOptions.data.blog.should.be.an.Object()
.with.properties(blogDataExpectedProps)
.and.size(blogDataExpectedProps.length);
// url should be correct
templateOptions.data.blog.url.should.eql('http://127.0.0.1:2369/');
// should get the title
templateOptions.data.blog.title.should.eql('Bloggy McBlogface');
// Check labs config
templateOptions.data.labs.should.be.an.Object();
// Check res.locals
should.not.exist(res.locals.secure);
done();
});
});
it('does not error if there is no active theme', function (done) {
getActiveThemeStub.returns(undefined);
updateTemplateData(req, res, function next(err) {
var templateOptions;
should.not.exist(err);
updateOptionsStub.calledOnce.should.be.true();
templateOptions = updateOptionsStub.firstCall.args[0];
templateOptions.should.be.an.Object().with.property('data');
templateOptions.data.should.be.an.Object().with.properties('blog', 'labs', 'config');
// Check Theme Config
templateOptions.data.config.should.be.an.Object();
// posts per page should NOT be set as there's no active theme
should.not.exist(templateOptions.data.config.posts_per_page);
// Check blog config
// blog should have all the right properties
templateOptions.data.blog.should.be.an.Object()
.with.properties(blogDataExpectedProps)
.and.size(blogDataExpectedProps.length);
// url should be correct
templateOptions.data.blog.url.should.eql('http://127.0.0.1:2369/');
// should get the title
templateOptions.data.blog.title.should.eql('Bloggy McBlogface');
// Check labs config
templateOptions.data.labs.should.be.an.Object();
done();
});
});
it('calls updateTempalateOptions with correct info for secure context', function (done) {
req.secure = true;
updateTemplateData(req, res, function next(err) {
var templateOptions;
should.not.exist(err);
updateOptionsStub.calledOnce.should.be.true();
templateOptions = updateOptionsStub.firstCall.args[0];
templateOptions.should.be.an.Object().with.property('data');
templateOptions.data.should.be.an.Object().with.properties('blog', 'labs', 'config');
// Check Theme Config
templateOptions.data.config.should.be.an.Object()
.with.properties(themeDataExpectedProps)
.and.size(themeDataExpectedProps.length);
// posts per page should be set according to the stub
templateOptions.data.config.posts_per_page.should.eql(2);
// Check blog config
// blog should have all the right properties
templateOptions.data.blog.should.be.an.Object()
.with.properties(blogDataExpectedProps)
.and.size(blogDataExpectedProps.length);
// url should be correct HTTPS!
templateOptions.data.blog.url.should.eql('https://127.0.0.1:2369/');
// should get the title
templateOptions.data.blog.title.should.eql('Bloggy McBlogface');
// Check labs config
templateOptions.data.labs.should.be.an.Object();
// Check res.locals
should.exist(res.locals.secure);
res.locals.secure.should.be.true();
done();
});
});
});
});
describe('Active', function () {
describe('Mount', function () {
var hbsStub, configStub,
fakeBlogApp, fakeLoadedTheme, fakeCheckedTheme;
beforeEach(function () {
hbsStub = sandbox.stub(hbs, 'express3');
configStub = sandbox.stub(config, 'set');
fakeBlogApp = {
cache: ['stuff'],
set: sandbox.stub(),
engine: sandbox.stub()
};
fakeLoadedTheme = {
name: 'casper',
path: 'my/fake/theme/path'
};
fakeCheckedTheme = {};
});
it('should mount active theme with partials', function () {
// setup partials
fakeCheckedTheme.partials = ['loop', 'navigation'];
var theme = activeTheme.set(fakeLoadedTheme, fakeCheckedTheme);
// Check the theme is not yet mounted
activeTheme.get().mounted.should.be.false();
// Call mount!
theme.mount(fakeBlogApp);
// Check the asset hash gets reset
configStub.calledOnce.should.be.true();
configStub.calledWith('assetHash', null).should.be.true();
// Check te view cache was cleared
fakeBlogApp.cache.should.eql({});
// Check the views were set correctly
fakeBlogApp.set.calledOnce.should.be.true();
fakeBlogApp.set.calledWith('views', 'my/fake/theme/path').should.be.true();
// Check handlebars was initialised correctly
hbsStub.calledOnce.should.be.true();
hbsStub.firstCall.args[0].should.be.an.Object().and.have.property('partialsDir');
hbsStub.firstCall.args[0].partialsDir.should.be.an.Array().with.lengthOf(2);
hbsStub.firstCall.args[0].partialsDir[1].should.eql('my/fake/theme/path/partials');
// Check the theme is now mounted
activeTheme.get().mounted.should.be.true();
});
it('should mount active theme without partials', function () {
// setup partials
fakeCheckedTheme.partials = [];
var theme = activeTheme.set(fakeLoadedTheme, fakeCheckedTheme);
// Check the theme is not yet mounted
activeTheme.get().mounted.should.be.false();
// Call mount!
theme.mount(fakeBlogApp);
// Check the asset hash gets reset
configStub.calledOnce.should.be.true();
configStub.calledWith('assetHash', null).should.be.true();
// Check te view cache was cleared
fakeBlogApp.cache.should.eql({});
// Check the views were set correctly
fakeBlogApp.set.calledOnce.should.be.true();
fakeBlogApp.set.calledWith('views', 'my/fake/theme/path').should.be.true();
// Check handlebars was initialised correctly
hbsStub.calledOnce.should.be.true();
hbsStub.firstCall.args[0].should.be.an.Object().and.have.property('partialsDir');
hbsStub.firstCall.args[0].partialsDir.should.have.lengthOf(1);
// Check the theme is now mounted
activeTheme.get().mounted.should.be.true();
});
});
});
});