Enhancement(機能追加・改善) #557
完了Add ability to manage plugin dependancy (プラグインの依存性を管理できるようにする)
100%
説明
Summary (概要)¶
Add ability to manage plugin dependancy.
プラグインの依存性を管理できるようにする。
Spec (仕様)¶
About dependency-supported plugin (依存性をサポートしたプラグインについて)¶
OpenPNE Plugin uses PEAR-styled dependency.
If you want to know about PEAR-styled dependency, see: http://pear.php.net/manual/en/guide.developers.package2.dependencies.php
Plugin developer can write <dependencies> to package.xml by hand. However, until now, developers have generated package.xml automatically by some convinience-tasks, so writing package.xml will be painful for them.
So, OpenPNE provides generating <dependencies> in package.xml too.
OpenPNE プラグインは PEAR スタイルの依存性をサポートする。
PEAR パッケージの依存性については http://pear.php.net/manual/ja/guide.developers.package2.dependencies.php にて知ることができる。
プラグイン開発者は package.xml に <dependencies> を手で記述することができる。しかしながら、いままで、開発者は package.xml を有用なタスク群によって自動で生成してきており、 package.xml を記述する行為は苦痛になると思われる。
そこで、 OpenPNE では package.xml に <dependencies> を生成する機能も提供する。
Creating dependency-supported plugin (依存性をサポートしたプラグインの作成方法)¶
OpenPNE 3.5.1 以降で opGenerate:plugin タスクを実行すると、生成したプラグインに dependencies.yml.sample というファイルが作成される。このファイルを dependencies.yml としてコピーして編集することで、 opPlugin:define や opPlugin:generate による package.xml の生成時に <dependencies> の記述が一緒に生成される。
OpenPNE 3.5.1 未満のバージョンで生成したプラグインについては lib/task/skeleton/opPlugin/dependencies.yml.sample からプラグインのルートディレクトリに dependencies.yml としてコピーして使用する。
このファイルの記述方法についてはファイル自体に含まれている説明を参照のこと。
Working for checking dependency (依存性チェックの挙動)¶
プラグインインストールの際にバージョン指定がされなかった場合、依存性を満たすパッケージを探し、依存性を満たすものが見つからなければインストールに失敗する(従来の挙動)。
バージョン指定された場合、ダウンロードしたパッケージのための依存性を解決できない場合、詳細なエラーメッセージを表示して依存性の解決を促すように変更をおこなった。 symfony のプラグインマネージャでは自動的にパッケージをダウンロードして依存性を解決することはできないため、依存性の解決自体は手動で行う必要がある。
依存性を解決できなかった場合のエラーメッセージは以下のように表示される。
http://26.media.tumblr.com/tumblr_kz23df0UNC1qz6qi7o1_500.png