Run `rails generate` commands automatically when Super Scaffolding #547

gazayas · 2023-09-13T11:43:52Z

Closes bullet-train-co/bullet_train#988.

gazayas · 2023-09-13T11:46:02Z

The plan from here is to run rails generate for the crud scaffolder first and try to go through each model in the test setup script step by step.

gazayas · 2023-09-22T12:58:07Z

cc/ @jagthedrummer @pascallaliberte @kaspth

Hey everyone, I decided to tag you guys because I think this PR could go one of two ways, one of which would have a big impact on our Super Scaffolding flow.

Our two options

Running something like bin/super-scaffold crud Project Team title:text_field will automatically run the rails g model command before scaffolding all of our templates, etc.
Instead, we can just add a flag like this: bin/super-scaffold crud Project Team title:text_field -—run-migration.

The current state of this PR

This PR currently works with commands like the following (option 2):

bin/super-scaffold crud Project Team title:text_field --run-migration
bin/super-scaffold crud-field Project test_number:number_field test_boolean:boolean --run-migration

My thoughts

I think 1 is closer to vanilla Rails scaffolding, but I'm afraid there will be situations in which we WON'T want to Super Scaffold all of the attributes to the new views. In this scenario, we could add a flag to say --skip-migration instead.

If we go with option 2, Bullet Train developers can still do things the old way, and if they're certain they want to run the migration on the spot then they can just add the --run-migration flag.

What seems most intuitive to you all? I personally like 1 the most, but I think developers will get thrown off if they are too used to the original workflow.

jagthedrummer · 2023-09-22T15:07:14Z

