Thorを使ってタスクを追加する場合、
通常以下のような感じで名前空間付きのタスクが追加されます。

pre>>
"クラス名":"タスク名"
<<--

グローバルな名前空間にタスクを追加したい場合は、

"help" という名前のタスクを追加すれば良いようです。

thor のメリット

thor は rake に比べて、

• タスク定義が Ruby メソッド
• コマンドライン引数が簡単に扱える

というメリットがあり、お気に入りです。
前者はもしかすると
「いやいや task の方が DSL 風で...」
と人によるかもしれませんが、
後者が強力なのは異論がないでしょう。
例えば、Rails の db:create を例にすると、
環境を指定するのに rake では仕方なく RAILS_ENV を使っていますが、
もし thor であれば

ruby>>
class Db < Thor
desc "create ENV", "Create database for specified env"
def create(env = 'development')
...
<<--

のように、引数の処理もデフォルト値の指定も、
ruby コードそのままで非常に直感的です。

complete usage

でも、しばらく使っていると、
上記の desc 部分(usage, descprtion)のうち、
前者の usage がメソッド定義と被っていて少しイライラしてきます。
そこで、get_args を利用して usage を補完するように改良してみました。

http://github.com/maiha/thor/tree/complete-usage

これにより、以下のように記述できます。

ruby>>
class Db < Thor
desc "Create database for specified env"
def create(env = 'development')
...
<<--

ruby>>
% thor list
thor db:create ENV = "development" # Create database for specified env
<<--

もちろん、従来の記法も利用可能です。
ユーザを増やして本家に取り込んでもらうと思うので、
よかったら使ってみてください。
バグ報告も大歓迎です。

インストール

で、こういう野良 github アプリはどうするんですかね？
とりあえず適当に clone して、complete-usage ブランチの lib で、
gems/thor-0.13.4/lib とかを直接差し替えるのが一番早い、
かも？です。
あと、もちろん get_args のインストールも必要になります。

ruby>>
% gem install get_args
<<--

merb-1.0.5以降、merbのthor merb:gem:installの挙動が変わったようです。

pre>>
% thor merb:gem:install
<<--

すると、依存するgemファイル一式をMERB_ROOT/gems/以下にインストールする事が出来ます。
同時に、それらを使うためのコマンド類（merbなど）がMERB_ROOT/bin/以下に作られるので、unpackされたgemを使う場合はそれらのコマンドを使う事になります。

以前は、インストールするgem名を引数に取ったり、--cacheなどのオプションが使えたのですが、1.0.5以降はこれが出来なくなっている模様。

pre>>
% ./bin/merb -i
<<--

これを使う事で、edge merbを手元の環境で簡単に使う事が出来ます。

Zshでthor (トール)のタスクを補完するための補完関数を作ってみました。

sh>>
_thor () {
compadd thor list | awk "{print \\$1}" | grep "\w" | \ ruby -e "puts ARGF.read.gsub /\\e.*?m/,''" | xargs
}

compdef _thor thor
<<--

See Also

• Railsの freeze タスクに相当するものを探したCommentsAdd Star