Implement TrueTruthyFalseFalseyTypeSpecifierContextMutator (#36)

Author: staabm

resources/infection.json5

@@ -12,9 +12,10 @@
   },
   "mutators": {
     "@default": false,
+    "PHPStan\\Infection\\IsSuperTypeOfCalleeAndArgumentMutator": true,
     "PHPStan\\Infection\\LooseBooleanMutator": true,
     "PHPStan\\Infection\\TrinaryLogicMutator": true,
-    "PHPStan\\Infection\\IsSuperTypeOfCalleeAndArgumentMutator": true
+    "PHPStan\\Infection\\TrueTruthyFalseFalseyTypeSpecifierContextMutator": true
   },
   "bootstrap": "build-infection/vendor/autoload.php"
 }

src/Infection/TrueTruthyFalseFalseyTypeSpecifierContextMutator.php

@@ -0,0 +1,85 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Infection;
+
+use Infection\Mutator\Definition;
+use Infection\Mutator\Mutator;
+use Infection\Mutator\MutatorCategory;
+use LogicException;
+use PhpParser\Node;
+use function count;
+use function in_array;
+
+/**
+ * @implements Mutator<Node\Expr\MethodCall>
+ */
+final class TrueTruthyFalseFalseyTypeSpecifierContextMutator implements Mutator
+{
+
+	public static function getDefinition(): Definition
+	{
+		return new Definition(
+			<<<'TXT'
+				Replaces boolean TypeSpecifierContext->true() with TypeSpecifierContext->truthy().
+				TXT
+			,
+			MutatorCategory::ORTHOGONAL_REPLACEMENT,
+			null,
+			<<<'DIFF'
+				- $context->false()
+				+ $context->falsey()
+			DIFF,
+		);
+	}
+
+	public function getName(): string
+	{
+		return self::class;
+	}
+
+	public function canMutate(Node $node): bool
+	{
+		if (!$node instanceof Node\Expr\MethodCall) {
+			return false;
+		}
+
+		if (!$node->name instanceof Node\Identifier) {
+			return false;
+		}
+
+		if (!in_array($node->name->name, ['true', 'truthy', 'false', 'falsey'], true)) {
+			return false;
+		}
+
+		if (count($node->getArgs()) !== 0) {
+			return false;
+		}
+
+		return true;
+	}
+
+	public function mutate(Node $node): iterable
+	{
+		if (!$node->name instanceof Node\Identifier) {
+			throw new LogicException();
+		}
+
+		switch ($node->name->name) {
+			case 'true':
+				yield new Node\Expr\MethodCall($node->var, 'truthy');
+				break;
+			case 'truthy':
+				yield new Node\Expr\MethodCall($node->var, 'true');
+				break;
+			case 'false':
+				yield new Node\Expr\MethodCall($node->var, 'falsey');
+				break;
+			case 'falsey':
+				yield new Node\Expr\MethodCall($node->var, 'false');
+				break;
+			default:
+				throw new LogicException();
+		}
+	}
+
+}

tests/Infection/TrueTruthyFalseFalseyTypeSpecifierContextMutatorTest.php

@@ -0,0 +1,106 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Infection;
+
+use Infection\Testing\BaseMutatorTestCase;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\DataProvider;
+
+#[CoversClass(TrueTruthyFalseFalseyTypeSpecifierContextMutator::class)]
+final class TrueTruthyFalseFalseyTypeSpecifierContextMutatorTest extends BaseMutatorTestCase
+{
+
+	/**
+	 * @param string|string[] $expected
+	 */
+	#[DataProvider('mutationsProvider')]
+	public function testMutator(string $input, $expected = []): void
+	{
+		$this->assertMutatesInput($input, $expected);
+	}
+
+	/**
+	 * @return iterable<string, array{0: string, 1?: string}>
+	 */
+	public static function mutationsProvider(): iterable
+	{
+		yield 'It mutates true()' => [
+			<<<'PHP'
+				<?php
+				$context = TypeSpecifierContext::createNull();
+				$context->true();
+				PHP
+,
+			<<<'PHP'
+				<?php
+
+				$context = TypeSpecifierContext::createNull();
+				$context->truthy();
+				PHP
+,
+		];
+
+		yield 'It mutates truthy()' => [
+			<<<'PHP'
+				<?php
+				$context = TypeSpecifierContext::createNull();
+				$context->truthy();
+				PHP
+,
+			<<<'PHP'
+				<?php
+
+				$context = TypeSpecifierContext::createNull();
+				$context->true();
+				PHP
+,
+		];
+
+		yield 'It mutates false()' => [
+			<<<'PHP'
+				<?php
+				$context = TypeSpecifierContext::createNull();
+				$context->false();
+				PHP
+,
+			<<<'PHP'
+				<?php
+
+				$context = TypeSpecifierContext::createNull();
+				$context->falsey();
+				PHP
+,
+		];
+
+		yield 'It mutates falsey()' => [
+			<<<'PHP'
+				<?php
+				$context = TypeSpecifierContext::createNull();
+				$context->falsey();
+				PHP
+,
+			<<<'PHP'
+				<?php
+
+				$context = TypeSpecifierContext::createNull();
+				$context->false();
+				PHP
+,
+		];
+
+		yield 'It skips null()' => [
+			<<<'PHP'
+				<?php
+				$context = TypeSpecifierContext::createNull();
+				$context->null();
+				PHP
+,
+		];
+	}
+
+	protected function getTestedMutatorClassName(): string
+	{
+		return TrueTruthyFalseFalseyTypeSpecifierContextMutator::class;
+	}
+
+}

tests/phpt/infection-config-default.phpt

@@ -19,9 +19,10 @@ echo shell_exec($bin);
     },
     "mutators": {
         "@default": false,
+        "PHPStan\\Infection\\IsSuperTypeOfCalleeAndArgumentMutator": true,
         "PHPStan\\Infection\\LooseBooleanMutator": true,
         "PHPStan\\Infection\\TrinaryLogicMutator": true,
-        "PHPStan\\Infection\\IsSuperTypeOfCalleeAndArgumentMutator": true
+        "PHPStan\\Infection\\TrueTruthyFalseFalseyTypeSpecifierContextMutator": true
     },
     "bootstrap": "build-infection\/vendor\/autoload.php"
 }

tests/phpt/infection-config.phpt

@@ -20,9 +20,10 @@ echo shell_exec($bin." --source-directory='more/files/' --timeout=180 --mutator-
     },
     "mutators": {
         "@default": false,
+        "PHPStan\\Infection\\IsSuperTypeOfCalleeAndArgumentMutator": true,
         "PHPStan\\Infection\\LooseBooleanMutator": true,
         "PHPStan\\Infection\\TrinaryLogicMutator": true,
-        "PHPStan\\Infection\\IsSuperTypeOfCalleeAndArgumentMutator": true,
+        "PHPStan\\Infection\\TrueTruthyFalseFalseyTypeSpecifierContextMutator": true,
         "My\\Class": true
     },
     "bootstrap": "build-infection\/vendor\/autoload.php"