Skip to content

Commit 1e59354

Browse files
dmsnelldmsnell
committed
Introduce WP_Block_Processor class.
1 parent 1ebc4c5 commit 1e59354

3 files changed

Lines changed: 231 additions & 0 deletions

File tree

‎src/wp-includes/class-wp-block-processor.php‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
<?php
2+
3+
/**
4+
* @todo Benchmark extracting blocks against {@link \parse_blocks()}.
5+
*/
6+
class WP_Block_Processor extends WP_Block_Scanner {
7+
private $open_blocks = array();
8+
9+
private $was_void = false;
10+
11+
public static function create( $html ) {
12+
return new self( $html );
13+
}
14+
15+
public function next_delimiter( $block_type = null, $html_spans = 'skip-html' ) {
16+
if ( $this->was_void ) {
17+
array_pop( $this->open_blocks );
18+
$this->was_void = false;
19+
}
20+
21+
if ( false === parent::next_delimiter( null, $html_spans ) ) {
22+
return false;
23+
}
24+
25+
$block_type = $this->get_block_type();
26+
27+
switch ( $this->get_delimiter_type() ) {
28+
case parent::OPENER:
29+
$this->open_blocks[] = $block_type;
30+
break;
31+
32+
case parent::CLOSER:
33+
$closed_block = array_pop( $this->open_blocks );
34+
if ( $block_type !== $closed_block ) {
35+
throw new Error( 'Tried to close a block of another type.' );
36+
}
37+
break;
38+
39+
case parent::VOID:
40+
$this->open_blocks[] = $block_type;
41+
$this->was_void = true;
42+
break;
43+
}
44+
45+
if ( isset( $block_type ) && ! $this->is_block_type( $block_type ) ) {
46+
return $this->next_delimiter( $block_type, $html_spans );
47+
}
48+
49+
return true;
50+
}
51+
52+
public function get_breadcrumbs() {
53+
return $this->open_blocks;
54+
}
55+
56+
/**
57+
* Returns the depth of the open blocks where the processor is currently matched.
58+
*
59+
* Depth increases before visiting openers and void blocks,
60+
* and decreases before visiting closers.
61+
* @return int|null
62+
*/
63+
public function get_depth() {
64+
return count( $this->open_blocks );
65+
}
66+
67+
/**
68+
* Extracts a block object starting at a matched block delimiter opener.
69+
*
70+
* @todo Use iteration instead of recursion, or at least refactor to tail-call form.
71+
*
72+
* @return array|null
73+
*/
74+
public function extract_block() {
75+
if ( parent::MATCHED !== $this->state || ! $this->opens_block() ) {
76+
return null;
77+
}
78+
79+
$block = array(
80+
'blockName' => $this->get_block_type(),
81+
'attrs' => $this->allocate_and_return_parsed_attributes() ?? array(),
82+
'innerHTML' => '',
83+
'innerBlocks' => array(),
84+
'innerContent' => array(),
85+
);
86+
87+
$depth = $this->get_depth();
88+
$child_depth = $depth + 1;
89+
while ( $this->next_delimiter( null, 'visit-html' ) && $this->get_depth() > $depth ) {
90+
if ( $this->get_depth() === $child_depth && $this->opens_block( 'core/freeform' ) ) {
91+
$chunk = $this->get_html_content_and_advance();
92+
$block['innerHTML'] .= $chunk;
93+
94+
$last_chunk = count( $block['innerContent'] ) - 1;
95+
if ( isset( $block['innerContent'][ $last_chunk ] ) ) {
96+
$block['innerContent'][ count( $block['innerContent'] ) - 1 ] = $chunk;
97+
} else {
98+
$block['innerContent'][] = $chunk;
99+
}
100+
101+
continue;
102+
}
103+
104+
/**
105+
* Inner blocks.
106+
*
107+
* @todo This is a decent place to call {@link \render_block()}
108+
*/
109+
if ( $this->opens_block() ) {
110+
$inner_block = $this->extract_block();
111+
$block['innerBlocks'][] = $inner_block;
112+
$block['innerContent'][] = null;
113+
}
114+
}
115+
116+
if ( empty( $block['innerBlocks'] ) ) {
117+
unset( $block['innerBlocks'] );
118+
}
119+
120+
return $block;
121+
}
122+
}

‎src/wp-settings.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,7 @@
266266
require ABSPATH . WPINC . '/html-api/class-wp-html-stack-event.php';
267267
require ABSPATH . WPINC . '/html-api/class-wp-html-processor-state.php';
268268
require ABSPATH . WPINC . '/html-api/class-wp-html-processor.php';
269+
require ABSPATH . WPINC . '/class-wp-block-processor.php';
269270
require ABSPATH . WPINC . '/class-wp-http.php';
270271
require ABSPATH . WPINC . '/class-wp-http-streams.php';
271272
require ABSPATH . WPINC . '/class-wp-http-curl.php';

