модуль Rails::Generators::Actions
Публичные методы экземпляров
# File railties/lib/rails/generators/actions.rb, line 94
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 Добавить указанный источник в 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 120
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 Добавляет строку в класс Application для config/application.rb.
Если указаны параметры :env, строка добавляется в соответствующий файл в config/environments.
environment do "config.asset_host = 'cdn.provider.com'" end environment(nil, env: "development") do "config.asset_host = 'localhost:3000'" end
# File railties/lib/rails/generators/actions.rb, line 21
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
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 = "gem #{parts.join(", ")}"
str = indentation + str
append_file_with_newline "Gemfile", str, verbose: false
end
end Добавляет запись в 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"
# File railties/lib/rails/generators/actions.rb, line 54
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 Оборачивает записи gem в группу.
gem_group :development, :test do gem "rspec-rails" end
# File railties/lib/rails/generators/actions.rb, line 226
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 Генерирует что-то с помощью генератора из Rails или плагина. Второй параметр — строка аргументов, передаваемая генератору или Array, которая соединяется.
generate(:authenticated, "user session")
# File railties/lib/rails/generators/actions.rb, line 142
def git(commands = {})
if commands.is_a?(Symbol)
run "git #{commands}"
else
commands.each do |cmd, options|
run "git #{cmd} #{options}"
end
end
end Выполнить команду в git.
git :init git add: "this.file that.rb" git add: "onefile.rb", rm: "badfile.cxx"
# File railties/lib/rails/generators/actions.rb, line 68
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 # File railties/lib/rails/generators/actions.rb, line 215
def initializer(filename, data = nil)
log :initializer, filename
data ||= yield if block_given?
create_file("config/initializers/#{filename}", optimize_indentation(data), verbose: false)
end Создать новый инициализатор с предоставленным кодом (в блоке или строке).
initializer("globals.rb") do
data = ""
['MY_WORK', 'ADMINS', 'BEST_COMPANY_EVAR'].each do |const|
data << "#{const} = :entp\n"
end
data
end
initializer("api.rb", "API_KEY = '123456'")
# File railties/lib/rails/generators/actions.rb, line 175
def lib(filename, data = nil)
log :lib, filename
data ||= yield if block_given?
create_file("lib/#{filename}", optimize_indentation(data), verbose: false)
end Создать новый файл в каталоге lib/. Код можно указать в блоке или в виде строки данных.
lib("crypto.rb") do
"crypted_special_value = '#{rand}--#{Time.now}--#{rand(1337)}--'"
end
lib("foreign.rb", "# Foreign code is fun")
# File railties/lib/rails/generators/actions.rb, line 251
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 (вызывается с помощью 'rails …')
rails_command("db:migrate")
rails_command("db:migrate", env: "production")
rails_command("gems:install", sudo: true)
rails_command("gems:install", capture: true)
# File railties/lib/rails/generators/actions.rb, line 241
def rake(command, options = {})
execute_command :rake, command, options
end Выполняет предоставленную задачу rake (вызывается с помощью 'rake …')
rake("db:migrate")
rake("db:migrate", env: "production")
rake("gems:install", sudo: true)
rake("gems:install", capture: true)
# File railties/lib/rails/generators/actions.rb, line 196
def rakefile(filename, data = nil)
log :rakefile, filename
data ||= yield if block_given?
create_file("lib/tasks/#{filename}", optimize_indentation(data), verbose: false)
end Создать новый Rakefile с предоставленным кодом (в блоке или строке).
rakefile("bootstrap.rake") do
project = ask("What is the UNIX name of your project?")
<<-TASK
namespace :#{project} do
task :bootstrap do
puts "I like boots!"
end
end
TASK
end
rakefile('seed.rake', 'puts "Planting seeds"')
# File railties/lib/rails/generators/actions.rb, line 285 def readme(path) log File.read(find_in_source_paths(path)) end
Считывает указанный файл в корневом каталоге источника и выводит его в консоль.
readme "README"
# File railties/lib/rails/generators/actions.rb, line 269
def route(routing_code, namespace: nil)
routing_code = Array(namespace).reverse.reduce(routing_code) do |code, ns|
"namespace :#{ns} do\n#{indent(code, 2)}\nend"
end
log :route, routing_code
sentinel = /\.routes\.draw do\s*\n/m
in_root do
inject_into_file "config/routes.rb", optimize_indentation(routing_code, 2), after: sentinel, verbose: false, force: false
end
end Создать запись в файле маршрутизации Rails config/routes.rb
route "root 'welcome#index'" route "root 'admin#index'", namespace: :admin
# File railties/lib/rails/generators/actions.rb, line 161
def vendor(filename, data = nil)
log :vendor, filename
data ||= yield if block_given?
create_file("vendor/#{filename}", optimize_indentation(data), verbose: false)
end Создать новый файл в каталоге vendor/. Код можно указать в блоке или в виде строки данных.
vendor("sekrit.rb") do
sekrit_salt = "#{Time.now}--#{3.years.ago}--#{rand}--"
"salt = '#{sekrit_salt}'"
end
vendor("foreign.rb", "# Foreign code is fun")
Приватные методы экземпляров
# File railties/lib/rails/generators/actions.rb, line 304
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}#{extify(executor)} #{command}", config) }
end Выполняет предоставленную команду с использованием «rake …» или «rails …» в зависимости от предоставленного параметра executor.
# File railties/lib/rails/generators/actions.rb, line 318
def extify(name) # :doc:
if Gem.win_platform?
"#{name}.bat"
else
name
end
end Добавить расширение к заданному имени в зависимости от платформы.
# File railties/lib/rails/generators/actions.rb, line 350 def indentation # :doc: " " * @indentation end
Отступ Gemfile на глубину @indentation.
# File railties/lib/rails/generators/actions.rb, line 293
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 Определение log для обратной совместимости. Если передано только одно значение, вызывается say, в противном случае вызывается say_status. В отличие от say и аналогично say_status, этот метод учитывает параметр quiet?
# File railties/lib/rails/generators/actions.rb, line 344
def optimize_indentation(value, amount = 0) # :doc:
return "#{value}\n" unless value.is_a?(String)
"#{value.strip_heredoc.indent(amount).chomp}\n"
end Возвращает оптимизированную строку с отступом.
# File railties/lib/rails/generators/actions.rb, line 328
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
if value.include?("'")
value.inspect
else
"'#{value}'"
end
end Оборачивает строку в одинарные кавычки, если нет кавычек. В противном случае использует двойные кавычки.
# File railties/lib/rails/generators/actions.rb, line 355 def with_indentation(&block) # :doc: @indentation += 1 instance_eval(&block) ensure @indentation -= 1 end
Управление отступом Gemfile для блока действия DSL.
© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.