Merge pull request #207 from koriym/phpstan12

Refactor with phpstan 0.12

Author: koriym

.gitignore

@@ -6,3 +6,4 @@ composer.lock
 tmp/
 .php_cs.cache
 .phpunit.result.cache
+tests/script/grapher.php.txt

.php_cs.dist

@@ -134,7 +134,7 @@ return \PhpCsFixer\Config::create()
         'phpdoc_inline_tag' => true, // @Symfony]
         'phpdoc_no_access' => true, // @Symfony]
         'phpdoc_no_alias_tag' => true, // @Symfony
-        'phpdoc_no_empty_return' => true, // @Symfony
+//      'phpdoc_no_empty_return' => true, // @Symfony
         'phpdoc_no_package' => true, // @Symfony
 //      'phpdoc_no_useless_inheritdoc' => true, // @Symfony
         'phpdoc_order' => true,
@@ -143,7 +143,7 @@ return \PhpCsFixer\Config::create()
         'phpdoc_separation' => true, // @Symfony
         'phpdoc_single_line_var_spacing' => true, // @Symfony
 //      'phpdoc_summary' => true, // @Symfony
-        'phpdoc_to_comment' => true, // @Symfony
+//      'phpdoc_to_comment' => true, // @Symfony
         'phpdoc_trim' => true, // @Symfony
         'phpdoc_trim_consecutive_blank_line_separation' => true,
         'phpdoc_types' => true, // @Symfony

.travis.yml

@@ -21,35 +21,37 @@ script:
   - ./vendor/bin/phpunit;
 
 jobs:
+  fast_finish: true
   include:
-  - stage: Test
-    name: Lowest dependencies
-    php: 7.2
-    install: composer update --prefer-dist --prefer-lowest
-
-  - stage: Test
-    name: Code coverage
-    php: 7.2
-    before_script:
-    - mv ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini{.disabled,}
-    - if [[ ! $(php -m | grep -si xdebug) ]]; then echo "xdebug required for coverage"; exit 1; fi
-    script:
-    - ./vendor/bin/phpunit -v --coverage-clover ./build/logs/clover.xml
-    after_script:
-    - wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover coverage.clover;
-
-  - stage: Code Quality
-    name: Static analysis
-    php: 7.4
-    install: composer require --dev phpstan/phpstan ^0.11 phpmetrics/phpmetrics vimeo/psalm
-    script:
-      - ./vendor/bin/phpstan analyse -l max -c phpstan.neon src tests --no-progress --no-interaction;
-      - ./vendor/bin/psalm
-      - ./vendor/bin/phpmetrics --excluded-dirs=src/Exception src
-
-  - stage: Code Quality
-    name: Coding standards
-    php: 7.4
-    install: composer require --dev friendsofphp/php-cs-fixer ^2.0;
-    script:
-      - ./vendor/bin/php-cs-fixer --dry-run -v fix;
+    - stage: Test
+      name: Lowest dependencies
+      php: 7.2
+      install: composer update --prefer-dist --prefer-lowest
+
+    - stage: Code Quality
+      name: Code coverage
+      php: 7.2
+      before_script:
+        - mv ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini{.disabled,}
+        - if [[ ! $(php -m | grep -si xdebug) ]]; then echo "xdebug required for coverage"; exit 1; fi
+      script:
+        - ./vendor/bin/phpunit -v --coverage-clover ./build/logs/clover.xml
+      after_script:
+        - wget https://scrutinizer-ci.com/ocular.phar && php ocular.phar code-coverage:upload --format=php-clover coverage.clover;
+
+    - stage: Code Quality
+      name: Static analysis
+      php: 7.2
+      install:
+        - composer global require --dev phpstan/phpstan ^0.12 vimeo/psalm ^3.11 phpmetrics/phpmetrics ^2.6;
+      script:
+        - ~/.composer/vendor/bin/phpstan analyse -c phpstan.neon --no-progress --no-interaction;
+        - ~/.composer/vendor/bin/psalm --show-info=false
+        - ~/.composer/vendor/bin/phpmetrics --exclude=Exception src
+
+    - stage: Code Quality
+      name: Coding standards
+      php: 7.2
+      install: composer global require --dev friendsofphp/php-cs-fixer ^2.0;
+      script:
+        - ~/.composer/vendor/bin/php-cs-fixer --dry-run -v fix;

