#28215

pending completion

Build # #28215

Build Type

push

github

Committed by

web-flow

Commit Message

<a href="https://github.com/api-platform/core/commit/<a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/<a class="double-link" href="https://git"><a class=hub.com/api-platform/core/commit/821a077736acb2000a63759cde175bb3f8cbb464">821a07773">&lt;a href=&quot;https://github.com/api-platform/core/commit/</a><a class="double-link" href="https://github.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/api-platform/core/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/api-platform/core/commit/821a077736acb2000a63759cde175bb3f8cbb464">821a07773</a><a href="https://github.com/api-platform/core/commit/821a077736acb2000a63759cde175bb3f8cbb464">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/api-platform/core/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/api-platform/core/commit/821a077736acb2000a63759cde175bb3f8cbb464&quot;&gt;821a07773&lt;/a&gt;&lt;a href=&quot;https://github.com/api-platform/core/commi... (continued)

Run Details

536 of 536 new or added lines in 40 files covered. (100.0%)

13275 of 16786 relevant lines covered (79.08%)

14.63 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/Core/Bridge/Symfony/Bundle/Command/RectorCommand.php

<?php

/*
 * This file is part of the API Platform project.
 *
 * (c) Kévin Dunglas <dunglas@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Command;

use ApiPlatform\Core\Bridge\Rector\Parser\TransformApiSubresourceVisitor;
use ApiPlatform\Core\Bridge\Rector\Service\SubresourceTransformer;
use ApiPlatform\Core\Bridge\Rector\Set\ApiPlatformSetList;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactoryInterface;
use PhpParser\Lexer\Emulative;
use PhpParser\NodeTraverser;
use PhpParser\Parser\Php7;
use PhpParser\PrettyPrinter\Standard;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\SymfonyStyle;

/**
 * @experimental
 */
final class RectorCommand extends Command
{
    private const OPERATIONS = [
        'annotation-to-legacy-api-resource' => '@ApiResource to #[ApiPlatform\Core\Annotation\ApiResource] - deprecated since 2.7',
        'annotation-to-api-resource' => '@ApiResource to #[ApiPlatform\Metadata\ApiResource]',
        'keep-attribute' => '#[ApiPlatform\Core\Annotation\ApiResource] to #[ApiPlatform\Metadata\ApiResource]',
        'transform-apisubresource' => 'Transform @ApiSubresource to alternate resources',
    ];

    protected static $defaultName = 'api:rector:upgrade';

    private $resourceNameCollectionFactory;
    private $resourceMetadataFactory;
    private $subresourceOperationFactory;
    private $subresourceTransformer;
    private $localCache = [];

