Module: Rails::Generators::Actions

Included in:
Base
Defined in:
railties/lib/rails/generators/actions.rb,
railties/lib/rails/generators/actions/create_migration.rb

Defined Under Namespace

Classes: CreateMigration

Instance Method Summary collapse

Instance Method Details

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

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



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'railties/lib/rails/generators/actions.rb', line 92

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

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

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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'railties/lib/rails/generators/actions.rb', line 118

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

#gem(*args) ⇒ Object

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"



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'railties/lib/rails/generators/actions.rb', line 19

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) ⇒ Object

Wraps gem entries inside a group.

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



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'railties/lib/rails/generators/actions.rb', line 52

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) ⇒ Object

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



224
225
226
227
228
229
230
231
 
# File 'railties/lib/rails/generators/actions.rb', line 224

def generate(what, *args)
  log :generate, what

  options = args.extract_options!
  argument = args.flat_map(&:to_s).join(" ")

  execute_command :rails, "generate #{what} #{argument}", options
end

#git(commands = {}) ⇒ Object

Run a command in git.

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



140
141
142
143
144
145
146
147
148
 
# File 'railties/lib/rails/generators/actions.rb', line 140

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) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'railties/lib/rails/generators/actions.rb', line 66

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

#initialize ⇒ Object

:nodoc:



8
9
10
11
 
# File 'railties/lib/rails/generators/actions.rb', line 8

def initialize(*) # :nodoc:
  super
  @indentation = 0
end

#initializer(filename, data = nil) ⇒ Object

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



213
214
215
216
217
 
# File 'railties/lib/rails/generators/actions.rb', line 213

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) ⇒ Object

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



173
174
175
176
177
 
# File 'railties/lib/rails/generators/actions.rb', line 173

def lib(filename, data = nil)
  log :lib, filename
  data ||= yield if block_given?
  create_file("lib/#{filename}", optimize_indentation(data), verbose: false)
end

#rails_command(command, options = {}) ⇒ Object

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)



249
250
251
 
# File 'railties/lib/rails/generators/actions.rb', line 249

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

#rake(command, options = {}) ⇒ Object

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)



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

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

#rakefile(filename, data = nil) ⇒ Object

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



194
195
196
197
198
 
# File 'railties/lib/rails/generators/actions.rb', line 194

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) ⇒ Object

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

readme "README"



273
274
275
 
# File 'railties/lib/rails/generators/actions.rb', line 273

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

#route(routing_code, namespace: nil) ⇒ Object

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

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



257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'railties/lib/rails/generators/actions.rb', line 257

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) ⇒ Object

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



159
160
161
162
163
 
# File 'railties/lib/rails/generators/actions.rb', line 159

def vendor(filename, data = nil)
  log :vendor, filename
  data ||= yield if block_given?
  create_file("vendor/#{filename}", optimize_indentation(data), verbose: false)
end