Rector - The Power of Automated Refactoring

Preface

1. A Trainer’s Journey
2. The Other Side
3. Who’s Fault is It?
4. From Blame to Pain
5. From Pain to Idea
6. From Idea to First Real Reconstructor
7. We’ve Just Started, Now You Get on Board

Introduction

1. What is Rector?
2. Who Should Read This Book?
3. An Overview of the Contents
4. About the Code Samples
5. About the Authors
6. Matthias Noback
7. Tomas Votruba
8. Acknowledgements
9. Tomas
10. Matthias

Programmatically Modifying PHP Code

1. This Chapter Covers:
2. Introduction
3. Primitive Ways of Modifying Code
4. Tokenizing PHP Code
5. Parsing PHP Tokens: the Abstract Syntax Tree
6. Converting the AST Back to PHP Code
7. Manipulating the AST
8. Node Visitors
9. Manipulating the AST with a Node Visitor
10. Built-in Node Visitors
11. Resolving Fully-qualified Names
12. Finding Nodes
13. Summary

PHP Tools in the Game

1. This Chapter Covers:
2. Introduction
3. Working Together with Giants
4. 2007 - Now Timeline
5. The Primary Feature
6. 1. Coding Standard Tools
7. PHP_CodeSniffer
8. PHP CS Fixer
9. Easy Coding Standard
10. 2. Static Analyzers
11. PHP-Parser
12. PHPStan
13. Psalm
14. 3. Instant Upgrade Tools
15. Symfony-Upgrade-Fixer
16. Rector
17. When to Use Which Tool?
18. Is Your Project Bare Without Any Tools?
19. Run Rector First, Then Polish with Coding Standards
20. Recommended Tools
21. Summary

Creating Your First Rector Rule

1. This Chapter Covers:
2. Introduction
3. What’s a Rector Rule?
4. Creating a Custom Rule
5. Requirements
6. Extending AbstractRector
7. Where to Store Your Rules?
8. Finding the Right Node Class
9. Install PHP-Parser
10. Expr vs Stmt
11. Running a Single Rule
12. Refactoring the Method Call Node
13. How Do We Know That?
14. What Is the Type of a Variable?
15. Commit Your Code Before Running Rector
16. What if We Run Rector Twice?
17. Effectivity Beats Perfection
18. Summary

Test-driven Rule Development

1. This Chapter Covers:
2. Introduction
3. Migrating from DateTime to DateTimeImmutable
4. Creating a Test Class
5. Install PHPUnit
6. Adding First Test Fixture
7. Making the First Test Pass
8. Use FullyQualified to avoid miss-imports
9. Narrowing the Scope of the Refactoring
10. Capturing the Return Value of modify()
11. Skipping Calls on Classes That Are Not DateTime
12. Summary

More Testing Techniques

1. This Chapter Covers:
2. Rules Should Be Idempotent
3. Removing the Clone Step
4. Low-Hanging Fruit First
5. Create a Configurable Generic Rule
6. Making Rule Behavior Configurable
7. Configurable Rule Makes Hidden Assumptions Explicit
8. Using Supporting Classes in Fixtures
9. Summary

Continuous Rectifying

1. This Chapter Covers:
2. Introduction
3. The Next Member of Your Team
4. Turning a Junior Into a Senior on Day 1
5. Who’s to Blame?
6. What Does it Look Like to Work with Rector in CI?
7. How Rector is Rectifying Itself
8. Removing Boring Work Opens Your Creativity
9. Summary

Rector + CI = Next Member of Your Team

1. This Chapter Covers:
2. Introduction
3. What are The Steps for a Rector Run?
4. How to Add Rector to GitHub Actions
5. 1. Generic PHP Setup
6. 2. Rector Setup
7. Allow Rector to contribute the Pull Request
8. Summary

The Future of Instant Upgrades

1. This Chapter Covers:
2. Introduction
3. Removing Legacy
4. How Can We Be So Confident?
5. A Member of your Team That Sends Pull-Requests Daily
6. PHP Stands Out

Epilogue

Node Type and Refactor Examples

Book Revisions

1. Update 2025-03-07
2. Update 2024-12-09 and Rector 2.0
3. Update 2024-02-07 and Rector 1.0
4. Update 2024-01-30 and Rector 0.19.3