class-wp-block-list-test.php

<?php
/**
 * Test WP_Block_List class.
 *
 * @package Gutenberg
 */

/**
 * This test file can be removed when plugin support requires WordPress 5.5.0+.
 *
 * @see https://core.trac.wordpress.org/ticket/49926
 * @see https://core.trac.wordpress.org/changeset/48159
 */
class WP_Block_List_Test extends WP_UnitTestCase {

	/**
	 * Fake block type registry.
	 *
	 * @var WP_Block_Type_Registry
	 */
	private $registry = null;

	/**
	 * Set up each test method.
	 */
	public function setUp() {
		parent::setUp();

		$this->registry = new WP_Block_Type_Registry();
		$this->registry->register( 'core/example', array() );
	}

	/**
	 * Tear down each test method.
	 */
	public function tearDown() {
		parent::tearDown();

		$this->registry = null;
	}

	function test_array_access() {
		$parsed_blocks = parse_blocks( '<!-- wp:example /-->' );
		$context       = array();
		$blocks        = new WP_Block_List( $parsed_blocks, $context, $this->registry );

		// Test "offsetExists".
		$this->assertTrue( isset( $blocks[0] ) );

		// Test "offsetGet".
		$this->assertEquals( 'core/example', $blocks[0]->name );

		// Test "offsetSet".
		$parsed_blocks[0]['blockName'] = 'core/updated';
		$blocks[0]                     = new WP_Block( $parsed_blocks[0], $context, $this->registry );
		$this->assertEquals( 'core/updated', $blocks[0]->name );

		// Test "offsetUnset".
		unset( $blocks[0] );
		$this->assertFalse( isset( $blocks[0] ) );
	}

	function test_iterable() {
		$parsed_blocks = parse_blocks( '<!-- wp:example --><!-- wp:example /--><!-- /wp:example -->' );
		$context       = array();
		$blocks        = new WP_Block_List( $parsed_blocks, $context, $this->registry );
		$assertions    = 0;

		foreach ( $blocks as $block ) {
			$this->assertEquals( 'core/example', $block->name );
			$assertions++;
			foreach ( $block->inner_blocks as $inner_block ) {
				$this->assertEquals( 'core/example', $inner_block->name );
				$assertions++;
			}
		}

		$blocks->rewind();
		while ( $blocks->valid() ) {
			$key   = $blocks->key();
			$block = $blocks->current();
			$this->assertEquals( 0, $key );
			$assertions++;
			$this->assertEquals( 'core/example', $block->name );
			$assertions++;
			$blocks->next();
		}

		$this->assertEquals( 4, $assertions );
	}

	function test_countable() {
		$parsed_blocks = parse_blocks( '<!-- wp:example /-->' );
		$context       = array();
		$blocks        = new WP_Block_List( $parsed_blocks, $context, $this->registry );

		$this->assertEquals( 1, count( $blocks ) );
	}

}