Rector - Upgrade your Legacy App to Modern Codebase

Rector is under development phase in 2018, to figure out the best way to use it in applications, polish API of Rector classes and get feedback from community. Please consider this while using it and report issues or post ideas you'll come up with while using. Thank you!

When you're gonna move from manual work to instant upgrades?

Rector upgrades your application for you, with focus on open-source projects:

Rector can:

• Rename classes
• Rename class' methods
• Rename partial namespace
• Rename pseudo-namespace to namespace
• Add, replace or remove arguments
• Add typehints based on new types of parent class or interface
• And much more...

Install

composer require --dev rector/rector:'dev-master' nikic/php-parser:'4.0.x-dev'

Do you Have Conflicts?

It may also happen your dependencies are in conflict, e.g. PHPStan requires PHP-Parser version 3, or older PHPUnit etc. This might be solved in the future, when PHP-Parser version 4 becomes stable.

Since Rector uses project's autoload to analyze type of elements, it cannot be installed as project in standalone directory but needs to be added as dependency. Here bamarni/composer-bin-plugin becomes useful:

composer require bamarni/composer-bin-plugin --dev

Then, require Rector using composer bin:

composer bin rector require --dev rector/rector:'dev-master' nikic/php-parser:'4.0.x-dev'

And Rector is accessible as:

vendor/bin/rector

Extra Autoloading

Rector relies on project and autoloading of its classes. To specify own autoload file, use --autoload-file option:

vendor/bin/rector process ../project --autoload-file ../project/vendor/autoload.php

How to Reconstruct your Code

A. Prepared Sets

Featured open-source projects have prepared sets. You'll find them in /src/config/level.

Do you need to upgrade to Symfony 4.0, for example?

1. Run rector on your /src directory:

   vendor/bin/rector process src --level symfony40
   

   Which is a shortcut for using complete path with --config option:

   vendor/bin/rector process src --config vendor/rector/rector/src/config/level/symfony/symfony40.yml
   

   You can also use your own config file:

   vendor/bin/rector process src --config your-own-config.yml
   

2. Do you want to see the preview of changes first?

   Use the --dry-run option:

   vendor/bin/rector process src --level symfony33 --dry-run
   

B. Custom Sets

1. Create rector.yml with desired Rectors:

   rectors:
       - Rector\Rector\Contrib\Nette\Application\InjectPropertyRector
   

2. Try Rector on your /src directory:

   vendor/bin/rector process src --dry-run
   

3. Apply the changes if you like them:

   vendor/bin/rector process src
   

Simple setup with Dynamic Rectors

You don't have to always write PHP code. Many projects change only classes or method names, so it would be too much work for a simple task.

Instead you can use prepared Dynamic Rectors directly in *.yml config:

You can:

Replace a class name

# phpunit60.yml
rectors:
    Rector\Rector\Dynamic\ClassReplacerRector:
        # old class: new class
        'PHPUnit_Framework_TestCase': 'PHPUnit\Framework\TestCase'

Replace some part of the namespace

# better-reflection20.yml
rectors:
    Rector\Rector\Dynamic\NamespaceReplacerRector:
        # old namespace: new namespace
        'BetterReflection': 'Roave\BetterReflection'

Change a method name

rectors:
    Rector\Rector\Dynamic\MethodNameReplacerRector:
        # class
        'Nette\Utils\Html':
            # old method: new method
            'add': 'addHtml'

        # or in case of static methods calls

        # class
        'Nette\Bridges\FormsLatte\FormMacros':
            # old method: [new class, new method]
            'renderFormBegin': ['Nette\Bridges\FormsLatte\Runtime', 'renderFormBegin']

Change a property name

rectors:
    Rector\Rector\Dynamic\PropertyNameReplacerRector:
        # class:
        'PhpParser\Node\Param':
            # old property: new property
            'name': 'var'

Change a class constant name

rectors:
    Rector\Rector\Dynamic\ClassConstantReplacerRector:
        # class
        'Symfony\Component\Form\FormEvents':
            # old constant: new constant
            'PRE_BIND': 'PRE_SUBMIT'
            'BIND': 'SUBMIT'
            'POST_BIND': 'POST_SUBMIT'

Change parameters type hinting according to the parent type

rectors:
    Rector\Rector\Dynamic\ParentTypehintedArgumentRector:
        # class
        'PhpParser\Parser':
            # method
            'parse':
                # parameter: typehint
                'code': 'string'

Change argument value or remove argument

