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

Update theme.json schema migrations #36154

Merged
merged 4 commits into from
Nov 3, 2021
Merged

Update theme.json schema migrations #36154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0a1e8e6
Make it clear that each one migrates to the next
oandregal Nov 2, 2021
94769dc
Centralize in migrate method
oandregal Nov 2, 2021
2d2112a
Update comments and remove unused code for v1 remove custom prefixes …
oandregal Nov 2, 2021
7ff8e03
Update comments and remove unused code for v0 to v1 migration
oandregal Nov 2, 2021
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
43 changes: 23 additions & 20 deletions lib/class-wp-theme-json-gutenberg.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,17 +286,7 @@ public function __construct( $theme_json = array(), $origin = 'theme' ) {
$origin = 'theme';
}

// The old format is not meant to be ported to core.
// We can remove it at that point.
if ( ! isset( $theme_json['version'] ) || 0 === $theme_json['version'] ) {
$theme_json = WP_Theme_JSON_Schema_V0::parse( $theme_json );
}

// Provide backwards compatibility for settings that did not land in 5.8
// and have had their `custom` prefixed removed since.
if ( 1 === $theme_json['version'] ) {
$theme_json = WP_Theme_JSON_Schema_V1::parse( $theme_json );
}
$theme_json = self::migrate( $theme_json );

$valid_block_names = array_keys( self::get_blocks_metadata() );
$valid_element_names = array_keys( self::ELEMENTS );
Expand All @@ -315,6 +305,27 @@ public function __construct( $theme_json = array(), $origin = 'theme' ) {
}
}

/**
* Function that migrates a given theme.json structure to the last version.
*
* @param array $theme_json The structure to migrate.
*
* @return array The structure in the last version.
*/
private static function migrate( $theme_json ) {
if ( ! isset( $theme_json['version'] ) || 0 === $theme_json['version'] ) {
$theme_json = WP_Theme_JSON_Schema_V0_To_V1::migrate( $theme_json );
}

// Provide backwards compatibility for settings that did not land in 5.8
// and have had their `custom` prefixed removed since.
if ( 1 === $theme_json['version'] ) {
$theme_json = WP_Theme_JSON_Schema_V1_Remove_Custom_Prefixes::migrate( $theme_json );
}

return $theme_json;
}

/**
* Sanitizes the input according to the schemas.
*
Expand Down Expand Up @@ -1436,15 +1447,7 @@ private static function is_safe_css_declaration( $property_name, $property_value
public static function remove_insecure_properties( $theme_json ) {
$sanitized = array();

if ( ! isset( $theme_json['version'] ) || 0 === $theme_json['version'] ) {
$theme_json = WP_Theme_JSON_Schema_V0::parse( $theme_json );
}

// Provide backwards compatibility for settings that did not land in 5.8
// and have had their `custom` prefixed removed since.
if ( 1 === $theme_json['version'] ) {
$theme_json = WP_Theme_JSON_Schema_V1::parse( $theme_json );
}
$theme_json = self::migrate( $theme_json );

$valid_block_names = array_keys( self::get_blocks_metadata() );
$valid_element_names = array_keys( self::ELEMENTS );
Expand Down
186 changes: 51 additions & 135 deletions lib/class-wp-theme-json-schema-v0.php → lib/class-wp-theme-json-schema-v0-to-v1.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
<?php
/**
* Class that implements a WP_Theme_JSON_Schema to convert
* a given structure in v0 schema to the latest one.
* Class that implements a WP_Theme_JSON_Schema migration.
*
* @package gutenberg
*/

