BC Break: Removed the sources-path argument - from here on, we assume there's a composer.json with an autoload section

This means that your project should (in theory) have a `composer.json` at
its root, and the sources for it will automatically be inferred from the
`composer.json` definition.

Currently, this package declares a `SourceLocator` instance emulating the
`"autoload"` section of a `composer.json` configuration, but later it may
be provided by BetterReflection directly (Roave/BetterReflection#442).

This patch also changes the constructor and default behavior
of `AssertBackwardsCompatible`, so it is a major BC break that requires
a new major release.

Author: Ocramius

bin/roave-backward-compatibility-check.php

@@ -18,12 +18,13 @@
 use Roave\BackwardCompatibility\DetectChanges\BCBreak\TraitBased;
 use Roave\BackwardCompatibility\DetectChanges\Variance\TypeIsContravariant;
 use Roave\BackwardCompatibility\DetectChanges\Variance\TypeIsCovariant;
-use Roave\BackwardCompatibility\Factory\DirectoryReflectorFactory;
+use Roave\BackwardCompatibility\Factory\ComposerInstallationReflectorFactory;
 use Roave\BackwardCompatibility\Git\GetVersionCollectionFromGitRepository;
 use Roave\BackwardCompatibility\Git\GitCheckoutRevisionToTemporaryPath;
 use Roave\BackwardCompatibility\Git\GitParseRevision;
 use Roave\BackwardCompatibility\Git\PickLastMinorVersionFromCollection;
 use Roave\BackwardCompatibility\LocateDependencies\LocateDependenciesViaComposer;
+use Roave\BackwardCompatibility\LocateSources\LocateSourcesViaComposerJson;
 use Roave\BetterReflection\BetterReflection;
 use RuntimeException;
 use Symfony\Component\Console\Application;
@@ -59,7 +60,7 @@
 
     $apiCompareCommand = new Command\AssertBackwardsCompatible(
         new GitCheckoutRevisionToTemporaryPath(),
-        new DirectoryReflectorFactory($astLocator),
+        new ComposerInstallationReflectorFactory(new LocateSourcesViaComposerJson($astLocator)),
         new GitParseRevision(),
         new GetVersionCollectionFromGitRepository(),
         new PickLastMinorVersionFromCollection(),

src/Command/AssertBackwardsCompatible.php

@@ -7,7 +7,7 @@
 use Assert\Assert;
 use Roave\BackwardCompatibility\Changes;
 use Roave\BackwardCompatibility\CompareApi;
-use Roave\BackwardCompatibility\Factory\DirectoryReflectorFactory;
+use Roave\BackwardCompatibility\Factory\ComposerInstallationReflectorFactory;
 use Roave\BackwardCompatibility\Formatter\MarkdownPipedToSymfonyConsoleFormatter;
 use Roave\BackwardCompatibility\Formatter\SymfonyConsoleTextFormatter;
 use Roave\BackwardCompatibility\Git\CheckedOutRepository;
@@ -22,7 +22,6 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Exception\InvalidArgumentException;
 use Symfony\Component\Console\Exception\LogicException;
-use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\ConsoleOutputInterface;
@@ -37,8 +36,8 @@ final class AssertBackwardsCompatible extends Command
     /** @var PerformCheckoutOfRevision */
     private $git;
 
-    /** @var DirectoryReflectorFactory */
-    private $reflectorFactory;
+    /** @var ComposerInstallationReflectorFactory */
+    private $makeComposerInstallationReflector;
 
     /** @var ParseRevision */
     private $parseRevision;
@@ -60,7 +59,7 @@ final class AssertBackwardsCompatible extends Command
      */
     public function __construct(
         PerformCheckoutOfRevision $git,
-        DirectoryReflectorFactory $reflectorFactory,
+        ComposerInstallationReflectorFactory $makeComposerInstallationReflector,
         ParseRevision $parseRevision,
         GetVersionCollection $getVersions,
         PickVersionFromVersionCollection $pickFromVersion,
@@ -69,13 +68,13 @@ public function __construct(
     ) {
         parent::__construct();
 
-        $this->git                = $git;
-        $this->reflectorFactory   = $reflectorFactory;
-        $this->parseRevision      = $parseRevision;
-        $this->getVersions        = $getVersions;
-        $this->pickFromVersion    = $pickFromVersion;
-        $this->locateDependencies = $locateDependencies;
-        $this->compareApi         = $compareApi;
+        $this->git                               = $git;
+        $this->makeComposerInstallationReflector = $makeComposerInstallationReflector;
+        $this->parseRevision                     = $parseRevision;
+        $this->getVersions                       = $getVersions;
+        $this->pickFromVersion                   = $pickFromVersion;
+        $this->locateDependencies                = $locateDependencies;
+        $this->compareApi                        = $compareApi;
     }
 
     /**
@@ -105,12 +104,6 @@ protected function configure() : void
                 InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
                 'Currently only supports "markdown"'
             )
-            ->addArgument(
-                'sources-path',
-                InputArgument::OPTIONAL,
-                'Path to the sources, relative to the repository root',
-                'src'
-            )
             ->addUsage(
                 <<<'USAGE'
 
@@ -126,7 +119,7 @@ protected function configure() : void
 
 It will then install all required dependencies in both copies
 and compare the APIs, looking for breaking changes in the
-given `<sources-path>` ("src" by default).
+defined "autoload" paths in your `composer.json` definition.
 
 Once completed, it will print out the results to `STDERR`
 and terminate with `3` if breaking changes were detected.
@@ -156,32 +149,25 @@ public function execute(InputInterface $input, OutputInterface $output) : int
             ? $this->parseRevisionFromInput($input, $sourceRepo)
             : $this->determineFromRevisionFromRepository($sourceRepo, $stdErr);
 
-        $toRevision  = $this->parseRevision->fromStringForRepository($input->getOption('to'), $sourceRepo);
-        $sourcesPath = $input->getArgument('sources-path');
+        $toRevision = $this->parseRevision->fromStringForRepository($input->getOption('to'), $sourceRepo);
 
         $stdErr->writeln(sprintf('Comparing from %s to %s...', (string) $fromRevision, (string) $toRevision));
 
         $fromPath = $this->git->checkout($sourceRepo, $fromRevision);
         $toPath   = $this->git->checkout($sourceRepo, $toRevision);
 
         try {
-            $fromSources = $fromPath . '/' . $sourcesPath;
-            $toSources   = $toPath . '/' . $sourcesPath;
-
-            Assert::that($fromSources)->directory();
-            Assert::that($toSources)->directory();
-
             $changes = $this->compareApi->__invoke(
-                $this->reflectorFactory->__invoke(
-                    $fromPath . '/' . $sourcesPath,
+                $this->makeComposerInstallationReflector->__invoke(
+                    $fromPath->__toString(),
                     new AggregateSourceLocator() // no dependencies
                 ),
-                $this->reflectorFactory->__invoke(
-                    $fromPath . '/' . $sourcesPath,
+                $this->makeComposerInstallationReflector->__invoke(
+                    $fromPath->__toString(),
                     $this->locateDependencies->__invoke((string) $fromPath)
                 ),
-                $this->reflectorFactory->__invoke(
-                    $toPath . '/' . $sourcesPath,
+                $this->makeComposerInstallationReflector->__invoke(
+                    $toPath->__toString(),
                     $this->locateDependencies->__invoke((string) $toPath)
                 )
             );

test/unit/Command/AssertBackwardsCompatibleTest.php

@@ -12,6 +12,7 @@
 use Roave\BackwardCompatibility\Changes;
 use Roave\BackwardCompatibility\Command\AssertBackwardsCompatible;
 use Roave\BackwardCompatibility\CompareApi;
+use Roave\BackwardCompatibility\Factory\ComposerInstallationReflectorFactory;
 use Roave\BackwardCompatibility\Factory\DirectoryReflectorFactory;
 use Roave\BackwardCompatibility\Git\CheckedOutRepository;
 use Roave\BackwardCompatibility\Git\GetVersionCollection;
@@ -20,6 +21,7 @@
 use Roave\BackwardCompatibility\Git\PickVersionFromVersionCollection;
 use Roave\BackwardCompatibility\Git\Revision;
 use Roave\BackwardCompatibility\LocateDependencies\LocateDependencies;
+use Roave\BackwardCompatibility\LocateSources\LocateSourcesViaComposerJson;
 use Roave\BetterReflection\BetterReflection;
 use Roave\BetterReflection\SourceLocator\Type\AggregateSourceLocator;
 use Symfony\Component\Console\Input\InputInterface;
@@ -95,7 +97,7 @@ public function setUp() : void
         $this->compareApi         = $this->createMock(CompareApi::class);
         $this->compare            = new AssertBackwardsCompatible(
             $this->performCheckout,
-            new DirectoryReflectorFactory((new BetterReflection())->astLocator()),
+            new ComposerInstallationReflectorFactory(new LocateSourcesViaComposerJson((new BetterReflection())->astLocator())),
             $this->parseRevision,
             $this->getVersions,
             $this->pickVersion,
@@ -382,47 +384,4 @@ public function testExecuteWithDefaultRevisionsNotProvided() : void
 
         self::assertSame(0, $this->compare->execute($this->input, $this->output));
     }
-
-    public function testExecuteFailsIfCheckedOutRepositoryDoesNotExist() : void
-    {
-        $fromSha = sha1('fromRevision', false);
-        $toSha   = sha1('toRevision', false);
-
-        $this->input->expects(self::any())->method('getOption')->willReturnMap([
-            ['from', $fromSha],
-            ['to', $toSha],
-        ]);
-        $this->input->expects(self::any())->method('getArgument')->willReturnMap([
-            ['sources-path', uniqid('src', true)],
-        ]);
-
-        $this->performCheckout->expects(self::at(0))
-            ->method('checkout')
-            ->with($this->sourceRepository, $fromSha)
-            ->willReturn($this->sourceRepository);
-        $this->performCheckout->expects(self::at(1))
-            ->method('checkout')
-            ->with($this->sourceRepository, $toSha)
-            ->willReturn($this->sourceRepository);
-        $this->performCheckout->expects(self::at(2))
-            ->method('remove')
-            ->with($this->sourceRepository);
-        $this->performCheckout->expects(self::at(3))
-            ->method('remove')
-            ->with($this->sourceRepository);
-
-        $this->parseRevision->expects(self::at(0))
-            ->method('fromStringForRepository')
-            ->with($fromSha)
-            ->willReturn(Revision::fromSha1($fromSha));
-        $this->parseRevision->expects(self::at(1))
-            ->method('fromStringForRepository')
-            ->with($toSha)
-            ->willReturn(Revision::fromSha1($toSha));
-
-        $this->compareApi->expects(self::never())->method('__invoke');
-
-        $this->expectException(InvalidArgumentException::class);
-        $this->compare->execute($this->input, $this->output);
-    }
 }