検索機能を実装しました – candycane v0.8.0

v0.8.0ダウンロードページ
CakePHPで作られた第3のRedmine、candycaneのバージョンをv0.8.0に更新しました。今回はインストーラーの国際化やチケットの関連付け機能の有効化、検索機能の最初の実装といった機能を盛り込みより実用性が向上しています。機能の実装に伴って判明した問題点などもありますが、まずは日常の利用をカバーする事を優先しています。特にインストーラーについては3分程度でインストール可能で、気に入らなければフォルダごと捨てられます。この点についてはRedmineと比較してもかなりスムーズな所かなと思っています。

なお先日のCakePHP2.0勉強会で発表した際にカウントしてみたところ現状で130を超えるアクションが実装されている事がわかりました。マニュアルの執筆をするのであれば当然この130のアクションに対してスクリーンショットの撮影や執筆が発生するとわかってしまい、戦慄しています。

Candycane110625

View more presentations from yandod

延べ作業時間は52.50時間、4のバグ修正と5つの機能追加というのが作業の概要です。なんというか、１週間は僕はcandycaneの為に働いているようですね。正直に申しましてこれだけの作業時間を確保するのは健康に支障があるレベルですので、細かなバグ修正から機能の実装まで参加してもらえる方をお待ちしております。。。。

また検索の実装にはSearch Pluginを使っており、k1Lowさんの記事が大変参考になりました。ありとあらゆる検索機能を実装する方にこのプラグインをお勧めしますよ。

• 機能 #107: パスワードリマインダーが動かない
• 機能 #119: インストーラーが翻訳されていない
• 機能 #124: CI環境の構築
• バグ #139: 優先度による色分けができてない
• 機能 #140: チケットの関連付けができない
• 機能 #146: チケット検索ができない
• バグ #148: Xampp上でインストール実行後のWelcome画面がErrrorとなり表示されない。
• バグ #149: 添付ファイルが添付できない？
• バグ #150: 言語リストに余分なdefault.potが表示される

前回のリリースノート

メールが送れるようになりました – CandyCane v0.7.1

v0.7.1ダウンロードページ

草葉の陰で粛々と開発中のcandycaneの更新情報です。
5月分の作業の目処がついたのでバージョンを打ちました。バグフィックス中心ですが、更新情報をメールで通知する機能を新規に実装しました。これは実際にイベントの運営管理でチームメンバーと課題を共有する必要があり、必要性に応じて実装を行いました。
元のRedmineの実装ではActionMailerを使っていたのでCakePHP用のActionMailerのコード例(by @felixge)を微妙に修正したものを取込んでいます。
メールが送信されるさまざまなイベントに送信のトリガーを仕込む必要がありますが、現在はチケットの新規登録と更新時のみメールが送信されるようになっています。

延べ作業時間は23.75時間、12のバグ修正と1つの機能追加というのが作業の概要です。

• バグ #99: ロードマップの件数をクリック後に検索条件が適用されていない
• バグ #106: ロールの編集ができない
• バグ #110: カスタムフィールドの登録が出来ない
• バグ #116: ロードマップに表示されるタイムトラッキングの情報が絞り込まれていない
• バグ #117: バージョン情報を更新後にリダイレクトしない
• バグ #118: 全ての活動からニュースをクリックするとエラー
• バグ #120: チケットのフィルタに対象バージョンがない
• バグ #121: Wikiに権限制限がかかっていない
• バグ #122: 変更履歴ページのバージョンがソートされていない
• バグ #123: 非公開のカスタムクエリが表示されない
• バグ #126: 活動のRSSが壊れている
• バグ #128: ユーザーのステータス変更ができない
• 機能 #127: 更新のメール通知

正直なところ１人で空いた時間に進めるにはこのくらいの作業量が限界かなと思います。（他にもブログを書いたりしているので）リファクタリングやバグつぶし、単体テストなどやりたい事はたくさんあるんですが、、、さてどうなりますか。コードをいじってみたい方はまずインストールしてみて、バグ探しや既知のバグの修正などをやってみてもらえるととても助かります。
マニュアルの作成なんかもやりたいんですが、orz。

あとメールの受信者を割り出す処理にバグがあって、テストサイトにアドレスを登録している方々にSPAMが送信されました。ご迷惑をおかけして申し訳ありません。

前回のリリースノート

candycaneのユニットテストを復旧中

ユニットテストをそろそろ復旧させてCI環境に載せるべく作業。
テスト実行時に app配下ではなく、 cake配下の app_model.phpを読んでしまいエラーになっていた部分を対応。またfixtureの設定の漏れがあったのでそのあたりも修正。
さらにテーブル名がべた書きされていたケースがあったので設定に追随するように修正といった所。

