跳至内容 跳至搜索
方法
A
E
G
I
L
O
Q
R
V
W

实例公有方法

add_source(source, options = {}, &block)

将给定的源添加到Gemfile

如果提供块,块中的 gem 条目将被包装到源组中。

add_source "http://gems.github.com/"

add_source "http://gems.github.com/" do
  gem "rspec-rails"
end
# File railties/lib/rails/generators/actions.rb, line 151
def add_source(source, options = {}, &block)
  log :source, source

  in_root do
    if block
      append_file_with_newline "Gemfile", "\nsource #{quote(source)} do", force: true
      with_indentation(&block)
      append_file_with_newline "Gemfile", "end", force: true
    else
      prepend_file "Gemfile", "source #{quote(source)}\n", verbose: false
    end
  end
end

application(data = nil, options = {})

别名为:environment

environment(data = nil, options = {})

将配置代码添加到 Rails 运行时环境。

默认情况下,将代码添加到config/application.rb中的Application类中,以便它适用于所有环境。

environment %(config.asset_host = "cdn.provider.com")

结果为

# config/application.rb
class Application < Rails::Application
  config.asset_host = "cdn.provider.com"
  # ...
end

如果指定了:env选项,则代码将添加到config/environments中的相应文件中。

environment %(config.asset_host = "localhost:3000"), env: "development"

结果为

# config/environments/development.rb
Rails.application.configure do
  config.asset_host = "localhost:3000"
  # ...
end

:env也可以是数组。在这种情况下,代码将添加到config/environments中的每个相应文件中。

代码也可以指定为块的返回值

environment do
  %(config.asset_host = "cdn.provider.com")
end

environment(nil, env: "development") do
  %(config.asset_host = "localhost:3000")
end
也别名为:application
# File railties/lib/rails/generators/actions.rb, line 206
def environment(data = nil, options = {})
  sentinel = "class Application < Rails::Application\n"
  env_file_sentinel = "Rails.application.configure do\n"
  data ||= yield if block_given?

  in_root do
    if options[:env].nil?
      inject_into_file "config/application.rb", optimize_indentation(data, 4), after: sentinel, verbose: false
    else
      Array(options[:env]).each do |env|
        inject_into_file "config/environments/#{env}.rb", optimize_indentation(data, 2), after: env_file_sentinel, verbose: false
      end
    end
  end
end

gem(*args)

为指定的 gem 在Gemfile中添加一个gem声明。

gem "rspec", group: :test
gem "technoweenie-restful-authentication", lib: "restful-authentication", source: "http://gems.github.com/"
gem "rails", "3.0", git: "https://github.com/rails/rails"
gem "RedCloth", ">= 4.1.0", "< 4.2.0"
gem "rspec", comment: "Put this comment above the gem declaration"

请注意,此方法只将 gem 添加到Gemfile中;它不会安装 gem。

选项

:version

gem 的版本约束,指定为字符串或字符串数组

gem "my_gem", version: "~> 1.1"
gem "my_gem", version: [">= 1.1", "< 2.0"]

或者,可以指定为 gem 名称之后的参数

gem "my_gem", ">= 1.1", "< 2.0"
:comment

Gemfile中的gem声明上方输出注释。

gem "my_gem", comment: "First line.\nSecond line."

输出

# First line.
# Second line.
gem "my_gem"
:group

Gemfile中 gem 所属的 gem 组。

:git

gem 的 git 仓库 URL。

传递给此方法的任何其他选项都将附加到Gemfile中的gem声明。例如

gem "my_gem", comment: "Edge my_gem", git: "https://example.com/my_gem.git", branch: "master"

输出

# Edge my_gem
gem "my_gem", git: "https://example.com/my_gem.git", branch: "master"
# File railties/lib/rails/generators/actions.rb, line 67
def gem(*args)
  options = args.extract_options!
  name, *versions = args

  # Set the message to be shown in logs. Uses the git repo if one is given,
  # otherwise use name (version).
  parts, message = [ quote(name) ], name.dup

  # Output a comment above the gem declaration.
  comment = options.delete(:comment)

  if versions = versions.any? ? versions : options.delete(:version)
    _versions = Array(versions)
    _versions.each do |version|
      parts << quote(version)
    end
    message << " (#{_versions.join(", ")})"
  end
  message = options[:git] if options[:git]

  log :gemfile, message

  parts << quote(options) unless options.empty?

  in_root do
    str = []
    if comment
      comment.each_line do |comment_line|
        str << indentation
        str << "# #{comment_line}"
      end
      str << "\n"
    end
    str << indentation
    str << "gem #{parts.join(", ")}"
    append_file_with_newline "Gemfile", str.join, verbose: false
  end
end

gem_group(*names, &block)

将 gem 条目包装到组中。

gem_group :development, :test do
  gem "rspec-rails"
