From 947db97e337c48f34c6699c11ffc77ccc388e54b Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Sat, 5 Jul 2014 13:50:47 -0500 Subject: [PATCH 1/5] [#2492] Removing an unused variable and use statement, fixing phpdoc --- src/Composer/Command/CreateProjectCommand.php | 1 - src/Composer/DependencyResolver/Pool.php | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/src/Composer/Command/CreateProjectCommand.php b/src/Composer/Command/CreateProjectCommand.php index 632e869df..b37814413 100644 --- a/src/Composer/Command/CreateProjectCommand.php +++ b/src/Composer/Command/CreateProjectCommand.php @@ -242,7 +242,6 @@ EOT } $parser = new VersionParser(); - $candidates = array(); $requirements = $parser->parseNameVersionPairs(array($packageName)); $name = strtolower($requirements[0]['name']); if (!$packageVersion && isset($requirements[0]['version'])) { diff --git a/src/Composer/DependencyResolver/Pool.php b/src/Composer/DependencyResolver/Pool.php index 636a78c0a..d0c660f82 100644 --- a/src/Composer/DependencyResolver/Pool.php +++ b/src/Composer/DependencyResolver/Pool.php @@ -15,7 +15,6 @@ namespace Composer\DependencyResolver; use Composer\Package\BasePackage; use Composer\Package\AliasPackage; use Composer\Package\Version\VersionParser; -use Composer\Package\Link; use Composer\Package\LinkConstraint\LinkConstraintInterface; use Composer\Package\LinkConstraint\VersionConstraint; use Composer\Package\LinkConstraint\EmptyConstraint; @@ -25,6 +24,7 @@ use Composer\Repository\ComposerRepository; use Composer\Repository\InstalledRepositoryInterface; use Composer\Repository\StreamableRepositoryInterface; use Composer\Repository\PlatformRepository; +use Composer\Package\PackageInterface; /** * A package pool contains repositories that provide packages. @@ -232,7 +232,7 @@ class Pool * packages must match or null to return all * @param bool $mustMatchName Whether the name of returned packages * must match the given name - * @return array A set of packages + * @return PackageInterface[] A set of packages */ public function whatProvides($name, LinkConstraintInterface $constraint = null, $mustMatchName = false) { From 58535a62fa906c73668d27de61494c23238ba84e Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Sat, 5 Jul 2014 13:51:15 -0500 Subject: [PATCH 2/5] [#2492] Automatically using the latest version when requiring a package This applies to the init and require commands. Previously: If you ommitted the version of a library, it prompted you to enter a version. New Behavior: If you omit the version, it automatically selects the latest version that is consistent with your minimum-stability flag. Is Jordi mentions, this is consistent with how npm works. --- src/Composer/Command/CreateProjectCommand.php | 18 +++--- src/Composer/Command/InitCommand.php | 63 +++++++++++++++---- 2 files changed, 59 insertions(+), 22 deletions(-) diff --git a/src/Composer/Command/CreateProjectCommand.php b/src/Composer/Command/CreateProjectCommand.php index b37814413..e8201cb2b 100644 --- a/src/Composer/Command/CreateProjectCommand.php +++ b/src/Composer/Command/CreateProjectCommand.php @@ -266,23 +266,14 @@ EOT $pool->addRepository($sourceRepo); $constraint = $packageVersion ? $parser->parseConstraints($packageVersion) : null; - $candidates = $pool->whatProvides($name, $constraint); - foreach ($candidates as $key => $candidate) { - if ($candidate->getName() !== $name) { - unset($candidates[$key]); - } - } + $candidates = $pool->whatProvides($name, $constraint, true); if (!$candidates) { throw new \InvalidArgumentException("Could not find package $name" . ($packageVersion ? " with version $packageVersion." : " with stability $stability.")); } - if (null === $directory) { - $parts = explode("/", $name, 2); - $directory = getcwd() . DIRECTORY_SEPARATOR . array_pop($parts); - } - // select highest version if we have many + // logic is repeated in InitCommand $package = reset($candidates); foreach ($candidates as $candidate) { if (version_compare($package->getVersion(), $candidate->getVersion(), '<')) { @@ -291,6 +282,11 @@ EOT } unset($candidates); + if (null === $directory) { + $parts = explode("/", $name, 2); + $directory = getcwd() . DIRECTORY_SEPARATOR . array_pop($parts); + } + $io->write('Installing ' . $package->getName() . ' (' . VersionParser::formatVersion($package, false) . ')'); if ($disablePlugins) { diff --git a/src/Composer/Command/InitCommand.php b/src/Composer/Command/InitCommand.php index a44546b73..0fa0d7564 100644 --- a/src/Composer/Command/InitCommand.php +++ b/src/Composer/Command/InitCommand.php @@ -12,6 +12,7 @@ namespace Composer\Command; +use Composer\DependencyResolver\Pool; use Composer\Json\JsonFile; use Composer\Factory; use Composer\Package\BasePackage; @@ -32,6 +33,7 @@ class InitCommand extends Command { private $gitConfig; private $repos; + private $pool; public function parseAuthorString($author) { @@ -284,9 +286,11 @@ EOT protected function findPackages($name) { - $packages = array(); + return $this->getRepos()->search($name); + } - // init repos + protected function getRepos() + { if (!$this->repos) { $this->repos = new CompositeRepository(array_merge( array(new PlatformRepository), @@ -294,7 +298,17 @@ EOT )); } - return $this->repos->search($name); + return $this->repos; + } + + protected function getPool() + { + if (!$this->pool) { + $this->pool = new Pool($this->getComposer()->getPackage()->getMinimumStability()); + $this->pool->addRepository($this->getRepos()); + } + + return $this->pool; } protected function determineRequirements(InputInterface $input, OutputInterface $output, $requires = array()) @@ -306,15 +320,42 @@ EOT $requires = $this->normalizeRequirements($requires); $result = array(); - foreach ($requires as $key => $requirement) { - if (!isset($requirement['version']) && $input->isInteractive()) { - $question = $dialog->getQuestion('Please provide a version constraint for the '.$requirement['name'].' requirement'); - if ($constraint = $dialog->ask($output, $question)) { - $requirement['version'] = $constraint; - } - } + foreach ($requires as $requirement) { if (!isset($requirement['version'])) { - throw new \InvalidArgumentException('The requirement '.$requirement['name'].' must contain a version constraint'); + + $candidates = $this->getPool()->whatProvides($requirement['name'], null, true); + + if (!$candidates) { + throw new \InvalidArgumentException(sprintf( + 'Could not find any versions for package "%s". Perhaps the name is wrong?', + $requirement['name'] + )); + } + + // select highest version if we have many + // logic is repeated in CreateProjectCommand + $package = reset($candidates); + foreach ($candidates as $candidate) { + if (version_compare($package->getVersion(), $candidate->getVersion(), '<')) { + $package = $candidate; + } + } + + if (!$package) { + throw new \Exception(sprintf( + 'No version of the package "%s" could be found that meets your minimum stability requirements of "%s"', + $requirement['name'], + $this->getComposer()->getPackage()->getMinimumStability() + )); + } + + $requirement['version'] = $package->getPrettyVersion(); + + $output->writeln(sprintf( + 'Using version %s for %s', + $requirement['version'], + $requirement['name'] + )); } $result[] = $requirement['name'] . ' ' . $requirement['version']; From 26179cc4b49fc18ac9276b90f6b6a47103e8a36d Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Sat, 5 Jul 2014 14:09:03 -0500 Subject: [PATCH 3/5] [#2492] Prefixed real versions with ~ when guessing the latest version 2.1.0 > ~2.1.0 v2.1.0 -> ~2.1.0 dev-master -> dev-master --- src/Composer/Command/InitCommand.php | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/src/Composer/Command/InitCommand.php b/src/Composer/Command/InitCommand.php index 0fa0d7564..f0f41a006 100644 --- a/src/Composer/Command/InitCommand.php +++ b/src/Composer/Command/InitCommand.php @@ -349,7 +349,17 @@ EOT )); } - $requirement['version'] = $package->getPrettyVersion(); + $version = $package->getPrettyVersion(); + if (!$package->isDev()) { + // remove the v prefix if there is one + if (substr($version, 0, 1) == 'v') { + $version = substr($version, 1); + } + + // 2.1.0 -> ~2.1.0, 2.0-beta.1 -> ~2.0-beta.1 + $version = '~'.$version; + } + $requirement['version'] = $version; $output->writeln(sprintf( 'Using version %s for %s', From aea2e901a93f6923417d01fe03f6910137ae557c Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Mon, 14 Jul 2014 21:25:44 -0500 Subject: [PATCH 4/5] Extracting logic into a new class related to selecting the latest version Also refactored InitCommand slightly so that you can use this "latest version" functionality when searching for a package as well. --- src/Composer/Command/CreateProjectCommand.php | 18 +--- src/Composer/Command/InitCommand.php | 93 +++++++++++-------- .../Package/Version/VersionSelector.php | 71 ++++++++++++++ .../Package/Version/VersionSelectorTest.php | 71 ++++++++++++++ 4 files changed, 201 insertions(+), 52 deletions(-) create mode 100644 src/Composer/Package/Version/VersionSelector.php create mode 100644 tests/Composer/Test/Package/Version/VersionSelectorTest.php diff --git a/src/Composer/Command/CreateProjectCommand.php b/src/Composer/Command/CreateProjectCommand.php index e8201cb2b..9928692eb 100644 --- a/src/Composer/Command/CreateProjectCommand.php +++ b/src/Composer/Command/CreateProjectCommand.php @@ -21,6 +21,7 @@ use Composer\IO\IOInterface; use Composer\Package\BasePackage; use Composer\DependencyResolver\Pool; use Composer\DependencyResolver\Operation\InstallOperation; +use Composer\Package\Version\VersionSelector; use Composer\Repository\ComposerRepository; use Composer\Repository\CompositeRepository; use Composer\Repository\FilesystemRepository; @@ -265,23 +266,14 @@ EOT $pool = new Pool($stability); $pool->addRepository($sourceRepo); - $constraint = $packageVersion ? $parser->parseConstraints($packageVersion) : null; - $candidates = $pool->whatProvides($name, $constraint, true); + // find the latest version if there are multiple + $versionSelector = new VersionSelector($pool); + $package = $versionSelector->findBestCandidate($name, $packageVersion); - if (!$candidates) { + if (!$package) { throw new \InvalidArgumentException("Could not find package $name" . ($packageVersion ? " with version $packageVersion." : " with stability $stability.")); } - // select highest version if we have many - // logic is repeated in InitCommand - $package = reset($candidates); - foreach ($candidates as $candidate) { - if (version_compare($package->getVersion(), $candidate->getVersion(), '<')) { - $package = $candidate; - } - } - unset($candidates); - if (null === $directory) { $parts = explode("/", $name, 2); $directory = getcwd() . DIRECTORY_SEPARATOR . array_pop($parts); diff --git a/src/Composer/Command/InitCommand.php b/src/Composer/Command/InitCommand.php index f0f41a006..b0ce567a8 100644 --- a/src/Composer/Command/InitCommand.php +++ b/src/Composer/Command/InitCommand.php @@ -16,6 +16,7 @@ use Composer\DependencyResolver\Pool; use Composer\Json\JsonFile; use Composer\Factory; use Composer\Package\BasePackage; +use Composer\Package\Version\VersionSelector; use Composer\Repository\CompositeRepository; use Composer\Repository\PlatformRepository; use Composer\Package\Version\VersionParser; @@ -323,42 +324,8 @@ EOT foreach ($requires as $requirement) { if (!isset($requirement['version'])) { - $candidates = $this->getPool()->whatProvides($requirement['name'], null, true); - - if (!$candidates) { - throw new \InvalidArgumentException(sprintf( - 'Could not find any versions for package "%s". Perhaps the name is wrong?', - $requirement['name'] - )); - } - - // select highest version if we have many - // logic is repeated in CreateProjectCommand - $package = reset($candidates); - foreach ($candidates as $candidate) { - if (version_compare($package->getVersion(), $candidate->getVersion(), '<')) { - $package = $candidate; - } - } - - if (!$package) { - throw new \Exception(sprintf( - 'No version of the package "%s" could be found that meets your minimum stability requirements of "%s"', - $requirement['name'], - $this->getComposer()->getPackage()->getMinimumStability() - )); - } - - $version = $package->getPrettyVersion(); - if (!$package->isDev()) { - // remove the v prefix if there is one - if (substr($version, 0, 1) == 'v') { - $version = substr($version, 1); - } - - // 2.1.0 -> ~2.1.0, 2.0-beta.1 -> ~2.0-beta.1 - $version = '~'.$version; - } + // determine the best version automatically + $version = $this->findBestVersionForPackage($requirement['name']); $requirement['version'] = $version; $output->writeln(sprintf( @@ -420,7 +387,7 @@ EOT $package = $dialog->askAndValidate($output, $dialog->getQuestion('Enter package # to add, or the complete package name if it is not listed', false, ':'), $validator, 3); } - // no constraint yet, prompt user + // no constraint yet, determine the best version automatically if (false !== $package && false === strpos($package, ' ')) { $validator = function ($input) { $input = trim($input); @@ -428,9 +395,20 @@ EOT return $input ?: false; }; - $constraint = $dialog->askAndValidate($output, $dialog->getQuestion('Enter the version constraint to require', false, ':'), $validator, 3); + $constraint = $dialog->askAndValidate( + $output, + $dialog->getQuestion('Enter the version constraint to require (or leave blank to use the latest version)', false, ':'), + $validator, + 3) + ; if (false === $constraint) { - continue; + $constraint = $this->findBestVersionForPackage($package); + + $output->writeln(sprintf( + 'Using version %s for %s', + $constraint, + $package + )); } $package .= ' '.$constraint; @@ -555,4 +533,41 @@ EOT return false !== filter_var($email, FILTER_VALIDATE_EMAIL); } + + /** + * Given a package name, this determines the best version to use in the require key. + * + * This returns a version with the ~ operator prefixed when possible. + * + * @param string $name + * @return string + * @throws \InvalidArgumentException + */ + protected function findBestVersionForPackage($name) + { + // find the latest version allowed in this pool + $versionSelector = new VersionSelector($this->getPool()); + $package = $versionSelector->findBestCandidate($name); + + if (!$package) { + throw new \InvalidArgumentException(sprintf( + 'Could not find package %s at any version for your minimum-stability (%s). Check the package spelling or your minimum-stability', + $name, + $this->getComposer()->getPackage()->getMinimumStability() + )); + } + + $version = $package->getPrettyVersion(); + if (!$package->isDev()) { + // remove the v prefix if there is one + if (substr($version, 0, 1) == 'v') { + $version = substr($version, 1); + } + + // 2.1.0 -> ~2.1.0, 2.0-beta.1 -> ~2.0-beta.1 + $version = '~'.$version; + } + + return $version; + } } diff --git a/src/Composer/Package/Version/VersionSelector.php b/src/Composer/Package/Version/VersionSelector.php new file mode 100644 index 000000000..ad9c2ab71 --- /dev/null +++ b/src/Composer/Package/Version/VersionSelector.php @@ -0,0 +1,71 @@ + + * Jordi Boggiano + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Composer\Package\Version; + +use Composer\DependencyResolver\Pool; +use Composer\Package\PackageInterface; + +/** + * Selects the best possible version for a package + * + * @author Ryan Weaver + */ +class VersionSelector +{ + private $pool; + + private $parser; + + public function __construct(Pool $pool) + { + $this->pool = $pool; + } + + /** + * Given a package name and optional version, returns the latest PackageInterface + * that matches. + * + * @param string $packageName + * @param string $targetPackageVersion + * @return PackageInterface|bool + */ + public function findBestCandidate($packageName, $targetPackageVersion = null) + { + $constraint = $targetPackageVersion ? $this->getParser()->parseConstraints($targetPackageVersion) : null; + $candidates = $this->pool->whatProvides($packageName, $constraint, true); + + if (!$candidates) { + return false; + } + + // select highest version if we have many + // logic is repeated in InitCommand + $package = reset($candidates); + foreach ($candidates as $candidate) { + if (version_compare($package->getVersion(), $candidate->getVersion(), '<')) { + $package = $candidate; + } + } + + return $package; + } + + private function getParser() + { + if ($this->parser === null) { + $this->parser = new VersionParser(); + } + + return $this->parser; + } +} diff --git a/tests/Composer/Test/Package/Version/VersionSelectorTest.php b/tests/Composer/Test/Package/Version/VersionSelectorTest.php new file mode 100644 index 000000000..636645807 --- /dev/null +++ b/tests/Composer/Test/Package/Version/VersionSelectorTest.php @@ -0,0 +1,71 @@ + + * Jordi Boggiano + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Composer\Test\Package\Version; + +use Composer\Package\Version\VersionSelector; + +class VersionSelectorTest extends \PHPUnit_Framework_TestCase +{ + // A) multiple versions, get the latest one + // B) targetPackageVersion will pass to pool + // C) No results, throw exception + + public function testLatestVersionIsReturned() + { + $packageName = 'foobar'; + + $package1 = $this->createMockPackage('1.2.1'); + $package2 = $this->createMockPackage('1.2.2'); + $package3 = $this->createMockPackage('1.2.0'); + $packages = array($package1, $package2, $package3); + + $pool = $this->createMockPool(); + $pool->expects($this->once()) + ->method('whatProvides') + ->with($packageName, null, true) + ->will($this->returnValue($packages)); + + $versionSelector = new VersionSelector($pool); + $best = $versionSelector->findBestCandidate($packageName); + + // 1.2.2 should be returned because it's the latest of the returned versions + $this->assertEquals($package2, $best, 'Latest version should be 1.2.2'); + } + + public function testFalseReturnedOnNoPackages() + { + $pool = $this->createMockPool(); + $pool->expects($this->once()) + ->method('whatProvides') + ->will($this->returnValue(array())); + + $versionSelector = new VersionSelector($pool); + $best = $versionSelector->findBestCandidate('foobaz'); + $this->assertFalse($best, 'No versions are available returns false'); + } + + private function createMockPackage($version) + { + $package = $this->getMock('\Composer\Package\PackageInterface'); + $package->expects($this->any()) + ->method('getVersion') + ->will($this->returnValue($version)); + + return $package; + } + + private function createMockPool() + { + return $this->getMock('Composer\DependencyResolver\Pool', array(), array(), '', true); + } +} From 895e62e85991dfb6f20d7cdc9aed2430c44fd742 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Fri, 12 Sep 2014 11:23:20 -0400 Subject: [PATCH 5/5] Refactoring selection of the "recommended" version (e.g ~1.2) and adding some tests This also modifies the behavior slightly (from a recommendation by seldaek) to always propose the minor version of the recommendation (e.g. ~1.2 instead of ~1.2.1). --- src/Composer/Command/InitCommand.php | 13 +----- .../Package/Version/VersionSelector.php | 42 ++++++++++++++++++ .../Package/Version/VersionSelectorTest.php | 44 +++++++++++++++++++ 3 files changed, 87 insertions(+), 12 deletions(-) diff --git a/src/Composer/Command/InitCommand.php b/src/Composer/Command/InitCommand.php index b0ce567a8..37c4d3029 100644 --- a/src/Composer/Command/InitCommand.php +++ b/src/Composer/Command/InitCommand.php @@ -557,17 +557,6 @@ EOT )); } - $version = $package->getPrettyVersion(); - if (!$package->isDev()) { - // remove the v prefix if there is one - if (substr($version, 0, 1) == 'v') { - $version = substr($version, 1); - } - - // 2.1.0 -> ~2.1.0, 2.0-beta.1 -> ~2.0-beta.1 - $version = '~'.$version; - } - - return $version; + return $versionSelector->findRecommendedRequireVersion($package); } } diff --git a/src/Composer/Package/Version/VersionSelector.php b/src/Composer/Package/Version/VersionSelector.php index ad9c2ab71..c00c4254d 100644 --- a/src/Composer/Package/Version/VersionSelector.php +++ b/src/Composer/Package/Version/VersionSelector.php @@ -60,6 +60,48 @@ class VersionSelector return $package; } + /** + * Given a concrete version, this returns a ~ constraint (when possible) + * that should be used, for example, in composer.json. + * + * For example: + * * 1.2.1 -> ~1.2 + * * 1.2 -> ~1.2 + * * v3.2.1 -> ~3.2 + * * 2.0-beta.1 -> ~2.0-beta.1 + * * dev-master -> dev-master (dev versions are untouched) + * + * @param PackageInterface $package + * @return string + */ + public function findRecommendedRequireVersion(PackageInterface $package) + { + $version = $package->getPrettyVersion(); + if (!$package->isDev()) { + // remove the v prefix if there is one + if (substr($version, 0, 1) == 'v') { + $version = substr($version, 1); + } + + // for stable packages only, we try to transform 2.1.1 to 2.1 + // this allows you to upgrade through minor versions + if ($package->getStability() == 'stable') { + $semanticVersionParts = explode('.', $version); + // check to see if we have a normal 1.2.6 semantic version + if (count($semanticVersionParts) == 3) { + // remove the last part (i.e. the patch version number) + unset($semanticVersionParts[2]); + $version = implode('.', $semanticVersionParts); + } + } + + // 2.1 -> ~2.1 + $version = '~'.$version; + } + + return $version; + } + private function getParser() { if ($this->parser === null) { diff --git a/tests/Composer/Test/Package/Version/VersionSelectorTest.php b/tests/Composer/Test/Package/Version/VersionSelectorTest.php index 636645807..fc4d6d61b 100644 --- a/tests/Composer/Test/Package/Version/VersionSelectorTest.php +++ b/tests/Composer/Test/Package/Version/VersionSelectorTest.php @@ -54,6 +54,50 @@ class VersionSelectorTest extends \PHPUnit_Framework_TestCase $this->assertFalse($best, 'No versions are available returns false'); } + /** + * @dataProvider getRecommendedRequireVersionPackages + */ + public function testFindRecommendedRequireVersion($prettyVersion, $isDev, $stability, $expectedVersion) + { + $pool = $this->createMockPool(); + $versionSelector = new VersionSelector($pool); + + $package = $this->getMock('\Composer\Package\PackageInterface'); + $package->expects($this->any()) + ->method('getPrettyVersion') + ->will($this->returnValue($prettyVersion)); + $package->expects($this->any()) + ->method('isDev') + ->will($this->returnValue($isDev)); + $package->expects($this->any()) + ->method('getStability') + ->will($this->returnValue($stability)); + + $recommended = $versionSelector->findRecommendedRequireVersion($package); + + // assert that the recommended version is what we expect + $this->assertEquals($expectedVersion, $recommended); + } + + public function getRecommendedRequireVersionPackages() + { + return array( + // real version, is dev package, stability, expected recommendation + array('1.2.1', false, 'stable', '~1.2'), + array('1.2', false, 'stable', '~1.2'), + array('v1.2.1', false, 'stable', '~1.2'), + array('3.1.2-pl2', false, 'stable', '~3.1'), + array('3.1.2-patch', false, 'stable', '~3.1'), + // for non-stable versions, we add ~, but don't try the (1.2.1 -> 1.2) transformation + array('2.0-beta.1', false, 'beta', '~2.0-beta.1'), + array('3.1.2-alpha5', false, 'alpha', '~3.1.2-alpha5'), + array('3.0-RC2', false, 'RC', '~3.0-RC2'), + // dev packages are not touched at all + array('dev-master', true, 'dev', 'dev-master'), + array('3.1.2-dev', true, 'dev', '3.1.2-dev'), + ); + } + private function createMockPackage($version) { $package = $this->getMock('\Composer\Package\PackageInterface');