ダッシュボードからプラグインのインストールが可能に – CandyCane v0.8.5リリース

CandyCaneダウンロード
(ページ下部にZipとtar.gzの圧縮ファイルへのリンクがあります)

RedmineをPHPに移植したタスク管理システム、CandyCaneのバージョンが0.8.5になりました。一部で話題になったにゃーんダウンチャートを生んだプラグイン機構を改良し、プラグインのインストールとアンインストールがダッシュボードから出来るようになりました。またプラグインのひな形を生成するシェルコマンドも同梱され、プラグインの開発をすぐに始める事ができます。

今回は作例としてチケットに「イイね」の機能を付けるLike Itプラグインを作成してみました。CakePHPベースでの開発はやはり効率がよくかなり少ないコードの分量で機能を実装する事ができたと思います。このプラグインのデモ動画はこちらです。

プラグインのカタログはgist上で管理しています。みなさんが作成したプラグインもgithubで公開されていればカタログに追加する事でダッシュボードからの配布が可能になります。ガントチャートのような独立性の高い機能については是非ともプラグインとして実装された事例が出てくればと思います。また僕自身が公開しているプラグインもそうですが、ネタっぽいものでも作ってみると勉強になるのでCakePHPの学習題材としても良いのではと思います。

開発にかかった時間は25時間。また今回から@okonomiさんが送ってくださったプルリクエストも含まれています。

• Bug #207: Supporting plugin architecture. Part3
• Bug #208: Kindly notice mod_rewrite availability.
• Bug #209: list is broken on render if it has more than 3items.
• Bug #211: Plugin generation by console.
• Bug #214: 「トラッカー」画面でワークフロー未設定のエラーメッセージが表示されない
• Enhancement #185: “Like” feature for issue.
• Enhancement #210: Get plugin catalog from remote.

まだバグつぶしや実現できていない構想もありますが、プラグイン機構で自由に機能を追加しやすい土壌が整ってきました。機能だけでなくデザインなどについても自由に組み替えて利用できるようなシステムにしていければよいなと思います。インストールも簡単ですので、お時間のある方はインストールの上でいじってみたり、プラグインを作ってみて貰えれば大変嬉しいです。

最近の反響

CandyCaneのテーマをカスタマイズしたら、すごく使いやすそうな見た目で導入も簡単なBTSができて、OSS使った開発コンサルっていうやりかたもあるな… 開発現場まだほとんど課題管理がアレなのが課題だから

2012年1月2日 11:26 PM via EchofonReplyRetweetFavorite

@tanakahisateru

Hisateru Tanaka

candycane試してみたけどセットアップが簡単で良い。安定版が出たらRedmineから乗り換えたいなー。 http://t.co/QQfckHJy

2012年1月1日 9:40 PM via YoruFukurouReplyRetweetFavorite

@okonomi

オコノミ

CandyCaneを見てる。RedmineのPHP版ですかぁ。安藤さんがゼロから開発し始めたと、さっき知ってビックリ。凄いですなぁ。 http://t.co/CrN15k3W

2011年12月26日 10:07 AM via webReplyRetweetFavorite

@khoshino

星野邦敏

にゃーんダウンチャートが使えます – CandyCane v0.8.4

RedmineをPHPに移植したCandyCaneのv0.8.4をリリースしました。 このリリースによりさまざまなプラグインを開発できるようになりました。完全なプロダクトを作るというのはかなり難しい目標です。そこでプラグインシステムを用意して必要な人が自分の好きな機能を追加できるというのが望ましいと考えていました。CandyCaneのプラグインはCakePHPの流儀で作成する事ができ、これによりプラグインを作ってみる方が増えてくればよいなと思っています。ではプラグインの概要を見てみましょう。

CandyCaneのプラグインの基礎

CandyCaneのプラグインはCakePHPのプラグインです。. CakePHPのMVCをベースにしたコードを書く事でCandyCaneにプラグインとして追加できます。また追加のコードからCandyCaneのモデルやヘルパー、コンポーネントなどを呼び出す事が出来ます。例えばチケットのデータやプロジェクトのデータをモデルから取得できます。作成したページがCandyCaneとやり取りをする為のAPIも用意されています。これらのAPIはプラグインの内部のinit.phpから呼び出します。

画面上部のメニューへのページ追加

