gulpにもmakeにも不満なWebデベロッパーためのRake(コンパイル・パターンマッチ・ファイル監視・通知)

イントロ

21世紀になって登場したフロントエンド向けビルドツールであるgrunt, gulpなどは、最近批判を受けているようだ。

たしかに、コンパイラ毎にプラグインをインストールしたり、毎年のように新しいビルドツールを覚えるのは無駄だ。古き良きmakeで十分という意見も理解できる。

でも、僕はmakeを使う気にもなれない。タブでインデントするのはまだ我慢できる。 しかし、$(JC) $(JCFLAGS) $< -o $@ といった記号を多用したソースは読みやすいとは言えない(可読性は大事だ!)。 また、機能がシンプルすぎて、標準的な使用方法から外れた時にはシェルスクリプトを苦労して書くことになる。

そこで、僕が提案したいのが、Ruby/DSLで記述するビルドツールRakeだ。

Rakeの導入

Rakeはmakeによく似た機能のビルドツールだ。

RakeのビルドスクリプトRakefileは、Rubyソースコードそのものだ。 Rubyオブジェクト指向言語として知られているが、 Rakeを使う上で自分でクラスを定義する必要は普通は無いので安心して欲しい。 むしろ、必要に応じて文字列処理機能やコレクションといったRubyのリッチな機能が使えるので、 makeより可読性が高いコードを簡単に書ける。

また、Ruby on Railsはもっとも普及しているWEBフレームワークの一つだ。 RubyはWEBデベロッパーにとって全く未知ということも無いと思う。 もしあなたがRubyに不案内でも、同僚のだれかはRubyを知っているはずだ。

RakeはRubyの処理系に一緒についてくる。 Unix系OSではRuby/Rakeをインストールするのは本当に簡単だ。

$ sudo apt install ruby2.0 # Ubuntuの場合

$ brew install ruby # OS Xの場合

一方、あなたがWindowsを使っているなら、RubyInstaller for Windowsをダウンロードして実行すればいい。

余談:Rubyは難解か?

Rakeと同じくRubyDSLを書くツールの1つにChefがある。Chefは特にRubyに不慣れなエンジニアからは難しいとの悪評が高かった。でも、Chefの「難しさ」はRuby/DSLのせいだけでなく、そもそも「冪等性」という新しい概念のせいでもある。

ところで、おなじRubyツールでもserverspecには「Rubyだから難しい」という評判はあまり聞かない。 これはserverspecがわかりやすいモデルに基づくツールだからだろう。

そして、Rakeのモデルはmakeと同じシンプルでわかりやすいものなので、 Rubyだから難しいのではないか」という心配をする必要はない。

もちろん、広い世間には必要以上に難しいコードや汚いコードを書いてしまう人がいるわけだけど、 それはRakeが難しいかどうかとは別の問題だ。

ファイルのコンパイル(TypeScript, SCSSなどのコンパイル、JSやCSSの結合など)

以下は、複数のJSファイルを結合して、dist.jsを生成するコードだ。

# Rakefile
# パターンにマッチするファイルのリストを生成
Src = FileList['src/*.js']

# dist.jsの生成にはSrcに含まれるファイルが必要と定義
# do〜endの中で具体的な生成方法を定義
file 'dist.js' => Src do |t|
  # t.sourcesがソースファイルのリストなので、それをスペースで連結したコマンドラインを生成
  sh "browserify -o dist.js #{t.sources.join(' ')}"
end

# デフォルトのタスクはdist.jsの生成と定義
task :default => 'dist.js'

どうだい?Makefileよりずっと親しみやすいだろう?

コマンドライン文字列の中で式展開#{...} を使っているが、 これはRubyが元々提供していた機能だ。 一方、FileListはRakeが独自に提供しているもので、 Ruby標準の配列にファイルパス操作機能が追加されている(class Rake::FileList)。

ここで、rakeコマンドでdist.jsを生成するタスクを実行した後、 もう一度rakeを実行すると今度はタスクは実行されない。 Rakeはmakeと同様、生成物とソースのタイムスタンプを比較し、生成物の方が新しければ、 わざわざ生成しなおしたりはしないんだ。