rectors:
    Rector\Rector\Dynamic\ArgumentReplacerRector:
        -
            class: 'Symfony\Component\DependencyInjection\ContainerBuilder'
            method: 'compile'
            position: 0
            # change default value
            type: 'changed'
            default_value: false

            # or remove
            type: 'removed'

            # or replace old default value by new one
            type: 'replace_default_value'
            replace_map:
                'Symfony\Component\DependencyInjection\ContainerBuilder::SCOPE_PROTOTYPE': false

Replace the underscore naming _ with namespaces \

rectors:
    Rector\Rector\Dynamic\PseudoNamespaceToNamespaceRector:
        # old namespace prefix
        - 'PHPUnit_'
        # exclude classes
        - '!PHPUnit_Framework_MockObject_MockObject'

Modify a property to method

rectors:
    Rector\Rector\Dynamic\PropertyToMethodRector:
        # type
        'Symfony\Component\Translation\Translator':
            # property to replace
            'locale':
                # (prepared key): get method name
                'get': 'getLocale'
                # (prepared key): set method name
                'set': 'setLocale'

Remove a value object and use simple type

rectors:
    Rector\Rector\Dynamic\ValueObjectRemoverRector:
        # type: new simple type
        'ValueObject\Name': 'string'

For example:

- $value = new ValueObject\Name('Tomas');
+ $value = 'Tomas';

/**
-* @var ValueObject\Name
+* @var string
 */
private $name;

- public function someMethod(ValueObject\Name $name) { ...
+ public function someMethod(string $name) { ...

Replace Property and Method Annotations

rectors:
    Rector\Rector\Dynamic\AnnotationReplacerRector:
        # type
        PHPUnit\Framework\TestCase:
            # old annotation: new annotation
            scenario: test

 final class SomeTest extends PHPUnit\Framework\TestCase
 {
     /**
-     * @scenario
+     * @test
      */
     public function test()
     {
     }
 }

Turn Magic to Methods

Replace get/set magic methods with real ones

rectors:
    Rector\Rector\MagicDisclosure\GetAndSetToMethodCallRector:
        # class
        'Nette\DI\Container':
            # magic method (prepared keys): new real method
            'get': 'getService'
            'set': 'addService'

For example:

- $result = $container['key'];
+ $result = $container->getService('key');

- $container['key'] = $value;
+ $container->addService('key', $value);

Replace isset/unset magic methods with real ones

rectors:
    Rector\Rector\MagicDisclosure\UnsetAndIssetToMethodCallRector:
        # class
        'Nette\DI\Container':
            # magic method (prepared keys): new real method
            'isset': 'hasService'
            'unset': 'removeService'

For example:

- isset($container['key']);
+ $container->hasService('key');

- unset($container['key']);
+ $container->removeService('key');

Replace toString magic method with real one

rectors:
    Rector\Rector\MagicDisclosure\ToStringToMethodCallRector:
        # class
        'Symfony\Component\Config\ConfigCache':
            # magic method (prepared key): new real method
            'toString': 'getPath'

For example:

- $result = (string) $someValue;
+ $result = $someValue->getPath();

- $result = $someValue->__toString();
+ $result = $someValue->getPath();

Remove Fluent Interface

rectors:
    Rector\Rector\Dynamic\FluentReplaceRector: ~

 class SomeClass
 {
     public function setValue($value)
     {
         $this->value = $value;
-        return $this;
     }

     public function setAnotherValue($anontherValue)
     {
         $this->anotherValue = $anotherValue;
-        return $this;
     }
 }

 $someClass = new SomeClass();
- $someClass->setValue(5)
+ $someClass->setValue(5);
-     ->setAnotherValue(10);
+ $someClass->setAnotherValue(10);
 }

Coding Standards are Outsourced

This package has no intention in formatting your code, as coding standard tools handle this much better. We prefer EasyCodingStandard with Rector's prepared set:

# install
composer require --dev symplify/easy-coding-standard

# check
vendor/bin/ecs check --config vendor/rector/rector/ecs-after-rector.neon

# fix
vendor/bin/ecs check --config vendor/rector/rector/ecs-after-rector.neon --fix

More Detailed Documentation

• How Rector Works?
• How to Create Rector with Fluent Builder
• How to Create Own Rector
• Service Name to Type Provider

How to Contribute

Just follow 3 rules:

• 1 feature per pull-request

• New feature needs tests

• Tests, coding standards and PHPStan checks must pass:

  composer complete-check
  

  Don you need to fix coding standards? Run:

  composer fix-cs
  

We would be happy to merge your feature then.