Ghost/core/test/unit/helpers/excerpt_spec.js
Nazar Gargol 16c3785b52 🐛 Fixed lack of space in excerpt generated from paragraphs
closes #10531

- Adds space when encountering closing </p> and <br> tags
- The mobiledoc-to-html conversion produces these tags in this exact
syntax, so there is no need to account for more cases like additional spaces or alternative syntax like  <br />
- Added test cases that cover spacing use-casei
- Changed some existing tests to contain more close-to-real-world markup
- The downside of this approach is generating multiple spaces in case there are empty paragraphs in the markup. The same concern is true for current "new line" substitution:
> excerpt.replace(/(\r\n|\n|\r)+/gm, ' ')
but it never has been a concern as in real world when multiple spaces are used inside of the `<p>` tag they are rendered as single space.
2019-08-26 18:05:14 +02:00

236 lines
9.5 KiB
JavaScript

var should = require('should'),
// Stuff we are testing
helpers = require('../../../frontend/helpers');
describe('{{excerpt}} Helper', function () {
it('renders empty string when html and excerpt are null', function () {
var html = null,
rendered = helpers.excerpt.call({
html: html,
custom_excerpt: null
});
should.exist(rendered);
rendered.string.should.equal('');
});
it('can render excerpt', function () {
var html = 'Hello World',
rendered = helpers.excerpt.call({
html: html,
custom_excerpt: ''
});
should.exist(rendered);
rendered.string.should.equal(html);
});
it('does not output HTML', function () {
var html = '<p>There are <br />10<br> types<br/> of people in <img src="a">the world:' +
'<img src=b alt="c"> those who <img src="@" onclick="javascript:alert(\'hello\');">' +
'understand trinary,</p> those who don\'t <div style="" class=~/\'-,._?!|#>and' +
'< test > those<<< test >>> who mistake it &lt;for&gt; binary.',
expected = 'There are 10 types of people in the world: those who understand trinary, those who ' +
'don\'t and those>> who mistake it &lt;for&gt; binary.',
rendered = helpers.excerpt.call({
html: html,
custom_excerpt: ''
});
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('strips multiple inline footnotes', function () {
var html = '<p>Testing<sup id="fnref:1"><a href="#fn:1" rel="footnote">1</a></sup>, my footnotes. And stuff. Footnote<sup id="fnref:2"><a href="#fn:2" rel="footnote">2</a></sup><a href="http://google.com">with a link</a> right after.',
expected = 'Testing, my footnotes. And stuff. Footnotewith a link right after.',
rendered = helpers.excerpt.call({
html: html,
custom_excerpt: ''
});
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('strips inline and bottom footnotes', function () {
var html = '<p>Testing<sup id="fnref:1"><a href="#fn:1" rel="footnote">1</a></sup> a very short post with a single footnote.</p>\n' +
'<div class="footnotes"><ol><li class="footnote" id="fn:1"><p><a href="https://ghost.org">https://ghost.org</a> <a href="#fnref:1" title="return to article">↩</a></p></li></ol></div>',
expected = 'Testing a very short post with a single footnote.',
rendered = helpers.excerpt.call({
html: html,
custom_excerpt: ''
});
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('can truncate html by word', function () {
var html = '<p>Hello <strong>World! It\'s me!</strong></p>',
expected = 'Hello World!',
rendered = (
helpers.excerpt.call(
{
html: html,
custom_excerpt: ''
},
{hash: {words: '2'}}
)
);
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('can truncate html with non-ascii characters by word', function () {
var html = '<p>Едквюэ опортэат <strong>праэчынт ючю но, квуй эю</strong></p>',
expected = 'Едквюэ опортэат',
rendered = (
helpers.excerpt.call(
{
html: html,
custom_excerpt: ''
},
{hash: {words: '2'}}
)
);
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('can truncate html by character', function () {
var html = '<p>Hello <strong>World! It\'s me!</strong></p>',
expected = 'Hello Wo',
rendered = (
helpers.excerpt.call(
{
html: html,
custom_excerpt: ''
},
{hash: {characters: '8'}}
)
);
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('uses custom excerpt if provided instead of truncating html', function () {
var html = '<p>Hello <strong>World! It\'s me!</strong></p>',
customExcerpt = 'My Custom Excerpt wins!',
expected = 'My Custom Excerpt wins!',
rendered = (
helpers.excerpt.call(
{
html: html,
custom_excerpt: customExcerpt
}
)
);
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('does not truncate custom excerpt if characters options is provided', function () {
var html = '<p>Hello <strong>World! It\'s me!</strong></p>',
customExcerpt = 'This is a custom excerpt. It should always be rendered in full length and not being cut ' +
'off. The maximum length of a custom excerpt is 300 characters. Enough to tell a bit about ' +
'your story and make a nice summary for your readers. It\s only allowed to truncate anything ' +
'after 300 characters. This give',
expected = 'This is a custom excerpt. It should always be rendered in full length and not being cut ' +
'off. The maximum length of a custom excerpt is 300 characters. Enough to tell a bit about ' +
'your story and make a nice summary for your readers. It\s only allowed to truncate anything ' +
'after 300 characters. This give',
rendered = (
helpers.excerpt.call(
{
html: html,
custom_excerpt: customExcerpt
},
{hash: {characters: '8'}}
)
);
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('does not truncate custom excerpt if words options is provided', function () {
var html = '<p>Hello <strong>World! It\'s me!</strong></p>',
customExcerpt = 'This is a custom excerpt. It should always be rendered in full length and not being cut ' +
'off. The maximum length of a custom excerpt is 300 characters. Enough to tell a bit about ' +
'your story and make a nice summary for your readers. It\s only allowed to truncate anything ' +
'after 300 characters. This give',
expected = 'This is a custom excerpt. It should always be rendered in full length and not being cut ' +
'off. The maximum length of a custom excerpt is 300 characters. Enough to tell a bit about ' +
'your story and make a nice summary for your readers. It\s only allowed to truncate anything ' +
'after 300 characters. This give',
rendered = (
helpers.excerpt.call(
{
html: html,
custom_excerpt: customExcerpt
},
{hash: {words: '10'}}
)
);
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('puts additional space after closing paragraph', function () {
var html = '<p>Testing.</p><p>Space before this text.</p><p>And this as well!</p>',
expected = 'Testing. Space before this text. And this as well!',
rendered = (
helpers.excerpt.call(
{
html: html,
custom_excerpt: ''
}
)
);
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('puts additional space instead of <br> tag', function () {
var html = '<p>Testing.<br>Space before this text.<br>And this as well!</p>',
expected = 'Testing. Space before this text. And this as well!',
rendered = (
helpers.excerpt.call(
{
html: html,
custom_excerpt: ''
}
)
);
should.exist(rendered);
rendered.string.should.equal(expected);
});
it('puts additional space between paragraph in markup generated by Ghost', function () {
var html = '<p>put space in excerpt.</p><p></p><p>before this paragraph.</p>' +
'<!--kg-card-begin: image--><figure class="kg-card kg-image-card"><img src="/content/images/2019/08/photo.jpg" class="kg-image"></figure><!--kg-card-end: image-->' +
'<p>and skip the image.</p><p></p>',
expected = 'put space in excerpt. before this paragraph. and skip the image.',
rendered = (
helpers.excerpt.call(
{
html: html,
custom_excerpt: ''
}
)
);
should.exist(rendered);
rendered.string.should.equal(expected);
});
});