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

#initialize ⇒ Application

Initialize a Rake::Application object.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/rake/application.rb', line 38

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

#name ⇒ Object (readonly)

The name of the application (typically ‘rake’)



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

def name
  @name
end

#original_dir ⇒ Object (readonly)

The original directory where rake was invoked.



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

def original_dir
  @original_dir
end

#rakefile ⇒ Object (readonly)

Name of the actual rakefile used.



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

def rakefile
  @rakefile
end

#terminal_columns ⇒ Object

Number of columns on the terminal



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

def terminal_columns
  @terminal_columns
end

#top_level_tasks ⇒ Object (readonly)

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



33
34
35
 
# File 'lib/rake/application.rb', line 33

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.



635
636
637
 
# File 'lib/rake/application.rb', line 635

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.



120
121
122
123
 
# File 'lib/rake/application.rb', line 120

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

#collect_tasks ⇒ Object

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.



622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/rake/application.rb', line 622

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

#deprecate(old_usage, new_usage, call_site) ⇒ Object

Warn about deprecated usage.

Example:

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



189
190
191
192
193
194
195
 
# File 'lib/rake/application.rb', line 189

def deprecate(old_usage, new_usage, call_site)
  fail "GONE"
  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.



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/rake/application.rb', line 172

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

#display_prerequisites ⇒ Object

Display the tasks and prerequisites



310
311
312
313
314
315
 
# File 'lib/rake/application.rb', line 310

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

#display_tasks_and_comments ⇒ Object

Display the tasks and comments.



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

def display_tasks_and_comments
  displayable_tasks = tasks.select { |t|
    (options.show_all_tasks || 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}"
      comment = t.full_comment || ""
      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_width ⇒ Object

Calculate the dynamic width of the



279
280
281
 
# File 'lib/rake/application.rb', line 279

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

#dynamic_width_stty ⇒ Object 



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

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

#dynamic_width_tput ⇒ Object 



287
288
289
 
# File 'lib/rake/application.rb', line 287

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

#find_rakefile_location ⇒ Object 



546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/rake/application.rb', line 546

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

Read and handle the command line options.



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/rake/application.rb', line 511

def handle_options
  options.rakelib = ['rakelib']
  options.trace_output = $stderr

  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!
end

#have_rakefile ⇒ Object

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



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/rake/application.rb', line 205

def have_rakefile
  @rakefiles.each do |fn|
    if File.exist?(fn)
      others = Rake.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.



75
76
77
78
79
80
81
 
# File 'lib/rake/application.rb', line 75

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

#invoke_task(task_string) ⇒ Object

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



137
138
139
140
141
 
# File 'lib/rake/application.rb', line 137

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

#load_imports ⇒ Object

Load the pending list of imported files.



640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/rake/application.rb', line 640

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

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



84
85
86
87
88
 
# File 'lib/rake/application.rb', line 84

def load_rakefile
  standard_exception_handling do
    raw_load_rakefile
  end
end

#options ⇒ Object

Application options from the command line



126
127
128
 
# File 'lib/rake/application.rb', line 126

def options
  @options ||= OpenStruct.new
end

#parse_task_string(string) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/rake/application.rb', line 143

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

#print_rakefile_directory(location) ⇒ Object 



560
561
562
563
 
# File 'lib/rake/application.rb', line 560

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.



532
533
534
535
536
537
538
539
540
541
542
543
544
 
# File 'lib/rake/application.rb', line 532

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 



653
654
655
656
657
658
659
660
 
# File 'lib/rake/application.rb', line 653

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

:nodoc:



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/rake/application.rb', line 565

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

#run ⇒ Object

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 (top_level).

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.



66
67
68
69
70
71
72
 
# File 'lib/rake/application.rb', line 66

def run
  standard_exception_handling do
    init
    load_rakefile
    top_level
  end
end

#run_with_threads ⇒ Object

Run the given block with the thread startup and shutdown.



104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/rake/application.rb', line 104

def run_with_threads
  thread_pool.gather_history if options.job_stats == :history

  yield

  thread_pool.join
  if options.job_stats
    stats = thread_pool.statistics
    puts "Maximum active threads: #{stats[:max_active_threads]}"
    puts "Total threads in play:  #{stats[:total_threads_in_play]}"
  end
  ThreadHistoryDisplay.new(thread_pool.history).show if options.job_stats == :history
end

#standard_exception_handling ⇒ Object

Provide standard exception handling for the given block.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/rake/application.rb', line 155

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

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



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
420
421
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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
 
# File 'lib/rake/application.rb', line 331

def standard_rake_options
  sort_options(
    [
      ['--all', '-A', "Show all tasks, even uncommented ones",
        lambda { |value|
          options.show_all_tasks = value
        }
      ],
      ['--backtrace [OUT]', "Enable full backtrace.  OUT can be stderr (default) or stdout.",
        lambda { |value|
          options.backtrace = true
          select_trace_output(options, 'backtrace', value)
        }
      ],
      ['--comments', "Show commented tasks only",
        lambda { |value|
          options.show_all_tasks = !value
        }
      ],
      ['--describe', '-D [PATTERN]', "Describe the tasks (matching optional PATTERN), then exit.",
        lambda { |value|
          select_tasks_to_show(options, :describe, value)
        }
      ],
      ['--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) }
      ],
      ['--jobs',  '-j [NUMBER]',
        "Specifies the maximum number of tasks to execute in parallel. (default:2)",
        lambda { |value| options.thread_pool_size = [(value || 2).to_i,2].max }
      ],
      ['--job-stats [LEVEL]',
        "Display job statistics. LEVEL=history displays a complete job list",
        lambda { |value|
          if value =~ /^history/i
            options.job_stats = :history
          else
            options.job_stats = true
          end
        }
      ],
      ['--libdir', '-I LIBDIR', "Include LIBDIR in the search path for required modules.",
        lambda { |value| $:.push(value) }
      ],
      ['--multitask', '-m', "Treat all tasks as multitasks.",
        lambda { |value| options.always_multitask = true }
      ],
      ['--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')",
        lambda { |value| options.rakelib = value.split(File::PATH_SEPARATOR) }
      ],
      ['--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
        }
      ],
      ['--suppress-backtrace PATTERN', "Suppress backtrace lines matching regexp PATTERN. Ignored if --trace is on.",
        lambda { |value|
          options.suppress_backtrace_pattern = Regexp.new(value)
        }
      ],
      ['--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|
          select_tasks_to_show(options, :tasks, value)
        }
      ],
      ['--trace', '-t [OUT]', "Turn on invoke/execute tracing, enable full backtrace. OUT can be stderr (default) or stdout.",
        lambda { |value|
          options.trace = true
          options.backtrace = true
          select_trace_output(options, 'trace', value)
          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|
          select_tasks_to_show(options, :lines, value)
          options.show_all_tasks = true
        }
      ],
      ['--no-deprecation-warnings', '-X', "Disable the deprecation warnings.",
        lambda { |value|
          options.ignore_deprecate = true
        }
      ],
    ])
