Module: Rails::Generators

Defined in:
actionmailer/lib/rails/generators/mailer/mailer_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/commands/application.rb,
railties/lib/rails/generators/test_case.rb,
railties/lib/rails/generators/migration.rb,
railties/lib/rails/generators/named_base.rb,
railties/lib/rails/generators/active_model.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/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/generators/rails/plugin/plugin_generator.rb,
railties/lib/rails/generators/rails/assets/assets_generator.rb,
railties/lib/rails/generators/rails/helper/helper_generator.rb,
railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb,
railties/lib/rails/generators/rails/resource/resource_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/resource_route/resource_route_generator.rb,
railties/lib/rails/generators/rails/integration_test/integration_test_generator.rb,
railties/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb

Defined Under Namespace

Modules: Actions, Migration, ResourceHelpers, Testing Classes: ActiveModel, AppBase, AppGenerator, AppPreparer, AssetsGenerator, Base, ControllerGenerator, Error, GeneratedAttribute, GeneratorGenerator, HelperGenerator, IntegrationTestGenerator, MailerGenerator, MigrationGenerator, ModelGenerator, NamedBase, PluginGenerator, ResourceGenerator, ResourceRouteGenerator, ScaffoldControllerGenerator, ScaffoldGenerator, 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',
    template_engine: '-e',
    test_framework: '-t'
  },

  test_unit: {
    fixture_replacement: '-r',
  }
}
DEFAULT_OPTIONS =
{
  rails: {
    assets: true,
    force_plural: false,
    helper: true,
    integration_tool: nil,
    javascripts: true,
    javascript_engine: :js,
    orm: false,
    resource_controller: :controller,
    resource_route: true,
    scaffold_controller: :scaffold_controller,
    stylesheets: true,
    stylesheet_engine: :css,
    test_framework: false,
    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("../../../../../..", File.dirname(__FILE__))
RESERVED_NAMES =
%w[application destroy plugin runner test]

Class Method Summary collapse

Class Method Details

.aliasesObject

:nodoc:


77
78
79
# File 'railties/lib/rails/generators.rb', line 77

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

.configure!(config) ⇒ Object

:nodoc:


63
64
65
66
67
68
69
70
71
# File 'railties/lib/rails/generators.rb', line 63

def self.configure!(config) #:nodoc:
  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

.fallbacksObject

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

97
98
99
# File 'railties/lib/rails/generators.rb', line 97

def self.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.


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
# File 'railties/lib/rails/generators.rb', line 124

def self.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.


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
225
226
227
228
229
230
231
232
233
234
# File 'railties/lib/rails/generators.rb', line 200

def self.help(command = 'generate')
  lookup!

  namespaces = subclasses.map{ |k| k.namespace }
  namespaces.sort!

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

  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 Rails defaults first.
  rails = groups.delete("rails")
  rails.map! { |n| n.sub(/^rails:/, '') }
  rails.delete("app")
  rails.delete("plugin")
  print_list("rails", rails)

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

  groups.sort.each { |b, n| print_list(b, n) }
end

.hidden_namespacesObject


162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
# File 'railties/lib/rails/generators.rb', line 162

def self.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}:mailer",
      "#{test}:model",
      "#{test}:scaffold",
      "#{test}:view",
      "#{template}:controller",
      "#{template}:scaffold",
      "#{template}:mailer",
      "#{css}:scaffold",
      "#{css}:assets",
      "css:assets",
      "css:scaffold"
    ]
  end
end

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


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

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.


152
153
154
155
156
157
158
159
160
# File 'railties/lib/rails/generators.rb', line 152

def self.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? { |a| a.required? }
    klass.start(args, config)
  else
    puts "Could not find generator #{namespace}."
  end
end

.no_color!Object

Remove the color from output.


102
103
104
# File 'railties/lib/rails/generators.rb', line 102

def self.no_color!
  Thor::Base.shell = Thor::Shell::Basic
end

.optionsObject

:nodoc:


81
82
83
# File 'railties/lib/rails/generators.rb', line 81

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

.subclassesObject

Track all generators subclasses.


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

def self.subclasses
  @subclasses ||= []
end

.templates_pathObject

:nodoc:


73
74
75
# File 'railties/lib/rails/generators.rb', line 73

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