Rector - The Power of Automated Refactoring
Rector - The Power of Automated Refactoring
About the Book
Rector is an extremely powerful tool that can instantly improve the code quality of your PHP projects. It can be used to safely migrate projects from PHP 5.6 to PHP 8. It can help you establish a standard of robust programming practices in your project. And it can save you a lot of time spent on reviewing pull requests.
In this book, seasoned developers Matthias Noback and Tomas Votruba give you all the information you need to become a Rector power user. You'll learn:
- How to make Rector part of your daily development workflow
- How to create Rector rules that replace repetitive manual refactoring work
- How to automate even more with Rector by adding it to your project's build process
Tomas, being the founding father and core maintainer of the Rector project, will shine his light on:
- What's the place of Rector in the larger ecosystem of PHP tools for code quality assurance?
- What role will Rector fulfill in the future?
Matthias, who has a strong focus on automated testing, will cover:
- The concepts behind Rector: tokenizing, parsing, and manipulating PHP AST nodes
- Test-driven development techniques for creating automated refactorings
What readers say
"I've been following Rector for a couple of years now. I've been very excited by the claims and demos but try as I might to get an understanding and a usable knowledge I just couldn't... until the book. Now within the space of a few days I have started to integrate Rector into a 20-year-old project (with a couple million lines of code) at work. My commits have increased, I have been able to find way more problems early on in code reviews, and I have started to clean up a lot of legacy spaghetti code.
Many thanks for the book, it has really really.... REALLY helped!"
-- Steve Hyde
"Grabbed my copy. This was an absolute nobrainer.
(one day later)
I already read through the whole thing. Nice work. Next step is to create some rules"
-- @psren
"The book is easy to read in a complex subject to me. Congrats both on your excellent work!!"
-- @KPikaza
"18 years ago, I bought my first technical book ever PHP 4 Bible. To master how to automatically refactor code using the same language on which it is written is something I could've not foreseen back then."
-- Oscar Nevarez
"I read most of the book already. Learned lots about the abstract syntax tree and how to create and test Rector rules. I can recommend any PHP developer to read this book!"
-- Tijmen Wierenga
"Purchased! My mind is already buzzing with ideas on how to use this on a legacy PHP project I just took over."
-- Joel Clermont
Table of Contents
-
Preface
- A Trainer’s Journey
- The Other Side
- Who’s Fault is It?
- From Blame to Pain
- From Pain to Idea
- From Idea to First Real Reconstructor
- We’ve Just Started, Now You Get on Board
-
Introduction
- What is Rector?
- Who Should Read This Book?
- An Overview of the Contents
- About the Code Samples
-
About the Authors
- Matthias Noback
- Tomas Votruba
- Acknowledgements
- We Want Your Feedback
-
Programmatically Modifying PHP Code
- Introduction
- Primitive Ways of Modifying Code
- Tokenizing PHP Code
- Parsing PHP Tokens: the Abstract Syntax Tree
- Converting the AST Back to PHP Code
- Manipulating the AST
- Node Visitors
- Manipulating the AST with a Node Visitor
-
Built-in Node Visitors
- Connecting Nodes
- Resolving Fully-qualified Names
- Finding Nodes
- Summary
-
PHP Tools in the Game
- Introduction
- Working Together with Giants
- 2007 to 2021 Timeline
- The Primary Feature
-
1. Coding Standard Tools
- PHP_CodeSniffer
- PHP CS Fixer
- EasyCodingStandard
-
2. Static Analyzers
- PHP-Parser
- PHPStan
- Psalm
-
3. Instant Upgrade Tools
- Symfony-Upgrade-Fixer
- Rector
-
4. Instant Downgrade Tools
- PHP-Backporter
- Galapagos
- Transphpilea
- 7to5
- Rector
- When to Use Which Tool?
- Is Your Project Bare Without Any Tools?
- Run Rector First, Then Polish with Coding Standards
- Recommended Tools
- Summary
-
Creating Your First Rector Rule
- Introduction
- What’s a Rector Rule?
- Creating a Custom Rule
-
Extending AbstractRector
- Finding the Right Node Class
- Running a Single Rule
-
Refactoring the Method Call Node
- What Is the Type of a Variable?
-
What if We Run Rector Twice?
- Effectivity Beats Perfection
- Summary
-
Test-driven Rule Development
- Introduction
- Migrating from DateTime to DateTimeImmutable
- Creating a Test Class
- Adding First Test Fixture
- Making the First Test Pass
- Narrowing the Scope of the Refactoring
- Capturing the Return Value of modify()
- Skipping Calls On Classes That Are Not DateTime
- Summary
-
More Testing Techniques
- Testing Multiple Rules Combined
- Rules Should Be Idempotent
- Removing the Clone Step
- Comparing Return Values to Validate Correctness
- Shouldn’t You Start with a Rule Set Test?
- Low-Hanging Fruit First
- Create a Configurable Generic Rule
- Using a Configurable Instead of a Custom Rule
- Making Rule Behavior Configurable
- Configurable Rule Makes Hidden Assumptions Explicit
- Using Supporting Classes in Fixtures
- Summary
-
Continuous Rectifying
- Introduction
- The Next Member of Your Team
- Turning a Junior Into a Senior on Day 1
- Who’s to Blame?
- What Does it Look Like to Work with Rector in CI?
- How Rector is Rectifying Itself
- Work First, Enjoy Later
- Removing Boring Work Opens Your Creativity
- Summary
-
Rector + GitHub Actions = Next Member of Your Team
- Introduction
- What Are The Steps for a Rector Run?
-
How to Add Rector to GitHub Actions
- 1. Generic PHP Setup
- 2. Rector Setup
- What Feedback Do We Get?
-
How to Work with Rector’s Output?
- 1. Manual Changes
- 2. Run Rector Locally
- 3. Let Rector Code for Us in Pull Requests
- What is The Work We Want to Automate?
-
Make Your Rector Workflow Come Alive
- Make Rector Push Changes
- Summary
-
The Future of Instant Upgrades
- Introduction
-
Removing Legacy
- How Can We Be So Confident?
- No Backward-Compatibility Breaks and No Backward-Compatibility
- A Bot That Sends Pull-Requests Daily
- Instant Upgrades on Click
- PHP Stands Out
- Epilogue
The Leanpub 60-day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Do Well. Do Good.
Authors have earned$11,592,641writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
SignalR on .NET 6 - the Complete Guide
Fiodar SazanavetsLearn everything there is to learn about SignalR and how to integrate it with the latest .NET 6 and C# 10 features. Learn how to connect any type of client to SignalR, including plain WebSocket client. Learn how to build interactive applications that can communicate with each other in real time without making excessive calls.
- #2
The easiest way to learn design patterns
Fiodar SazanavetsLearn design patterns in the easiest way possible. You will no longer have to brute-force your way through each one of them while trying to figure out how it works. The book provides a unique methodology that will make your understanding of design patterns stick. It can also be used as a reference book where you can find design patterns in seconds.
- #3
C++20 - The Complete Guide
Nicolai M. JosuttisAll the new language and library features of C++20 (for those who know previous versions).
The book presents all new language and library features of C++20. Learn how this impacts day-to-day programming, to benefit in practice, to combine new features, and to avoid all new traps.
Buy early, pay less, free updates.
Other books:
- #4
Jetpack Compose internals
Jorge CastilloJetpack Compose is the future of Android UI. Master how it works internally and become a more efficient developer with it. You'll also find it valuable if you are not an Android dev. This book provides all the details to understand how the Compose compiler & runtime work, and how to create a client library using them.
- #5
Functional event-driven architecture: Powered by Scala 3
Gabriel VolpeExplore the event-driven architecture (EDA) in a purely functional way, mainly powered by Fs2 streams in Scala 3!
Leverage your functional programming skills by designing and writing stateless microservices that scale, powered by stateful message brokers.
- #6
OpenIntro Statistics
David Diez, Christopher Barr, Mine Cetinkaya-Rundel, and OpenIntroA complete foundation for Statistics, also serving as a foundation for Data Science.
Leanpub revenue supports OpenIntro (US-based nonprofit) so we can provide free desk copies to teachers interested in using OpenIntro Statistics in the classroom and expand the project to support free textbooks in other subjects.
More resources: openintro.org.
- #7
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
- #8
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #9
CCIE Service Provider Version 4 Written and Lab Exam Comprehensive Guide
Nicholas RussoThe service provider landscape has changed rapidly over the past several years. Networking vendors are continuing to propose new standards, techniques, and procedures for overcoming new challenges while concurrently reducing costs and delivering new services. Cisco has recently updated the CCIE Service Provider track to reflect these changes; this book represents the author's personal journey in achieving that certification.
- #10
Cronache di Domain-Driven Design
Francesco Strazzullo, Matteo Baglini, Gianluca Padovani, Emanuele DelBono, Marco Consolaro, Alessandro Colla, Uberto Barbini, Alberto Acerbis, Julie Camosseto, DDD Open, and Alberto BrandoliniCronache di Domain-Driven Design: un libro corale in italiano fatto di storie indipendenti tra loro, che sono il risultato dell’applicazione di Domain-Driven Design su progetti reali.
Top Bundles
- #1
Practical FP in Scala + Functional event-driven architecture
2 Books
Practical FP in Scala (A hands-on approach) & Functional event-driven architecture, aka FEDA, (Powered by Scala 3), together as a bundle! The content of PFP in Scala is a requirement to understand FEDA so why not take advantage of this bundle!? - #2
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #3
All the Books of The Medical Futurist
6 Books
We put together the most popular books from The Medical Futurist to provide a clear picture about the major trends shaping the future of medicine and healthcare. Digital health technologies, artificial intelligence, the future of 20 medical specialties, big pharma, data privacy, digital health investments and how technology giants such as Amazon... - #4
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #6
Pattern-Oriented Memory Forensics and Malware Detection
2 Books
This training bundle for security engineers and researchers, malware and memory forensics analysts includes two accelerated training courses for Windows memory dump analysis using WinDbg. It is also useful for technical support and escalation engineers who analyze memory dumps from complex software environments and need to check for possible... - #7
Modern C++ Collection
3 Books
Get All about Modern C++C++ Standard Library, including C++20Concurrency with Modern C++, including C++20C++20Each book has about 200 complete code examples. Updates are included. When I update one of the books, you immediately get the updated bundle. You can expect significant updates to each new C++ standard (C++23, C++26, .. ) and also... - #10
Growing Agile: The Complete Coach's Guide
7 Books
Growing Agile: Coach's Guide Series This bundle provides a collection of training and workshop plans for a variety of agile topics. The series is aimed at agile coaches, trainers and ScrumMasters who often find themselves needing to help teams understand agile concepts. Each book in the series provides the plans, slides, handouts and activity...
