Gradual Modularization for Ruby and Rails
Gradual Modularization for Ruby and Rails
Improve collaboration, system design, and flexibility
About the Book
For the longest time, Ruby and Rails developers had gems and engines as their main tools for creating structure to manage large-scale structures within their applications. This book is about a new tool in their toolbelt: packages.
Based on the work on packwerk by Shopify packages allow a much more fluid move to modularization then components ever did. The effects are astounding: discussions about where to draw boundaries can be far less technical and focus more on the business because the underlying technology gets out of the way.
The concept underlying this is gradual modularization, which the author expects we will see spread into other languages and frameworks over the coming years. Why? Because gradual modularization allows for a not-before seen level of approachability and flexibility to modularization work. Work that required difficult decisions that were hard to reverse changes. Those decisions are now the extreme points on a spectrum of options where the right thing for the team can be somewhere in between.
About the Author
Table of Contents
- Acknowledgments
-
1 Introduction to Package-based Rails Applications
- 1.1 The inescapable challenges with components
-
1.2 Component-based Challenges
- 1.2.1 External dependency drift
- 1.2.2 Configuration drift
- 1.2.3 Global impact of local changes
-
2 Getting started with packaging in a Rails application
- 2.1 Let’s get started
-
2.2 From one to many packages
- 2.2.1 Packwerk packages vs gems as components
- 2.2.2 A completely packagified application
- 2.2.3 Introducing app/packages
- 2.2.4 Getting things to work
- 2.2.5 Making packwerk packages
- 2.2.6 Visualizing dependencies
- 2.3 Accepting the intended dependencies - explicitly adding package dependencies
- 2.4 Removing the circular dependencies - creating rails_shims package
- 2.5 Analyzing and removing root dependencies (almost) - Aligning app and test code
- 2.6 Removing all dependencies from root
- 2.7 Recapping differences and similarities to components
-
3 Gradual Modularization: A New Model for Application Composition
- 3.1 Gradual Typing as a Role Model
- 3.2 Commonalities of previous modularization approaches
-
3.3 Gradularity - Modularization Game Changer
- 3.3.1 Enforce Visibility
- 3.3.2 Allow privacy circumvention
- 3.3.3 API versioning
- 3.3.4 Enforcing a package namespace
- 3.3.5 Enforcing a separate database
- 3.3.6 Enforcing a typed API
- 3.3.7 Enforcing proper documentation
- 3.3.8 Configurable failure modes
- 3.3.9 Here is my code, run it in the cloud for me, I do not care how
- 3.3.10 Analyze to modularize the right stuff
- 3.3.11 Caveats
- 3.3.12 Managing the caveats
-
4 Making Components work with Packages
- 4.1 Engines
-
4.2 Gems
- 4.2.1 Converting the gem fully into an engine
- 4.2.2 Converting the gem into an engine (as little as possible!)
-
5 Dependency Violation Management Refactorings
- 5.1 Do absolutely nothing
- 5.2 Accept the dependency
- 5.3 Merge the two packages
- 5.4 Split the violated package
- 5.5 Move the code between packages
- 5.6 Duplicate the functionality
- 5.7 Abstract away the dependency
-
5.8 Dependency injection
- 5.8.1 Naive dependency injection
- 5.8.2 Dependency injection with typing
- 5.8.3 Dependency injection with typing and type abstraction
- 5.9 Dependency Location - The service locator pattern
-
5.10 Emit and listen to events
- 5.10.1 To event or not to event - and where?
- 5.10.2 Calculating backend responses with events
- 5.10.3 Determining where to send responses
- 5.10.4 Wiring backend and frontend together
- 5.10.5 The package effect of eventing
- 5.11 Beyond dependency refactorings
-
6 Privacy Violation Management Refactorings
-
6.1 Packages without consumers should protect their public API
- 6.1.1 The root package
- 6.1.2 The UI and admin packages
-
6.1.3
packages/prediction_interfaceand interface classes
- 6.2 Expose existing service classes
- 6.3 Expose existing service classes
- 6.4 ActiveRecord handled naively
-
6.5 Hide ActiveRecord
-
6.5.1 A new form of
Team -
6.5.2 A
TeamRepositoryto manage teams - 6.5.3 Migrating consumers to the new API
-
6.5.1 A new form of
-
6.1 Packages without consumers should protect their public API
-
7 Big Rails
- 7.1 The giants who’s shoulders we stand on
- 7.2 Gusto’s Big Rails work supporting Gradual Modularity
- 7.3 Stimpack
- 7.4 BigRails Teams
- 7.5 ParsePackwerk
- 7.6 Code ownership
- 7.7 PackageProtections
- 7.8 Danger::Packwerk
- 7.9 ModularizationStatistics
- 7.10 Honorable mentions: More of Gusto’s BigRails
- 7.11 The Structure of BigRails
-
8 Measuring Modularization Progress
-
8.1 Basic technical measures of modularization progress
- 8.1.1 How modularized is the app?
- 8.1.2 Are there an adequate amount of packages?
- 8.1.3 How much are packages owned by only one team?
- 8.1.4 How discerning is the package dependency graph?
- 8.1.5 Basic technical measures create a path
-
8.2 Refining technical measures of modularization progress
- 8.2.1 How many packages protect themselves from breaking their own stated dependencies?
- 8.2.2 How many packages protect themselves against privacy violations?
- 8.2.3 How much are packages operating in their own namespace?
- 8.2.4 How many packages protect themselves against untyped APIs?
- 8.3 Growing the list of technical measures your organization can support
-
8.1 Basic technical measures of modularization progress
-
9 Future Work
- 9.1 Hotspot analysis
- 9.2 Automatic packaging of applications of any size
- 9.3 Other stuff in packages
- 9.4 Conditional Builds for packages
- 9.5 Private by default
- 9.6 Multi-faceted dependency graph drawing
- Notes
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,815,072writing, 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
Stratospheric
Tom Hombergs, Björn Wilmsmann, and Philip RiecksFrom Zero to Production with Spring Boot and AWS. All you need to know to get a Spring Boot application into production with AWS. No previous AWS knowledge required.
Go to stratospheric.dev for a tour of the contents.
- #2
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:
- #3
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.
- #4
node-opcua by example
Etienne RossignonGet the best out of node-opcua through a set of documented examples by the author himself that will allow you to create stunning OPCUA Servers or Clients.
- #5
Advanced Web Application Architecture
Matthias NobackThe missing manual for making your web applications future-proof
- #6
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.
- #7
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.
- #8
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.
- #9
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
- #10
D3 Start to Finish
Peter CookD3 Start to Finish shows you how to build a custom, interactive and beautiful data visualisation using the JavaScript library D3.js (versions 6 & 7).
The book covers D3.js concepts such as selections, joins, requests, scale functions, events & transitions. You'll put these concepts into practice by building a custom, interactive data visualisation.
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
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
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
Retromat eBook Bundle for Agile Retrospectives
2 Books
If you facilitate retrospectives this bundle is for you: "Plans for Retrospectives" helps beginners learn the lay of the land with tried-and-true plans. Once you know your way around, "Run great agile retrospectives" contains all 135+ activities in Retromat for you to mix and match. - #8
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... - #10
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!?
