Merge pull request #1 from Einenlum/2.x

Version 2

Author: Einenlum

Diff for: .gitignore

@@ -1,4 +1,5 @@
 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

Diff for: README.md

@@ -1,6 +1,6 @@
 # PHP Stack Detector
 
-This library allows to easily detect the PHP stack (Wordpress, Laravel, Symfony…) and the version used, when parsing a directory.
+This library allows to easily detect the PHP stack (Wordpress, Laravel, Symfony…) and the version used, when parsing a directory or ar Github remote repository.
 
 Supported Stacks for now:
 
@@ -24,9 +24,14 @@ composer require einenlum/php-stack-detector
 require_once __DIR__ . '/vendor/autoload.php';
 
 use Einenlum\PhpStackDetector\Detector;
+use Einenlum\PhpStackDetector\Factory\FilesystemDetectorFactory;
+use Einenlum\PhpStackDetector\Factory\GithubDetectorFactory;
 use Einenlum\PhpStackDetector\StackType;
 
-$detector = Detector::create();
+// Local usage
+
+$factory = new FilesystemDetectorFactory();
+$detector = $factory->create();
 $stack = $detector->getStack('/path/to/a/symfony/directory');
 
 $stack->type === StackType::SYMFONY;
@@ -38,16 +43,74 @@ $stack->version; // null
 
 $stack = $detector->getStack('/path/to/an/unknown/stack/directory');
 $stack; // null
+
+// For Github usage
+
+$factory = new GithubDetectorFactory();
+$detector = $factory->create();
+
+$stack = $detector->getStack('symfony/demo');
+
+$stack->type === StackType::SYMFONY;
+$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();
+
+$stack = $detector->getStack('einenlum/private-repo');
+
+$stack->type === StackType::SYMFONY;
+$stack->version; // 6.3.0
 ```
 
 You can also use the CLI to test it.
 
 ```
-php bin/detect.php ~/Prog/php/my_project/
+php bin/detect-local.php ~/Prog/php/my_project/
+Detected stack: laravel
+Version: 10.19.0
+
+php bin/detect-github.php 'symfony/demo'
+Detected stack: symfony
+Version: 6.3.0
+```
+
+It is advised to use an access token for github parsing, to either access private repositories or avoid reaching Github API limit.
+
+```
+GITHUB_ACCESS_TOKEN=my_token php bin/detect-github.php 'einenlum/private-repo'
 Detected stack: laravel
 Version: 10.19.0
 ```
 
+### Usage with Symfony
+
+Declare the factory and the detector in your `services.yaml` file.
+
+For Github:
+
+```yaml
+services:
+    Einenlum\PhpStackDetector\Factory\GithubDetectorFactory: ~
+
+    Einenlum\PhpStackDetector\Detector:
+        factory: ['@Einenlum\PhpStackDetector\Factory\GithubDetectorFactory', 'create']
+        arguments:
+            $client: '@Github\Client'
+```
+
+For local filesystem:
+
+```yaml
+services:
+    Einenlum\PhpStackDetector\Factory\FilesystemDetectorFactory: ~
+
+    Einenlum\PhpStackDetector\Detector:
+        factory: ['@Einenlum\PhpStackDetector\Factory\FilesystemDetectorFactory', 'create']
+```
+
 ## Tests
 
 ```
@@ -58,7 +121,10 @@ composer run test
 
 Each stack has its own Detector implementing a [StackDetectorInterface](src/StackDetectorInterface.php).
 If the stack uses composer you can use the [PackageVersionProvider](src/Composer/PackageVersionProvider.php) class.
+This will use a [ComposerConfigProvider](src/Composer/ComposerConfigProvider.php) to get the lock or the json config.
+
+All of them use an Adapter, that is for now either [FilesystemAdapter](src/DirectoryCrawler/FilesystemAdapter.php) or [GithubAdapter](src/DirectoryCrawler/GithubAdapter.php)
 
-You can add your own StackDetector and then add it to the `create` method of the [Detector](src/Detector.php).
+You can add your own StackDetector and then add it to the `getStackDetectors` method of the [HasStackDetectors](src/Factory/HasStackDetectors.php) trait.
 
 Any Pull Request welcome!

Diff for: bin/detect-github.php

@@ -0,0 +1,36 @@
+<?php
+
+require_once __DIR__ . '/../vendor/autoload.php';
+
+use Einenlum\PhpStackDetector\Detector;
+use Einenlum\PhpStackDetector\Factory\GithubDetectorFactory;
+use Github\AuthMethod;
+
+$factory = new GithubDetectorFactory();
+
+$accessToken = getenv('GITHUB_ACCESS_TOKEN');
+if ($accessToken) {
+    $client = new \Github\Client();
+    $client->authenticate($accessToken, null, AuthMethod::ACCESS_TOKEN);
+    $detector = $factory->create($client);
+} else {
+    $detector = $factory->create();
+}
+
+$directory = $argv[1] ?? null;
+if (null === $directory) {
+    echo 'Please provide a directory to scan' . "\n";
+    exit(1);
+}
+
+$subDirectory = $argv[2] ?? null;
+
+$stack = $detector->getStack($directory, $subDirectory);
+
+if (null === $stack) {
+    echo 'No stack detected' . "\n";
+    exit(0);
+}
+
+echo 'Detected stack: ' . $stack->type->value . "\n";
+echo 'Version: ' . ($stack->version ?: 'Unknown version') . "\n";

Diff for: bin/detect.php renamed to bin/detect-local.php

@@ -2,17 +2,20 @@
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
-use Einenlum\PhpStackDetector\Detector;
+use Einenlum\PhpStackDetector\Factory\FilesystemDetectorFactory;
 
-$detector = Detector::create();
+$factory = new FilesystemDetectorFactory();
+$detector = $factory->create();
 
 $directory = $argv[1] ?? null;
-if (null === $directory || !is_dir($directory)) {
+if (null === $directory) {
     echo 'Please provide a directory to scan' . "\n";
     exit(1);
 }
 
-$stack = $detector->getStack($directory);
+$subDirectory = $argv[2] ?? null;
+
+$stack = $detector->getStack($directory, $subDirectory);
 
 if (null === $stack) {
     echo 'No stack detected' . "\n";

Diff for: composer.json

@@ -24,7 +24,10 @@
         "phpstan/phpstan": "^1.10"
     },
     "require": {
-        "einenlum/composer-version-parser": "^1.0"
+        "einenlum/composer-version-parser": "^1.0",
+        "knplabs/github-api": "^3.12",
+        "symfony/http-client": "^6.3",
+        "nyholm/psr7": "^1.8"
     },
     "scripts": {
         "unit-test": "phpunit tests",
@@ -33,5 +36,10 @@
             "@unit-test",
             "@static-analysis"
         ]
+    },
+    "config": {
+        "allow-plugins": {
+            "php-http/discovery": true
+        }
     }
 }