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,
ActiveRecord::Generators::MultiDbGenerator,
Erb::Generators::Base,
Erb::Generators::ControllerGenerator,
Erb::Generators::MailerGenerator,
Erb::Generators::ScaffoldGenerator,
AppBase ,
AppGenerator ,
Rails::Generators::ApplicationRecordGenerator,
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 configuration code to a Rails runtime environment.
-
#gem(*args)
Adds a #gem declaration to the
Gemfile
for the specified gem. -
#gem_group(*names, &block)
Wraps gem entries inside a group.
-
#generate(what, *args)
Runs another generator.
-
#git(commands = {})
Runs one or more git commands.
- #github(repo, options = {}, &block)
-
#initializer(filename, data = nil)
Creates an initializer file in
config/initializers/
. -
#lib(filename, data = nil)
Creates a file in
lib/
. -
#rails_command(command, options = {})
Runs the specified Rails command.
-
#rake(command, options = {})
Runs the specified Rake task.
-
#rakefile(filename, data = nil)
Creates a Rake tasks file in
lib/tasks/
. -
#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)
Creates a file in
vendor/
. -
#execute_command(executor, command, options = {})
private
Runs the supplied command using either “rake …” or “rails …” based on the executor parameter provided.
-
#indentation
private
Indent the
Gemfile
to the depth of @indentation. -
#log(*args)
private
Define log for backwards compatibility.
-
#optimize_indentation(value, amount = 0)
(also: #rebase_indentation)
private
Returns optimized string with indentation.
-
#quote(value)
private
Always returns value in double 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
# File 'railties/lib/rails/generators/actions.rb', line 151
def add_source(source, = {}, &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.
# File 'railties/lib/rails/generators/actions.rb', line 221
alias :application :environment
#environment(data = nil, options = {}) Also known as: #application
Adds configuration code to a Rails runtime environment.
By default, adds code inside the ::Rails::Application
class in config/application.rb
so that it applies to all environments.
environment %(config.asset_host = "cdn.provider.com")
Results in:
# config/application.rb
class Application < Rails::Application
config.asset_host = "cdn.provider.com"
# ...
end
If the :env
option is specified, the code will be added to the corresponding file in config/environments
instead.
environment %(config.asset_host = "localhost:3000"), env: "development"
Results in:
# config/environments/development.rb
Rails.application.configure do
config.asset_host = "localhost:3000"
# ...
end
:env
can also be an array. In which case, the code is added to each corresponding file in config/environments
.
The code can also be specified as the return value of the block:
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 206
def environment(data = nil, = {}) sentinel = "class Application < Rails::Application\n" env_file_sentinel = "Rails.application.configure do\n" data ||= yield if block_given? in_root do if [:env].nil? inject_into_file "config/application.rb", optimize_indentation(data, 4), after: sentinel, verbose: false else Array( [: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.
# File 'railties/lib/rails/generators/actions.rb', line 461
def execute_command(executor, command, = {}) # :doc: log executor, command sudo = [:sudo] && !Gem.win_platform? ? "sudo " : "" config = { env: { "RAILS_ENV" => ( [:env] || ENV["RAILS_ENV"] || "development") }, verbose: false, capture: [:capture], abort_on_failure: [:abort_on_failure], } in_root { run("#{sudo}#{Shellwords.escape Gem.ruby} bin/#{executor} #{command}", config) } end
#gem(*args)
Adds a gem
declaration to the Gemfile
for the specified 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"
Note that this method only adds the gem to the Gemfile
; it does not install the gem.
Options
:version
-
The version constraints for the gem, specified as a string or an array of strings:
gem "my_gem", version: "~> 1.1" gem "my_gem", version: [">= 1.1", "< 2.0"]
Alternatively, can be specified as one or more arguments following the gem name:
gem "my_gem", ">= 1.1", "< 2.0"
:comment
-
Outputs a comment above the
gem
declaration in theGemfile
.gem "my_gem", comment: "First line.\nSecond line."
Outputs:
# First line. # Second line. gem "my_gem"
:group
-
The gem group in the
Gemfile
that the gem belongs to. :git
-
The URL of the git repository for the gem.
Any additional options passed to this method will be appended to the gem
declaration in the Gemfile
. For example:
gem "my_gem", comment: "Edge my_gem", git: "https://example.com/my_gem.git", branch: "master"
Outputs:
# 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) = args. name, *versions = args # Set the message to be shown in logs. Uses the git repo if one is given, # otherwise use name (version). parts, = [ quote(name) ], name.dup # Output a comment above the gem declaration. comment = .delete(:comment) if versions = versions.any? ? versions : .delete(:version) _versions = Array(versions) _versions.each do |version| parts << quote(version) end << " (#{_versions.join(", ")})" end = [:git] if [:git] log :gemfile, parts << quote( ) unless .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)
Wraps gem entries inside a group.
gem_group :development, :test do
gem "rspec-rails"
end
# File 'railties/lib/rails/generators/actions.rb', line 111
def gem_group(*names, &block) = names. str = names.map(&:inspect) str << quote( ) unless .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)
Runs another generator.
generate "scaffold", "Post title:string body:text"
generate "scaffold", "Post", "title:string", "body:text"
The first argument is the generator name, and the remaining arguments are joined together and passed to the generator.
# File 'railties/lib/rails/generators/actions.rb', line 332
def generate(what, *args) log :generate, what = args. [:abort_on_failure] = ! [:inline] rails_command "generate #{what} #{args.join(" ")}", end
#git(commands = {})
Runs one or more git commands.
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, | run "git #{cmd} #{}" end end end
#github(repo, options = {}, &block)
[ GitHub ]# File 'railties/lib/rails/generators/actions.rb', line 125
def github(repo, = {}, &block) str = [quote(repo)] str << quote( ) unless .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
# File 'railties/lib/rails/generators/actions.rb', line 494
def indentation # :doc: " " * @indentation end
#initializer(filename, data = nil)
Creates an initializer file in config/initializers/
. The code can be specified as an argument or as the return value of the block.
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)
Creates a file in lib/
. The contents can be specified as an argument or as the return value of the block.
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
#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.
# File 'railties/lib/rails/generators/actions.rb', line 450
def log(*args) # :doc: if args.size == 1 say args.first.to_s unless .quiet? else args << (behavior == :invoke ? :green : :red) say_status(*args) end end
#optimize_indentation(value, amount = 0) (private) Also known as: #rebase_indentation
Returns optimized string with 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) (private)
Always returns value in double quotes.
# 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
#rails_command(command, options = {})
Runs the specified Rails command.
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
Options
:env
-
The Rails environment in which to run the command. Defaults to
ENV["RAILS_ENV"] || "development"
. :abort_on_failure
-
Whether to halt the generator if the command exits with a non-success exit status.
:capture
-
Whether to capture and return the output of the command.
:sudo
-
Whether to run the command using
sudo
.
# File 'railties/lib/rails/generators/actions.rb', line 391
def rails_command(command, = {}) if [:inline] log :rails, command command, *args = Shellwords.split(command) in_root do silence_warnings do ::Rails::Command.invoke(command, args, ** ) end end else execute_command :rails, command, end end
#rake(command, options = {})
Runs the specified Rake task.
rake "db:migrate"
rake "db:migrate", env: "production"
rake "db:migrate", abort_on_failure: true
rake "stats", capture: true
rake "gems:install", sudo: true
Options
:env
-
The Rails environment in which to run the task. Defaults to
ENV["RAILS_ENV"] || "development"
. :abort_on_failure
-
Whether to halt the generator if the task exits with a non-success exit status.
:capture
-
Whether to capture and return the output of the task.
:sudo
-
Whether to run the task using
sudo
.
# File 'railties/lib/rails/generators/actions.rb', line 364
def rake(command, = {}) execute_command :rake, command, end
#rakefile(filename, data = nil)
Creates a Rake tasks file in lib/tasks/
. The code can be specified as an argument or as the return value of the block.
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)
Reads the given file at the source root and prints it in the console.
readme "README"
#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
# 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)
Creates a file in vendor/
. The contents can be specified as an argument or as the return value of the block.
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
#with_indentation(&block) (private)
Manage Gemfile
indentation for a DSL action block
# File 'railties/lib/rails/generators/actions.rb', line 499
def with_indentation(&block) # :doc: @indentation += 1 instance_eval(&block) ensure @indentation -= 1 end