Module: Rails::Generators

Includes:
Command::Behavior
Defined in:
activejob/lib/rails/generators/job/job_generator.rb,
actionmailer/lib/rails/generators/mailer/mailer_generator.rb,
actioncable/lib/rails/generators/channel/channel_generator.rb,
actionmailbox/lib/rails/generators/mailbox/mailbox_generator.rb,
railties/lib/rails/generators.rb,
railties/lib/rails/generators/base.rb,
railties/lib/rails/generators/actions.rb,
railties/lib/rails/generators/app_base.rb,
railties/lib/rails/generators/app_name.rb,
railties/lib/rails/generators/database.rb,
railties/lib/rails/generators/migration.rb,
railties/lib/rails/generators/test_case.rb,
railties/lib/rails/generators/named_base.rb,
railties/lib/rails/generators/active_model.rb,
railties/lib/rails/generators/model_helpers.rb,
railties/lib/rails/generators/resource_helpers.rb,
railties/lib/rails/generators/testing/behaviour.rb,
railties/lib/rails/generators/testing/assertions.rb,
railties/lib/rails/generators/generated_attribute.rb,
railties/lib/rails/generators/rails/app/app_generator.rb,
railties/lib/rails/generators/actions/create_migration.rb,
railties/lib/rails/generators/rails/task/task_generator.rb,
railties/lib/rails/generators/testing/setup_and_teardown.rb,
railties/lib/rails/generators/rails/model/model_generator.rb,
railties/lib/rails/commands/application/application_command.rb,
railties/lib/rails/generators/rails/assets/assets_generator.rb,
railties/lib/rails/generators/rails/helper/helper_generator.rb,
railties/lib/rails/generators/rails/plugin/plugin_generator.rb,
railties/lib/rails/generators/rails/resource/resource_generator.rb,
railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb,
railties/lib/rails/generators/rails/generator/generator_generator.rb,
railties/lib/rails/generators/rails/migration/migration_generator.rb,
railties/lib/rails/generators/rails/controller/controller_generator.rb,
railties/lib/rails/generators/rails/master_key/master_key_generator.rb,
railties/lib/rails/generators/rails/credentials/credentials_generator.rb,
railties/lib/rails/generators/rails/db/system/change/change_generator.rb,
railties/lib/rails/generators/rails/system_test/system_test_generator.rb,
railties/lib/rails/generators/rails/encrypted_file/encrypted_file_generator.rb,
railties/lib/rails/generators/rails/resource_route/resource_route_generator.rb,
railties/lib/rails/generators/rails/integration_test/integration_test_generator.rb,
railties/lib/rails/generators/rails/application_record/application_record_generator.rb,
railties/lib/rails/generators/rails/encryption_key_file/encryption_key_file_generator.rb,
railties/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb

Overview

:nodoc:

Defined Under Namespace

Modules: Actions, AppName, Database, Db, Migration, ModelHelpers, ResourceHelpers, Testing Classes: ARGVScrubber, ActiveModel, AppBase, AppGenerator, ApplicationRecordGenerator, AssetsGenerator, Base, ChannelGenerator, ControllerGenerator, CredentialsGenerator, EncryptedFileGenerator, EncryptionKeyFileGenerator, Error, GeneratedAttribute, GeneratorGenerator, HelperGenerator, IntegrationTestGenerator, JobGenerator, MailboxGenerator, MailerGenerator, MasterKeyGenerator, MigrationGenerator, ModelGenerator, NamedBase, PluginGenerator, ResourceGenerator, ResourceRouteGenerator, ScaffoldControllerGenerator, ScaffoldGenerator, SystemTestGenerator, TaskGenerator, TestCase

Constant Summary collapse

DEFAULT_ALIASES = 
{
  rails: {
    actions: "-a",
    orm: "-o",
    javascripts: "-j",
    javascript_engine: "-je",
    resource_controller: "-c",
    scaffold_controller: "-c",
    stylesheets: "-y",
    stylesheet_engine: "-se",
    scaffold_stylesheet: "-ss",
    template_engine: "-e",
    test_framework: "-t"
  },

  test_unit: {
    fixture_replacement: "-r",
  }
}
DEFAULT_OPTIONS = 
{
  rails: {
    api: false,
    assets: true,
    force_plural: false,
    helper: true,
    integration_tool: nil,
    orm: false,
    resource_controller: :controller,
    resource_route: true,
    scaffold_controller: :scaffold_controller,
    stylesheets: true,
    stylesheet_engine: :css,
    scaffold_stylesheet: true,
    system_tests: nil,
    test_framework: nil,
    template_engine: :erb
  }
}
RAILS_DEV_PATH =

