File: rake.rb

# rake.rb

Path: | lib/rake.rb
Last Update: | Fri Sep 01 18:00:54 MDT 2006

# 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

desc(comment)

Describe the next rake task.

Example:

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

directory(dir)

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

Example:

      directory "testdata/doc"

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_create(args, &block)

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

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"

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]

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.

rake_dup()

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

rule(args, &block)

Declare a rule for auto-tasks.

Example:

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

task(args, &block)

Declare a basic task.

Example:

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

[Validate]