end

#system_dir ⇒ Object

The directory path containing the system wide rakefiles.



596
597
598
599
600
601
602
603
604
605
 
# File 'lib/rake/application.rb', line 596

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

#terminal_width ⇒ Object 



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/rake/application.rb', line 267

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

#thread_pool ⇒ Object

Return the thread pool used for multithreaded processing.



131
132
133
 
# File 'lib/rake/application.rb', line 131

def thread_pool             # :nodoc:
  @thread_pool ||= ThreadPool.new(options.thread_pool_size||FIXNUM_MAX)
end

#top_level ⇒ Object

Run the top level tasks of a Rake application.



91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/rake/application.rb', line 91

def top_level
  run_with_threads 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

#trace(*str) ⇒ Object 



317
318
319
320
 
# File 'lib/rake/application.rb', line 317

def trace(*str)
  options.trace_output ||= $stderr
  options.trace_output.puts(*str)
end

#truncate(string, width) ⇒ Object 



299
300
301
302
303
304
305
306
307
 
# File 'lib/rake/application.rb', line 299

def truncate(string, width)
  if string.nil?
    ""
  elsif 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) 


229
230
231
 
# File 'lib/rake/application.rb', line 229

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

#tty_output=(tty_output_state) ⇒ Object

Override the detected TTY output state (mostly for testing)



223
224
225
 
# File 'lib/rake/application.rb', line 223

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) 


218
219
220
 
# File 'lib/rake/application.rb', line 218

def tty_output?
  @tty_output
end

#unix? ⇒ Boolean

Returns:

  • (Boolean) 


291
292
293
 
# File 'lib/rake/application.rb', line 291

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

#windows? ⇒ Boolean

Returns:

  • (Boolean) 


295
296
297
 
# File 'lib/rake/application.rb', line 295

def windows?
  Win32.windows?
end