YappoLogs

Module::Setup - pmsetupをモジュール化した

Perlのモジュールをまず最初に作る時はpmsetupやModule::Starterなどを使うのが一般的です。
かく言う余もpmsetupでガリガリ書いてたんですが、はこべさんやらdannさんやらの最近の記事を見て思う所もあってpmsetupをモジュール化してみました。
http://svn.coderepos.org/share/lang/perl/Module-Setup/trunk/

使い方は簡単！cpan Module::Setupでinstallして(まだCPANにあげてないよ！)

 $ module-setup Foo:Bar

を実行するだけ！
ほぼpmsetupと同等の挙動でひな形を作ってくれます。あらべんり！

これだけじゃまったく意味が無いのでModule::Setupらしい所を。。。

flavor

Module::Setup には flavor という概念があり(Module::Startっぽい)module-setupコマンドを叩く時にflavorを切り替える事で、様々なモジュールのひな形を利用出来ます。
現在はDefaultとCodeReposのflavorがあり

 $ module-setup --init --flavor-class=CodeRepos coderepos
 $ module-setup CodeRepos::Module coderepos

という操作で、codereposのflavorを作って、そのflavorをひな形にしたモジュールを作成出来ます。

flavorの編集

flavorは~/.module-setup/flavorの中にflavor別のディレクトリに入っています。
codereposなら ~/.module-setup/flavor/coderepos/template の中身がひな形として使われています。
flavorを使ってひな形を作る時には、このtemplateディレクトリの構成そのまま使われますので、自分の趣味に合うように編集したり必要なファイルとかを追加すると良いでしょう。

このflavor用の設定ファイルは ~/.module-setup/flavor/coderepos/config.yaml にあります。pluginsディレクトリがありますが、この中に適当なファイル名でModule::Setup::Pluginを継承したモジュールを書いてconfig.yamlのpluginsにmodule nameを追加しておくと、このflavorのひな形を作るときにプラグインが読み込まれます。
今の所template処理や新規作成するモジュールの情報を変更するフェーズにフック出来るけど、細かいのはModule::Setup:Plugim::*などのソースを読んで下さい。

subversion用のディレクトリやひな形作成後のperl Makefile.PL make make test などは全部Pluginで行っています。
ちなみに =/.module-setup/plugins には、全flavorでloadされる独自pluginを置いておけます。

flavor を packする

flavorを自分好みに編集したらsvnで管理するにしろtar.gzにするにしろ自由ですが--packオプションでflavorの中身全てを一つのpmファイルにしてくれます。

 $ module-setup --pack MyCodeRepos coderepos > MyCodeRepos.pm

これで作られたファイルを配布するなり好きにすれば良いでしょう。
flavorにするには

 $ module-setup --init --flavor-class=+MyCodeRepos myrepos

とかで出来ます。

packされたflavorを直接使ってひな形つくる

いま作った MyCodeRepos.pm を module-setup --init しないでも直接使う事が出来ます。

 $ module-setup --direct --flavor-class=+MyCodeRepos myrepos

~/.module-setup の変わりに File::Temp で作ったテンポラリディレクトリの中に flavor を展開しているだけです。

おわりに

--pack やら --direct を上手く活用すると catalyst.pl でやってくれるようなヘルパーアプリを作れます。
Module::Setup->run の $options と $argv に適切な値を渡せば、他のモジュールから叩けるはず。
例えばflavor template の lib/____var-module_path-var____.pm の ____var-module_path-var____ は 実際の module　の path に書き換えられるので、フレームワークのモジュール追加のヘルパーアプリとかに応用できる。

既存の物とは違ってひな形の元ファイルを、普通のファイル操作で編集出来るって所が便利なんじゃないのかなぁと思ってる所。(Module::Starter::Plugin::CGIApp も似たアプローチだけどキモイというか、Module::Sterter::PBP的だ)
ひとしきり固まれば pack して、自作アプリに組み込んだりも出来るから便利そうだなぁと。

以前からpmsetupをモジュール化するという話は出ていたのですが、「そこまでやるならModule::Sterter使うだろJK」やら「一枚岩のスクリプトで気が変わったらスクリプトを書き換えればひな形が変えられるのがpmsetupの良い所！」という感じで誰も手を付けませんでした。
もちろん僕もそう思っていたのですが、若干必要に迫られた感もあってModuler::Sterterに手を出してみようと思ったら、すこぶるめんどくさくなったのでModule::Setupを作ったのでした。

たぶん他の人のpmsetupも全部カバーできそうかも？

Posted by Yappo at 2008年10月01日 18:21 | TrackBack | Perl