Module: Rails::Generators::Actions

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In: `::ActionMailbox::Generators::InstallGenerator`, `::ActionText::Generators::InstallGenerator`, ActiveRecord::Generators::ApplicationRecordGenerator, ActiveRecord::Generators::Base, ActiveRecord::Generators::MigrationGenerator, ActiveRecord::Generators::ModelGenerator, Css::Generators::AssetsGenerator, Css::Generators::ScaffoldGenerator, Erb::Generators::Base, Erb::Generators::ControllerGenerator, Erb::Generators::MailerGenerator, Erb::Generators::ScaffoldGenerator, `AppBase`, `AppGenerator`, Rails::Generators::ApplicationRecordGenerator, Rails::Generators::AssetsGenerator, `Base`, `BenchmarkGenerator`, `ChannelGenerator`, Rails::Generators::ControllerGenerator, Rails::Generators::CredentialsGenerator, Rails::Generators::Db::System::ChangeGenerator, Rails::Generators::EncryptedFileGenerator, Rails::Generators::EncryptionKeyFileGenerator, Rails::Generators::GeneratorGenerator, Rails::Generators::HelperGenerator, Rails::Generators::IntegrationTestGenerator, Rails::Generators::JobGenerator, `MailboxGenerator`, `MailerGenerator`, Rails::Generators::MasterKeyGenerator, Rails::Generators::MigrationGenerator, Rails::Generators::ModelGenerator, `NamedBase`, Rails::Generators::PluginGenerator, Rails::Generators::ResourceGenerator, Rails::Generators::ResourceRouteGenerator, Rails::Generators::ScaffoldControllerGenerator, Rails::Generators::ScaffoldGenerator, Rails::Generators::SystemTestGenerator, Rails::Generators::TaskGenerator, TestUnit::Generators::Base, `::TestUnit::Generators::ChannelGenerator`, TestUnit::Generators::ControllerGenerator, TestUnit::Generators::GeneratorGenerator, TestUnit::Generators::HelperGenerator, `::TestUnit::Generators::InstallGenerator`, TestUnit::Generators::IntegrationGenerator, TestUnit::Generators::JobGenerator, `::TestUnit::Generators::MailboxGenerator`, TestUnit::Generators::MailerGenerator, TestUnit::Generators::ModelGenerator, TestUnit::Generators::PluginGenerator, TestUnit::Generators::ScaffoldGenerator, TestUnit::Generators::SystemGenerator
Defined in:	railties/lib/rails/generators/actions.rb, railties/lib/rails/generators/actions/create_migration.rb

Instance Method Summary

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

Add the given source to Gemfile
#application(data = nil, options = {})

Alias for #environment.
#environment(data = nil, options = {}) (also: #application)

Adds a line inside the ::Rails::Application class for config/application.rb.
#gem(*args)

Adds an entry into Gemfile for the supplied gem.
#gem_group(*names, &block)

Wraps gem entries inside a group.
#generate(what, *args)

Generate something using a generator from ::Rails or a plugin.
#git(commands = {})

Run a command in git.
#github(repo, options = {}, &block)
#initializer(filename, data = nil)

Create a new initializer with the provided code (either in a block or a string).
#lib(filename, data = nil)

Create a new file in the lib/ directory.
#rails_command(command, options = {})

Runs the supplied rake task (invoked with ‘rails …’).
#rake(command, options = {})

Runs the supplied rake task (invoked with ‘rake …’).
#rakefile(filename, data = nil)

Create a new Rakefile with the provided code (either in a block or a string).
#readme(path)

Reads the given file at the source root and prints it in the console.
#route(routing_code, namespace: nil)

Make an entry in ::Rails routing file config/routes.rb.
#vendor(filename, data = nil)

Create a new file in the vendor/ directory.
#execute_command(executor, command, options = {}) private

Runs the supplied command using either “rake …” or “rails …” based on the executor parameter provided.
#extify(name) private

Add an extension to the given name based on the platform.
#indentation private

Indent the Gemfile to the depth of @indentation.
#log(*args) private

Define log for backwards compatibility.
#optimize_indentation(value, amount = 0) private

Returns optimized string with indentation.
#quote(value) private

Surround string with single quotes if there is no quotes.
#with_indentation(&block) private

Manage Gemfile indentation for a DSL action block.

Instance Method Details

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

Add the given source to Gemfile

If block is given, gem entries in block are wrapped into the source group.

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

add_source "http://gems.github.com/" do
  gem "rspec-rails"
end

[ GitHub ]

# 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

#application(data = nil, options = {})

