Merge pull request #154 from wmde/trait-alternative

Create alternative to CanValidateField trait

Author: gbirke

src/CanValidateField.php

@@ -5,8 +5,7 @@
 namespace WMDE\FunValidators;
 
 /**
- * @deprecated this trait is used in other repositories and cannot be tested here properly,
- * thus it should be turned into a helper class instead or get the behaviour extracted in another way
+ * @deprecated Use {@see WMDE\FunValidators\ValidationResult::setSource()} instead
  */
 trait CanValidateField {
 

src/ConstraintViolation.php

@@ -33,6 +33,9 @@ public function getSource(): string {
 	}
 
 	public function setSource( string $source ): void {
+		if ( $this->source && $this->source !== $source ) {
+			trigger_error( 'Source is already set, overwriting it will be a logic exception in the future', E_USER_DEPRECATED );
+		}
 		$this->source = $source;
 	}
 

src/ValidationResult.php

@@ -30,4 +30,32 @@ public function getViolations(): array {
 		return $this->violations;
 	}
 
+	/**
+	 * @deprecated Use {@see setSourceForAllViolations()} instead
+	 */
+	public function setSource( string $sourceName ): self {
+		return $this->setSourceForAllViolations( $sourceName );
+	}
+
+	/**
+	 * Set source of an error in all violations.
+	 *
+	 * This method is meant for validation results that come from one source,
+	 * e.g. a validator like {@see WMDE\FunValidators\Validators\RequiredFieldValidator}
+	 * or {@see WMDE\FunValidators\Validators\StringLengthValidator}
+	 *
+	 * DO NOT call it on validation results that come from validators
+	 * that validate several sources. In those cases, the responsibility to
+	 * set the source is with the validator and not its calling code.
+	 */
+	public function setSourceForAllViolations( string $sourceName ): self {
+		foreach ( $this->violations as $violation ) {
+			$violation->setSource( $sourceName );
+		}
+		return $this;
+	}
+
+	public function getFirstViolation(): ?ConstraintViolation {
+		return $this->violations[0] ?? null;
+	}
 }

tests/Unit/ConstraintViolationTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare( strict_types = 1 );
+
+namespace WMDE\FunValidators\Tests\Unit;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use WMDE\FunValidators\ConstraintViolation;
+
+#[CoversClass( ConstraintViolation::class )]
+class ConstraintViolationTest extends TestCase {
+	public function testConstructorSetsProperties(): void {
+			$constraintViolation = new ConstraintViolation( "1nval1d", "no_mix_of_numbers_and_letters", "username" );
+
+			$this->assertSame( 'no_mix_of_numbers_and_letters', $constraintViolation->getMessageIdentifier() );
+			$this->assertSame( '1nval1d', $constraintViolation->getValue() );
+			$this->assertSame( 'username', $constraintViolation->getSource() );
+	}
+
+	public function testSetSource(): void {
+		$constraintViolation = new ConstraintViolation( "1nval1d", "no_mix_of_numbers_and_letters" );
+
+		$constraintViolation->setSource( 'access_code' );
+
+			$this->assertSame( 'access_code', $constraintViolation->getSource() );
+	}
+
+	/**
+	 * We'll change this to an exception check when our other libraries don't trigger deprecations any more
+	 */
+	public function testSetSourceDeprecatesOverridingExistingSource(): void {
+		$constraintViolation = new ConstraintViolation( "1nval1d", "no_mix_of_numbers_and_letters", 'username' );
+		$hasTriggeredDeprecation = false;
+		// @phpstan-ignore-next-line argument.type
+		set_error_handler( static function ()use( &$hasTriggeredDeprecation ){
+			$hasTriggeredDeprecation = true;
+		}, E_USER_DEPRECATED );
+
+		$constraintViolation->setSource( 'access_code' );
+
+		restore_error_handler();
+		$this->assertTrue( $hasTriggeredDeprecation );
+	}
+
+	/**
+	 * We'll change this to an exception check when our other libraries don't trigger deprecations any more
+	 */
+	public function testSetSourceAllowsOverridingWhenSourceNameMatches(): void {
+		$constraintViolation = new ConstraintViolation( "1nval1d", "no_mix_of_numbers_and_letters", 'username' );
+		$hasTriggeredDeprecation = false;
+		// @phpstan-ignore-next-line argument.type
+		set_error_handler( static function ()use( &$hasTriggeredDeprecation ){
+			$hasTriggeredDeprecation = true;
+		}, E_USER_DEPRECATED );
+
+		$constraintViolation->setSource( 'username' );
+
+		restore_error_handler();
+		$this->assertFalse( $hasTriggeredDeprecation );
+	}
+
+}

tests/Unit/ValidationResultTest.php

@@ -0,0 +1,56 @@
+<?php
+
+declare( strict_types = 1 );
+
+namespace WMDE\FunValidators\Tests\Unit;
+
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\TestCase;
+use WMDE\FunValidators\ConstraintViolation;
+use WMDE\FunValidators\ValidationResult;
+
+#[CoversClass( ValidationResult::class )]
+class ValidationResultTest extends TestCase {
+	public function testResultWithoutViolationsIsSuccessful(): void {
+		$result = new ValidationResult();
+
+		$this->assertTrue( $result->isSuccessful() );
+		$this->assertFalse( $result->hasViolations() );
+	}
+
+	public function testResultWithViolationsIsNotSuccessful(): void {
+		$violation1 = new ConstraintViolation( 'value?', 'test_message_1' );
+		$violation2 = new ConstraintViolation( 'value!', 'test_message_2' );
+		$result = new ValidationResult( $violation1, $violation2 );
+
+		$this->assertFalse( $result->isSuccessful() );
+		$this->assertTrue( $result->hasViolations() );
+		$this->assertSame( [ $violation1, $violation2 ], $result->getViolations() );
+	}
+
+	public function testSetSourceForAllViolationsChangesAllViolations(): void {
+		$violation1 = new ConstraintViolation( 'value?', 'test_message_1' );
+		$violation2 = new ConstraintViolation( 'value!', 'test_message_2' );
+		$result = new ValidationResult( $violation1, $violation2 );
+
+		$result->setSourceForAllViolations( 'a_test_field' );
+
+		$this->assertSame( 'a_test_field', $violation1->getSource() );
+		$this->assertSame( 'a_test_field', $violation2->getSource() );
+	}
+
+	public function testGetFirstViolationReturnsFirstViolation(): void {
+		$violation1 = new ConstraintViolation( 'value?', 'test_message_1' );
+		$violation2 = new ConstraintViolation( 'value!', 'test_message_2' );
+		$result = new ValidationResult( $violation1, $violation2 );
+
+		$this->assertSame( $violation1, $result->getFirstViolation() );
+	}
+
+	public function testGetFirstViolationReturnsNullWhenThereAreNoViolations(): void {
+		$result = new ValidationResult();
+
+		$this->assertNull( $result->getFirstViolation() );
+	}
+
+}