@wordpress/editor/src/bindings/test/post-meta.js

Enhanced block editor for WordPress posts.

/**
 * Internal dependencies
 */
import { lock } from '../../lock-unlock';

/**
 * Internal dependencies
 */
import postMetaBindings from '../post-meta';

describe( 'post-meta bindings', () => {
	let context, select, selectReturn;

	beforeAll( () => {
		const getEditedEntityRecord = ( kind, type, id ) => ( {
			meta:
				id === 123
					? {
							movie_field: 'Test Movie Value',
							_protected_field: 'Protected field value',
					  }
					: {},
		} );

		const getEditorSettings = () => ( {
			enableCustomFields: false,
		} );

		selectReturn = {
			getEditedEntityRecord,
			getEditorSettings,
		};

		const getRegisteredPostMeta = () => ( {
			field_without_label_or_default: { type: 'string' },
			field_with_label_only: {
				title: 'Field With Label Only',
				default: '', // If there's no default set, getRegisteredPostMeta() will return an empty string.
				type: 'string',
			},
			movie_field: {
				title: 'Movie Field Label',
				default: 'Movie field default value',
				type: 'string',
			},
			_protected_field: {
				default: 'Protected field default value',
				type: 'string',
			},
		} );

		lock( selectReturn, { getRegisteredPostMeta } );

		select = () => selectReturn;
	} );

	describe( 'when no postId is provided in context', () => {
		beforeAll( () => {
			context = { postType: 'movie' };
		} );

		describe( 'getValues', () => {
			it( 'should return the meta default value if it is defined', () => {
				const values = postMetaBindings.getValues( {
					select,
					context,
					bindings: {
						content: {
							args: { key: 'movie_field' },
						},
					},
				} );

				expect( values.content ).toBe( 'Movie field default value' );
			} );

			it( 'should fall back to the field label if the meta default value is not defined', () => {
				const values = postMetaBindings.getValues( {
					select,
					context,
					bindings: {
						content: {
							args: { key: 'field_with_label_only' },
						},
					},
				} );

				expect( values.content ).toBe( 'Field With Label Only' );
			} );

			it( 'should fall back to the field key if the field label is not defined', () => {
				const values = postMetaBindings.getValues( {
					select,
					context,
					bindings: {
						content: {
							args: { key: 'field_without_label_or_default' },
						},
					},
				} );

				expect( values.content ).toBe(
					'field_without_label_or_default'
				);
			} );
		} );

		describe( 'getFieldsList', () => {
			it( 'should return the list of available meta fields, with correct fallbacks for labels, and exclude protected fields', () => {
				const fields = postMetaBindings.getFieldsList( {
					select,
					context,
				} );

				expect( fields ).toEqual( [
					{
						label: 'field_without_label_or_default',
						type: 'string',
						args: { key: 'field_without_label_or_default' },
					},
					{
						label: 'Field With Label Only',
						type: 'string',
						args: { key: 'field_with_label_only' },
					},
					{
						label: 'Movie Field Label',
						type: 'string',
						args: { key: 'movie_field' },
					},
				] );
			} );
		} );
	} );

	describe( 'when postId is provided in context', () => {
		beforeAll( () => {
			context = { postType: 'movie', postId: 123 };
		} );

		describe( 'getValues', () => {
			it( 'should return the meta value if it is defined', () => {
				const values = postMetaBindings.getValues( {
					select,
					context,
					bindings: {
						content: {
							args: { key: 'movie_field' },
						},
					},
				} );

				expect( values.content ).toBe( 'Test Movie Value' );
			} );

			it( 'should fall back to the key when meta field is not accessible', () => {
				const values = postMetaBindings.getValues( {
					select,
					context,
					bindings: {
						content: {
							args: { key: 'inaccessible_field' },
						},
					},
				} );

				expect( values.content ).toBe( 'inaccessible_field' );
			} );

			it( 'should fall back to the key when meta field is protected', () => {
				const values = postMetaBindings.getValues( {
					select,
					context,
					bindings: {
						content: {
							args: { key: '_protected_field' },
						},
					},
				} );

				expect( values.content ).toBe( '_protected_field' );
			} );
		} );

		describe( 'canUserEditValue', () => {
			beforeAll( () => {
				select = () => ( { ...selectReturn, canUser: () => true } );
			} );

			it( 'should return false when meta field is not accessible', () => {
				const canUser = postMetaBindings.canUserEditValue( {
					select,
					context,
					args: { key: 'inaccessible_field' },
				} );

				expect( canUser ).toBe( false );
			} );

			it( 'should return false when meta field is protected', () => {
				const canUser = postMetaBindings.canUserEditValue( {
					select,
					context,
					args: { key: '_protected_field' },
				} );

				expect( canUser ).toBe( false );
			} );
		} );
	} );
} );