Parent

Class/Module Index [+]

Quicksearch

Rails::TemplateRunner

Attributes

logger[W]
root[R]

Public Instance Methods

capify!() click to toggle source

Just run the capify command in root

Example

capify!
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 275
def capify!
  log 'capifying'
  in_root { run('capify .', false) }
end
environment(data = nil, options = {}, &block) click to toggle source

Adds a line inside the Initializer block for config/environment.rb. Used by gem If options :env is specified, the line is appended to the corresponding file in config/environments/#{env}.rb

# File lib/rails_generator/generators/applications/app/template_runner.rb, line 103
def environment(data = nil, options = {}, &block)
  sentinel = 'Rails::Initializer.run do |config|'

  data = block.call if !data && block_given?

  in_root do
    if options[:env].nil?
      gsub_file 'config/environment.rb', /(#{Regexp.escape(sentinel)})/i do |match|
        "#{match}\n  " << data
      end
    else
      Array.wrap(options[:env]).each do|env|
        append_file "config/environments/#{env}.rb", "\n#{data}"
      end
    end
  end
end
file(filename, data = nil, log_action = true, &block) click to toggle source

Create a new file in the Rails project folder. Specify the relative path from RAILS_ROOT. Data is the return value of a block or a data string.

Examples

file("lib/fun_party.rb") do
  hostname = ask("What is the virtual hostname I should use?")
  "vhost.name = #{hostname}"
end

file("config/apach.conf", "your apache config")
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 45
def file(filename, data = nil, log_action = true, &block)
  log 'file', filename if log_action
  dir, file = [File.dirname(filename), File.basename(filename)]

  inside(dir) do
    File.open(file, "w") do |f|
      if block_given?
        f.write(block.call)
      else
        f.write(data)
      end
    end
  end
end
freeze!(args = {}) click to toggle source

Add Rails to /vendor/rails

Example

freeze!
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 286
def freeze!(args = {})
  log 'vendor', 'rails edge'
  in_root { run('rake rails:freeze:edge', false) }
end
gem(name, options = {}) click to toggle source

Adds an entry into config/environment.rb for the supplied gem :

# File lib/rails_generator/generators/applications/app/template_runner.rb, line 86
def gem(name, options = {})
  log 'gem', name
  env = options.delete(:env)

  gems_code = "config.gem '#{name}'"

  if options.any?
    opts = options.inject([]) {|result, h| result << [":#{h[0]} => #{h[1].inspect.gsub('"',"'")}"] }.sort.join(", ")
    gems_code << ", #{opts}"
  end

  environment gems_code, :env => env
end
generate(what, *args) click to toggle source

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.

Example

generate(:authenticated, "user session")
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 228
def generate(what, *args)
  log 'generating', what
  argument = args.map(&:to_s).flatten.join(" ")

  in_root { run_ruby_script("script/generate #{what} #{argument}", false) }
end
git(command = {}) click to toggle source

Run a command in git.

Examples

git :init
git :add => "this.file that.rb"
git :add => "onefile.rb", :rm => "badfile.cxx"
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 129
def git(command = {})
  in_root do
    if command.is_a?(Symbol)
      log 'running', "git #{command}"
      Git.run(command.to_s)
    else
      command.each do |command, options|
        log 'running', "git #{command} #{options}"
        Git.run("#{command} #{options}")
      end
    end
  end
end
initializer(filename, data = nil, &block) click to toggle source

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

Examples

initializer("globals.rb") do
  data = ""

  ['MY_WORK', 'ADMINS', 'BEST_COMPANY_EVAR'].each do
    data << "#{const} = :entp"
  end

  data
end

initializer("api.rb", "API_KEY = '123456'")
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 215
def initializer(filename, data = nil, &block)
  log 'initializer', filename
  file("config/initializers/#{filename}", data, false, &block)
end
lib(filename, data = nil, &block) click to toggle source

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

Examples

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

lib("foreign.rb", "# Foreign code is fun")
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 171
def lib(filename, data = nil, &block)
  log 'lib', filename
  file("lib/#{filename}", data, false, &block)
end
load_template(template) click to toggle source
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 23
def load_template(template)
  begin
    code = open(template).read
    in_root { self.instance_eval(code) }
  rescue LoadError, Errno::ENOENT => e
    raise "The template [#{template}] could not be loaded. Error: #{e}"
  end
end
plugin(name, options) click to toggle source

Install a plugin. You must provide either a Subversion url or Git url. For a Git-hosted plugin, you can specify if it should be added as a submodule instead of cloned.

Examples

plugin 'restful-authentication', :git => 'git://github.com/technoweenie/restful-authentication.git'
plugin 'restful-authentication', :git => 'git://github.com/technoweenie/restful-authentication.git', :submodule => true
plugin 'restful-authentication', :svn => 'svn://svnhub.com/technoweenie/restful-authentication/trunk'
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 69
def plugin(name, options)
  log 'plugin', name

  if options[:git] && options[:submodule]
    in_root do
      Git.run("submodule add #{options[:git]} vendor/plugins/#{name}")
    end
  elsif options[:git] || options[:svn]
    in_root do
      run_ruby_script("script/plugin install #{options[:svn] || options[:git]}", false)
    end
  else
    log "! no git or svn provided for #{name}.  skipping..."
  end
end
rake(command, options = {}) click to toggle source

Runs the supplied rake task

Example

rake("db:migrate")
rake("db:migrate", :env => "production")
rake("gems:install", :sudo => true)
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 262
def rake(command, options = {})
  log 'rake', command
  env = options[:env] || 'development'
  sudo = options[:sudo] ? 'sudo ' : ''
  in_root { run("#{sudo}rake #{command} RAILS_ENV=#{env}", false) }
end
rakefile(filename, data = nil, &block) click to toggle source

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

Examples

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 'im plantin ur seedz'")
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 194
def rakefile(filename, data = nil, &block)
  log 'rakefile', filename
  file("lib/tasks/#{filename}", data, false, &block)
end
route(routing_code) click to toggle source

Make an entry in Rails routing file conifg/routes.rb

Example

route "map.root :controller => :welcome"
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 297
def route(routing_code)
  log 'route', routing_code
  sentinel = 'ActionController::Routing::Routes.draw do |map|'

  in_root do
    gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/i do |match|
      "#{match}\n  #{routing_code}\n"
    end
  end
end
run(command, log_action = true) click to toggle source

Executes a command

Example

inside('vendor') do
  run('ln -s ~/edge rails')
end
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 243
def run(command, log_action = true)
  log 'executing',  "#{command} from #{Dir.pwd}" if log_action
  `#{command}`
end
run_ruby_script(command, log_action = true) click to toggle source

Executes a ruby script (taking into account WIN32 platform quirks)

# File lib/rails_generator/generators/applications/app/template_runner.rb, line 249
def run_ruby_script(command, log_action = true)
  ruby_command = RUBY_PLATFORM=~ /win32/ ? 'ruby ' : ''
  run("#{ruby_command}#{command}", log_action)
end
vendor(filename, data = nil, &block) click to toggle source

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

Examples

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

vendor("foreign.rb", "# Foreign code is fun")
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 155
def vendor(filename, data = nil, &block)
  log 'vendoring', filename
  file("vendor/#{filename}", data, false, &block)
end

Protected Instance Methods

append_file(relative_destination, data) click to toggle source

Append text to a file

Example

append_file 'config/environments/test.rb', 'config.gem "rspec"'
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 374
def append_file(relative_destination, data)
  path = destination_path(relative_destination)
  File.open(path, 'ab') { |file| file.write(data) }
end
ask(string) click to toggle source

Get a user's input

Example

answer = ask("Should I freeze the latest Rails?")
freeze! if ask("Should I freeze the latest Rails?") == "yes"
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 317
def ask(string)
  log '', string
  STDIN.gets.strip
end
destination_path(relative_destination) click to toggle source
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 379
def destination_path(relative_destination)
  File.join(root, relative_destination)
end
gsub_file(relative_destination, regexp, *args, &block) click to toggle source

Run a regular expression replacement on a file

Example

gsub_file 'app/controllers/application_controller.rb', /#\s*(filter_parameter_logging :password)/, '\1'
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 362
def gsub_file(relative_destination, regexp, *args, &block)
  path = destination_path(relative_destination)
  content = File.read(path).gsub(regexp, *args, &block)
  File.open(path, 'wb') { |file| file.write(content) }
end
in_root() click to toggle source
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 331
def in_root
  FileUtils.cd(root) { yield }
end
inside(dir = '', &block) click to toggle source

Do something in the root of the Rails application or a provided subfolder; the full path is yielded to the block you provide. The path is set back to the previous path when the method exits.

# File lib/rails_generator/generators/applications/app/template_runner.rb, line 325
def inside(dir = '', &block)
  folder = File.join(root, dir)
  FileUtils.mkdir_p(folder) unless File.exist?(folder)
  FileUtils.cd(folder) { block.arity == 1 ? yield(folder) : yield }
end
log(action, message = '') click to toggle source
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 383
def log(action, message = '')
  logger.log(action, message)
end
logger() click to toggle source
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 387
def logger
  @logger ||= Rails::Generator::Base.logger
end
no?(question) click to toggle source

Helper to test if the user does NOT say yes(y)?

Example

capify! if no?("Will you be using vlad to deploy your application?")
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 352
def no?(question)
  !yes?(question)
end
yes?(question) click to toggle source

Helper to test if the user says yes(y)?

Example

freeze! if yes?("Should I freeze the latest Rails?")
# File lib/rails_generator/generators/applications/app/template_runner.rb, line 341
def yes?(question)
  answer = ask(question).downcase
  answer == "y" || answer == "yes"
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.