読者です 読者をやめる 読者になる 読者になる

totofugaのブログ

PerlとかC++のプログラム系の話

Module::Starterから自分用のテンプレートを生成する

perl

Module::Starter

http://search.cpan.org/~xsawyerx/Module-Starter-1.60/lib/Module/Starter.pm

Module::Starterをcpanからインストールするとmodule-starterコマンドが使用できるようになり、

module-starter --modules=Hoge::Fuga --distro=hoge-fuga

とかすると、

hoge-fuga/:
Changes  MANIFEST  Makefile.PL  README  lib  t

hoge-fuga/lib:
Hoge

hoge-fuga/lib/Hoge:
Fuga.pm

hoge-fuga/t:
00.load.t  perlcritic.t  pod-coverage.t  pod.t

のようにモジュール用のテンプレートファイルが作成されます。 便利なのですが、現在のプロジェクトに合わせるのには自分用にいろいろカスタマイズが必要だったので その方法を調べてみました。

module-starterの設定

module-sterterのconfigファイルは ~/.module-starter/confg ファイルで行います。

root@localhost$ cat ~/.module-starter/config 
author: totofuga
email: test@test
plugins: Module::Starter::Simple

author には作成者名 email にはメールアドレスになります。

module-starterコマンド

f:id:totofuga:20130909151147g:plain

module-starterの呼び出すと上記のように Module::Starter::Appのrunが呼び出されます。 Module::Starter::Appのrunはmodule-starterのconfigファイルのplugins項目に書かれているクラスを生成して

の各メソッドを順に呼び出します。

先ほど設定したplugins項目のModule::Starter::Simpleはモジュール呼び出しのベースとなるクラスで、 上の関数がすべて定義されたクラスなのです。

module-starterをテンプレートから読み込むようにする

plugins項目に複数のクラスを書くとそれらを継承したクラスが呼ばれるようになるのを利用して Module::Starter::Simpleを拡張します。

まずはModule::Starter::Plugin::Templateクラスを追加してみます。

http://search.cpan.org/dist/Module-Starter/lib/Module/Starter/Plugin/Template.pm

cpanからModule::Starter::Plugin::Templateを追加してconfigファイルのplugins項目を

plugins: Module::Starter::Simple, Module::Starter::Plugin::Template

のように変更します。 左が継承元、右が継承先になります。

Module::Starter::Plugin::Templateはcreate_distroをオーバーライドして、 pmやtファイルの生成時にrenderを呼び出すように変更するテンプレートメソッドのクラスになっていてそのままでは使用できません。

Module::Starter::Plugin::Templateを使用するためには

  • renderer (出力エンジンを返す)
  • render (出力を行う)
  • templates (使用するテンプレートを返す)

の三つを実装する必要があります。

f:id:totofuga:20130909154721g:plain

templatesを実装するモジュール

Module::Starter::Plugin::DirStoreはtemplatesを実装してありディレクトリからテンプレートを取得するモジュールです。 今回はこれを使用してみます。

http://search.cpan.org/~rjbs/Module-Starter-Plugin-SimpleStore-0.144/lib/Module/Starter/Plugin/DirStore.pm

cpanからインストール後、configファイルのplugins項目に追加して、 さらにtemplate_dir項目を追加することそのディレクトリからテンプレートファイルを読み込むようになります。

plugins: Module::Starter::Simple, Module::Starter::Plugin::Template, Module::Starter::PluginDirStore
template_dir: /root/.module-starter/templates

注意: この時template_dirを~/ではじめるとエラーになるので絶対パスで指定します。

rendererとrenderを実装するモジュール

Module::Starter::Plugin::TT2はTemplateToolKitを使用してrendererとrenderを実装するモジュールです。 今回はこれを使用してみます。

http://search.cpan.org/~rjbs/Module-Starter-Plugin-TT2-0.125/lib/Module/Starter/Plugin/TT2.pm

cpanからインストール後、configファイルのplugins項目に追加します。 さらにそのままだとwarningが出るのでtemplate_parmsもundefで設定しておきます。(template_parmsはTemplate->newに渡す引数でevalされて使用されます。)

plugins: Module::Starter::Simple, Module::Starter::Plugin::Template, Module::Starter::Plugin::DirStore, Module::Starter::Plugin::TT2
template_dir: /root/.module-starter/templates
template_parms: undef

f:id:totofuga:20130909210118g:plain

テンプレートファイルを作成する

作成可能な主なファイルは以下です。

  • MANIFEST(files)
  • Makefile.PL(main_module, main_pm_file)
  • README(build_instructions)
  • Module.pm(module, rtname)
  • .tで終わるテストファイル(modules)

カッコで指定した値はファイル内で使用できる変数です。 ファイルを作成しないと空ファイルとして作成され、 .tで終わるファイルを作成するとt/下のフォルダにそのファイルが作成されます。

今回は Module.pm を定義してみましょう。

~/.module-starter/templates/にModule.pmを作成して以下の内容を書き込みます。

# this is a module.pm
# module: [% module %]
# rtname: [% rtname %]
# author: [% self.author %]
# hoge:   [% self.hoge %]

先ほど書いたようにModule.pmはmoduel, rtnameという変数が使用できます。 その他にself.で始めるとconfigファイルに書かれた値を参照できます。 hogeを参照しているので、configファイルに

author: test_user
hoge: fuga

を追加しておきます。

そして

module-starter --distro=hoge-fuga --module=Hoge::Fuga

を実行するとhoge-fuga/lib/Hoge/Fuga.pmに

# this is a module.pm
# module: Hoge::Fuga
# rtname: hoge-fuga
# author: test_user
# hoge:   fuga

と展開され自分用のテンプレートが作成できるようになります。

参考にさせてもらったサイト