Add script folder and generator #52335

jeromedalbert · 2024-07-15T10:50:41Z

New attempt at addressing this discussion after #39552 fell through the cracks.

Motivation / Background

This Pull Request has been created because it is currently not clear where to put one-off scripts, and DHH has expressed support for bringing back script/ as a default directory.

Detail

This Pull Request changes the Rails app generator to create a new script default directory that can hold one-off scripts, data migration scripts, cleanup scripts, benchmark scripts, etc. This PR also adds a basic script generator to create such scripts.

Additional information

I added a script generator to this PR because:
- there seemed to be some support for it.
- a new script directory and/or a generator seem to go hand in hand.
- only adding a script directory with a small mention in the Getting Started guide feels a little bare. It is a good start (since it is not clear where else it could be documented in the guides), but adding a new generator can be an additional indirect way to document how this new directory can be used.
I can remove the generator from this PR if it is not deemed useful. Conversely, I can keep the generator and remove the default empty script folder if only a generator is preferred.
I think most people are interested in ruby scripts so I didn't add an option to generate bash scripts, but I can add one if needed.
PR 39552 didn't go through and @hahmed expressed interest in someone else taking over, so we will see if this PR gets better luck.

Checklist

Before submitting the PR make sure the following are checked:

This Pull Request is related to one change. Unrelated changes should be opened in separate PRs.
Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
Tests are added or updated if you fix a bug or add a feature.
CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

Add a new script default folder to hold one-off or general purpose scripts, such as data migration scripts, cleanup scripts, etc. Also add a script generator to create such scripts. Co-authored-by: Haroon Ahmed <haroon.ahmed25@gmail.com>

dhh · 2024-07-16T10:28:16Z

This is great. The generator doesn't add much, but it helps explain the feature, and it does help with the require. Nice.

Add a new script default folder to hold one-off or general purpose scripts, such as data migration scripts, cleanup scripts, etc. Also add a script generator to create such scripts. Co-authored-by: Haroon Ahmed <haroon.ahmed25@gmail.com>

seanpdoyle · 2024-07-19T14:01:25Z

railties/lib/rails/generators/rails/script/USAGE

+        script/my_script.rb
+
+    You can run the script using:
+        `ruby script/my_script.rb`


Could it be valuable to encourage users to execute the script with the rails runner command so that the script itself has access to Rails classes (like the ones in app/models)?

While the generated require_relative "../config/environment" does the trick and allows the script to access Rails classes using just ruby, it adds friction to moving the script around. Using rails runner would do that for free.

@seanpdoyle The generator creates a script that has require_relative "../config/environment", so you can run the script with ruby and it will work the same as if you ran it with rails runner.

But this is a very basic generator, you don't have to use it! You can manually create a script without require_relative "../config/environment" and run it with rails runner if you prefer.

@seanpdoyle The generator creates a script that has require_relative "../config/environment", so you can run the script with ruby and it will work the same as if you ran it with rails runner.

Thanks for clarifying @jeromedalbert, I wasn't clear until I read your comment and tried the generator whether the scripts were living in Ruby or in my Rails project

okuramasafumi · 2024-07-19T15:34:31Z

Hi, I'm the author of the original discussion. I'm sorry that I've been absent from this topic for so long, and I'm so happy to see it's implemented finally, thank you!

joelmoss · 2024-07-19T15:55:18Z

I know I'm late, and that this has already been merged, but aren't rake tasks one off scripts? At least that is what I use them for. The scripts described here seem to be exactly what rake tasks are. If not, what is the difference?

jeromedalbert · 2024-07-20T01:45:55Z

Hey @joelmoss, I think there can be some overlap between rake tasks and one-off scripts and opinions may vary. In the related discussion Okura Masafumi mentions that rake tasks are one way but they can be executed multiple times, and I tend to agree, leaving rake tasks for code that is intended to be run multiple times.

So script/ can hold one-off scripts, for example Basecamp uses script/migrate which I am guessing they use for updating data, and we had a similar folder at my previous company.

But script/ is not only for one-off scripts, it can hold more general scripts too, for example rails generate benchmark already generates benchmarks in script/benchmarks, and at my previous company we had script/ops which had a bunch of shell scripts and ruby scripts for various ops-related things.

Add a new script default folder to hold one-off or general purpose scripts, such as data migration scripts, cleanup scripts, etc. Also add a script generator to create such scripts. Co-authored-by: Haroon Ahmed <haroon.ahmed25@gmail.com>

