Module: Rails::Generators

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

def after_generate_callbacks # :nodoc:
  @after_generate_callbacks ||= []
end

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

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

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

def api_only!
  hide_namespaces "assets", "helper", "css", "js"

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

  options[:mailer] ||= {}
  options[:mailer][:template_engine] ||= :erb
end

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

def command_type # :doc:
  @command_type ||= "generator"
end

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

def configure!(config) # :nodoc:
  api_only! if config.api_only
  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!
  hide_namespaces(*config.hidden_namespaces)
  after_generate_callbacks.replace config.after_generate_callbacks
end

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

def fallbacks
  @fallbacks ||= {}
end

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

def file_lookup_paths # :doc:
  @file_lookup_paths ||= [ "{#{lookup_paths.join(',')}}", "**", "*_generator.rb" ]
end

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

def 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.index_by(&:namespace)
  lookups.each do |namespace|
    klass = namespaces[namespace]
    return klass if klass
  end

  invoke_fallbacks_for(name, base) || invoke_fallbacks_for(context, name)
end

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

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

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

def hidden_namespaces
  @hidden_namespaces ||= begin
    orm      = options[:rails][:orm]
    test     = options[:rails][:test_framework]
    template = options[:rails][:template_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",
      "action_text:install",
      "action_mailbox:install",
      "devcontainer"
    ].tap do |h|
      h << "test_unit" if test.to_s != "test_unit"
    end
  end
end

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

alias hide_namespace hide_namespaces

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

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

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

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
    options = sorted_groups.flat_map(&:last)
    error = Command::CorrectableNameError.new("Could not find generator '#{namespace}'.", namespace, options)

    puts <<~MSG
      #{error.detailed_message}
      Run `bin/rails generate --help` for more options.
    MSG
    exit 1
  end
end

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

def invoke_fallbacks_for(name, base)
  return nil unless base && fallbacks[base.to_sym]
  invoked_fallbacks = []

  Array(fallbacks[base.to_sym]).each do |fallback|
    next if invoked_fallbacks.include?(fallback)
    invoked_fallbacks << fallback

    klass = find_by_namespace(name, fallback)
    return klass if klass
  end

  nil
end

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

def lookup_paths # :doc:
  @lookup_paths ||= %w( rails/generators generators )
end

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

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

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

def print_generators
  sorted_groups.each { |b, n| print_list(b, n) }
end

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

def print_list(base, namespaces) # :doc:
  namespaces = namespaces.reject { |n| hidden_namespaces.include?(n) }
  super
end

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

def public_namespaces
  lookup!
  subclasses.map(&:namespace)
end

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

def run_after_generate_callback
  if defined?(@@generated_files) && !@@generated_files.empty?
    after_generate_callbacks.each do |callback|
      callback.call(@@generated_files)
    end
    @@generated_files = []
  end
end

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

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_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

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

def templates_path # :nodoc:
  @templates_path ||= []
end