    public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, SubresourceOperationFactoryInterface $subresourceOperationFactory, SubresourceTransformer $subresourceTransformer)
    {
        $this->resourceNameCollectionFactory = $resourceNameCollectionFactory;
        $this->resourceMetadataFactory = $resourceMetadataFactory;
        $this->subresourceOperationFactory = $subresourceOperationFactory;
        $this->subresourceTransformer = $subresourceTransformer;

        parent::__construct();
    }

    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setDescription('Change "ApiPlatform\Core\Annotation\ApiResource" annotation/attribute to new "ApiPlatform\Metadata\ApiResource" attribute')
            ->addOption('dry-run', '-d', InputOption::VALUE_NONE, 'Rector will show you diff of files that it would change. To make the changes, drop --dry-run')
            ->addOption('silent', '-s', InputOption::VALUE_NONE, 'Run Rector silently')
            ->addArgument('src', InputArgument::REQUIRED, 'Path to folder/file to convert, forwarded to Rector');

        foreach (self::OPERATIONS as $operationKey => $operationDescription) {
            $this->addOption($operationKey, null, InputOption::VALUE_NONE, $operationDescription);
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        if (!file_exists('vendor/bin/rector')) {
            $output->write('Rector is not installed. Please execute composer require --dev rector/rector:0.12.5');

            return Command::FAILURE;
        }

        $io = new SymfonyStyle($input, $output);
        $operations = self::OPERATIONS;

        $choices = array_values($operations);

        $choice = null;
        $operationCount = 0;
        $askForSubresources = true;

        foreach ($operations as $operationKey => $operationDescription) {
            if ($input->getOption($operationKey)) {
                $choice = $operationKey;
                ++$operationCount;
            }
        }

        if ($operationCount > 1) {
            $output->write('Only one operation can be given as a parameter.');

            return Command::FAILURE;
        }

        if (!$choice) {
            $io->text([
                'Welcome,',
                'This tool allows you to transform Doctrine Annotations "@ApiResource" into Attributes "#[ApiPlatform\Core\Annotation\ApiResource]".',
                'Note that since 2.7 there is a new Attribute at ApiPlatform\Metadata\ApiResource that allows you more control over resources. It\'s the new default in 3.0.',
            ]);
            $choice = $io->choice('Choose an operation to perform:', $choices);
        } else {
            $askForSubresources = false;
        }

        $operationKey = $this->getOperationKeyByChoice($operations, $choice);

        $command = 'vendor/bin/rector process '.$input->getArgument('src');

        if ($output->isDebug()) {
            $command .= ' --debug';
        }

        $operationKeys = array_keys($operations);

        switch ($operationKey) {
            case $operationKeys[0]:
                $command .= ' --config='.ApiPlatformSetList::ANNOTATION_TO_LEGACY_API_RESOURCE_ATTRIBUTE;
                break;
            case $operationKeys[1]:
                if ($askForSubresources && $this->isThereSubresources($io, $output)) {
                    return Command::FAILURE;
                }
                $command .= ' --config='.ApiPlatformSetList::ANNOTATION_TO_API_RESOURCE_ATTRIBUTE;
                break;
            case $operationKeys[2]:
                if ($askForSubresources && $this->isThereSubresources($io, $output)) {
                    return Command::FAILURE;
                }
                $command .= ' --config='.ApiPlatformSetList::ATTRIBUTE_TO_API_RESOURCE_ATTRIBUTE;
                break;
            case $operationKeys[3]:
                $command .= ' --config='.ApiPlatformSetList::TRANSFORM_API_SUBRESOURCE;
                break;
        }

        if ($input->getOption('dry-run')) {
            $command .= ' --dry-run';
        } else {
            if (!$io->confirm('Your files will be overridden. Do you want to continue ?')) {
                $output->write('Migration aborted.');

                return Command::FAILURE;
            }
        }

        $io->title('Run '.$command);

        if ($operationKey === $operationKeys[3] && !$input->getOption('dry-run')) {
            $this->transformApiSubresource($input->getArgument('src'), $output);
        }

        if ($input->getOption('silent')) {
            exec($command.' --no-progress-bar --no-diffs');
        } else {
            passthru($command);
        }

        $output->write('Migration successful.');

        return Command::SUCCESS;
    }

    private function getOperationKeyByChoice($operations, $choice): string
    {
        if (\in_array($choice, array_keys($operations), true)) {
            return $choice;
        }

        return array_search($choice, $operations, true);
    }

    private function transformApiSubresource(string $src, OutputInterface $output)
    {
        foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {
            try {
                new \ReflectionClass($resourceClass);
            } catch (\Exception $e) {
                continue;
            }

            if (!isset($this->localCache[$resourceClass])) {
                $this->localCache[$resourceClass] = [];
            }

            foreach ($this->subresourceOperationFactory->create($resourceClass) as $subresourceMetadata) {
                if (!isset($this->localCache[$subresourceMetadata['resource_class']])) {
                    $this->localCache[$subresourceMetadata['resource_class']] = [];
                }

                foreach ($this->localCache[$subresourceMetadata['resource_class']] as $currentSubresourceMetadata) {
                    if ($currentSubresourceMetadata['path'] === $subresourceMetadata['path']) {
                        continue 2;
                    }
                }
                $this->localCache[$subresourceMetadata['resource_class']][] = $subresourceMetadata;
            }
        }

        // Compute URI variables
        foreach ($this->localCache as $class => $subresources) {
            if (!$subresources) {
                unset($this->localCache[$class]);
                continue;
            }

            foreach ($subresources as $i => $subresourceMetadata) {
                $this->localCache[$class][$i]['uri_variables'] = $this->subresourceTransformer->toUriVariables($subresourceMetadata);
            }
        }

        foreach ($this->localCache as $resourceClass => $linkedSubresourceMetadata) {
            $fileName = (new \ReflectionClass($resourceClass))->getFilename();

            if (!str_contains($fileName, $src)) {
                continue;
            }

            $referenceType = null;
            try {
                $metadata = $this->resourceMetadataFactory->create($resourceClass);
                $referenceType = $metadata->getAttribute('url_generation_strategy');
            } catch (\Exception $e) {
            }

            foreach ($linkedSubresourceMetadata as $subresourceMetadata) {
                $lexer = new Emulative([
                    'usedAttributes' => [
                        'comments',
                        'startLine', 'endLine',
                        'startTokenPos', 'endTokenPos',
                    ],
                ]);
                $parser = new Php7($lexer);

                $traverser = new NodeTraverser();
                $traverser->addVisitor(new TransformApiSubresourceVisitor($subresourceMetadata, $referenceType));
                $prettyPrinter = new Standard();

                $oldStmts = $parser->parse(file_get_contents($fileName));
                $oldTokens = $lexer->getTokens();

                $newStmts = $traverser->traverse($oldStmts);

                $newCode = $prettyPrinter->printFormatPreserving($newStmts, $oldStmts, $oldTokens);

                file_put_contents($fileName, $newCode);
            }
        }
    }

    private function isThereSubresources($io, $output): bool
    {
        if ($io->confirm('Do you have any @ApiSubresource or #[ApiSubresource] left in your code ?')) {
            $output->write('You will not be able to convert them afterwards. Please run the command "Transform @ApiSubresource to alternate resources" first.');

            return true;
        }

        return false;
    }
}

