haiku-atelier-2024/web/vendor/htmlburger/carbon-fields/tests/unit-tests/Container/ContainerTest.php
2024-08-13 15:29:18 +02:00

278 lines
No EOL
11 KiB
PHP

<?php
use Mockery as M;
use Carbon_Fields\Pimple\Container as PimpleContainer;
use Carbon_Fields\Container\Container;
use Carbon_Fields\Container\Repository as ContainerRepository;
use Carbon_Fields\Toolset\Key_Toolset;
use Carbon_Fields\Container\Condition\Factory as ConditionFactory;
use Carbon_Fields\Exception\Incorrect_Syntax_Exception;
/**
* @group container
* @coversDefaultClass Carbon_Fields\Container\Container
*/
class ContainerTest extends WP_UnitTestCase {
public $containerId;
public $containerTitle;
public $containerType;
public $containerTypeUpperCase;
public $containerTypeSpaced;
public $containerTypeInvalid;
public $containerTypeClass;
public $containerTypeDatastoreClass;
public $containerTypeBrokenClass;
public $containerConditionFulfillableCollection;
public $containerConditionTranslatorJson;
public function setUp(): void {
$ioc = new PimpleContainer();
$ioc['container_repository'] = function( $ioc ) {
return new ContainerRepository();
};
$ioc['key_toolset'] = function( $ioc ) {
return new Key_Toolset();
};
$ioc['container_condition_factory'] = function( $ioc ) {
return new ConditionFactory( $ioc['container_conditions'] );
};
$ioc['container_condition_translator_array'] = function( $ioc ) {
return new \Carbon_Fields\Container\Fulfillable\Translator\Array_Translator( $ioc['container_condition_factory'] );
};
$ioc['container_condition_translator_json'] = function( $ioc ) {
return new \Carbon_Fields\Container\Fulfillable\Translator\Json_Translator( $ioc['container_condition_factory'] );
};
$ioc['container_condition_fulfillable_collection'] = $ioc->factory( function( $ioc ) {
return M::mock( 'Carbon_Fields\\Container\\Fulfillable\\Fulfillable_Collection' )->shouldIgnoreMissing();
} );
$ioc['container_conditions'] = function() {
return new PimpleContainer();
};
\Carbon_Fields\Carbon_Fields::instance()->install( $ioc );
$this->containerId = 'PageSettings';
$this->containerTitle = 'Page Settings';
$this->containerType = 'post_meta';
$this->containerTypeUpperCase = 'Post_Meta';
$this->containerTypeSpaced = 'Post Meta';
$this->containerTypeInvalid = '__no_such_container_type__';
$this->containerTypeClass = 'Carbon_Fields\Container\Post_Meta_Container';
$this->containerTypeDatastoreClass = 'Carbon_Fields\Datastore\Post_Meta_Datastore';
$this->containerTypeBrokenClass = 'Carbon_Fields\Container\Broken_Container';
$this->containerConditionFulfillableCollection = $ioc['container_condition_fulfillable_collection'];
$this->containerConditionTranslatorJson = $ioc['container_condition_translator_json'];
}
public function tearDown(): void {
\Carbon_Fields\Carbon_Fields::instance()->install( new PimpleContainer() );
}
/**
* @covers ::make
* @covers ::factory
*/
public function testMakePostMetaContainer() {
$container = Container::factory( $this->containerType, $this->containerTitle );
$this->assertEquals( $this->containerTitle, $container->title );
}
/**
* @covers ::make
* @covers ::factory
*
* @expectedException Carbon_Fields\Exception\Incorrect_Syntax_Exception
* @expectedExceptionMessage Unknown container "".
*/
public function testExceptionIsThrownWhenContainerTypeIsEmpty() {
$container = Container::factory( '', $this->containerTitle );
}
/**
* @covers ::make
* @covers ::factory
*
* @expectedException Carbon_Fields\Exception\Incorrect_Syntax_Exception
* @expectedExceptionMessage Unknown container "__no_such_container_type__".
*/
public function testExceptionIsThrownWhenContainerTypeIsInvalid() {
$container = Container::factory( $this->containerTypeInvalid, $this->containerTitle );
}
/**
* @covers ::make
* @covers ::factory
*/
public function testBrokenContainerIsReturnedWhenDebugIsDisabledAndContainerIsInvalid() {
$old_val = Incorrect_Syntax_Exception::$throw_errors;
Incorrect_Syntax_Exception::$throw_errors = false;
$container = Container::factory( $this->containerTypeInvalid, $this->containerTitle );
$this->assertInstanceOf( $this->containerTypeBrokenClass, $container );
Incorrect_Syntax_Exception::$throw_errors = $old_val;
}
/**
* @covers ::make
* @covers ::factory
*/
public function testContainerTypeCaseIsIgnored() {
$container = Container::factory( $this->containerTypeUpperCase, $this->containerTitle );
$this->assertInstanceOf( $this->containerTypeClass, $container );
}
/**
* @covers ::make
* @covers ::factory
*/
public function testSpacesInContainerTypeAreSupported() {
$container = Container::factory( $this->containerTypeSpaced, $this->containerTitle );
$this->assertTrue(true); // no exception should be thrown
}
/**
* @covers ::make
* @covers ::factory
*/
public function testSameContainerNamesDoNotGenerateIdenticalIds() {
$container1 = Container::factory( $this->containerType, $this->containerTitle );
$container2 = Container::factory( $this->containerType, $this->containerTitle );
$this->assertNotEquals( $container1->get_id(), $container2->get_id() );
}
/**
* @covers ::make
* @covers ::factory
*/
public function testSameContainerNameAddsNumericalSuffix() {
$container1 = Container::factory( $this->containerType, $this->containerTitle );
$container2 = Container::factory( $this->containerType, $this->containerTitle );
$this->assertEquals( $container1->get_id() . '1', $container2->get_id() );
}
/**
* @covers ::__construct
*
* @expectedException Carbon_Fields\Exception\Incorrect_Syntax_Exception
* @expectedExceptionMessage Empty container title is not supported
*/
public function testExceptionIsThrownWhenContainerTitleIsEmpty() {
$container = new $this->containerTypeClass( $this->containerId, '', $this->containerType, $this->containerConditionFulfillableCollection, $this->containerConditionTranslatorJson );
}
/**
* @covers ::__construct
*/
public function testNonAsciiContainerTitlesAreHandledProperly() {
// This text includes a capital cyrillic letter ... it actually assures that
// container titles in non-english are converted to lowercase
$container = new $this->containerTypeClass( $this->containerId, 'bulgarian: България', $this->containerType, $this->containerConditionFulfillableCollection, $this->containerConditionTranslatorJson );
$this->assertEquals( 'bulgarian: България', $container->title );
}
/**
* @covers ::set_datastore
* @covers ::get_datastore
* @covers ::has_default_datastore
*/
public function testSetDatastore_Default_ReturnDefault() {
$datastore = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$container = new $this->containerTypeClass( $this->containerId, $this->containerTitle, $this->containerType, $this->containerConditionFulfillableCollection, $this->containerConditionTranslatorJson );
$this->assertEquals( true, $container->has_default_datastore() );
$this->assertInstanceOf( $this->containerTypeDatastoreClass, $container->get_datastore() );
$container->set_datastore( $datastore, true );
$this->assertEquals( true, $container->has_default_datastore() );
$this->assertEquals( $datastore, $container->get_datastore() );
}
/**
* @covers ::set_datastore
* @covers ::get_datastore
* @covers ::has_default_datastore
*/
public function testSetDatastore_DefaultDefault2_ReturnDefault2() {
$datastore1 = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$datastore2 = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$container = new $this->containerTypeClass( $this->containerId, $this->containerTitle, $this->containerType, $this->containerConditionFulfillableCollection, $this->containerConditionTranslatorJson );
$container->set_datastore( $datastore1, true );
$container->set_datastore( $datastore2, true );
$this->assertEquals( $datastore2, $container->get_datastore() );
}
/**
* @covers ::set_datastore
* @covers ::get_datastore
* @covers ::has_default_datastore
*/
public function testSetDatastore_Override_ReturnOverride() {
$datastore = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$container = new $this->containerTypeClass( $this->containerId, $this->containerTitle, $this->containerType, $this->containerConditionFulfillableCollection, $this->containerConditionTranslatorJson );
$container->set_datastore( $datastore, false );
$this->assertEquals( false, $container->has_default_datastore() );
$this->assertEquals( $datastore, $container->get_datastore() );
}
/**
* @covers ::set_datastore
* @covers ::get_datastore
* @covers ::has_default_datastore
*/
public function testSetDatastore_OverrideOverride2_ReturnOverride2() {
$datastore1 = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$datastore2 = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$container = new $this->containerTypeClass( $this->containerId, $this->containerTitle, $this->containerType, $this->containerConditionFulfillableCollection, $this->containerConditionTranslatorJson );
$container->set_datastore( $datastore1, false );
$container->set_datastore( $datastore2, false );
$this->assertEquals( false, $container->has_default_datastore() );
$this->assertEquals( $datastore2, $container->get_datastore() );
}
/**
* @covers ::set_datastore
* @covers ::get_datastore
* @covers ::has_default_datastore
*/
public function testSetDatastore_DefaultOverride_ReturnOverride() {
$default_datastore = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$override_datastore = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$container = new $this->containerTypeClass( $this->containerId, $this->containerTitle, $this->containerType, $this->containerConditionFulfillableCollection, $this->containerConditionTranslatorJson );
$container->set_datastore( $default_datastore, true );
$this->assertEquals( true, $container->has_default_datastore() );
$this->assertEquals( $default_datastore, $container->get_datastore() );
$container->set_datastore( $override_datastore, false );
$this->assertEquals( false, $container->has_default_datastore() );
$this->assertEquals( $override_datastore, $container->get_datastore() );
}
/**
* @covers ::set_datastore
* @covers ::get_datastore
* @covers ::has_default_datastore
*/
public function testSetDatastore_DefaultOverrideDefault2_ReturnOverride() {
$default_datastore = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$override_datastore = M::mock( $this->containerTypeDatastoreClass )->shouldIgnoreMissing();
$container = new $this->containerTypeClass( $this->containerId, $this->containerTitle, $this->containerType, $this->containerConditionFulfillableCollection, $this->containerConditionTranslatorJson );
$container->set_datastore( $default_datastore, true );
$container->set_datastore( $override_datastore, false );
$container->set_datastore( $default_datastore, true );
$this->assertEquals( false, $container->has_default_datastore() );
$this->assertEquals( $override_datastore, $container->get_datastore() );
}
}