rake.rb

Path: lib/rake.rb
Last Update: Sat Jun 02 18:36:50 CDT 2007

Required files

rbconfig   ftools   getoptlong   fileutils   singleton   thread   ostruct   rake/classic_namespace  

Methods

desc   directory   file   file_create   import   multitask   namespace   rule   task  

Included Modules

RakeFileUtils

Constants

RAKEVERSION = '0.7.3'  
 Copyright (c) 2003, 2004, 2005, 2006 Jim Weirich

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to
 deal in the Software without restriction, including without limitation the
 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 sell copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 IN THE SOFTWARE.
++
 = 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

[Source]

     # File lib/rake.rb, line 663
663: def desc(comment)
664:   Rake.application.last_comment = comment
665: end

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

Example:

  directory "testdata/doc"

[Source]

     # File lib/rake.rb, line 610
610: def directory(dir)
611:   Rake.each_dir_parent(dir) do |d|
612:     file_create d do |t|
613:       mkdir_p t.name if ! File.exist?(t.name)
614:     end
615:   end
616: end

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

[Source]

     # File lib/rake.rb, line 595
595: def file(args, &block)
596:   Rake::FileTask.define_task(args, &block)
597: end

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

[Source]

     # File lib/rake.rb, line 601
601: def file_create(args, &block)
602:   Rake::FileCreationTask.define_task(args, &block)
603: end

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"

[Source]

     # 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

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]

[Source]

     # File lib/rake.rb, line 625
625: def multitask(args, &block)
626:   Rake::MultiTask.define_task(args, &block)
627: end

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.

[Source]

     # File lib/rake.rb, line 640
640: def namespace(name=nil, &block)
641:   Rake.application.in_namespace(name, &block)
642: end

Declare a rule for auto-tasks.

Example:

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

[Source]

     # File lib/rake.rb, line 651
651: def rule(args, &block)
652:   Rake::Task.create_rule(args, &block)
653: end

Declare a basic task.

Example:

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

[Source]

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

[Validate]