Class: Rake::Application

Inherits:
Object
  • Object
show all
Includes:
TaskManager
Defined in:
lib/rake/application.rb

Overview

Rake main application object. When invoking rake from the command line, a Rake::Application object is created and run.

Constant Summary collapse

DEFAULT_RAKEFILES =
['rakefile', 'Rakefile', 'rakefile.rb', 'Rakefile.rb'].freeze

Instance Attribute Summary collapse

Attributes included from TaskManager

#last_description

Instance Method Summary collapse

Methods included from TaskManager

#[], #clear, #create_rule, #current_scope, #define_task, #enhance_with_matching_rule, #in_namespace, #intern, #lookup, #resolve_args, #synthesize_file_task, #tasks, #tasks_in_scope

Constructor Details

#initializeApplication

Initialize a Rake::Application object.


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/rake/application.rb', line 34

def initialize
  super
  @name = 'rake'
  @rakefiles = DEFAULT_RAKEFILES.dup
  @rakefile = nil
  @pending_imports = []
  @imported = []
  @loaders = {}
  @default_loader = Rake::DefaultLoader.new
  @original_dir = Dir.pwd
  @top_level_tasks = []
  add_loader('rb', DefaultLoader.new)
  add_loader('rf', DefaultLoader.new)
  add_loader('rake', DefaultLoader.new)
  @tty_output = STDOUT.tty?
  @terminal_columns = ENV['RAKE_COLUMNS'].to_i
end

Instance Attribute Details

#nameObject (readonly)

The name of the application (typically 'rake')


17
18
19
# File 'lib/rake/application.rb', line 17

def name
  @name
end

#original_dirObject (readonly)

The original directory where rake was invoked.


20
21
22
# File 'lib/rake/application.rb', line 20

def original_dir
  @original_dir
end

#rakefileObject (readonly)

Name of the actual rakefile used.


23
24
25
# File 'lib/rake/application.rb', line 23

def rakefile
  @rakefile
end

#terminal_columnsObject

Number of columns on the terminal


26
27
28
# File 'lib/rake/application.rb', line 26

def terminal_columns
  @terminal_columns
end

#top_level_tasksObject (readonly)

List of the top level task names (task names from the command line).


29
30
31
# File 'lib/rake/application.rb', line 29

def top_level_tasks
  @top_level_tasks
end

Instance Method Details

#add_import(fn) ⇒ Object

Add a file to the list of files to be imported.


556
557
558
# File 'lib/rake/application.rb', line 556

def add_import(fn)
  @pending_imports << fn
end

#add_loader(ext, loader) ⇒ Object

Add a loader to handle imported files ending in the extension ext.


101
102
103
104
# File 'lib/rake/application.rb', line 101

def add_loader(ext, loader)
  ext = ".#{ext}" unless ext =~ /^\./
  @loaders[ext] = loader
end

#collect_tasksObject

Collect the list of tasks on the command line. If no tasks are given, return a list containing only the default task. Environmental assignments are processed at this time as well.


543
544
545
546
547
548
549
550
551
552
553
# File 'lib/rake/application.rb', line 543

def collect_tasks
  @top_level_tasks = []
  ARGV.each do |arg|
    if arg =~ /^(\w+)=(.*)$/
      ENV[$1] = $2
    else
      @top_level_tasks << arg unless arg =~ /^-/
    end
  end
  @top_level_tasks.push("default") if @top_level_tasks.size == 0
end

#const_warning(const_name) ⇒ Object

Warn about deprecated use of top level constant names.


575
576
577
578
579
580
581
582
583
584
# File 'lib/rake/application.rb', line 575

