[TASK] Do not treat PHPDoc type information as certain#1583
Merged
Conversation
This is a library. This means that we have no control over how other software calls our methods, and whether they adher to the types required via `@param` annotations. Hence, we shouldn't rely on those types being certain.
oliverklee
added
the
developer-specific
|
coverage: 73.324%. remained the same — task/no-certain-phpdoc into main |
JakeQZ
approved these changes
May 13, 2026
JakeQZ
reviewed
May 13, 2026
Comment on lines
-51
to
-56
| - | ||
| message: '#^Call to static method PHPUnit\\Framework\\Assert\:\:assertSame\(\) with ''red'' and Sabberworm\\CSS\\Value\\Value will always evaluate to false\.$#' | ||
| identifier: staticMethod.impossibleType | ||
| count: 1 | ||
| path: ../../tests/ParserTest.php | ||
|
|
Collaborator
There was a problem hiding this comment.
That this warning existed indicates something is returning a string but has DocBlock type indicating a different return type.
Collaborator
There was a problem hiding this comment.
#1584 resolves this concern. Turns out the test code had a loop with no iterations, within which was the assertSame() which would always fail, but was never called.
oliverklee
added a commit
that referenced
this pull request
May 13, 2026
This is a library. This means that we have no control over how other software calls our methods, and whether they adher to the types required via `@param` annotations. Hence, we shouldn't rely on those types being certain.
JakeQZ
added a commit
that referenced
this pull request
May 13, 2026
`getAllValues()` only includes values that are `Value` objects. It does not include `string` values. So the list returned was empty, the loop had no iterations, and the `assertSame()` was never called. It doesn't make sense to replace the code with an assertion that `getAllValues()` is returning an empty list, because the `TestCase` is for `Parser`, not `Document`. Besides, there is already an assertion that `red` is set for the string `color` value. Uncovered by PHPStan config change in #1583. This change would also have silenced the same PHPStan warning.
oliverklee
pushed a commit
that referenced
this pull request
May 14, 2026
`getAllValues()` only includes values that are `Value` objects. It does not include `string` values. So the list returned was empty, the loop had no iterations, and the `assertSame()` was never called. It doesn't make sense to replace the code with an assertion that `getAllValues()` is returning an empty list, because the `TestCase` is for `Parser`, not `Document`. Besides, there is already an assertion that `red` is set for the string `color` value. Uncovered by PHPStan config change in #1583. This change would also have silenced the same PHPStan warning.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is a library. This means that we have no control over how other software calls our methods, and whether they adher to the types required via
@paramannotations.Hence, we shouldn't rely on those types being certain.