Tidy your Rakefile

by pluskid, on 2009-10-31, in Develop

Rake 我就不再介绍了，Ruby 的 Make ，许多方面都比 Make 要更好用一些。和 Makefile 不同的是，Rakefile 本身其实就是一段 Ruby 代码，这样的好处有很多，一方面在 Rake 里面就可以很直接地做任何 Ruby 能做的事了，另一方面由于 Ruby 对 DSL 支持良好，所以 Rakefile 通常看起来也并不那么“代码”。

不过，代码始终是代码，Makefile 尚且可以写得很乱，Rakefile 要写乱就更容易了，幸运地是，Rake 提供了一些功能让我们可以来对 Rakefile 做一些组织工作。

其中之一就是 import 功能，把不同功能的 task 写到不同的文件中，例如，像这个样子：

Rakefile
task/
  +-- doc.rake
  +-- compile.rake
  `-- deploy.rake

这样，在 Rakefile 里写上

import("task/doc.rake")

这样的语句导入各个子任务即可，不同的任务写到不同的文件里面就不会一团糟了。而且，import 同 Ruby 自己的 require 不一样，import 并不是立即进行导入的，而是在整个 Rakefile 执行结束之后才全部导入，因此，可以在任意的地方写 import ，而不用担心依赖关系，需要共享的变量之类的只要在主 Rakefile 中定义了即可。

import 是组织不同的功能模块，除此之外，Rake 还允许我们对一些重复性的任务进行抽象，具体来说，就是自定义的 task 。通常情况下，我们使用 Rake 提供的通用 task 和文件 task 来构造我们需要完成的工作，除此之外，Rake 还自带了一些针对特殊任务的 task 类型，例如构建 rdoc 或者运行 test 等。实际上，一种任务就是一个普通的 Ruby 类，我们可以继承 Rake 里的 Task 类并重新定义相关的函数来实现自定义的 task 类型。不过，这样多少有些麻烦，实际上，很多时候我们要定义的任务都可以分解为一些小任务用内置的通用 task 和 file task 来实现的，这个时候可以用 Tasklib 来更方便地定义自定义的任务。

具体地来说，就是写一个类，继承自 Tasklib （虽然实际上只是约定而并不是必须的），然后在这个类的初始化函数里用 task 或者 file 来定义实际完成任务的子 task 即可。用一个实际的例子来说，比如说，我们可以定义一个 ErlcTask ，可以用来把一些 Erlang 文件编译到某个目录下，并在 clean 的时候自动能把编译出来的 .beam 文件清理掉：

require 'rake'
require 'rake/clean'
require 'rake/tasklib'
 
class ErlcTask < Rake::TaskLib
  attr_accessor :name
  attr_accessor :sources
  attr_accessor :dest_dir
  attr_accessor :include_path
  attr_accessor :flags
  attr_accessor :extra_dep
 
  def initialize(name = :erlc)
    # default values
    if name.is_a? Hash
      @name = name.keys.first
      @extra_dep = name.values.first
    else
      @name = name
      @extra_dep = []
    end
    @sources = FileList[]
    @dest_dir = '.'
    @include_path = []
    @flags = "-W +warn_unused_vars +warn_unused_import"
 
    yield self if block_given?
    define
  end
 
 
  def define
    beams = @sources.pathmap(File.join(@dest_dir, '%n.beam'))
 
    include_path = Array(@include_path).map{|incl|"-I"+incl}.join(" ")
 
    directory @dest_dir
    beams.zip(@sources).each do |beam, source|
      file beam => source do
        sh "erlc -pa #{@dest_dir} #{@flags} #{include_path} -o #{@dest_dir} #{source}"
      end
    end
 
    task @name => beams + Array(@extra_dep)
    CLEAN.include(beams)
  end
end

首先定义一些 Task 相关的属性，在初始化函数里设置初值，然后调用 block 来填充实际的值，最后调用 define 函数，define 函数就使用 directory 、file 和 task 分别定义了建立目录、编译和清理的任务。如果了解 Ruby 和 Rake 的基本语法的话，应该很容易看明白了。

接下来把这个文件保存到某个 .rb 里，然后在 Rakefile 里 require 之，就可以这样写了：

ErlcTask.new :compile do |t|
    t.sources = FileList['src/*.erl']
    t.dest_dir = '../ebin'
    t.include_path = '../include'
    t.extra_dep = :library
end