[4.x] Add PHPStan analysis to the build

[mhujer]

PHPStan is a PHP Static Analysis Tool.

I've fixed the errors it can find up to level 2 (it has 7 levels of checks), but this PR is already big enough, so I will create another one later on.

[mhujer]

By calling the Composer script, it runs the same configuration as you would run locally.

[mhujer]

this is the actual tool, but wrapped in a phar so it does not install any other dependencies

[mhujer]

it should be ran before tests, because it can discover issues that would make tests fail anyway

[mhujer]

by splitting analysis of src and tests separate config file can be provided (e.g. with different ignored erros)

[mhujer]

Please check if this is correct

[ramsey]

I’d like to understand more about what this does. Very little code has changed, but it looks like a lot of comments have been added. Does phpstan require these comments?

[mhujer]

Most of the changes are for both PHPStorm and PHPStan (and anything that tries to analyze the code)

1. /** @var Uuid $uuid */ comment is necessary anywhere, where the result of Uuid::fromString() is treated like the instance of Uuid. (::fromString() returns UuidInterface which lacks some of the methods available in Uuid)

eg. in the following code, the $uuid is UuidInterface, but the getClockSeqLow() method is available only in Uuid. The docblock makes it clear, that the Uuid is actually returned.

     public function testGetClockSeqLow()
      {
 +        /** @var Uuid $uuid */
          $uuid = Uuid::fromString('ff6f8cb0-c57d-11e1-9b21-0800200c9a66');
          $this->assertEquals(33, $uuid->getClockSeqLow());
      }

2. In some places, it was necessary to add a phpdoc for a mock object, because methods from both objects can be called:

        /** @var \Ramsey\Uuid\Provider\Node\SystemNodeProvider|\PHPUnit_Framework_MockObject_MockObject $provider */
        $provider = $this->getMockBuilder(SystemNodeProvider::class)
            ->setMethods(['getIfconfig'])
            ->getMock();

        $provider->expects($this->once())  // method from \PHPUnit_Framework_MockObject_MockObject
            ->method('getIfconfig')
            ->willReturn(PHP_EOL . 'AA-BB-CC-DD-EE-FF' . PHP_EOL);

        $node = $provider->getNode(); // method from \Ramsey\Uuid\Provider\Node\SystemNodeProvider

[mhujer]

I'm not sure about this change, but originally it was calling the static method non-statically.

[mhujer]

PHPStan works by analyzing the types in the code and in the phpdocs and then it uses it to report potentially incorrect code. (It knows, that if the method accepts some type, you cannot pass other type there.) The analysis is possible by having proper types in the code (which also helps the PHPStorm and other IDEs).

If there is anything else I can explain, you can comment directly at the specific line of the diff.

[ramsey]

After considering this some more, I've decided to accept it. Thanks for all your hard work!

[ramsey]

✅ SemVer Sentry Result

This PR will not change anything and can be merged freely without breaking backwards compatibility.

If you decide to create a release after merging this PR, you should know that the changes in this PR warrants at least a PATCH version release.

SemVer Sentry is in beta, take it's recommendations with a grain of salt and if in doubt, double check. If you want to get in touch with us, use the contact form on our homepage.

See here for more information on semantic versioning (semver).