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

Author: pscheit

.github/workflows/tests.yml .github/workflows/ci.yml.github/workflows/tests.yml renamed to .github/workflows/ci.yml

@@ -1,12 +1,34 @@
-name: tests
+name: ci
 
 on:
   push:
   pull_request:
 
 jobs:
-  tests:
+  static_analysis:
+    name: Static analysis
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
 
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.0'
+          extensions: curl
+          tools: composer:v2
+          coverage: none
+
+      - name: Install PHP dependencies
+        run: composer update --prefer-dist --no-interaction --no-progress
+
+      - name: Run PHPStan
+        run: vendor/bin/phpstan analyze
+
+  tests:
+    name: Tests ${{ matrix.php }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -18,8 +40,6 @@ jobs:
           - '8.3'
           - '8.4'
 
-    name: PHP ${{ matrix.php }}
-
     steps:
       - name: Checkout code
         uses: actions/checkout@v2

.gitignore

@@ -1,3 +1,4 @@
 composer.lock
 tests/.phpunit.result.cache
+tests/phpunit.xml
 vendor

composer.json

@@ -22,7 +22,9 @@
 
 	"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"
 	},
 
 	"replace": {
@@ -33,7 +35,7 @@
 
     "extra": {
         "branch-alias": {
-            "dev-master": "2.1-dev"
+            "dev-master": "3.0-dev"
         }
     }
 }

generator/FactoryFile.php

@@ -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;
     }
 
@@ -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";

generator/FactoryMethod.php

@@ -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);

generator/parts/functions_header.txt

@@ -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(