forked from WordPress/wordpress-develop
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathblock-type.php
More file actions
394 lines (337 loc) · 9.9 KB
/
block-type.php
File metadata and controls
394 lines (337 loc) · 9.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
<?php
/**
* WP_Block_Type Tests
*
* @package WordPress
* @subpackage Blocks
* @since 5.0.0
*/
/**
* Tests for WP_Block_Type
*
* @since 5.0.0
*
* @group blocks
*/
class WP_Test_Block_Type extends WP_UnitTestCase {
/**
* Editor user ID.
*
* @since 5.0.0
* @var int
*/
protected static $editor_user_id;
/**
* ID for a post containing blocks.
*
* @since 5.0.0
* @var int
*/
protected static $post_with_blocks;
/**
* ID for a post without blocks.
*
* @since 5.0.0
* @var int
*/
protected static $post_without_blocks;
/**
* Set up before class.
*
* @since 5.0.0
*/
public static function wpSetUpBeforeClass() {
self::$editor_user_id = self::factory()->user->create(
array(
'role' => 'editor',
)
);
self::$post_with_blocks = self::factory()->post->create(
array(
'post_title' => 'Example',
'post_content' => "<!-- wp:core/text {\"dropCap\":true} -->\n<p class=\"has-drop-cap\">Tester</p>\n<!-- /wp:core/text -->",
)
);
self::$post_without_blocks = self::factory()->post->create(
array(
'post_title' => 'Example',
'post_content' => 'Tester',
)
);
}
/**
* @ticket 45097
*/
public function test_set_props() {
$name = 'core/fake';
$args = array(
'render_callback' => array( $this, 'render_fake_block' ),
'foo' => 'bar',
);
$block_type = new WP_Block_Type( $name, $args );
$this->assertSame( $name, $block_type->name );
$this->assertSame( $args['render_callback'], $block_type->render_callback );
$this->assertSame( $args['foo'], $block_type->foo );
}
/**
* @ticket 45097
*/
public function test_render() {
$attributes = array(
'foo' => 'bar',
'bar' => 'foo',
);
$block_type = new WP_Block_Type(
'core/fake',
array(
'render_callback' => array( $this, 'render_fake_block' ),
)
);
$output = $block_type->render( $attributes );
$this->assertEquals( $attributes, json_decode( $output, true ) );
}
/**
* @ticket 45097
*/
public function test_render_with_content() {
$attributes = array(
'foo' => 'bar',
'bar' => 'foo',
);
$content = 'baz';
$expected = array_merge( $attributes, array( '_content' => $content ) );
$block_type = new WP_Block_Type(
'core/fake',
array(
'render_callback' => array( $this, 'render_fake_block_with_content' ),
)
);
$output = $block_type->render( $attributes, $content );
$this->assertEquals( $expected, json_decode( $output, true ) );
}
/**
* @ticket 45097
*/
public function test_render_for_static_block() {
$block_type = new WP_Block_Type( 'core/fake', array() );
$output = $block_type->render();
$this->assertEquals( '', $output );
}
/**
* @ticket 45097
*/
public function test_is_dynamic_for_static_block() {
$block_type = new WP_Block_Type( 'core/fake', array() );
$this->assertFalse( $block_type->is_dynamic() );
}
/**
* @ticket 45097
*/
public function test_is_dynamic_for_dynamic_block() {
$block_type = new WP_Block_Type(
'core/fake',
array(
'render_callback' => array( $this, 'render_fake_block' ),
)
);
$this->assertTrue( $block_type->is_dynamic() );
}
/**
* @ticket 45097
*/
public function test_prepare_attributes() {
$attributes = array(
'correct' => 'include',
'wrongType' => 5,
'wrongTypeDefaulted' => 5,
/* missingDefaulted */
'undefined' => 'include',
'intendedNull' => null,
);
$block_type = new WP_Block_Type(
'core/fake',
array(
'attributes' => array(
'correct' => array(
'type' => 'string',
),
'wrongType' => array(
'type' => 'string',
),
'wrongTypeDefaulted' => array(
'type' => 'string',
'default' => 'defaulted',
),
'missingDefaulted' => array(
'type' => 'string',
'default' => 'define',
),
'intendedNull' => array(
'type' => array( 'string', 'null' ),
'default' => 'wrong',
),
),
)
);
$prepared_attributes = $block_type->prepare_attributes_for_render( $attributes );
$this->assertEquals(
array(
'correct' => 'include',
/* wrongType */
'wrongTypeDefaulted' => 'defaulted',
'missingDefaulted' => 'define',
'undefined' => 'include',
'intendedNull' => null,
),
$prepared_attributes
);
}
/**
* @ticket 45145
*/
function test_prepare_attributes_none_defined() {
$attributes = array( 'exists' => 'keep' );
$block_type = new WP_Block_Type( 'core/dummy', array() );
$prepared_attributes = $block_type->prepare_attributes_for_render( $attributes );
$this->assertEquals( $attributes, $prepared_attributes );
}
/**
* @ticket 45097
*/
public function test_has_block_with_mixed_content() {
$mixed_post_content = 'before' .
'<!-- wp:core/fake --><!-- /wp:core/fake -->' .
'<!-- wp:core/fake_atts {"value":"b1"} --><!-- /wp:core/fake_atts -->' .
'<!-- wp:core/fake-child -->
<p>testing the test</p>
<!-- /wp:core/fake-child -->' .
'between' .
'<!-- wp:core/self-close-fake /-->' .
'<!-- wp:custom/fake {"value":"b2"} /-->' .
'after';
$this->assertTrue( has_block( 'core/fake', $mixed_post_content ) );
$this->assertTrue( has_block( 'core/fake_atts', $mixed_post_content ) );
$this->assertTrue( has_block( 'core/fake-child', $mixed_post_content ) );
$this->assertTrue( has_block( 'core/self-close-fake', $mixed_post_content ) );
$this->assertTrue( has_block( 'custom/fake', $mixed_post_content ) );
// checking for a partial block name should fail.
$this->assertFalse( has_block( 'core/fak', $mixed_post_content ) );
// checking for a wrong namespace should fail.
$this->assertFalse( has_block( 'custom/fake_atts', $mixed_post_content ) );
// checking for namespace only should not work. Or maybe ... ?
$this->assertFalse( has_block( 'core', $mixed_post_content ) );
}
/**
* @ticket 45097
*/
public function test_has_block_with_invalid_content() {
// some content with invalid HMTL comments and a single valid block.
$invalid_content = 'before' .
'<!- - wp:core/weird-space --><!-- /wp:core/weird-space -->' .
'<!--wp:core/untrimmed-left --><!-- /wp:core/untrimmed -->' .
'<!-- wp:core/fake --><!-- /wp:core/fake -->' .
'<!-- wp:core/untrimmed-right--><!-- /wp:core/untrimmed2 -->' .
'after';
$this->assertFalse( has_block( 'core/text', self::$post_without_blocks ) );
$this->assertFalse( has_block( 'core/weird-space', $invalid_content ) );
$this->assertFalse( has_block( 'core/untrimmed-left', $invalid_content ) );
$this->assertFalse( has_block( 'core/untrimmed-right', $invalid_content ) );
$this->assertTrue( has_block( 'core/fake', $invalid_content ) );
}
/**
* @ticket 45097
*/
public function test_post_has_block() {
// should fail for a non-existent block `custom/fake`.
$this->assertFalse( has_block( 'custom/fake', self::$post_with_blocks ) );
// this functions should not work without the second param until the $post global is set.
$this->assertFalse( has_block( 'core/text' ) );
$this->assertFalse( has_block( 'core/fake' ) );
global $post;
$post = get_post( self::$post_with_blocks );
// check if the function correctly detects content from the $post global.
$this->assertTrue( has_block( 'core/text' ) );
// even if it detects a proper $post global it should still be false for a missing block.
$this->assertFalse( has_block( 'core/fake' ) );
}
public function test_post_has_block_serialized_name() {
$content = '<!-- wp:serialized /--><!-- wp:core/normalized /--><!-- wp:plugin/third-party /-->';
$this->assertTrue( has_block( 'core/serialized', $content ) );
/*
* Technically, `has_block` should receive a "full" (normalized, parsed)
* block name. But this test conforms to expected pre-5.3.1 behavior.
*/
$this->assertTrue( has_block( 'serialized', $content ) );
$this->assertTrue( has_block( 'core/normalized', $content ) );
$this->assertTrue( has_block( 'normalized', $content ) );
$this->assertFalse( has_block( 'plugin/normalized', $content ) );
$this->assertFalse( has_block( 'plugin/serialized', $content ) );
$this->assertFalse( has_block( 'third-party', $content ) );
$this->assertFalse( has_block( 'core/third-party', $content ) );
}
/**
* Renders a test block without content.
*
* @since 5.0.0
*
* @param array $attributes Block attributes. Default empty array.
* @return string JSON encoded list of attributes.
*/
public function render_fake_block( $attributes ) {
return json_encode( $attributes );
}
/**
* Renders a test block with content.
*
* @since 5.0.0
*
* @param array $attributes Block attributes. Default empty array.
* @param string $content Block content. Default empty string.
* @return string JSON encoded list of attributes.
*/
public function render_fake_block_with_content( $attributes, $content ) {
$attributes['_content'] = $content;
return json_encode( $attributes );
}
/**
* Testing the block version.
*
* @ticket 43887
*
* @dataProvider data_block_version
*
* @param string|null $content Content.
* @param int $expected Expected block version.
*/
public function test_block_version( $content, $expected ) {
$this->assertSame( $expected, block_version( $content ) );
}
/**
* Test cases for test_block_version().
*
* @since 5.0.0
*
* @return array {
* @type array {
* @type string|null Content.
* @type int Expected block version.
* }
* }
*/
public function data_block_version() {
return array(
// Null.
array( null, 0 ),
// Empty post content.
array( '', 0 ),
// Post content without blocks.
array( '<hr class="wp-block-separator" />', 0 ),
// Post content with a block.
array( '<!-- wp:core/separator -->', 1 ),
// Post content with a fake block.
array( '<!-- wp:core/fake --><!-- /wp:core/fake -->', 1 ),
// Post content with an invalid block.
array( '<!- - wp:core/separator -->', 0 ),
);
}
}