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

test: Rich text test helpers mimic user events #49804

Merged
merged 6 commits into from
Apr 18, 2023
Merged

test: Rich text test helpers mimic user events #49804

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4028095
test: changeAndSelectTextOfRichText defaults cursor to end of new text
dcalhoun Apr 12, 2023
14ba9e7
test: Consolidate multiple Rich Text change text helpers
dcalhoun Apr 13, 2023
88d67af
test: Add selectTextInRichText helper
dcalhoun Apr 13, 2023
291b2fa
test: Simplify tests with new helpers
dcalhoun Apr 13, 2023
cc8b1ef
test: Refactor selectTextInRichText
dcalhoun Apr 17, 2023
6bf636f
test: Rename typeInRichText selection parameters
dcalhoun Apr 17, 2023
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
18 changes: 9 additions & 9 deletions packages/block-editor/src/components/block-mobile-toolbar/test/block-actions-menu.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import {
getBlock,
within,
getEditorHtml,
changeTextOfRichText,
typeInRichText,
} from 'test/helpers';

/**
Expand Down Expand Up @@ -71,7 +71,7 @@ describe( 'Block Actions Menu', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down Expand Up @@ -132,7 +132,7 @@ describe( 'Block Actions Menu', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down Expand Up @@ -179,7 +179,7 @@ describe( 'Block Actions Menu', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down Expand Up @@ -228,7 +228,7 @@ describe( 'Block Actions Menu', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down Expand Up @@ -275,7 +275,7 @@ describe( 'Block Actions Menu', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down Expand Up @@ -322,7 +322,7 @@ describe( 'Block Actions Menu', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down Expand Up @@ -368,7 +368,7 @@ describe( 'Block Actions Menu', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down Expand Up @@ -405,7 +405,7 @@ describe( 'Block Actions Menu', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down
8 changes: 4 additions & 4 deletions packages/block-editor/src/components/block-mover/test/index.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import {
within,
getEditorHtml,
render,
changeTextOfRichText,
typeInRichText,
} from 'test/helpers';

/**
Expand Down Expand Up @@ -89,7 +89,7 @@ describe( 'Block Mover Picker', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down Expand Up @@ -138,7 +138,7 @@ describe( 'Block Mover Picker', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down Expand Up @@ -176,7 +176,7 @@ describe( 'Block Mover Picker', () => {
within( paragraphBlock ).getByPlaceholderText(
'Start writing…'
);
changeTextOfRichText( paragraphField, 'Hello!' );
typeInRichText( paragraphField, 'Hello!' );

// Add Spacer block
await addBlock( screen, 'Spacer' );
Expand Down
4 changes: 2 additions & 2 deletions packages/block-library/src/buttons/test/edit.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {
within,
getBlock,
initializeEditor,
changeTextOfRichText,
typeInRichText,
} from 'test/helpers';

/**
Expand Down Expand Up @@ -196,7 +196,7 @@ describe( 'Buttons block', () => {
within( secondButtonBlock ).getByLabelText(
'Text input. Empty'
);
changeTextOfRichText( secondButtonInput, 'Hello!' );
typeInRichText( secondButtonInput, 'Hello!' );

expect( getEditorHtml() ).toMatchSnapshot();
} );
Expand Down
8 changes: 4 additions & 4 deletions packages/block-library/src/gallery/test/index.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/
import {
act,
changeTextOfRichText,
typeInRichText,
fireEvent,
getBlock,
getEditorHtml,
Expand Down Expand Up @@ -173,7 +173,7 @@ describe( 'Gallery block', () => {
const captionField = within(
getByLabelText( /Gallery caption. Empty/ )
).getByPlaceholderText( 'Add caption' );
changeTextOfRichText(
typeInRichText(
captionField,
'<strong>Bold</strong> <em>italic</em> <s>strikethrough</s> gallery caption'
);
Expand All @@ -197,7 +197,7 @@ describe( 'Gallery block', () => {
// Set gallery item caption
const captionField =
within( galleryItem ).getByPlaceholderText( 'Add caption' );
changeTextOfRichText(
typeInRichText(
captionField,
'<strong>Bold</strong> <em>italic</em> <s>strikethrough</s> image caption'
);
Expand Down Expand Up @@ -537,7 +537,7 @@ describe( 'Gallery block', () => {
<figure class="wp-block-gallery has-nested-images columns-default is-cropped"><!-- wp:image {"id":${ media[ 0 ].localId }} -->
<figure class="wp-block-image"><img src="${ media[ 0 ].localUrl }" alt="" class="wp-image-${ media[ 0 ].localId }"/></figure>
<!-- /wp:image -->

<!-- wp:image {"id":${ media[ 1 ].localId },"linkDestination":"attachment"} -->
<figure class="wp-block-image"><img src="${ media[ 1 ].localUrl }" alt="" class="wp-image-${ media[ 1 ].localId }"/></figure>
<!-- /wp:image --></figure>
Expand Down
16 changes: 5 additions & 11 deletions packages/block-library/src/list/test/edit.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
* External dependencies
*/
import {
changeTextOfRichText,
changeAndSelectTextOfRichText,
selectRangeInRichText,
typeInRichText,
fireEvent,
getEditorHtml,
initializeEditor,
Expand Down Expand Up @@ -79,7 +79,7 @@ describe( 'List block', () => {

const listItemField =
within( listBlock ).getByPlaceholderText( 'List' );
changeTextOfRichText( listItemField, 'First list item' );
typeInRichText( listItemField, 'First list item' );

expect( getEditorHtml() ).toMatchSnapshot();
} );
Expand Down Expand Up @@ -347,10 +347,7 @@ describe( 'List block', () => {
// backward delete
const listItemField =
within( listItemBlock ).getByLabelText( /Text input. .*Two.*/ );
changeAndSelectTextOfRichText( listItemField, 'Two', {
initialSelectionStart: 0,
initialSelectionEnd: 3,
} );
selectRangeInRichText( listItemField, 0 );
fireEvent( listItemField, 'onKeyDown', {
nativeEvent: {},
preventDefault() {},
Expand Down Expand Up @@ -398,10 +395,7 @@ describe( 'List block', () => {
// backward delete
const listItemField =
within( listItemBlock ).getByLabelText( /Text input. .*One.*/ );
changeAndSelectTextOfRichText( listItemField, 'One', {
initialSelectionStart: 0,
initialSelectionEnd: 3,
} );
selectRangeInRichText( listItemField, 0 );
fireEvent( listItemField, 'onKeyDown', {
nativeEvent: {},
preventDefault() {},
Expand Down
51 changes: 23 additions & 28 deletions packages/block-library/src/paragraph/test/edit.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ import {
act,
addBlock,
getBlock,
changeTextOfRichText,
changeAndSelectTextOfRichText,
typeInRichText,
fireEvent,
getEditorHtml,
initializeEditor,
Expand Down Expand Up @@ -55,10 +54,10 @@ describe( 'Paragraph block', () => {
fireEvent.press( paragraphBlock );
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
changeAndSelectTextOfRichText(
typeInRichText(
paragraphTextInput,
'A quick brown fox jumps over the lazy dog.',
{ selectionStart: 2, selectionEnd: 7 }
{ finalSelectionStart: 2, finalSelectionEnd: 7 }
);
fireEvent.press( screen.getByLabelText( 'Bold' ) );

Expand All @@ -80,10 +79,10 @@ describe( 'Paragraph block', () => {
fireEvent.press( paragraphBlock );
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
changeAndSelectTextOfRichText(
typeInRichText(
paragraphTextInput,
'A quick brown fox jumps over the lazy dog.',
{ selectionStart: 2, selectionEnd: 7 }
{ finalSelectionStart: 2, finalSelectionEnd: 7 }
);
fireEvent.press( screen.getByLabelText( 'Italic' ) );

Expand All @@ -105,10 +104,10 @@ describe( 'Paragraph block', () => {
fireEvent.press( paragraphBlock );
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
changeAndSelectTextOfRichText(
typeInRichText(
paragraphTextInput,
'A quick brown fox jumps over the lazy dog.',
{ selectionStart: 2, selectionEnd: 7 }
{ finalSelectionStart: 2, finalSelectionEnd: 7 }
);
fireEvent.press( screen.getByLabelText( 'Strikethrough' ) );

Expand All @@ -130,7 +129,7 @@ describe( 'Paragraph block', () => {
fireEvent.press( paragraphBlock );
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
changeTextOfRichText(
typeInRichText(
paragraphTextInput,
'A quick brown fox jumps over the lazy dog.'
);
Expand All @@ -155,7 +154,7 @@ describe( 'Paragraph block', () => {
fireEvent.press( paragraphBlock );
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
changeTextOfRichText(
typeInRichText(
paragraphTextInput,
'A quick brown fox jumps over the lazy dog.'
);
Expand All @@ -180,7 +179,7 @@ describe( 'Paragraph block', () => {
fireEvent.press( paragraphBlock );
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
changeTextOfRichText(
typeInRichText(
paragraphTextInput,
'A quick brown fox jumps over the lazy dog.'
);
Expand Down Expand Up @@ -208,9 +207,9 @@ describe( 'Paragraph block', () => {
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
const string = 'A quick brown fox jumps over the lazy dog.';
changeAndSelectTextOfRichText( paragraphTextInput, string, {
selectionStart: string.length / 2,
selectionEnd: string.length / 2,
typeInRichText( paragraphTextInput, string, {
finalSelectionStart: string.length / 2,
finalSelectionEnd: string.length / 2,
} );
fireEvent( paragraphTextInput, 'onKeyDown', {
nativeEvent: {},
Expand Down Expand Up @@ -279,12 +278,12 @@ describe( 'Paragraph block', () => {
fireEvent.press( paragraphBlock );
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
changeAndSelectTextOfRichText(
typeInRichText(
paragraphTextInput,
'A quick brown fox jumps over the lazy dog.',
{
selectionStart: 2,
selectionEnd: 7,
finalSelectionStart: 2,
finalSelectionEnd: 7,
}
);
// Await React Navigation: https://github.com/WordPress/gutenberg/issues/35685#issuecomment-961919931
Expand Down Expand Up @@ -325,12 +324,12 @@ describe( 'Paragraph block', () => {
fireEvent.press( paragraphBlock );
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
changeAndSelectTextOfRichText(
typeInRichText(
paragraphTextInput,
'A quick brown fox jumps over the lazy dog.',
{
selectionStart: 2,
selectionEnd: 7,
finalSelectionStart: 2,
finalSelectionEnd: 7,
}
);
// Await React Navigation: https://github.com/WordPress/gutenberg/issues/35685#issuecomment-961919931
Expand Down Expand Up @@ -362,14 +361,10 @@ describe( 'Paragraph block', () => {
fireEvent.press( paragraphBlock );
const paragraphTextInput =
within( paragraphBlock ).getByPlaceholderText( 'Start writing…' );
changeAndSelectTextOfRichText(
paragraphTextInput,
' some text ',
{
selectionStart: 5,
selectionEnd: 14,
}
);
typeInRichText( paragraphTextInput, ' some text ', {
finalSelectionStart: 5,
finalSelectionEnd: 14,
} );
fireEvent.press( screen.getByLabelText( 'Italic' ) );

// Assert
Expand Down
10 changes: 3 additions & 7 deletions packages/block-library/src/preformatted/test/edit.native.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
*/
import {
addBlock,
changeAndSelectTextOfRichText,
typeInRichText,
fireEvent,
getEditorHtml,
initializeEditor,
Expand Down Expand Up @@ -67,17 +67,13 @@ describe( 'Preformatted', () => {
const preformattedTextInput = await screen.findByPlaceholderText(
'Write preformatted text…'
);
const string = 'A great statement.';
changeAndSelectTextOfRichText( preformattedTextInput, string, {
selectionStart: string.length,
selectionEnd: string.length,
} );
typeInRichText( preformattedTextInput, 'A great statement.' );
fireEvent( preformattedTextInput, 'onKeyDown', {
nativeEvent: {},
preventDefault() {},
keyCode: ENTER,
} );
changeAndSelectTextOfRichText( preformattedTextInput, 'Again' );
typeInRichText( preformattedTextInput, 'Again' );

// Assert
expect( getEditorHtml() ).toMatchInlineSnapshot( `
Expand Down
Loading