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
Methods
Included Modules
Constants
RAKEVERSION = '0.7.2.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

[ show source ]

     # File lib/rake.rb, line 674
674: def desc(comment)
675:   Rake.application.last_comment = comment
676: end
directory(dir)

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

Example: 

  directory "testdata/doc"

[ show source ]

     # File lib/rake.rb, line 621
621: def directory(dir)
622:   Rake.each_dir_parent(dir) do |d|
623:     file_create d do |t|
624:       mkdir_p t.name if ! File.exist?(t.name)
625:     end
626:   end
627: 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

[ show source ]

     # File lib/rake.rb, line 605
605: def file(args, &block)
606:   Rake::FileTask.define_task(args, &block)
607: end
file_create(args, &block)

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

[ show source ]

     # File lib/rake.rb, line 611
611: def file_create(args, &block)
612:   Rake::FileCreationTask.define_task(args, &block)
613: 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"

[ show source ]

     # File lib/rake.rb, line 692
692: def import(*fns)
693:   fns.each do |fn|
694:     Rake.application.add_import(fn)
695:   end
696: 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]

[ show source ]

     # File lib/rake.rb, line 636
636: def multitask(args, &block)
637:   Rake::MultiTask.define_task(args, &block)
638: 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.

[ show source ]

     # File lib/rake.rb, line 651
651: def namespace(name=nil, &block)
652:   Rake.application.in_namespace(name, &block)
653: end
rule(args, &block)

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 662
662: def rule(args, &block)
663:   Rake::Task.create_rule(args, &block)
664: end
task(args, &block)

Declare a basic task.

Example: 

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

[ show source ]

     # File lib/rake.rb, line 587
587: def task(args, &block)
588:   Rake::Task.define_task(args, &block)
589: end