Merge remote-tracking branch 'upstream/master'

50bhan · 50bhan · commit 7bcf05e56b9d · 2020-05-10T10:47:17.000+04:30
* upstream/master: Feature/syntax check (nunomaduro#373) Fix display detail message without file (nunomaduro#404) Fix nunomaduro#401 (nunomaduro#402) Update doc (add phpunit upgrade command) (nunomaduro#399)
diff --git a/composer.json b/composer.json
@@ -20,6 +20,7 @@
         "justinrainbow/json-schema": "^5.1",
         "league/container": "^3.2",
         "object-calisthenics/phpcs-calisthenics-rules": "^3.7",
+        "php-parallel-lint/php-parallel-lint": "^1.1",
         "phploc/phploc": "^5.0|^6.0",
         "psr/container": "^1.0",
         "sensiolabs/security-checker": "^6.0",
diff --git a/docs/insights/style.md b/docs/insights/style.md
@@ -179,12 +179,20 @@ This sniff ensures the `PHP_SAPI` constant is used instead of `php_sapi_name()`.
 
 **Insight Class**: `PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\SAPIUsageSniff`
 
-## Syntax <Badge text="^1.0"/> <Badge text="Style" type="warn"/>
+## Syntax <Badge text="^1.0"/> <Badge text="Style" type="warn"/> <Badge text="Deprecated since 2.0" type="error"/>
 
 This sniff ensures PHP believes the syntax is clean.
 
 **Insight Class**: `PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\SyntaxSniff`
 
+> Note: This sniff is deprecated, use insight below
+
+## Syntax Check <Badge text="^2.0"/> <Badge text="Style" type="warn"/>
+
+This Insight process lint on all PHP files via `php -l` using [PHP-Parallel-Lint](https://github.com/php-parallel-lint/PHP-Parallel-Lint).
+
+**Insight Class**: `NunoMaduro\PhpInsights\Domain\Insights\SyntaxCheck`
+
 ## Trailing array comma <Badge text="^1.0"/> <Badge text="Style" type="warn"/>
 
 This sniff enforces trailing commas in multi-line arrays and requires short array syntax `[]`.
diff --git a/src/Application/Console/Formatters/Console.php b/src/Application/Console/Formatters/Console.php
@@ -586,8 +586,10 @@ private function formatFileLine(Details $detail, string $category, string $commo
             $formattedLink = $this->fileLinkFormatter->format($file, $detail->getLine());
         }
 
-        $color = $this->getCategoryColor($category);
-        $detailString = sprintf('<fg=%s>%s</>', $color, $detailString);
+        if ($detailString !== '') {
+            $color = $this->getCategoryColor($category);
+            $detailString = sprintf('<fg=%s>%s</>', $color, $detailString);
+        }
 
         if ($this->supportHyperLinks &&
             $formattedLink !== '' &&
diff --git a/src/Application/Injectors/InsightLoaders.php b/src/Application/Injectors/InsightLoaders.php
@@ -5,6 +5,7 @@
 namespace NunoMaduro\PhpInsights\Application\Injectors;
 
 use NunoMaduro\PhpInsights\Domain\InsightLoader\FixerLoader;
+use NunoMaduro\PhpInsights\Domain\InsightLoader\InsightLoader;
 use NunoMaduro\PhpInsights\Domain\InsightLoader\SniffLoader;
 
 /**
@@ -20,6 +21,7 @@ final class InsightLoaders
     public function __invoke(): array
     {
         return [
+            InsightLoader::class => static fn (): InsightLoader => new InsightLoader(),
             SniffLoader::class => static fn (): SniffLoader => new SniffLoader(),
             FixerLoader::class => static fn (): FixerLoader => new FixerLoader(),
         ];
diff --git a/src/Domain/Contracts/GlobalInsight.php b/src/Domain/Contracts/GlobalInsight.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NunoMaduro\PhpInsights\Domain\Contracts;
+
+/**
+ * @internal
+ */
+interface GlobalInsight extends Insight
+{
+    /**
+     * Launch Insight inspection.
+     */
+    public function process(): void;
+}
diff --git a/src/Domain/Contracts/InsightLoader.php b/src/Domain/Contracts/InsightLoader.php
@@ -4,6 +4,8 @@
 
 namespace NunoMaduro\PhpInsights\Domain\Contracts;
 
+use NunoMaduro\PhpInsights\Domain\Collector;
+
 /**
  * @internal
  */
@@ -21,5 +23,5 @@ public function support(string $insightClass): bool;
      *
      * @param array<string, int|string|array> $config Related to $insightClass
      */
-    public function load(string $insightClass, string $dir, array $config): Insight;
+    public function load(string $insightClass, string $dir, array $config, Collector $collector): Insight;
 }
diff --git a/src/Domain/FileFactory.php b/src/Domain/FileFactory.php
@@ -21,9 +21,13 @@ final class FileFactory
     public function __construct()
     {
         $config = new Config([], false);
+        // disable loading custom ruleset
+        $config->restoreDefaults();
         $config->__set('tabWidth', 4);
         $config->__set('annotations', false);
         $config->__set('encoding', 'UTF-8');
+        // Include only 1 sniff, they are register later
+        $config->__set('sniffs', ['Generic.Files.LineEndings']);
 
         $this->config = $config;
         $this->ruleset = new Ruleset($this->config);
diff --git a/src/Domain/InsightLoader/FixerLoader.php b/src/Domain/InsightLoader/FixerLoader.php
@@ -4,6 +4,7 @@
 
 namespace NunoMaduro\PhpInsights\Domain\InsightLoader;
 
+use NunoMaduro\PhpInsights\Domain\Collector;
 use NunoMaduro\PhpInsights\Domain\Contracts\Insight;
 use NunoMaduro\PhpInsights\Domain\Contracts\InsightLoader;
 use NunoMaduro\PhpInsights\Domain\Insights\FixerDecorator;
@@ -20,7 +21,7 @@ public function support(string $insightClass): bool
         return array_key_exists(FixerInterface::class, class_implements($insightClass));
     }
 
-    public function load(string $insightClass, string $dir, array $config): Insight
+    public function load(string $insightClass, string $dir, array $config, Collector $collector): Insight
     {
         $fixer = new $insightClass();
 
diff --git a/src/Domain/InsightLoader/InsightLoader.php b/src/Domain/InsightLoader/InsightLoader.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NunoMaduro\PhpInsights\Domain\InsightLoader;
+
+use NunoMaduro\PhpInsights\Domain\Collector;
+use NunoMaduro\PhpInsights\Domain\Contracts\Insight;
+use NunoMaduro\PhpInsights\Domain\Contracts\InsightLoader as LoaderContract;
+
+/**
+ * @internal
+ */
+final class InsightLoader implements LoaderContract
+{
+    public function support(string $insightClass): bool
+    {
+        return array_key_exists(Insight::class, class_implements($insightClass));
+    }
+
+    public function load(string $insightClass, string $dir, array $config, Collector $collector): Insight
+    {
+        return new $insightClass($collector, $config);
+    }
+}
diff --git a/src/Domain/InsightLoader/SniffLoader.php b/src/Domain/InsightLoader/SniffLoader.php
@@ -4,6 +4,7 @@
 
 namespace NunoMaduro\PhpInsights\Domain\InsightLoader;
 
+use NunoMaduro\PhpInsights\Domain\Collector;
 use NunoMaduro\PhpInsights\Domain\Contracts\Insight;
 use NunoMaduro\PhpInsights\Domain\Contracts\InsightLoader;
 use NunoMaduro\PhpInsights\Domain\Insights\SniffDecorator;
@@ -19,7 +20,7 @@ public function support(string $insightClass): bool
         return array_key_exists(SniffContract::class, class_implements($insightClass));
     }
 
-    public function load(string $insightClass, string $dir, array $config): Insight
+    public function load(string $insightClass, string $dir, array $config, Collector $collector): Insight
     {
         /** @var SniffContract $sniff */
         $sniff = new $insightClass();
diff --git a/src/Domain/Insights/InsightCollectionFactory.php b/src/Domain/Insights/InsightCollectionFactory.php
@@ -59,22 +59,13 @@ public function get(array $metrics, OutputInterface $consoleOutput): InsightColl
             $insightsClasses = [...$insightsClasses, ...$this->getInsights($metricClass)];
         }
 
-        $insightFactory = new InsightFactory($this->filesRepository, $insightsClasses, $this->config);
+        $insightFactory = new InsightFactory($this->filesRepository, $insightsClasses, $this->config, $collector);
         $insightsForCollection = [];
 
         foreach ($metrics as $metricClass) {
             $insightsForCollection[$metricClass] = array_map(
-                function (string $insightClass) use ($insightFactory, $collector, $consoleOutput) {
-                    if (! array_key_exists(Insight::class, class_implements($insightClass))) {
-                        return $insightFactory->makeFrom(
-                            $insightClass,
-                            $consoleOutput
-                        );
-                    }
-
-                    return new $insightClass($collector, $this->config->getConfigForInsight($insightClass));
-                },
-                $this->getInsights($metricClass),
+                static fn (string $insightClass): Insight => $insightFactory->makeFrom($insightClass, $consoleOutput),
+                $this->getInsights($metricClass)
             );
         }
 
diff --git a/src/Domain/Insights/InsightFactory.php b/src/Domain/Insights/InsightFactory.php
@@ -5,6 +5,7 @@
 namespace NunoMaduro\PhpInsights\Domain\Insights;
 
 use Exception;
+use NunoMaduro\PhpInsights\Domain\Collector;
 use NunoMaduro\PhpInsights\Domain\Configuration;
 use NunoMaduro\PhpInsights\Domain\Container;
 use NunoMaduro\PhpInsights\Domain\Contracts\Insight as InsightContract;
@@ -42,17 +43,20 @@ final class InsightFactory
 
     private bool $ran = false;
 
+    private Collector $collector;
+
     /**
      * Creates a new instance of Insight Factory.
      *
      * @param array<string> $insightsClasses
      */
-    public function __construct(FilesRepository $filesRepository, array $insightsClasses, Configuration $config)
+    public function __construct(FilesRepository $filesRepository, array $insightsClasses, Configuration $config, Collector $collector)
     {
         $this->filesRepository = $filesRepository;
         $this->insightsClasses = $insightsClasses;
         $this->insightLoaders = Container::make()->get(InsightLoader::INSIGHT_LOADER_TAG);
         $this->config = $config;
+        $this->collector = $collector;
     }
 
     /**
@@ -114,7 +118,8 @@ private function loadInsights(array $insights): array
                     $insightsAdded[] = $loader->load(
                         $insight,
                         $path,
-                        $this->config->getConfigForInsight($insight)
+                        $this->config->getConfigForInsight($insight),
+                        $this->collector
                     );
                 }
             }
diff --git a/src/Domain/Insights/SyntaxCheck.php b/src/Domain/Insights/SyntaxCheck.php
@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+namespace NunoMaduro\PhpInsights\Domain\Insights;
+
+use NunoMaduro\PhpInsights\Domain\Contracts\GlobalInsight;
+use NunoMaduro\PhpInsights\Domain\Contracts\HasDetails;
+use NunoMaduro\PhpInsights\Domain\Details;
+use PHP_CodeSniffer\Config;
+use Symfony\Component\Process\Process;
+
+/**
+ * @internal
+ */
+final class SyntaxCheck extends Insight implements HasDetails, GlobalInsight
+{
+    /** @var array<Details> */
+    private array $details = [];
+
+    public function getTitle(): string
+    {
+        return 'Syntax Check';
+    }
+
+    public function hasIssue(): bool
+    {
+        return count($this->details) > 0;
+    }
+
+    public function getDetails(): array
+    {
+        return $this->details;
+    }
+
+    public function process(): void
+    {
+        $phpPath = (string) Config::getExecutablePath('php');
+        $filesToAnalyse = array_map(
+            static fn (string $file): string => escapeshellarg($file),
+            $this->filterFilesWithoutExcluded($this->collector->getFiles())
+        );
+
+        $cmdLine = sprintf(
+            '%s %s --no-colors --no-progress --json %s',
+            escapeshellcmd($phpPath),
+            escapeshellarg(dirname(__DIR__, 3) . '/vendor/bin/parallel-lint'),
+            implode(' ', $filesToAnalyse)
+        );
+
+        $process = Process::fromShellCommandline($cmdLine);
+        $process->run();
+        $output = json_decode($process->getOutput(), true);
+        $errors = $output['results']['errors'] ?? [];
+
+        foreach ($errors as $error) {
+            if (preg_match('/^.*error:(.*) in .* on line [\d]+/m', $error['message'], $matches) === 1) {
+                $this->details[] = Details::make()
+                    ->setFile($error['file'])
+                    ->setLine($error['line'])
+                    ->setMessage('PHP syntax error: ' . trim($matches[1]));
+            }
+        }
+    }
+}
diff --git a/src/Domain/Metrics/Style/Style.php b/src/Domain/Metrics/Style/Style.php
@@ -5,6 +5,7 @@
 namespace NunoMaduro\PhpInsights\Domain\Metrics\Style;
 
 use NunoMaduro\PhpInsights\Domain\Contracts\HasInsights;
+use NunoMaduro\PhpInsights\Domain\Insights\SyntaxCheck;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\DisallowLongArraySyntaxSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\Files\ByteOrderMarkSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineEndingsSniff;
@@ -21,7 +22,6 @@
 use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\LowerCaseKeywordSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\LowerCaseTypeSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\SAPIUsageSniff;
-use PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\SyntaxSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\VersionControl\GitMergeConflictSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\ArbitraryParenthesesSpacingSniff;
 use PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\DisallowTabIndentSniff;
@@ -97,6 +97,7 @@ final class Style implements HasInsights
     public function getInsights(): array
     {
         return [
+            SyntaxCheck::class,
             ClosingTagSniff::class,
             EndFileNewlineSniff::class,
             SideEffectsSniff::class,
@@ -123,7 +124,6 @@ public function getInsights(): array
             LowerCaseKeywordSniff::class,
             LowerCaseTypeSniff::class,
             SAPIUsageSniff::class,
-            SyntaxSniff::class,
             TrailingArrayCommaSniff::class,
             ArbitraryParenthesesSpacingSniff::class,
             DisallowTabIndentSniff::class,
diff --git a/src/Domain/Runner.php b/src/Domain/Runner.php
@@ -5,6 +5,7 @@
 namespace NunoMaduro\PhpInsights\Domain;
 
 use NunoMaduro\PhpInsights\Domain\Contracts\FileProcessor as FileProcessorContract;
+use NunoMaduro\PhpInsights\Domain\Contracts\GlobalInsight;
 use NunoMaduro\PhpInsights\Domain\Contracts\Repositories\FilesRepository;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -29,6 +30,9 @@ final class Runner
 
     private FilesRepository $filesRepository;
 
+    /** @var array<\NunoMaduro\PhpInsights\Domain\Contracts\GlobalInsight|\NunoMaduro\PhpInsights\Domain\Contracts\Insight> */
+    private array $globalInsights = [];
+
     public function __construct(OutputInterface $output, FilesRepository $filesRepository)
     {
         $this->filesRepository = $filesRepository;
@@ -44,9 +48,14 @@ public function __construct(OutputInterface $output, FilesRepository $filesRepos
      */
     public function addInsights(array $insights): void
     {
-        /** @var FileProcessorContract $fileProcessor */
-        foreach ($this->filesProcessors as $fileProcessor) {
-            foreach ($insights as $insight) {
+        foreach ($insights as $insight) {
+            if ($insight instanceof GlobalInsight) {
+                $this->globalInsights[] = $insight;
+                continue;
+            }
+
+            /** @var FileProcessorContract $fileProcessor */
+            foreach ($this->filesProcessors as $fileProcessor) {
                 if ($fileProcessor->support($insight)) {
                     $fileProcessor->addChecker($insight);
                 }
@@ -65,10 +74,21 @@ public function run(): void
         }
 
         // Create progress bar
-        $progressBar = $this->createProgressBar(count($files));
+        $progressBar = $this->createProgressBar(count($files) + count($this->globalInsights));
         $progressBar->setMessage('');
         $progressBar->start();
 
+        /** @var GlobalInsight $insight */
+        foreach ($this->globalInsights as $insight) {
+            if ($this->output->isVerbose()) {
+                $progressBar->setMessage(' - Global: ' . $insight->getTitle());
+                $progressBar->display();
+            }
+
+            $insight->process();
+            $progressBar->advance();
+        }
+
         /** @var SplFileInfo $file */
         foreach ($files as $file) {
             // Output file name if verbose
diff --git a/tests/Domain/Insights/InsightFactoryTest.php b/tests/Domain/Insights/InsightFactoryTest.php
diff --git a/tests/Domain/Insights/SyntaxCheckTest.php b/tests/Domain/Insights/SyntaxCheckTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace NunoMaduro\PhpInsights\Domain\Contracts;`
`6`	`6`
	`7`	`+use NunoMaduro\PhpInsights\Domain\Collector;`
	`8`	`+`
`7`	`9`	`/**`
`8`	`10`	`* @internal`
`9`	`11`	`*/`
`@@ -21,5 +23,5 @@ public function support(string $insightClass): bool;`
`21`	`23`	`*`
`22`	`24`	`* @param array<string, int\|string\|array> $config Related to $insightClass`
`23`	`25`	`*/`
`24`		`- public function load(string $insightClass, string $dir, array $config): Insight;`
	`26`	`+ public function load(string $insightClass, string $dir, array $config, Collector $collector): Insight;`
`25`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace NunoMaduro\PhpInsights\Domain\InsightLoader;`
`6`	`6`
	`7`	`+use NunoMaduro\PhpInsights\Domain\Collector;`
`7`	`8`	`use NunoMaduro\PhpInsights\Domain\Contracts\Insight;`
`8`	`9`	`use NunoMaduro\PhpInsights\Domain\Contracts\InsightLoader;`
`9`	`10`	`use NunoMaduro\PhpInsights\Domain\Insights\FixerDecorator;`
`@@ -20,7 +21,7 @@ public function support(string $insightClass): bool`
`20`	`21`	`return array_key_exists(FixerInterface::class, class_implements($insightClass));`
`21`	`22`	`}`
`22`	`23`
`23`		`- public function load(string $insightClass, string $dir, array $config): Insight`
	`24`	`+ public function load(string $insightClass, string $dir, array $config, Collector $collector): Insight`
`24`	`25`	`{`
`25`	`26`	`$fixer = new $insightClass();`
`26`	`27`