Merge pull request #9 from /issues/8

Implemented using autoloader from the project

Author: morozov

phpstan.neon

@@ -1,3 +1,5 @@
 parameters:
 	excludes_analyse:
 		- %currentWorkingDirectory%/tests/fixtures/*
+	ignoreErrors:
+		- '~^Class Dummy not found.$~i'

src/Application.php

@@ -44,7 +44,10 @@ public function run(Command $command, array $args) : int
             return 1;
         }
 
-        $config = (new ConfigLoader())->loadConfig(getcwd());
+        $loader = new ProjectLoader(getcwd());
+        $loader->registerClassLoader();
+
+        $config = $loader->getPhpCodeSnifferConfiguration();
 
         try {
             if ($config !== null) {

src/ConfigLoader.php src/ProjectLoader.phpsrc/ConfigLoader.php renamed to src/ProjectLoader.php

@@ -7,47 +7,88 @@
 /**
  * Configuration loader
  */
-class ConfigLoader
+class ProjectLoader
 {
     /**
-     * @param string $dir Current directory
-     * @return array|null Configuration parameters or NULL if not found
+     * Project root
+     *
+     * @var string|null
+     */
+    private $root;
+
+    /**
+     * Indicates whether Composer configuration was loaded
+     *
+     * @var bool
+     */
+    private $composerConfigurationLoaded = false;
+
+    /**
+     * Composer vendor directory
+     *
+     * @var string
      */
-    public function loadConfig($dir) : ?array
+    private $vendorDirectory = 'vendor';
+
+    /**
+     * @param string $directory Current working directory
+     */
+    public function __construct(string $directory)
     {
-        $path = $this->findComposerConfig($dir);
+        $this->root = $this->findProjectRoot($directory);
+    }
 
-        if ($path === null) {
+    /**
+     * @return array|null Configuration parameters or NULL if not found
+     */
+    public function getPhpCodeSnifferConfiguration() : ?array
+    {
+        if ($this->root === null) {
             return null;
         }
 
-        $composerConfig = $this->loadComposerConfig($path);
-        $vendorDir = $composerConfig['vendor-dir'] ?? 'vendor';
-
-        $path = sprintf('%s/%s/squizlabs/php_codesniffer/CodeSniffer.conf', dirname($path), $vendorDir);
+        $path = sprintf('%s/%s/squizlabs/php_codesniffer/CodeSniffer.conf', $this->root, $this->getVendorDirectory());
 
         if (!file_exists($path)) {
             return null;
         }
 
-        $config = $this->loadPhpCodeSnifferConfig($path);
+        $config = $this->loadPhpCodeSnifferConfiguration($path);
 
         return $this->massageConfig($config, $path);
     }
 
     /**
-     * Finds path of composer.json located in the closest common parent directory
+     * Registers class loader if it's defined in the project
+     */
+    public function registerClassLoader() : void
+    {
+        if ($this->root === null) {
+            return;
+        }
+
+        $path = sprintf('%s/%s/autoload.php', $this->root, $this->getVendorDirectory());
+
+        if (!is_file($path)) {
+            return;
+        }
+
+        require $path;
+    }
+
+    /**
+     * Finds project root by locating composer.json located in the current working directory or its closest parent
      *
-     * @param string $dir Current directory
+     * @param string $dir Current working directory
      * @return string|null
      */
-    private function findComposerConfig(string $dir) : ?string
+    private function findProjectRoot(string $dir) : ?string
     {
         do {
             $path = $dir . '/composer.json';
 
             if (file_exists($path)) {
-                return $path;
+                return $dir;
             }
 
             $prev = $dir;
@@ -57,15 +98,29 @@ private function findComposerConfig(string $dir) : ?string
         return null;
     }
 
+    private function getVendorDirectory() : string
+    {
+        if (!$this->composerConfigurationLoaded) {
+            $config = $this->loadComposerConfiguration();
+
+            if (isset($config['vendor-dir'])) {
+                $this->vendorDirectory = $config['vendor-dir'];
+            }
+
+            $this->composerConfigurationLoaded = true;
+        }
+
+        return $this->vendorDirectory;
+    }
+
     /**
      * Loads composer configuration from the given file
      *
-     * @param string $path File path
      * @return array Configuration parameters
      */
-    private function loadComposerConfig(string $path) : array
+    private function loadComposerConfiguration() : array
     {
-        $contents = file_get_contents($path);
+        $contents = file_get_contents($this->root . '/composer.json');
         $config = json_decode($contents, true);
 
         if (json_last_error() !== JSON_ERROR_NONE) {
@@ -81,7 +136,7 @@ private function loadComposerConfig(string $path) : array
      * @param string $path File path
      * @return array Configuration parameters
      */
-    private function loadPhpCodeSnifferConfig(string $path) : array
+    private function loadPhpCodeSnifferConfiguration(string $path) : array
     {
         $phpCodeSnifferConfig = [];
 

tests/ApplicationTest.php

@@ -5,6 +5,7 @@
 use function chdir;
 use DiffSniffer\Application;
 use DiffSniffer\Command;
+use Dummy;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use const DIRECTORY_SEPARATOR;
@@ -17,7 +18,27 @@ class ApplicationTest extends TestCase
      */
     public function testUseCase(string $useCase, int $expectedExitCode)
     {
-        $dir = __DIR__ . DIRECTORY_SEPARATOR . 'fixtures' . DIRECTORY_SEPARATOR . $useCase;
+        $app = new Application();
+
+        $this->expectOutputString($this->getExpectedOutput($useCase));
+        $exitCode = $app->run($this->createCommand($useCase), [__FILE__]);
+
+        $this->assertSame($expectedExitCode, $exitCode);
+    }
+
+    public function testClassLoader()
+    {
+        $app = new Application();
+
+        $app->run($this->createCommand('class-loader'), [__FILE__]);
+
+        self::assertTrue(class_exists(Dummy::class));
+    }
+
+    private function createCommand(string $useCase) : Command
+    {
+        $dir = $this->getDirectory($useCase);
+
         $changeset = new FixtureChangeset($dir);
         chdir($dir . DIRECTORY_SEPARATOR . 'tree');
 
@@ -26,15 +47,23 @@ public function testUseCase(string $useCase, int $expectedExitCode)
         $command->expects($this->once())
             ->method('createChangeset')
             ->willReturn($changeset);
-        $app = new Application();
 
-        $expectedOutput = file_get_contents($dir . DIRECTORY_SEPARATOR . 'output.txt');
-        $expectedOutput = str_replace("\n", PHP_EOL, $expectedOutput);
+        return $command;
+    }
 
-        $this->expectOutputString($expectedOutput);
-        $exitCode = $app->run($command, [__FILE__]);
+    private function getExpectedOutput(string $useCase) : string
+    {
+        $dir = $this->getDirectory($useCase);
 
-        $this->assertSame($expectedExitCode, $exitCode);
+        $output = file_get_contents($dir . DIRECTORY_SEPARATOR . 'output.txt');
+        $output = str_replace("\n", PHP_EOL, $output);
+
+        return $output;
+    }
+
+    private function getDirectory(string $useCase) : string
+    {
+        return __DIR__ . DIRECTORY_SEPARATOR . 'fixtures' . DIRECTORY_SEPARATOR . $useCase;
     }
 
     public static function useCaseProvider()
@@ -52,6 +81,10 @@ public static function useCaseProvider()
                 'exclude-pattern',
                 1,
             ],
+            'class-loader' => [
+                'class-loader',
+                0,
+            ],
         ];
     }
 }

tests/ConfigLoaderTest.php tests/ProjectLoaderTest.phptests/ConfigLoaderTest.php renamed to tests/ProjectLoaderTest.php

@@ -2,32 +2,26 @@
 
 namespace DiffSniffer\Tests;
 
-use DiffSniffer\ConfigLoader;
+use DiffSniffer\ProjectLoader;
 use DiffSniffer\Exception;
 use PHPUnit\Framework\TestCase;
 use VirtualFileSystem\FileSystem;
 
 /**
- * @covers \DiffSniffer\ConfigLoader
+ * @covers \DiffSniffer\ProjectLoader
  */
-class ConfigLoaderTest extends TestCase
+class ProjectLoaderTest extends TestCase
 {
     /**
      * @var FileSystem
      */
     private $fs;
 
-    /**
-     * @var ConfigLoader
-     */
-    private $loader;
-
     protected function setUp() : void
     {
         parent::setUp();
 
         $this->fs = new FileSystem();
-        $this->loader = new ConfigLoader();
     }
 
     /**
@@ -38,7 +32,9 @@ public function success(array $structure, string $dir, array $expected)
     {
         $this->fs->createStructure($structure);
         $dir = $this->fs->path($dir);
-        $config = $this->loader->loadConfig($dir);
+
+        $loader = new ProjectLoader($dir);
+        $config = $loader->getPhpCodeSnifferConfiguration();
 
         if (isset($expected['installed_paths'])) {
             $expected['installed_paths'] = implode(',', array_map(function ($path) {
@@ -114,7 +110,9 @@ public function notFound(array $structure, string $dir)
     {
         $this->fs->createStructure($structure);
         $dir = $this->fs->path($dir);
-        $config = $this->loader->loadConfig($dir);
+
+        $loader = new ProjectLoader($dir);
+        $config = $loader->getPhpCodeSnifferConfiguration();
 
         $this->assertNull($config);
     }
@@ -149,8 +147,10 @@ public function failure(array $structure, string $dir)
         $this->fs->createStructure($structure);
         $dir = $this->fs->path($dir);
 
+        $loader = new ProjectLoader($dir);
+
         $this->expectException(Exception::class);
-        $this->loader->loadConfig($dir);
+        $loader->getPhpCodeSnifferConfiguration();
     }
 
     public static function failureProvider() : array

tests/fixtures/class-loader/changeset.diff

@@ -0,0 +1,5 @@
+<?php
+
+class Dummy
+{
+}

tests/fixtures/class-loader/output.txt

@@ -0,0 +1,3 @@
+{
+  "vendor-dir": "dependencies"
+}

tests/fixtures/class-loader/tree/Dummy.php

@@ -0,0 +1,7 @@
+<?php
+
+spl_autoload_register(function (string $class) : void {
+    if ($class === Dummy::class) {
+        require __DIR__ . '/../Dummy.php';
+    }
+});