module Rails::Generators::Actions
Публичные методы экземпляра
# 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 Добавить указанный источник к 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 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 Добавляет код конфигурации в среду выполнения Rails.
По умолчанию добавляет код внутри класса Application в config/application.rb, так что он применяется ко всем средам.
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
# 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 в 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 -
Выводит комментарий над объявлением
gemвGemfile.gem "my_gem", comment: "First line.\nSecond line."
Выводит:
# First line. # Second line. gem "my_gem"
-
:group -
Группа gem в
Gemfile, к которой принадлежит gem. -
:git -
URL git-репозитория для gem.
Все дополнительные параметры, переданные этому методу, будут добавлены к объявлению gem в Gemfile. Например:
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 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 Оборачивает записи gem внутри группы.
gem_group :development, :test do gem "rspec-rails" end
# 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 Запускает другой генератор.
generate "scaffold", "Post title:string body:text" generate "scaffold", "Post", "title:string", "body:text"
Первый аргумент — имя генератора, а остальные аргументы объединяются и передаются генератору.
# 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 Запускает одну или несколько команд 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 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 # 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 Создает файл инициализации в 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 275
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 "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 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 Запускает указанную команду 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 364
def rake(command, options = {})
execute_command :rake, command, options
end Запускает указанную задачу 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 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 Создает файл задач Rake в lib/tasks/. Код может быть указан как аргумент или как возвращаемое значение блока.
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 442 def readme(path) log File.read(find_in_source_paths(path)) end
Читает указанный файл в корневом каталоге исходного кода и выводит его в консоль.
readme "README"
# 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 Создает запись в файле маршрутизации Rails config/routes.rb
route "root 'welcome#index'" route "root 'admin#index'", namespace: :admin
# 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 Создает файл в 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 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 Выполняет предоставленную команду, используя «rake …» или «rails …» в зависимости от предоставленного параметра executor.
# File railties/lib/rails/generators/actions.rb, line 494 def indentation # :doc: " " * @indentation end
Отступы Gemfile до уровня @indentation
# 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 Определение log для обратной совместимости. Если отправлен только один аргумент, вызывается say, в противном случае вызывается say_status. В отличие от say и аналогично say_status, этот метод учитывает опцию quiet?
# 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 Возвращает оптимизированную строку с отступами
# 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 Всегда возвращает значение в двойных кавычках.
# File railties/lib/rails/generators/actions.rb, line 499 def with_indentation(&block) # :doc: @indentation += 1 instance_eval(&block) ensure @indentation -= 1 end
Управление отступами Gemfile для блока действия DSL
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.