Ruby - Shebang ストリングによるスクリプト実行！

Updated: 2015-04-30 00:20

こんにちは。

Shebang（シバン、シェバン）ストリングを使用して Ruby スクリプトを実行する方法についての記録（＆個人的方針）です。

どの方法を使用するかは個人の趣味・趣向によるところがあります。ご了承ください。

これはよくある方法。

#! /usr/bin/env ruby

これもよくある方法。

#! /usr/local/bin/ruby

メリット
- Linux 等の cron で環境変数 PATH を意識する必要がない。
- top, ps コマンド等でプロセスの実行状況を確認するとプロセス名がスクリプト名になるため、シェルスクリプトによるプロセス管理（二重起動防止等）が容易。（前項や次項の方法では困難）
デメリット
- 環境に合わせて ruby コマンドをフルパスで指定する必要がある。
- Shebang 行では引数が１個しか取得できない。（但し、取得できる引数の個数や文字数は OS により異なる）
  例えば ruby AAA BBB のように記述した場合、AAA と BBB という引数ではなく AAA BBB という引数になってしまうということ。
  （個人的には Shebang 行で ruby コマンドに対するオプションを指定することはないが）

（Ruby リファレンスマニュアルの「Rubyの起動」で紹介されている方法）

#! /bin/sh
exec ruby -S -x $0 "$@"
#! ruby

まず、上記の各種オプションについて。

そして、メリットとデメリット。

メリット
- 環境に依存しにくい。（上記 1 の「env コマンドを使用する方法」よりは。但し、環境に依存することもある）
デメリット
- ３行必要になる。
- Shebang で ruby コマンドにオプションを付加することはできない。（実際にそういう局面はあまりないと感じているが）
- Linux 等で cron 実行する場合に環境変数 PATH を引き継がないため、 cron スクリプト内で PATH を適切に設定する必要がある。
- top, ps コマンド等でプロセスの実行状況を確認するとプロセス名がスクリプト名でなく ruby になってしまうため、シェルスクリプトによるプロセス管理（二重起動防止等）が困難。

当方は以下の理由で、上記 2 の「ruby コマンドをフルパスで指定する方法」に統一している。（プライベートでは）

Linux サーバで cron 実行することが多い。
Linux サーバも Linux クライアント環境も、メインで使用する Ruby をソースビルドで “/usr/local/bin/ruby” にインストールしている。
前項 2 により、クライアント側で作成した Ruby スクリプトが、そのままサーバ側で環境変数 PATH に注意を払わずに cron 実行できる。

また、ブログ等で Ruby スクリプトを公開する際も「ruby コマンドをフルパスで指定する方法」に則って記述したものに（ほぼ）統一している。
「環境に全く依存しない記述方法はないので、利用する側が自分の環境に合わせて適宜対応すべきである」という意味も込めて。

他にも方法（よい方法）があるかもしれません。また気がついたら記事にします。

以上。