Skip to content

Add native typhints to all hamcrest classes (+ install phpstan) #88

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
merged 15 commits into from
Jul 31, 2025
Merged

Add native typhints to all hamcrest classes (+ install phpstan) #88

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
eded4bd
add a simple Justfile to run in php7.4 and execute phpunit from the c…
pscheit Jun 25, 2025
2436a19
install phpstan and configure including baseline
pscheit Jun 25, 2025
db81cfa
add mostly native typehints to all files in hamcrest
pscheit Jun 25, 2025
f75c291
cleanup gitignore and justfile
pscheit Jun 25, 2025
8c6d2a3
codestyling
pscheit Jun 25, 2025
3603c58
Generate the files instead of modifying them and fix the code generat…
pscheit Jun 25, 2025
ef3183e
fix the return type of the Description interface to be static instead…
pscheit Jun 25, 2025
39afaff
Can use native Matcher typehints for the privates in IsArrayContainin…
pscheit Jun 25, 2025
2564fba
return the return type of the called method when generating factory m…
pscheit Jul 26, 2025
cbdee96
regenerate Matchers and Hamcrest to resolve conflicts
pscheit Jul 26, 2025
fb89dbc
remove the dump
pscheit Jul 26, 2025
7e813dd
revert wrong change in composer.json
pscheit Jul 29, 2025
a957171
add PHPStan to the CI in GitHub Actions
pscheit Jul 30, 2025
27146b1
run only on php 8.0
pscheit Jul 31, 2025
96a6a10
move CI configuration into one file and add the static analysis there
pscheit Jul 31, 2025
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
composer.lock
tests/.phpunit.result.cache
tests/phpunit.xml
vendor
7 changes: 5 additions & 2 deletions composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@

"require-dev": {
"phpunit/php-file-iterator": "^1.4 || ^2.0 || ^3.0",
"phpunit/phpunit": "^4.8.36 || ^5.7 || ^6.5 || ^7.0 || ^8.0 || ^9.0"
"phpunit/phpunit": "^4.8.36 || ^5.7 || ^6.5 || ^7.0 || ^8.0 || ^9.0",
"phpstan/phpstan": "^2.1",
"phpstan/phpstan-phpunit": "^2.0",
"symfony/var-dumper": "^5.4"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why the symfony/var-dumper is needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry, my mistake. I removed it

},

"replace": {
Expand All @@ -33,7 +36,7 @@

"extra": {
"branch-alias": {
"dev-master": "2.1-dev"
"dev-master": "3.0-dev"
}
}
}
18 changes: 17 additions & 1 deletion generator/FactoryFile.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ public function generateDeclaration($name, FactoryMethod $method)
$code = $this->indent . $this->getDeclarationModifiers()
. 'function ' . $name . '('
. $this->generateDeclarationArguments($method)
. ')' . "\n" . $this->indent . '{' . "\n";
. '): ' . $this->generateReturnType($method) . "\n" . $this->indent . '{' . "\n";
return $code;
}

Expand All @@ -83,6 +83,22 @@ public function generateDeclarationArguments(FactoryMethod $method)
}
}

public function generateReturnType(FactoryMethod $method): string
{
$call = $method->getCalls()[0];
if (!$call instanceof FactoryCall) {
throw new Exception('The first call in the FactoryMethod cannot be used to determine the return type. Method: '.$method->getName());
}

$returnType = $call->getMethod()->getReturnType();

if (!$returnType) {
throw new \Exception('The first calls FactoryMethod cannot be used to determine the return type. Method: '.$method->getName());
}

return sprintf('\\%s', $returnType);
}

public function generateImport(FactoryMethod $method)
{
return $this->indent . self::INDENT . "require_once '" . $method->getClass()->getFile() . "';" . "\n";
Expand Down
15 changes: 15 additions & 0 deletions generator/FactoryMethod.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,21 @@ public function getFullName()
return $this->getClassName() . '::' . $this->getName();
}

public function getReturnType(): ?string
{
if (!$this->reflector->hasReturnType()) {
return null;
}

$returnType = $this->reflector->getReturnType()->getName();

if ($returnType === 'self') {
return $this->reflector->getDeclaringClass()->getName();
}

return $returnType;
}

public function getCommentText()
{
return implode("\n", $this->comment);
Expand Down
2 changes: 1 addition & 1 deletion generator/parts/functions_header.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ if (!function_exists('assertThat')) {
* assertThat("some error", $a > $b);
* </pre>
*/
function assertThat()
function assertThat(): void
{
$args = func_get_args();
call_user_func_array(
Expand Down
Loading