ダッシュボードからプラグインのインストールが可能に – 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でのプルリクエストや実際に使ってみたなどのご報告も歓迎です。宜しくお願い致します。

CandyCane v0.8.1 をリリースしました

v0.8.1ダウンロードページ
CakePHPで作られた第3のRedmine、CandyCaneのバージョンをv0.8.1のバージョンを打ちました。

ご存知の方もいると思いますが、github上でウォッチされたPHPのプロジェクトのランキングで4位にCandyCaneが入りました！(※ただし、１日限り)。前回のエントリで一連の流れについて書きましたが、CakeFestでの発表で認知度が高まった事が数字に現れたようです。またCakePHPのコアデベロッパのグラハムが開発に協力してくれているのでかなり開発速度が上がっています。

今回は世界中でインストールしてみた人が増えた事から得られたフィードバックを中心に修正しています。やはりインストーラーでWordPressのようにインストールできる点についてはうまくいっているようです。
また既存のRedmineのスキーマを流用する場合はRedmineのV0.8以降に行われたスキーマ変更に追従していない部分があることが分かっています。この部分のキャッチアップについてはスキーマを更新するMigrateをインストーラーに統合してからの対応になるでしょう。

延べ作業時間は16時間、11のバグ修正と1つの機能追加です。また次回のリリースからはPHP5向けにコードを記述していきます。困る人も殆どいないと思いますが、PHP4向けの修正が継続できるようにブランチだけは作っています。

• Bug #97: チケットの複数編集時に選択内容が保持されない
• Bug #103: チケットの状態を終了にした際に進捗率が100％になっていない
• Bug #114: 最近のプロジェクトにアーカイブされたプロジェクトが表示されている
• Bug #138: 複数のチケットを編集した際に履歴が1つしか作られていない
• Bug #153: 送信元メールアドレスとフッタの設定が機能していない
• Bug #154: 活動のアイテムの並び順が日付の降順になっていない
• Bug #160: 非公開プロジェクトのwikiがメンバー外から見える
• Bug #164: Search hits against wiki of pravate project for unlogged in user.
• Bug #166: (user/edit) don’t load user’s language
• Enhancement #167: (user/edit) Option without password
• Bug #168: Issue priority changes when adding update/comment to issue
• Bug #170: Emain wont be sent on bulk edit of issue.

日本のCakePHP使いが死力を尽くしたCandyCaneにブレイクの兆し

前回のエントリを書いてからまだ一週間も経っていませんが、CakePHP版RedmineのCandyCaneへの反響に驚いています。CakeFestでの発表の後に下記の反応を貰った事は前回触れましたが、その後も色々な反応がありました。
CakePHPのコアメンバーの１人である@predominantさんからの反応や、会場に来ていた@theMojoWillさん、配信を見ていた@sumardiさんからの反応は発表のあとすぐに届きました。

その後、数日たってNYにお住まいでCakeFestにもいつも来ている@savantさんが他にもRedmineを移植しようとしているフランスのユーザーがが居るのを発見したと教えてくれました。この@kwikyさんは勇敢にもフルスクラッチでRedmineを移植しようとしており、最初の画面が表示された所までで協力者を探しているようでした。

このまま2つのPHP版Redmineが開発されていくのはあまりにも悲しいという事でさらに@phpMagpieさんが会話に参加。この方もイギリスの方でCakeFestの参加者です。

メッセージをkwikyさんに送ったところ、自分のプロジェクトを速攻で閉鎖し、すぐにCandyCaneにフランス語のロケールとフッターのコードの修正やスキーマのミスの修正を送って来てくれました。

会話に参加していた@phpMagpieさんもCandyCaneをインストールしてCSSのリンク切れを教えてくれました。

このあたりの状況を見ていた@itemanさんが「ブレイク」という言葉で祝福してくれました。ちなみに何ヶ月か前に徹夜のネットラジオでCandyCaneの今後の展開について語ったりもしたので、状況を分かって頂けたのかもしれません。

時を同じくしてバグ管理のプロジェクトにもインストール時に不具合に遭遇したという報告や、いくつかの挙動の報告をIgorさんがしてくれています。またインストール方法について案内した後にすばらしい一言をくれました。
“good job about porting Redmine to PHP. I was really looking for something like this.”
(Redmineの移植すごいですね。こういうのを探していたんです)

そしてその後、CakeDCでのCandyCane導入を考えているといっていた@predominantさんが本気を出して怒濤のリファクタリングを開始。一晩に33ものコミットを行って不具合の修正などをしてくれています。結果的にネットワークチャートがすごいことに。

また気づいていないうちにドイツの@meinnerdさんがRedmineを移植した上に結構できてるみたいで、こいつらおかしい！というお褒めの言葉をくれていました。

地道にインストーラーの国際化などをしておいたおかげか、ひとまず各所でインストールしてみる事は成功しているようです。最新のRedmineから移行するとスキーマーの違いでエラーになる部分があることも分かってきましたが、この辺りの対応はバグが落ち着いて来た所ですることになるでしょう。
また日本からもリアル案件でCandyCaneを使っている！という熱い情報がすでに寄せられています。

元々CandyCaneは当時東京に居たCakePHPユーザーが中心になって行った開発合宿の成果物ということで多くの人の手が入っているのですが、ここに来てコントリビューターのリストが一気に国際色を帯びました。日本でも有数のCakePHP使いの皆さんが死力を振り絞って作ったコードがこういう形で陽の目を見るのはとてもうれしいです。またその事を忘れない為にもフッターにはコントリビューター一覧へのリンクを付ける事にしました。

思えば２泊３日で睡眠時間が１日数時間という地獄のような合宿があってこそ。gitもそこで覚えた人もいたし。

すでに立ち上げからは2年が経過し、こんなに多くの人の手が入ったコードを扱っている事には我ながら驚いています。またフィードバックを受けながらソフトウェアが進化するというオープンソースの基本原理を実際に体験する事が出来てなんとも不思議な気持ちです。
日本に居なかったので日本の勉強会での発表やハッカソンなどは全くできていなかったのですが、協力して頂いた皆さんのコードや声を無駄にしないように気長に続けて行ければと思います。

さしあたってはバグの修正とプラグイン開発の土台作りまではこのまま走って行ければと思います。アジャイルの対応やSCMなどの連携はプラグインとして実装できるようにしておいて、各地のCake使いが作れるのが理想かなと思っていますので。

今後も宜しくお願いします。