composer.json

@@ -16,9 +16,8 @@
     ],
     "require": {
         "php": ">=7.2.0",
-        "ray/aop": "^2.8.5",
-        "ray/compiler": "1.x-dev|^1.3.6",
-        "doctrine/annotations": "^1.7"
+        "ray/aop": "^2.9.3",
+        "ray/compiler": "1.x-dev|^1.3.6"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.5"
@@ -35,10 +34,10 @@
     },
     "scripts" :{
         "test": ["phpunit"],
-        "tests": ["@cs", "phpstan analyse -l max src tests -c phpstan.neon --no-progress", "psalm", "@test"],
+        "tests": ["@cs", "phpstan analyse -c phpstan.neon --no-progress", "psalm", "@test"],
         "coverage": ["php -dzend_extension=xdebug.so ./vendor/bin/phpunit --coverage-text --coverage-html=build/coverage"],
         "cs": ["php-cs-fixer fix -v --dry-run", "phpcs --standard=./phpcs.xml src"],
         "cs-fix": ["php-cs-fixer fix -v", "phpcbf src"],
-        "metrics": ["phpmetrics --report-html=build/metrics --excluded-dirs=src/Exception src"]
+        "metrics": ["phpmetrics --report-html=build/metrics --exclude=Exception src"]
     }
 }

phpstan.neon

@@ -1,5 +1,19 @@
 parameters:
-    ignoreErrors:
-        - '#does not call parent constructor from#'
-    excludes_analyse:
-        - %currentWorkingDirectory%/tests/tmp/*
+  level: max
+  paths:
+    - src
+    - tests
+  excludes_analyse:
+    - %currentWorkingDirectory%/tests/tmp/*
+    - %currentWorkingDirectory%/tests/Fake/*
+  checkMissingIterableValueType: false
+  ignoreErrors:
+  -
+    message: "#Method Ray\\Di\\AbstractModule::getContainer() should return Ray\\Di\\Container but returns Ray\\Di\\Container|null\\.$#"
+    path: src/AbstractModule.php
+  -
+    message: "#has no return typehint specified\\.$#"
+    path: tests/*
+  -
+    message: "#expects class-string, string given\\.$#"
+    path: tests/BindTest.php

src/AbstractModule.php

@@ -6,6 +6,7 @@
 
 use Ray\Aop\AbstractMatcher;
 use Ray\Aop\Matcher;
+use Ray\Aop\Pointcut;
 use Ray\Aop\PriorityPointcut;
 
 abstract class AbstractModule
@@ -21,7 +22,7 @@ abstract class AbstractModule
     protected $lastModule;
 
     /**
-     * @var Container
+     * @var ?Container
      */
     private $container;
 
