<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[56761] trunk/tests/phpunit/tests/blocks: Tests: Rename and improve the `blocks/context.php` file to follow handbook</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/56761">56761</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/56761","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>gziolo</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-10-03 08:52:54 +0000 (Tue, 03 Oct 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Tests: Rename and improve the `blocks/context.php` file to follow handbook
Renames `context.php` and `Tests_Blocks_Context` to `renderBlock.php` and `Tests_Blocks_RenderBlock`. See https://make.wordpress.org/core/handbook/testing/automated-testing/writing-phpunit-tests/#test-classes.
Simplifies also the tear_down method by using the same convention as in <a href="https://core.trac.wordpress.org/changeset/56759">[56759]</a>.
Props costdev, ockham.
Follow-up <a href="https://core.trac.wordpress.org/changeset/48224">[48224]</a>.
See <a href="https://core.trac.wordpress.org/ticket/49927">#49927</a>.</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsblocksrenderBlockphp">trunk/tests/phpunit/tests/blocks/renderBlock.php</a></li>
</ul>
<h3>Removed Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsblockscontextphp">trunk/tests/phpunit/tests/blocks/context.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsblockscontextphp"></a>
<div class="delfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Deleted: trunk/tests/phpunit/tests/blocks/context.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/context.php 2023-10-03 08:34:36 UTC (rev 56760)
+++ trunk/tests/phpunit/tests/blocks/context.php 2023-10-03 08:52:54 UTC (rev 56761)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,208 +0,0 @@
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-<?php
-/**
- * Tests for block context functions.
- *
- * @package WordPress
- * @subpackage Blocks
- * @since 5.5.0
- *
- * @group blocks
- */
-class Tests_Blocks_Context extends WP_UnitTestCase {
-
- /**
- * Registered block names.
- *
- * @var string[]
- */
- private $registered_block_names = array();
-
- /**
- * Sets up each test method.
- */
- public function set_up() {
- global $post;
-
- parent::set_up();
-
- $args = array(
- 'post_content' => 'example',
- 'post_excerpt' => '',
- );
-
- $post = self::factory()->post->create_and_get( $args );
- setup_postdata( $post );
- }
-
- /**
- * Tear down each test method.
- */
- public function tear_down() {
- while ( ! empty( $this->registered_block_names ) ) {
- $block_name = array_pop( $this->registered_block_names );
- unregister_block_type( $block_name );
- }
-
- parent::tear_down();
- }
-
- /**
- * Registers a block type.
- *
- * @param string|WP_Block_Type $name Block type name including namespace, or alternatively a
- * complete WP_Block_Type instance. In case a WP_Block_Type
- * is provided, the $args parameter will be ignored.
- * @param array $args {
- * Optional. Array of block type arguments. Any arguments may be defined, however the
- * ones described below are supported by default. Default empty array.
- *
- * @type callable $render_callback Callback used to render blocks of this block type.
- * }
- */
- protected function register_block_type( $name, $args ) {
- register_block_type( $name, $args );
-
- $this->registered_block_names[] = $name;
- }
-
- /**
- * Tests that a block which provides context makes that context available to
- * its inner blocks.
- *
- * @ticket 49927
- */
- public function test_provides_block_context() {
- $provided_context = array();
-
- $this->register_block_type(
- 'gutenberg/test-context-provider',
- array(
- 'attributes' => array(
- 'contextWithAssigned' => array(
- 'type' => 'number',
- ),
- 'contextWithDefault' => array(
- 'type' => 'number',
- 'default' => 0,
- ),
- 'contextWithoutDefault' => array(
- 'type' => 'number',
- ),
- 'contextNotRequested' => array(
- 'type' => 'number',
- ),
- ),
- 'provides_context' => array(
- 'gutenberg/contextWithAssigned' => 'contextWithAssigned',
- 'gutenberg/contextWithDefault' => 'contextWithDefault',
- 'gutenberg/contextWithoutDefault' => 'contextWithoutDefault',
- 'gutenberg/contextNotRequested' => 'contextNotRequested',
- ),
- )
- );
-
- $this->register_block_type(
- 'gutenberg/test-context-consumer',
- array(
- 'uses_context' => array(
- 'gutenberg/contextWithDefault',
- 'gutenberg/contextWithAssigned',
- 'gutenberg/contextWithoutDefault',
- ),
- 'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
- $provided_context[] = $block->context;
-
- return '';
- },
- )
- );
-
- $parsed_blocks = parse_blocks(
- '<!-- wp:gutenberg/test-context-provider {"contextWithAssigned":10} -->' .
- '<!-- wp:gutenberg/test-context-consumer /-->' .
- '<!-- /wp:gutenberg/test-context-provider -->'
- );
-
- render_block( $parsed_blocks[0] );
-
- $this->assertSame(
- array(
- 'gutenberg/contextWithDefault' => 0,
- 'gutenberg/contextWithAssigned' => 10,
- ),
- $provided_context[0]
- );
- }
-
- /**
- * Tests that a block can receive default-provided context through
- * render_block.
- *
- * @ticket 49927
- */
- public function test_provides_default_context() {
- global $post;
-
- $provided_context = array();
-
- $this->register_block_type(
- 'gutenberg/test-context-consumer',
- array(
- 'uses_context' => array( 'postId', 'postType' ),
- 'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
- $provided_context[] = $block->context;
-
- return '';
- },
- )
- );
-
- $parsed_blocks = parse_blocks( '<!-- wp:gutenberg/test-context-consumer /-->' );
-
- render_block( $parsed_blocks[0] );
-
- $this->assertSame(
- array(
- 'postId' => $post->ID,
- 'postType' => $post->post_type,
- ),
- $provided_context[0]
- );
- }
-
- /**
- * Tests that default block context can be filtered.
- *
- * @ticket 49927
- */
- public function test_default_context_is_filterable() {
- $provided_context = array();
-
- $this->register_block_type(
- 'gutenberg/test-context-consumer',
- array(
- 'uses_context' => array( 'example' ),
- 'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
- $provided_context[] = $block->context;
-
- return '';
- },
- )
- );
-
- $filter_block_context = static function ( $context ) {
- $context['example'] = 'ok';
- return $context;
- };
-
- $parsed_blocks = parse_blocks( '<!-- wp:gutenberg/test-context-consumer /-->' );
-
- add_filter( 'render_block_context', $filter_block_context );
-
- render_block( $parsed_blocks[0] );
-
- remove_filter( 'render_block_context', $filter_block_context );
-
- $this->assertSame( array( 'example' => 'ok' ), $provided_context[0] );
- }
-}
</del></span></pre></div>
<a id="trunktestsphpunittestsblocksrenderBlockphpfromrev56760trunktestsphpunittestsblockscontextphp"></a>
<div class="copfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Copied: trunk/tests/phpunit/tests/blocks/renderBlock.php (from rev 56760, trunk/tests/phpunit/tests/blocks/context.php)</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/renderBlock.php (rev 0)
+++ trunk/tests/phpunit/tests/blocks/renderBlock.php 2023-10-03 08:52:54 UTC (rev 56761)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,195 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Tests for render block functions.
+ *
+ * @package WordPress
+ * @subpackage Blocks
+ * @since 5.5.0
+ *
+ * @group blocks
+ */
+class Tests_Blocks_RenderBlock extends WP_UnitTestCase {
+
+ /**
+ * Sets up each test method.
+ */
+ public function set_up() {
+ global $post;
+
+ parent::set_up();
+
+ $args = array(
+ 'post_content' => 'example',
+ 'post_excerpt' => '',
+ );
+
+ $post = self::factory()->post->create_and_get( $args );
+ setup_postdata( $post );
+ }
+
+ /**
+ * Tear down each test method.
+ */
+ public function tear_down() {
+ // Removes test block types registered by test cases.
+ $block_types = WP_Block_Type_Registry::get_instance()->get_all_registered();
+ foreach ( $block_types as $block_type ) {
+ $block_name = $block_type->name;
+ if ( str_starts_with( $block_name, 'tests/' ) ) {
+ unregister_block_type( $block_name );
+ }
+ }
+
+ parent::tear_down();
+ }
+
+ /**
+ * Tests that a block which provides context makes that context available to
+ * its inner blocks.
+ *
+ * @ticket 49927
+ *
+ * @covers ::register_block_type
+ * @covers ::render_block
+ */
+ public function test_provides_block_context() {
+ $provided_context = array();
+
+ register_block_type(
+ 'tests/context-provider',
+ array(
+ 'attributes' => array(
+ 'contextWithAssigned' => array(
+ 'type' => 'number',
+ ),
+ 'contextWithDefault' => array(
+ 'type' => 'number',
+ 'default' => 0,
+ ),
+ 'contextWithoutDefault' => array(
+ 'type' => 'number',
+ ),
+ 'contextNotRequested' => array(
+ 'type' => 'number',
+ ),
+ ),
+ 'provides_context' => array(
+ 'tests/contextWithAssigned' => 'contextWithAssigned',
+ 'tests/contextWithDefault' => 'contextWithDefault',
+ 'tests/contextWithoutDefault' => 'contextWithoutDefault',
+ 'tests/contextNotRequested' => 'contextNotRequested',
+ ),
+ )
+ );
+
+ register_block_type(
+ 'tests/context-consumer',
+ array(
+ 'uses_context' => array(
+ 'tests/contextWithDefault',
+ 'tests/contextWithAssigned',
+ 'tests/contextWithoutDefault',
+ ),
+ 'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
+ $provided_context[] = $block->context;
+
+ return '';
+ },
+ )
+ );
+
+ $parsed_blocks = parse_blocks(
+ '<!-- wp:tests/context-provider {"contextWithAssigned":10} -->' .
+ '<!-- wp:tests/context-consumer /-->' .
+ '<!-- /wp:tests/context-provider -->'
+ );
+
+ render_block( $parsed_blocks[0] );
+
+ $this->assertSame(
+ array(
+ 'tests/contextWithDefault' => 0,
+ 'tests/contextWithAssigned' => 10,
+ ),
+ $provided_context[0]
+ );
+ }
+
+ /**
+ * Tests that a block can receive default-provided context through
+ * render_block.
+ *
+ * @ticket 49927
+ *
+ * @covers ::register_block_type
+ * @covers ::render_block
+ */
+ public function test_provides_default_context() {
+ global $post;
+
+ $provided_context = array();
+
+ register_block_type(
+ 'tests/context-consumer',
+ array(
+ 'uses_context' => array( 'postId', 'postType' ),
+ 'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
+ $provided_context[] = $block->context;
+
+ return '';
+ },
+ )
+ );
+
+ $parsed_blocks = parse_blocks( '<!-- wp:tests/context-consumer /-->' );
+
+ render_block( $parsed_blocks[0] );
+
+ $this->assertSame(
+ array(
+ 'postId' => $post->ID,
+ 'postType' => $post->post_type,
+ ),
+ $provided_context[0]
+ );
+ }
+
+ /**
+ * Tests that default block context can be filtered.
+ *
+ * @ticket 49927
+ *
+ * @covers ::register_block_type
+ * @covers ::render_block
+ */
+ public function test_default_context_is_filterable() {
+ $provided_context = array();
+
+ register_block_type(
+ 'tests/context-consumer',
+ array(
+ 'uses_context' => array( 'example' ),
+ 'render_callback' => static function ( $attributes, $content, $block ) use ( &$provided_context ) {
+ $provided_context[] = $block->context;
+
+ return '';
+ },
+ )
+ );
+
+ $filter_block_context = static function ( $context ) {
+ $context['example'] = 'ok';
+ return $context;
+ };
+
+ $parsed_blocks = parse_blocks( '<!-- wp:tests/context-consumer /-->' );
+
+ add_filter( 'render_block_context', $filter_block_context );
+
+ render_block( $parsed_blocks[0] );
+
+ remove_filter( 'render_block_context', $filter_block_context );
+
+ $this->assertSame( array( 'example' => 'ok' ), $provided_context[0] );
+ }
+}
</ins></span></pre>
</div>
</div>
</body>
</html>