Rake — Ruby Make
This is the main file for the Rake application. Normally it is referenced as a library via a require statement, but it can be distributed independently as an application.
- rbconfig
- ftools
- getoptlong
- fileutils
- singleton
- thread
- ostruct
- rake/classic_namespace
RAKEVERSION | = | '0.7.0' |
Rake — Ruby MakeThis is the main file for the Rake application. Normally it is referenced as a library via a require statement, but it can be distributed independently as an application. |
||
FileList | = | Rake::FileList |
Alias FileList to be available at the top level. |
Describe the next rake task.
Example:
desc "Run the Unit Tests" task :test => [:build] runtests end
[ show source ]
# File lib/rake.rb, line 507 507: def desc(comment) 508: Rake.application.last_comment = comment 509: end
Declare a set of files tasks to create the given directories on demand.
Example:
directory "testdata/doc"
[ show source ]
# File lib/rake.rb, line 454 454: def directory(dir) 455: Rake.each_dir_parent(dir) do |d| 456: file_create d do |t| 457: mkdir_p t.name if ! File.exist?(t.name) 458: end 459: end 460: end
Declare a file task.
Example:
file "config.cfg" => ["config.template"] do open("config.cfg", "w") do |outfile| open("config.template") do |infile| while line = infile.gets outfile.puts line end end end end
[ show source ]
# File lib/rake.rb, line 438 438: def file(args, &block) 439: Rake::FileTask.define_task(args, &block) 440: end
Declare a file creation task. (Mainly used for the directory command).
[ show source ]
# File lib/rake.rb, line 444 444: def file_create(args, &block) 445: Rake::FileCreationTask.define_task(args, &block) 446: end
Import the partial Rakefiles fn. Imported files are loaded after the current file is completely loaded. This allows the import statement to appear anywhere in the importing file, and yet allowing the imported files to depend on objects defined in the importing file.
A common use of the import statement is to include files containing dependency declarations.
See also the —rakelibdir command line option.
Example:
import ".depend", "my_rules"
[ show source ]
# File lib/rake.rb, line 525 525: def import(*fns) 526: fns.each do |fn| 527: Rake.application.add_import(fn) 528: end 529: end
Declare a task that performs its prerequisites in parallel. Multitasks does not guarantee that its prerequisites will execute in any given order (which is obvious when you think about it)
Example:
multitask :deploy => [:deploy_gem, :deploy_rdoc]
[ show source ]
# File lib/rake.rb, line 469 469: def multitask(args, &block) 470: Rake::MultiTask.define_task(args, &block) 471: end
Create a new rake namespace and use it for evaluating the given block. Returns a NameSpace object that can be used to lookup tasks defined in the namespace.
E.g.
ns = namespace "nested" do task :run end task_run = ns[:run] # find :run in the given namespace.
[ show source ]
# File lib/rake.rb, line 484 484: def namespace(name=nil, &block) 485: Rake.application.in_namespace(name, &block) 486: end
Duplicate an object if it can be duplicated. If it can not be cloned or duplicated, then just return the original object.
[ show source ]
# File lib/rake.rb, line 58 58: def rake_dup() self end
Declare a rule for auto-tasks.
Example:
rule '.o' => '.c' do |t| sh %{cc -o #{t.name} #{t.source}} end
[ show source ]
# File lib/rake.rb, line 495 495: def rule(args, &block) 496: Rake::Task.create_rule(args, &block) 497: end
Declare a basic task.
Example:
task :clobber => [:clean] do rm_rf "html" end
[ show source ]
# File lib/rake.rb, line 420 420: def task(args, &block) 421: Rake::Task.define_task(args, &block) 422: end