deps: update symfony dependencies to ^7

.github/workflows/ci.yml

@@ -23,7 +23,7 @@ jobs:
     # uses: shivammathur/setup-php@v2
     - uses: shivammathur/setup-php@2cb9b829437ee246e9b3cac53555a39208ca6d28
       with:
-        php-version: '8.2'
+        php-version: '8.4'
     - uses: actions/checkout@v3
     - name: Cache Composer packages
       id: composer-cache

.gitignore

@@ -2,6 +2,8 @@ composer.phar
 composer.lock
 /vendor/
 
-# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
-# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
-# composer.lock
+.idea
+
+###> friendsofphp/php-cs-fixer ###
+/.php-cs-fixer.cache
+###< friendsofphp/php-cs-fixer ###

.php-cs-fixer.dist.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__ . '/lib')
+    ->in(__DIR__ . '/tests/Unit');
+
+$config = new PhpCsFixer\Config();
+$config->setUnsupportedPhpVersionAllowed(true);
+
+return $config
+    ->setParallelConfig(\PhpCsFixer\Runner\Parallel\ParallelConfigFactory::detect())
+    ->setRules([
+    '@Symfony' => true,
+    '@PSR1' => true,
+    '@PSR2' => true,
+    '@PSR12' => true,
+])->setFinder($finder);

README.md

@@ -57,10 +57,13 @@ $stack->version; // 6.3.0
 // You can also pass an already authenticated Github Client
 $client = new \Github\Client();
 $client->authenticate('some_access_token', null, \Github\AuthMethod::ACCESS_TOKEN);
-$detector = $factory->create();
+$detector = $factory->create($client);
 
 $stack = $detector->getStack('einenlum/private-repo');
 
+// optionally: detect the stack on a specific branch 
+$stack = $detector->getStack('einenlum/private-repo:branch-name');
+
 $stack->type === StackType::SYMFONY;
 $stack->version; // 6.3.0
 ```
@@ -117,6 +120,12 @@ services:
 composer run test
 ```
 
+## Run interactive shell with docker
+
+```shell
+docker run --rm -it -v "$PWD":/app -w /app  php:8.4-cli bash
+```
+
 ## Contribute
 
 Each stack has its own Detector implementing a [StackDetectorInterface](src/StackDetectorInterface.php).

composer.json

