Module: Rails::Generators

Defined in:

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/generated_attribute.rb,
railties/lib/rails/generators/rails/app/app_generator.rb,
railties/lib/rails/generators/rails/model/model_generator.rb,
actionmailer/lib/rails/generators/mailer/mailer_generator.rb,
railties/lib/rails/generators/rails/plugin/plugin_generator.rb,
railties/lib/rails/generators/rails/helper/helper_generator.rb,
railties/lib/rails/generators/rails/observer/observer_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/migration/migration_generator.rb,
railties/lib/rails/generators/rails/generator/generator_generator.rb,
railties/lib/rails/generators/rails/plugin_new/plugin_new_generator.rb,
railties/lib/rails/generators/rails/controller/controller_generator.rb,
railties/lib/rails/generators/rails/stylesheets/stylesheets_generator.rb,
railties/lib/rails/generators/rails/integration_test/integration_test_generator.rb,
railties/lib/rails/generators/rails/performance_test/performance_test_generator.rb,
railties/lib/rails/generators/rails/session_migration/session_migration_generator.rb,
railties/lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb

Defined Under Namespace

Modules: Actions, Migration, ResourceHelpers Classes: ActiveModel, AppBase, AppGenerator, Base, ControllerGenerator, Error, GeneratedAttribute, GeneratorGenerator, HelperGenerator, IntegrationTestGenerator, MailerGenerator, MigrationGenerator, ModelGenerator, NamedBase, ObserverGenerator, PerformanceTestGenerator, PluginGenerator, PluginNewGenerator, ResourceGenerator, ScaffoldControllerGenerator, ScaffoldGenerator, SessionMigrationGenerator, StylesheetsGenerator, TestCase

Constant Summary

DEFAULT_ALIASES =

{
  :rails => {
    :actions => '-a',
    :orm => '-o',
    :resource_controller => '-c',
    :scaffold_controller => '-c',
    :stylesheets => '-y',
    :template_engine => '-e',
    :test_framework => '-t'
  },

  :test_unit => {
    :fixture_replacement => '-r',
  },

  :plugin => {
    :generator => '-g',
    :tasks => '-r'
  }
}

DEFAULT_OPTIONS =

{
  :rails => {
    :force_plural => false,
    :helper => true,
    :orm => nil,
    :integration_tool => nil,
    :performance_tool => nil,
    :resource_controller => :controller,
    :scaffold_controller => :scaffold_controller,
    :stylesheets => true,
    :test_framework => nil,
    :template_engine => :erb
  },

  :plugin => {
    :generator => false,
    :tasks => false
  }
}

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

Class Method Summary (collapse)

• + (Object) aliases

  :nodoc:.

• + (Object) configure!(config = Rails.application.config.generators)

  :nodoc:.

• + (Object) fallbacks

  Hold configured generators fallbacks.

• + (Object) find_by_namespace(name, base = nil, context = nil)

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

• + (Object) help(command = 'generate'))

  Show help message with available generators.

• + (Object) hidden_namespaces
• + (Object) hide_namespaces(*namespaces) (also: hide_namespace)
• + (Object) invoke(namespace, args = ARGV, config = {})

  Receives a namespace, arguments and the behavior to invoke the generator.

• + (Object) no_color!

  Remove the color from output.

• + (Object) options

  :nodoc:.

• + (Object) subclasses

  Track all generators subclasses.

• + (Object) templates_path

77
78
79

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

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

64
65
66
67
68
69
70
71

# File 'railties/lib/rails/generators.rb', line 64

def self.configure!(config = Rails.application.config.generators) #: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!
end

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

98
99
100

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

def self.fallbacks
  @fallbacks ||= {}
end

find_by_namespace :webrat, :rails, :integration

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

128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

# File 'railties/lib/rails/generators.rb', line 128

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

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
235
236
237

# File 'railties/lib/rails/generators.rb', line 203

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_new")
  print_list("rails", rails)

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

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

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
191
192
193

# File 'railties/lib/rails/generators.rb', line 166

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

    [
      "rails",
      "#{orm}:migration",
      "#{orm}:model",
      "#{orm}:observer",
      "#{orm}:session_migration",
      "#{test}:controller",
      "#{test}:helper",
      "#{test}:integration",
      "#{test}:mailer",
      "#{test}:model",
      "#{test}:observer",
      "#{test}:scaffold",
      "#{test}:view",
      "#{test}:performance",
      "#{test}:plugin",
      "#{template}:controller",
      "#{template}:scaffold",
      "#{template}:mailer"
    ]
  end
end

196
197
198

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

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

156
157
158
159
160
161
162
163
164

# File 'railties/lib/rails/generators.rb', line 156

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

103
104
105

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

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

81
82
83

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

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

108
109
110

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

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

73
74
75

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

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