@@ -30,6 +31,7 @@ public function __construct(
     ) {
         $this->lastModule = $module;
         $this->activate();
+        assert($this->container instanceof Container);
         if ($module instanceof self) {
             $this->container->merge($module->getContainer());
         }
@@ -53,14 +55,12 @@ public function install(self $module) : void
      */
     public function override(self $module) : void
     {
-        $module->getContainer()->merge($this->container);
+        $module->getContainer()->merge($this->getContainer());
         $this->container = $module->getContainer();
     }
 
     /**
-     * Return container
-     *
-     * @psalm-suppress DocblockTypeContradiction
+     * Return activated container
      */
     public function getContainer() : Container
     {
@@ -74,26 +74,28 @@ public function getContainer() : Container
     /**
      * Bind interceptor
      *
-     * @param string[] $interceptors
+     * @param array<class-string<\Ray\Aop\MethodInterceptor>> $interceptors
      */
     public function bindInterceptor(AbstractMatcher $classMatcher, AbstractMatcher $methodMatcher, array $interceptors) : void
     {
         $pointcut = new Pointcut($classMatcher, $methodMatcher, $interceptors);
-        $this->container->addPointcut($pointcut);
+        $this->getContainer()->addPointcut($pointcut);
         foreach ($interceptors as $interceptor) {
-            (new Bind($this->container, $interceptor))->to($interceptor)->in(Scope::SINGLETON);
+            (new Bind($this->getContainer(), $interceptor))->to($interceptor)->in(Scope::SINGLETON);
         }
     }
 
     /**
      * Bind interceptor early
+     *
+     * @param array<class-string<\Ray\Aop\MethodInterceptor>> $interceptors
      */
     public function bindPriorityInterceptor(AbstractMatcher $classMatcher, AbstractMatcher $methodMatcher, array $interceptors) : void
     {
         $pointcut = new PriorityPointcut($classMatcher, $methodMatcher, $interceptors);
-        $this->container->addPointcut($pointcut);
+        $this->getContainer()->addPointcut($pointcut);
         foreach ($interceptors as $interceptor) {
-            (new Bind($this->container, $interceptor))->to($interceptor)->in(Scope::SINGLETON);
+            (new Bind($this->getContainer(), $interceptor))->to($interceptor)->in(Scope::SINGLETON);
         }
     }
 
@@ -116,12 +118,14 @@ public function rename(string $interface, string $newName, string $sourceName =
     /**
      * Configure binding
      *
-     * @psalm-suppress MissingReturnType
+     * @return void
      */
     abstract protected function configure();
 
     /**
      * Bind interface
+     *
+     * @phpstan-param class-string|string $interface
      */
     protected function bind(string $interface = '') : Bind
     {

src/AnnotatedClass.php

@@ -28,7 +28,7 @@ public function __construct(AnnotationReader $reader)
     /**
      * Return factory instance
      *
-     * @param \ReflectionClass $class Target class reflection
+     * @phpstan-param \ReflectionClass<object> $class Target class reflection
      */
     public function getNewInstance(\ReflectionClass $class) : NewInstance
     {
@@ -47,6 +47,8 @@ public function getNewInstance(\ReflectionClass $class) : NewInstance
 
     /**
      * Return @-PostConstruct method reflection
+     *
+     * @phpstan-param \ReflectionClass<object> $class
      */
     public function getPostConstruct(\ReflectionClass $class) : ?\ReflectionMethod
     {

src/AnnotatedClassMethods.php

@@ -26,6 +26,9 @@ public function __construct(Reader $reader)
         $this->nameKeyVarString = new NameKeyVarString($reader);
     }
 
+    /**
+     * @phpstan-param \ReflectionClass<object> $class
+     */
     public function getConstructorName(\ReflectionClass $class) : Name
     {
         $constructor = $class->getConstructor();

src/Argument.php

@@ -102,14 +102,19 @@ public function serialize() : string
         ]);
     }
 
+    /**
+     * @param string $serialized
+     *
+     * @throws \ReflectionException
+     */
     public function unserialize($serialized) : void
     {
-        list($this->index,
+        [$this->index,
             $this->isDefaultAvailable,
             $this->default,
             $this->meta,
             $ref
-        ) = unserialize($serialized);
+        ] = unserialize($serialized, ['allowed_classes' => false]);
         $this->reflection = new \ReflectionParameter([$ref[0], $ref[1]], $ref[2]);
     }
 
@@ -129,7 +134,7 @@ private function setDefaultValue(\ReflectionParameter $parameter) : void
     private function getType(\ReflectionParameter $parameter) : string
     {
         $type = $parameter->getType();
-        if (! $type instanceof \ReflectionType) {
+        if (! $type instanceof \ReflectionNamedType) {
             return '';
         }
         if (\in_array($type->getName(), ['bool', 'int', 'string', 'array', 'resource', 'callable'], true)) {

src/AspectBind.php

@@ -23,13 +23,11 @@ public function __construct(AopBind $bind)
      */
     public function inject(Container $container) : array
     {
+        /** @var array<array<class-string>> $bindings */
         $bindings = $this->bind->getBindings();
         foreach ($bindings as &$interceptors) {
-            /* @var string[] $interceptors */
             foreach ($interceptors as &$interceptor) {
-                if (\is_string($interceptor)) {
-                    $interceptor = $container->getInstance($interceptor, Name::ANY);
-                }
+                $interceptor = $container->getInstance($interceptor, Name::ANY);
             }
         }