1	<?php
2
3	/*
4	* This file is part of the API Platform project.
5	*
6	* (c) Kévin Dunglas <dunglas@gmail.com>
7	*
8	* For the full copyright and license information, please view the LICENSE
9	* file that was distributed with this source code.
10	*/
11
12	declare(strict_types=1);
13
14	namespace ApiPlatform\Core\Bridge\Symfony\Bundle\Command;
15
16	use ApiPlatform\Core\Bridge\Rector\Parser\TransformApiSubresourceVisitor;
17	use ApiPlatform\Core\Bridge\Rector\Service\SubresourceTransformer;
18	use ApiPlatform\Core\Bridge\Rector\Set\ApiPlatformSetList;
19	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
20	use ApiPlatform\Core\Metadata\Resource\Factory\ResourceNameCollectionFactoryInterface;
21	use ApiPlatform\Core\Operation\Factory\SubresourceOperationFactoryInterface;
22	use PhpParser\Lexer\Emulative;
23	use PhpParser\NodeTraverser;
24	use PhpParser\Parser\Php7;
25	use PhpParser\PrettyPrinter\Standard;
26	use Symfony\Component\Console\Command\Command;
27	use Symfony\Component\Console\Input\InputArgument;
28	use Symfony\Component\Console\Input\InputInterface;
29	use Symfony\Component\Console\Input\InputOption;
30	use Symfony\Component\Console\Output\OutputInterface;
31	use Symfony\Component\Console\Style\SymfonyStyle;
32
33	/**
34	* @experimental
35	*/
36	final class RectorCommand extends Command
37	{
38	private const OPERATIONS = [
39	'annotation-to-legacy-api-resource' => '@ApiResource to #[ApiPlatform\Core\Annotation\ApiResource] - deprecated since 2.7',
40	'annotation-to-api-resource' => '@ApiResource to #[ApiPlatform\Metadata\ApiResource]',
41	'keep-attribute' => '#[ApiPlatform\Core\Annotation\ApiResource] to #[ApiPlatform\Metadata\ApiResource]',
42	'transform-apisubresource' => 'Transform @ApiSubresource to alternate resources',
43	];
44
45	protected static $defaultName = 'api:rector:upgrade';
46
47	private $resourceNameCollectionFactory;
48	private $resourceMetadataFactory;
49	private $subresourceOperationFactory;
50	private $subresourceTransformer;
51	private $localCache = [];
52
53	public function __construct(ResourceNameCollectionFactoryInterface $resourceNameCollectionFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, SubresourceOperationFactoryInterface $subresourceOperationFactory, SubresourceTransformer $subresourceTransformer)
54	{
55	$this->resourceNameCollectionFactory = $resourceNameCollectionFactory;	×
56	$this->resourceMetadataFactory = $resourceMetadataFactory;	×
57	$this->subresourceOperationFactory = $subresourceOperationFactory;	×
58	$this->subresourceTransformer = $subresourceTransformer;	×
59
60	parent::__construct();	×
61	}	×
62
63	/**
64	* {@inheritdoc}
65	*/
66	protected function configure()
67	{
68	$this
69	->setDescription('Change "ApiPlatform\Core\Annotation\ApiResource" annotation/attribute to new "ApiPlatform\Metadata\ApiResource" attribute')	×
70	->addOption('dry-run', '-d', InputOption::VALUE_NONE, 'Rector will show you diff of files that it would change. To make the changes, drop --dry-run')	×
71	->addOption('silent', '-s', InputOption::VALUE_NONE, 'Run Rector silently')	×
72	->addArgument('src', InputArgument::REQUIRED, 'Path to folder/file to convert, forwarded to Rector');	×
73
74	foreach (self::OPERATIONS as $operationKey => $operationDescription) {	×
75	$this->addOption($operationKey, null, InputOption::VALUE_NONE, $operationDescription);	×
76	}
77	}	×
78
79	/**
80	* {@inheritdoc}
81	*/
82	protected function execute(InputInterface $input, OutputInterface $output): int
83	{
84	if (!file_exists('vendor/bin/rector')) {	×
85	$output->write('Rector is not installed. Please execute composer require --dev rector/rector:0.12.5');	×
86
87	return Command::FAILURE;	×
88	}
89
90	$io = new SymfonyStyle($input, $output);	×
91	$operations = self::OPERATIONS;	×
92
93	$choices = array_values($operations);	×
94
95	$choice = null;	×
96	$operationCount = 0;	×
97	$askForSubresources = true;	×
98
99	foreach ($operations as $operationKey => $operationDescription) {	×
100	if ($input->getOption($operationKey)) {	×
101	$choice = $operationKey;	×
102	++$operationCount;	×
103	}
104	}
105
106	if ($operationCount > 1) {	×
107	$output->write('Only one operation can be given as a parameter.');	×
108
109	return Command::FAILURE;	×
110	}
111
112	if (!$choice) {	×
113	$io->text([	×
114	'Welcome,',	×
115	'This tool allows you to transform Doctrine Annotations "@ApiResource" into Attributes "#[ApiPlatform\Core\Annotation\ApiResource]".',
116	'Note that since 2.7 there is a new Attribute at ApiPlatform\Metadata\ApiResource that allows you more control over resources. It\'s the new default in 3.0.',
117	]);
118	$choice = $io->choice('Choose an operation to perform:', $choices);	×
119	} else {
120	$askForSubresources = false;	×
121	}
122
123	$operationKey = $this->getOperationKeyByChoice($operations, $choice);	×
124
125	$command = 'vendor/bin/rector process '.$input->getArgument('src');	×
126
127	if ($output->isDebug()) {	×
128	$command .= ' --debug';	×
129	}
130
131	$operationKeys = array_keys($operations);	×
132
133	switch ($operationKey) {
134	case $operationKeys[0]:	×
135	$command .= ' --config='.ApiPlatformSetList::ANNOTATION_TO_LEGACY_API_RESOURCE_ATTRIBUTE;	×
136	break;	×
137	case $operationKeys[1]:	×
138	if ($askForSubresources && $this->isThereSubresources($io, $output)) {	×
139	return Command::FAILURE;	×
140	}
141	$command .= ' --config='.ApiPlatformSetList::ANNOTATION_TO_API_RESOURCE_ATTRIBUTE;	×
142	break;	×
143	case $operationKeys[2]:	×
144	if ($askForSubresources && $this->isThereSubresources($io, $output)) {	×
145	return Command::FAILURE;	×
146	}
147	$command .= ' --config='.ApiPlatformSetList::ATTRIBUTE_TO_API_RESOURCE_ATTRIBUTE;	×
148	break;	×
149	case $operationKeys[3]:	×
150	$command .= ' --config='.ApiPlatformSetList::TRANSFORM_API_SUBRESOURCE;	×
151	break;	×
152	}
153
154	if ($input->getOption('dry-run')) {	×
155	$command .= ' --dry-run';	×
156	} else {
157	if (!$io->confirm('Your files will be overridden. Do you want to continue ?')) {	×
158	$output->write('Migration aborted.');	×
159
160	return Command::FAILURE;	×
161	}
162	}
163
164	$io->title('Run '.$command);	×
165
166	if ($operationKey === $operationKeys[3] && !$input->getOption('dry-run')) {	×
167	$this->transformApiSubresource($input->getArgument('src'), $output);	×
168	}
169
170	if ($input->getOption('silent')) {	×
171	exec($command.' --no-progress-bar --no-diffs');	×
172	} else {
173	passthru($command);	×
174	}
175
176	$output->write('Migration successful.');	×
177
178	return Command::SUCCESS;	×
179	}
180
181	private function getOperationKeyByChoice($operations, $choice): string
182	{
183	if (\in_array($choice, array_keys($operations), true)) {	×
184	return $choice;	×
185	}
186
187	return array_search($choice, $operations, true);	×
188	}
189
190	private function transformApiSubresource(string $src, OutputInterface $output)
191	{
192	foreach ($this->resourceNameCollectionFactory->create() as $resourceClass) {	×
193	try {
194	new \ReflectionClass($resourceClass);	×
195	} catch (\Exception $e) {	×
196	continue;	×
197	}
198
199	if (!isset($this->localCache[$resourceClass])) {	×
200	$this->localCache[$resourceClass] = [];	×
201	}
202
203	foreach ($this->subresourceOperationFactory->create($resourceClass) as $subresourceMetadata) {	×
204	if (!isset($this->localCache[$subresourceMetadata['resource_class']])) {	×
205	$this->localCache[$subresourceMetadata['resource_class']] = [];	×
206	}
207
208	foreach ($this->localCache[$subresourceMetadata['resource_class']] as $currentSubresourceMetadata) {	×
209	if ($currentSubresourceMetadata['path'] === $subresourceMetadata['path']) {	×
210	continue 2;	×
211	}
212	}
213	$this->localCache[$subresourceMetadata['resource_class']][] = $subresourceMetadata;	×
214	}
215	}
216
217	// Compute URI variables
218	foreach ($this->localCache as $class => $subresources) {	×
219	if (!$subresources) {	×
220	unset($this->localCache[$class]);	×
221	continue;	×
222	}
223
224	foreach ($subresources as $i => $subresourceMetadata) {	×
225	$this->localCache[$class][$i]['uri_variables'] = $this->subresourceTransformer->toUriVariables($subresourceMetadata);	×
226	}
227	}
228
229	foreach ($this->localCache as $resourceClass => $linkedSubresourceMetadata) {	×
230	$fileName = (new \ReflectionClass($resourceClass))->getFilename();	×
231
232	if (!str_contains($fileName, $src)) {	×
233	continue;	×
234	}
235
236	$referenceType = null;	×
237	try {
238	$metadata = $this->resourceMetadataFactory->create($resourceClass);	×
239	$referenceType = $metadata->getAttribute('url_generation_strategy');	×
240	} catch (\Exception $e) {	×
241	}
242
243	foreach ($linkedSubresourceMetadata as $subresourceMetadata) {	×
244	$lexer = new Emulative([	×
245	'usedAttributes' => [
246	'comments',	×
247	'startLine', 'endLine',
248	'startTokenPos', 'endTokenPos',
249	],
250	]);
251	$parser = new Php7($lexer);	×
252
253	$traverser = new NodeTraverser();	×
254	$traverser->addVisitor(new TransformApiSubresourceVisitor($subresourceMetadata, $referenceType));	×
255	$prettyPrinter = new Standard();	×
256
257	$oldStmts = $parser->parse(file_get_contents($fileName));	×
258	$oldTokens = $lexer->getTokens();	×
259
260	$newStmts = $traverser->traverse($oldStmts);	×
261
262	$newCode = $prettyPrinter->printFormatPreserving($newStmts, $oldStmts, $oldTokens);	×
263
264	file_put_contents($fileName, $newCode);	×
265	}
266	}
267	}	×
268
269	private function isThereSubresources($io, $output): bool
270	{
271	if ($io->confirm('Do you have any @ApiSubresource or #[ApiSubresource] left in your code ?')) {	×
272	$output->write('You will not be able to convert them afterwards. Please run the command "Transform @ApiSubresource to alternate resources" first.');	×
273
274	return true;	×
275	}
276
277	return false;	×
278	}
279	}

api-platform / core / #28215

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous