Spec-Zone.ru › Ruby on Rails 5.1

модуль Rails::Generators::Actions

Открытые методы экземпляров

add_source(source, options = {}, &block) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 71
def add_source(source, options = {}, &block)
  log :source, source

  in_root do
    if block
      append_file "Gemfile", "\nsource #{quote(source)} do", force: true
      @in_group = true
      instance_eval(&block)
      @in_group = false
      append_file "Gemfile", "\nend\n", 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
after_bundle(&block) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 259
def after_bundle(&block)
  @after_bundle_callbacks << block
end

Регистрирует обратный вызов, который выполняется после выполнения bundle и spring binstubs.

after_bundle do
  git add: '.'
end
application(data = nil, options = {})
Псевдоним для: environment
capify!() Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 229
def capify!
  log :capify, ""
  in_root { run("#{extify(:capify)} .", verbose: false) }
end

Просто выполните команду capify в корневой директории

capify!
environment(data = nil, options = {}) { || ... } Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 99
def environment(data = nil, options = {})
  sentinel = /class [a-z_:]+ < Rails::Application/i
  env_file_sentinel = /Rails\.application\.configure do/
  data = yield if !data && block_given?

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

Добавляет строку в класс Application для config/application.rb.

Если указан параметр options :env, строка добавляется в соответствующий файл в config/environments.

environment do
  "config.action_controller.asset_host = 'cdn.provider.com'"
end

environment(nil, env: "development") do
  "config.action_controller.asset_host = 'localhost:3000'"
end
Также является псевдонимом для: application
gem(*args) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 15
def gem(*args)
  options = args.extract_options!
  name, version = 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 version ||= options.delete(:version)
    parts   << quote(version)
    message << " (#{version})"
  end
  message = options[:git] if options[:git]

  log :gemfile, message

  options.each do |option, value|
    parts << "#{option}: #{quote(value)}"
  end

  in_root do
    str = "gem #{parts.join(", ")}"
    str = "  " + str if @in_group
    str = "\n" + str
    append_file "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: "git://github.com/rails/rails"
gem_group(*names, &block) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 47
def gem_group(*names, &block)
  name = names.map(&:inspect).join(", ")
  log :gemfile, "group #{name}"

  in_root do
    append_file "Gemfile", "\ngroup #{name} do", force: true

    @in_group = true
    instance_eval(&block)
    @in_group = false

    append_file "Gemfile", "\nend\n", force: true
  end
end

Оборачивает записи gem в группу.

gem_group :development, :test do
  gem "rspec-rails"
end
generate(what, *args) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 201
def generate(what, *args)
  log :generate, what
  argument = args.flat_map(&:to_s).join(" ")

  in_root { run_ruby_script("bin/rails generate #{what} #{argument}", verbose: false) }
end

Генерирует что-то с помощью генератора из Rails или плагина. Второй параметр — строка аргументов, передаваемая генератору, или массив, элементы которого объединяются.

generate(:authenticated, "user session")
git(commands = {}) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 121
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"
initializer(filename, data = nil, &block) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 191
def initializer(filename, data = nil, &block)
  log :initializer, filename
  create_file("config/initializers/#{filename}", data, verbose: false, &block)
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'")
lib(filename, data = nil, &block) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 153
def lib(filename, data = nil, &block)
  log :lib, filename
  create_file("lib/#{filename}", data, verbose: false, &block)
end

Создаёт новый файл в каталоге lib. Код может быть задан в блоке или в виде строки данных.

lib("crypto.rb") do
  "crypted_special_value = '#{rand}--#{Time.now}--#{rand(1337)}--'"
end

lib("foreign.rb", "# Foreign code is fun")
rails_command(command, options = {}) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 222
def rails_command(command, options = {})
  execute_command :rails, command, options
end

Выполняет указанную задачу rake (вызывается с помощью 'rails …')

rails("db:migrate")
rails("db:migrate", env: "production")
rails("gems:install", sudo: true)
rake(command, options = {}) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 213
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)
rakefile(filename, data = nil, &block) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 173
def rakefile(filename, data = nil, &block)
  log :rakefile, filename
  create_file("lib/tasks/#{filename}", data, verbose: false, &block)
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"')
readme(path) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 249
def readme(path)
  log File.read(find_in_source_paths(path))
end

Читает указанный файл в корневом каталоге и выводит его в консоль.

readme "README"
route(routing_code) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 237
def route(routing_code)
  log :route, routing_code
  sentinel = /\.routes\.draw do\s*\n/m

  in_root do
    inject_into_file "config/routes.rb", "  #{routing_code}\n", after: sentinel, verbose: false, force: false
  end
end

Создаёт запись в файле маршрутизации Rails config/routes.rb

route "root 'welcome#index'"
vendor(filename, data = nil, &block) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 140
def vendor(filename, data = nil, &block)
  log :vendor, filename
  create_file("vendor/#{filename}", data, verbose: false, &block)
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")

Закрытые методы экземпляров

execute_command(executor, command, options = {}) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 279
def execute_command(executor, command, options = {}) # :doc:
  log executor, command
  env  = options[:env] || ENV["RAILS_ENV"] || "development"
  sudo = options[:sudo] && !Gem.win_platform? ? "sudo " : ""
  in_root { run("#{sudo}#{extify(executor)} #{command} RAILS_ENV=#{env}", verbose: false) }
end

Выполняет указанную команду, используя либо «rake …», либо «rails …», в зависимости от предоставленного параметра executor.

extify(name) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 287
def extify(name) # :doc:
  if Gem.win_platform?
    "#{name}.bat"
  else
    name
  end
end

Добавляет расширение к данному имени на основе платформы.

log(*args) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 268
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?

quote(value) Показать исходный код
# File railties/lib/rails/generators/actions.rb, line 297
def quote(value) # :doc:
  return value.inspect unless value.is_a? String

  if value.include?("'")
    value.inspect
  else
    "'#{value}'"
  end
end

Оборачивает строку в одинарные кавычки, если в строке нет кавычек. В противном случае использует двойные кавычки.

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API