Module: Rails::Generators

Defined in:
lib/rails/generators.rb,
lib/rails/generators/base.rb,
lib/rails/generators/actions.rb,
lib/rails/generators/migration.rb,
lib/rails/generators/test_case.rb,
lib/rails/generators/named_base.rb,
lib/rails/generators/active_model.rb,
lib/rails/generators/resource_helpers.rb,
lib/rails/generators/generated_attribute.rb,
lib/rails/generators/rails/app/app_generator.rb,
lib/rails/generators/rails/model/model_generator.rb,
lib/rails/generators/rails/helper/helper_generator.rb,
lib/rails/generators/rails/plugin/plugin_generator.rb,
lib/rails/generators/rails/observer/observer_generator.rb,
lib/rails/generators/rails/resource/resource_generator.rb,
lib/rails/generators/rails/scaffold/scaffold_generator.rb,
lib/rails/generators/rails/generator/generator_generator.rb,
lib/rails/generators/rails/migration/migration_generator.rb,
lib/rails/generators/rails/controller/controller_generator.rb,
lib/rails/generators/rails/stylesheets/stylesheets_generator.rb,
lib/rails/generators/rails/integration_test/integration_test_generator.rb,
lib/rails/generators/rails/performance_test/performance_test_generator.rb,
lib/rails/generators/rails/session_migration/session_migration_generator.rb,
lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb

Defined Under Namespace

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

Constant Summary collapse

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 destroy benchmarker profiler
plugin runner test]

Class Method Summary collapse

Class Method Details

.aliasesObject

:nodoc:


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

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

.configure!(config = Rails.application.config.generators) ⇒ Object

:nodoc:


64
65
66
67
68
69
70
71
# File '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

.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

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

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.

Examples

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.


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File '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 = subclasses.inject({}) do |hash, klass|
    hash[klass.namespace] = klass
    hash
  end

  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.


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
238
239
# File 'lib/rails/generators.rb', line 206

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")
  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


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
194
195
196
# File 'lib/rails/generators.rb', line 169

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

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


199
200
201
# File 'lib/rails/generators.rb', line 199

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.


159
160
161
162
163
164
165
166
167
# File 'lib/rails/generators.rb', line 159

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.


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

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

.optionsObject

:nodoc:


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

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

.subclassesObject

Track all generators subclasses.


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

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

.templates_pathObject


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

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