module Rails::Generators::Actions
Public Instance Methods
# File railties/lib/rails/generators/actions.rb, line 67 def add_source(source, options={}) log :source, source in_root do prepend_file "Gemfile", "source #{quote(source)}\n", verbose: false end end
Add the given source to Gemfile
add_source "http://gems.github.com/"
# File railties/lib/rails/generators/actions.rb, line 241 def after_bundle(&block) @after_bundle_callbacks << block end
Registers a callback to be executed after bundle and spring binstubs have run.
after_bundle do git add: '.' end
# File railties/lib/rails/generators/actions.rb, line 211 def capify! log :capify, "" in_root { run("#{extify(:capify)} .", verbose: false) } end
Just run the capify command in root
capify!
# File railties/lib/rails/generators/actions.rb, line 87 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
Adds a line inside the 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.action_controller.asset_host = 'cdn.provider.com'" end environment(nil, env: "development") do "config.action_controller.asset_host = 'localhost:3000'" end
# File railties/lib/rails/generators/actions.rb, line 17 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 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
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: "git://github.com/rails/rails"
# File railties/lib/rails/generators/actions.rb, line 49 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
Wraps gem entries inside a group.
gem_group :development, :test do gem "rspec-rails" end
# File railties/lib/rails/generators/actions.rb, line 189 def generate(what, *args) log :generate, what argument = args.flat_map {|arg| arg.to_s }.join(" ") in_root { run_ruby_script("bin/rails generate #{what} #{argument}", verbose: false) } end
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")
# File railties/lib/rails/generators/actions.rb, line 109 def git(commands={}) if commands.is_a?(Symbol) run "git #{commands}" else commands.each do |cmd, options| run "git #{cmd} #{options}" end end end
Run a command in git.
git :init git add: "this.file that.rb" git add: "onefile.rb", rm: "badfile.cxx"
# File railties/lib/rails/generators/actions.rb, line 179 def initializer(filename, data=nil, &block) log :initializer, filename create_file("config/initializers/#{filename}", data, verbose: false, &block) end
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'")
# File railties/lib/rails/generators/actions.rb, line 141 def lib(filename, data=nil, &block) log :lib, filename create_file("lib/#{filename}", data, verbose: false, &block) end
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")
# File railties/lib/rails/generators/actions.rb, line 201 def rake(command, options={}) log :rake, command env = options[:env] || ENV["RAILS_ENV"] || 'development' sudo = options[:sudo] && RbConfig::CONFIG['host_os'] !~ /mswin|mingw/ ? 'sudo ' : '' in_root { run("#{sudo}#{extify(:rake)} #{command} RAILS_ENV=#{env}", verbose: false) } end
Runs the supplied rake task
rake("db:migrate") rake("db:migrate", env: "production") rake("gems:install", sudo: true)
# File railties/lib/rails/generators/actions.rb, line 161 def rakefile(filename, data=nil, &block) log :rakefile, filename create_file("lib/tasks/#{filename}", data, verbose: false, &block) end
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"')
# File railties/lib/rails/generators/actions.rb, line 231 def readme(path) log File.read(find_in_source_paths(path)) end
Reads the given file at the source root and prints it in the console.
readme "README"
# File railties/lib/rails/generators/actions.rb, line 219 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: true } end end
Make an entry in Rails routing file config/routes.rb
route "root 'welcome#index'"
# File railties/lib/rails/generators/actions.rb, line 128 def vendor(filename, data=nil, &block) log :vendor, filename create_file("vendor/#{filename}", data, verbose: false, &block) end
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")
Protected Instance Methods
# File railties/lib/rails/generators/actions.rb, line 260 def extify(name) if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ "#{name}.bat" else name end end
Add an extension to the given name based on the platform.
# File railties/lib/rails/generators/actions.rb, line 250 def log(*args) if args.size == 1 say args.first.to_s unless options.quiet? else args << (self.behavior == :invoke ? :green : :red) say_status(*args) end end
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 270 def quote(value) return value.inspect unless value.is_a? String if value.include?("'") value.inspect else "'#{value}'" end end
Surround string with single quotes if there is no quotes. Otherwise fall back to double quotes
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.