W3cubDocs

module Rails::Generators

Constants

DEFAULT_ALIASES
DEFAULT_OPTIONS
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.
RESERVED_NAMES

Public Class Methods

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 115
def api_only!
  hide_namespaces "assets", "helper", "css", "js"

  options[:rails].merge!(
    api: true,
    assets: false,
    helper: false,
    template_engine: nil
  )

  if ARGV.first == "mailer"
    options[:rails].merge!(template_engine: :erb)
  end
end

fallbacks() Show source

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

# File railties/lib/rails/generators.rb, line 107
def fallbacks
  @fallbacks ||= {}
end

help(command = "generate") Show source

Show help message with available generators.

# File railties/lib/rails/generators.rb, line 178
def 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() Show source

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”.

# File railties/lib/rails/generators.rb, line 140
def 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}:system",
      "#{test}:mailer",
      "#{test}:model",
      "#{test}:scaffold",
      "#{test}:view",
      "#{test}:job",
      "#{template}:controller",
      "#{template}:scaffold",
      "#{template}:mailer",
      "#{css}:scaffold",
      "#{css}:assets",
      "css:assets",
      "css:scaffold"
    ]
  end
end

hide_namespace(*namespaces)

Alias for: hide_namespaces

hide_namespaces(*namespaces) Show source

# File railties/lib/rails/generators.rb, line 172
def hide_namespaces(*namespaces)
  hidden_namespaces.concat(namespaces)
end

Also aliased as: hide_namespace

invoke(namespace, args = ARGV, config = {}) Show source

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 265
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)
  else
    options     = sorted_groups.flat_map(&:last)
    suggestions = options.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 ", locale: :en) }\n"
    msg << "Run `rails generate --help` for more options."
    puts msg
  end
end

no_color!() Show source

Remove the color from output.

# File railties/lib/rails/generators.rb, line 131
def no_color!
  Thor::Base.shell = Thor::Shell::Basic
end

print_generators() Show source

# File railties/lib/rails/generators.rb, line 199
def print_generators
  sorted_groups.each { |b, n| print_list(b, n) }
end

public_namespaces() Show source

# File railties/lib/rails/generators.rb, line 194
def public_namespaces
  lookup!
  subclasses.map(&:namespace)
end

sorted_groups() Show source

# File railties/lib/rails/generators.rb, line 203
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.sub(/^rails:/, "") }
  rails.delete("app")
  rails.delete("plugin")
  rails.delete("encrypted_secrets")

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

  [[ "rails", rails ]] + groups.sort.to_a
end

Private Class Methods

command_type() Show source

# File railties/lib/rails/generators.rb, line 303
def command_type # :doc:
  @command_type ||= "generator"
end

file_lookup_paths() Show source

# File railties/lib/rails/generators.rb, line 311
def file_lookup_paths # :doc:
  @file_lookup_paths ||= [ "{#{lookup_paths.join(',')}}", "**", "*_generator.rb" ]
end

lookup_paths() Show source

# File railties/lib/rails/generators.rb, line 307
def lookup_paths # :doc:
  @lookup_paths ||= %w( rails/generators generators )
end

print_list(base, namespaces) Show source

Calls superclass method

# File railties/lib/rails/generators.rb, line 282
def print_list(base, namespaces) # :doc:
  namespaces = namespaces.reject { |n| hidden_namespaces.include?(n) }
  super
end