Instant Upgrades for PHP Applications
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin rename class in bin/bootstrap.php Feb 8, 2019
config move level config to autodiscovery path Feb 9, 2019
docs add Rector create manual to main README [closes #1017] Feb 7, 2019
examples [Php 7.4] Add GetCalledClassToStaticClassRector Dec 31, 2018
packages fix nesting on SimplifyDeMorganBinaryRector Feb 12, 2019
src fix nesting on SimplifyDeMorganBinaryRector Feb 12, 2019
tests fix nesting on SimplifyDeMorganBinaryRector Feb 12, 2019
utils/phpstan decouple ValueResolver Feb 2, 2019
.coveralls.yml travis: add coverage Oct 28, 2018
.editorconfig improve attributes, add .editorconfig Dec 13, 2018
.gitattributes add .phpstorm.meta.php to .gitattributes Feb 8, 2019
.gitignore remove demo from gitignore [skip ci] Feb 4, 2019
.phpstorm.meta.php add .phpstorm.meta.php Feb 2, 2019
.travis.yml fix docs command in travis Feb 4, 2019
CODE_OF_CONDUCT.md Use HTTPS instead of HTTP Feb 14, 2018
Dockerfile rename *.yml to *.yaml Feb 3, 2019
LICENSE Update LICENSE year forever Jan 2, 2018
README.md add Rector create manual to main README [closes #1017] Feb 7, 2019
composer.json fix tests Feb 6, 2019
create-rector.yaml.dist rename *.yml to *.yaml Feb 3, 2019
ecs-after-rector.yml decouple TemplateVariablesFactory Oct 23, 2018
ecs.yml add event_class to RenameEventNamesInEventSubscriberRector Feb 9, 2019
phpstan.neon add static inverse on non-static call Feb 9, 2019
phpunit.xml [CodeQuality] Move coupled location to rest of Rector in standalone p… Oct 17, 2018

README.md

Rector - Upgrade your Legacy App to Modern Codebase

Rector is a reconstructor tool - it does instant upgrades and instant refactoring of your code. Why doing it manually if 80% Rector can handle for you?

Build Status Coverage Status Downloads

Rector-showcase

Rector instantly upgrades and instantly refactors PHP code of your application. It covers many open-source projects and PHP changes itself:



Rector can:

  • Rename classes, methods and properties
  • Rename partial namespace
  • Rename pseudo-namespace to namespace
  • Add, replace or remove arguments
  • Add arguments or return typehint
  • Change visibility of constant, property or method
  • And much more...

...look at overview of all available Rectors with before/after diffs and configuration examples. You can use them to build your own sets.

Install

composer require rector/rector --dev

Do you have conflicts on composer require or on run?

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

Or make use of rector.yaml config:

# rector.yaml
parameters:
    autoload_paths:
        - 'vendor/squizlabs/php_codesniffer/autoload.php'
        - 'vendor/project-without-composer'

Exclude Paths and Rectors

You can also exclude files or directories (with regex or fnmatch):

# rector.yaml
parameters:
    exclude_paths:
        - '*/src/*/Tests/*'

Do you want to use whole set, except that one rule? Exclude it:

# rector.yaml
parameters:
    exclude_rectors:
        - 'Rector\CodeQuality\Rector\If_\SimplifyIfReturnBoolRector'

Running Rector

A. Prepared Sets

Featured open-source projects have prepared sets. You'll find them in /config/level or by calling:

vendor/bin/rector levels

Let's say you pick symfony40 level and you want to upgrade your /src directory:

# show known changes in Symfony 4.0
vendor/bin/rector process src --level symfony40 --dry-run
# apply
vendor/bin/rector process src --level symfony40

Tip: To process just specific subdirectories, you can use fnmatch pattern:

vendor/bin/rector process "src/Symfony/Component/*/Tests" --level phpunit60 --dry-run

B. Custom Sets

  1. Create rector.yaml with desired Rectors:

    services:
        Rector\Rector\Architecture\DependencyInjection\AnnotatedPropertyInjectToConstructorInjectionRector:
            $annotation: "inject"
  2. Run on your /src directory:

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

How to Apply Coding Standards?

AST that Rector uses doesn't deal with coding standards very well, so it's better to let coding standard tools do that. Your project doesn't have one? Rector ships with EasyCodingStandard set that covers namespaces import, 1 empty line between class elements etc.

Just use --with-style option to handle these basic cases:

vendor/bin/rector process src --with-style

4 Steps to Create Own Rector

First, make sure it's not covered by any existing Rectors yet.

Let's say we want to change method calls from set* to change*.

 $user = new User();
-$user->setPassword('123456');
+$user->changePassword('123456');

1. Create New Rector

Create class that extends Rector\Rector\AbstractRector. It has useful methods like checking node type and name. Just run $this-> and let PHPStorm show you all possible methods.

<?php declare(strict_types=1);

namespace App\Rector;

use PhpParser\Node;
use Rector\Rector\AbstractRector;
use Rector\RectorDefinition\RectorDefinition;

final class MyFirstRector extends AbstractRector
{
    public function getDefinition(): RectorDefinition
    {
        // what does this do?
        // minimalistic before/after sample - to explain in code
    }

    /**
     * @return string[]
     */
    public function getNodeTypes(): array
    {
        // what node types we look for?
        // String_? FuncCall? ...
        // pick any node from https://github.com/nikic/PHP-Parser/tree/master/lib/PhpParser/Node
        return [];
    }

    public function refactor(Node $node): ?Node
    {
        // what will happen with the node?
        // common work flow:
        // - should skip? → return null;
        // - modify it? → do it, then return $node;
        // - remove/add nodes elsewhere? → do it, then return null;
    }
}

2. Implement Methods

<?php declare(strict_types=1);

namespace App\Rector;

use Nette\Utils\Strings;
use PhpParser\Node;
use PhpParser\Node\Identifier;
use PhpParser\Node\Expr\MethodCall;
use Rector\Rector\AbstractRector;
use Rector\RectorDefinition\CodeSample;
use Rector\RectorDefinition\RectorDefinition;

final class MyFirstRector extends AbstractRector
{
    public function getDefinition(): RectorDefinition
    {
        return new RectorDefinition('Add "_" to private method calls that start with "internal"', [
            new CodeSample('$this->internalMethod();', '$this->_internalMethod();')
        ]);
    }

    /**
     * @return string[]
     */
    public function getNodeTypes(): array
    {
        return [MethodCall::class];
    }

    /**
     * @param MethodCall $node - we can add "MethodCall" type here, because only this node is in "getNodeTypes()"
     */
    public function refactor(Node $node): ?Node
    {
        // we only care about "internal*" method names
        $methodCallName = $this->getName($node);

        if (! Strings::startsWith($methodCallName, 'set')) {
            return null;
        }

        $newMethodCallName = Strings::replace($methodCallName, '#^set#', 'change');

        $node->name = new Identifier($newMethodCallName);

        return $node;
    }
}

3. Register it

# rector.yaml
services:
    App\Rector\MyFirstRector: ~

4. Let Rector Refactor Your Code

# see the diff first
vendor/bin/rector process src --dry-run

# if it's ok, apply
vendor/bin/rector process src

That's it!

More Detailed Documentation

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.

Run Rector in Docker

With this command, you can process your project with rector from docker:

docker run -v $(pwd):/project rector/rector:latest