Skip to content

Extract theme json processor #26803

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

Merged
oandregal merged 29 commits into from
Nov 13, 2020
Merged

Extract theme json processor #26803

Changes from 1 commit
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
5bf46cb
Add WP_Theme_JSON class
oandregal Nov 5, 2020
86a79b0
Add gutenberg_experimental_global_styles_augment_with_block_data func…
oandregal Nov 5, 2020
6a27d97
WP_Theme_JSON: support more styles and presets
oandregal Nov 7, 2020
ea2eb98
Delegate to WP_Theme_JSON to process the tree for settings and styles…
oandregal Nov 7, 2020
1c1b36b
Add tests cases to fix
oandregal Nov 7, 2020
f3290e9
Use block metadata to normalize schema
oandregal Nov 7, 2020
37a50ed
Add test case for metadata
oandregal Nov 7, 2020
71f9f2c
Remove block metadata from global styles as it is part of WP_Theme_JSON
oandregal Nov 7, 2020
609fe5d
Fix link color block.json path
oandregal Nov 9, 2020
bf639ba
Fix metadata
oandregal Nov 9, 2020
e03c839
Adapt client to work with the minimal data it needs
oandregal Nov 9, 2020
f6a82a8
Fix preset generation
oandregal Nov 9, 2020
1718c81
Update test case
oandregal Nov 9, 2020
0c85091
Fix typo in test case
oandregal Nov 9, 2020
ddde638
Fix preset merging
oandregal Nov 9, 2020
c156988
WP_Theme_JSON: process values stored as var:preset|category|value
oandregal Nov 9, 2020
5775cfb
Adds PHPDoc
oandregal Nov 9, 2020
819d9c4
Make linter happy
oandregal Nov 10, 2020
40ada7a
Make linter happy
oandregal Nov 10, 2020
5e87c56
Use less metadata for style properties
oandregal Nov 10, 2020
5de7698
Document PRESET_METADATA and use better keys for its structure
oandregal Nov 10, 2020
4ee2311
Do not attach :root selector to classes at the global level
oandregal Nov 11, 2020
27baf59
Font families do not generate classes
oandregal Nov 11, 2020
263c494
Mark some private functions as static
oandregal Nov 11, 2020
8611881
Extract global type and arguments to a constant
oandregal Nov 11, 2020
fba3c45
Make get_blocks_metadata static
oandregal Nov 11, 2020
7608978
Adapt newly added preset generation in the client
oandregal Nov 12, 2020
4762dfa
Do not use breaking lines
oandregal Nov 12, 2020
77d626a
Substitute get_from_path by gutenberg_experimental_get
oandregal Nov 12, 2020
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
Prev Previous commit
Next Next commit
Remove block metadata from global styles as it is part of WP_Theme_JSON
  • Loading branch information
@oandregal
oandregal committed Nov 13, 2020
commit 71f9f2c10f920859a6803c93143673307bc7adc9
166 changes: 6 additions & 160 deletions lib/global-styles.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ function gutenberg_experimental_global_styles_get_user() {
}
}

return new WP_Theme_JSON( gutenberg_experimental_global_styles_augment_with_block_data( $config ) );
return new WP_Theme_JSON( $config );
}