テスト実行用の環境の作り方が何パターンかあるのでその全てをカバーするにはまだ調整が必要そう。ちなみにテスト環境の組み合わせは

• 動作用とは別のDB名＋通常と同じテーブル名
• 動作用と同じDB名＋プリフィクス付きのテーブル名
• 動作用と別のDB名＋プリフィクス付きのテーブル名

いずれにせよ正しい方法でテーブル名を取得していれば問題ないのですが、ひとまず独自のメソッドがあるので底に寄せて行く予定です。なお開発合宿時は各自バラバラの設定で、PostgreSQLも使っていたくらいなのでわりかしどの環境でも動いていました。

candycaneバグ修正 #110

バグ #110 カスタムフィールドの登録が出来ない
カスタムフィールドが登録できないバグを治しました。修正は1行ですが原因の特定に2時間近く掛かりました。カスタムフィールドは表示順をpostionという項目で制御しており、管理画面の矢印をクリックすることでソートすることができます。この機能を実装しているのがlistビヘイビアで、このビヘイビアを実装すればどんなテーブルでもたちまち並び替えが出来るようになるというものです。このビヘイビアのbeforeSaveに問題がありました。（答えはコードの後にあるので、じっくり見てから読み進めても良いですよ）

1
2
3
4
5
6
7
8
9
10
11
12

  function beforeSave(&$Model) {
    $result = true;
    if(empty($Model->id)) {
      $position_column = $this->settings[$Model->alias]['column'];
      $conditions = $this->settings[$Model->alias]['scope'];
      $result = $Model->find('first', array('conditions'=>$conditions, 'order'=>"$position_column DESC"));
      if($result) {
        $Model->data[$Model->alias][$position_column] = $result[$Model->alias][$position_column] + 1;
      }
    }
    return $result;
  }

さて、わかりましたか？
問題があったのは11行目。挿入しようとしたデータと同じpostionの行があった場合は番号をインクリメントするのですが、テーブルが空の場合などデータが無いと$resultがfalseになりbeforeSaveが異常終了してしまいます。なので修正はこれをtrueに変えただけです。モデルのコールバックやバリデーションを自作した場合は最後の戻り値に注意深くなければならないという事を再確認しました。

でもこれでチケットやプロジェクト、ユーザーに好きな項目を拡張する事ができるようになりましたね！

candycaneバグ修正 #99

バグ #99 ロードマップの件数をクリック後に検索条件が適用されていない

比較的やっかいな修正。
チケットの一覧ページへ絞り込み条件がクエリストリングで与えられるとうまく動いていなかった。問題は２つ。まず１つがクエリストリング付きのURL生成の方法が間違っていること。routesの設定をカスタマイズしていることもあり、パスパラメータとクエリストリングをきちんと分ける必要がある。routesが何も設定されていなかった頃は動いていたのかもしれないが。クエリストリングに渡したいパラメータは？の下にハッシュでぶら下げればよい。[diff]

2つめの問題はクエリストリングを解釈してくれる処理が存在していない事による。フォームで送信された場合は受け取れるのだが、フォームの場合は比較を「等しい」「等しくない」のように選べるがクエリストリングの場合は取り扱いが異なる。なのでそのまま代入するわけにもいかず分岐を作った。これはもうすこしスマートにマージできる気もする。[diff]
またこれだけでは適用できるフィルターのリストに「バージョン」が表示されないので、Queryモデルのフィルタ一覧を取得する処理内を他のフィルタを見習って設定する。おそらくakiyanが書いた処理なのだが空気を読んで書くだけで動いた。助かる。

これでロードマップから貼られているリンクをクリックした際に絞り込みが動くようになった。解決。

candycaneバグ修正 #118

バグ #118: 全ての活動からニュースをクリックするとエラー
一つ一つのコミットにはCakePHPとcandycaneの実装を理解するエッセンスがあると思ったのでこまめにブログにしていく試み。活動（アクティビティ）のページに表示される対象のデータにはActivityProviderビヘイビアを設定する必要があるが、設定が間違っていた。
岸田さん実装のこのあたりはかなりの神実装。つまりどんなモデルでもこのビヘイビアが設定してあれば、指定された条件で検索を行ってこの一覧ページに登場するのだから。ただビヘイビアは原理上、どんなモデルに設定しても動くようになっているので抽象度が高い。よってユニットテストを行いながらの実装が欠かせない。

修正した内容

• プロジェクトが指定されていない場合を考慮してissetと分岐を追加 diff
• ビヘイビアで設定するURLの設定ルールにプロジェクトIDを含める様に変更 [diff]

普通に操作していて動かない場所は本当に少なくなって来た。あと少し。