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$12,151,660writing, 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
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.
- #10
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.
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... - #3
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... - #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... - #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...
