File: rake.rb

Included modules

Public Instance methods

Describe the next rake task.

Example:

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

     # File lib/rake.rb, line 662
662: def desc(comment)
663:   Rake.application.last_comment = comment
664: 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 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

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 593
593: def file(args, &block)
594:   Rake::FileTask.define_task(args, &block)
595: end

file_create(args, &block)

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

     # File lib/rake.rb, line 599
599: def file_create(args, &block)
600:   Rake::FileCreationTask.define_task(args, &block)
601: 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 680
680: def import(*fns)
681:   fns.each do |fn|
682:     Rake.application.add_import(fn)
683:   end
684: 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 624
624: def multitask(args, &block)
625:   Rake::MultiTask.define_task(args, &block)
626: 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 639
639: def namespace(name=nil, &block)
640:   Rake.application.in_namespace(name, &block)
641: end

rake_dup()

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

    # File lib/rake.rb, line 58
58:     def rake_dup() self 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 650
650: def rule(args, &block)
651:   Rake::Task.create_rule(args, &block)
652: end

task(args, &block)

Declare a basic task.

Example:

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

     # File lib/rake.rb, line 575
575: def task(args, &block)
576:   Rake::Task.define_task(args, &block)
577: end

Rake — Ruby Make