Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: handle non-positive integer type
Non-positive integer can be used as below. It will accept any value
equal to or lower than zero.
```php
final class SomeClass
{
/** @var non-positive-int */
public int $nonPositiveInteger;
}
```- Loading branch information
Showing
8 changed files
with
242 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace CuyZ\Valinor\Type\Types; | ||
|
|
||
| use CuyZ\Valinor\Mapper\Tree\Message\ErrorMessage; | ||
| use CuyZ\Valinor\Mapper\Tree\Message\MessageBuilder; | ||
| use CuyZ\Valinor\Type\IntegerType; | ||
| use CuyZ\Valinor\Type\Type; | ||
| use CuyZ\Valinor\Utility\IsSingleton; | ||
|
|
||
| /** @internal */ | ||
| final class NonPositiveIntegerType implements IntegerType | ||
| { | ||
| use IsSingleton; | ||
|
|
||
| public function accepts(mixed $value): bool | ||
| { | ||
| return is_int($value) && $value <= 0; | ||
| } | ||
|
|
||
| public function matches(Type $other): bool | ||
| { | ||
| if ($other instanceof UnionType) { | ||
| return $other->isMatchedBy($this); | ||
| } | ||
|
|
||
| return $other instanceof self | ||
| || $other instanceof NativeIntegerType | ||
| || $other instanceof MixedType; | ||
| } | ||
|
|
||
| public function canCast(mixed $value): bool | ||
| { | ||
| return ! is_bool($value) | ||
| && filter_var($value, FILTER_VALIDATE_INT) !== false | ||
| && $value <= 0; | ||
| } | ||
|
|
||
| public function cast(mixed $value): int | ||
| { | ||
| assert($this->canCast($value)); | ||
|
|
||
| return (int)$value; // @phpstan-ignore-line | ||
| } | ||
|
|
||
| public function errorMessage(): ErrorMessage | ||
| { | ||
| return MessageBuilder::newError('Value {source_value} is not a valid non-positive integer.')->build(); | ||
| } | ||
|
|
||
| public function toString(): string | ||
| { | ||
| return 'non-positive-int'; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,149 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace CuyZ\Valinor\Tests\Unit\Type\Types; | ||
|
|
||
| use AssertionError; | ||
| use CuyZ\Valinor\Tests\Fake\Type\FakeType; | ||
| use CuyZ\Valinor\Tests\Traits\TestIsSingleton; | ||
| use CuyZ\Valinor\Type\Types\MixedType; | ||
| use CuyZ\Valinor\Type\Types\NativeIntegerType; | ||
| use CuyZ\Valinor\Type\Types\NonPositiveIntegerType; | ||
| use CuyZ\Valinor\Type\Types\PositiveIntegerType; | ||
| use CuyZ\Valinor\Type\Types\UnionType; | ||
| use PHPUnit\Framework\TestCase; | ||
| use stdClass; | ||
|
|
||
| final class NonPositiveIntegerTypeTest extends TestCase | ||
| { | ||
| use TestIsSingleton; | ||
|
|
||
| private NonPositiveIntegerType $nonPositiveIntegerType; | ||
|
|
||
| protected function setUp(): void | ||
| { | ||
| parent::setUp(); | ||
|
|
||
| $this->nonPositiveIntegerType = new NonPositiveIntegerType(); | ||
| } | ||
|
|
||
| public function test_accepts_correct_values(): void | ||
| { | ||
| self::assertTrue($this->nonPositiveIntegerType->accepts(0)); | ||
| self::assertTrue($this->nonPositiveIntegerType->accepts(-404)); | ||
| } | ||
|
|
||
| public function test_does_not_accept_incorrect_values(): void | ||
| { | ||
| self::assertFalse($this->nonPositiveIntegerType->accepts(null)); | ||
| self::assertFalse($this->nonPositiveIntegerType->accepts('Schwifty!')); | ||
| self::assertFalse($this->nonPositiveIntegerType->accepts(404)); | ||
| self::assertFalse($this->nonPositiveIntegerType->accepts(42.1337)); | ||
| self::assertFalse($this->nonPositiveIntegerType->accepts(['foo' => 'bar'])); | ||
| self::assertFalse($this->nonPositiveIntegerType->accepts(false)); | ||
| self::assertFalse($this->nonPositiveIntegerType->accepts(new stdClass())); | ||
| } | ||
|
|
||
| public function test_can_cast_integer_value(): void | ||
| { | ||
| self::assertTrue($this->nonPositiveIntegerType->canCast(0)); | ||
| self::assertTrue($this->nonPositiveIntegerType->canCast(-404)); | ||
| self::assertTrue($this->nonPositiveIntegerType->canCast('-404')); | ||
| self::assertTrue($this->nonPositiveIntegerType->canCast(-404.00)); | ||
| } | ||
|
|
||
| public function test_cannot_cast_other_types(): void | ||
| { | ||
| self::assertFalse($this->nonPositiveIntegerType->canCast(null)); | ||
| self::assertFalse($this->nonPositiveIntegerType->canCast(42)); | ||
| self::assertFalse($this->nonPositiveIntegerType->canCast(-42.1337)); | ||
| self::assertFalse($this->nonPositiveIntegerType->canCast(42.1337)); | ||
| self::assertFalse($this->nonPositiveIntegerType->canCast(['foo' => 'bar'])); | ||
| self::assertFalse($this->nonPositiveIntegerType->canCast('Schwifty!')); | ||
| self::assertFalse($this->nonPositiveIntegerType->canCast(false)); | ||
| self::assertFalse($this->nonPositiveIntegerType->canCast(new stdClass())); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider cast_value_returns_correct_result_data_provider | ||
| */ | ||
| public function test_cast_value_returns_correct_result(mixed $value, int $expected): void | ||
| { | ||
| self::assertSame($expected, $this->nonPositiveIntegerType->cast($value)); | ||
| } | ||
|
|
||
| public function cast_value_returns_correct_result_data_provider(): array | ||
| { | ||
| return [ | ||
| 'Integer from float' => [ | ||
| 'value' => -404.00, | ||
| 'expected' => -404, | ||
| ], | ||
| 'Integer from string' => [ | ||
| 'value' => '-42', | ||
| 'expected' => -42, | ||
| ], | ||
| 'Integer from integer' => [ | ||
| 'value' => -1337, | ||
| 'expected' => -1337, | ||
| ], | ||
| 'Zero from string' => [ | ||
| 'value' => '0', | ||
| 'expected' => 0, | ||
| ], | ||
| ]; | ||
| } | ||
|
|
||
| public function test_cast_invalid_value_throws_exception(): void | ||
| { | ||
| $this->expectException(AssertionError::class); | ||
|
|
||
| $this->nonPositiveIntegerType->cast('foo'); | ||
| } | ||
|
|
||
| public function test_cast_invalid_positive_value_throws_exception(): void | ||
| { | ||
| $this->expectException(AssertionError::class); | ||
|
|
||
| $this->nonPositiveIntegerType->cast(1337); | ||
| } | ||
|
|
||
| public function test_string_value_is_correct(): void | ||
| { | ||
| self::assertSame('non-positive-int', $this->nonPositiveIntegerType->toString()); | ||
| } | ||
|
|
||
| public function test_matches_valid_integer_type(): void | ||
| { | ||
| self::assertTrue($this->nonPositiveIntegerType->matches(new NativeIntegerType())); | ||
| self::assertTrue($this->nonPositiveIntegerType->matches($this->nonPositiveIntegerType)); | ||
| self::assertFalse($this->nonPositiveIntegerType->matches(new PositiveIntegerType())); | ||
| } | ||
|
|
||
| public function test_does_not_match_other_type(): void | ||
| { | ||
| self::assertFalse($this->nonPositiveIntegerType->matches(new FakeType())); | ||
| } | ||
|
|
||
| public function test_matches_mixed_type(): void | ||
| { | ||
| self::assertTrue($this->nonPositiveIntegerType->matches(new MixedType())); | ||
| } | ||
|
|
||
| public function test_matches_union_type_containing_integer_type(): void | ||
| { | ||
| $union = new UnionType(new FakeType(), new NativeIntegerType(), new FakeType()); | ||
| $unionWithSelf = new UnionType(new FakeType(), new NonPositiveIntegerType(), new FakeType()); | ||
|
|
||
| self::assertTrue($this->nonPositiveIntegerType->matches($union)); | ||
| self::assertTrue($this->nonPositiveIntegerType->matches($unionWithSelf)); | ||
| } | ||
|
|
||
| public function test_does_not_match_union_type_not_containing_integer_type(): void | ||
| { | ||
| $unionType = new UnionType(new FakeType(), new FakeType()); | ||
|
|
||
| self::assertFalse($this->nonPositiveIntegerType->matches($unionType)); | ||
| } | ||
| } |