Block API: Normalize function arguments

docs/reference/deprecated.md

@@ -6,6 +6,7 @@ Gutenberg's deprecation policy is intended to support backwards-compatibility fo
 - `wp.compose.remountOnPropChange` has been removed.
 - The following editor store actions have been removed: `createNotice`, `removeNotice`, `createSuccessNotice`, `createInfoNotice`, `createErrorNotice`, `createWarningNotice`. Use the equivalent actions by the same name from the `@wordpress/notices` module.
 - The id prop of wp.nux.DotTip has been removed. Please use the tipId prop instead.
+- `wp.blocks.isValidBlock` has been removed. Please use `wp.blocks.isBlockContentValid` instead.
 
 ## 4.3.0
 

packages/blocks/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 5.1.0 (Unreleased)
+
+### New feature
+
+- `isBlockContentValid` function has been added ([#10891](https://github.com/WordPress/gutenberg/pull/10891)).
+
+### Deprecation
+
+- `isValidBlock` function has been deprecated ([#10891](https://github.com/WordPress/gutenberg/pull/10891)). Use `isBlockContentValid` instead.
+
 ## 5.0.0 (2018-10-29)
 
 ### Breaking Changes

packages/blocks/src/api/factory.js

@@ -29,20 +29,20 @@ import { getBlockType, getBlockTypes } from './registration';
 /**
  * Returns a block object given its type and attributes.
  *
- * @param {string} name            Block name.
- * @param {Object} blockAttributes Block attributes.
- * @param {?Array} innerBlocks     Nested blocks.
+ * @param {string} name        Block name.
+ * @param {Object} attributes  Block attributes.
+ * @param {?Array} innerBlocks Nested blocks.
  *
  * @return {Object} Block object.
  */
-export function createBlock( name, blockAttributes = {}, innerBlocks = [] ) {
+export function createBlock( name, attributes = {}, innerBlocks = [] ) {
 	// Get the type definition associated with a registered block.
 	const blockType = getBlockType( name );
 
 	// Ensure attributes contains only values defined by block type, and merge
 	// default values for missing attributes.
-	const attributes = reduce( blockType.attributes, ( result, schema, key ) => {
-		const value = blockAttributes[ key ];
+	const sanitizedAttributes = reduce( blockType.attributes, ( result, schema, key ) => {
+		const value = attributes[ key ];
 
 		if ( undefined !== value ) {
 			result[ key ] = value;
@@ -75,7 +75,7 @@ export function createBlock( name, blockAttributes = {}, innerBlocks = [] ) {
 		clientId,
 		name,
 		isValid: true,
-		attributes,
+		attributes: sanitizedAttributes,
 		innerBlocks,
 	};
 }
@@ -84,7 +84,7 @@ export function createBlock( name, blockAttributes = {}, innerBlocks = [] ) {
  * Given a block object, returns a copy of the block object, optionally merging
  * new attributes and/or replacing its inner blocks.
  *
- * @param {Object} block              Block object.
+ * @param {Object} block              Block instance.
  * @param {Object} mergeAttributes    Block attributes.
  * @param {?Array} newInnerBlocks     Nested blocks.
  *
@@ -112,7 +112,6 @@ export function cloneBlock( block, mergeAttributes = {}, newInnerBlocks ) {
  * @param {Object} transform The transform object to validate.
  * @param {string} direction Is this a 'from' or 'to' transform.
  * @param {Array} blocks The blocks to transform from.
- * @param {boolean} isMultiBlock Have multiple blocks been selected?
  *
  * @return {boolean} Is the transform possible?
  */
@@ -157,7 +156,6 @@ const isPossibleTransformForSource = ( transform, direction, blocks ) => {
  * 'from' transforms on other blocks.
  *
  * @param {Array}  blocks  The blocks to transform from.
- * @param {boolean} isMultiBlock Have multiple blocks been selected?
  *
  * @return {Array} Block types that the blocks can be transformed into.
  */
@@ -189,7 +187,6 @@ const getBlockTypesForPossibleFromTransforms = ( blocks ) => {
  * the source block's own 'to' transforms.
  *
  * @param {Array} blocks The blocks to transform from.
- * @param {boolean} isMultiBlock Have multiple blocks been selected?
  *
  * @return {Array} Block types that the source can be transformed into.
  */

packages/blocks/src/api/index.js

@@ -20,7 +20,7 @@ export {
 	getSaveElement,
 	getSaveContent,
 } from './serializer';
-export { isValidBlock } from './validation';
+export { isBlockContentValid, isValidBlock } from './validation';
 export {
 	getCategories,
 	setCategories,

packages/blocks/src/api/parser.js

@@ -20,7 +20,7 @@ import {
 	getUnregisteredTypeHandlerName,
 } from './registration';
 import { createBlock } from './factory';
-import { isValidBlock } from './validation';
+import { isBlockContentValid } from './validation';
 import { getCommentDelimitedContent } from './serializer';
 import { attr, html, text, query, node, children, prop } from './matchers';
 
@@ -283,7 +283,7 @@ export function getBlockAttribute( attributeKey, attributeSchema, innerHTML, com
  *
  * @return {Object} All block attributes.
  */
-export function getBlockAttributes( blockType, innerHTML, attributes ) {
+export function getBlockAttributes( blockType, innerHTML, attributes = {} ) {
 	const blockAttributes = mapValues( blockType.attributes, ( attributeSchema, attributeKey ) => {
 		return getBlockAttribute( attributeKey, attributeSchema, innerHTML, attributes );
 	} );
@@ -340,10 +340,10 @@ export function getMigratedBlock( block ) {
 		);
 
 		// Ignore the deprecation if it produces a block which is not valid.
-		const isValid = isValidBlock(
-			originalContent,
+		const isValid = isBlockContentValid(
 			deprecatedBlockType,
-			migratedAttributes
+			migratedAttributes,
+			originalContent
 		);
 
 		if ( ! isValid ) {
@@ -459,7 +459,7 @@ export function createBlockWithFallback( blockNode ) {
 	// provided source value with the serialized output before there are any modifications to
 	// the block. When both match, the block is marked as valid.
 	if ( ! isFallbackBlock ) {
-		block.isValid = isValidBlock( innerHTML, blockType, block.attributes );
+		block.isValid = isBlockContentValid( blockType, block.attributes, innerHTML );
 	}
 
 	// Preserve original content for future use in case the block is parsed as

packages/blocks/src/api/registration.js

@@ -174,10 +174,10 @@ export function unregisterBlockType( name ) {
 /**
  * Assigns name of block for handling non-block content.
  *
- * @param {string} name Block name.
+ * @param {string} blockName Block name.
  */
-export function setFreeformContentHandlerName( name ) {
-	dispatch( 'core/blocks' ).setFreeformFallbackBlockName( name );
+export function setFreeformContentHandlerName( blockName ) {
+	dispatch( 'core/blocks' ).setFreeformFallbackBlockName( blockName );
 }
 
 /**
@@ -193,10 +193,10 @@ export function getFreeformContentHandlerName() {
 /**
  * Assigns name of block handling unregistered block types.
  *
- * @param {string} name Block name.
+ * @param {string} blockName Block name.
  */
-export function setUnregisteredTypeHandlerName( name ) {
-	dispatch( 'core/blocks' ).setUnregisteredFallbackBlockName( name );
+export function setUnregisteredTypeHandlerName( blockName ) {
+	dispatch( 'core/blocks' ).setUnregisteredFallbackBlockName( blockName );
 }
 
 /**

packages/blocks/src/api/serializer.js

@@ -134,14 +134,14 @@ export function getSaveContent( blockType, attributes, innerBlocks ) {
  * This function returns only those attributes which are needed to persist and
  * which cannot be matched from the block content.
  *
- * @param {Object<string,*>} allAttributes Attributes from in-memory block data.
  * @param {Object<string,*>} blockType     Block type.
+ * @param {Object<string,*>} attributes Attributes from in-memory block data.
  *
  * @return {Object<string,*>} Subset of attributes for comment serialization.
  */
-export function getCommentAttributes( allAttributes, blockType ) {
-	const attributes = reduce( blockType.attributes, ( result, attributeSchema, key ) => {
-		const value = allAttributes[ key ];
+export function getCommentAttributes( blockType, attributes ) {
+	return reduce( blockType.attributes, ( result, attributeSchema, key ) => {
+		const value = attributes[ key ];
 
 		// Ignore undefined values.
 		if ( undefined === value ) {
@@ -163,8 +163,6 @@ export function getCommentAttributes( allAttributes, blockType ) {
 		result[ key ] = value;
 		return result;
 	}, {} );
-
-	return attributes;
 }
 
 /**
@@ -195,7 +193,7 @@ export function serializeAttributes( attributes ) {
 /**
  * Given a block object, returns the Block's Inner HTML markup.
  *
- * @param {Object} block Block Object.
+ * @param {Object} block Block instance.
  *
  * @return {string} HTML.
  */
@@ -262,7 +260,7 @@ export function serializeBlock( block ) {
 	const blockName = block.name;
 	const blockType = getBlockType( blockName );
 	const saveContent = getBlockContent( block );
-	const saveAttributes = getCommentAttributes( block.attributes, blockType );
+	const saveAttributes = getCommentAttributes( blockType, block.attributes );
 
 	switch ( blockName ) {
 		case getFreeformContentHandlerName():

packages/blocks/src/api/test/serializer.js

@@ -79,22 +79,27 @@ describe( 'block serializer', () => {
 		} );
 
 		it( 'should only return attributes which are not matched from content', () => {
-			const attributes = getCommentAttributes( {
-				fruit: 'bananas',
-				category: 'food',
-				ripeness: 'ripe',
-			}, { attributes: {
-				fruit: {
-					type: 'string',
-					source: 'text',
-				},
-				category: {
-					type: 'string',
-				},
-				ripeness: {
-					type: 'string',
+			const attributes = getCommentAttributes(
+				{
+					attributes: {
+						fruit: {
+							type: 'string',
+							source: 'text',
+						},
+						category: {
+							type: 'string',
+						},
+						ripeness: {
+							type: 'string',
+						},
+					},
 				},
-			} } );
+				{
+					fruit: 'bananas',
+					category: 'food',
+					ripeness: 'ripe',
+				}
+			);
 
 			expect( attributes ).toEqual( {
 				category: 'food',
@@ -103,17 +108,22 @@ describe( 'block serializer', () => {
 		} );
 
 		it( 'should skip attributes whose values are undefined', () => {
-			const attributes = getCommentAttributes( {
-				fruit: 'bananas',
-				ripeness: undefined,
-			}, { attributes: {
-				fruit: {
-					type: 'string',
-				},
-				ripeness: {
-					type: 'string',
+			const attributes = getCommentAttributes(
+				{
+					attributes: {
+						fruit: {
+							type: 'string',
+						},
+						ripeness: {
+							type: 'string',
+						},
+					},
 				},
-			} } );
+				{
+					fruit: 'bananas',
+					ripeness: undefined,
+				}
+			);
 
 			expect( attributes ).toEqual( { fruit: 'bananas' } );
 		} );

packages/blocks/src/api/test/validation.js

@@ -13,7 +13,7 @@ import {
 	isEqualTokensOfType,
 	getNextNonWhitespaceToken,
 	isEquivalentHTML,
-	isValidBlock,
+	isBlockContentValid,
 	isClosedByToken,
 } from '../validation';
 import {
@@ -553,14 +553,14 @@ describe( 'validation', () => {
 		} );
 	} );
 
-	describe( 'isValidBlock()', () => {
+	describe( 'isBlockContentValid()', () => {
 		it( 'returns false if block is not valid', () => {
 			registerBlockType( 'core/test-block', defaultBlockSettings );
 
-			const isValid = isValidBlock(
-				'Apples',
+			const isValid = isBlockContentValid(
 				getBlockType( 'core/test-block' ),
-				{ fruit: 'Bananas' }
+				{ fruit: 'Bananas' },
+				'Apples'
 			);
 
 			expect( console ).toHaveWarned();
@@ -576,10 +576,10 @@ describe( 'validation', () => {
 				},
 			} );
 
-			const isValid = isValidBlock(
-				'Bananas',
+			const isValid = isBlockContentValid(
 				getBlockType( 'core/test-block' ),
-				{ fruit: 'Bananas' }
+				{ fruit: 'Bananas' },
+				'Bananas'
 			);
 
 			expect( console ).toHaveErrored();
@@ -589,10 +589,10 @@ describe( 'validation', () => {
 		it( 'returns true is block is valid', () => {
 			registerBlockType( 'core/test-block', defaultBlockSettings );
 
-			const isValid = isValidBlock(
-				'Bananas',
+			const isValid = isBlockContentValid(
 				getBlockType( 'core/test-block' ),
-				{ fruit: 'Bananas' }
+				{ fruit: 'Bananas' },
+				'Bananas'
 			);
 
 			expect( isValid ).toBe( true );

packages/blocks/src/api/validation.js

@@ -4,6 +4,11 @@
 import { tokenize } from 'simple-html-tokenizer';
 import { xor, fromPairs, isEqual, includes, stubTrue } from 'lodash';
 
+/**
+ * WordPress dependencies
+ */
+import deprecated from '@wordpress/deprecated';
+
 /**
  * Internal dependencies
  */
@@ -485,20 +490,30 @@ export function isEquivalentHTML( actual, expected ) {
 	return true;
 }
 
+export function isValidBlock( innerHTML, blockType, attributes ) {
+	deprecated( 'isValidBlock', {
+		plugin: 'Gutenberg',
+		version: '4.3',
+		alternative: 'isBlockContentValid',
+	} );
+
+	return isBlockContentValid( blockType, attributes, innerHTML );
+}
+
 /**
  * Returns true if the parsed block is valid given the input content. A block
  * is considered valid if, when serialized with assumed attributes, the content
  * matches the original value.
  *
  * Logs to console in development environments when invalid.
  *
- * @param {string} innerHTML  Original block content.
  * @param {string} blockType  Block type.
  * @param {Object} attributes Parsed block attributes.
+ * @param {string} innerHTML  Original block content.
  *
  * @return {boolean} Whether block is valid.
  */
-export function isValidBlock( innerHTML, blockType, attributes ) {
+export function isBlockContentValid( blockType, attributes, innerHTML ) {
 	let saveContent;
 	try {
 		saveContent = getSaveContent( blockType, attributes );