Rake::DSL

Public Class Methods

environment(&block) click to toggle source

Run the code block in an environment including the Rake DSL commands.

    # File lib/rake/environment.rb, line 35
35:   def DSL.environment(&block)
36:     Rake::Environment.run(&block)
37:   end

include_in_top_scope() click to toggle source

Include the Rake DSL commands in the top level Ruby scope.

     # File lib/rake/dsl_definition.rb, line 140
140:     def self.include_in_top_scope
141:       Object.send(:include, Rake::DSL)
142:     end

Public Instance Methods

desc(description) click to toggle source

Describe the next rake task.

Example:

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

     # File lib/rake/dsl_definition.rb, line 115
115:     def desc(description)
116:       Rake.application.last_description = description
117:     end

directory(dir) click to toggle source

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

Example:

  directory "testdata/doc"

    # File lib/rake/dsl_definition.rb, line 56
56:     def directory(dir)
57:       Rake.each_dir_parent(dir) do |d|
58:         file_create d do |t|
59:           mkdir_p t.name if ! File.exist?(t.name)
60:         end
61:       end
62:     end

file(*args, &block) click to toggle source

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/dsl_definition.rb, line 40
40:     def file(*args, &block)
41:       Rake::FileTask.define_task(*args, &block)
42:     end

file_create(args, &block) click to toggle source

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

    # File lib/rake/dsl_definition.rb, line 46
46:     def file_create(args, &block)
47:       Rake::FileCreationTask.define_task(args, &block)
48:     end

import(*fns) click to toggle source

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/dsl_definition.rb, line 133
133:     def import(*fns)
134:       fns.each do |fn|
135:         Rake.application.add_import(fn)
136:       end
137:     end

multitask(args, &block) click to toggle source

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/dsl_definition.rb, line 72
72:     def multitask(args, &block)
73:       Rake::MultiTask.define_task(args, &block)
74:     end

namespace(name=nil, &block) click to toggle source

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/dsl_definition.rb, line 87
87:     def namespace(name=nil, &block)
88:       name = name.to_s if name.kind_of?(Symbol)
89:       name = name.to_str if name.respond_to?(:to_str)
90:       unless name.kind_of?(String) || name.nil?
91:         raise ArgumentError, "Expected a String or Symbol for a namespace name"
92:       end
93:       Rake.application.in_namespace(name, &block)
94:     end

rule(*args, &block) click to toggle source

Declare a rule for auto-tasks.

Example:

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

     # File lib/rake/dsl_definition.rb, line 103
103:     def rule(*args, &block)
104:       Rake::Task.create_rule(*args, &block)
105:     end

task(*args, &block) click to toggle source

Declare a basic task.

Example:

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

    # File lib/rake/dsl_definition.rb, line 22
22:     def task(*args, &block)
23:       Rake::Task.define_task(*args, &block)
24:     end

Home Classes Methods

In Files

Methods

Included Modules

Files

Class Index

Rake::DSL

Public Class Methods

Public Instance Methods