Module: Rails::Generators
Constant Summary
-
DEFAULT_ALIASES =
# File 'railties/lib/rails/generators.rb', line 29{ rails: { actions: "-a", orm: "-o", javascripts: ["-j", "--js"], resource_controller: "-c", scaffold_controller: "-c", stylesheets: "-y", template_engine: "-e", test_framework: "-t" }, test_unit: { fixture_replacement: "-r", } }
-
DEFAULT_OPTIONS =
# File 'railties/lib/rails/generators.rb', line 46{ 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, 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 weFileUtils.cd
.File. ("../../../../../..", __dir__)
Class Attribute Summary
- .namespace (also: #namespace) rw
Class Method Summary
-
.api_only!
Configure generators for
API
only applications. -
.fallbacks
Hold configured generators fallbacks.
-
.help(command = "generate")
Show help message with available generators.
-
.hidden_namespaces
Returns an array of generator namespaces that are hidden.
-
.hide_namespace(*namespaces)
Alias for .hide_namespaces.
- .hide_namespaces(*namespaces) (also: .hide_namespace)
-
.invoke(namespace, args = ARGV, config = {})
Receives a namespace, arguments, and the behavior to invoke the generator.
- .print_generators
- .public_namespaces
- .sorted_groups
- .command_type private
- .file_lookup_paths private
- .lookup_paths private
- .print_list(base, namespaces) private
Instance Attribute Summary
- #namespace rw
Class Attribute Details
.namespace (rw) Also known as: #namespace
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 27
mattr_accessor :namespace
Class Method Details
.api_only!
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.
# File 'railties/lib/rails/generators.rb', line 112
def api_only! hide_namespaces "assets", "helper", "css", "js" [:rails].merge!( api: true, assets: false, helper: false, template_engine: nil ) [:mailer] ||= {} [:mailer][:template_engine] ||= :erb end
.command_type (private)
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 301
def command_type # :doc: @command_type ||= "generator" end
.fallbacks
Hold configured generators fallbacks. If a plugin developer wants a generator group to fall back 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
# File 'railties/lib/rails/generators.rb', line 104
def fallbacks @fallbacks ||= {} end
.file_lookup_paths (private)
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 309
def file_lookup_paths # :doc: @file_lookup_paths ||= [ "{#{lookup_paths.join(',')}}", "**", "*_generator.rb" ] end
.help(command = "generate")
Show help message with available generators.
# File 'railties/lib/rails/generators.rb', line 165
def help(command = "generate") puts "Usage:" puts " bin/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
.hide_namespace(*namespaces)
Alias for .hide_namespaces.
# File 'railties/lib/rails/generators.rb', line 162
alias hide_namespace hide_namespaces
.hide_namespaces(*namespaces) Also known as: .hide_namespace
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 159
def hide_namespaces(*namespaces) hidden_namespaces.concat(namespaces) end
.invoke(namespace, args = ARGV, config = {})
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.
# File 'railties/lib/rails/generators.rb', line 257
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) run_after_generate_callback if config[:behavior] == :invoke else = sorted_groups.flat_map(&:last) error = Command::CorrectableNameError.new("Could not find generator '#{namespace}'.", namespace, ) puts <<~MSG #{error.} Run `bin/rails generate --help` for more options. MSG end end
.lookup_paths (private)
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 305
def lookup_paths # :doc: @lookup_paths ||= %w( rails/generators generators ) end
.print_generators
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 187
def print_generators sorted_groups.each { |b, n| print_list(b, n) } end
.print_list(base, namespaces) (private)
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 280
def print_list(base, namespaces) # :doc: namespaces = namespaces.reject { |n| hidden_namespaces.include?(n) } super end
.public_namespaces
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 182
def public_namespaces lookup! subclasses.map(&:namespace) end
.sorted_groups
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 191
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.delete_prefix("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
Instance Attribute Details
#namespace (rw)
[ GitHub ]# File 'railties/lib/rails/generators.rb', line 27
mattr_accessor :namespace