記事の引越しから漏れていたのでサルベージ。 Generatorプラグインの作り方をメモしておきます。 まずはプラグインの雛形を作ります。 shell-unix-generic>> $ ./script/generate plugin foo <<-- 次にGeneratorプラグインに必要なディレクトリを用意。 shell-unix-generic>> $ mkdir -p vendor/plugins/foo/generators/foo/templates <<-- FooGeneratorクラスの定義ファイルを作成 **vendor/plugins/foo/generators/foo/foo_generator.rb** ruby_on_rails>> class FooGenerator < Rails::Generator::NamedBase def initialize(runtime_args, runtime_options = {}) super ～ 引数・オプションの解釈と初期化 ～ end def manifest record do |m| ～ マニフェスト ～ end end end <<-- マニフェストの書き方は [この辺](http://dev.rubyonrails.org/browser/trunk/railties/lib/rails_generator/generators/components/controller/controller_generator.rb) が参考になります。基底クラスは、Rails::Generator::Baseの派生クラスなら何でもOKです。 続いて、マニフェストから参照するテンプレートファイルをtemplatesディレクトリの中に作ります。テンプレートファイルはERbテンプレートなので、Generatorクラスのコンテクストでrhtmlを書くような感じで記述できます。 以上で完了。Generatorを使うときは以下の通り。 shell-unix-generic>> $ ./script/generate foo <<-- マニフェストの書式を以下にまとめておきます。 **`m.class_collisions( *class_names)`** 生成するクラス名の衝突を検出します。 Generatorで生成する予定のクラス名をすべて列記しておきましょう。 **`m.directory(relative_path)`** RAILS_ROOTからの相対パスで、指定したディレクトリを利用する事を 宣言します。 **`m.template(relative_source, relative_destination, template_options = {})`** Generatorが生成するファイルを宣言します。`relative_source`は、templatesディレクトリからの相対パスでERbテンプレートを指定します。`relative_destination`には生成されるファイルの場所を`RAILS_ROOT`からの相対パスで記述します。 `template_options`には、`:assigns => {:foo => some_thing}` のような感じで、ERbテンプレートから参照可能な値を設定する事ができます。 **`m.readme( *relative_sources)`** helpドキュメントを指定します。指定したファイル群は単純に連続出力されます。 **`m.migration_template(relative_source, relative_destination, template_options = {})`** migrationファイルの生成を宣言します。migrationファイルは、ファイル名の先頭に005_のようなプレフィックスが付くので、専用のメソッドが用意されています。 `relative_destination`は、migrationファイルを配置するディレクトリを、`RAILS_ROOT`からの相対パスで指定します。生成するファイル名は、`template_options[:migration_file_name]` で明示的に指定するか、さもなくばGeneratorの引数から自動的に決定されます。 そのほかの挙動はm.templateと同じです。　 **`m.dependency(generator_name, args, runtime_options = {})`** Generatorの依存関係を宣言します。これによってメタジェネレータを記述する事も可能です。素晴らしいですね。 **`m.file(relative_source, relative_destination, file_options = {}) {|sf| ...}`** ファイルのコピーを宣言します。`relative_source`、`relative_destination` はそれぞれ`RAILS_ROOT`からの相対パスです。 `file_options`には、`:chmod`, `:shebang`, `:collision`を指定します。 詳細な挙動については [こちら](http://edgedocs.planetargon.org/classes/Rails/Generator/Commands/Create.html#M004122) を参照のこと。 ブロック引数は、`relative_source`で指定したファイルが何らかのテンプレートファイルであるときに、テンプレートを展開する処理を記述します。そうでない場合は省略可能です。 より詳細な情報が必要な場合は、 [Rails::Generator::Commands::Createクラスのドキュメント](http://edgedocs.planetargon.org/classes/Rails/Generator/Commands/Create.html) 及び [Createクラスの基底クラスであるRails::Generator::Commands::Baseのドキュメント](http://edgedocs.planetargon.org/classes/Rails/Generator/Commands/Base.html) をご覧ください。 **更新履歴** * 2006/08/10 マニフェストの書き方を最後の方にまとめておきました。 * 2007/11/22 記事の移行からもれていたのでサルベージ