make github work

.github/workflows/code-analysis.yaml

@@ -0,0 +1,53 @@
+name: Code Analysis
+
+on:
+    pull_request: null
+    push:
+        branches:
+            - main
+
+jobs:
+    code_analysis:
+        strategy:
+            fail-fast: false
+            matrix:
+                actions:
+                    -
+                        name: 'PHPStan'
+                        run: composer phpstan
+
+                    -
+                        name: 'Check Active Classes'
+                        run: vendor/bin/class-leak check bin src tests --ansi --skip-path=Fixture --skip-path=Source
+
+                    -
+                        name: 'Unit tests'
+                        run: vendor/bin/phpunit
+
+                    -
+                        name: "Finalize classes"
+                        run: vendor/bin/swiss-knife finalize-classes bin src tests --dry-run --ansi
+
+                    -
+                        name: 'Composer dependency Analyser'
+                        run: vendor/bin/composer-dependency-analyser
+
+                    -
+                        name: 'Validate Composer'
+                        run: composer validate
+
+        name: ${{ matrix.actions.name }}
+        runs-on: ubuntu-latest
+
+        steps:
+            -   uses: actions/checkout@v4
+
+            # see https://github.com/shivammathur/setup-php
+            -   uses: shivammathur/setup-php@v2
+                with:
+                    php-version: 8.2
+                    coverage: none
+
+            -   uses: "ramsey/composer-install@v2"
+
+            -   run: ${{ matrix.actions.run }}

bin/handyman.php

@@ -1,7 +1,6 @@
 <?php
 
-// 1. install require-dev
-// WIP...
+declare(strict_types=1);
 
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Input\ArgvInput;

composer-dependency-analyser.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use ShipMonk\ComposerDependencyAnalyser\Config\Configuration;
+use ShipMonk\ComposerDependencyAnalyser\Config\ErrorType;
+
+$configuration = new Configuration();
+
+// available transitionally via phpstan, to keep compatible version
+return $configuration->ignoreErrorsOnPackage('nikic/php-parser', [ErrorType::DEV_DEPENDENCY_IN_PROD]);

composer.json

