WMDE\Fundraising\AddressChangeContext\Tests\Unit\Domain\Model\AddressChangeTest

Complexity

Total Complexity

19

Size/Duplication

Total Lines	150
Duplicated Lines	0 %

Importance

Changes	8
Bugs	0	Features	0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	testWhenNewAddressChangeIsCreated_itIsNotModified()	0	3	1
A	testWhenAddressIsUpdated_dataIsProperlyAssigned()	0	7	1
A	testWhenAddressChangeIsPerformed_exportStateIsReset()	0	6	1
A	newPersonAddressChange()	0	8	1
A	setUp()	0	3	1
A	testMarkingAsExportedDoesNotChangeModificationDate()	0	4	1
A	testUpdatingAddressMarksAddressChangeAsModified()	0	9	1
A	testOptingOutOfReceiptMarksAddressChangeAsModified()	0	9	1
A	testNewAddressChangeIsNotExported()	0	3	1
A	testAddressChangeCanBeMarkedAsExported()	0	4	1
A	testAddressChangeCannotBeExportedTwice()	0	7	1
A	testUsedAndExportedAddressReturnsCorrectExportState()	0	6	1
A	testAddressChangesWithAddressesAreUsed()	0	5	1
A	testNewAddressChangesAreUnused()	0	4	1
A	testUnusedAddressReturnsCorrectExportState()	0	4	1
A	testUsedAddressReturnsCorrectExportState()	0	5	1
A	testReferenceTypeIsValidated()	0	4	1
A	testMultipleModificationsWithTheSameIdentifierKeepsIdentifiers()	0	9	1
A	testAddressChangesWithOptOutAreUsed()	0	5	1

<?php

declare( strict_types = 1 );

namespace WMDE\Fundraising\AddressChangeContext\Tests\Unit\Domain\Model;

use PHPUnit\Framework\Attributes\CoversClass;

The type PHPUnit\Framework\Attributes\CoversClass was not found. Maybe you did not declare it correctly or list all dependencies?

use PHPUnit\Framework\TestCase;
use WMDE\Fundraising\AddressChangeContext\Domain\Model\AddressChange;
use WMDE\Fundraising\AddressChangeContext\Domain\Model\AddressChangeId;
use WMDE\Fundraising\AddressChangeContext\Domain\Model\AddressType;
use WMDE\Fundraising\AddressChangeContext\Tests\Data\ValidAddress;

#[CoversClass( AddressChange::class )]
class AddressChangeTest extends TestCase {

	private const DUMMY_DONATION_ID = 0;

	private AddressChangeId $identifier;
	private AddressChangeId $newIdentifier;

	public function setUp(): void {
		$this->identifier = AddressChangeId::fromString( 'c956688a-89e8-41b7-b93e-7e4cf3d6c826' );
		$this->newIdentifier = AddressChangeId::fromString( 'e0c4db0b-9049-462c-8c76-c4f6a3a75091' );
	}

	public function testWhenNewAddressChangeIsCreated_itIsNotModified(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$this->assertFalse( $addressChange->isModified() );
	}

	public function testWhenAddressIsUpdated_dataIsProperlyAssigned(): void {
		$addressChange = $this->newPersonAddressChange();
		$address = ValidAddress::newValidPersonalAddress();

		$addressChange->performAddressChange( $address, $this->newIdentifier );

		$this->assertSame( $address, $addressChange->getAddress() );
	}

	private function newPersonAddressChange(): AddressChange {
		return new AddressChange(
			AddressType::Person,
			AddressChange::EXTERNAL_ID_TYPE_DONATION,
			self::DUMMY_DONATION_ID,
			$this->identifier,
			null,
			new \DateTime( '1970-01-01' ),
		);
	}

	public function testUpdatingAddressMarksAddressChangeAsModified(): void {
		$addressChange = $this->newPersonAddressChange();
		$initialIdentifier = $addressChange->getCurrentIdentifier();

		$addressChange->performAddressChange( ValidAddress::newValidPersonalAddress(), $this->newIdentifier );

		$this->assertNotSame( $initialIdentifier, $addressChange->getCurrentIdentifier() );
		$this->assertSame( $initialIdentifier, $addressChange->getPreviousIdentifier() );
		$this->assertTrue( $addressChange->isModified() );
	}