end
# File railties/lib/rails/generators/actions.rb, line 111
def gem_group(*names, &block)
  options = names.extract_options!
  str = names.map(&:inspect)
  str << quote(options) unless options.empty?
  str = str.join(", ")
  log :gemfile, "group #{str}"

  in_root do
    append_file_with_newline "Gemfile", "\ngroup #{str} do", force: true
    with_indentation(&block)
    append_file_with_newline "Gemfile", "end", force: true
  end
end

generate(what, *args)

运行另一个生成器。

generate "scaffold", "Post title:string body:text"
generate "scaffold", "Post", "title:string", "body:text"

第一个参数是生成器名称,其余参数将合并在一起并传递给生成器。

# File railties/lib/rails/generators/actions.rb, line 332
def generate(what, *args)
  log :generate, what

  options = args.extract_options!
  options[:abort_on_failure] = !options[:inline]

  rails_command "generate #{what} #{args.join(" ")}", options
end

git(commands = {})

运行一个或多个 git 命令。

git :init
# => runs `git init`

git add: "this.file that.rb"
# => runs `git add this.file that.rb`

git commit: "-m 'First commit'"
# => runs `git commit -m 'First commit'`

git add: "good.rb", rm: "bad.cxx"
# => runs `git add good.rb; git rm bad.cxx`
# File railties/lib/rails/generators/actions.rb, line 237
def git(commands = {})
  if commands.is_a?(Symbol)
    run "git #{commands}"
  else
    commands.each do |cmd, options|
      run "git #{cmd} #{options}"
    end
  end
end

github(repo, options = {}, &block)

# File railties/lib/rails/generators/actions.rb, line 125
def github(repo, options = {}, &block)
  str = [quote(repo)]
  str << quote(options) unless options.empty?
  str = str.join(", ")
  log :github, "github #{str}"

  in_root do
    if @indentation.zero?
      append_file_with_newline "Gemfile", "\ngithub #{str} do", force: true
    else
      append_file_with_newline "Gemfile", "#{indentation}github #{str} do", force: true
    end
    with_indentation(&block)
    append_file_with_newline "Gemfile", "#{indentation}end", force: true
  end
end

initializer(filename, data = nil)

config/initializers/中创建一个初始化文件。代码可以指定为参数,也可以指定为块的返回值。

initializer "api.rb", <<~RUBY
  API_KEY = "123456"
RUBY

initializer "api.rb" do
  %(API_KEY = "123456")
end
# File railties/lib/rails/generators/actions.rb, line 319
def initializer(filename, data = nil)
  log :initializer, filename
  data ||= yield if block_given?
  create_file("config/initializers/#{filename}", optimize_indentation(data), verbose: false)
end

lib(filename, data = nil)

lib/中创建一个文件。内容可以指定为参数,也可以指定为块的返回值。

lib "foreign.rb", <<~RUBY
  # Foreign code is fun
RUBY

lib "foreign.rb" do
  "# Foreign code is fun"
end
# File railties/lib/rails/generators/actions.rb, line 275
def lib(filename, data = nil)
  log :lib, filename
  data ||= yield if block_given?
  create_file("lib/#{filename}", optimize_indentation(data), verbose: false)
end

rails_command(command, options = {})

运行指定的 Rails 命令。

rails_command "db:migrate"
rails_command "db:migrate", env: "production"
rails_command "db:migrate", abort_on_failure: true
rails_command "stats", capture: true
rails_command "gems:install", sudo: true

选项

:env

运行命令的 Rails 环境。默认值为ENV["RAILS_ENV"] || "development"

:abort_on_failure

如果命令以非成功退出状态退出,是否停止生成器。

:capture

是否捕获并返回命令的输出。

:sudo

是否使用sudo运行命令。

# File railties/lib/rails/generators/actions.rb, line 391
def rails_command(command, options = {})
  if options[:inline]
    log :rails, command
    command, *args = Shellwords.split(command)
    in_root do
      silence_warnings do
        ::Rails::Command.invoke(command, args, **options)
      end
    end
  else
    execute_command :rails, command, options
  end
end

rake(command, options = {})

运行指定的 Rake 任务。

rake "db:migrate"
rake "db:migrate", env: "production"
rake "db:migrate", abort_on_failure: true
rake "stats", capture: true
rake "gems:install", sudo: true

选项

:env

运行任务的 Rails 环境。默认值为ENV["RAILS_ENV"] || "development"

:abort_on_failure

如果任务以非成功退出状态退出,是否停止生成器。

:capture

是否捕获并返回任务的输出。

:sudo

是否使用sudo运行任务。

# File railties/lib/rails/generators/actions.rb, line 364
def rake(command, options = {})
  execute_command :rake, command, options
end

rakefile(filename, data = nil)

lib/tasks/中创建一个 Rake 任务文件。代码可以指定为参数,也可以指定为块的返回值。

rakefile "bootstrap.rake", <<~RUBY
  task :bootstrap do
    puts "Boots! Boots! Boots!"
  end
RUBY

rakefile "bootstrap.rake" do
  project = ask("What is the UNIX name of your project?")

  <<~RUBY
    namespace :#{project} do
      task :bootstrap do
        puts "Boots! Boots! Boots!"
      end
    end
  RUBY
