Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Drop empty tables #41

Merged
merged 1 commit into from
Nov 16, 2023
Merged

feat: Drop empty tables #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions src/converters/fromHtml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ const elementsShouldHaveText = [
'STRONG',
'SUB',
'SUP',
'TABLE',
'U',
];

Expand Down Expand Up @@ -111,7 +112,9 @@ const extractElementsWithConverters = (el, defaultTextBlock, href) => {
if (parent) {
parent.removeChild(el);
}
result.push(blockFromElement(el, defaultTextBlock, href));
if (shouldKeepWrapper(el)) {
result.push(blockFromElement(el, defaultTextBlock, href));
}
}

return result;
Expand Down Expand Up @@ -145,10 +148,9 @@ const convertFromHTML = (input, defaultTextBlock) => {
for (const el of elements) {
const children = el.childNodes;
const href = el.getAttribute('href');
let keepWrapper = shouldKeepWrapper(el);
for (const child of children) {
// With children nodes, we keep the wrapper only
// if at least one child is not in elementsWithConverters
// if at least one child is not in elementsWithConverters
const tmpResult = extractElementsWithConverters(
child,
defaultTextBlock,
Expand All @@ -158,7 +160,7 @@ const convertFromHTML = (input, defaultTextBlock) => {
result.push(...tmpResult);
}
}
if (keepWrapper) {
if (shouldKeepWrapper(el)) {
result.push(blockFromElement(el, defaultTextBlock));
}
}
Expand Down
66 changes: 35 additions & 31 deletions src/converters/fromHtml.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ describe('convertFromHTML parsing div with br tags', () => {
describe('convertFromHTML parsing whitespace inside unknown tags', () => {
const html = '<center>\n<strong>text</strong>\n</center>';

describe('returns valid result preserving the whitespace', () => {
test('returns valid result preserving the whitespace', () => {
const result = convertFromHTML(html, 'slate');
expect(result).toHaveLength(1);
expect(result[0].value).toEqual([
Expand All @@ -333,7 +333,7 @@ describe('convertFromHTML parsing whitespace inside unknown tags', () => {
describe('convertFromHTML parsing image', () => {
// https://github.com/plone/blocks-conversion-tool/issues/21

describe('on its own', () => {
test('on its own', () => {
const html = '<img src="image.jpeg">';

const result = convertFromHTML(html, 'slate');
Expand All @@ -350,7 +350,7 @@ describe('convertFromHTML parsing image', () => {
]);
});

describe('inside a p element', () => {
test('inside a p element', () => {
const html = '<p><img src="image.jpeg"></p>';

const result = convertFromHTML(html, 'slate');
Expand All @@ -367,7 +367,7 @@ describe('convertFromHTML parsing image', () => {
]);
});

describe('inside a span element', () => {
test('inside a span element', () => {
const html = '<p><span><img src="image.jpeg"></span></p>';

const result = convertFromHTML(html, 'slate');
Expand All @@ -384,7 +384,7 @@ describe('convertFromHTML parsing image', () => {
]);
});

describe('inside a div element', () => {
test('inside a div element', () => {
// https://github.com/plone/blocks-conversion-tool/issues/21#issuecomment-1455176066
const html = '<div><img src="image.jpeg"></div>';

Expand All @@ -402,7 +402,7 @@ describe('convertFromHTML parsing image', () => {
]);
});

describe('inside a nested div element', () => {
test('inside a nested div element', () => {
// https://github.com/plone/blocks-conversion-tool/issues/21#issuecomment-1455176066
const html = '<div><div><img src="image.jpeg"></div></div>';

Expand All @@ -420,7 +420,7 @@ describe('convertFromHTML parsing image', () => {
]);
});

describe('inside a nested div element with line breaks', () => {
test('inside a nested div element with line breaks', () => {
const html = `<div>
<div>
<p><span><img src="image.jpeg" /></span></p>
Expand All @@ -440,7 +440,7 @@ describe('convertFromHTML parsing image', () => {
});
});

describe('inside a nested span element containing valid text', () => {
test('inside a nested span element containing valid text', () => {
const html = '<p><span><img src="image.jpeg" />text</span></p>';

const result = convertFromHTML(html, 'slate');
Expand All @@ -455,7 +455,7 @@ describe('convertFromHTML parsing image', () => {
});
});

describe('inside a nested span element, with a sibling containing valid text', () => {
test('inside a nested span element, with a sibling containing valid text', () => {
const html =
'<p><span><img src="image.jpeg" /></span><span>text</span></p>';

Expand All @@ -471,7 +471,7 @@ describe('convertFromHTML parsing image', () => {
});
});

describe('inside a nested link element should add the href property', () => {
test('inside a nested link element should add the href property', () => {
const html =
'<p><a href="https://plone.org"><img src="image.jpeg"></a></p>';

Expand All @@ -495,12 +495,12 @@ describe('convertFromHTML parsing image', () => {
]);
});

describe('inside a table', () => {
test('inside a table', () => {
const html =
'<table><tr><td><div><img src="image.jpeg" /></div></td></tr></table>';

const result = convertFromHTML(html, 'slate');
expect(result).toHaveLength(2);
expect(result).toHaveLength(1);
expect(result[0]).toEqual({
'@type': 'image',
align: 'center',
Expand All @@ -509,27 +509,19 @@ describe('convertFromHTML parsing image', () => {
title: '',
url: 'image.jpeg',
});
expect(result[1].table.rows[0].cells[0].type).toEqual('header');
expect(result[1].table.rows[0].cells[0].value).toEqual([
{ type: 'div', children: [{ text: '' }] },
]);
expect(result[1].table.rows[1].cells[0].type).toEqual('data');
expect(result[1].table.rows[1].cells[0].value).toEqual([
{ type: 'div', children: [{ text: '' }] },
]);
});
});

describe('convertFromHTML parsing nested tags', () => {
describe('with an image and without line breaks', () => {
test('with an image and without line breaks', () => {
const html = `<div>
<div><p><span><img src="image.jpg" /></span></p></div>
<p ><span><a href="link"><span><span><span>Text</span></span></span></a>, </span><a href="link"><span>text</span></a>, <a href="link"><span><span>text</span></span> </a></p>
</div>`;
const result = convertFromHTML(html, 'slate');
expect(result).toHaveLength(2);
});
describe('with an image and with an additional line break', () => {
test('with an image and with an additional line break', () => {
const html = `<div>
<div>
<p><span><img src="image.jpg" /></span></p>
Expand All @@ -539,7 +531,7 @@ describe('convertFromHTML parsing nested tags', () => {
const result = convertFromHTML(html, 'slate');
expect(result).toHaveLength(2);
});
describe('with paragraph, table and image blocks', () => {
test('with paragraph, table and image blocks', () => {
const html = `<p>
<table>
<tbody>
Expand All @@ -552,11 +544,10 @@ describe('convertFromHTML parsing nested tags', () => {
</table>
</p>`;
const result = convertFromHTML(html, 'slate');
expect(result).toHaveLength(2);
expect(result).toHaveLength(1);
expect(result[0]['@type']).toBe('image');
expect(result[1]['@type']).toBe('slateTable');
});
describe('with paragraph, table and image blocks', () => {
test('with paragraph, table and image blocks', () => {
const html = `<div>
<div>
<p>
Expand All @@ -574,11 +565,10 @@ describe('convertFromHTML parsing nested tags', () => {
<p></p>
</div>`;
const result = convertFromHTML(html, 'slate');
expect(result).toHaveLength(2);
expect(result).toHaveLength(1);
expect(result[0]['@type']).toBe('image');
expect(result[1]['@type']).toBe('slateTable');
});
describe('with paragraph, table, image blocks, and other paragraph', () => {
test('with paragraph, table, image blocks, and other paragraph', () => {
const html = `<div>
<p>
<table>
Expand All @@ -595,9 +585,23 @@ describe('convertFromHTML parsing nested tags', () => {
<p>A text</p>
</div>`;
const result = convertFromHTML(html, 'slate');
expect(result).toHaveLength(3);
expect(result).toHaveLength(2);
expect(result[0]['@type']).toBe('image');
expect(result[1]['@type']).toBe('slate');
});
test('with paragraph, and text and image in table', () => {
const html = `<p>
<table>
<tbody>
<tr>
<td>text in table<img src="image.png" /></td>
</tr>
</tbody>
</table>
</p>`;
const result = convertFromHTML(html, 'slate');
expect(result).toHaveLength(2);
expect(result[0]['@type']).toBe('image');
expect(result[1]['@type']).toBe('slateTable');
expect(result[2]['@type']).toBe('slate');
});
});