We need to store the RAILS_DEV_PATH in a constant, otherwise the path can change in Ruby 1.8.7 when we FileUtils.cd.

File.expand_path("../../../../../..", __dir__)

Class Method Summary collapse

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included

Class Method Details

.aliases ⇒ Object

:nodoc:



88
89
90
 
# File 'railties/lib/rails/generators.rb', line 88

def aliases #:nodoc:
  @aliases ||= DEFAULT_ALIASES.dup
end

.api_only! ⇒ Object

Configure generators for API only applications. It basically hides everything that is usually browser related, such as assets and session migration generators, and completely disable helpers and assets so generators such as scaffold won’t create them.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'railties/lib/rails/generators.rb', line 116

def api_only!
  hide_namespaces "assets", "helper", "css", "js"

  options[:rails].merge!(
    api: true,
    assets: false,
    helper: false,
    template_engine: nil
  )

  if ARGV.first == "mailer"
    options[:rails][:template_engine] = :erb
  end
end

.configure!(config) ⇒ Object

:nodoc:



73
74
75
76
77
78
79
80
81
82
 
# File 'railties/lib/rails/generators.rb', line 73

def configure!(config) #:nodoc:
  api_only! if config.api_only
  no_color! unless config.colorize_logging
  aliases.deep_merge! config.aliases
  options.deep_merge! config.options
  fallbacks.merge! config.fallbacks
  templates_path.concat config.templates
  templates_path.uniq!
  hide_namespaces(*config.hidden_namespaces)
end

.fallbacks ⇒ Object

Hold configured generators fallbacks. If a plugin developer wants a generator group to fallback to another group in case of missing generators, they can add a fallback.

For example, shoulda is considered a test_framework and is an extension of test_unit. However, most part of shoulda generators are similar to test_unit ones.

Shoulda then can tell generators to search for test_unit generators when some of them are not available by adding a fallback:

Rails::Generators.fallbacks[:shoulda] = :test_unit



108
109
110
 
# File 'railties/lib/rails/generators.rb', line 108

def fallbacks
  @fallbacks ||= {}
end

.find_by_namespace(name, base = nil, context = nil) ⇒ Object

Rails finds namespaces similar to Thor, it only adds one rule:

Generators names must end with “_generator.rb”. This is required because Rails looks in load paths and loads the generator just before it’s going to be used.

find_by_namespace :webrat, :rails, :integration

Will search for the following generators:

"rails:webrat", "webrat:integration", "webrat"

Notice that “rails:generators:webrat” could be loaded as well, what Rails looks for is the first and last parts of the namespace.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'railties/lib/rails/generators.rb', line 239

def find_by_namespace(name, base = nil, context = nil) #:nodoc:
  lookups = []
  lookups << "#{base}:#{name}"    if base
  lookups << "#{name}:#{context}" if context

  unless base || context
    unless name.to_s.include?(?:)
      lookups << "#{name}:#{name}"
      lookups << "rails:#{name}"
    end
    lookups << "#{name}"
  end

  lookup(lookups)

  namespaces = Hash[subclasses.map { |klass| [klass.namespace, klass] }]
  lookups.each do |namespace|
    klass = namespaces[namespace]
    return klass if klass
  end

  invoke_fallbacks_for(name, base) || invoke_fallbacks_for(context, name)
end

.help(command = "generate") ⇒ Object

Show help message with available generators.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'railties/lib/rails/generators.rb', line 175

def help(command = "generate")
  puts "Usage: rails #{command} GENERATOR [args] [options]"
  puts
  puts "General options:"
  puts "  -h, [--help]     # Print generator's options and usage"
  puts "  -p, [--pretend]  # Run but do not make any changes"
  puts "  -f, [--force]    # Overwrite files that already exist"
  puts "  -s, [--skip]     # Skip files that already exist"
  puts "  -q, [--quiet]    # Suppress status output"
  puts
  puts "Please choose a generator below."
  puts

  print_generators
