Semi-Automated Refactoring and Upgrades with Rector

Rector is a CLI tool that assists with upgrading and refactoring of PHP projects. Do you seek to save months of mindless work and frustration on your next PHP upgrade?

After a brief introduction to Rector using practical examples, I will show you what it can and can't do for you. I will also give real-world tips on PHP upgrades and how you can best leverage Rector and other automated tools.

Transcript

1. © Perforce Software, Inc. Semi-Automated Refactoring and Upgrades with Rector International PHP Conference Anna Filina | November 2024
2. © Perforce Software, Inc. Automated Refactoring -array_push($items, $item); +$items[] = $item;
3. © Perforce Software, Inc. What is Rector What it does and doesn’t do How I upgrade How I leverage automated tools Agenda
4. © Perforce Software, Inc. Anna Filina • Coding since 1997 • PHP, Java, C#, etc. • Zend Professional Services • I fix your legacy • I write your tests • I teach you all my tricks
5. © Perforce Software, Inc. Legacy PHP • 4M lines of code • As low as PHP 4 • register_globals • undefined vars • dead libraries • removed extensions
6. © Perforce Software, Inc.
7. © Perforce Software, Inc. What is Rector
8. © Perforce Software, Inc. Rector • CLI tool • Has out-of-the box rules • Written in PHP, for PHP
9. © Perforce Software, Inc. Example PHPSpreadsheet PHPExcel
10. © Perforce Software, Inc. Steps $ composer require rector/rector-phpoffice --dev $ vendor/bin/rector init return function (RectorConfig $rectorConfig): void { $rectorConfig->import( PHPOfficeSetList::PHPEXCEL_TO_PHPSPREADSHEET ); }; $ vendor/bin/rector process src
11. © Perforce Software, Inc. Result -$worksheet->getDefaultStyle(); +$worksheet->getParent()->getDefaultStyle(); -$worksheet->setSharedStyle($sharedStyle, $range); +$worksheet->duplicateStyle($sharedStyle, $range); -$cell = $worksheet->setCellValue('A1', 'value', true); +$cell = $worksheet->getCell('A1')->setValue('value'); -PHPExcel_Cell::absoluteCoordinate() +PhpOffice\PhpSpreadsheet\Cell\Coordinate::absoluteCoordinate()
12. © Perforce Software, Inc. How Rector Works Static analysis
13. © Perforce Software, Inc. How Rector Works Rules hook into relevant nodes Static analysis Fix is applied references to PHPExcel_Cell rename to PhpOffice\PhpSpreadsheet \Cell\Coordinate
14. © Perforce Software, Inc. Types -function save() {} +function save(): void {}
15. © Perforce Software, Inc. More Types public function search(int $id) { $this->fetch($id); } -private function fetch($id) +private function fetch(int $id)
16. © Perforce Software, Inc. Frameworks - /** - * @Route("/path", name="action") - */ + #[Route(path: '/path', name: 'action')]
17. © Perforce Software, Inc. Rector Rules • Framework rules: Symfony • Library rules: Doctrine, PHPUnit, PHPSpreadsheet • Upgrade rules: PHP 5.3, 5.4, etc. • Configurable rules: add arg to method signature and its references • Can write your own custom rules.
18. © Perforce Software, Inc. What it Does and Doesn’t Do
19. © Perforce Software, Inc. Limitations $db = new Db();
20. © Perforce Software, Inc. PHP 4 Style Constructor class MyClass { - public function MyClass() + public function __construct() { } }
21. © Perforce Software, Inc. Incorrect Solution class ChildClass extends ParentClass { - public function ChildClass() + public function __construct() { $this->ParentClass(); } } Uncaught Error: Call to undefined method ChildClass::ParentClass()
22. © Perforce Software, Inc. PHPStorm’s Solution - $this->ParentClass() + ParentClass::__construct() https://www.zend.com/php-migration/function-name- restrictions/removed-php4-style-constructor
23. © Perforce Software, Inc. Use all available automated tools, not just one.
24. © Perforce Software, Inc. Don’t blindly rely on automation.
25. © Perforce Software, Inc. How I Upgrade
26. © Perforce Software, Inc. Support Period 7.4 5.3 8.3 5.3
27. © Perforce Software, Inc. Extended Support Period 7.4 5.3 8.3 Community PHP 7.4: November 2022 ZendPHP 7.4: December 2026 Due date: December 2026
28. © Perforce Software, Inc. Avoid Regressions Make changes Did behavior change? Write tests 5,000 changes 3,000 changes 7,000 changes
29. © Perforce Software, Inc. npm install cypress
30. © Perforce Software, Inc. npx cypress open
31. © Perforce Software, Inc. Branches Legacy Upgrade
32. © Perforce Software, Inc. Tests Execute on legacy & upgrade First test passes on upgrade Write tests Make changes
33. © Perforce Software, Inc. How I Leverage Automated Tools
34. © Perforce Software, Inc. PHPCompatibility FILE: /var/www/upgrade/my_account.php ------------------------------------------------------------------------ FOUND 1 ERROR AND 1 WARNING AFFECTING 3 LINES ------------------------------------------------------------------------ 202 | ERROR | Function split() is deprecated since PHP 5.3 and removed since PHP 7.0; Use preg_split() instead -------------------------------------------------------------------------
35. © Perforce Software, Inc. Migration Guides
36. © Perforce Software, Inc. Mixed Types 1 > 'a' // 5.6: true // 8.3: false
37. © Perforce Software, Inc. Undefined Variables ini_set('date.timezone', 'UTC'); date('Y-m-d H:i', $timestamp); // 5.6: string(16) "2024-01-01 12:00" // 8.3: string(16) "1970-01-01 00:00"
38. © Perforce Software, Inc. Custom Rector Rules Zend Framework 1 Mezzio
39. © Perforce Software, Inc. Custom Rector Rules Account\IndexHandler AccountController indexAction() viewAction() Zend Framework 1 Mezzio Account\ViewHandler
40. © Perforce Software, Inc. Thank You @afilina@phpc.social @afilina afilina@perforce.com