Alias for #environment.

[ GitHub ]

# File 'railties/lib/rails/generators/actions.rb', line 135


alias :application :environment

#environment(data = nil, options = {}) Also known as: #application

Adds a line inside the ::Rails::Application class for config/application.rb.

If options :env is specified, the line is appended to the corresponding file in config/environments.

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

environment(nil, env: "development") do
  "config.asset_host = 'localhost:3000'"
end

[ GitHub ]

# 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

#execute_command(executor, command, options = {}) (private)

Runs the supplied command using either “rake …” or “rails …” based on the executor parameter provided.

[ GitHub ]

# 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

#extify(name) (private)

Add an extension to the given name based on the platform.

[ GitHub ]

# File 'railties/lib/rails/generators/actions.rb', line 318


def extify(name) # :doc:
  if Gem.win_platform?
    "#{name}.bat"
  else
    name
  end
end

#gem(*args)

Adds an entry into Gemfile for the supplied 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"

[ GitHub ]

# 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

#gem_group(*names, &block)

Wraps gem entries inside a group.

gem_group :development, :test do
  gem "rspec-rails"
end

[ GitHub ]

# 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

#generate(what, *args)

Generate something using a generator from ::Rails or a plugin. The second parameter is the argument string that is passed to the generator or an ::Array that is joined.

generate(:authenticated, "user session")

[ GitHub ]

# 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

#git(commands = {})

Run a command in git.

git :init
git add: "this.file that.rb"
git add: "onefile.rb", rm: "badfile.cxx"

[ GitHub ]

# 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

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

[ GitHub ]

# 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

#indentation (private)

Indent the Gemfile to the depth of @indentation

[ GitHub ]

# File 'railties/lib/rails/generators/actions.rb', line 350


def indentation # :doc:
  "  " * @indentation
end

#initializer(filename, data = nil)

Create a new initializer with the provided code (either in a block or a string).

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'")

[ GitHub ]

# 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

#lib(filename, data = nil)

Create a new file in the lib/ directory. Code can be specified in a block or a data string can be given.

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

lib("foreign.rb", "# Foreign code is fun")

[ GitHub ]

# 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

#log(*args) (private)

Define log for backwards compatibility. If just one argument is sent, invoke say, otherwise invoke say_status. Differently from say and similarly to say_status, this method respects the quiet? option given.

[ GitHub ]

# 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

#optimize_indentation(value, amount = 0) (private)

Returns optimized string with indentation

[ GitHub ]

# 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

#quote(value) (private)

Surround string with single quotes if there is no quotes. Otherwise fall back to double quotes

[ GitHub ]

# 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

#rails_command(command, options = {})

Runs the supplied rake task (invoked with ‘rails …’)

rails_command("db:migrate")
rails_command("db:migrate", env: "production")
rails_command("gems:install", sudo: true)
rails_command("gems:install", capture: true)

[ GitHub ]

# 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(command, options = {})

Runs the supplied rake task (invoked with ‘rake …’)

rake("db:migrate")
rake("db:migrate", env: "production")
rake("gems:install", sudo: true)
rake("gems:install", capture: true)

[ GitHub ]

# File 'railties/lib/rails/generators/actions.rb', line 241


def rake(command, options = {})
  execute_command :rake, command, options
end

#rakefile(filename, data = nil)

Create a new Rakefile with the provided code (either in a block or a string).

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"')

[ GitHub ]

# 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

#readme(path)

Reads the given file at the source root and prints it in the console.

readme "README"

[ GitHub ]

# File 'railties/lib/rails/generators/actions.rb', line 285


def readme(path)
  log File.read(find_in_source_paths(path))
end

#route(routing_code, namespace: nil)

Make an entry in ::Rails routing file config/routes.rb

route "root 'welcome#index'"
route "root 'admin#index'", namespace: :admin

[ GitHub ]

# 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

#vendor(filename, data = nil)

Create a new file in the vendor/ directory. Code can be specified in a block or a data string can be given.

vendor("sekrit.rb") do
  sekrit_salt = "#{Time.now}--#{3.years.ago}--#{rand}--"
  "salt = '#{sekrit_salt}'"
end

vendor("foreign.rb", "# Foreign code is fun")

[ GitHub ]

# 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

#with_indentation(&block) (private)

Manage Gemfile indentation for a DSL action block

[ GitHub ]

# File 'railties/lib/rails/generators/actions.rb', line 355


def with_indentation(&block) # :doc:
  @indentation += 1
  instance_eval(&block)
ensure
  @indentation -= 1
end