	public function testOptingOutOfReceiptMarksAddressChangeAsModified(): void {
		$addressChange = $this->newPersonAddressChange();
		$initialIdentifier = $addressChange->getCurrentIdentifier();

		$addressChange->optOutOfDonationReceipt( $this->newIdentifier );

		$this->assertNotSame( $initialIdentifier, $addressChange->getCurrentIdentifier() );
		$this->assertSame( $initialIdentifier, $addressChange->getPreviousIdentifier() );
		$this->assertTrue( $addressChange->isModified() );
	}

	public function testNewAddressChangeIsNotExported(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$this->assertFalse( $addressChange->isExported() );
	}

	public function testAddressChangeCanBeMarkedAsExported(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$addressChange->markAsExported();
		$this->assertTrue( $addressChange->isExported() );
	}

	public function testAddressChangeCannotBeExportedTwice(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$addressChange->markAsExported();

		$this->expectException( \LogicException::class );

		$addressChange->markAsExported();
	}

	public function testMarkingAsExportedDoesNotChangeModificationDate(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$addressChange->markAsExported();
		$this->assertFalse( $addressChange->isModified() );
	}

	public function testWhenAddressChangeIsPerformed_exportStateIsReset(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$addressChange->markAsExported();
		$addressChange->performAddressChange( ValidAddress::newValidCompanyAddress(), $this->newIdentifier );

		$this->assertFalse( $addressChange->isExported() );
	}

	public function testReferenceTypeIsValidated(): void {
		$this->expectException( \InvalidArgumentException::class );

		new AddressChange( AddressType::Person, 'dogs!', self::DUMMY_DONATION_ID, $this->identifier );
	}

	public function testUnusedAddressReturnsCorrectExportState(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );

		$this->assertEquals( AddressChange::EXPORT_STATE_NO_DATA, $addressChange->getExportState() );
	}

	public function testUsedAddressReturnsCorrectExportState(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$addressChange->performAddressChange( ValidAddress::newValidPersonalAddress(), $this->newIdentifier );

		$this->assertEquals( AddressChange::EXPORT_STATE_USED_NOT_EXPORTED, $addressChange->getExportState() );
	}

	public function testUsedAndExportedAddressReturnsCorrectExportState(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$addressChange->performAddressChange( ValidAddress::newValidPersonalAddress(), $this->newIdentifier );
		$addressChange->markAsExported();

		$this->assertEquals( AddressChange::EXPORT_STATE_USED_EXPORTED, $addressChange->getExportState() );
	}

	public function testNewAddressChangesAreUnused(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );

		$this->assertFalse( $addressChange->hasBeenUsed() );
	}

	public function testAddressChangesWithAddressesAreUsed(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$addressChange->performAddressChange( ValidAddress::newValidPersonalAddress(), $this->newIdentifier );

		$this->assertTrue( $addressChange->hasBeenUsed() );
	}

	public function testAddressChangesWithOptOutAreUsed(): void {
		$addressChange = new AddressChange( AddressType::Person, AddressChange::EXTERNAL_ID_TYPE_DONATION, self::DUMMY_DONATION_ID, $this->identifier );
		$addressChange->optOutOfDonationReceipt( $this->newIdentifier );

		$this->assertTrue( $addressChange->hasBeenUsed() );
	}

	public function testMultipleModificationsWithTheSameIdentifierKeepsIdentifiers(): void {
		$addressChange = $this->newPersonAddressChange();
		$initialIdentifier = $addressChange->getCurrentIdentifier();

		$addressChange->performAddressChange( ValidAddress::newValidPersonalAddress(), $this->newIdentifier );
		$addressChange->optOutOfDonationReceipt( $this->newIdentifier );

		$this->assertEquals( $initialIdentifier, $addressChange->getPreviousIdentifier() );
		$this->assertEquals( $this->newIdentifier, $addressChange->getCurrentIdentifier() );
	}
}