Skip to content

Stop using FauxFunction #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VincentLanglet merged 1 commit into from
Sep 21, 2026
Merged

Stop using FauxFunction #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"keywords": ["static analysis"],
"require": {
"php": "^7.4 || ^8.0",
"phpstan/phpstan": "^2.1.41"
"phpstan/phpstan": "^2.2.15"
},
"require-dev": {
"nikic/php-parser": "^5.1",
Expand Down
118 changes: 47 additions & 71 deletions src/Type/WebMozartAssert/AssertTypeSpecifyingExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
use PHPStan\ShouldNotHappenException;
use PHPStan\Type\ArrayType;
use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
use PHPStan\Type\Constant\ConstantBooleanType;
use PHPStan\Type\IterableType;
use PHPStan\Type\MixedType;
use PHPStan\Type\NeverType;
Expand Down Expand Up @@ -156,7 +155,7 @@ public function specifyTypes(
);
}

[$expr, $rootExpr] = self::createExpression($scope, $staticMethodReflection->getName(), $node->getArgs());
[$expr, $isEquality] = self::createExpression($scope, $staticMethodReflection->getName(), $node->getArgs());
if ($expr === null) {
return new SpecifiedTypes([], []);
}
Expand All @@ -165,14 +164,17 @@ public function specifyTypes(
$scope,
$expr,
TypeSpecifierContext::createTruthy(),
)->setRootExpr($rootExpr ?? $expr);
);
if ($isEquality) {
$specifiedTypes = $specifiedTypes->setEquality();
}

return $this->specifyRootExprIfSet($rootExpr, $scope, $specifiedTypes);
return $specifiedTypes;
}

/**
* @param Arg[] $args
* @return array{?Expr, ?Expr}
* @return array{?Expr, bool}
*/
private function createExpression(
Scope $scope,
Expand All @@ -186,14 +188,14 @@ private function createExpression(

$resolverResult = $resolver($scope, ...$args);
if (is_array($resolverResult)) {
[$expr, $rootExpr] = $resolverResult;
[$expr, $isEquality] = $resolverResult;
} else {
$expr = $resolverResult;
$rootExpr = null;
$isEquality = false;
}

if ($expr === null) {
return [null, null];
return [null, false];
}

if (substr($name, 0, 6) === 'nullOr') {
Expand All @@ -206,11 +208,11 @@ private function createExpression(
);
}

return [$expr, $rootExpr];
return [$expr, $isEquality];
}

/**
* @return array<string, callable(Scope, Arg...): (Expr|array{?Expr, ?Expr}|null)>
* @return array<string, callable(Scope, Arg...): (Expr|array{?Expr, bool}|null)>
*/
private function getExpressionResolvers(): array
{
Expand Down Expand Up @@ -634,22 +636,23 @@ private function getExpressionResolvers(): array
];

foreach (['contains', 'startsWith', 'endsWith'] as $name) {
$this->resolvers[$name] = static function (Scope $scope, Arg $value, Arg $subString) use ($name): array {
if ($scope->getType($subString->value)->isNonEmptyString()->yes()) {
return self::createIsNonEmptyStringAndSomethingExprPair($name, [$value, $subString]);
}

$this->resolvers[$name] = static function (Scope $scope, Arg $value, Arg $subString): array {
$expr = new FuncCall(
new Name('is_string'),
[$value],
);

$rootExpr = new BooleanAnd(
$expr,
new FuncCall(new Name('FAUX_FUNCTION_ ' . $name), [$value, $subString]),
);
if ($scope->getType($subString->value)->isNonEmptyString()->yes()) {
$expr = new BooleanAnd(
$expr,
new NotIdentical(
$value->value,
new String_(''),
),
);
}

return [$expr, $rootExpr];
return [$expr, true];
};
}

Expand All @@ -669,7 +672,19 @@ private function getExpressionResolvers(): array
'notWhitespaceOnly',
];
foreach ($assertionsResultingAtLeastInNonEmptyString as $name) {
$this->resolvers[$name] = static fn (Scope $scope, Arg $value): array => self::createIsNonEmptyStringAndSomethingExprPair($name, [$value]);
$this->resolvers[$name] = static fn (Scope $scope, Arg $value): array => [
new BooleanAnd(
new FuncCall(
new Name('is_string'),
[$value],
),
new NotIdentical(
$value->value,
new String_(''),
),
),
true,
];
}
}

Expand All @@ -687,7 +702,6 @@ private function handleAllNot(
$scope,
$node->getArgs()[0]->value,
static fn (Type $type): Type => TypeCombinator::removeNull($type),
null,
);
}

Expand All @@ -703,7 +717,6 @@ private function handleAllNot(
$scope,
$node->getArgs()[0]->value,
static fn (Type $type): Type => TypeCombinator::remove($type, $classNameType),
null,
);
}

Expand All @@ -713,7 +726,6 @@ private function handleAllNot(
$scope,
$node->getArgs()[0]->value,
static fn (Type $type): Type => TypeCombinator::remove($type, $valueType),
null,
);
}

Expand All @@ -732,7 +744,7 @@ private function handleAll(
{
$args = $node->getArgs();
$args[0] = new Arg(new ArrayDimFetch($args[0]->value, new LNumber(0)));
[$expr, $rootExpr] = self::createExpression($scope, $methodName, $args);
[$expr, $isEquality] = self::createExpression($scope, $methodName, $args);
if ($expr === null) {
return new SpecifiedTypes();
}
Expand All @@ -741,7 +753,7 @@ private function handleAll(
$scope,
$expr,
TypeSpecifierContext::createTruthy(),
)->setRootExpr($rootExpr ?? $expr);
);

$sureNotTypes = $specifiedTypes->getSureNotTypes();
foreach ($specifiedTypes->getSureTypes() as $exprStr => [$exprNode, $type]) {
Expand All @@ -754,12 +766,16 @@ private function handleAll(
$type = $typeModifier($type);
}

return $this->allArrayOrIterable(
$specifiedTypes = $this->allArrayOrIterable(
$scope,
$node->getArgs()[0]->value,
static fn (): Type => $type,
$rootExpr,
);
break;
}

if ($isEquality) {
$specifiedTypes = $specifiedTypes->setEquality();
}

return $specifiedTypes;
Expand All @@ -768,8 +784,7 @@ private function handleAll(
private function allArrayOrIterable(
Scope $scope,
Expr $expr,
Closure $typeCallback,
?Expr $rootExpr
Closure $typeCallback
): SpecifiedTypes
{
$currentType = TypeCombinator::intersect($scope->getType($expr), new IterableType(new MixedType(), new MixedType()));
Expand Down Expand Up @@ -809,14 +824,12 @@ private function allArrayOrIterable(
return new SpecifiedTypes([], []);
}

$specifiedTypes = $this->typeSpecifier->create(
return $this->typeSpecifier->create(
$expr,
$specifiedType,
TypeSpecifierContext::createTruthy(),
$scope,
)->setRootExpr($rootExpr);

return $this->specifyRootExprIfSet($rootExpr, $scope, $specifiedTypes);
);
}

/**
Expand Down Expand Up @@ -856,41 +869,4 @@ private static function buildAnyOfExpr(Scope $scope, Arg $value, Arg $items, cal
return self::implodeExpr($resolvers, BooleanOr::class);
}

/**
* @param Arg[] $args
* @return array{Expr, Expr}
*/
private static function createIsNonEmptyStringAndSomethingExprPair(string $name, array $args): array
{
$expr = new BooleanAnd(
new FuncCall(
new Name('is_string'),
[$args[0]],
),
new NotIdentical(
$args[0]->value,
new String_(''),
),
);

$rootExpr = new BooleanAnd(
$expr,
new FuncCall(new Name('FAUX_FUNCTION_ ' . $name), $args),
);

return [$expr, $rootExpr];
}

private function specifyRootExprIfSet(?Expr $rootExpr, Scope $scope, SpecifiedTypes $specifiedTypes): SpecifiedTypes
{
if ($rootExpr === null) {
return $specifiedTypes;
}

// Makes consecutive calls with a rootExpr adding unknown info via FAUX_FUNCTION evaluate to true
return $specifiedTypes->unionWith(
$this->typeSpecifier->create($rootExpr, new ConstantBooleanType(true), TypeSpecifierContext::createTruthy(), $scope),
);
}

}
10 changes: 0 additions & 10 deletions tests/Type/WebMozartAssert/ImpossibleCheckTypeMethodCallRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@ protected function getRule(): Rule

public function testExtension(): void
{
$tipText = 'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.';

$this->analyse([__DIR__ . '/data/impossible-check.php'], [
[
'Call to static method Webmozart\Assert\Assert::stringNotEmpty() with \'\' will always evaluate to false.',
Expand Down Expand Up @@ -110,7 +108,6 @@ public function testExtension(): void
[
'Call to static method Webmozart\Assert\Assert::isInstanceOf() with Exception and class-string<Exception> will always evaluate to true.',
119,
$tipText,
],
[
'Call to static method Webmozart\Assert\Assert::startsWith() with \'value\' and string will always evaluate to true.',
Expand All @@ -119,7 +116,6 @@ public function testExtension(): void
[
'Call to static method Webmozart\Assert\Assert::implementsInterface() with \'WebmozartAssertImpossibleCheck\\\\Bar\' and \'WebmozartAssertImpossibleCheck\\\\Bar\' will always evaluate to false.',
134,
$tipText,
],
]);
}
Expand Down Expand Up @@ -196,34 +192,28 @@ public function testEqNotEq(): void

public function testBug8(): void
{
$tipText = 'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.';
$this->analyse([__DIR__ . '/data/bug-8.php'], [
[
'Call to static method Webmozart\Assert\Assert::numeric() with numeric-string will always evaluate to true.',
15,
$tipText,
],
[
'Call to static method Webmozart\Assert\Assert::numeric() with \'foo\' will always evaluate to false.',
16,
$tipText,
],
[
'Call to static method Webmozart\Assert\Assert::numeric() with \'17.19\' will always evaluate to true.',
17,
$tipText,
],
]);
}

public function testBug17(): void
{
$tipText = 'Because the type is coming from a PHPDoc, you can turn off this check by setting <fg=cyan>treatPhpDocTypesAsCertain: false</> in your <fg=cyan>%configurationFile%</>.';
$this->analyse([__DIR__ . '/data/bug-17.php'], [
[
'Call to static method Webmozart\Assert\Assert::implementsInterface() with \'DateTime\' and \'DateTimeInterface\' will always evaluate to true.',
9,
$tipText,
],
]);
}
Expand Down
Loading