@@ -21,20 +21,25 @@
     ],
     "require-dev": {
         "phpunit/phpunit": "^10.4",
-        "phpstan/phpstan": "^1.10"
+        "phpstan/phpstan": "^2.1",
+        "friendsofphp/php-cs-fixer": "^3.82"
     },
     "require": {
+        "php": "^8.4",
         "einenlum/composer-version-parser": "^1.0",
         "knplabs/github-api": "^3.12",
-        "symfony/http-client": "^6.3",
+        "symfony/http-client": "^7.0",
         "nyholm/psr7": "^1.8"
     },
     "scripts": {
         "unit-test": "phpunit tests",
         "static-analysis": "phpstan",
+        "test-cs": "./vendor/bin/php-cs-fixer fix --dry-run --diff -v",
+        "test-cs-fix": "./vendor/bin/php-cs-fixer fix --diff -v",
         "test": [
-            "@unit-test",
-            "@static-analysis"
+            "@test-cs",
+            "@static-analysis",
+            "@unit-test"
         ]
     },
     "config": {

lib/Composer/ComposerConfig.php

@@ -4,7 +4,7 @@
 
 namespace Einenlum\PhpStackDetector\Composer;
 
-class ComposerConfig
+readonly class ComposerConfig
 {
     /** @param array<string, mixed> $content */
     public function __construct(public ComposerConfigType $type, public array $content)

lib/Composer/ComposerConfigProvider.php

@@ -14,7 +14,7 @@ class ComposerConfigProvider
     private array $cache = [];
 
     public function __construct(
-        private AdapterInterface $adapter
+        private readonly AdapterInterface $adapter,
     ) {
     }
 
@@ -93,7 +93,7 @@ private function getConfig(string $baseUri, ?string $subDirectory, string $filen
     private function setToCache(
         string $baseUri,
         ?string $subDirectory,
-        ?ComposerConfig $config
+        ?ComposerConfig $config,
     ): void {
         $cacheKey = $this->getCacheKey($baseUri, $subDirectory);
 
@@ -116,6 +116,6 @@ private function getFromCache(string $baseUri, ?string $subDirectory): ?Composer
 
     private function getCacheKey(string $baseUri, ?string $subDirectory): string
     {
-        return $baseUri . $subDirectory;
+        return $baseUri.$subDirectory;
     }
 }

lib/Composer/PackageVersion.php

@@ -6,18 +6,18 @@
 
 use Einenlum\ComposerVersionParser\Parser;
 
-class PackageVersion
+readonly class PackageVersion
 {
     public function __construct(
         private ?string $requirement,
-        private ?string $version
+        private ?string $version,
     ) {
     }
 
     public function getVersion(): ?string
     {
-        if ($this->version !== null) {
-            if (mb_strpos($this->version, 'v') === 0) {
+        if (null !== $this->version) {
+            if (0 === mb_strpos($this->version, 'v')) {
                 return mb_substr($this->version, 1);
             }
 
@@ -26,8 +26,11 @@ public function getVersion(): ?string
 
         /** @var string $requirement */
         $requirement = $this->requirement;
-        $parser = new Parser();
 
-        return $parser->parse($requirement);
+        if (str_starts_with($requirement, '~v')) {
+            $requirement =  mb_substr($requirement, 2);
+        }
+
+        return new Parser()->parse($requirement);
     }
 }

lib/Composer/PackageVersionProvider.php

@@ -4,28 +4,26 @@
 
 namespace Einenlum\PhpStackDetector\Composer;
 
-use Einenlum\PhpStackDetector\DirectoryCrawler\AdapterInterface;
-
-class PackageVersionProvider
+readonly class PackageVersionProvider
 {
     public function __construct(private ComposerConfigProvider $configProvider)
     {
     }
 
     /**
-     * @param string ...$packageNames A list of packages to check in that order
+     * @param string[] $packageNames A list of packages to check in that order
      */
     public function getVersionForPackage(
         string $baseUri,
         ?string $subDirectory,
-        string ...$packageNames
+        array $packageNames,
     ): ?PackageVersion {
         $config = $this->configProvider->getComposerConfig($baseUri, $subDirectory);
         if (null === $config) {
             return null;
         }
 
-        if ($config->type === ComposerConfigType::LOCK) {
+        if (ComposerConfigType::LOCK === $config->type) {
             foreach ($packageNames as $packageName) {
                 foreach ($config->content['packages'] as $package) {
                     if ($package['name'] === $packageName) {

lib/DependencyTree.php

@@ -4,17 +4,27 @@
 
 namespace Einenlum\PhpStackDetector;
 
+use Einenlum\PhpStackDetector\StackDetector\LunarDetector;
+use Einenlum\PhpStackDetector\StackDetector\OctoberCMSDetector;
+use Einenlum\PhpStackDetector\StackDetector\StatamicDetector;
+use Einenlum\PhpStackDetector\StackDetector\TwillDetector;
+use Einenlum\PhpStackDetector\StackDetector\WinterCMSDetector;
+
 class DependencyTree
 {
-    public const EXCLUSION_LIST = [
+    public const array CHILDREN_STACKS = [
         'laravel/framework' => [
-            'statamic/cms',
+            StatamicDetector::PACKAGE_NAME,
+            OctoberCMSDetector::PACKAGE_NAME,
+            LunarDetector::PACKAGE_NAME,
+            TwillDetector::PACKAGE_NAME,
+            WinterCMSDetector::PACKAGE_NAME,
         ],
     ];
 
     /** @return string[] */
-    public static function skipIfThesePackagesArePresent(string $packageName): array
+    public static function getChildStacksForPackage(string $packageName): array
     {
-        return self::EXCLUSION_LIST[$packageName] ?? [];
+        return self::CHILDREN_STACKS[$packageName] ?? [];
     }
 }

lib/Detector.php

@@ -4,17 +4,7 @@
 
 namespace Einenlum\PhpStackDetector;
 
-use Einenlum\PhpStackDetector\Composer\ComposerConfigProvider;
-use Einenlum\PhpStackDetector\DirectoryCrawler\AdapterInterface;
-use Einenlum\PhpStackDetector\DirectoryCrawler\GithubAdapter;
-use Einenlum\PhpStackDetector\StackDetector\CraftCMSDetector;
-use Einenlum\PhpStackDetector\StackDetector\LaravelDetector;
-use Einenlum\PhpStackDetector\StackDetector\StatamicDetector;
-use Einenlum\PhpStackDetector\StackDetector\SymfonyDetector;
-use Einenlum\PhpStackDetector\StackDetector\WordpressDetector;
-use Github\Client;
-
-class Detector
+readonly class Detector
 {
     /** @param StackDetectorInterface[] $stackDetectors */
     public function __construct(private array $stackDetectors)
@@ -23,11 +13,11 @@ public function __construct(private array $stackDetectors)
 
     /**
      * @param string $baseUri The base URI of the project, e.g.
-     *     /some/path/to/local/project
-     *     or
-     *     symfony/demo for a remote Github repository
-     *     or
-     *     symfony/demo:v1.1 for a remote Github repository with a reference
+     *                        /some/path/to/local/project
+     *                        or
+     *                        symfony/demo for a remote Github repository
+     *                        or
+     *                        symfony/demo:v1.1 for a remote Github repository with a reference
      */
     public function getStack(string $baseUri, ?string $subFolder = null): ?Stack
     {
@@ -36,7 +26,7 @@ public function getStack(string $baseUri, ?string $subFolder = null): ?Stack
         foreach ($this->stackDetectors as $stackDetector) {
             $stack = $stackDetector->getStack($baseUri, $subFolder);
 
-            if ($stack !== null) {
+            if (null !== $stack) {
                 return $stack;
             }
         }
@@ -46,10 +36,10 @@ public function getStack(string $baseUri, ?string $subFolder = null): ?Stack
 
     private function cleanSubFolder(?string $subFolder): ?string
     {
-        if ($subFolder === null) {
+        if (null === $subFolder) {
             return null;
         }
 
-        return trim($subFolder) === '/' ? null : $subFolder;
+        return '/' === trim($subFolder) ? null : $subFolder;
     }
 }

lib/DirectoryCrawler/AdapterInterface.php

@@ -13,6 +13,6 @@ public function getFileContent(string $baseUri, ?string ...$pathTree): string;
 
     public function directoryExists(string $baseUri, ?string ...$pathTree): bool;
 
-    /** @return array<int, null|string> */
+    /** @return array<int, string|null> */
     public function listFilesInDirectory(string $baseUri, ?string ...$pathTree): array;
 }

lib/DirectoryCrawler/FilesystemAdapter.php

@@ -8,7 +8,6 @@
 
 class FilesystemAdapter implements AdapterInterface
 {
-    /** {@inheritdoc} */
     public function getFileContent(string $baseUri, ?string ...$pathTree): string
     {
         $fullUri = $this->getFullUri($baseUri, $pathTree);
@@ -31,7 +30,6 @@ public function directoryExists(string $baseUri, ?string ...$pathTree): bool
         return is_dir($fullUri);
     }
 
-    /** {@inheritdoc} */
     public function listFilesInDirectory(string $baseUri, ?string ...$pathTree): array
     {
         if (!$this->directoryExists($baseUri, ...$pathTree)) {
@@ -46,7 +44,7 @@ public function listFilesInDirectory(string $baseUri, ?string ...$pathTree): arr
         return array_values(array_diff($files, ['..', '.']));
     }
 
-    /** @param (null|string)[] $pathTree */
+    /** @param (string|null)[] $pathTree */
     private function getFullUri(string $baseUri, array $pathTree): string
     {
         $pathTree = array_filter($pathTree);

lib/DirectoryCrawler/GithubAdapter.php

@@ -8,10 +8,10 @@
 use Github\Client;
 use Github\Exception\RuntimeException;
 
-class GithubAdapter implements AdapterInterface
+readonly class GithubAdapter implements AdapterInterface
 {
     /*
-     * If you need to check private repositories, the client should aleady
+     * If you need to check private repositories, the client should already
      * be authenticated.
      */
     public function __construct(private Client $client)
@@ -91,7 +91,6 @@ public function listFilesInDirectory(string $baseUri, ?string ...$pathTree): arr
         );
     }
 
-
     /**
      * @return array{organization: string, repository: string, reference: ?string}
      */
@@ -113,7 +112,7 @@ private function splitBaseUri(string $baseUri): array
         ];
     }
 
-    /** @param (null|string)[] $pathTree */
+    /** @param (string|null)[] $pathTree */
     private function getPathTreeAsString(array $pathTree): string
     {
         $paths = array_filter($pathTree);

lib/Factory/GithubDetectorFactory.php

@@ -12,9 +12,9 @@ class GithubDetectorFactory
 {
     use HasStackDetectors;
 
-    public function create(Client $client = null): Detector
+    public function create(?Client $client = null): Detector
     {
-        $client = $client ?: new \Github\Client();
+        $client = $client ?: new Client();
         $adapter = new GithubAdapter($client);
 
         $stackDetectors = $this->getStackDetectors($adapter);