Recipes for Decoupling
Recipes for Decoupling
About the Book
Looking for a print edition? It's available on Lulu.
"Future me will appreciate it if I apply even just half of the recipes in this fantastic book. I learnt something new from every chapter and I can't wait to share some of these methods with my teams." Andrew Barlow
"Another excellent book from Matthias Noback! I learned a lot about techniques how to decouple your application from frameworks, test suites and other libraries. And the best part: it showed me how to unleash the power of PHPStan with custom rules to make sure you stay decoupled." Stefan Blanke
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.
"Have you ever wondered how to efficiently decouple from your PHP framework? And how to enforce it through tooling? I did! And Recipes For Decoupling delivered me very well thought out explanations, examples and snippets for decoupling. It even explains step by step how to enforce these decoupling rules through PHPStan rules. The book contains examples from a variety of popular PHP frameworks including Symfony, Laravel, Mockery and PHPUnit." - Vincent Hagen
"'Decoupling' is a delightful read that merits a slow read because you will want to stop and code after every chapter! Noback’s clarity and honesty is welcome in an era of big personalities, as is his ability to distill framework concepts to elegant code." - Matthew Gatner
About the Author
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$12,153,952writing, 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
- #1
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.
- #2
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.
- #3
CCIE SP v5.0
Łukasz Bromirski, Piotr Jablonski, and Nicholas RussoAre you striving to prepare to and pass CCIE SP lab exam? Take the opportunity and get this workbook! With the attached initial cfg files you will prepare yourself for the CCIE SP exam as well as learn SP technologies applicable to all kinds of today modern networks! This workbook covers blueprint topics and provides challenging examples.
- #4
Functional Programming Made Easier
Charles ScalfaniA Functional Programming book from beginner to advanced without skipping a single step along the way.
In my 40 years of programming, I've felt that programming books always let me down, especially Functional Programming books. So, I wrote the book I wish I had 5 years ago.
Functional Programming will never be easy, but it can be easier.
- #5
C++20 - The Complete Guide
Nicolai M. JosuttisAll new language and library features of C++20 (for those who know previous C++ 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:
- #6
Windows 11 Field Guide
Rafael Rivera and Paul ThurrottThe Windows 11 Field Guide is a full-length e-book about the latest version of Microsoft Windows, aimed at those users who will upgrade from Windows 10 or acquire Windows 11 with a new PC.
- #7
Production Haskell
Matt ParsonsAre you excited about Haskell, but don't know where to begin? Are you thrilled by the technical advantages, but worried about the unknown pitfalls? This book has you covered.
- #8
The PowerShell Scripting and Toolmaking Book
Don Jones and Jeff HicksLearn the patterns, practices, and details of PowerShell Scripting and Toolmaking from the industry's two most recognized experts on the subject.
- #9
The Art of Functional Programming
Minh Quang Tran, PhDA master class on the fundamentals and principles of functional programming. It contains 20 programming challenges with detailed solutions and 44 quizzes with answers and explanations. Moreover, 84 diagrams graphically illustrate how concepts and techniques work. Two real-world use cases show how to apply functional programming in practice.
- #10
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.
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
1500 QUIZ COMMENTATI (3 libri)
3 Books
Tre libri dei QUIZ MMG Commentati al prezzo di DUE! I QUIZ dei concorsi ufficiali di Medicina Generale relativi agli anni: 2000-2001-2003-2012-2013-2014-2015-2016-2017-2018-2019-2020-2021 +100 inediti Raccolti in unico bundle per aiutarvi nello studio e nella preparazione al concorso. All'interno di ogni libro i quiz sono stati suddivisi per... - #3
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... - #5
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... - #9
Statistics - All Lee Baker's Books
10 Books
This bundle includes all of the statistics books that Lee Baker has published at LeanPub 13 Statistics Books*1 PlaceNo Hassle! All in both epub and mobi formats - perfect for all devices and screen sizes. --------------------------------------------------------- *The book listed as Getting Started With Statistics is a bundle of 4 books...