…2335

Verify `script/` directory creation in api app generator test #52335

# By Jean Boussier (270) and others # Via GitHub (1669) and others * main: (2541 commits) ActiveSupport::Cache::RedisCacheStore use UNLINK instead of DEL Fix typo in The Rails Command Line guide Fixed-width == and === docs do not work with RDoc short-hand Add `default_isolation_level` on `NullPool` [ActiveRecord] Introduce with_default_isolation_level Use status code 303 for redirect in destroy action Add `Cache#read_counter` and `Cache#write_counter` misc: fix spelling in Markdown and Ruby files [ci skip] docs(activestorage): Update default variant processor Generate deploy config without extra blank lines Extract system test setup to system_helper Include cookie name in length calculation Verify `script/` directory creation in api app generator test rails#52335 Add `must-understand` directive according Fix typo in Action Controller Overview guide Ensure function aliases allow retrying queries Enable join table references to stay retryable Fix rails#54805. Add a config.action_controller.json_renderer_escapes framework default Don't always escape JSON when calling render json: ... # Conflicts: # activerecord/CHANGELOG.md # activerecord/lib/active_record/autosave_association.rb

rails-bot bot added docs railties labels Jul 15, 2024

jeromedalbert mentioned this pull request Jul 15, 2024

Adds ./script folder to a new rails app #39552

Closed

jeromedalbert force-pushed the script-folder branch 2 times, most recently from ef11c0d to d60ed64 Compare July 15, 2024 11:29

Add script folder and generator

3632fd5

Add a new script default folder to hold one-off or general purpose scripts, such as data migration scripts, cleanup scripts, etc. Also add a script generator to create such scripts. Co-authored-by: Haroon Ahmed <haroon.ahmed25@gmail.com>

jeromedalbert force-pushed the script-folder branch from d60ed64 to 3632fd5 Compare July 15, 2024 18:34

dhh merged commit c01a846 into rails:main Jul 16, 2024
3 checks passed

jeromedalbert deleted the script-folder branch July 16, 2024 17:40

seanpdoyle reviewed Jul 19, 2024

View reviewed changes

seanpdoyle mentioned this pull request Jul 28, 2024

Add bin/dev by default #52433

Merged

aliismayilov mentioned this pull request Aug 7, 2024

Allow running detached app commands and follow logs by container ID basecamp/kamal#906

Merged

kakudou3 added a commit to kakudou3/rails that referenced this pull request Mar 29, 2025

Verify script/ directory creation in api app generator test rails#5…

7f2667e

…2335

kakudou3 mentioned this pull request Mar 29, 2025

Verify script/ directory creation in api app generator test #52335 #54834

Merged

4 tasks

yahonda added a commit that referenced this pull request Mar 31, 2025

Merge pull request #54834 from kakudou3/add-script-path-to-api-app-test

1eac7f2

Verify `script/` directory creation in api app generator test #52335

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add script folder and generator #52335

Add script folder and generator #52335

jeromedalbert commented Jul 15, 2024 •

edited

Loading

dhh commented Jul 16, 2024

seanpdoyle Jul 19, 2024

neilvcarvalho Jul 19, 2024 •

edited

Loading

jeromedalbert Jul 19, 2024 •

edited

Loading

seanwmitchell Nov 12, 2024

okuramasafumi commented Jul 19, 2024

joelmoss commented Jul 19, 2024

jeromedalbert commented Jul 20, 2024 •

edited

Loading

Add script folder and generator #52335

Add script folder and generator #52335

Conversation

jeromedalbert commented Jul 15, 2024 • edited Loading

Motivation / Background

Detail

Additional information

Checklist

dhh commented Jul 16, 2024

seanpdoyle Jul 19, 2024

Choose a reason for hiding this comment

neilvcarvalho Jul 19, 2024 • edited Loading

Choose a reason for hiding this comment

jeromedalbert Jul 19, 2024 • edited Loading

Choose a reason for hiding this comment

seanwmitchell Nov 12, 2024

Choose a reason for hiding this comment

okuramasafumi commented Jul 19, 2024

joelmoss commented Jul 19, 2024

jeromedalbert commented Jul 20, 2024 • edited Loading

jeromedalbert commented Jul 15, 2024 •

edited

Loading

neilvcarvalho Jul 19, 2024 •

edited

Loading

jeromedalbert Jul 19, 2024 •

edited

Loading

jeromedalbert commented Jul 20, 2024 •

edited

Loading