跳至内容 跳至搜索
命名空间
方法
A
C
F
H
I
L
P
S

常量

DEFAULT_ALIASES = { 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 = { 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 } }
 

类公共方法

api_only!()

配置生成器，使其仅用于API应用程序。它主要隐藏所有与浏览器相关的部分，例如资产和会话迁移生成器，并完全禁用助手和资产，因此像脚手架这样的生成器不会创建它们。

来源： 显示 | 在GitHub上

# File railties/lib/rails/generators.rb, line 116
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

fallbacks()

保存已配置的生成器后备。如果插件开发者希望生成器组在缺少生成器的情况下回退到另一个组，他们可以添加一个后备。

例如，shoulda被视为test_framework，是test_unit的扩展。然而，shoulda生成器的大部分与test_unit的生成器相似。

然后，shoulda可以指示生成器在某些生成器不可用时搜索test_unit生成器，方法是添加一个后备。

Rails::Generators.fallbacks[:shoulda] = :test_unit

来源： 显示 | 在GitHub上

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

help(command = "generate")

显示可用生成器的帮助消息。

来源： 显示 | 在GitHub上

# File railties/lib/rails/generators.rb, line 172
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

hidden_namespaces()

返回一个隐藏的生成器命名空间数组。生成器命名空间可能由于多种原因而被隐藏。有些被别名为“rails:migration”，可以使用更短的“migration”来调用。

来源： 显示 | 在GitHub上

# File railties/lib/rails/generators.rb, line 134
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

hide_namespace(*namespaces)

别名： hide_namespaces

hide_namespaces(*namespaces)

也别名为： hide_namespace

来源： 显示 | 在GitHub上

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

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

接收一个命名空间、参数和要调用的生成器的行为。它被用作generate、destroy和update命令的默认入口点。

来源： 显示 | 在GitHub上

# File railties/lib/rails/generators.rb, line 263
      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

print_generators()

来源： 显示 | 在GitHub上

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

public_namespaces()

来源： 显示 | 在GitHub上

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

sorted_groups()

来源： 显示 | 在GitHub上

# File railties/lib/rails/generators.rb, line 198
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

类私有方法

command_type()

来源： 显示 | 在GitHub上

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

file_lookup_paths()

来源： 显示 | 在GitHub上

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

lookup_paths()

来源： 显示 | 在GitHub上

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

print_list(base, namespaces)

来源： 显示 | 在GitHub上

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