Rails 5 - 如何创建自定义脚手架生成器？

Question

目标是命令...

bin/rails generate custom_scaffold Thing

...生成以下6个文件：

db/migrate/201812031331_create_things.rb
app/models/thing.rb
app/controllers/things_controller.rb
app/serializers/thing_serializer.rb
test/fixtures/things.yml
test/integration/requests/things_request_test.rb

... 使用 Rails 5.

我当前的设置会生成 app/models/thing.rb，但不会用 Thing 填充它。

预计：

class Thing < ApplicationRecord

end

目前：

class <%= class_name %> < ApplicationRecord

end

我已经通读了这些 Rails guides 但收效甚微。

有人有工作示例吗？

我的设置：

# lib/generators/custom_scaffold/custom_scaffold_generator.rb

class CustomScaffoldGenerator < Rails::Generators::NamedBase
  source_root File.expand_path('templates', __dir__)

  def create_files
    copy_file 'migration.rb', "db/migrate/#{timestamp}_create_#{plural_name}.rb"
    copy_file 'model.rb', "app/models/#{file_name}.rb"
    copy_file 'controller.rb', "app/controllers/#{plural_name}_controller.rb"
    copy_file 'serializer.rb', "app/serializers/#{file_name}_serializer.rb"
    copy_file 'fixture.yml', "test/fixtures/#{plural_name}.yml"
    copy_file 'request_test.rb', "test/integration/requests/#{plural_name}_request_test.rb"
  end

  private

  def timestamp
    Time.now.utc.strftime('%Y%m%d%H%M%S')
  end
end

# lib/generators/custom_scaffold/templates/model.rb

class <%= class_name %> < ApplicationRecord

end

# lib/generators/custom_scaffold/templates/controller.rb

module V1
  module Public
    class <%= class_name.pluralize %>Controller < ApplicationController

    end
  end
end

# lib/generators/custom_scaffold/templates/migration.rb
# Ignore for now

# lib/generators/custom_scaffold/templates/serializer.rb
# Ignore for now

# lib/generators/custom_scaffold/templates/fixture.yml
# Ignore for now

# lib/generators/custom_scaffold/templates/request_test.rb
# Ignore for now

# Gemfile

source 'https://rubygems.org'

ruby '2.4.1'
gem 'rails', '~> 5.1.6'
gem 'puma', '~> 3.7'
gem 'pg'
gem 'rack-cors', require: 'rack/cors'
gem 'olive_branch'
gem 'fast_jsonapi'
gem 'awesome_print'
gem 'byebug', '~> 10.0', groups: %i[development test]
gem 'yaml_db'

group :development do
  gem 'listen', '>= 3.0.5', '< 3.2'
  gem 'mina', '~> 1.2', require: false
  gem 'mina-puma', require: false
  gem 'rubocop', require: false
  gem 'annotate', require: false
end

Answer 1

您需要将文件指定为 Thor 模板。 Rails 使用 Thor 模板生成其中包含 ERB 样式代码的模板。

替换：
copy_file 'model.rb', "app/models/#{file_name}.rb"

与：
template 'model.rb.tt', "app/models/#{file_name}.rb"

通过添加 .tt 扩展，您告诉生成器将文件作为 Thor 模板处理，它将解释文件中的 Ruby 代码（ERB 样式），然后创建一个具有相同名称的文件减去 .tt 扩展名。您拥有的任何没有 .tt 扩展名的文件，生成器将批量复制，而不执行其中的任何代码。

一个有用的提示：有时您想在 Thor 模板文件中保留一些 ERB 代码而不执行它。默认情况下，.tt 文件中的任何 ERB 样式标签都将被处理，并且在它的位置将一个字符串写入输出文件。您可以避免处理 ERB 标签，但在标签中使用双百分号。

例如，假设您有一个名为 foo.erb.tt 的文件，它将在您的生成器运行时创建文件 foo.erb。假设我们有一个 article_name 变量，它的值为 Breaking News

如果您将 <%= article_name %> 放入文件中，它会将 Breaking News 写入 foo.erb。

如果你输入 <%%= article_name %>（注意 %%），它会将 <%= article_name %> 写入 foo.erb。

我发现以下参考资料在学习这些东西时很方便。

Rails Application Templates Rails 指南中的文章。
Creating and Customizing Rails Generators & Templates Rails 指南中的文章。
Thor Actions Docs 这些是我们 template.rb 文件中使用的命令。

Thor 附带了几个有助于脚本和生成器任务的操作。您可能对它们很熟悉，因为有些来自 Rails 模板。它们是：say、ask、yes?、no?、add_file、remove_file、copy_file、template , directory, inside, run, inject_into_file 以及更多。

Rails 5 - 如何创建自定义脚手架生成器？

Rails 5 - How to create custom scaffold generator?

ruby

ruby-on-rails

ruby-on-rails-5

ruby-on-rails-5.1