end

.hidden_namespaces ⇒ Object

Returns an array of generator namespaces that are hidden. Generator namespaces may be hidden for a variety of reasons. Some are aliased such as “rails:migration” and can be invoked with the shorter “migration”, others are private to other generators such as “css:scaffold”.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'railties/lib/rails/generators.rb', line 136

def hidden_namespaces
  @hidden_namespaces ||= begin
    orm      = options[:rails][:orm]
    test     = options[:rails][:test_framework]
    template = options[:rails][:template_engine]
    css      = options[:rails][:stylesheet_engine]

    [
      "rails",
      "resource_route",
      "#{orm}:migration",
      "#{orm}:model",
      "#{test}:controller",
      "#{test}:helper",
      "#{test}:integration",
      "#{test}:system",
      "#{test}:mailer",
      "#{test}:model",
      "#{test}:scaffold",
      "#{test}:view",
      "#{test}:job",
      "#{template}:controller",
      "#{template}:scaffold",
      "#{template}:mailer",
      "#{css}:scaffold",
      "#{css}:assets",
      "css:assets",
      "css:scaffold",
      "action_text:install"
    ]
  end
end

.hide_namespaces(*namespaces) ⇒ Object Also known as: hide_namespace 



169
170
171
 
# File 'railties/lib/rails/generators.rb', line 169

def hide_namespaces(*namespaces)
  hidden_namespaces.concat(namespaces)
end

.invoke(namespace, args = ARGV, config = {}) ⇒ Object

Receives a namespace, arguments and the behavior to invoke the generator. It’s used as the default entry point for generate, destroy and update commands.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'railties/lib/rails/generators.rb', line 266

def invoke(namespace, args = ARGV, config = {})
  names = namespace.to_s.split(":")
  if klass = find_by_namespace(names.pop, names.any? && names.join(":"))
    args << "--help" if args.empty? && klass.arguments.any?(&:required?)
    klass.start(args, config)
  else
    options     = sorted_groups.flat_map(&:last)
    suggestion  = Rails::Command::Spellchecker.suggest(namespace.to_s, from: options)
    suggestion_msg = "Maybe you meant #{suggestion.inspect}?" if suggestion

    puts <<~MSG
      Could not find generator '#{namespace}'. #{suggestion_msg}
      Run `bin/rails generate --help` for more options.
    MSG
  end
end

.options ⇒ Object

:nodoc:



92
93
94
 
# File 'railties/lib/rails/generators.rb', line 92

def options #:nodoc:
  @options ||= DEFAULT_OPTIONS.dup
end

.print_generators ⇒ Object 



196
197
198
 
# File 'railties/lib/rails/generators.rb', line 196

def print_generators
  sorted_groups.each { |b, n| print_list(b, n) }
end

.public_namespaces ⇒ Object 



191
192
193
194
 
# File 'railties/lib/rails/generators.rb', line 191

def public_namespaces
  lookup!
  subclasses.map(&:namespace)
end

.sorted_groups ⇒ Object 



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'railties/lib/rails/generators.rb', line 200

def sorted_groups
  namespaces = public_namespaces
  namespaces.sort!

  groups = Hash.new { |h, k| h[k] = [] }
  namespaces.each do |namespace|
    base = namespace.split(":").first
    groups[base] << namespace
  end

  rails = groups.delete("rails")
  rails.map! { |n| n.sub(/^rails:/, "") }
  rails.delete("app")
  rails.delete("plugin")
  rails.delete("encrypted_secrets")
  rails.delete("encrypted_file")
  rails.delete("encryption_key_file")
  rails.delete("master_key")
  rails.delete("credentials")
  rails.delete("db:system:change")

  hidden_namespaces.each { |n| groups.delete(n.to_s) }

  [[ "rails", rails ]] + groups.sort.to_a
end

.templates_path ⇒ Object

:nodoc:



84
85
86
 
# File 'railties/lib/rails/generators.rb', line 84

def templates_path #:nodoc:
  @templates_path ||= []
end