@gazayas, do we need to automatically run migrations before we can super scaffold things? (I don't know a lot about the internals of how super scaffolding works.)

In general I think we should try to stick as closely as possible to the "normal Rails way", mainly so that things feel familiar and intuitive for devs that are already familiar with those patterns. So I'm kind of inclined to just tell people to run the migration themselves the normal way.

For example, if I were scaffolding a project in vanilla rails I'd do something like:

rails g scaffold Project team:references title:string
rails db:migrate

And so, (possibly naively) I'd expect the same general pattern for super scaffolding:

bin/super-scaffold crud Project Team title:text_field
rails db:migrate

Using a --run-migrations flag feels like a nice "quality of life" improvement that would allow me to combine everything into a single step if I know that's what I want.

Conversely requiring a --skip-migrations flag in order to make things work closer to The Rails Way seems like it assumes people will already posses some knowledge about The Bullet Train Way. (Not that that's necessarily bad. There's certainly a story we could tell about how we're saving you a step.)

As far as how to handle fields that shouldn't be on the form, I think that if we don't run the migration for people that they'd be able to handle it "the normal Rails way". That is they could either:

Generate a scaffold for the things that should show up in the form, and then edit the migration to add additional columns that shouldn't be on the form.
Generate a scaffold for the things that should show up in the form and also generate a second migration to add some additional non-form fields.
Generate the scaffold with all of the fields, and then edit the form and controller to remove attributes that shouldn't be user-facing.

And if we do run migrations for people then it's pretty easy to follow up with a second vanilla migration to add whatever extra fields are needed.

Aside

Not suggesting we tackle it in this PR, but it would be nice if we could get our super scaffolding commands to be closer to vanilla rails commands. I'd love to be able to do:

rails g super-scaffold Project Team title:text_field
rails db:migrate

gazayas · 2023-09-22T22:53:14Z

@jagthedrummer Thank you for the feedback! I realized there's a portion that I didn't explain, so I'll write that here and maybe that will clear things up.

`--run-migrations`

I had trouble naming this flag because crud and crud-field accomplish two different things. This flag doesn't run rails db:migrate, but does the following:

For the crud scaffolder, it runs rails g model ModelName
For the crud-field scaffolder, it runs rails g migration migration_name

I originally wanted to name this --generate-model to cover both of the scaffolders, but crud-field doesn't actually generate a model. I also didn't want to name it --generate-migration because I felt it would be too long. So yes, I'm not 100% sure what to call the flag name right now, but I can see how --run-migration implies rails db:migrate, which is not what we want. After reading your comment though, I feel more confident that we can just do away with the flag.

Defining separate attributes in a different migration

Generate a scaffold for the things that should show up in the form, and then edit the migration to add additional columns that shouldn't be on the form.

Generate a scaffold for the things that should show up in the form and also generate a second migration to add some additional non-form fields.

Yes, I like these either one of these (mostly the second option). I think we can mention it shortly in the Super Scaffolding documentation and that that would suffice.

gazayas · 2023-09-22T23:37:34Z

Joint PR

Update Super Scaffolding system test setup for automated rails g commands bullet_train#1030

jagthedrummer · 2023-09-25T14:45:40Z

@gazayas, thanks for the additional info. With that new info I agree with your initial assessment that the first option you presented is the best. (But if we want to go with the second option for some reason I think the flag should be named --generate-migration instead of --run-migration. Even though it's a bit longer I think it's clearer as to what it does.)

kaspth · 2023-09-25T16:27:55Z

Would it be clearer if we added this as separate commands like crud-migration and crud-field-migration? I know that could be a problem if we added more options in the future, but it feels tough to name the migration option without having it be ambiguous.

…_id attributes

gazayas · 2023-09-26T12:15:32Z

@kaspth I personally like just bin/super-scaffold crud and automatically creating the migrations that way, but I'm open to crud-migration and crud-field-migration too!

Until we decide, I've added the --skip-migration-generation flag in the meantime:

rails g model Project team:references title:string
bin/super-scaffold crud Project Team title:text_field --skip-migration-generation

gazayas · 2023-09-26T12:18:56Z

This PR is ready for review, I'm still working on updating the documentation though and I'll have to think through delegated types because I don't think we have a test in place for this.

kaspth · 2023-09-26T16:14:42Z

@gazayas ok, that sounds good to me!

gazayas · 2023-09-27T10:09:57Z

Looking at the documentation for delegated types, you can see that we generate a polymorphic model:

rails g model Entry team:references entryable:references{polymorphic}:index

I currently don't have a solution in mind that would automatically run this Rails command, but I've at least added the --skip-migration-generation flag in the documentation so developers can still run the code properly.

pascallaliberte · 2023-09-28T13:41:06Z

I like this a lot. Classy.

jagthedrummer · 2023-09-29T02:32:52Z

I've been a little thin on time this week and haven't been able to do a thorough review yet, but I'm really looking forward to getting this merged. It'll be a very nice quality of life improvement. 🎉

jagthedrummer

I just pulled this down and played around with it and I love it! It feels much more like it's an enhancement to the Rails scaffolding procedure that I already know vs being a whole new procedure that has different types of steps than I'm used to.

Since this will change scaffolding behavior on people, but will not break existing code, I'm thinking we should do a minor version bump when we release this one. What do y'all think @gazayas, @kaspth, @pascallaliberte?

jagthedrummer · 2023-10-03T20:47:31Z

bullet_train-super_scaffolding/lib/scaffolding/script.rb

+  email_field: "string",
+  emoji_field: "string",
+  file_field: "attachment",
+  image: "attachment",


Should this be active_storage_image? Or should we remove cloudinary_image above and then have image be a special case where we don't do a direct lookup, but instead check whether Cloudinary is active?

jagthedrummer · 2023-10-03T20:50:41Z

bullet_train-super_scaffolding/lib/scaffolding/script.rb

@@ -53,6 +113,19 @@ def check_required_options_for_attributes(scaffolding_type, attributes, child, p
      {}
    end

+    data_type = if type == "image" && cloudinary_enabled?
+      "string"


Oh, here's that special case I mentioned above. Maybe we remove cloudinary_image from that list? (Or do we want to leave it for backwards compatibility?)

Maybe we remove cloudinary_image from that list? (Or do we want to leave it for backwards compatibility?)

Right, I was planning on leaving it here for backwards compatibility. However, if we were to delete it, it technically wouldn't be breaking anything so I don't feel too strongly either way right now about leaving it or deleting it.

gazayas · 2023-10-04T06:32:27Z

Since this will change scaffolding behavior on people, but will not break existing code, I'm thinking we should do a minor version bump when we release this one.

@jagthedrummer I think doing a minor version bump makes sense! Although I will say I'm not too strong when it comes to semantic versioning. I'm curious if there's a set of guidelines we should refer to when updating?

jagthedrummer · 2023-10-04T14:49:18Z

I'm curious if there's a set of guidelines we should refer to when updating?

@gazayas, there is a guide, but I think our situation is complicated a bit by the fact that the starter repo and the core gems are so tightly intertwined. Maybe we should write out our own "Bullet Train Semver" guide that takes that fact into account.

kaspth · 2023-10-04T15:48:20Z

@jagthedrummer nice, I'm onboard with the minor bump!

@gazayas great work on this ❤️

The PR for testing super scaffolding of Addresses (bullet-train-co/bullet_train#986) landed right before the PR for automatically generating a migration during super scaffolding (#547). As a result a bug / test-failure crept in. The `Address` model `belongs_to :addressable`, which means that the relation is stored on the `Address` side, and not on the owning model. So that means that when we super scaffold an address field it turns out that we don't need to represent that in the migration for the model that will own the address.

gazayas · 2023-10-05T04:00:21Z

@kaspth Thank you!

Excited to use this moving forward 🚀

First pass on setting up rails g

90691fe

gazayas added 2 commits September 22, 2023 20:40

Fixing Standard Ruby

3ac77a2

More additions to automate migrations on Super Scaffold

a73edaa

gazayas mentioned this pull request Sep 22, 2023

Update Super Scaffolding system test setup for automated rails g commands bullet-train-co/bullet_train#1030

Merged

gazayas added the Joint PR label Sep 22, 2023

gazayas added 6 commits September 23, 2023 08:39

Remove generate-migration flag for crud scaffolders

0d90b85

Compensate for image partials

eaaabf4

Compensate for join-model scaffolder with *_ids attributes

5b45c71

Removing options when registering attribute type for generation

4d66db6

Compensate for attributes with options

e6aa173

Update comment in scaffolding script

9f6b314

gazayas added 7 commits September 26, 2023 16:08

Compensate for matching namespaces, add foreign key to migration for …

bd6ff3e

…_id attributes

Refactor Super Scaffolding script sightly

ab54117

Automate model generation for the join-model scaffolder

2396d18

Fixing Standard Ruby

5a834cd

Add --skip-migration-generation flag

206972c

Merge branch 'main' into features/generate-models-when-super-scaffolding

79b44f2

Update portion of docs for new Super Scaffolding functionality

f2f0338

gazayas marked this pull request as ready for review September 26, 2023 12:13

gazayas requested a review from jagthedrummer September 26, 2023 12:19

gazayas added 3 commits September 27, 2023 18:56

Update more documentation

8265e38

Add skip-migration-generation flag for join-model scaffolder

3d59e5e

Update delegated types documentation

cca2fc5

jagthedrummer approved these changes Oct 3, 2023

View reviewed changes

Merge branch 'main' into features/generate-models-when-super-scaffolding

4d0ffbd

jagthedrummer merged commit 77bb4f6 into main Oct 4, 2023
5 checks passed

jagthedrummer deleted the features/generate-models-when-super-scaffolding branch October 4, 2023 15:11

jagthedrummer mentioned this pull request Oct 4, 2023

Bug fix for super scaffolding an address_field #600

Merged

gazayas mentioned this pull request Oct 5, 2023

Raise error when Super Scaffolding if rails g model was previously executed #603

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Run `rails generate` commands automatically when Super Scaffolding #547

Run `rails generate` commands automatically when Super Scaffolding #547

gazayas commented Sep 13, 2023 •

edited

Loading

gazayas commented Sep 13, 2023

gazayas commented Sep 22, 2023

jagthedrummer commented Sep 22, 2023

gazayas commented Sep 22, 2023

gazayas commented Sep 22, 2023

jagthedrummer commented Sep 25, 2023

kaspth commented Sep 25, 2023

gazayas commented Sep 26, 2023

gazayas commented Sep 26, 2023

kaspth commented Sep 26, 2023

gazayas commented Sep 27, 2023

pascallaliberte commented Sep 28, 2023

jagthedrummer commented Sep 29, 2023

jagthedrummer left a comment

jagthedrummer Oct 3, 2023

jagthedrummer Oct 3, 2023

gazayas Oct 4, 2023

gazayas commented Oct 4, 2023

jagthedrummer commented Oct 4, 2023

kaspth commented Oct 4, 2023

gazayas commented Oct 5, 2023

Run rails generate commands automatically when Super Scaffolding #547

Run rails generate commands automatically when Super Scaffolding #547

Conversation

gazayas commented Sep 13, 2023 • edited Loading

gazayas commented Sep 13, 2023

gazayas commented Sep 22, 2023

Our two options

The current state of this PR

My thoughts

jagthedrummer commented Sep 22, 2023

Aside

gazayas commented Sep 22, 2023

--run-migrations

Defining separate attributes in a different migration

gazayas commented Sep 22, 2023

jagthedrummer commented Sep 25, 2023

kaspth commented Sep 25, 2023

gazayas commented Sep 26, 2023

gazayas commented Sep 26, 2023

kaspth commented Sep 26, 2023

gazayas commented Sep 27, 2023

pascallaliberte commented Sep 28, 2023

jagthedrummer commented Sep 29, 2023

jagthedrummer left a comment

Choose a reason for hiding this comment

jagthedrummer Oct 3, 2023

Choose a reason for hiding this comment

jagthedrummer Oct 3, 2023

Choose a reason for hiding this comment

gazayas Oct 4, 2023

Choose a reason for hiding this comment

gazayas commented Oct 4, 2023

jagthedrummer commented Oct 4, 2023

kaspth commented Oct 4, 2023

gazayas commented Oct 5, 2023

Run `rails generate` commands automatically when Super Scaffolding #547

Run `rails generate` commands automatically when Super Scaffolding #547

gazayas commented Sep 13, 2023 •

edited

Loading

`--run-migrations`