def const_warning(const_name)
  @const_warning ||= false
  if ! @const_warning
    $stderr.puts %{WARNING: Deprecated reference to top-level constant '#{const_name}' } +
      %{found at: #{rakefile_location}} # '
    $stderr.puts %{    Use --classic-namespace on rake command}
    $stderr.puts %{    or 'require "rake/classic_namespace"' in Rakefile}
  end
  @const_warning = true
end

#deprecate(old_usage, new_usage, call_site) ⇒ Object

Warn about deprecated usage.

Example:

Rake.application.deprecate("import", "Rake.import", caller.first)

165
166
167
168
169
170
# File 'lib/rake/application.rb', line 165

def deprecate(old_usage, new_usage, call_site)
  return if options.ignore_deprecate
  $stderr.puts "WARNING: '#{old_usage}' is deprecated.  " +
    "Please use '#{new_usage}' instead.\n" +
    "    at #{call_site}"
end

#display_error_message(ex) ⇒ Object

Display the error message that caused the exception.


148
149
150
151
152
153
154
155
156
157
158
# File 'lib/rake/application.rb', line 148

def display_error_message(ex)
  $stderr.puts "#{name} aborted!"
  $stderr.puts ex.message
  if options.trace
    $stderr.puts ex.backtrace.join("\n")
  else
    $stderr.puts rakefile_location(ex.backtrace)
  end
  $stderr.puts "Tasks: #{ex.chain}" if has_chain?(ex)
  $stderr.puts "(See full trace by running task with --trace)" unless options.trace
end

#display_prerequisitesObject

Display the tasks and prerequisites


282
283
284
285
286
287
# File 'lib/rake/application.rb', line 282

def display_prerequisites
  tasks.each do |t|
    puts "#{name} #{t.name}"
    t.prerequisites.each { |pre| puts "    #{pre}" }
  end
end

#display_tasks_and_commentsObject

Display the tasks and comments.


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
# File 'lib/rake/application.rb', line 209

def display_tasks_and_comments
  displayable_tasks = tasks.select { |t|
    t.comment && t.name =~ options.show_task_pattern
  }
  case options.show_tasks
  when :tasks
    width = displayable_tasks.collect { |t| t.name_with_args.length }.max || 10
    max_column = truncate_output? ? terminal_width - name.size - width - 7 : nil

    displayable_tasks.each do |t|
      printf "#{name} %-#{width}s  # %s\n",
        t.name_with_args, max_column ? truncate(t.comment, max_column) : t.comment
    end
  when :describe
    displayable_tasks.each do |t|
      puts "#{name} #{t.name_with_args}"
      t.full_comment.split("\n").each do |line|
        puts "    #{line}"
      end
      puts
    end
  when :lines
    displayable_tasks.each do |t|
      t.locations.each do |loc|
        printf "#{name} %-30s %s\n",t.name_with_args, loc
      end
    end
  else
    fail "Unknown show task mode: '#{options.show_tasks}'"
  end
end

#dynamic_widthObject

Calculate the dynamic width of the


253
254
255
# File 'lib/rake/application.rb', line 253

def dynamic_width
  @dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
end

#dynamic_width_sttyObject


257
258
259
# File 'lib/rake/application.rb', line 257

def dynamic_width_stty
  %x{stty size 2>/dev/null}.split[1].to_i
end

#dynamic_width_tputObject


261
262
263
# File 'lib/rake/application.rb', line 261

def dynamic_width_tput
  %x{tput cols 2>/dev/null}.to_i
end

#find_rakefile_locationObject


466
467
468
469
470
471
472
473
474
475
476
477
478
# File 'lib/rake/application.rb', line 466

def find_rakefile_location
  here = Dir.pwd
  while ! (fn = have_rakefile)
    Dir.chdir("..")
    if Dir.pwd == here || options.nosearch
      return nil
    end
    here = Dir.pwd
  end
  [fn, here]
ensure
  Dir.chdir(Rake.original_dir)
end

#handle_optionsObject

Read and handle the command line options.


422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'lib/rake/application.rb', line 422

def handle_options
  options.rakelib = ['rakelib']

  OptionParser.new do |opts|
    opts.banner = "rake [-f rakefile] {options} targets..."
    opts.separator ""
    opts.separator "Options are ..."

    opts.on_tail("-h", "--help", "-H", "Display this help message.") do
      puts opts
      exit
    end

    standard_rake_options.each { |args| opts.on(*args) }
    opts.environment('RAKEOPT')
  end.parse!

  # If class namespaces are requested, set the global options
  # according to the values in the options structure.
  if options.classic_namespace
    $show_tasks = options.show_tasks
    $show_prereqs = options.show_prereqs
    $trace = options.trace
    $dryrun = options.dryrun
    $silent = options.silent
  end
end

#have_rakefileObject

True if one of the files in RAKEFILES is in the current directory. If a match is found, it is copied into @rakefile.


180
181
182
183
184
185
186
187
188
189
190
# File 'lib/rake/application.rb', line 180

def have_rakefile
  @rakefiles.each do |fn|
    if File.exist?(fn)
      others = Dir.glob(fn, File::FNM_CASEFOLD)
      return others.size == 1 ? others.first : fn
    elsif fn == ''
      return fn
    end
  end
  return nil
end

#init(app_name = 'rake') ⇒ Object

Initialize the command line parameters and app name.


71
72
73
74
75
76
77
# File 'lib/rake/application.rb', line 71

def init(app_name='rake')
  standard_exception_handling do
    @name = app_name
    handle_options
    collect_tasks
  end
end

#invoke_task(task_string) ⇒ Object

private —————————————————————-


113
114
115
116
117
# File 'lib/rake/application.rb', line 113

def invoke_task(task_string)
  name, args = parse_task_string(task_string)
  t = self[name]
  t.invoke(*args)
end

#load_importsObject

Load the pending list of imported files.


561
562
563
564
565
566
567
568
569
570
571
572
# File 'lib/rake/application.rb', line 561

def load_imports
  while fn = @pending_imports.shift
    next if @imported.member?(fn)
    if fn_task = lookup(fn)
      fn_task.invoke
    end
    ext = File.extname(fn)
    loader = @loaders[ext] || @default_loader
    loader.load(fn)
    @imported << fn
  end
end

#load_rakefileObject

Find the rakefile and then load it and any pending imports.


80
81
82
83
84
# File 'lib/rake/application.rb', line 80

def load_rakefile
  standard_exception_handling do
    raw_load_rakefile
  end
end

#optionsObject

Application options from the command line


107
108
109
# File 'lib/rake/application.rb', line 107

def options
  @options ||= OpenStruct.new
end

#parse_task_string(string) ⇒ Object


119
120
121
122
123
124
125
126
127
128
# File 'lib/rake/application.rb', line 119

def parse_task_string(string)
  if string =~ /^([^\[]+)(\[(.*)\])$/
    name = $1
    args = $3.split(/\s*,\s*/)
  else
    name = string
    args = []
  end
  [name, args]
end

480
481
482
483
# File 'lib/rake/application.rb', line 480

def print_rakefile_directory(location)
  $stderr.puts "(in #{Dir.pwd})" unless
    options.silent or original_dir == location
end

#rake_require(file_name, paths = $LOAD_PATH, loaded = $") ⇒ Object

Similar to the regular Ruby require command, but will check for *.rake files in addition to *.rb files.


452
453
454
455
456
457
458
459
460
461
462
463
464
# File 'lib/rake/application.rb', line 452

def rake_require(file_name, paths=$LOAD_PATH, loaded=$")
  fn = file_name + ".rake"
  return false if loaded.include?(fn)
  paths.each do |path|
    full_path = File.join(path, fn)
    if File.exist?(full_path)
      Rake.load_rakefile(full_path)
      loaded << fn
      return true
    end
  end
  fail LoadError, "Can't find #{file_name}"
end

#rakefile_location(backtrace = caller) ⇒ Object


586
587
588
589
590
591
592
593
# File 'lib/rake/application.rb', line 586

def rakefile_location backtrace = caller
  backtrace.map { |t| t[/([^:]+):/,1] }

  re = /^#{@rakefile}$/
  re = /#{re.source}/i if windows?

  backtrace.find { |str| str =~ re } || ''
end

#raw_load_rakefileObject

:nodoc:


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
# File 'lib/rake/application.rb', line 485

def raw_load_rakefile # :nodoc:
  rakefile, location = find_rakefile_location
  if (! options.ignore_system) &&
      (options.load_system || rakefile.nil?) &&
      system_dir && File.directory?(system_dir)
    print_rakefile_directory(location)
    glob("#{system_dir}/*.rake") do |name|
      add_import name
    end
  else
    fail "No Rakefile found (looking for: #{@rakefiles.join(', ')})" if
      rakefile.nil?
    @rakefile = rakefile
    Dir.chdir(location)
    print_rakefile_directory(location)
    $rakefile = @rakefile if options.classic_namespace
    Rake.load_rakefile(File.expand_path(@rakefile)) if @rakefile && @rakefile != ''
    options.rakelib.each do |rlib|
      glob("#{rlib}/*.rake") do |name|
        add_import name
      end
    end
  end
  load_imports
end

#runObject

Run the Rake application. The run method performs the following three steps:

  • Initialize the command line options (init).

  • Define the tasks (load_rakefile).

  • Run the top level tasks (run_tasks).

If you wish to build a custom rake command, you should call init on your application. Then define any tasks. Finally, call top_level to run your top level tasks.


62
63
64
65
66
67
68
# File 'lib/rake/application.rb', line 62

def run
  standard_exception_handling do
    init
    load_rakefile
    top_level
  end
end

#standard_exception_handlingObject

Provide standard exception handling for the given block.


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/rake/application.rb', line 131

def standard_exception_handling
  begin
    yield
  rescue SystemExit => ex    # Exit silently with current status

    raise
  rescue OptionParser::InvalidOption => ex
    $stderr.puts ex.message
    exit(false)
  rescue Exception => ex    # Exit with error message

    display_error_message(ex)
    exit(false)
  end
end

#standard_rake_optionsObject

A list of all the standard options used in rake, suitable for passing to OptionParser.


291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
# File 'lib/rake/application.rb', line 291

def standard_rake_options
  [
    ['--classic-namespace', '-C', "Put Task and FileTask in the top level namespace",
      lambda { |value|
        require 'rake/classic_namespace'
        options.classic_namespace = true
      }
    ],
    ['--describe', '-D [PATTERN]', "Describe the tasks (matching optional PATTERN), then exit.",
      lambda { |value|
        options.show_tasks = :describe
        options.show_task_pattern = Regexp.new(value || '')
        TaskManager. = true
      }
    ],
    ['--dry-run', '-n', "Do a dry run without executing actions.",
      lambda { |value|
        Rake.verbose(true)
        Rake.nowrite(true)
        options.dryrun = true
        options.trace = true
      }
    ],
    ['--execute',  '-e CODE', "Execute some Ruby code and exit.",
      lambda { |value|
        eval(value)
        exit
      }
    ],
    ['--execute-print',  '-p CODE', "Execute some Ruby code, print the result, then exit.",
      lambda { |value|
        puts eval(value)
        exit
      }
    ],
    ['--execute-continue',  '-E CODE',
      "Execute some Ruby code, then continue with normal task processing.",
      lambda { |value| eval(value) }
    ],
    ['--libdir', '-I LIBDIR', "Include LIBDIR in the search path for required modules.",
      lambda { |value| $:.push(value) }
    ],
    ['--no-search', '--nosearch', '-N', "Do not search parent directories for the Rakefile.",
      lambda { |value| options.nosearch = true }
    ],
    ['--prereqs', '-P', "Display the tasks and dependencies, then exit.",
      lambda { |value| options.show_prereqs = true }
    ],
    ['--quiet', '-q', "Do not log messages to standard output.",
      lambda { |value| Rake.verbose(false) }
    ],
    ['--rakefile', '-f [FILE]', "Use FILE as the rakefile.",
      lambda { |value|
        value ||= ''
        @rakefiles.clear
        @rakefiles << value
      }
    ],
    ['--rakelibdir', '--rakelib', '-R RAKELIBDIR',
      "Auto-import any .rake files in RAKELIBDIR. (default is 'rakelib')",
      # HACK Use File::PATH_SEPARATOR
      lambda { |value| options.rakelib = value.split(':') }
    ],
    ['--require', '-r MODULE', "Require MODULE before executing rakefile.",
      lambda { |value|
        begin
          require value
        rescue LoadError => ex
          begin
            rake_require value
          rescue LoadError
            raise ex
          end
        end
      }
    ],
    ['--rules', "Trace the rules resolution.",
      lambda { |value| options.trace_rules = true }
    ],
    ['--silent', '-s', "Like --quiet, but also suppresses the 'in directory' announcement.",
      lambda { |value|
        Rake.verbose(false)
        options.silent = true
      }
    ],
    ['--system',  '-g',
      "Using system wide (global) rakefiles (usually '~/.rake/*.rake').",
      lambda { |value| options.load_system = true }
    ],
    ['--no-system', '--nosystem', '-G',
      "Use standard project Rakefile search paths, ignore system wide rakefiles.",
      lambda { |value| options.ignore_system = true }
    ],
    ['--tasks', '-T [PATTERN]', "Display the tasks (matching optional PATTERN) with descriptions, then exit.",
      lambda { |value|
        options.show_tasks = :tasks
        options.show_task_pattern = Regexp.new(value || '')
        Rake::TaskManager. = true
      }
    ],
    ['--trace', '-t', "Turn on invoke/execute tracing, enable full backtrace.",
      lambda { |value|
        options.trace = true
        Rake.verbose(true)
      }
    ],
    ['--verbose', '-v', "Log message to standard output.",
      lambda { |value| Rake.verbose(true) }
    ],
    ['--version', '-V', "Display the program version.",
      lambda { |value|
        puts "rake, version #{RAKEVERSION}"
        exit
      }
    ],
    ['--where', '-W [PATTERN]', "Describe the tasks (matching optional PATTERN), then exit.",
      lambda { |value|
        options.show_tasks = :lines
        options.show_task_pattern = Regexp.new(value || '')
        Rake::TaskManager. = true
      }
    ],
    ['--no-deprecation-warnings', '-X', "Disable the deprecation warnings.",
      lambda { |value|
        options.ignore_deprecate = true
      }
    ],
  ]
end

#system_dirObject

The directory path containing the system wide rakefiles.


517
518
519
520
521
522
523
524
525
526
# File 'lib/rake/application.rb', line 517

def system_dir
  @system_dir ||=
    begin
      if ENV['RAKE_SYSTEM']
        ENV['RAKE_SYSTEM']
      else
        standard_system_dir
      end
    end
end

#terminal_widthObject


241
242
243
244
245
246
247
248
249
250
# File 'lib/rake/application.rb', line 241

def terminal_width
  if @terminal_columns.nonzero?
    result = @terminal_columns
  else
    result = unix? ? dynamic_width : 80
  end
  (result < 10) ? 80 : result
rescue
  80
end

#top_levelObject

Run the top level tasks of a Rake application.


87
88
89
90
91
92
93
94
95
96
97
# File 'lib/rake/application.rb', line 87

def top_level
  standard_exception_handling do
    if options.show_tasks
      display_tasks_and_comments
    elsif options.show_prereqs
      display_prerequisites
    else
      top_level_tasks.each { |task_name| invoke_task(task_name) }
    end
  end
end

#truncate(string, width) ⇒ Object


273
274
275
276
277
278
279
# File 'lib/rake/application.rb', line 273

def truncate(string, width)
  if string.length <= width
    string
  else
    ( string[0, width-3] || "" ) + "..."
  end
end

#truncate_output?Boolean

We will truncate output if we are outputting to a TTY or if we've been given an explicit column width to honor

Returns:

  • (Boolean)

204
205
206
# File 'lib/rake/application.rb', line 204

def truncate_output?
  tty_output? || @terminal_columns.nonzero?
end

#tty_output=(tty_output_state) ⇒ Object

Override the detected TTY output state (mostly for testing)


198
199
200
# File 'lib/rake/application.rb', line 198

def tty_output=( tty_output_state )
  @tty_output = tty_output_state
end

#tty_output?Boolean

True if we are outputting to TTY, false otherwise

Returns:

  • (Boolean)

193
194
195
# File 'lib/rake/application.rb', line 193

def tty_output?
  @tty_output
end

#unix?Boolean

Returns:

  • (Boolean)

265
266
267
# File 'lib/rake/application.rb', line 265

def unix?
  RbConfig::CONFIG['host_os'] =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
end

#windows?Boolean

Returns:

  • (Boolean)

269
270
271
# File 'lib/rake/application.rb', line 269

def windows?
  Win32.windows?
end