packwerk VS Annotate

gem "packwerk" - https://github.com/Shopify/packwerk | Allows modularising Ruby code, a must-have for growing projects.

Yep, that article is about very similar concepts but grounded in Spring as the framework.

I like what they do around package imports and it looks a lot like what we do at incident.io, with some rules about which packages can import what.

For people in the Ruby world who want a similar solution, Shopify provide an open-source framework called packwerk that is designed just for this:

https://github.com/Shopify/packwerk

I’d probably go with packwerk before rails engines these days

https://github.com/Shopify/packwerk allows you to make dependencies between components explicit

Packwerk – to enforce boundaries and modularize Rails applications

Take a look at Packwerk from some folks at Shopify - gets you the benefits of naming some components for organizing boundaries in your code, with each component having the usual rails folder structure, but without the hard isolation restrictions of doing so with Engines.

Nothing is stopping you from doing so except you (and maybe packwerk, but you very likely don't have that installed).

For me, the most important aspect of a growing Rails app is handling of complexity and interdependencies and turns out Shopify's packwerk is just what the doctor ordered - it leverages zeitwerk loader to improve on Rails' vanilla file structure, allowing to group files by business concept or sub-domain and control visibility and ownership.

Let's set the stage right quick. You happen to be in a large Rails application that follows along with something like Packwerk to clearly delineate different packages in your Rails monolith. Let's say you have 100 packs, which is not particularly unusual with larger applications.

gem "annotate" - https://github.com/ctran/annotate_models | Adds DB-schema comments to models. May be unnecessary on RubyMine, YMMW.

I believe Ctran is aware of this based on his response in this issue https://github.com/ctran/annotate_models/issues/913

A gem that's pretty useful alongside this one is the annotation gem -- it prefixes models with their specific schema dump (as comments) and then updates those descriptive comments on migration. It's one of my go-to gems to install when I rotate onto a new-to-me Rails project (or start a new one) and I'm working to understand the data model.

Have you looked at annotate for inspiration?

I get it, though. Sounds like you're used to seeing every column definition in there. And that would be handy. There is a gem that you might like: https://github.com/ctran/annotate_models

annotate for annotations