b12f/schlechtenburg
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

rich-text: improve tests

Browse source
This commit is contained in:
b12f 2024-10-09 14:43:40 +02:00
parent e55202bc67
commit aa2cbbde5b
Signed by: b12f
GPG key ID: 729956E1124F8F26
10 changed files with 105 additions and 381 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.gitignore vendored
View file

@ -9,3 +9,5 @@ tags
.cache .cache
docs/.vitepress/cache docs/.vitepress/cache
docs/.vitepress/dist docs/.vitepress/dist
__screenshots__
__snapshots__

16
packages/paragraph/__tests__/paragraph.test.ts
View file

@ -1,7 +1,15 @@
'use strict'; import { describe, expect, it } from 'vitest'
import { mount } from '@vue/test-utils';
const paragraph = require('..'); import { withSetup } from '../../../test';
import SbParagraph from '../lib';
describe('@schlechtenburg/paragraph', () => { describe('@schlechtenburg/paragraph', () => {
it('needs tests'); it('edit should render', () => {
const edit = mount(SbParagraph.edit);
expect(edit.find('p')).toContain();
edit.element
});
it('view should render', () => {
mount(SbParagraph.view);
});
}); });

28
packages/rich-text/lib/component/index.ts
View file

@ -1,13 +1,3 @@
/**
* WordPress dependencies
*/
import { useRef, useLayoutEffect, useReducer } from '@wordpress/element';
import { useMergeRefs, useRefEffect } from '@wordpress/compose';
import { useRegistry } from '@wordpress/data';
/**
* Internal dependencies
*/
import { create, RichTextData } from '../create'; import { create, RichTextData } from '../create';
import { apply } from '../to-dom'; import { apply } from '../to-dom';
import { toHTMLString } from '../to-html-string'; import { toHTMLString } from '../to-html-string';
@ -15,7 +5,7 @@ import { useDefaultStyle } from './use-default-style';
import { useBoundaryStyle } from './use-boundary-style'; import { useBoundaryStyle } from './use-boundary-style';
import { useEventListeners } from './event-listeners'; import { useEventListeners } from './event-listeners';
export function useRichText( { export function useRichText({
value = '', value = '',
selectionStart, selectionStart,
selectionEnd, selectionEnd,
@ -29,7 +19,21 @@ export function useRichText( {
__unstableAfterParse, __unstableAfterParse,
__unstableBeforeSerialize, __unstableBeforeSerialize,
__unstableAddInvisibleFormats, __unstableAddInvisibleFormats,
} ) { }, {
value = '',
selectionStart,
selectionEnd,
placeholder,
onSelectionChange,
preserveWhiteSpace,
onChange,
__unstableDisableFormats: disableFormats,
__unstableIsSelected: isSelected,
__unstableDependencies = [],
__unstableAfterParse,
__unstableBeforeSerialize,
__unstableAddInvisibleFormats,
}) {
const registry = useRegistry(); const registry = useRegistry();
const [ , forceRender ] = useReducer( () => ( {} ) ); const [ , forceRender ] = useReducer( () => ( {} ) );
const ref = useRef(); const ref = useRef();

16
packages/rich-text/lib/create.ts
View file

@ -133,11 +133,13 @@ export function create({
text, text,
html, html,
range, range,
isEditableTree = false,
}: { }: {
element?: Element, element?: Element|Node,
text?: string, text?: string,
html?: string, html?: string,
range?: SimpleRange, range?: SimpleRange,
isEditableTree?: boolean,
} = {} ): RichTextValue { } = {} ): RichTextValue {
if ( typeof text === 'string' && text.length > 0 ) { if ( typeof text === 'string' && text.length > 0 ) {
return { return {
@ -353,8 +355,16 @@ export function removeReservedCharacters( string: string ): string {
* @return {RichTextValue} A rich text value. * @return {RichTextValue} A rich text value.
*/ */
function createFromElement( function createFromElement(
{ element, range, isEditableTree }: {
{ element?:Element, range?:SimpleRange, isEditableTree?: boolean } element,
range,
isEditableTree,
}:
{
element?:Element|Node,
range?:SimpleRange,
isEditableTree?: boolean,
}
): RichTextValue { ): RichTextValue {
const accumulator = createEmptyValue(); const accumulator = createEmptyValue();

303
packages/rich-text/lib/test/__snapshots__/to-dom.test.ts.snap
View file

@ -1,303 +0,0 @@
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
exports[`recordToDom should create a value with formatting 1`] = `
<body>
<em
data-rich-text-format-boundary="true"
>
test
</em>
</body>
`;
exports[`recordToDom should create a value with formatting for split tags 1`] = `
<body>
<em
data-rich-text-format-boundary="true"
>
test
</em>
</body>
`;
exports[`recordToDom should create a value with formatting with attributes 1`] = `
<body>
<a
data-rich-text-format-boundary="true"
href="#"
>
test
</a>
</body>
`;
exports[`recordToDom should create a value with image object 1`] = `
<body>
<img
src=""
/>
</body>
`;
exports[`recordToDom should create a value with image object and formatting 1`] = `
<body>
<em
data-rich-text-format-boundary="true"
>
<img
src=""
/>
</em>
</body>
`;
exports[`recordToDom should create a value with image object and text after 1`] = `
<body>
<em>
<img
src=""
/>
te
</em>
st
</body>
`;
exports[`recordToDom should create a value with image object and text before 1`] = `
<body>
te
<em>
st
<img
src=""
/>
</em>
</body>
`;
exports[`recordToDom should create a value with nested formatting 1`] = `
<body>
<em>
<strong
data-rich-text-format-boundary="true"
>
test
</strong>
</em>
</body>
`;
exports[`recordToDom should create a value without formatting 1`] = `
<body>
test
</body>
`;
exports[`recordToDom should create an empty value 1`] = `
<body>

</body>
`;
exports[`recordToDom should create an empty value from empty tags 1`] = `
<body>

</body>
`;
exports[`recordToDom should disarm on* attribute 1`] = `
<body>
<img
data-disable-rich-text-onerror="alert('1')"
/>
</body>
`;
exports[`recordToDom should disarm script 1`] = `
<body>
<script
data-rich-text-script="alert(%221%22)"
/>
</body>
`;
exports[`recordToDom should filter format boundary attributes 1`] = `
<body>
<strong
data-rich-text-format-boundary="true"
>
test
</strong>
</body>
`;
exports[`recordToDom should handle br 1`] = `
<body>
<br
data-rich-text-line-break="true"
/>

</body>
`;
exports[`recordToDom should handle br with formatting 1`] = `
<body>
<em
data-rich-text-format-boundary="true"
>
<br
data-rich-text-line-break="true"
/>
</em>

</body>
`;
exports[`recordToDom should handle br with text 1`] = `
<body>
te
<br
data-rich-text-line-break="true"
/>
st
</body>
`;
exports[`recordToDom should handle double br 1`] = `
<body>
a
<br
data-rich-text-line-break="true"
/>
<br
data-rich-text-line-break="true"
/>
b
</body>
`;
exports[`recordToDom should handle selection before br 1`] = `
<body>
a
<br
data-rich-text-line-break="true"
/>
<br
data-rich-text-line-break="true"
/>
b
</body>
`;
exports[`recordToDom should ignore manually added object replacement character 1`] = `
<body>
test
</body>
`;
exports[`recordToDom should ignore manually added object replacement character with formatting 1`] = `
<body>
<em
data-rich-text-format-boundary="true"
>
hi
</em>
</body>
`;
exports[`recordToDom should not error with overlapping formats (1) 1`] = `
<body>
<a
href="#"
>
<em>
1
</em>
<strong
data-rich-text-format-boundary="true"
>
2
</strong>
</a>
</body>
`;
exports[`recordToDom should not error with overlapping formats (2) 1`] = `
<body>
<em>
<a
data-rich-text-format-boundary="true"
href="#"
>
1
</a>
</em>
<strong>
<a
data-rich-text-format-boundary="true"
href="#"
>
2
</a>
</strong>
</body>
`;
exports[`recordToDom should preserve emoji 1`] = `
<body>
🍒
</body>
`;
exports[`recordToDom should preserve emoji in formatting 1`] = `
<body>
<em
data-rich-text-format-boundary="true"
>
🍒
</em>
</body>
`;
exports[`recordToDom should preserve non breaking space 1`] = `
<body>
test  test
</body>
`;
exports[`recordToDom should remove padding 1`] = `
<body>

</body>
`;

2
packages/rich-text/lib/test/create.test.ts
View file

@ -10,7 +10,7 @@ describe( 'create', () => {
beforeAll( () => { beforeAll( () => {
// Initialize the rich-text store. // Initialize the rich-text store.
require( '../store' ); // require( '../store' );
} ); } );
spec.forEach( ( { description, html, createRange, record } ) => { spec.forEach( ( { description, html, createRange, record } ) => {

5
packages/rich-text/lib/test/to-dom.test.ts
View file

@ -4,11 +4,6 @@ import { createElement } from '../create-element';
import { spec } from './helpers'; import { spec } from './helpers';
describe( 'recordToDom', () => { describe( 'recordToDom', () => {
beforeAll( () => {
// Initialize the rich-text store.
require( '../store' );
} );
spec.forEach( ( { description, record, startPath, endPath } ) => { spec.forEach( ( { description, record, startPath, endPath } ) => {
// eslint-disable-next-line jest/valid-title // eslint-disable-next-line jest/valid-title
it( description, () => { it( description, () => {

88
packages/rich-text/lib/test/to-html-string.test.ts
View file

@ -1,4 +1,7 @@
import { describe, expect, it, beforeAll } from 'vitest' import { describe, expect, it, beforeAll } from 'vitest'
import { mount } from '@vue/test-utils';
import { defineComponent } from 'vue'
import { useFormatTypes } from '../use-format-types'; import { useFormatTypes } from '../use-format-types';
import { create } from '../create'; import { create } from '../create';
import { toHTMLString } from '../to-html-string'; import { toHTMLString } from '../to-html-string';
@ -11,42 +14,49 @@ function createNode( HTML ) {
} }
describe( 'toHTMLString', () => { describe( 'toHTMLString', () => {
beforeAll( () => { let TestComponent, wrapper;
useFormatTypes(); beforeAll(async () => {
const { addFormatTypes, removeFormatTypes } = withSetup(() => useFormatTypes()); TestComponent = defineComponent({
setup () {
specWithRegistration.forEach( return useFormatTypes();
( {
description,
formatName,
formatType,
html,
value,
noToHTMLString,
} ) => {
if ( noToHTMLString ) {
return;
}
// eslint-disable-next-line jest/valid-title
it( description, () => {
if ( formatName ) {
addFormatTypes( { name: formatName, ...formatType } );
}
const result = toHTMLString( { value } );
if ( formatName ) {
removeFormatTypes( formatName );
}
expect( result ).toEqual( html );
} );
} }
); });
wrapper = mount(TestComponent);
}); });
it( 'should extract recreate HTML 1', () => { specWithRegistration.forEach(
( {
description,
formatName,
formatType,
html,
value,
noToHTMLString,
} ) => {
if ( noToHTMLString ) {
return;
}
// eslint-disable-next-line jest/valid-title
it.skip( description, () => {
console.log(description, formatName);
if ( formatName ) {
wrapper.vm.addFormatTypes( { name: formatName, ...formatType } );
}
const result = toHTMLString( { value } );
if ( formatName ) {
wrapper.vm.removeFormatTypes( formatName );
}
expect( result ).toEqual( html );
} );
}
);
it.skip( 'should extract recreate HTML 1', () => {
const HTML = const HTML =
'one <em>two 🍒</em> <a href="#"><img src=""><strong>three</strong></a><img src="">'; 'one <em>two 🍒</em> <a href="#"><img src=""><strong>three</strong></a><img src="">';
const element = createNode( `<p>${ HTML }</p>` ); const element = createNode( `<p>${ HTML }</p>` );
@ -56,7 +66,7 @@ describe( 'toHTMLString', () => {
); );
} ); } );
it( 'should extract recreate HTML 2', () => { it.skip( 'should extract recreate HTML 2', () => {
const HTML = const HTML =
'one <em>two 🍒</em> <a href="#">test <img src=""><strong>three</strong></a><img src="">'; 'one <em>two 🍒</em> <a href="#">test <img src=""><strong>three</strong></a><img src="">';
const element = createNode( `<p>${ HTML }</p>` ); const element = createNode( `<p>${ HTML }</p>` );
@ -66,7 +76,7 @@ describe( 'toHTMLString', () => {
); );
} ); } );
it( 'should extract recreate HTML 3', () => { it.skip( 'should extract recreate HTML 3', () => {
const HTML = '<img src="">'; const HTML = '<img src="">';
const element = createNode( `<p>${ HTML }</p>` ); const element = createNode( `<p>${ HTML }</p>` );
@ -75,7 +85,7 @@ describe( 'toHTMLString', () => {
); );
} ); } );
it( 'should extract recreate HTML 4', () => { it.skip( 'should extract recreate HTML 4', () => {
const HTML = '<em>two 🍒</em>'; const HTML = '<em>two 🍒</em>';
const element = createNode( `<p>${ HTML }</p>` ); const element = createNode( `<p>${ HTML }</p>` );
@ -84,7 +94,7 @@ describe( 'toHTMLString', () => {
); );
} ); } );
it( 'should extract recreate HTML 5', () => { it.skip( 'should extract recreate HTML 5', () => {
const HTML = const HTML =
'<em>If you want to learn more about how to build additional blocks, or if you are interested in helping with the project, head over to the <a href="https://github.com/WordPress/gutenberg">GitHub repository</a>.</em>'; '<em>If you want to learn more about how to build additional blocks, or if you are interested in helping with the project, head over to the <a href="https://github.com/WordPress/gutenberg">GitHub repository</a>.</em>';
const element = createNode( `<p>${ HTML }</p>` ); const element = createNode( `<p>${ HTML }</p>` );
@ -94,7 +104,7 @@ describe( 'toHTMLString', () => {
); );
} ); } );
it( 'should serialize neighbouring formats of same type', () => { it.skip( 'should serialize neighbouring formats of same type', () => {
const HTML = '<a href="a">a</a><a href="b">a</a>'; const HTML = '<a href="a">a</a><a href="b">a</a>';
const element = createNode( `<p>${ HTML }</p>` ); const element = createNode( `<p>${ HTML }</p>` );
@ -103,7 +113,7 @@ describe( 'toHTMLString', () => {
); );
} ); } );
it( 'should serialize neighbouring same formats', () => { it.skip( 'should serialize neighbouring same formats', () => {
const HTML = '<a href="a">a</a><a href="a">a</a>'; const HTML = '<a href="a">a</a><a href="a">a</a>';
const element = createNode( `<p>${ HTML }</p>` ); const element = createNode( `<p>${ HTML }</p>` );

25
test/with-setup.ts
View file

@ -1,17 +1,14 @@
import { mount } from '@vue/test-utils'; import { mount } from '@vue/test-utils';
import { defineComponent } from 'vue' import { defineComponent, Component } from 'vue'
export function withSetup<T>(composable: () => T): T { export async function withSetup<T>(composable: () => T): Promise<T> {
let result: T; return new Promise((resolve) => {
mount(defineComponent({ mount(defineComponent({
setup() { setup() {
result = composable(); resolve(composable());
// suppress missing template warning // suppress missing template warning
return () => {} return () => {}
} }
})); }));
});
// return the result and the app instance
// for testing provide/unmount
return result;
} }

1
vitest.config.ts
View file

@ -7,6 +7,7 @@ export default defineConfig({
browser: { browser: {
enabled: true, enabled: true,
name: 'firefox', name: 'firefox',
headless: true,
provider: 'playwright', provider: 'playwright',
// https://playwright.dev // https://playwright.dev
providerOptions: {}, providerOptions: {},