rake.rb

Path: lib/rake.rb
Last Update: Sat Mar 10 18:28:42 -0700 2007

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.

Required files

rbconfig   ftools   getoptlong   fileutils   singleton   thread   ostruct   rake/classic_namespace  

Methods

desc   directory   file   file_create   import   multitask   namespace   rake_dup   rule   task  

Included Modules

RakeFileUtils

Constants

RAKEVERSION = '0.7.1'  

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.
FileList = Rake::FileList   Alias FileList to be available at the top level.

Public Instance methods

Describe the next rake task.

Example:

  desc "Run the Unit Tests"
  task :test => [:build]
    runtests
  end

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

Example:

  directory "testdata/doc"

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

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

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"

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]

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.

Duplicate an object if it can be duplicated. If it can not be cloned or duplicated, then just return the original object.

Declare a rule for auto-tasks.

Example:

 rule '.o' => '.c' do |t|
   sh %{cc -o #{t.name} #{t.source}}
 end

Declare a basic task.

Example:

  task :clobber => [:clean] do
    rm_rf "html"
  end

[Validate]