mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-02-03 23:00:14 -05:00
refs #8221, closes #7688, refs #7558 🙇 Improve meta data publisher logo behaviour This is a follow-up PR for #8285. Reasons: The code changes of #8285 caused error messages when falling back to the default `favicon.ico`, as the `image-size` tool doesn't support `ico` files. This PR takes the logic to decide which logo needs to be listed in our schema into a new fn `blog_logo.js`. There we have now three decisions: 1. If we have a publication **logo**, we'll take that one 2. If we have no publication logo, but an **icon** we'll use this one. 3. If we have none of the above things, we fall back to our default `favicon.ico` Additional, we're hard coding image dimensions for whenever the logo is an `.ico` file and built and extra decision to not call `image-size` when the dimension are already given. I will create another follow-up PR, which checks the extension type for the file and offers it as a util. 🛠 Blog icon util refs #7688 Serve functionality around the blog icon in its own util: - getIconDimensions -> async function that takes the filepath of on ico file and returns its dimensions - isIcoImageType -> returns true if file has `.ico` extension - getIconType -> returns icon-type (`x-icon` or `png`) - getIconUrl -> returns the absolut or relativ URL for the favicon: `[subdirectory or not]favicon.[ico or png]` 📖 Get .ico sizes for meta data & logo improvement refs #7558 refs #8221 Use the new `blogIconUtil` in meta data to fetch the dimensions of `.ico` files. Improvements for `publisher.logo`: We're now returning a hard-coded 'faked' image dimensions value to render an `imageObject` and prevent error our schema (Google structured data). As soon as an image (`.ico` or non-`.ico`) is too large, but - in case of non-`.ico` - a square format, be set the image-dimensions to 60px width and height. This reduces the chances of getting constantly error messages from Googles' webmaster tools. - add getIconPath util
147 lines
5.8 KiB
JavaScript
147 lines
5.8 KiB
JavaScript
// jshint unused: false
|
|
var should = require('should'),
|
|
sinon = require('sinon'),
|
|
_ = require('lodash'),
|
|
settingsCache = require('../../../server/settings/cache'),
|
|
configUtils = require('../../utils/configUtils'),
|
|
testUtils = require('../../utils'),
|
|
config = configUtils.config,
|
|
path = require('path'),
|
|
|
|
// stuff we are testing
|
|
blogIcon = require('../../../server/utils/blog-icon'),
|
|
|
|
sandbox = sinon.sandbox.create();
|
|
|
|
describe('Blog Icon', function () {
|
|
before(function () {
|
|
configUtils.restore();
|
|
});
|
|
|
|
afterEach(function () {
|
|
configUtils.restore();
|
|
sandbox.restore();
|
|
});
|
|
|
|
describe('getIconUrl', function () {
|
|
it('custom uploaded ico blog icon', function () {
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.ico');
|
|
blogIcon.getIconUrl().should.eql('/favicon.ico');
|
|
});
|
|
|
|
it('custom uploaded png blog icon', function () {
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.png');
|
|
blogIcon.getIconUrl().should.eql('/favicon.png');
|
|
});
|
|
|
|
it('default ico blog icon', function () {
|
|
blogIcon.getIconUrl().should.eql('/favicon.ico');
|
|
});
|
|
describe('absolute URL', function () {
|
|
it('custom uploaded ico blog icon', function () {
|
|
configUtils.set({url: 'http://my-ghost-blog.com/'});
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.ico');
|
|
blogIcon.getIconUrl(true).should.eql('http://my-ghost-blog.com/favicon.ico');
|
|
});
|
|
|
|
it('custom uploaded png blog icon', function () {
|
|
configUtils.set({url: 'http://my-ghost-blog.com/'});
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.png');
|
|
blogIcon.getIconUrl(true).should.eql('http://my-ghost-blog.com/favicon.png');
|
|
});
|
|
|
|
it('default ico blog icon', function () {
|
|
configUtils.set({url: 'http://my-ghost-blog.com/'});
|
|
blogIcon.getIconUrl(true).should.eql('http://my-ghost-blog.com/favicon.ico');
|
|
});
|
|
});
|
|
|
|
describe('with subdirectory', function () {
|
|
it('custom uploaded ico blog icon', function () {
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.ico');
|
|
configUtils.set({url: 'http://my-ghost-blog.com/blog'});
|
|
|
|
blogIcon.getIconUrl().should.eql('/blog/favicon.ico');
|
|
});
|
|
|
|
it('custom uploaded png blog icon', function () {
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.png');
|
|
configUtils.set({url: 'http://my-ghost-blog.com/blog'});
|
|
|
|
blogIcon.getIconUrl().should.eql('/blog/favicon.png');
|
|
});
|
|
|
|
it('default ico blog icon', function () {
|
|
configUtils.set({url: 'http://my-ghost-blog.com/blog'});
|
|
blogIcon.getIconUrl().should.eql('/blog/favicon.ico');
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('getIconPath', function () {
|
|
it('custom uploaded ico blog icon', function () {
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.ico');
|
|
blogIcon.getIconPath().should.eql('/2017/04/my-icon.ico');
|
|
});
|
|
|
|
it('custom uploaded png blog icon', function () {
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/content/images/2017/04/my-icon.png');
|
|
blogIcon.getIconPath().should.eql('/2017/04/my-icon.png');
|
|
});
|
|
|
|
it('default ico blog icon', function () {
|
|
blogIcon.getIconPath().should.eql(path.join(__dirname, '../../../server/public/favicon.ico'));
|
|
});
|
|
|
|
describe('with subdirectory', function () {
|
|
it('custom uploaded ico blog icon', function () {
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/blog/content/images/2017/04/my-icon.ico');
|
|
configUtils.set({url: 'http://my-ghost-blog.com/blog'});
|
|
|
|
blogIcon.getIconPath().should.eql('/2017/04/my-icon.ico');
|
|
});
|
|
|
|
it('custom uploaded png blog icon', function () {
|
|
sandbox.stub(settingsCache, 'get').withArgs('icon').returns('/blog/content/images/2017/04/my-icon.png');
|
|
configUtils.set({url: 'http://my-ghost-blog.com/blog'});
|
|
|
|
blogIcon.getIconPath().should.eql('/2017/04/my-icon.png');
|
|
});
|
|
|
|
it('default ico blog icon', function () {
|
|
configUtils.set({url: 'http://my-ghost-blog.com/blog'});
|
|
blogIcon.getIconPath().should.eql(path.join(__dirname, '../../../server/public/favicon.ico'));
|
|
});
|
|
});
|
|
});
|
|
|
|
describe('isIcoImageType', function () {
|
|
it('returns true, if icon is .ico filetype', function () {
|
|
blogIcon.isIcoImageType('icon.ico').should.be.true();
|
|
});
|
|
|
|
it('returns false, if icon is not .ico filetype', function () {
|
|
blogIcon.isIcoImageType('icon.png').should.be.false();
|
|
});
|
|
});
|
|
|
|
describe('getIconType', function () {
|
|
it('returns x-icon for ico icons', function () {
|
|
blogIcon.getIconType('favicon.ico').should.eql('x-icon');
|
|
});
|
|
|
|
it('returns png for png icon', function () {
|
|
blogIcon.getIconType('favicon.png').should.eql('png');
|
|
});
|
|
});
|
|
|
|
describe.skip('getIconDimensions', function () {
|
|
it('[success] returns icon dimensions', function (done) {
|
|
done();
|
|
});
|
|
|
|
it('[failure] return error message', function (done) {
|
|
done();
|
|
});
|
|
});
|
|
});
|