@@ -1,6 +1,7 @@
 {
     "name": "tomasvotruba/handyman",
     "type": "phpstan-extension",
+    "license": "MIT",
     "description": "Automate repeated steps when coming to a PHP project or create new package",
     "require": {
         "php": "^8.2",
@@ -9,7 +10,8 @@
         "symfony/process": "^7.1",
         "symfony/finder": "^7.1",
         "nette/utils": "^4.0",
-        "phpstan/phpstan": "^1.12"
+        "phpstan/phpstan": "^1.12",
+        "webmozart/assert": "^1.11"
     },
     "require-dev": {
         "rector/rector": "^1.2",
@@ -20,7 +22,7 @@
         "symplify/easy-coding-standard": "^12.3",
         "shipmonk/composer-dependency-analyser": "^1.7",
         "tomasvotruba/type-coverage": "^1.0",
-        "tomasvotruba/class-leak": "^1.0",
+        "tomasvotruba/class-leak": "^1.1",
         "tomasvotruba/unused-public": "^1.0",
         "tracy/tracy": "^2.10",
         "nikic/php-parser": "^4.19"

phpunit.xml

@@ -9,6 +9,7 @@
     <testsuites>
         <testsuite name="main">
             <directory>tests</directory>
+            <exclude>tests/PHPStan/Rule/PublicStaticDataProviderRule/Fixture</exclude>
         </testsuite>
     </testsuites>
 </phpunit>

src/Command/GithubCommand.php

@@ -4,12 +4,12 @@
 
 namespace TomasVotruba\Handyman\Command;
 
-use Nette\Utils\FileSystem;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use TomasVotruba\Handyman\FileSystem\TemplateFileSystem;
+use TomasVotruba\Handyman\ValueObject\ComposerJson;
 
 final class GithubCommand extends Command
 {
@@ -27,17 +27,22 @@ protected function configure(): void
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $codeAnalysisFilePath = getcwd() . '/.github/workflows/code-analysis.yaml';
-        if (! file_exists($codeAnalysisFilePath)) {
-            $fileContents = TemplateFileSystem::renderFilePathWithVariables(
-                __DIR__ . '/../../templates/github-workflows/code-analysis.yaml',
-                []
+        $projectFilePath = getcwd() . '/.github/workflows/code-analysis.yaml';
+
+        if (! file_exists($projectFilePath)) {
+            $projectComposerJson = new ComposerJson(getcwd() . '/composer.json');
+
+            TemplateFileSystem::renderFilePathWithVariables(
+                __DIR__ . '/../../templates/.github/workflows/code_analysis.yaml',
+                [
+                    '__PHP_VERSION__' => $projectComposerJson->getPhpVersionString(),
+                ],
+                $projectFilePath
             );
 
-            FileSystem::write($codeAnalysisFilePath, $fileContents);
-            $this->symfonyStyle->success('Created .github/workflows/code-analysis.yaml');
+            $this->symfonyStyle->success('Created .github/workflows/code_analysis.yaml');
         } else {
-            $this->symfonyStyle->success('Config .github/workflows/code-analysis.yaml already exists');
+            $this->symfonyStyle->success('Config .github/workflows/code_analysis.yaml already exists');
         }
 
         return self::SUCCESS;

src/FileSystem/TemplateFileSystem.php

@@ -5,15 +5,28 @@
 namespace TomasVotruba\Handyman\FileSystem;
 
 use Nette\Utils\FileSystem;
+use Webmozart\Assert\Assert;
 
 final class TemplateFileSystem
 {
     /**
      * @param array<string, string|float|int|null> $variables
      */
-    public static function renderFilePathWithVariables(string $sourceFilePath, array $variables): string
-    {
-        $fileContents = FileSystem::read($sourceFilePath);
-        return str_replace(array_keys($variables), array_values($variables), $fileContents);
+    public static function renderFilePathWithVariables(
+        string $sourceFilePath,
+        array $variables,
+        ?string $targetFilePath = null
+    ): string {
+        Assert::fileExists($sourceFilePath);
+
+        $templateContents = FileSystem::read($sourceFilePath);
+        $fileContents = str_replace(array_keys($variables), array_values($variables), $templateContents);
+
+        // save file contents directly
+        if (is_string($targetFilePath)) {
+            FileSystem::write($targetFilePath, $fileContents);
+        }
+
+        return $fileContents;
     }
 }

src/ValueObject/ComposerJson.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TomasVotruba\Handyman\ValueObject;
+
+use Nette\Utils\FileSystem;
+use Nette\Utils\Json;
+use Nette\Utils\Strings;
+use Webmozart\Assert\Assert;
+
+final class ComposerJson
+{
+    private string $composerJsonFilePath;
+
+    /**
+     * @var array<string, mixed>
+     */
+    private array $json = [];
+
+    public function __construct(string $composerJsonFilePath)
+    {
+        Assert::fileExists($composerJsonFilePath);
+        $this->composerJsonFilePath = $composerJsonFilePath;
+
+        $this->json = Json::decode(FileSystem::read($this->composerJsonFilePath), true);
+    }
+
+    public function getPhpVersionString(): string
+    {
+        $requirePhp = $this->json['require']['php'] ?? null;
+        Assert::string($requirePhp);
+
+        $match = Strings::match($requirePhp, '#(?<version>\d\.\d)#');
+        Assert::isArray($match);
+        Assert::keyExists($match, 'version');
+
+        return $match['version'];
+    }
+}

stubs/Doctrine/ORM/EntityManager.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Doctrine\ORM;
+
+if (class_exists(EntityManager::class)) {
+    return;
+}
+
+class EntityManager
+{
+}

stubs/Doctrine/Persistence/ObjectManager.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Doctrine\Persistence;
+
+if (class_exists(ObjectManager::class)) {
+    return;
+}
+
+class ObjectManager
+{
+}

stubs/Symfony/Contracts/Service/Attribute/Required.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Symfony\Contracts\Service\Attribute;
+
+class Required
+{
+
+}

templates/github-workflows/code_analysis.yaml → templates/.github/workflows/code_analysis.yaml

@@ -26,12 +26,16 @@ jobs:
 
                     -
                         name: "Finalize classes"
-                        run: vendor/bin/swiss-knife finalize-classes src tests --dry-run
+                        run: vendor/bin/swiss-knife finalize-classes src tests --dry-run --ansi
 
                     -
                         name: 'Composer dependency Analyser'
                         run: vendor/bin/composer-dependency-analyser
 
+                    -
+                        name: 'Validate Composer'
+                        run: composer validate
+
         name: ${{ matrix.actions.name }}
         runs-on: ubuntu-latest
 

tests/PHPStan/Rule/NoEntityMockingRule/NoEntityMockingRuleTest.php

@@ -20,7 +20,7 @@ public static function provideData(): Iterator
     {
         yield [__DIR__ . '/Fixture/MockingEntity.php', [[NoEntityMockingRule::ERROR_MESSAGE, 12]]];
 
-        yield [__DIR__ . '/Fixture/MockingDocument.php', [[NoEntityMockingRule::ERROR_MESSAGE, 13]]];
+        yield [__DIR__ . '/Fixture/MockingDocument.php', [[NoEntityMockingRule::ERROR_MESSAGE, 12]]];
 
         yield [__DIR__ . '/Fixture/SkipMockingOtherObject.php', []];
     }

tests/PHPStan/Rule/NoEntityMockingRule/Source/SimpleObject.php

@@ -2,6 +2,6 @@
 
 namespace TomasVotruba\Handyman\Tests\PHPStan\Rule\NoEntityMockingRule\Source;
 
-class SimpleObject
+final class SimpleObject
 {
 }

tests/PHPStan/Rule/NoGetRepositoryOutsideServiceRule/Fixture/SkipInRepository.php

@@ -2,10 +2,10 @@
 
 declare(strict_types=1);
 
-namespace PHPStan\Rule\NoGetRepositoryOutsideServiceRule\Fixture;
+namespace TomasVotruba\Handyman\Tests\PHPStan\Rule\NoGetRepositoryOutsideServiceRule\Fixture;
 
 use Doctrine\ORM\EntityManager;
-use PHPStan\Rule\NoGetRepositoryOutsideServiceRule\Source\SomeRandomEntity;
+use TomasVotruba\Handyman\Tests\PHPStan\Rule\NoGetRepositoryOutsideServiceRule\Source\SomeRandomEntity;
 
 final readonly class SkipInRepository
 {

tests/PHPStan/Rule/NoGetRepositoryOutsideServiceRule/NoGetRepositoryOutsideServiceRuleTest.php

@@ -25,7 +25,7 @@ public static function provideData(): Iterator
     {
         yield [__DIR__ . '/Fixture/NonRepositoryUsingEntityManager.php', [[
             NoGetRepositoryOutsideServiceRule::ERROR_MESSAGE,
-            17,
+            18,
         ]]];
 
         yield [__DIR__ . '/Fixture/SkipInRepository.php', []];

tests/PHPStan/Rule/NoGetRepositoryOutsideServiceRule/Source/SomeRandomEntity.php

@@ -1,7 +1,7 @@
 <?php
 
-namespace PHPStan\Rule\NoGetRepositoryOutsideServiceRule\Source;
+namespace TomasVotruba\Handyman\Tests\PHPStan\Rule\NoGetRepositoryOutsideServiceRule\Source;
 
-class SomeRandomEntity
+final class SomeRandomEntity
 {
 }

tests/PHPStan/Rule/NoMockOnlyTestRule/Source/FirstClass.php

@@ -2,6 +2,6 @@
 
 namespace TomasVotruba\Handyman\Tests\PHPStan\Rule\NoMockOnlyTestRule\Source;
 
-class FirstClass
+final class FirstClass
 {
 }

tests/PHPStan/Rule/NoMockOnlyTestRule/Source/SecondClass.php

@@ -2,6 +2,6 @@
 
 namespace TomasVotruba\Handyman\Tests\PHPStan\Rule\NoMockOnlyTestRule\Source;
 
-class SecondClass
+final class SecondClass
 {
 }