/**
Expand Down Expand Up @@ -225,10 +225,9 @@ function gutenberg_experimental_global_styles_get_core() {
$font_weight['name'] = $default_font_weights_i18n[ $font_weight['slug'] ];
}
}

// End i18n logic to remove when JSON i18 strings are extracted.

return new WP_Theme_JSON( gutenberg_experimental_global_styles_augment_with_block_data( $config ) );
return new WP_Theme_JSON( $config );
}

/**
Expand Down Expand Up @@ -332,13 +331,9 @@ function gutenberg_experimental_global_styles_get_theme_support_settings() {
* @return WP_Theme_JSON Entity that holds theme data.
*/
function gutenberg_experimental_global_styles_get_theme() {
$theme_support_data = gutenberg_experimental_global_styles_augment_with_block_data(
gutenberg_experimental_global_styles_get_theme_support_settings()
);
$theme_json_data = gutenberg_experimental_global_styles_augment_with_block_data(
gutenberg_experimental_global_styles_get_from_file(
locate_template( 'experimental-theme.json' )
)
$theme_support_data = gutenberg_experimental_global_styles_get_theme_support_settings();
$theme_json_data = gutenberg_experimental_global_styles_get_from_file(
locate_template( 'experimental-theme.json' )
);

/*
Expand All @@ -352,155 +347,6 @@ function gutenberg_experimental_global_styles_get_theme() {
return $result;
}

/**
* Returns the style features a particular block supports.
*
* @param array $supports The block supports array.
*
* @return array Style features supported by the block.
*/
function gutenberg_experimental_global_styles_get_supported_styles( $supports ) {
$support_keys = array(
'--wp--style--color--link' => array( 'color', 'linkColor' ),
'background' => array( 'color', 'gradients' ),
'backgroundColor' => array( 'color' ),
'color' => array( 'color' ),
'fontFamily' => array( '__experimentalFontFamily' ),
'fontSize' => array( 'fontSize' ),
'fontStyle' => array( '__experimentalFontAppearance' ),
'fontWeight' => array( '__experimentalFontAppearance' ),
'lineHeight' => array( 'lineHeight' ),
'textDecoration' => array( '__experimentalTextDecoration' ),
'textTransform' => array( '__experimentalTextTransform' ),
);
$supported_features = array();
foreach ( $support_keys as $key => $path ) {
if ( gutenberg_experimental_get( $supports, $path ) ) {
$supported_features[] = $key;
}
}

return $supported_features;
}

/**
* Retrieves the block data (selector/supports).
*
* @return array
*/
function gutenberg_experimental_global_styles_get_block_data() {
$block_data = array();

$registry = WP_Block_Type_Registry::get_instance();
$blocks = array_merge(
$registry->get_all_registered(),
array(
'global' => new WP_Block_Type(
'global',
array(
'supports' => array(
'__experimentalFontAppearance' => false,
'__experimentalFontFamily' => true,
'__experimentalSelector' => ':root',
'__experimentalTextDecoration' => true,
'__experimentalTextTransform' => true,
'color' => array(
'gradients' => true,
'linkColor' => true,
),
'fontSize' => true,
'lineHeight' => true,
),
)
),
)
);
foreach ( $blocks as $block_name => $block_type ) {
if ( ! property_exists( $block_type, 'supports' ) || empty( $block_type->supports ) || ! is_array( $block_type->supports ) ) {
continue;
}

$supports = gutenberg_experimental_global_styles_get_supported_styles( $block_type->supports );

/*
* Assign the selector for the block.
*
* Some blocks can declare multiple selectors:
*
* - core/heading represents the H1-H6 HTML elements
* - core/list represents the UL and OL HTML elements
* - core/group is meant to represent DIV and other HTML elements
*
* Some other blocks don't provide a selector,
* so we generate a class for them based on their name:
*
* - 'core/group' => '.wp-block-group'
* - 'my-custom-library/block-name' => '.wp-block-my-custom-library-block-name'
*
* Note that, for core blocks, we don't add the `core/` prefix to its class name.
* This is for historical reasons, as they come with a class without that infix.
*
*/
if (
isset( $block_type->supports['__experimentalSelector'] ) &&
is_string( $block_type->supports['__experimentalSelector'] )
) {
$block_data[ $block_name ] = array(
'selector' => $block_type->supports['__experimentalSelector'],
'supports' => $supports,
'blockName' => $block_name,
);
} elseif (
isset( $block_type->supports['__experimentalSelector'] ) &&
is_array( $block_type->supports['__experimentalSelector'] )
) {
foreach ( $block_type->supports['__experimentalSelector'] as $key => $selector ) {
$block_data[ $key ] = array(
'selector' => $selector,
'supports' => $supports,
'blockName' => $block_name,
);
}
} else {
$block_data[ $block_name ] = array(
'selector' => '.wp-block-' . str_replace( '/', '-', str_replace( 'core/', '', $block_name ) ),
'supports' => $supports,
'blockName' => $block_name,
);
}
}

return $block_data;
}

/**
* Given a tree that adheres to the theme.json schema
* it adds the block data (selector, support) to each context.
*
* @param array $tree Tree to augment with block data.
*
* @return array Tree with block data.
*/
function gutenberg_experimental_global_styles_augment_with_block_data( $tree ) {
$block_data = gutenberg_experimental_global_styles_get_block_data();
foreach ( array_keys( $tree ) as $block_name ) {
if (
! array_key_exists( $block_name, $block_data ) ||
! array_key_exists( 'selector', $block_data[ $block_name ] ) ||
! array_key_exists( 'supports', $block_data[ $block_name ] )
) {
// Skip blocks that haven't declared support,
// because we don't know to process them.
continue;
}

$tree[ $block_name ]['selector'] = $block_data[ $block_name ]['selector'];
$tree[ $block_name ]['supports'] = $block_data[ $block_name ]['supports'];
}

return $tree;
}

/**
* Takes a tree adhering to the theme.json schema and generates
* the corresponding stylesheet.
Expand Down Expand Up @@ -605,7 +451,7 @@ function_exists( 'gutenberg_is_edit_site_page' ) &&
gutenberg_experimental_global_styles_has_theme_json_support()
) {
$settings['__experimentalGlobalStylesUserEntityId'] = gutenberg_experimental_global_styles_get_user_cpt_id();
$settings['__experimentalGlobalStylesContexts'] = gutenberg_experimental_global_styles_get_block_data();
$settings['__experimentalGlobalStylesContexts'] = $base->get_blocks_metadata();
$settings['__experimentalGlobalStylesBaseStyles'] = $base->get_raw_data();
} else {
// STEP 3 - OTHERWISE, ADD STYLES
Expand Down