Add `config.generators.after_generate` for processing to generated files #38870

y-yagi · 2020-04-03T12:52:44Z

This is useful if users want to process generated files.
For example, can execute an autocorrect of RuboCop for generated files as like following.

config.generators.after_generate do |files|
  system("bundle exec rubocop --auto-correct " + files.join(" "), exception: true)
end

simi · 2020-04-03T15:10:49Z

This covers a little difference use-case than I have seen benefit of in original #32996. I was looking for way to open (for example) migration file every-time I create it using generator, but do not enforce the same for all developers on same project. Also I would welcome to set this once in my "env" and have this enabled for all Rails apps having this capability (compatible version).

If I understand it well currently there's no easy way to achieve this, since (AFAIK) the global file .railsrc works only for rails new command. The only way I can think of for now is to have custom initializer globally git ignored and ensure it is copied in every Rails app I work on.

Thinking of my requirement, I think it should be possible to modify behaviour of rails generator commands when used in "non-interactive"(!$stdout.tty?) way and instead of user friendly output just provide list of generated files. Than it would be possible to do bin/rails g migration my_tiny_winie_migration | xargs gvim. WDYT?

y-yagi · 2020-04-04T12:03:41Z

Thanks for sharing your use-case!

It seems the requirement is different from my requirement.
My requirement is enforcing the style to the same for all developers on the same project.
So I think it's hard to fix all use-case in one fix. I keep this PR as is (to fix my use-case).

bin/rails g migration my_tiny_winie_migration | xargs gvim

This use-case can support by this PR. For example, only run after_generate when some env key.

config.generators.after_generate do |files|
  if ENV["EDITOR_FOR_GENERATOR"]
    system(ENV["EDITOR_FOR_GENERATOR"], *files, exception: true)
  end
end

$ EDITOR_FOR_GENERATOR=vim ./bin/rails g model user name:string

Of course, this is a little ugly. That support is out of scope this PR, but being able to pass a list of files to stdout in some way is worth considering in other PR I think.

simi · 2020-04-04T12:21:47Z

only run after_generate when some env key

Yeah, but that should be added to every app just because of me.

I'll think about my use-case a little more and open separate PR if needed. Code changes in here would be beneficial for that as well.

kaspth · 2020-04-05T21:58:39Z

Not too fond of the stated use case as justification for adding it. Wouldn't you have to run Rubocop before pushing the files (e.g. after someone's edited it) or run a Rubocop check on CI anyway? But the possibilities that after_generate has are interesting enough, so let's go for it.

I think the --edit (which then uses ENV["EDITOR"]) would be great to have built-in, I've wanted that in the past too.

kaspth · 2020-04-05T21:59:56Z

railties/lib/rails/generators.rb

+        def run_after_generate_callback
+          unless self.generated_files.empty?
+            @after_generate_callbacks.each do |callback|
+              callback.call(self.generated_files)


Omit the needless self. when calling generated_files.

kaspth · 2020-04-05T22:03:19Z

railties/lib/rails/generators/actions/create_migration.rb

@@ -19,6 +19,11 @@ def identical?
          exists? && File.binread(existing_migration) == render
        end

+        def invoke!
+          invoked_file = super
+          File.exist?(@destination) ? invoked_file : relative_existing_migration


Why is this needed?

CreateMigration keeps an existing file when content is the same with an invoked file. In that case, we need to return an existing file name. If do not, after_generate callback will return a non-existing file name(invoked file name).

kaspth · 2020-04-05T22:04:10Z

railties/lib/rails/generators.rb

@@ -269,6 +275,7 @@ def invoke(namespace, args = ARGV, config = {})
        if klass = find_by_namespace(names.pop, names.any? && names.join(":"))
          args << "--help" if args.empty? && klass.arguments.any?(&:required?)
          klass.start(args, config)
+          run_after_generate_callback if config[:behavior] == :invoke


Does start return a value that we need to pass on? E.g. should we do start(args, config).tap do?

The start returns all result of all_command. all_command includes methods that do not relate with generating files(e.g. check_class_collision, hook_for). It is a little difficult to extract that only result of generating files.

kaspth · 2020-04-05T22:07:03Z

railties/lib/rails/generators.rb

@@ -29,6 +29,7 @@ module Generators
    autoload :TestCase,        "rails/generators/test_case"

    mattr_accessor :namespace
+    mattr_reader :generated_files, default: []


Hm, not liking exposing this here. Can we manage everything entirely within add_generated_file? Maybe via (@@generated_files ||= []) << file or something?

If not, I'd move the _reader above the _accessor since that's the style we follow, iirc.

I fixed that manage everything entirely within add_generated_file.

jonathanhefner · 2020-04-22T20:41:59Z

railties/lib/rails/generators.rb

@@ -281,6 +287,11 @@ def invoke(namespace, args = ARGV, config = {})
        end
      end

+      def add_generated_file(file) # :nodoc:
+        (@@generated_files ||= []) << file


It feels a little strange to have this as global state. I'm not sure how it will play with the :inline option added in #37516. If there is no way for this to be instance state on the instantiated generator, what do you think about clearing @@generated_files after all callbacks are run?

Thanks, your advice is correct and clearing @@generated_files was needed. I fixed.

Register a callback that will get called right after generators has finished. This is useful if users want to process generated files. For example, can execute an autocorrect of RuboCop for generated files as like following. ```ruby config.generators.after_generate do |files| system("bundle exec rubocop --auto-correct " + files.join(" "), exception: true) end ```

kaspth · 2020-05-08T12:49:00Z

Rad! ❤️💪

This PR adds a Rails feature introduced by rails/rails#38870 to docs.