パターンによるファイルのコンパイル

ruleを使うと、規則的な変換が定義できる。例えば、 * 'src/FOO.scss' を 'dist/FOO.scss' に * 'src/BAR.scss' を 'dist/BAR.scss' に

# Rakefile
SRC = FileList['src/*.scss']

# SRC を規則的に変換
DIST = SRC.pathmap('%{^src,dist}X.css')
# Rubyの標準機能を使ってやることもできる
# DST = SRC.map do |path|
#   path.sub! /^src\//, 'dist/'
#   path.sub! /\.scss/, 'css'
# end

# rule を使うと規則的な変換が定義できる
rule /dist\/.*\.css/ => '%{^dist,src}X.scss' do |t|
  sh "scss #{t.source} #{t}"
end

task :default => DIST

ここでは、Rakeが提供する機能を使って、パスの変換を定義している。 * FileList.pathmapメソッド(書式文字列を渡している) * rule=>の左側の正規表現 * rule=>の右側の書式文字列

しかし、ここであえて注意したいのは、.pathmapメソッドなどは使わなくてもいいということ。 たとえば、コメントに書いたようにRubyの標準機能で用足すこともできるし、 はたまた.pathmapで再現できない変な変換を書くこともできる。

これはmakeでは不可能だったことだ。

不要ファイルの削除

C言語などの開発では、最終成果物(実行ファイル)の他に、オブジェクトファイル等の中間ファイルができる。 こういった中間ファイルを一括に削除するタスクがあると良い。

そのためにRakeで必要なのは、rake/cleanをインポートし、CLEANCLOBBERという特別なリストにファイルを追加するだけだ。

# Rakefile
require 'rake/clean'

Src = FileList["*.c"]
Obj = Src.ext('o')

CLEAN.include(Obj)
CLOBBER.include('hello')

file 'hello' => Obj do |t|
  sh "gcc -o #{t.name} #{t.sources.join(' ')}"
end

rule '.o' => '.c' do |t|
  sh "gcc -c #{t.source}"
end

task :default => 'hello'

# rake clean で *.oが削除される
# rake clobber で hello も削除される

コンパイル以外のタスク(rsyncによるファイルアップロード等)

コマンド実行の形なら、どんな仕事をさせることもできる。

例えば、ファイルアップロードならrsyncを実行させればいい。

# Rakefile
task :rsync do |t|
  sh "rsync -rax dist/ appsvr:/var/www/html/"
end

task :default => :rsync

シンプルだ!

ファイル変更の監視・通知

多くの人は、gruntやgulpを使う理由として、ファイルの変更を監視して自動で再コンパイルする機能を挙げるだろう。 残念ながら、Rakeにはファイル監視や通知の機能は無い。

だがファイル監視にfswatch、デスクトップ通知にnotify-sendといった外部コマンドを使えば、 実現するのは簡単だ。

# Rakefile
task :rsync do |t|
  sh "rsync -rax dist appsvr:/var/www/html/"
end

task :watch do |t|
  sh %w{fswatch -r w/ | xargs -I{} sh -c "rake && notify-send 'rsync success' || notify-send 'rsync failure'"}
end

task :default => :rsync

# 以下のコマンドで監視開始
# $ rake watch

ここでは簡単さを優先してrake再帰的に呼びだす方法を書いた(安易な方法とも言う)。

もちろん、移植性その他を考慮すれば、別のコマンドやライブラリを使う選択もあるだろう。

まとめ

Gruntなどの21世紀のビルドツールにも、1970年代に登場したmakeにも、それぞれ不満な点があった。

一方、2000年代に開発されたRakeは、 makeのようにUnixの威力を活用でき、Rubyによって自在に拡張できる。 まさに、Gruntとmakeの長所を兼ね備えたツール

リンク

基本的なRakeの使い方

FileList などの機能を使い込みたいと思ったら

Rakeのバグを見つけたり、機能追加を提案したくなったら

広告を非表示にする