Change class names and file names

[dingo-d]

Hi!

I'm playing with Rector on some of my older WordPress projects, where I've used WordPress coding standards. That means that the class has to be named using underscores like Some_Class_Name and has to be in the file called class-some-class-name.php.

Now, I'd like to change this to fit in PSR-4 autoloading that is

SomeClassName would be in the SomeClassName.php. The classes are split into one class per file, and they do follow the structure that the namespace follows the file structure like in PSR-4.

Is it possible to target partial class names and files so that they match? Is it possible to get the class names as arguments inside the configure method?

[TomasVotruba]

Hi, for working with class names and file names, check PSR4 rules: https://github.com/rectorphp/rector-src/tree/main/rules/PSR4/Rector
Or in README: https://github.com/rectorphp/rector/blob/main/docs/rector_rules_overview.md#psr4

You'll have to create custom rule, that moves around your files the specific way.

[dingo-d]

I'm having some trouble with understanding why this isn't working so any help will be appreciated. I wrote the rule like this

Details

<?php

declare (strict_types=1);

namespace Utils\Rector\Rector\Renaming;

use PhpParser\Node;
use PhpParser\Node\Stmt\Class_;
use Rector\Core\Rector\AbstractRector;
use Rector\Renaming\NodeManipulator\ClassRenamer;
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;

/**
 * Rector rule for renaming class names
 */
final class RenameClassNameRector extends AbstractRector
{
	/**
	 * @readonly
	 * @var ClassRenamer
	 */
	private $classRenamer;

	public function __construct(ClassRenamer $classRenamer)
	{
		$this->classRenamer = $classRenamer;
	}

	/**
	 * @throws \Symplify\RuleDocGenerator\Exception\PoorDocumentationException
	 */
	public function getRuleDefinition(): RuleDefinition
	{
		return new RuleDefinition(
			'Renames the Snake_Case classnames into PascalCase, e.g. Some_Class_Name to SomeClassName', [
			new CodeSample(
				<<<'CODE_SAMPLE'
class Some_Class_Name
{
	public function run()
	{
		$this->something();
	}
}
CODE_SAMPLE
, <<<'CODE_SAMPLE'
class SomeClassName
{
	public function run()
	{
		$this->something();
	}
}
CODE_SAMPLE
			)
		]
		);
	}

	/**
	 * @return array<class-string<Node>>
	 */
	public function getNodeTypes(): array
	{
		return [Class_::class];
	}

	/**
	 * @param \PhpParser\Node\Stmt\Class_ $node
	 */
	public function refactor(Node $node): ?Node
	{
		if ($node instanceof Class_) {
			$oldName = $node->name->toString();
			$names = explode('_', $oldName);

			$capitalizedNameParts = [];
			foreach ($names as $namePart) {
				$capitalizedNameParts[] = ucfirst(strtolower($namePart));
			}

			$newName = implode('', $capitalizedNameParts);

			return $this->classRenamer->renameNode($node, [$oldName => $newName]);
		}

		return null;
	}
}

The main logic in the refactor method is just taking the class name, exploding by _ converting parts to have the first part of the name uppercased, and then using the classRenamer like in the RenameClassRector rule to rename the node. But that's not working and I'm not sure why.

I think I'm missing some crucial part 😅

[TomasVotruba]

Looks good at first sight. The problem can be any many places, it's hard to say.
Could you share reproducible repository with failing test? I'll check it :)

[dingo-d]

Really appreciate the help, here's the repo with a minimal example, the rule, and the tests

https://github.com/dingo-d/rector-snake-case-rename-rule

You should be able to just run composer install and with composer test:run the test

[TomasVotruba]

I'm looking into it... could you give me PR access there, so I don't have to create forks to send PR?

[dingo-d]

Sure thing, I've sent you the invite 🙂