Skip to content

Stop using FauxFunction #102

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 #102

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.0"
"phpstan/phpstan": "^2.2.15"
},
"require-dev": {
"beberlei/assert": "^3.3.0",
Expand Down
72 changes: 25 additions & 47 deletions src/Type/BeberleiAssert/AssertHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ public static function specifyTypes(
bool $nullOr
): SpecifiedTypes
{
[$expression, $rootExpr] = self::createExpression($scope, $assertName, $args);
[$expression, $isEquality] = self::createExpression($scope, $assertName, $args);
if ($expression === null) {
return new SpecifiedTypes([], []);
}
Expand All @@ -98,9 +98,12 @@ public static function specifyTypes(
$scope,
$expression,
TypeSpecifierContext::createTruthy(),
)->setRootExpr($rootExpr ?? $expression);
);
if ($isEquality) {
$specifiedTypes = $specifiedTypes->setEquality();
}

return self::specifyRootExprIfSet($rootExpr, $scope, $specifiedTypes, $typeSpecifier);
return $specifiedTypes;
}

public static function handleAll(
Expand Down Expand Up @@ -242,7 +245,7 @@ private static function allArrayOrIterable(

/**
* @param Arg[] $args
* @return array{?Expr, ?Expr}
* @return array{?Expr, bool}
*/
private static function createExpression(
Scope $scope,
Expand All @@ -255,21 +258,21 @@ private static 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];
}

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

/**
* @return array<string, callable(Scope, Arg, Arg...): (Expr|array{?Expr, ?Expr}|null)>
* @return array<string, callable(Scope, Arg, Arg...): (Expr|array{?Expr, bool}|null)>
*/
private static function getExpressionResolvers(): array
{
Expand Down Expand Up @@ -438,47 +441,22 @@ private static function getExpressionResolvers(): array
'isJsonString',
];
foreach ($assertionsResultingAtLeastInNonEmptyString as $name) {
self::$resolvers[$name] = static fn (Scope $scope, Arg $value): array => self::createIsNonEmptyStringAndSomethingExprPair($name, [$value]);
self::$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,
];
}

return self::$resolvers;
}

/**
* @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 static function specifyRootExprIfSet(?Expr $rootExpr, Scope $scope, SpecifiedTypes $specifiedTypes, TypeSpecifier $typeSpecifier): SpecifiedTypes
{
if ($rootExpr === null) {
return $specifiedTypes;
}

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

}
3 changes: 2 additions & 1 deletion tests/Type/BeberleiAssert/ImpossibleCheckTypeMethodCallRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ public function testExtension(): void
[
'Call to method Assert\AssertionChain::isJsonString() will always evaluate to true.',
22,
'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%</>.',
'• 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%</>.
• If Assert\AssertionChain::isJsonString() is impure, add <fg=cyan>@phpstan-impure</> PHPDoc tag above its declaration. Learn more: <fg=cyan>https://phpstan.org/blog/remembering-and-forgetting-returned-values</>',
],
[
'Call to method Assert\AssertionChain::isJsonString() will always evaluate to true.',
Expand Down
1 change: 0 additions & 1 deletion tests/Type/BeberleiAssert/ImpossibleCheckTypeStaticMethodCallRuleTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ public function testExtension(): void
[
'Call to static method Assert\Assertion::string() with string will always evaluate to true.',
12,
'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%</>.',
],
[
'Call to static method Assert\Assertion::allString() with array<string> will always evaluate to true.',
Expand Down
Loading