1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
require 'open-uri'
require 'active_support/deprecation'
module Rails
module Generators
module Actions
# Install a plugin. You must provide either a Subversion url or Git url.
#
# For a Git-hosted plugin, you can specify a branch and
# whether it should be added as a submodule instead of cloned.
#
# For a Subversion-hosted plugin you can specify a revision.
#
# ==== Examples
#
# plugin 'restful-authentication', :git => 'git://github.com/technoweenie/restful-authentication.git'
# plugin 'restful-authentication', :git => 'git://github.com/technoweenie/restful-authentication.git', :branch => 'stable'
# plugin 'restful-authentication', :git => 'git://github.com/technoweenie/restful-authentication.git', :submodule => true
# plugin 'restful-authentication', :svn => 'svn://svnhub.com/technoweenie/restful-authentication/trunk'
# plugin 'restful-authentication', :svn => 'svn://svnhub.com/technoweenie/restful-authentication/trunk', :revision => 1234
#
def plugin(name, options)
log :plugin, name
if options[:git] && options[:submodule]
options[:git] = "-b #{options[:branch]} #{options[:git]}" if options[:branch]
in_root do
run "git submodule add #{options[:git]} vendor/plugins/#{name}", :verbose => false
end
elsif options[:git] || options[:svn]
options[:git] = "-b #{options[:branch]} #{options[:git]}" if options[:branch]
options[:svn] = "-r #{options[:revision]} #{options[:svn]}" if options[:revision]
in_root do
run_ruby_script "script/rails plugin install #{options[:svn] || options[:git]}", :verbose => false
end
else
log "! no git or svn provided for #{name}. Skipping..."
end
end
# Adds an entry into config/environment.rb for the supplied gem. If env
# is specified, add the gem to the given environment.
#
# ==== Example
#
# gem "rspec", :env => :test
# gem "technoweenie-restful-authentication", :lib => "restful-authentication", :source => "http://gems.github.com/"
# gem "rails", "3.0", :git => "git://github.com/rails/rails"
#
def gem(*args)
options = args.extract_options!
name, version = args
# Deal with deprecated options
{ :env => :only, :lib => :require_as }.each do |old, new|
next unless options[old]
options[new] = options.delete(old)
ActiveSupport::Deprecation.warn "#{old.inspect} option in gem is deprecated, use #{new.inspect} instead"
end
# Deal with deprecated source
if source = options.delete(:source)
ActiveSupport::Deprecation.warn ":source option in gem is deprecated, use add_source method instead"
add_source(source)
end
# Set the message to be shown in logs. Uses the git repo if one is given,
# otherwise use name (version).
parts, message = [ name.inspect ], name
if version ||= options.delete(:version)
parts << version
message << " (#{version})"
end
message = options[:git] if options[:git]
log :gemfile, message
options.each do |option, value|
parts << ":#{option} => #{value.inspect}"
end
in_root do
append_file "Gemfile", "gem #{parts.join(", ")}\n", :verbose => false
end
end
# Add the given source to Gemfile
#
# ==== Example
#
# source "http://gems.github.com/"
def add_source(source, options={})
log :source, source
in_root do
prepend_file "Gemfile", "source #{source.inspect}", :verbose => false
end
end
# Adds a line inside the Initializer block for config/environment.rb.
#
# If options :env is specified, the line is appended to the corresponding
# file in config/environments.
#
def environment(data=nil, options={}, &block)
sentinel = /class [a-z_:]+ < Rails::Application/i
data = block.call 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.wrap(options[:env]).each do|env|
append_file "config/environments/#{env}.rb", "\n#{data}", :verbose => false
end
end
end
end
alias :application :environment
# Run a command in git.
#
# ==== Examples
#
# git :init
# git :add => "this.file that.rb"
# git :add => "onefile.rb", :rm => "badfile.cxx"
#
def git(command={})
if command.is_a?(Symbol)
run "git #{command}"
else
command.each do |command, options|
run "git #{command} #{options}"
end
end
end
# 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")
#
def vendor(filename, data=nil, &block)
log :vendor, filename
create_file("vendor/#{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.
#
# ==== Examples
#
# lib("crypto.rb") do
# "crypted_special_value = '#{rand}--#{Time.now}--#{rand(1337)}--'"
# end
#
# lib("foreign.rb", "# Foreign code is fun")
#
def lib(filename, data=nil, &block)
log :lib, filename
create_file("lib/#{filename}", data, :verbose => false, &block)
end
# 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'")
#
def rakefile(filename, data=nil, &block)
log :rakefile, filename
create_file("lib/tasks/#{filename}", data, :verbose => false, &block)
end
# 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'")
#
def initializer(filename, data=nil, &block)
log :initializer, filename
create_file("config/initializers/#{filename}", data, :verbose => false, &block)
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.
#
# ==== Example
#
# generate(:authenticated, "user session")
#
def generate(what, *args)
log :generate, what
argument = args.map {|arg| arg.to_s }.flatten.join(" ")
in_root { run_ruby_script("script/rails generate #{what} #{argument}", :verbose => false) }
end
# Runs the supplied rake task
#
# ==== Example
#
# rake("db:migrate")
# rake("db:migrate", :env => "production")
# rake("gems:install", :sudo => true)
#
def rake(command, options={})
log :rake, command
env = options[:env] || 'development'
sudo = options[:sudo] && RUBY_PLATFORM !~ /mswin|mingw/ ? 'sudo ' : ''
in_root { run("#{sudo}#{extify(:rake)} #{command} RAILS_ENV=#{env}", :verbose => false) }
end
# Just run the capify command in root
#
# ==== Example
#
# capify!
#
def capify!
log :capify, ""
in_root { run("#{extify(:capify)} .", :verbose => false) }
end
# Add Rails to /vendor/rails
#
# ==== Example
#
# freeze!
#
def freeze!(args={})
ActiveSupport::Deprecation.warn "freeze! is deprecated since your rails app now comes bundled with Rails by default, please check your Gemfile"
end
# Make an entry in Rails routing file conifg/routes.rb
#
# === Example
#
# route "root :to => 'welcome'"
#
def route(routing_code)
log :route, routing_code
sentinel = "routes.draw do |map|"
in_root do
inject_into_file 'config/routes.rb', "\n #{routing_code}\n", { :after => sentinel, :verbose => false }
end
end
protected
# Define log for backwards compatibility. If just one argument is sent,
# invoke say, otherwise invoke say_status.
#
def log(*args)
if args.size == 1
say args.first.to_s
else
args << (self.behavior == :invoke ? :green : :red)
say_status *args
end
end
# Add an extension to the given name based on the platform.
#
def extify(name)
if RUBY_PLATFORM =~ /mswin|mingw/
"#{name}.bat"
else
name
end
end
end
end
end
|