アプリケーション全体のレベルのページを追加したい場合は画面左上のメニューにリンクを追加する事になるでしょう。リンクを追加するにはMenuContainerオブジェクトをプラグインの中のinit.phpから使います。

$menuContainer = ClassRegistry::getObject('MenuContainer');
$menuContainer->addTopMenu(
	array(
		'url' => '/cc_nyancat/nyan/index',
		'class' => 'nyan-cat',
		'caption' => 'Nyan Cat',
		'logged' => false,
		'admin' => false
	)
);

プロジェクトタブへのページ追加

CandyCaneの多くのページはプロジェクト以下の要素として動作します。このようなページを作成する場合はページをプロジェクトタブに追加することになります。その場合はMenuContainerクラスを使います。また現在のプロジェクトをURLから推定する為のルーティングの設定が必要です。

$menuContainer->addProjectMenu(
  'nyancat',
  array(
          'plugin' => 'cc_nyancat',
          'controller' => 'cc_nyancat_chart',
          'action' => 'index',
          'class' => '',
          'caption' => 'Nyan Down Chart',
          'params' => 'project_id',
          '_allowed' => true // for bypassing permmission system.
  )
);
// make sure put new route setting which includes project_id
App::import('Core','Router');
Router::connect('/projects/:project_id/nyanchart/:action', array(
  'plugin' => 'cc_nyancat',
  'controller' => 'cc_nyancat_chart'
));

ページ内の特定の場所へのHTML挿入

CandyCaneの既存のページに変更を加えたい場合、テンプレートの構造を元に変更を加えられます。HookContainerクラスのオブジェクトを使って任意のテンプレートをフックできます。テンプレートが分離されているポイントに対しては好きなテンプレートを追加できます。例えばこの場合はNyan Catがissues/relationsテンプレートの後に表示されます。

$hookContainer = ClassRegistry::getObject('HookContainer');
$hookContainer->registerElementHook(
	'issues/relations', // target element name.
	'../../plugins/cc_nyancat/views/elements/nyancat', // additional template you want to inject.
	false // it should be true when you want to inject before the target template.
);

プラグインのインストール

プラグインのインストールには手動の作業が必要ですが、近いうちに自動化する予定です。とはいえ手順はapp/pluginsの下にプラグインを展開するだけです。CandyCaneのプラグインは”cc_”で始まるディレクトリで作成され、CandyCaneは”app/plugins/cc_*”配下のinit.phpを探してプラグインをロードしています。

注)
プラグインのインストールはすでに自動化されました！

実際の例を見るにはcc_nyancat plugin のgithub上のコードを動かしてみてください。みなさんが実際にプラグインを作成して面白い使い方ができるようになることを楽しみしています。

おまけ：各界の反応

PHPすごい / “アジャイル開発のバーンダウンチャートはもう古い？！2012年からは「にゃーんダウンチャート」へ | 世界” http://t.co/KjqtPSlQ

2011年12月15日 2:09 PM via HatenaReplyRetweetFavorite

@kakutani

Kakutani Shintaro

candycane v0.8.3 をリリースしました

Version 0.8.3 ダウンロード

RedmineをPHPに移植したチケット管理システム、CandyCaneのv0.8.3をリリースしました。今回のリリースではphpmatsuriでの成果とバグフィックスを含んでおり、これによりプラグインを用いてCandyCaneを拡張できるようになりました。

サンプルとしてNyan Catを表示するcc_nyancatプラグインを開発しました。このプラグインを導入するデモ動画があります。こちらの動画ではプラグインがサブディレクトリに配置するだけで有効になる様子をご覧になれます。

延べ作業時間は10時間、6のバグ修正と2つの機能追加です。

• Bug #65: チケットの移動時に関連削除処理でエラーがでる
• Bug #67: チケットを移動させると起票者が変わる
• Bug #75: ログインしていないのにニュースが編集できてしまう
• Bug #158: News module was spamed.
• Enhancement #159: Sending email on updating news.
• Bug #178: Users can’t Update issues
• Enhancement #186: Supporting plugin architecture. Part1
• Bug #190: Fix denial of permissions for users with permissions moving issues

イベントの開催などが一段落したので今後は開発に多くの時間を割けるようになりそうです。githubでのプルリクエストや実際に使ってみたなどのご報告も歓迎です。宜しくお願い致します。