File: rake.rb

# rake.rb

Path: | lib/rake.rb
Last Update: | Sun Mar 01 21:08:19 -0700 2009

### Required files

rbconfig fileutils singleton monitor optparse ostruct rake/win32 rake/classic_namespace

### Methods

desc directory file file_create import multitask namespace rule task

### Included Modules

RakeFileUtils

### Constants

RAKEVERSION | = | '0.8.3' |  |
     Copyright (c) 2003, 2004, 2005, 2006, 2007  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

desc(description)

Describe the next rake task.

Example:

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

[Source]

         # File lib/rake.rb, line 914
    914: def desc(description)
    915:   Rake.application.last_description = description
    916: end

directory(dir)

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

Example:

      directory "testdata/doc"

[Source]

         # File lib/rake.rb, line 861
    861: def directory(dir)
    862:   Rake.each_dir_parent(dir) do |d|
    863:     file_create d do |t|
    864:       mkdir_p t.name if ! File.exist?(t.name)
    865:     end
    866:   end
    867: 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

[Source]

         # File lib/rake.rb, line 846
    846: def file(*args, &block)
    847:   Rake::FileTask.define_task(*args, &block)
    848: end

file_create(args, &block)

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

[Source]

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

[Source]

         # File lib/rake.rb, line 931
    931: def import(*fns)
    932:   fns.each do |fn|
    933:     Rake.application.add_import(fn)
    934:   end
    935: 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]

[Source]

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

[Source]

         # File lib/rake.rb, line 891
    891: def namespace(name=nil, &block)
    892:   Rake.application.in_namespace(name, &block)
    893: end

rule(*args, &block)

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 902
    902: def rule(*args, &block)
    903:   Rake::Task.create_rule(*args, &block)
    904: end

task(*args, &block)

Declare a basic task.

Example:

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

[Source]

         # File lib/rake.rb, line 828
    828: def task(*args, &block)
    829:   Rake::Task.define_task(*args, &block)
    830: end

[Validate]