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.

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

Extract hook for offcanvas inserted block #46618

Merged
merged 3 commits into from
Dec 20, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* WordPress dependencies
*/
import { useSelect, useDispatch } from '@wordpress/data';
import { useSelect } from '@wordpress/data';
import { forwardRef, useState } from '@wordpress/element';
/**
* Internal dependencies
Expand All @@ -10,6 +10,7 @@ import { store as blockEditorStore } from '../../store';
import Inserter from '../inserter';
import { LinkUI } from './link-ui';
import { updateAttributes } from './update-attributes';
import { useInsertedBlock } from './use-inserted-block';

const BLOCKS_WITH_LINK_UI_SUPPORT = [
'core/navigation-link',
Expand All @@ -36,27 +37,11 @@ export const Appender = forwardRef( ( props, ref ) => {
};
}, [] );

const { insertedBlockAttributes, insertedBlockName } = useSelect(
( select ) => {
const { getBlockName, getBlockAttributes } =
select( blockEditorStore );

return {
insertedBlockAttributes: getBlockAttributes(
insertedBlockClientId
),
insertedBlockName: getBlockName( insertedBlockClientId ),
};
},
[ insertedBlockClientId ]
);

const { updateBlockAttributes } = useDispatch( blockEditorStore );

const setAttributes =
( _insertedBlockClientId ) => ( _updatedAttributes ) => {
updateBlockAttributes( _insertedBlockClientId, _updatedAttributes );
};
const {
insertedBlockAttributes,
insertedBlockName,
setInsertedBlockAttributes,
} = useInsertedBlock( insertedBlockClientId );

const maybeSetInsertedBlockOnInsertion = ( _insertedBlock ) => {
if ( ! _insertedBlock?.clientId ) {
Expand All @@ -81,7 +66,7 @@ export const Appender = forwardRef( ( props, ref ) => {
onChange={ ( updatedValue ) => {
updateAttributes(
updatedValue,
setAttributes( insertedBlockClientId ),
setInsertedBlockAttributes,
insertedBlockAttributes
);
setInsertedBlockClientId( null );
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
/**
* Internal dependencies
*/
import { useInsertedBlock } from '../use-inserted-block';

/**
* WordPress dependencies
*/
import { useDispatch, useSelect } from '@wordpress/data';

/**
* External dependencies
*/
import { act, renderHook } from '@testing-library/react';

jest.mock( '@wordpress/data/src/components/use-select', () => {
// This allows us to tweak the returned value on each test.
const mock = jest.fn();
return mock;
} );

jest.mock( '@wordpress/data/src/components/use-dispatch', () => ( {
useDispatch: jest.fn(),
} ) );

describe( 'useInsertedBlock', () => {
const mockUpdateBlockAttributes = jest.fn();

it( 'returns undefined values when called without a block clientId', () => {
useSelect.mockImplementation( () => ( {
insertedBlockAttributes: {
'some-attribute': 'some-value',
},
insertedBlockName: 'core/navigation-link',
} ) );

useDispatch.mockImplementation( () => ( {
updateBlockAttributes: mockUpdateBlockAttributes,
} ) );

const { result } = renderHook( () => useInsertedBlock() );

const {
insertedBlockName,
insertedBlockAttributes,
setInsertedBlockAttributes,
} = result.current;

expect( insertedBlockName ).toBeUndefined();
expect( insertedBlockAttributes ).toBeUndefined();
expect(
setInsertedBlockAttributes( { 'some-attribute': 'new-value' } )
).toBeUndefined();
} );

it( 'returns name and attributes when called with a block clientId', () => {
useSelect.mockImplementation( () => ( {
insertedBlockAttributes: {
'some-attribute': 'some-value',
},
insertedBlockName: 'core/navigation-link',
} ) );

useDispatch.mockImplementation( () => ( {
updateBlockAttributes: mockUpdateBlockAttributes,
} ) );

const { result } = renderHook( () =>
useInsertedBlock( 'some-client-id-here' )
);

const { insertedBlockName, insertedBlockAttributes } = result.current;

expect( insertedBlockName ).toBe( 'core/navigation-link' );
expect( insertedBlockAttributes ).toEqual( {
'some-attribute': 'some-value',
} );
} );

it( 'dispatches updateBlockAttributes on provided client ID with new attributes when setInsertedBlockAttributes is called', () => {
useSelect.mockImplementation( () => ( {
insertedBlockAttributes: {
'some-attribute': 'some-value',
},
insertedBlockName: 'core/navigation-link',
} ) );

useDispatch.mockImplementation( () => ( {
updateBlockAttributes: mockUpdateBlockAttributes,
} ) );

const clientId = '123456789';

const { result } = renderHook( () => useInsertedBlock( clientId ) );

const { setInsertedBlockAttributes } = result.current;

act( () => {
setInsertedBlockAttributes( {
'some-attribute': 'new-value',
} );
} );

expect( mockUpdateBlockAttributes ).toHaveBeenCalledWith( clientId, {
'some-attribute': 'new-value',
} );
} );
} );
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
/**
* WordPress dependencies
*/
import { useSelect, useDispatch } from '@wordpress/data';

/**
* Internal dependencies
*/
import { store as blockEditorStore } from '../../store';

export const useInsertedBlock = ( insertedBlockClientId ) => {
const { insertedBlockAttributes, insertedBlockName } = useSelect(
( select ) => {
const { getBlockName, getBlockAttributes } =
select( blockEditorStore );

return {
insertedBlockAttributes: getBlockAttributes(
insertedBlockClientId
),
insertedBlockName: getBlockName( insertedBlockClientId ),
};
},
[ insertedBlockClientId ]
);

const { updateBlockAttributes } = useDispatch( blockEditorStore );

const setInsertedBlockAttributes = ( _updatedAttributes ) => {
if ( ! insertedBlockClientId ) return;
updateBlockAttributes( insertedBlockClientId, _updatedAttributes );
};

if ( ! insertedBlockClientId ) {
return {
insertedBlockAttributes: undefined,
insertedBlockName: undefined,
setInsertedBlockAttributes,
};
}

return {
insertedBlockAttributes,
insertedBlockName,
setInsertedBlockAttributes,
};
};