# packeta/trunk/tests/Module/WidgetOptionsBuilderTest.php

Packeta, version trunk. 294 lines.

- Page: https://pluginprobe.com/plugins/packeta/trunk/code/tests/Module/WidgetOptionsBuilderTest.php
- Raw: https://pluginprobe.com/plugins/packeta/trunk/raw/tests/Module/WidgetOptionsBuilderTest.php
- Modified: 2025-11-07T08:59:28+00:00

Line numbers below start at 1. Link to a line or a range by appending a fragment to the
page URL, for example `https://pluginprobe.com/plugins/packeta/trunk/code/tests/Module/WidgetOptionsBuilderTest.php#L10-L20`.

```php
<?php

declare( strict_types=1 );

namespace Tests\Module;

use Packetery\Core\Entity\Address;
use Packetery\Core\Entity\Carrier;
use Packetery\Core\Entity\Order;
use Packetery\Core\PickupPointProvider\CompoundCarrierCollectionFactory;
use Packetery\Core\PickupPointProvider\VendorCollectionFactory;
use Packetery\Module\Carrier\OptionPrefixer;
use Packetery\Module\Carrier\PacketaPickupPointsConfig;
use Packetery\Module\Framework\WpAdapter;
use Packetery\Module\WidgetOptionsBuilder;
use PHPUnit\Framework\TestCase;
use Tests\Core\DummyFactory;

class WidgetOptionsBuilderTest extends TestCase {
	/**
	 * @return array[]
	 */
	public static function pickupPointForAdminDataProvider(): array {
		return [
			[
				'order'              => new Order( 'dummyNumber123', DummyFactory::createCarrierZpointcz() ),
				'expectedCountry'    => 'cz',
				'adultContent'       => true,
				'existingKeys'       => [ 'language', 'appIdentity', 'weight', 'livePickupPoint', 'vendors' ],
				'existingVendorKeys' => [ 'selected', 'country', 'group' ],
				'vendorsSize'        => 2,
				'notExistingKeys'    => [ 'carriers' ],
			],
			[
				'order'              => new Order( 'dummyNumber123', DummyFactory::createCarrierZpointcz() ),
				'expectedCountry'    => 'cz',
				'adultContent'       => false,
				'existingKeys'       => [ 'language', 'appIdentity', 'weight', 'vendors' ],
				'existingVendorKeys' => [ 'selected', 'country', 'group' ],
				'vendorsSize'        => 2,
				'notExistingKeys'    => [ 'carriers', 'livePickupPoint' ],
			],
			[
				'order'              => new Order( 'dummyNumber123', DummyFactory::createCarrierCzechHdRequiresSize() ),
				'expectedCountry'    => 'cz',
				'adultContent'       => false,
				'existingKeys'       => [ 'language', 'appIdentity', 'weight', 'vendors' ],
				'existingVendorKeys' => [ 'selected', 'carrierId' ],
				'vendorsSize'        => 1,
				'notExistingKeys'    => [ 'carriers', 'livePickupPoint' ],
			],
			[
				'order'              => new Order( 'dummyNumber123', DummyFactory::createCarrierGermanHd() ),
				'expectedCountry'    => 'de',
				'adultContent'       => false,
				'existingKeys'       => [ 'language', 'appIdentity', 'weight', 'vendors' ],
				'existingVendorKeys' => [ 'selected', 'carrierId' ],
				'vendorsSize'        => 1,
				'notExistingKeys'    => [ 'carriers', 'livePickupPoint' ],
			],
			[
				'order'              => new Order( 'dummyNumber123', DummyFactory::createCarrierGermanHd() ),
				'expectedCountry'    => 'de',
				'adultContent'       => true,
				'existingKeys'       => [ 'language', 'appIdentity', 'weight', 'vendors', 'livePickupPoint' ],
				'existingVendorKeys' => [ 'selected', 'carrierId' ],
				'vendorsSize'        => 1,
				'notExistingKeys'    => [ 'carriers' ],
			],
		];
	}

	/**
	 * @dataProvider pickupPointForAdminDataProvider
	 */
	public function testPickupPointForAdmin(
		Order $order,
		string $expectedCountry,
		bool $adultContent,
		array $existingKeys,
		array $existingVendorKeys,
		int $vendorsSize,
		array $notExistingKeys,
		?string $carriersValueValidator = null
	): void {
		$wpAdapterMock = $this->createMock( WpAdapter::class );

		$config = new PacketaPickupPointsConfig(
			new CompoundCarrierCollectionFactory(),
			new VendorCollectionFactory()
		);

		$builder = new WidgetOptionsBuilder(
			$config,
			$wpAdapterMock
		);

		$order->setShippingCountry( $order->getCarrier()->getCountry() );
		$order->setAdultContent( $adultContent );
		$result = $builder->createPickupPointForAdmin( $order );

		$this->assertSame( $expectedCountry, $result['country'] );
		foreach ( $existingKeys as $key ) {
			$this->assertArrayHasKey( $key, $result );
		}

		foreach ( $notExistingKeys as $key ) {
			$this->assertArrayNotHasKey( $key, $result );
		}

		if ( in_array( 'vendors', $existingKeys, true ) ) {
			$this->assertCount( $vendorsSize, $result['vendors'] );
			foreach ( $result['vendors'] as $vendor ) {
				foreach ( $vendor as $key => $value ) {
					$this->assertContains( $key, $existingVendorKeys );
				}
			}
		} else {
			$this->assertSame( 0, $vendorsSize, 'vendors key does not exist so its size must be 0' );
			$this->assertEmpty( $existingVendorKeys, 'vendors key does not exist so existing keys array must be empty' );
		}

		if ( $carriersValueValidator !== null ) {
			$this->assertTrue(
				call_user_func( $carriersValueValidator, $result['carriers'] ),
				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
				'carriers value "' . var_export( $result['carriers'], true ) . '" do not validate with ' . $carriersValueValidator
			);
		}
	}

	/**
	 * @return array[]
	 */
	public static function addressForAdminDataProvider(): array {
		$alwaysPresentKeys = [ 'country', 'language', 'layout', 'appIdentity', 'street', 'city', 'postcode' ];

		return [
			[
				'order'           => new Order( '123', DummyFactory::createCarrierZpointcz() ),
				'address'         => DummyFactory::createAddress(),
				'expectedKeys'    => $alwaysPresentKeys,
				'nonExistingKeys' => [ 'houseNumber', 'county', 'carrierId' ],
			],
			[
				'order'           => new Order( '123', DummyFactory::createCarrierZpointcz() ),
				'address'         => DummyFactory::createAddress( '123' ),
				'expectedKeys'    => array_merge( $alwaysPresentKeys, [ 'houseNumber' ] ),
				'nonExistingKeys' => [ 'carrierId', 'county' ],
			],
			[
				'order'           => new Order( '123', DummyFactory::createCarrierZpointcz() ),
				'address'         => DummyFactory::createAddress( '123', 'county' ),
				'expectedKeys'    => array_merge( $alwaysPresentKeys, [ 'houseNumber', 'county' ] ),
				'nonExistingKeys' => [ 'carrierId' ],
			],
			[
				'order'           => new Order( '123', DummyFactory::createCarrierCzechHdRequiresSize() ),
				'address'         => DummyFactory::createAddress( '123', 'county' ),
				'expectedKeys'    => array_merge( $alwaysPresentKeys, [ 'houseNumber', 'county', 'carrierId' ] ),
				'nonExistingKeys' => [],
			],
			[
				'order'           => new Order( '123', DummyFactory::createCarrierCzechHdRequiresSize() ),
				'address'         => DummyFactory::createAddress( '123' ),
				'expectedKeys'    => array_merge( $alwaysPresentKeys, [ 'houseNumber', 'carrierId' ] ),
				'nonExistingKeys' => [],
			],
			[
				'order'           => new Order( '123', DummyFactory::createCarrierCzechHdRequiresSize() ),
				'address'         => DummyFactory::createAddress(),
				'expectedKeys'    => array_merge( $alwaysPresentKeys, [ 'carrierId' ] ),
				'nonExistingKeys' => [],
			],
		];
	}

	/**
	 * @dataProvider addressForAdminDataProvider
	 */
	public function testAddressForAdmin(
		Order $order,
		Address $address,
		array $expectedKeys,
		array $nonExistingKeys
	): void {
		$wpAdapterMock = $this->createMock( WpAdapter::class );

		$config = new PacketaPickupPointsConfig(
			new CompoundCarrierCollectionFactory(),
			new VendorCollectionFactory()
		);

		$builder = new WidgetOptionsBuilder(
			$config,
			$wpAdapterMock
		);

		$order->setDeliveryAddress( $address );
		$result = $builder->createAddressForAdmin( $order );

		foreach ( $expectedKeys as $key ) {
			$this->assertArrayHasKey( $key, $result );
		}

		foreach ( $nonExistingKeys as $key ) {
			$this->assertArrayNotHasKey( $key, $result );
		}

		$this->assertSame( 'hd', $result['layout'] );
	}

	/**
	 * @return array[]
	 */
	public static function getCarrierForCheckoutDataProvider(): array {
		$alwaysPresentKeys = [ 'id', 'is_pickup_points' ];

		return [
			[
				'carrier'           => DummyFactory::createCarrierCzechHdRequiresSize(),
				'expectedKeys'      => array_merge( $alwaysPresentKeys, [ 'address_validation' ] ),
				'nonExistingKeys'   => [ 'vendors', 'carriers' ],
				'addressValidation' => 'optional',
			],
			[
				'carrier'           => DummyFactory::createCarrierGermanHd(),
				'expectedKeys'      => array_merge( $alwaysPresentKeys, [ 'address_validation' ] ),
				'nonExistingKeys'   => [ 'vendors', 'carriers' ],
				'addressValidation' => 'none',
			],
			[
				'carrier'         => DummyFactory::createCarrierZpointcz(),
				'expectedKeys'    => array_merge( $alwaysPresentKeys, [ 'vendors' ] ),
				'nonExistingKeys' => [ 'address_validation', 'carriers' ],
			],
			[
				'carrier'         => DummyFactory::createCarrierCzzpoint(),
				'expectedKeys'    => array_merge( $alwaysPresentKeys, [ 'vendors' ] ),
				'nonExistingKeys' => [ 'address_validation', 'carriers' ],
			],
		];
	}

	/**
	 * @dataProvider getCarrierForCheckoutDataProvider
	 */
	public function testGetCarrierForCheckout(
		Carrier $carrier,
		array $expectedKeys,
		array $nonExistingKeys,
		?string $addressValidation = null
	): void {
		$wpAdapterMock = $this->createMock( WpAdapter::class );

		$config = new PacketaPickupPointsConfig(
			new CompoundCarrierCollectionFactory(),
			new VendorCollectionFactory(),
		);

		$builder = new WidgetOptionsBuilder(
			$config,
			$wpAdapterMock
		);

		$optionId = OptionPrefixer::getOptionId( $carrier->getId() );
		$wpAdapterMock
			->method( 'getOption' )
			->willReturn(
				[
					'address_validation' => $addressValidation,
				]
			);

		$result = $builder->getCarrierForCheckout(
			$carrier,
			$optionId
		);

		foreach ( $expectedKeys as $key ) {
			$this->assertArrayHasKey( $key, $result );
		}

		foreach ( $nonExistingKeys as $key ) {
			$this->assertArrayNotHasKey( $key, $result );
		}

		if ( $addressValidation !== null ) {
			$this->assertContains( 'address_validation', $expectedKeys, 'address_validation key must be present in expectedKeys' );
			$this->assertSame( $addressValidation, $result['address_validation'] );
		}
	}
}

```