‎tests/phpunit/tests/block-scanner/wpBlockProcessor.php‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
<?php
2+
3+
/**
4+
* Unit tests covering WP_Block_Processor functionality.
5+
*
6+
* @package WordPress
7+
* @subpackage HTML-API
8+
*
9+
* @since {WP_VERSION}
10+
*
11+
* @group block-scanner
12+
*
13+
* @coversDefaultClass WP_Block_Processor
14+
*/
15+
class Tests_Blocks_BlockScanner_WP_Block_Processor extends WP_UnitTestCase {
16+
public function test_creates_class_instance() {
17+
$processor = WP_Block_Processor::create( '' );
18+
19+
$this->assertInstanceOf( 'WP_Block_Processor', $processor );
20+
}
21+
22+
public function test_get_breadcrumbs() {
23+
$processor = WP_Block_Processor::create( '<!-- wp:top --><!-- wp:inside /--><!-- /wp:top -->' );
24+
25+
$this->assertTrue(
26+
$processor->next_delimiter(),
27+
'Should have found the opening "top" delimiter but found nothing.'
28+
);
29+
30+
$this->assertSame(
31+
array( 'core/top' ),
32+
$processor->get_breadcrumbs(),
33+
'Should have found only the single opening delimiter.'
34+
);
35+
36+
$processor->next_delimiter();
37+
$this->assertSame(
38+
array( 'core/top', 'core/inside' ),
39+
$processor->get_breadcrumbs(),
40+
'Should have detected the nesting structure of the blocks.'
41+
);
42+
}
43+
44+
public function test_get_depth() {
45+
// Create a deeply-nested stack of blocks.
46+
$html = '';
47+
$max_depth = 10;
48+
49+
for ( $i = 0; $i < $max_depth; $i++ ) {
50+
$html .= "<!-- wp:ladder {\"level\":{$i}} -->\n";
51+
}
52+
53+
for ( $i = 0; $i < $max_depth; $i++ ) {
54+
$html .= "<!-- /wp:ladder -->\n";
55+
}
56+
57+
$processor = WP_Block_Processor::create( $html );
58+
$n = new NumberFormatter( 'en-US', NumberFormatter::ORDINAL );
59+
60+
for ( $i = 0; $i < $max_depth; $i++ ) {
61+
$this->assertTrue(
62+
$processor->next_delimiter(),
63+
"Should have found {$n->format( $i + 1 )} opening delimiter: check test setup."
64+
);
65+
66+
$this->assertSame(
67+
$i + 1,
68+
$processor->get_depth(),
69+
"Should have identified the proper depth of the {$n->format( $i + 1 )} opening delimiter."
70+
);
71+
}
72+
73+
for ( $i = 0; $i < $max_depth; $i++ ) {
74+
$this->assertTrue(
75+
$processor->next_delimiter(),
76+
"Should have found {$n->format( $i + 1 )} closing delimiter: check test setup."
77+
);
78+
79+
$this->assertSame(
80+
$max_depth - $i - 1,
81+
$processor->get_depth(),
82+
"Should have identified the proper depth of the {$n->format( $i + 1 )} closing delimiter."
83+
);
84+
}
85+
}
86+
87+
public function test_builds_block() {
88+
$cover_block = [ 'blockName' => 'core/cover', 'attrs' => [], 'innerHTML' => '<img>', 'innerContent' => [ '<img>' ] ];
89+
$heading_block = [ 'blockName' => 'core/heading', 'attrs' => [ 'level' => 2 ], 'innerHTML' => '<h2>Testing works!</h2>', 'innerContent' => [ '<h2>Testing works!</h2>' ] ];
90+
$paragraph_block = [ 'blockName' => 'core/paragraph', 'attrs' => [], 'innerHTML' => '<p>Who knew?</p>', 'innerContent' => [ '<p>Who knew?</p>' ] ];
91+
$group_block = [ 'blockName' => 'core/group', 'attrs' => [], 'innerHTML' => '', 'innerBlocks' => [ $heading_block, $paragraph_block ], 'innerContent' => [ null, null ] ];
92+
$blocks = [ $cover_block, $group_block ];
93+
$html = serialize_blocks( $blocks );
94+
95+
$processor = WP_Block_Processor::create( $html );
96+
97+
$extracted = array();
98+
while ( $processor->next_delimiter() ) {
99+
$extracted[] = $processor->extract_block();
100+
}
101+
102+
$this->assertSame(
103+
$blocks,
104+
$extracted,
105+
'Should have extracted a block matching the input group block.'
106+
);
107+
}
108+
}

0 commit comments

Comments
 (0)