Module: Rails::Generators
- Defined in:
- lib/rails/generators.rb,
lib/rails/generators/base.rb,
lib/rails/generators/actions.rb,
lib/rails/generators/app_base.rb,
lib/rails/commands/application.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/model_helpers.rb,
lib/rails/generators/resource_helpers.rb,
lib/rails/generators/testing/behaviour.rb,
lib/rails/generators/testing/assertions.rb,
lib/rails/generators/generated_attribute.rb,
lib/rails/generators/rails/app/app_generator.rb,
lib/rails/generators/actions/create_migration.rb,
lib/rails/generators/rails/task/task_generator.rb,
lib/rails/generators/testing/setup_and_teardown.rb,
lib/rails/generators/rails/model/model_generator.rb,
lib/rails/generators/rails/assets/assets_generator.rb,
lib/rails/generators/rails/helper/helper_generator.rb,
lib/rails/generators/rails/plugin/plugin_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/resource_route/resource_route_generator.rb,
lib/rails/generators/rails/integration_test/integration_test_generator.rb,
lib/rails/generators/rails/scaffold_controller/scaffold_controller_generator.rb
Defined Under Namespace
Modules: Actions, Migration, ModelHelpers, ResourceHelpers, Testing Classes: ARGVScrubber, ActiveModel, AppBase, AppGenerator, AssetsGenerator, Base, ControllerGenerator, Error, GeneratedAttribute, GeneratorGenerator, HelperGenerator, IntegrationTestGenerator, 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.("../../../../../..", File.dirname(__FILE__))
- RESERVED_NAMES =
%w[application destroy plugin runner test]
Class Method Summary collapse
-
.aliases ⇒ Object
:nodoc:.
-
.configure!(config) ⇒ Object
:nodoc:.
-
.fallbacks ⇒ Object
Hold configured generators fallbacks.
-
.find_by_namespace(name, base = nil, context = nil) ⇒ Object
Rails finds namespaces similar to thor, it only adds one rule:.
-
.help(command = 'generate') ⇒ Object
Show help message with available generators.
-
.hidden_namespaces ⇒ Object
Returns an array of generator namespaces that are hidden.
- .hide_namespaces(*namespaces) ⇒ Object (also: hide_namespace)
-
.invoke(namespace, args = ARGV, config = {}) ⇒ Object
Receives a namespace, arguments and the behavior to invoke the generator.
-
.no_color! ⇒ Object
Remove the color from output.
-
.options ⇒ Object
:nodoc:.
- .print_generators ⇒ Object
- .public_namespaces ⇒ Object
- .sorted_groups ⇒ Object
-
.subclasses ⇒ Object
Track all generators subclasses.
-
.templates_path ⇒ Object
:nodoc:.
Class Method Details
.aliases ⇒ Object
:nodoc:
78 79 80 |
# File 'lib/rails/generators.rb', line 78 def self.aliases #:nodoc: @aliases ||= DEFAULT_ALIASES.dup end |
.configure!(config) ⇒ Object
:nodoc:
64 65 66 67 68 69 70 71 72 |
# File 'lib/rails/generators.rb', line 64 def self.configure!(config) #:nodoc: no_color! unless config.colorize_logging aliases.deep_merge! config.aliases .deep_merge! config. 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
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.
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.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/rails/generators.rb', line 125 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.
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/rails/generators.rb', line 211 def self.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”.
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/rails/generators.rb', line 173 def self.hidden_namespaces @hidden_namespaces ||= begin orm = [:rails][:orm] test = [:rails][:test_framework] template = [:rails][:template_engine] css = [: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
204 205 206 |
# File 'lib/rails/generators.rb', line 204 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.
153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/rails/generators.rb', line 153 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 = sorted_groups.map(&:last).flatten suggestions = .sort_by {|suggested| levenshtein_distance(namespace.to_s, suggested) }.first(3) msg = "Could not find generator '#{namespace}'. " msg << "Maybe you meant #{ suggestions.map {|s| "'#{s}'"}.to_sentence(last_word_connector: " or ") }\n" msg << "Run `rails generate --help` for more options." puts msg 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 |
.options ⇒ Object
:nodoc:
82 83 84 |
# File 'lib/rails/generators.rb', line 82 def self. #:nodoc: @options ||= DEFAULT_OPTIONS.dup end |
.print_generators ⇒ Object
232 233 234 |
# File 'lib/rails/generators.rb', line 232 def self.print_generators sorted_groups.each { |b, n| print_list(b, n) } end |
.public_namespaces ⇒ Object
227 228 229 230 |
# File 'lib/rails/generators.rb', line 227 def self.public_namespaces lookup! subclasses.map { |k| k.namespace } end |
.sorted_groups ⇒ Object
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 |
# File 'lib/rails/generators.rb', line 236 def self.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") hidden_namespaces.each { |n| groups.delete(n.to_s) } [["rails", rails]] + groups.sort.to_a end |
.subclasses ⇒ Object
Track all generators subclasses.
108 109 110 |
# File 'lib/rails/generators.rb', line 108 def self.subclasses @subclasses ||= [] end |
.templates_path ⇒ Object
:nodoc:
74 75 76 |
# File 'lib/rails/generators.rb', line 74 def self.templates_path #:nodoc: @templates_path ||= [] end |