Recipes for Decoupling
Recipes for Decoupling
About the Book
Looking for a print edition? It's available on Lulu.
Software is never done. The world around your program changes faster than you want it to. Frameworks and libraries are abandoned and replaced with something better (or just something new), so you need to migrate. You can postpone this work for a bit, but eventually you'll have to catch up, or your project may end up hopelessly outdated. I'm sure you know one or two of those projects!
How can you make all of this easier for yourself and the future maintainers of the project? The keyword is "decoupling". You can change the design of your code to defend it against changes in any dependency your project relies on. Decoupling your code is a way to make it future-proof (without doing too much work that "you ain't gonna need").
About 10 years ago I started looking for ways to decouple my code, but at first I struggled to do it effectively. My code was decoupled in the wrong places, or in the wrong way. I got a better view on this topic after several intense experiences with some legacy projects, a big framework migration, and a complete project rewrite (that I'm sure could have been prevented). I've collected many recipes for decoupling along the way. This book gives you a practical overview of common situations that suffer from an often unintended high level of coupling in web applications. Of course, it also gives you step-by-step recipes to improve these situations. The examples in this book show you how to decouple from your web framework, templating engine, test framework, ORM, and so on.
Decoupling is one thing, but staying decoupled is something else entirely. That's why in this book we focus on how to solidify the decoupling rules with PHPStan, the automated static analysis tool for PHP. That way we don't have to rely on discipline and code reviews, but can let a tool point out possible coupling mistakes.
Bundles that include this book
Table of Contents
-
Introduction
- Coupling, Why is it Bad?
- Decoupling, How to Do it Efficiently?
- Objection
- What’s Special About This Book?
- How to Stay Decoupled?
- Who Should Read This Book?
- Overview of the Contents
- About the Author
-
Changelog
- 10 May 2022
- 17 May 2022
- 26 May 2022
- 31 May 2022
- 7 June 2022
- 15 June 2022
- 29 June 2022
-
1 Creating Custom Rules for PHPStan
- Introduction
- Analyzing Code with PHPStan
- Catching Specific Node Types
- Adding Automated Tests for a PHPStan Rule
- Deriving Types from the Current Scope
- Putting a Node in Context
- Generalizing a Rule
- Conclusion
-
2 Web Frameworks
- Introduction
-
Controllers
- Show How the Response is Created
- Only Use Constructor Injection for Dependencies
- Make Every Step Explicit
- Controllers Have No Parent Class
- Every Action Has its Own Controller Class
- Should We Use an HTTP Abstraction Library?
-
Rules for Decoupled Controllers
- Forbidden Parent Classes
- Allowing Only Parameters of a Certain Type
- Enforcing Return Types
- One Action Per Controller
-
Views
- Pass All the Data That the Template Needs
- Don’t Pass Objects That Don’t Belong in a Template
-
Rules for Decoupled Views
- Don’t Use Certain Global Variables in a Template
- Don’t Use Certain Functions in a Template
- Don’t Pass Entities to a Template
- Conclusion
-
3 CLI Frameworks
- Introduction
-
Input
- Collect Input First
- Jump to a Service
-
Output
- Using an Observer for Showing Output
- Generalizing the Solution with Event Dispatching
- Turn the Command Class Itself Into an Event Subscriber
- Controllers Should Call Framework-agnostic Services
-
Rules for Decoupling
- Use InputInterface and OutputInterface Only in Command Classes
-
4 Form Validation
- Introduction
- Form Validation
- Protecting Data Inside the Model
- Delegating Protection to Value Objects
- Removing Duplicate Validation Logic
- Defining an Explicit Shape for the Input Data
-
Rules for Decoupling
- Don’t Pass a Single Array of Data to create()
- Enforcing the Use of Closure-based Form Validation
- Conclusion
-
5 ORMs and the Database
- Introduction
-
Repository: an Abstraction for Persistence
- Trying an Alternative Implementation
-
Application-generated IDs
- PHPStan Rule: Disallow Auto-incrementing Model IDs
- Defining Our Own Object API
-
Custom Mapping Code
- PHPStan Rule: Only Allow Calls to fromDatabaseRecord() from Repository Classes
-
No Magic Persistence of Related Objects
- Using Aggregate Design Rules
- Limiting Changes to One Entity
- Introducing View Models
- Provide Read Models When the Framework Needs Your Data
-
Use Domain Events Instead of Persistence Events
- PHPStan Rule: Forbidden Parameter Types
- Conclusion
-
6 Test Frameworks
- Introduction
- Use Only the Most Basic Features of a Test Framework
-
Declare Test Dependencies Explicitly
- PHPStan Rule: Don’t Allow PHPUnit Extensions
- PHPStan Rule: Don’t Allow Class-level Set-up and Tear-down Functions
- Assertions
- Write Tests in Plain Code
-
Handwritten Test Doubles
- PHPStan Rule: Don’t Generate Mocks
- Conclusion
- 7 Conclusion
- 8 The End of the Book
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,841,865writing, 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) and EPUB (for phones, tablets and 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
The Hitchhiker's Guide to DFIR: Experiences From Beginners and Experts
Barry Grundy, Tristram, John Haynes, ApexPredator, Andrew Rathbun, Kevin Pagano, Victor Heiland, Nisarg Suthar, Guus Beckers, and Jason WilkinsA first of its kind crowdsourced DFIR book written on GitHub by the members of the Digital Forensics Discord Server to share knowledge!
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.
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.
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.
Maîtriser Apache JMeter
Philippe Mouawad, Bruno Demion (Milamber), and Antonio Gomes RodriguesToute la puissance d'Apache JMeter expliquée par ses commiteurs et utilisateurs experts. De l'intégration continue en passant par le Cloud, vous découvrirez comment intégrer JMeter à vos processus "Agile" et Devops.
If you're looking for the newer english version of this book, go to Master JMeter : From load testing to DevOps
Software Architecture for Developers
Simon BrownA developer-friendly, practical and pragmatic guide to lightweight software architecture, technical leadership and the balance with agility.
Functional Event-Driven Architecture
Gabriel VolpeExplore the event-driven architecture (EDA) in a purely functional way. Learn to design and develop distributed systems that scale. Identify common design patterns in such systems.
Take your functional programming skills to the next level by joining me in developing a distributed system powered by Apache Pulsar and Fs2 streams, all in Scala 3!
Thinking with Types
Sandy MaguireThis book aims to be the comprehensive manual for type-level programming. It's about getting you from here to there---from a competent Haskell programmer to one who convinces the compiler to do their work for them.
Biological Modeling
Phillip CompeauIn this ebook, learn why zebras have stripes, why SARS-CoV-2 spread so quickly around the planet, how to train a computer to classify cellular images, and more!
Introduction to Data Science
Rafael A IrizarryThe demand for skilled data science practitioners in industry, academia, and government is rapidly growing. This book introduces concepts from probability, statistical inference, linear regression and machine learning and R programming skills. Throughout the book we demonstrate how these can help you tackle real-world data analysis challenges.
Top Bundles
- #1
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... - #2
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!? - #3
Software Architecture
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... - #4
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... - #5
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... - #6
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... - #8
Learn Git, Bash, and Terraform the Hard Way
3 Books
Learn Git, Bash and Terraform using the Hard Way method.These technologies are essential tools in the DevOps armoury. These books walk you through their features and subtleties in a simple, gradual way that reinforces learning rather than baffling you with theory. - #9
Static Analysis and Automated Refactoring
2 Books
As PHP developers we are living in the "Age of Static Analysis". We can use a tool like PHPStan to learn about potential bugs before we ship our code to production, and we can enforce our team's programming standards using custom PHPStan rules. Recipes for Decoupling by Matthias Noback teaches you in great detail how to do this, while also...