Skip to content

Commit

Permalink
Parser: Extract the deprecated versions handler to a separate function
Browse files Browse the repository at this point in the history
  • Loading branch information
youknowriad committed Dec 6, 2017
1 parent 3f94460 commit 5a1ef20
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 22 deletions.
49 changes: 33 additions & 16 deletions blocks/api/parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* External dependencies
*/
import { parse as hpqParse } from 'hpq';
import { mapValues, find, omit } from 'lodash';
import { mapValues, omit } from 'lodash';

/**
* Internal dependencies
Expand Down Expand Up @@ -129,6 +129,32 @@ export function getBlockAttributes( blockType, innerHTML, attributes ) {
return blockAttributes;
}

/**
* Attempt to parse the innerHTML using using a supplied `deprecated` definition.
*
* @param {?Object} blockType Block type
* @param {string} innerHTML Raw block content
* @param {?Object} attributes Known block attributes (from delimiters)
* @return {Object} Block attributes
*/
export function getAttributesFromDeprecatedVersion( blockType, innerHTML, attributes ) {
if ( ! blockType.deprecated ) {
return;
}

for ( let i = 0; i < blockType.deprecated.length; i++ ) {
const deprecatedBlockType = {
...omit( blockType, [ 'attributes', 'save', 'supports' ] ), // Parsing/Serialization properties
...blockType.deprecated[ i ],
};
const deprecatedBlockAttributes = getBlockAttributes( deprecatedBlockType, innerHTML, attributes );
const isValid = isValidBlock( innerHTML, deprecatedBlockType, deprecatedBlockAttributes );
if ( isValid ) {
return deprecatedBlockAttributes;
}
}
}

/**
* Creates a block with fallback to the unknown type handler.
*
Expand Down Expand Up @@ -181,23 +207,14 @@ export function createBlockWithFallback( name, innerHTML, attributes ) {
// as invalid, or future serialization attempt results in an error
block.originalContent = innerHTML;

// When a block is invalid, attempt to validate again using a supplied `deprecated` definition.
// When a block is invalid, attempt to parse it using a supplied `deprecated` definition.
// This allows blocks to modify their attribute and markup structure without invalidating
// content written in previous formats.
if ( ! block.isValid && blockType.deprecated ) {
let attributesParsedWithDeprecatedVersion;
const hasValidOlderVersion = find( blockType.deprecated, ( oldBlockType ) => {
const deprecatedBlockType = {
...omit( blockType, [ 'attributes', 'save', 'supports' ] ), // Parsing/Serialization properties
...oldBlockType,
};
const deprecatedBlockAttributes = getBlockAttributes( deprecatedBlockType, innerHTML, attributes );
const isValid = isValidBlock( innerHTML, deprecatedBlockType, deprecatedBlockAttributes );
attributesParsedWithDeprecatedVersion = isValid ? deprecatedBlockAttributes : undefined;
return isValid;
} );

if ( hasValidOlderVersion ) {
if ( ! block.isValid ) {
const attributesParsedWithDeprecatedVersion = getAttributesFromDeprecatedVersion(
blockType, innerHTML, attributes
);
if ( attributesParsedWithDeprecatedVersion ) {
block.isValid = true;
block.attributes = attributesParsedWithDeprecatedVersion;
}
Expand Down
73 changes: 67 additions & 6 deletions blocks/api/test/parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
getBlockAttributes,
asType,
createBlockWithFallback,
getAttributesFromDeprecatedVersion,
default as parse,
} from '../parser';
import {
Expand All @@ -15,6 +16,15 @@ import {
setUnknownTypeHandlerName,
} from '../registration';

const expectFailingBlockValidation = () => {
/* eslint-disable no-console */
expect( console.error ).toHaveBeenCalled();
expect( console.warn ).toHaveBeenCalled();
console.warn.mockClear();
console.error.mockClear();
/* eslint-enable no-console */
};

describe( 'block parser', () => {
const defaultBlockSettings = {
attributes: {
Expand Down Expand Up @@ -164,6 +174,62 @@ describe( 'block parser', () => {
} );
} );

describe( 'getAttributesFromDeprecatedVersion', () => {
it( 'should return undefined if the block has no deprecated versions', () => {
const attributes = getAttributesFromDeprecatedVersion(
defaultBlockSettings,
'<span class="wp-block-test-block">Bananas</span>',
{},
);
expect( attributes ).toBeUndefined();
} );

it( 'should return undefined if no valid deprecated version found', () => {
const attributes = getAttributesFromDeprecatedVersion(
{
name: 'core/test-block',
...defaultBlockSettings,
deprecated: [
{
save() {
return 'nothing';
},
},
],
},
'<span class="wp-block-test-block">Bananas</span>',
{},
);
expect( attributes ).toBeUndefined();
expectFailingBlockValidation();
} );

it( 'should return the attributes parsed by the deprecated version', () => {
const attributes = getAttributesFromDeprecatedVersion(
{
name: 'core/test-block',
...defaultBlockSettings,
save: ( props ) => <div>{ props.attributes.fruit }</div>,
deprecated: [
{
attributes: {
fruit: {
type: 'string',
source: 'text',
selector: 'span',
},
},
save: ( props ) => <span>{ props.attributes.fruit }</span>,
},
],
},
'<span class="wp-block-test-block">Bananas</span>',
{},
);
expect( attributes ).toEqual( { fruit: 'Bananas' } );
} );
} );

describe( 'createBlockWithFallback', () => {
it( 'should create the requested block if it exists', () => {
registerBlockType( 'core/test-block', defaultBlockSettings );
Expand Down Expand Up @@ -245,12 +311,7 @@ describe( 'block parser', () => {
expect( block.name ).toEqual( 'core/test-block' );
expect( block.attributes ).toEqual( { fruit: 'Bananas' } );
expect( block.isValid ).toBe( true );
/* eslint-disable no-console */
expect( console.error ).toHaveBeenCalled();
expect( console.warn ).toHaveBeenCalled();
console.warn.mockClear();
console.error.mockClear();
/* eslint-enable no-console */
expectFailingBlockValidation();
} );
} );

Expand Down

0 comments on commit 5a1ef20

Please sign in to comment.