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.1' |
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 662 662: def desc(comment) 663: Rake.application.last_comment = comment 664: 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 609 609: def directory(dir) 610: Rake.each_dir_parent(dir) do |d| 611: file_create d do |t| 612: mkdir_p t.name if ! File.exist?(t.name) 613: end 614: end 615: 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 593 593: def file(args, &block) 594: Rake::FileTask.define_task(args, &block) 595: end
Declare a file creation task. (Mainly used for the directory command).
[ show source ]
# File lib/rake.rb, line 599 599: def file_create(args, &block) 600: Rake::FileCreationTask.define_task(args, &block) 601: 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 680 680: def import(*fns) 681: fns.each do |fn| 682: Rake.application.add_import(fn) 683: end 684: 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 624 624: def multitask(args, &block) 625: Rake::MultiTask.define_task(args, &block) 626: 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 639 639: def namespace(name=nil, &block) 640: Rake.application.in_namespace(name, &block) 641: 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 650 650: def rule(args, &block) 651: Rake::Task.create_rule(args, &block) 652: end
Declare a basic task.
Example:
task :clobber => [:clean] do rm_rf "html" end
[ show source ]
# File lib/rake.rb, line 575 575: def task(args, &block) 576: Rake::Task.define_task(args, &block) 577: end