Module: Rails::Generators::Actions

Included in:
Base
Defined in:
lib/rails/generators/actions.rb,
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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/rails/generators/actions.rb', line 71

def add_source(source, options={}, &block)
  log :source, source

  in_root do
    if block
      append_file "Gemfile", "\nsource #{quote(source)} do", force: true
      @in_group = true
      instance_eval(&block)
      @in_group = false
      append_file "Gemfile", "\nend\n", force: true
    else
      prepend_file "Gemfile", "source #{quote(source)}\n", verbose: false
    end
  end
end

#after_bundle(&block) ⇒ Object

Registers a callback to be executed after bundle and spring binstubs have run.

after_bundle do
  git add: '.'
end



259
260
261
 
# File 'lib/rails/generators/actions.rb', line 259

def after_bundle(&block)
  @after_bundle_callbacks << block
end

#capify! ⇒ Object

Just run the capify command in root

capify!



229
230
231
232
 
# File 'lib/rails/generators/actions.rb', line 229

def capify!
  log :capify, ""
  in_root { run("#{extify(:capify)} .", verbose: false) }
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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/rails/generators/actions.rb', line 99

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

#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: "git://github.com/rails/rails"



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/rails/generators/actions.rb', line 15

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.dup
  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

#gem_group(*names, &block) ⇒ Object

Wraps gem entries inside a group.

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/rails/generators/actions.rb', line 47

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

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



201
202
203
204
205
206
 
# File 'lib/rails/generators/actions.rb', line 201

def generate(what, *args)
  log :generate, what
  argument = args.flat_map(&:to_s).join(" ")

  in_root { run_ruby_script("bin/rails generate #{what} #{argument}", verbose: false) }
end

#git(commands = {}) ⇒ Object

Run a command in git.

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



121
122
123
124
125
126
127
128
129
 
# File 'lib/rails/generators/actions.rb', line 121

def git(commands={})
  if commands.is_a?(Symbol)
    run "git #{commands}"
  else
    commands.each do |cmd, options|
      run "git #{cmd} #{options}"
    end
  end
end

#initialize ⇒ Object

:nodoc:



4
5
6
7
8
 
# File 'lib/rails/generators/actions.rb', line 4

def initialize(*) # :nodoc:
  super
  @in_group = nil
  @after_bundle_callbacks = []
end

#initializer(filename, data = nil, &block) ⇒ 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'")



191
192
193
194
 
# File 'lib/rails/generators/actions.rb', line 191

def initializer(filename, data=nil, &block)
  log :initializer, filename
  create_file("config/initializers/#{filename}", data, verbose: false, &block)
end

#lib(filename, data = nil, &block) ⇒ 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")



153
154
155
156
 
# File 'lib/rails/generators/actions.rb', line 153

def lib(filename, data=nil, &block)
  log :lib, filename
  create_file("lib/#{filename}", data, verbose: false, &block)
end

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

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

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



222
223
224
 
# File 'lib/rails/generators/actions.rb', line 222

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)



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

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

#rakefile(filename, data = nil, &block) ⇒ 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"')



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

def rakefile(filename, data=nil, &block)
  log :rakefile, filename
  create_file("lib/tasks/#{filename}", data, verbose: false, &block)
end

#readme(path) ⇒ Object

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

readme "README"



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

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

#route(routing_code) ⇒ Object

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

route "root 'welcome#index'"



237
238
239
240
241
242
243
244
 
# File 'lib/rails/generators/actions.rb', line 237

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: false }
  end
end

#vendor(filename, data = nil, &block) ⇒ 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")



140
141
142
143
 
# File 'lib/rails/generators/actions.rb', line 140

def vendor(filename, data=nil, &block)
  log :vendor, filename
  create_file("vendor/#{filename}", data, verbose: false, &block)
end