File
rake.rb
Path: lib/rake.rb
Modified: 2009-06-29 09:39:06 +0000

Required files

rbconfig fileutils singleton monitor optparse ostruct rake/win32 rake/classic_namespace
Methods

desc, directory, file, file_create, import, multitask, namespace, rule, task,
Included modules

RakeFileUtils
Public Instance methods
desc(description)

Describe the next rake task.

Example:

  desc "Run the Unit Tests"
  task :test => [:build]
    runtests
  end
     # File lib/rake.rb, line 912
912: def desc(description)
913:   Rake.application.last_description = description
914: end
directory(dir)

Declare a set of files tasks to create the given directories on demand.

Example:

  directory "testdata/doc"
     # File lib/rake.rb, line 859
859: def directory(dir)
860:   Rake.each_dir_parent(dir) do |d|
861:     file_create d do |t|
862:       mkdir_p t.name if ! File.exist?(t.name)
863:     end
864:   end
865: end
file(*args, &block)

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
     # File lib/rake.rb, line 844
844: def file(*args, &block)
845:   Rake::FileTask.define_task(*args, &block)
846: end
file_create(args, &block)

Declare a file creation task. (Mainly used for the directory command).

     # File lib/rake.rb, line 850
850: def file_create(args, &block)
851:   Rake::FileCreationTask.define_task(args, &block)
852: end
import(*fns)

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"
     # File lib/rake.rb, line 929
929: def import(*fns)
930:   fns.each do |fn|
931:     Rake.application.add_import(fn)
932:   end
933: end
multitask(args, &block)

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]
     # File lib/rake.rb, line 874
874: def multitask(args, &block)
875:   Rake::MultiTask.define_task(args, &block)
876: end
namespace(name=nil, &block)

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.
     # File lib/rake.rb, line 889
889: def namespace(name=nil, &block)
890:   Rake.application.in_namespace(name, &block)
891: end
rule(*args, &block)

Declare a rule for auto-tasks.

Example:

 rule '.o' => '.c' do |t|
   sh %{cc -o #{t.name} #{t.source}}
 end
     # File lib/rake.rb, line 900
900: def rule(*args, &block)
901:   Rake::Task.create_rule(*args, &block)
902: end
task(*args, &block)

Declare a basic task.

Example:

  task :clobber => [:clean] do
    rm_rf "html"
  end
     # File lib/rake.rb, line 826
826: def task(*args, &block)
827:   Rake::Task.define_task(*args, &block)
828: end