From b07be842a033494419e42bf80680b5378bb7f525 Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Mon, 7 Aug 2017 18:14:04 +0200 Subject: [PATCH] Remove feature-branches option as it is misnamed and duplicates the non-feature-branches option, refs #6475 --- doc/04-schema.md | 43 ---------- res/composer-schema.json | 7 -- .../Package/Version/VersionGuesser.php | 7 +- .../Package/Version/VersionGuesserTest.php | 83 ++++++++++++++++++- 4 files changed, 82 insertions(+), 58 deletions(-) diff --git a/doc/04-schema.md b/doc/04-schema.md index e8b164224..0f01f684d 100644 --- a/doc/04-schema.md +++ b/doc/04-schema.md @@ -897,47 +897,4 @@ Then "composer show -s" will give you `versions : * dev-latest-testing`. Optional. -### feature-branches - -If your feature branch names are other than the default names: - -* master -* trunk -* default -* develop - -You can use this setting to declare the list of branch names which should be considered -feature branches in your package. For example, if you do not use `develop` but rather use -a name like `development` and have no `trunk` or `default` branches, you can change this -setting to: - - -```json -{ - "feature-branches": ["master", "development"] -} -``` - -And Composer will consider those two branches (plus any numeric branches) as your only -feature branches. This allows Composer to recognise when you create a new branch based -on such a non-standard named feature branch, that your new branch is based on that "version". - -In practice this allows you to have `my/package:dev-oddname` in your dependency -section and still have `my/package:dev-branchofoddname` be recognised as compatible. -Without overriding this configuration option, Composer would instead demand that you -explicitly install `my/package:dev-oddname` or change the dependency to the explicit -name `my/package:dev-branchofoddname`. - -Particularly useful when combined with local repositories of type `path` where Composer -will read the checked-out branch name to determine the version. Without this setting, if you -used non-standard names, Composer would reject creating a symlink to the path and will -instead force `git clone`. With the setting, symlink creation is allowed when your local -branches are based on such non-standard named feature branches. - -Note that this is only the case when your branch names are other than the above mentioned -four default branch names. When you use default names you never need to declare this list - -Composer will then detect your feature branches based on the default set of names. - -Optional. - ← [Command-line interface](03-cli.md) | [Repositories](05-repositories.md) → diff --git a/res/composer-schema.json b/res/composer-schema.json index 49929bdb8..b98348222 100644 --- a/res/composer-schema.json +++ b/res/composer-schema.json @@ -492,13 +492,6 @@ } } }, - "feature-branches": { - "type": ["array"], - "description": "A set of string or regex patterns for non-numeric branch names that will be handled as feature branches. Overrides default feature branch names \"master\", \"trunk\", \"default\" and \"develop\" when declared.", - "items": { - "type": "string" - } - }, "non-feature-branches": { "type": ["array"], "description": "A set of string or regex patterns for non-numeric branch names that will not be handled as feature branches.", diff --git a/src/Composer/Package/Version/VersionGuesser.php b/src/Composer/Package/Version/VersionGuesser.php index 2ac4a4156..c84c5d8f7 100644 --- a/src/Composer/Package/Version/VersionGuesser.php +++ b/src/Composer/Package/Version/VersionGuesser.php @@ -211,11 +211,6 @@ class VersionGuesser $nonFeatureBranches = implode('|', $packageConfig['non-feature-branches']); } - $featureBranches = 'master|trunk|default|develop'; - if (!empty($packageConfig['feature-branches'])) { - $featureBranches = implode('|', $packageConfig['feature-branches']); - } - foreach ($branches as $candidate) { // return directly, if branch is configured to be non-feature branch if ($candidate === $branch && preg_match('{^(' . $nonFeatureBranches . ')$}', $candidate)) { @@ -223,7 +218,7 @@ class VersionGuesser } // do not compare against other feature branches - if ($candidate === $branch || !preg_match('{^(' . $featureBranches . '|\d+\..+)$}', $candidate, $match)) { + if ($candidate === $branch || !preg_match('{^(' . $nonFeatureBranches . '|master|trunk|default|develop|\d+\..+)$}', $candidate, $match)) { continue; } diff --git a/tests/Composer/Test/Package/Version/VersionGuesserTest.php b/tests/Composer/Test/Package/Version/VersionGuesserTest.php index 061b6d126..60681393c 100644 --- a/tests/Composer/Test/Package/Version/VersionGuesserTest.php +++ b/tests/Composer/Test/Package/Version/VersionGuesserTest.php @@ -126,7 +126,7 @@ class VersionGuesserTest extends \PHPUnit_Framework_TestCase $this->assertEquals($commitHash, $versionArray['commit']); } - public function testGuessVersionReadsAndRespectsFeatureBranchesConfigurationForArbitraryNaming() + public function testGuessVersionReadsAndRespectsNonFeatureBranchesConfigurationForArbitraryNaming() { $commitHash = '03a15d220da53c52eddd5f32ffca64a7b3801bea'; $anotherCommitHash = '03a15d220da53c52eddd5f32ffca64a7b3801bea'; @@ -165,12 +165,91 @@ class VersionGuesserTest extends \PHPUnit_Framework_TestCase $config = new Config; $config->merge(array('repositories' => array('packagist' => false))); $guesser = new VersionGuesser($config, $executor, new VersionParser()); - $versionArray = $guesser->guessVersion(array('version' => 'self.version', 'feature-branches' => array('arbitrary')), 'dummy/path'); + $versionArray = $guesser->guessVersion(array('version' => 'self.version', 'non-feature-branches' => array('arbitrary')), 'dummy/path'); $this->assertEquals("dev-arbitrary", $versionArray['version']); $this->assertEquals($anotherCommitHash, $versionArray['commit']); } + public function testGuessVersionReadsAndRespectsNonFeatureBranchesConfigurationForArbitraryNamingRegex() + { + $commitHash = '03a15d220da53c52eddd5f32ffca64a7b3801bea'; + $anotherCommitHash = '03a15d220da53c52eddd5f32ffca64a7b3801bea'; + + $executor = $this->getMockBuilder('\\Composer\\Util\\ProcessExecutor') + ->setMethods(array('execute')) + ->disableArgumentCloning() + ->disableOriginalConstructor() + ->getMock() + ; + + $self = $this; + + $executor + ->expects($this->at(0)) + ->method('execute') + ->willReturnCallback(function ($command, &$output) use ($self, $commitHash, $anotherCommitHash) { + $self->assertEquals('git branch --no-color --no-abbrev -v', $command); + $output = " latest-testing $commitHash Commit message\n* current $anotherCommitHash Another message\n"; + + return 0; + }) + ; + + $executor + ->expects($this->at(1)) + ->method('execute') + ->willReturnCallback(function ($command, &$output, $path) use ($self, $anotherCommitHash) { + $self->assertEquals('git rev-list latest-testing..current', $command); + $output = "$anotherCommitHash\n"; + + return 0; + }) + ; + + $config = new Config; + $config->merge(array('repositories' => array('packagist' => false))); + $guesser = new VersionGuesser($config, $executor, new VersionParser()); + $versionArray = $guesser->guessVersion(array('version' => 'self.version', 'non-feature-branches' => array('latest-.*')), 'dummy/path'); + + $this->assertEquals("dev-latest-testing", $versionArray['version']); + $this->assertEquals($anotherCommitHash, $versionArray['commit']); + } + + public function testGuessVersionReadsAndRespectsNonFeatureBranchesConfigurationForArbitraryNamingWhenOnNonFeatureBranch() + { + $commitHash = '03a15d220da53c52eddd5f32ffca64a7b3801bea'; + $anotherCommitHash = '03a15d220da53c52eddd5f32ffca64a7b3801bea'; + + $executor = $this->getMockBuilder('\\Composer\\Util\\ProcessExecutor') + ->setMethods(array('execute')) + ->disableArgumentCloning() + ->disableOriginalConstructor() + ->getMock() + ; + + $self = $this; + + $executor + ->expects($this->at(0)) + ->method('execute') + ->willReturnCallback(function ($command, &$output) use ($self, $commitHash, $anotherCommitHash) { + $self->assertEquals('git branch --no-color --no-abbrev -v', $command); + $output = "* latest-testing $commitHash Commit message\n current $anotherCommitHash Another message\n master $anotherCommitHash Another message\n"; + + return 0; + }) + ; + + $config = new Config; + $config->merge(array('repositories' => array('packagist' => false))); + $guesser = new VersionGuesser($config, $executor, new VersionParser()); + $versionArray = $guesser->guessVersion(array('version' => 'self.version', 'non-feature-branches' => array('latest-.*')), 'dummy/path'); + + $this->assertEquals("dev-latest-testing", $versionArray['version']); + $this->assertEquals($commitHash, $versionArray['commit']); + } + public function testDetachedHeadBecomesDevHash() { $commitHash = '03a15d220da53c52eddd5f32ffca64a7b3801bea';