WP_Theme_JSON_Gutenberg Unit tests: fix phpunit warnings about set_spacing_sizes

[matiasbenedetto]

What?

WP_Theme_JSON_Gutenberg unit tests: fix phpunit warnings about set_spacing_sizes().

Why?

To avoid the warnings on the console:

There were 5 warnings:

1) WP_Theme_JSON_Gutenberg_Test::test_set_spacing_sizes_when_invalid with data set "invalid_spacing_scale_values_missing_operator" (array('', 1.5, 1, 4, 'rem'), null)
Expecting E_STRICT, E_NOTICE, and E_USER_NOTICE is deprecated and will no longer be possible in PHPUnit 10.

2) WP_Theme_JSON_Gutenberg_Test::test_set_spacing_sizes_when_invalid with data set "invalid_spacing_scale_values_non_numeric_increment" (array('+', 'add two to previous value', 1, 4, 'rem'), null)
Expecting E_STRICT, E_NOTICE, and E_USER_NOTICE is deprecated and will no longer be possible in PHPUnit 10.

3) WP_Theme_JSON_Gutenberg_Test::test_set_spacing_sizes_when_invalid with data set "invalid_spacing_scale_values_non_numeric_steps" (array('+', 1.5, 'spiral staircase preferred', 4, 'rem'), null)
Expecting E_STRICT, E_NOTICE, and E_USER_NOTICE is deprecated and will no longer be possible in PHPUnit 10.

4) WP_Theme_JSON_Gutenberg_Test::test_set_spacing_sizes_when_invalid with data set "invalid_spacing_scale_values_non_numeric_medium_step" (array('+', 1.5, 5, 'That which is just right', 'rem'), null)
Expecting E_STRICT, E_NOTICE, and E_USER_NOTICE is deprecated and will no longer be possible in PHPUnit 10.

5) WP_Theme_JSON_Gutenberg_Test::test_set_spacing_sizes_when_invalid with data set "invalid_spacing_scale_values_missing_unit" (array('+', 1.5, 5, 4), null)
Expecting E_STRICT, E_NOTICE, and E_USER_NOTICE is deprecated and will no longer be possible in PHPUnit 10.

How?

using core function _doing_it_wrong() to throw the notice and using setExpectedIncorrectUsage to assert the incorrect usage notice.

Testing Instructions

Run PHP unit tests with and without this change.
You should not see the warning running this PR.

[github-actions]

This pull request has changed or added PHP files. Please confirm whether these changes need to be synced to WordPress Core, and therefore featured in the next release of WordPress.

If so, it is recommended to create a new Trac ticket and submit a pull request to the WordPress Core Github repository soon after this pull request is merged.

If you're unsure, you can always ask for help in the #core-editor channel in WordPress Slack.

Thank you! ❤️

View changed files

❔ lib/class-wp-theme-json-gutenberg.php
❔ phpunit/class-wp-theme-json-test.php

[glendaviesnz]

LGTM - thanks for fixing this.

[anton-vlasenko]

This code is in Core, so I wonder how changing trigger_error() to _doing_it_wrong() could affect backward compatibility, @matiasbenedetto.

[matiasbenedetto]

Thanks @glendaviesnz and @anton-vlasenko for the review.

This code is in Core, so I wonder how changing trigger_error() to _doing_it_wrong() could affect backward compatibility.

I think this is not in core because this is the Gutenberg version of this class (WP_Theme_JSON_Gutenberg). Apart from that _doing_it_wrong() function is just calling trigger_error() as the line this PR replaces, just in a standardized way:

https://github.com/WordPress/wordpress-develop/blob/781953641607c4d5b0743a6924af0e820fd54871/src/wp-includes/functions.php#L5860-L5928

So I think there won't be disruptions.

[anton-vlasenko]

I've explained why replacing trigger_error() with _doing_it_wrong() could be an issue here: #55354.
I would appreciate your review, @matiasbenedetto.

[getdave]

Confirming this code is not in Core

https://github.com/WordPress/wordpress-develop/blob/5bd13e7cc1a2f7b649c1b97e3ada88b8950ed2b6/src/wp-includes/class-wp-theme-json.php#L3400-L3409

[getdave]

But I can also see that Gutnberg trunk does not contain this change

gutenberg/lib/class-wp-theme-json-gutenberg.php

Lines 3516 to 3518 in fb71e4b

	if ( ! empty( $spacing_scale ) ) {
	trigger_error( __( 'Some of the theme.json settings.spacing.spacingScale values are invalid', 'gutenberg' ), E_USER_NOTICE );
	}

[getdave]

I appears this change was reverted in #55354

[getdave]

...and phpunit changes were commit as part of WordPress/wordpress-develop#5911

[getdave]

✅ I updated the PHP Sync Tracking Issue for WP 6.5 to note this PR does not require a backport for WP 6.5.

Why? Because related changes were backported in #55313 instead.

cc @matiasbenedetto and @anton-vlasenko for 👍