…rate` ## Motivation / Background RuboCop has now been included by default (rails#50456). By adding the following tip to the default configuration, user can apply RuboCop's autocorrection to code generated by `bin/rails generate` (e.g., migration file): https://github.com/rubocop/rubocop-rails#rails-configuration-tip This means that the generated files will be formatted according to user's .rubocop.yml custom configuration. ## Detail Since `bin/rails generate` and `bin/rubocop` are used only in the development environment, the target files are limited to only `config/environments/development.rb`. ## Additional information This feature was introduced in Rails 6.1 by rails#38870.

…rate` (#50506) * Apply autocorrection by RuboCop to files generated by `bin/rails generate` ## Motivation / Background RuboCop has now been included by default (#50456). By adding the following tip to the default configuration, user can apply RuboCop's autocorrection to code generated by `bin/rails generate` (e.g., migration file): https://github.com/rubocop/rubocop-rails#rails-configuration-tip This means that the generated files will be formatted according to user's .rubocop.yml custom configuration. ## Detail Since `bin/rails generate` and `bin/rubocop` are used only in the development environment, the target files are limited to only `config/environments/development.rb`. ## Additional information This feature was introduced in Rails 6.1 by #38870.

…rate` (rails#50506) * Apply autocorrection by RuboCop to files generated by `bin/rails generate` ## Motivation / Background RuboCop has now been included by default (rails#50456). By adding the following tip to the default configuration, user can apply RuboCop's autocorrection to code generated by `bin/rails generate` (e.g., migration file): https://github.com/rubocop/rubocop-rails#rails-configuration-tip This means that the generated files will be formatted according to user's .rubocop.yml custom configuration. ## Detail Since `bin/rails generate` and `bin/rubocop` are used only in the development environment, the target files are limited to only `config/environments/development.rb`. ## Additional information This feature was introduced in Rails 6.1 by rails#38870.

rails-bot bot added the railties label Apr 3, 2020

y-yagi mentioned this pull request Apr 3, 2020

Added --editor (-e) option to open generated files in the user's editor #32996

Closed

kaspth reviewed Apr 5, 2020

View reviewed changes

y-yagi force-pushed the add_after_generate branch from fe2a4ef to 1d14399 Compare April 22, 2020 04:59

jonathanhefner reviewed Apr 22, 2020

View reviewed changes

y-yagi force-pushed the add_after_generate branch from 1d14399 to 11e8826 Compare May 1, 2020 05:02

y-yagi force-pushed the add_after_generate branch from 11e8826 to fde100d Compare May 8, 2020 12:06

y-yagi merged commit d80c18a into rails:master May 8, 2020

y-yagi deleted the add_after_generate branch May 8, 2020 20:43

duleorlovic mentioned this pull request Jan 21, 2023

Add ability to add specify column null and default values from cli #31448

Closed

koic mentioned this pull request Mar 17, 2023

[Doc] Add config.generators.after_generate Rails config to docs rubocop/rubocop-rails#956

Merged

9 tasks

koic added a commit to koic/rubocop-rails that referenced this pull request Mar 17, 2023

[Doc] Add config.generators.after_generate Rails config to docs

89c679f

This PR adds a Rails feature introduced by rails/rails#38870 to docs.

koic added a commit to koic/rubocop-rails that referenced this pull request Mar 18, 2023

[Doc] Add config.generators.after_generate Rails config to docs

1b30576

This PR adds a Rails feature introduced by rails/rails#38870 to docs.

koic added a commit to koic/rubocop-rails that referenced this pull request Mar 18, 2023

[Doc] Add config.generators.after_generate Rails config to docs

e55e26a

This PR adds a Rails feature introduced by rails/rails#38870 to docs.

koic added a commit to koic/rubocop-rails that referenced this pull request Mar 18, 2023

[Doc] Add config.generators.after_generate Rails config to docs

ca6f2fe

This PR adds a Rails feature introduced by rails/rails#38870 to docs.

koic mentioned this pull request Dec 31, 2023

Apply autocorrection by RuboCop to files generated by bin/rails generate #50506

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `config.generators.after_generate` for processing to generated files #38870

Add `config.generators.after_generate` for processing to generated files #38870

Uh oh!

y-yagi commented Apr 3, 2020

Uh oh!

simi commented Apr 3, 2020

Uh oh!

y-yagi commented Apr 4, 2020

Uh oh!

simi commented Apr 4, 2020

Uh oh!

kaspth commented Apr 5, 2020

Uh oh!

kaspth Apr 5, 2020

Uh oh!

kaspth Apr 5, 2020

Uh oh!

y-yagi Apr 22, 2020

Uh oh!

kaspth Apr 5, 2020

Uh oh!

y-yagi Apr 22, 2020

Uh oh!

kaspth Apr 5, 2020

Uh oh!

y-yagi Apr 22, 2020

Uh oh!

jonathanhefner Apr 22, 2020

Uh oh!

y-yagi May 1, 2020

Uh oh!

kaspth commented May 8, 2020

Uh oh!

Uh oh!

Add config.generators.after_generate for processing to generated files #38870

Add config.generators.after_generate for processing to generated files #38870

Uh oh!

Conversation

y-yagi commented Apr 3, 2020

Uh oh!

simi commented Apr 3, 2020

Uh oh!

y-yagi commented Apr 4, 2020

Uh oh!

simi commented Apr 4, 2020

Uh oh!

kaspth commented Apr 5, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kaspth commented May 8, 2020

Uh oh!

Uh oh!

Add `config.generators.after_generate` for processing to generated files #38870

Add `config.generators.after_generate` for processing to generated files #38870