/**
* Class that implements a WP_Theme_JSON_Schema to convert
* a given structure in v0 schema to the latest one.
* Class that migrates a given structure in v0 schema to one
* that follows the v1 schema.
*/
class WP_Theme_JSON_Schema_V0 implements WP_Theme_JSON_Schema {
class WP_Theme_JSON_Schema_V0_To_V1 implements WP_Theme_JSON_Schema {

/**
* How to address all the blocks
Expand All @@ -27,108 +26,65 @@ class WP_Theme_JSON_Schema_V0 implements WP_Theme_JSON_Schema {
const ROOT_BLOCK_NAME = 'root';

/**
* Data schema of each block within a theme.json.
* Converts a v0 data structure into a v1 one.
*
* Example:
* It expects input data to come in v0 form:
*
* {
* 'block-one': {
* 'styles': {
* 'color': {
* 'background': 'color'
* }
* },
* 'settings': {
* 'color': {
* 'custom': true
* }
* 'root': {
* 'settings': { ... },
* 'styles': { ... }
* }
* 'core/paragraph': {
* 'styles': { ... },
* 'settings': { ... }
* },
* 'core/heading/h1': {
* 'settings': { ... }
* 'styles': { ... }
* },
* 'core/heading/h2': {
* 'settings': { ... }
* 'styles': { ... }
* },
* }
*
* And it will return v1 form:
*
* {
* 'settings': {
* 'border': { ... }
* 'color': { ... },
* 'typography': { ... },
* 'spacing': { ... },
* 'custom': { ... },
* 'blocks': {
* 'core/paragraph': { ... }
* }
* },
* 'block-two': {
* 'styles': {
* 'color': {
* 'link': 'color'
* styles: {
* border: { ... }
* color: { ... },
* typography: { ... },
* spacing: { ... },
* custom: { ... },
* blocks: {
* core/paragraph: { ... }
* core/heading: {
* elements: {
* h1: { ... },
* h2: { ... }
* }
* }
* }
* }
* }
*/
const SCHEMA = array(
'customTemplates' => null,
'templateParts' => null,
'styles' => array(
'border' => array(
'radius' => null,
'color' => null,
'style' => null,
'width' => null,
),
'color' => array(
'background' => null,
'gradient' => null,
'link' => null,
'text' => null,
),
'spacing' => array(
'padding' => array(
'top' => null,
'right' => null,
'bottom' => null,
'left' => null,
),
),
'typography' => array(
'fontFamily' => null,
'fontSize' => null,
'fontStyle' => null,
'fontWeight' => null,
'lineHeight' => null,
'textDecoration' => null,
'textTransform' => null,
),
),
'settings' => array(
'border' => array(
'customRadius' => null,
'customColor' => null,
'customStyle' => null,
'customWidth' => null,
),
'color' => array(
'custom' => null,
'customGradient' => null,
'gradients' => null,
'link' => null,
'palette' => null,
),
'spacing' => array(
'customPadding' => null,
'units' => null,
),
'typography' => array(
'customFontSize' => null,
'customLineHeight' => null,
'dropCap' => null,
'fontFamilies' => null,
'fontSizes' => null,
'customFontStyle' => null,
'customFontWeight' => null,
'customTextDecorations' => null,
'customTextTransforms' => null,
),
'custom' => null,
'layout' => null,
),
);

/**
* Converts a v0 schema into the latest.
*
* @param array $old Data in v0 schema.
*
* @return array Data in the latest schema.
* @return array Data in v1 schema.
*/
public static function parse( $old ) {
public static function migrate( $old ) {
// Copy everything.
$new = $old;

Expand All @@ -140,7 +96,7 @@ public static function parse( $old ) {
$new['styles'] = self::process_styles( $old['styles'] );
}

$new['version'] = WP_Theme_JSON_Gutenberg::LATEST_SCHEMA;
$new['version'] = 1;

return $new;
}
Expand Down Expand Up @@ -184,16 +140,6 @@ private static function process_settings( $settings ) {
array( 'custom' ),
);

$renamed_paths = array(
'border.customColor' => 'border.color',
'border.customStyle' => 'border.style',
'border.customWidth' => 'border.width',
'typography.customFontStyle' => 'typography.fontStyle',
'typography.customFontWeight' => 'typography.fontWeight',
'typography.customTextDecorations' => 'typography.textDecoration',
'typography.customTextTransforms' => 'typography.textTransform',
);

// 'defaults' settings become top-level.
if ( isset( $settings[ self::ALL_BLOCKS_NAME ] ) ) {
$new = $settings[ self::ALL_BLOCKS_NAME ];
Expand Down Expand Up @@ -229,18 +175,6 @@ private static function process_settings( $settings ) {
return $new;
}

// Process any renamed/moved paths within settings.
foreach ( $renamed_paths as $original => $renamed ) {
$original_path = explode( '.', $original );
$renamed_path = explode( '.', $renamed );
$current_value = _wp_array_get( $new, $original_path, null );

if ( null !== $current_value ) {
gutenberg_experimental_set( $new, $renamed_path, $current_value );
self::unset_setting_by_path( $new, $original_path );
}
}

/*
* At this point, it only contains block's data.
* However, some block data we need to consolidate
Expand Down Expand Up @@ -276,24 +210,6 @@ private static function process_settings( $settings ) {
return $new;
}

/**
* Removes a property from within the provided settings by its path.
*
* @param array $settings Reference to the current settings array.
* @param array $path Path to the property to be removed.
*
* @return void
*/
private static function unset_setting_by_path( &$settings, $path ) {
$tmp_settings = &$settings; // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
$last_key = array_pop( $path );
foreach ( $path as $key ) {
$tmp_settings = &$tmp_settings[ $key ];
}

unset( $tmp_settings[ $last_key ] );
}

/**
* Processes the styles subtree.
*
Expand Down
Loading