Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions src/Console/Command/ComposerBasedCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -103,19 +103,25 @@ private function createTableRows(): array
}

$composerPackageConstraint = $rector->provideComposerPackageConstraint();
$packageName = $composerPackageConstraint->getPackageName();
$constraint = $composerPackageConstraint->getConstraint();

$installedVersion = $this->installedPackageResolver->resolvePackageVersion($packageName);
$isActive = $installedVersion !== null && Semver::satisfies($installedVersion, $constraint);

$tableRows[] = [
$this->printShortClassName($rector::class),
$packageName,
$constraint,
$installedVersion ?? '-',
$isActive ? 'yes' : 'no',
];
$composerPackageConstraints = is_array($composerPackageConstraint)
? $composerPackageConstraint
: [$composerPackageConstraint];

foreach ($composerPackageConstraints as $composerPackageConstraint) {
$packageName = $composerPackageConstraint->getPackageName();
$constraint = $composerPackageConstraint->getConstraint();

$installedVersion = $this->installedPackageResolver->resolvePackageVersion($packageName);
$isActive = $installedVersion !== null && Semver::satisfies($installedVersion, $constraint);

$tableRows[] = [
$this->printShortClassName($rector::class),
$packageName,
$constraint,
$installedVersion ?? '-',
$isActive ? 'yes' : 'no',
];
}
}

// sort by package name first, then by rule class
Expand Down
23 changes: 17 additions & 6 deletions src/VersionBonding/ComposerPackageConstraintFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,25 @@ public function filter(array $rectors): array
private function satisfiesComposerPackageConstraint(ComposerPackageConstraintInterface $rector): bool
{
$composerPackageConstraint = $rector->provideComposerPackageConstraint();
$packageVersion = $this->installedPackageResolver->resolvePackageVersion(
$composerPackageConstraint->getPackageName(),
);
$composerPackageConstraints = is_array($composerPackageConstraint)
? $composerPackageConstraint
: [$composerPackageConstraint];

if ($packageVersion === null) {
return false;
// every constraint must be satisfied, so the rule fits every required package at once
foreach ($composerPackageConstraints as $composerPackageConstraint) {
$packageVersion = $this->installedPackageResolver->resolvePackageVersion(
$composerPackageConstraint->getPackageName(),
);

if ($packageVersion === null) {
return false;
}

if (! Semver::satisfies($packageVersion, $composerPackageConstraint->getConstraint())) {
return false;
}
}

return Semver::satisfies($packageVersion, $composerPackageConstraint->getConstraint());
return true;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,11 @@
*/
interface ComposerPackageConstraintInterface
{
public function provideComposerPackageConstraint(): ComposerPackageConstraint;
/**
* Return a single constraint, or a list of constraints that must all be satisfied at once,
* e.g. an attribute that only works when both a library and its framework integration are new enough.
*
* @return ComposerPackageConstraint|list<ComposerPackageConstraint>
*/
public function provideComposerPackageConstraint(): ComposerPackageConstraint|array;
}
36 changes: 36 additions & 0 deletions tests/VersionBonding/ComposerPackageConstraintFilterTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@
use PHPUnit\Framework\TestCase;
use Rector\Composer\InstalledPackageResolver;
use Rector\Tests\VersionBonding\Fixture\ComposerPackageConstraintRector;
use Rector\Tests\VersionBonding\Fixture\ComposerPackageConstraintsRector;
use Rector\Tests\VersionBonding\Fixture\NoInterfaceRector;
use Rector\VersionBonding\ComposerPackageConstraintFilter;
use Rector\VersionBonding\ValueObject\ComposerPackageConstraint;

final class ComposerPackageConstraintFilterTest extends TestCase
{
Expand Down Expand Up @@ -71,4 +73,38 @@ public function testRectorWithLessThanConstraintExcludesNewerVersions(): void

$this->assertCount(0, $filtered);
}

public function testRectorWithAllConstraintsSatisfiedIsIncluded(): void
{
$composerPackageConstraintsRector = new ComposerPackageConstraintsRector(
new ComposerPackageConstraint('nikic/php-parser', '>=4.0.0'),
new ComposerPackageConstraint('phpstan/phpstan', '>=1.0.0'),
);
$filtered = $this->composerPackageConstraintFilter->filter([$composerPackageConstraintsRector]);

$this->assertCount(1, $filtered);
$this->assertSame($composerPackageConstraintsRector, $filtered[0]);
}

public function testRectorWithOneUnsatisfiedConstraintIsExcluded(): void
{
$composerPackageConstraintsRector = new ComposerPackageConstraintsRector(
new ComposerPackageConstraint('nikic/php-parser', '>=4.0.0'),
new ComposerPackageConstraint('nikic/php-parser', '>=999.0.0'),
);
$filtered = $this->composerPackageConstraintFilter->filter([$composerPackageConstraintsRector]);

$this->assertCount(0, $filtered);
}

public function testRectorWithOneMissingPackageIsExcluded(): void
{
$composerPackageConstraintsRector = new ComposerPackageConstraintsRector(
new ComposerPackageConstraint('nikic/php-parser', '>=4.0.0'),
new ComposerPackageConstraint('non-existent/package', '>=1.0.0'),
);
$filtered = $this->composerPackageConstraintFilter->filter([$composerPackageConstraintsRector]);

$this->assertCount(0, $filtered);
}
}
47 changes: 47 additions & 0 deletions tests/VersionBonding/Fixture/ComposerPackageConstraintsRector.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<?php

declare(strict_types=1);

namespace Rector\Tests\VersionBonding\Fixture;

use PhpParser\Node;
use Rector\Rector\AbstractRector;
use Rector\VersionBonding\Contract\ComposerPackageConstraintInterface;
use Rector\VersionBonding\ValueObject\ComposerPackageConstraint;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

final class ComposerPackageConstraintsRector extends AbstractRector implements ComposerPackageConstraintInterface
{
/**
* @var ComposerPackageConstraint[]
*/
private array $composerPackageConstraints;

public function __construct(ComposerPackageConstraint ...$composerPackageConstraints)
{
$this->composerPackageConstraints = $composerPackageConstraints;
}

public function getRuleDefinition(): RuleDefinition
{
return new RuleDefinition('Test rector with multiple composer package constraints', []);
}

public function getNodeTypes(): array
{
return [Node\Stmt\Class_::class];
}

public function refactor(Node $node): ?Node
{
return null;
}

/**
* @return list<ComposerPackageConstraint>
*/
public function provideComposerPackageConstraint(): array
{
return array_values($this->composerPackageConstraints);
}
}
Loading