mirror of
https://github.com/TryGhost/Ghost.git
synced 2025-01-27 22:49:56 -05:00
7845617607
closes #8793 - 1.3 post excerpt migration - add 1.3 migration to add `excerpt` to post schema NOTE: - knex-migrator relies on the package.json safe version - so right now Ghost is on 1.2 - the migration script is for 1.3 - if you pull down the PR (or if we merge this PR into master), you have to run `knex-migrator migrate --v 1.3 --force` - knex-migrator will tell you what you have todo - Bump dependencies - knex-migrator@2.1.3 - Soft limit for custom_excerpt - Extended {{excerpt}} to use custom excerpt - when a `custom_excerpt` field exists, the `{{excerpt}}` helper will output this and fall back to autogenerated excerpt if not. - Refactored behaviour of (meta) description - html tag `<meta name="description" />` for posts, tags and author doesn't get rendered if not provided. - fallback for `author.bio` removed - fallback for `tag.description` removed - structured data and schema.org for `post` context takes the following order to render description fields: 1. custom excerpt 2. meta description 3. automated excerpt (50 words) - updated and added tests to reflect the changes
473 lines
16 KiB
JavaScript
473 lines
16 KiB
JavaScript
var should = require('should'),
|
|
getSchema = require('../../../server/data/meta/schema'),
|
|
markdownToMobiledoc = require('../../utils/fixtures/data-generator').markdownToMobiledoc;
|
|
|
|
describe('getSchema', function () {
|
|
it('should return post schema if context starts with post', function (done) {
|
|
var metadata = {
|
|
blog: {
|
|
title: 'Blog Title',
|
|
url: 'http://mysite.com',
|
|
logo: {
|
|
url: 'http://mysite.com/author/image/url/logo.jpg',
|
|
dimensions: {
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
}
|
|
},
|
|
authorImage: {
|
|
url: 'http://mysite.com/author/image/url/me.jpg',
|
|
dimensions: {
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
},
|
|
authorFacebook: 'testuser',
|
|
creatorTwitter: '@testuser',
|
|
authorUrl: 'http://mysite.com/author/me/',
|
|
metaTitle: 'Post Title',
|
|
url: 'http://mysite.com/post/my-post-slug/',
|
|
publishedDate: '2015-12-25T05:35:01.234Z',
|
|
modifiedDate: '2016-01-21T22:13:05.412Z',
|
|
coverImage: {
|
|
url: 'http://mysite.com/content/image/mypostcoverimage.jpg',
|
|
dimensions: {
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
},
|
|
keywords: ['one', 'two', 'tag'],
|
|
metaDescription: 'Post meta description',
|
|
excerpt: 'Custom excerpt for description'
|
|
}, data = {
|
|
context: ['post'],
|
|
post: {
|
|
author: {
|
|
name: 'Post Author',
|
|
website: 'http://myblogsite.com/',
|
|
bio: 'My author bio.',
|
|
facebook: 'testuser',
|
|
twitter: '@testuser'
|
|
}
|
|
}
|
|
}, schema = getSchema(metadata, data);
|
|
|
|
should.deepEqual(schema, {
|
|
'@context': 'https://schema.org',
|
|
'@type': 'Article',
|
|
author: {
|
|
'@type': 'Person',
|
|
image: {
|
|
'@type': 'ImageObject',
|
|
url: 'http://mysite.com/author/image/url/me.jpg',
|
|
width: 500,
|
|
height: 500
|
|
},
|
|
name: 'Post Author',
|
|
sameAs: [
|
|
'http://myblogsite.com/',
|
|
'https://www.facebook.com/testuser',
|
|
'https://twitter.com/testuser'
|
|
],
|
|
url: 'http://mysite.com/author/me/'
|
|
},
|
|
dateModified: '2016-01-21T22:13:05.412Z',
|
|
datePublished: '2015-12-25T05:35:01.234Z',
|
|
description: 'Custom excerpt for description',
|
|
headline: 'Post Title',
|
|
image: {
|
|
'@type': 'ImageObject',
|
|
url: 'http://mysite.com/content/image/mypostcoverimage.jpg',
|
|
width: 500,
|
|
height: 500
|
|
},
|
|
keywords: 'one, two, tag',
|
|
mainEntityOfPage: {
|
|
'@type': 'WebPage',
|
|
'@id': 'http://mysite.com'
|
|
},
|
|
publisher: {
|
|
'@type': 'Organization',
|
|
name: 'Blog Title',
|
|
logo: {
|
|
'@type': 'ImageObject',
|
|
url: 'http://mysite.com/author/image/url/logo.jpg',
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
},
|
|
url: 'http://mysite.com/post/my-post-slug/'
|
|
});
|
|
done();
|
|
});
|
|
|
|
it('should return post schema if context starts with amp', function (done) {
|
|
var metadata = {
|
|
blog: {
|
|
title: 'Blog Title',
|
|
url: 'http://mysite.com',
|
|
logo: {
|
|
url: 'http://mysite.com/author/image/url/logo.jpg',
|
|
dimensions: {
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
}
|
|
},
|
|
authorImage: {
|
|
url: 'http://mysite.com/author/image/url/me.jpg',
|
|
dimensions: {
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
},
|
|
authorFacebook: 'testuser',
|
|
creatorTwitter: '@testuser',
|
|
authorUrl: 'http://mysite.com/author/me/',
|
|
metaTitle: 'Post Title',
|
|
url: 'http://mysite.com/post/my-amp-post-slug/',
|
|
publishedDate: '2015-12-25T05:35:01.234Z',
|
|
modifiedDate: '2016-01-21T22:13:05.412Z',
|
|
coverImage: {
|
|
url: 'http://mysite.com/content/image/mypostcoverimage.jpg',
|
|
dimensions: {
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
},
|
|
keywords: ['one', 'two', 'tag'],
|
|
metaDescription: 'Post meta description',
|
|
excerpt: 'Post meta description'
|
|
}, data = {
|
|
context: ['amp', 'post'],
|
|
post: {
|
|
title: 'Post Title',
|
|
slug: 'my-amp-post-slug',
|
|
mobiledoc: markdownToMobiledoc('some markdown'),
|
|
html: 'some html',
|
|
author: {
|
|
name: 'Post Author',
|
|
website: 'http://myblogsite.com/',
|
|
bio: 'My author bio.',
|
|
facebook: 'testuser',
|
|
twitter: '@testuser'
|
|
}
|
|
}
|
|
}, schema = getSchema(metadata, data);
|
|
|
|
should.deepEqual(schema, {
|
|
'@context': 'https://schema.org',
|
|
'@type': 'Article',
|
|
author: {
|
|
'@type': 'Person',
|
|
image: {
|
|
'@type': 'ImageObject',
|
|
url: 'http://mysite.com/author/image/url/me.jpg',
|
|
width: 500,
|
|
height: 500
|
|
},
|
|
name: 'Post Author',
|
|
sameAs: [
|
|
'http://myblogsite.com/',
|
|
'https://www.facebook.com/testuser',
|
|
'https://twitter.com/testuser'
|
|
],
|
|
url: 'http://mysite.com/author/me/'
|
|
},
|
|
dateModified: '2016-01-21T22:13:05.412Z',
|
|
datePublished: '2015-12-25T05:35:01.234Z',
|
|
description: 'Post meta description',
|
|
headline: 'Post Title',
|
|
image: {
|
|
'@type': 'ImageObject',
|
|
url: 'http://mysite.com/content/image/mypostcoverimage.jpg',
|
|
width: 500,
|
|
height: 500
|
|
},
|
|
keywords: 'one, two, tag',
|
|
mainEntityOfPage: {
|
|
'@type': 'WebPage',
|
|
'@id': 'http://mysite.com'
|
|
},
|
|
publisher: {
|
|
'@type': 'Organization',
|
|
name: 'Blog Title',
|
|
logo: {
|
|
'@type': 'ImageObject',
|
|
url: 'http://mysite.com/author/image/url/logo.jpg',
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
},
|
|
url: 'http://mysite.com/post/my-amp-post-slug/'
|
|
});
|
|
done();
|
|
});
|
|
|
|
it('should return post schema removing null or undefined values', function (done) {
|
|
var metadata = {
|
|
blog: {
|
|
title: 'Blog Title'
|
|
},
|
|
authorImage: null,
|
|
authorFacebook: undefined,
|
|
creatorTwitter: undefined,
|
|
authorUrl: 'http://mysite.com/author/me/',
|
|
metaTitle: 'Post Title',
|
|
url: 'http://mysite.com/post/my-post-slug/',
|
|
publishedDate: '2015-12-25T05:35:01.234Z',
|
|
modifiedDate: '2016-01-21T22:13:05.412Z',
|
|
coverImage: undefined,
|
|
keywords: [],
|
|
metaDescription: '',
|
|
excerpt: 'Post meta description'
|
|
}, data = {
|
|
context: ['post'],
|
|
post: {
|
|
author: {
|
|
name: 'Post Author',
|
|
website: undefined,
|
|
bio: null,
|
|
facebook: null,
|
|
twitter: null
|
|
}
|
|
}
|
|
}, schema = getSchema(metadata, data);
|
|
|
|
should.deepEqual(schema, {
|
|
'@context': 'https://schema.org',
|
|
'@type': 'Article',
|
|
author: {
|
|
'@type': 'Person',
|
|
name: 'Post Author',
|
|
sameAs: [],
|
|
url: 'http://mysite.com/author/me/'
|
|
},
|
|
dateModified: '2016-01-21T22:13:05.412Z',
|
|
datePublished: '2015-12-25T05:35:01.234Z',
|
|
description: 'Post meta description',
|
|
headline: 'Post Title',
|
|
mainEntityOfPage: {
|
|
'@type': 'WebPage',
|
|
'@id': null
|
|
},
|
|
publisher: {
|
|
'@type': 'Organization',
|
|
name: 'Blog Title',
|
|
logo: null
|
|
},
|
|
url: 'http://mysite.com/post/my-post-slug/'
|
|
});
|
|
done();
|
|
});
|
|
|
|
it('should return image url instead of ImageObjects if no dimensions supplied', function (done) {
|
|
var metadata = {
|
|
blog: {
|
|
title: 'Blog Title',
|
|
url: 'http://mysite.com',
|
|
logo: {
|
|
url: 'http://mysite.com/author/image/url/logo.jpg'
|
|
}
|
|
},
|
|
authorImage: {
|
|
url: 'http://mysite.com/author/image/url/me.jpg'
|
|
},
|
|
authorFacebook: 'testuser',
|
|
creatorTwitter: '@testuser',
|
|
authorUrl: 'http://mysite.com/author/me/',
|
|
metaTitle: 'Post Title',
|
|
url: 'http://mysite.com/post/my-post-slug/',
|
|
publishedDate: '2015-12-25T05:35:01.234Z',
|
|
modifiedDate: '2016-01-21T22:13:05.412Z',
|
|
coverImage: {
|
|
url: 'http://mysite.com/content/image/mypostcoverimage.jpg'
|
|
},
|
|
keywords: ['one', 'two', 'tag'],
|
|
metaDescription: 'Post meta description',
|
|
excerpt: 'Post meta description'
|
|
}, data = {
|
|
context: ['post'],
|
|
post: {
|
|
author: {
|
|
name: 'Post Author',
|
|
website: 'http://myblogsite.com/',
|
|
bio: 'My author bio.',
|
|
facebook: 'testuser',
|
|
twitter: '@testuser',
|
|
metaDescription: 'My author bio.'
|
|
}
|
|
}
|
|
}, schema = getSchema(metadata, data);
|
|
|
|
should.deepEqual(schema, {
|
|
'@context': 'https://schema.org',
|
|
'@type': 'Article',
|
|
author: {
|
|
'@type': 'Person',
|
|
description: 'My author bio.',
|
|
image: 'http://mysite.com/author/image/url/me.jpg',
|
|
name: 'Post Author',
|
|
sameAs: [
|
|
'http://myblogsite.com/',
|
|
'https://www.facebook.com/testuser',
|
|
'https://twitter.com/testuser'
|
|
],
|
|
url: 'http://mysite.com/author/me/'
|
|
},
|
|
dateModified: '2016-01-21T22:13:05.412Z',
|
|
datePublished: '2015-12-25T05:35:01.234Z',
|
|
description: 'Post meta description',
|
|
headline: 'Post Title',
|
|
image: 'http://mysite.com/content/image/mypostcoverimage.jpg',
|
|
keywords: 'one, two, tag',
|
|
mainEntityOfPage: {
|
|
'@type': 'WebPage',
|
|
'@id': 'http://mysite.com'
|
|
},
|
|
publisher: {
|
|
'@type': 'Organization',
|
|
name: 'Blog Title',
|
|
logo: 'http://mysite.com/author/image/url/logo.jpg'
|
|
},
|
|
url: 'http://mysite.com/post/my-post-slug/'
|
|
});
|
|
done();
|
|
});
|
|
|
|
it('should return home schema if context starts with home', function () {
|
|
var metadata = {
|
|
blog: {
|
|
title: 'Blog Title'
|
|
},
|
|
url: 'http://mysite.com/post/my-post-slug/',
|
|
coverImage: {
|
|
url: 'http://mysite.com/content/image/mypostcoverimage.jpg',
|
|
dimensions: {
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
},
|
|
metaDescription: 'This is the theme description'
|
|
}, data = {
|
|
context: ['home']
|
|
}, schema = getSchema(metadata, data);
|
|
|
|
should.deepEqual(schema, {
|
|
'@context': 'https://schema.org',
|
|
'@type': 'Website',
|
|
description: 'This is the theme description',
|
|
image: {
|
|
'@type': 'ImageObject',
|
|
url: 'http://mysite.com/content/image/mypostcoverimage.jpg',
|
|
width: 500,
|
|
height: 500
|
|
},
|
|
mainEntityOfPage: {
|
|
'@type': 'WebPage',
|
|
'@id': null
|
|
},
|
|
publisher: {
|
|
'@type': 'Organization',
|
|
name: 'Blog Title',
|
|
logo: null
|
|
},
|
|
url: 'http://mysite.com/post/my-post-slug/'
|
|
});
|
|
});
|
|
|
|
it('should return tag schema if context starts with tag', function () {
|
|
var metadata = {
|
|
blog: {
|
|
title: 'Blog Title'
|
|
},
|
|
url: 'http://mysite.com/post/my-post-slug/',
|
|
coverImage: {
|
|
url: 'http://mysite.com/content/image/mypostcoverimage.jpg',
|
|
dimensions: {
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
},
|
|
metaDescription: 'This is the tag description!'
|
|
}, data = {
|
|
context: ['tag'],
|
|
tag: {
|
|
name: 'Great Tag'
|
|
}
|
|
}, schema = getSchema(metadata, data);
|
|
|
|
should.deepEqual(schema, {
|
|
'@context': 'https://schema.org',
|
|
'@type': 'Series',
|
|
description: 'This is the tag description!',
|
|
image: {
|
|
'@type': 'ImageObject',
|
|
url: 'http://mysite.com/content/image/mypostcoverimage.jpg',
|
|
width: 500,
|
|
height: 500
|
|
},
|
|
mainEntityOfPage: {
|
|
'@type': 'WebPage',
|
|
'@id': null
|
|
},
|
|
name: 'Great Tag',
|
|
publisher: {
|
|
'@type': 'Organization',
|
|
name: 'Blog Title',
|
|
logo: null
|
|
},
|
|
url: 'http://mysite.com/post/my-post-slug/'
|
|
});
|
|
});
|
|
|
|
it('should return author schema if context starts with author', function () {
|
|
var metadata = {
|
|
blog: {
|
|
title: 'Blog Title',
|
|
url: 'http://mysite.com'
|
|
},
|
|
authorImage: {
|
|
url: 'http://mysite.com/author/image/url/me.jpg',
|
|
dimensions: {
|
|
width: 500,
|
|
height: 500
|
|
}
|
|
},
|
|
authorUrl: 'http://mysite.com/author/me/',
|
|
metaDescription: 'This is the author description!'
|
|
}, data = {
|
|
context: ['author'],
|
|
author: {
|
|
name: 'Author Name',
|
|
website: 'http://myblogsite.com/?user=bambedibu&a=<script>alert("bambedibu")</script>',
|
|
twitter: '@testuser'
|
|
}
|
|
}, schema = getSchema(metadata, data);
|
|
|
|
should.deepEqual(schema, {
|
|
'@context': 'https://schema.org',
|
|
'@type': 'Person',
|
|
description: 'This is the author description!',
|
|
mainEntityOfPage: {
|
|
'@type': 'WebPage',
|
|
'@id': 'http://mysite.com'
|
|
},
|
|
name: 'Author Name',
|
|
sameAs: [
|
|
'http://myblogsite.com/?user=bambedibu&a=<script>alert("bambedibu")</script>',
|
|
'https://twitter.com/testuser'
|
|
],
|
|
url: 'http://mysite.com/author/me/'
|
|
});
|
|
});
|
|
|
|
it('should return null if not a supported type', function () {
|
|
var metadata = {},
|
|
data = {},
|
|
schema = getSchema(metadata, data);
|
|
|
|
should.deepEqual(schema, null);
|
|
});
|
|
});
|