end
# File railties/lib/rails/generators/actions.rb, line 302
def rakefile(filename, data = nil)
  log :rakefile, filename
  data ||= yield if block_given?
  create_file("lib/tasks/#{filename}", optimize_indentation(data), verbose: false)
end

readme(path)

读取源根目录下的给定文件,并在控制台中打印。

readme "README"
# File railties/lib/rails/generators/actions.rb, line 442
def readme(path)
  log File.read(find_in_source_paths(path))
end

route(routing_code, namespace: nil)

在 Rails 路由文件config/routes.rb中创建一个条目

route "root 'welcome#index'"
route "root 'admin#index'", namespace: :admin
# File railties/lib/rails/generators/actions.rb, line 409
def route(routing_code, namespace: nil)
  namespace = Array(namespace)
  namespace_pattern = route_namespace_pattern(namespace)
  routing_code = namespace.reverse.reduce(routing_code) do |code, name|
    "namespace :#{name} do\n#{rebase_indentation(code, 2)}end"
  end

  log :route, routing_code

  in_root do
    if namespace_match = match_file("config/routes.rb", namespace_pattern)
      base_indent, *, existing_block_indent = namespace_match.captures.compact.map(&:length)
      existing_line_pattern = /^[ ]{,#{existing_block_indent}}\S.+\n?/
      routing_code = rebase_indentation(routing_code, base_indent + 2).gsub(existing_line_pattern, "")
      namespace_pattern = /#{Regexp.escape namespace_match.to_s}/
    end

    inject_into_file "config/routes.rb", routing_code, after: namespace_pattern, verbose: false, force: false

    if behavior == :revoke && namespace.any? && namespace_match
      empty_block_pattern = /(#{namespace_pattern})((?:\s*end\n){1,#{namespace.size}})/
      gsub_file "config/routes.rb", empty_block_pattern, verbose: false, force: true do |matched|
        beginning, ending = empty_block_pattern.match(matched).captures
        ending.sub!(/\A\s*end\n/, "") while !ending.empty? && beginning.sub!(/^[ ]*namespace .+ do\n\s*\z/, "")
        beginning + ending
      end
    end
  end
end

vendor(filename, data = nil)

vendor/中创建一个文件。内容可以指定为参数,也可以指定为块的返回值。

vendor "foreign.rb", <<~RUBY
  # Foreign code is fun
RUBY

vendor "foreign.rb" do
  "# Foreign code is fun"
end
# File railties/lib/rails/generators/actions.rb, line 258
def vendor(filename, data = nil)
  log :vendor, filename
  data ||= yield if block_given?
  create_file("vendor/#{filename}", optimize_indentation(data), verbose: false)
end

实例私有方法

execute_command(executor, command, options = {})

使用“rake …”或“rails …”运行提供的命令,具体取决于提供的执行器参数。

# File railties/lib/rails/generators/actions.rb, line 461
def execute_command(executor, command, options = {}) # :doc:
  log executor, command
  sudo = options[:sudo] && !Gem.win_platform? ? "sudo " : ""
  config = {
    env: { "RAILS_ENV" => (options[:env] || ENV["RAILS_ENV"] || "development") },
    verbose: false,
    capture: options[:capture],
    abort_on_failure: options[:abort_on_failure],
  }

  in_root { run("#{sudo}#{Shellwords.escape Gem.ruby} bin/#{executor} #{command}", config) }
end

indentation()

Gemfile缩进到@indentation的深度

# File railties/lib/rails/generators/actions.rb, line 494
def indentation # :doc:
  "  " * @indentation
end

log(*args)

为向后兼容性定义 log。如果只发送一个参数,则调用 say,否则调用 say_status。与 say 不同,与 say_status 相似,此方法会尊重提供的 quiet? 选项。

# File railties/lib/rails/generators/actions.rb, line 450
def log(*args) # :doc:
  if args.size == 1
    say args.first.to_s unless options.quiet?
  else
    args << (behavior == :invoke ? :green : :red)
    say_status(*args)
  end
end

optimize_indentation(value, amount = 0)

返回带有缩进的优化字符串

也别名为:rebase_indentation
# File railties/lib/rails/generators/actions.rb, line 487
def optimize_indentation(value, amount = 0) # :doc:
  return "#{value}\n" unless value.is_a?(String)
  "#{value.strip_heredoc.indent(amount).chomp}\n"
end

quote(value)

始终以双引号返回 value。

# File railties/lib/rails/generators/actions.rb, line 475
def quote(value) # :doc:
  if value.respond_to? :each_pair
    return value.map do |k, v|
      "#{k}: #{quote(v)}"
    end.join(", ")
  end
  return value.inspect unless value.is_a? String

  "\"#{value.tr("'", '"')}\""
end

with_indentation(&block)

为 DSL 操作块管理Gemfile缩进

# File railties/lib/rails/generators/actions.rb, line 499
def with_indentation(&block) # :doc:
  @indentation += 1
  instance_eval(&block)
ensure
  @indentation -= 1
end