Redmineプラグインを作るなら読むべき本家チュートリアルの日本語訳 – 旅と子育てとアジャイルコーチのブログ「世界」

:param – プロジェクトIDとなるIDパラメタを指定する。デフォルトではidとなる。（例. :param => :project_id）
:if – アイテム表示前に呼ばれる。条件にtrueの場合のみアイテムは表示される
:caption – メニューで表示したい文字。以下の指定が可能
- ローカライズ文字列のシンボル
- 文字列
- プロジェクトが引数として使えるProc
:before, :after – 対象のメニューの前や後ろにメニューを入れたい時にこれを使う(例. :after => :activity)
:first, :last – trueに設定した場合、メニューの最初や最後に表示できる (例. :last => true)
:html – a hash of html options that are passed to link_to when rendering the menu item

トップメニュー

${PLUGIN_ROOT/init.rbに以下のように記述する。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile22.txt

以下のように表示される。

Screen shot 2011-05-09 at 11.57.03 PM

アカウントメニュー

${PLUGIN_ROOT}/init.rbに以下を記述する。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile23.txt

以下のように表示される。

Screen shot 2011-05-10 at 12.01.23 AM

アプリケーションメニュー

${PLUGIN_ROOT}/init.rbに以下を記述する。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile24.txt

以下のようにメニュー表示される。このメニューはログインしていなくても見えてしまう。

Screen shot 2011-05-08 at 9.08.47 PM

プロジェクトメニュー

プロジェクトを開いたときのメニューに表示する。init.rbに以下に書くだけで良い。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile25.txt

この場合、パラメタproject_idが指定されるメニューリンクが、活動タブの後ろに配置される。メニューのリンクは「http://localhost:3000/cool?project_id=プロジェクトID」のようになる。
permissionの行では、プラグインのアクション（この場合、indexアクション、voteアクション）を公開（public => true）している。Redmineを再起動すると以下のように表示されるはず。

Screen shot 2011-05-09 at 11.33.02 PM

しかし、プロジェクトメニューの場合はこれだけではだめ。試しにクリックすると以下のように表示されるはず。

Screen shot 2011-05-09 at 11.45.42 PM

プロジェクトにあるその他のメニューが表示されない。これを何とかするために、コントローラ内で@projectにプロジェクトを設定する必要がある。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile26.txt

これを実装するために「param => :project_id」のような記述が必要になってくる。この実装を入れるとメニュークリック時に以下のようになる。

Screen shot 2011-05-09 at 11.47.38 PM

管理メニュー

新しい権限を設定する

このままだと誰でも投票できてしまうため、権限を設定する必要がある。まずは2つ権限設定を追加してみる。一つは投票画面を表示する権限で、もうひとつは投票する権限とする。これらの権限をつけるために、まずはpublicとなっている権限を削除する(:public => true の行を削除)。

権限設定は、${PLUGIN_ROOT}/init.rbに以下のように記述する。ここではプロジェクトメニューで実装。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile27.txt

そして、Redmineをリスタートし、http://localhost:3000/roles/reportにアクセス。

Screen shot 2011-05-25 at 8.55.41 PM

権限レポート画面では、設定した二つの権限設定が可能になっているはず。もちろん、アクションをきちんと権限で制限するために、いくつかのコードをコントローラに追加する必要がある。

今回は、indexアクションに:authorizeフィルタを追加し、このフィルタを呼び出す前に、find_projectによって@projectインスタンスを設定している。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile28.txt

find_projectは、indexアクションが呼ばれる前に呼び出される。さらに、上の例だと、voteアクションを実行した後も「redirect_to :action => ‘index’」でindexアクションが呼ばれるため、その前にfind_projectされてしまう。voteアクション時はproject_idが設定されていないため、app/views/cool/index.html.erbのvoteアクションを呼び出す部分でproject_idを設定する必要がある。以下がその例。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile29.txt

リンクURLのパラメタに「project_id => @project.id」を設定しているのがポイント。そして、リダイレクト時に、飛んできた「project_id」をパラメタに再設定するため、コントローラには「redirect_to :action => ‘index’, :project_id => params[:project_id]」と書かなければならない。そうじゃないとindexアクションへのリダイレクト時に、リクエストスコープのパラメタproject_idが消えてしまうため、「Couldn’t find Project without an ID」と怒られてしまう。

この修正によって、voteアクションも同じように、権限設定で付与されたユーザのみが実行できるアクションになる。
もし、権限のシンボルをいろいろな言語で設定したい場合は、以下のようにテキストラベルを言語ファイル（上記「翻訳」セクションを参考のこと）に作り設定することで解決する。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile30.txt

この例ではen.ymlに上記を記述することになる。もちろん、その他の言語でもOK。見ての通りだが、上記シンボルの場合は、「view_sample」の頭に「permission_」を付与している。init.rbでは「:permission_view_sample」ではなく、以下のように記述すればよい。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile31.txt

このシンボル（:permission_view_sample）をinit.rbに記述して、再起動すれば言語の切り替えができるようになる。

プロジェクトモジュールを作る

今の状態だと、作ったプラグインは全てのプロジェクトに追加されてしまう。しかし、「いくつかのプロジェクトで使う」といった柔軟性がほしい場合もありえる。そういうときは、プロジェクトモジュールとしてプラグインを作ることができる。プロジェクトモジュールにすることによって、プロジェクトの設定画面にチェックボックスが登場し、「使いたいモジュール」だけ選択する形にできるようになる。

では、今回作ったプラグインをプロジェクトモジュールにしてみよう。以下のように、${PLUBIN_ROOT}/init.rbの権限設定の文をproject_moduleでくくる。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile32.txt

そして、Redmineを再起動し、プロジェクトの設定画面のモジュールタブを開けば、プロジェクトモジュールとして表示されるはず。

Screen shot 2011-05-28 at 2.40.26 PM

これで、プロジェクトレベルで利用・解除ができる。

ビューの改善

スタイルシートの追加

ビューにスタイルシートを追加する方法の説明。sample.cssを${PLUBIN_ROOT}/assets/stylesheetsディレクトリに作成する。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile33.txt

Redmineが起動したときに、RailsによってWebサーバで利用可能にするために、assetsフォルダは自動的にpublic/plugin_assets/redmine_sample/にコピーされる。このため、CSSを変更したときは、Redmineを再起動させる必要がある。

それから、Redmineによってページのヘッダ部分にCSSを読み込ませるために、以下の行を${PLUGIN_ROOT}/app/views/cool/index.html.erbの最後に追加する。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile34.txt

「:plugin => ‘redmine_sample’」オプションはtylesheet_link_tagを呼び出すときの必須項目になる。Javascriptの場合は、CSSｗの場合と同じように「javascript_include_tag」を呼び出せばよい。

ページタイトルを設定する

html_titleヘルパーを使うことでHTMLにタイトルを設定することができる。

https://gist.github.com/daipresents/cd8c75cbe343487bfa7968ee231b6589.js?file=gistfile35.txt

プラグインのテストについてはまた別途。

プラグインを作成する

モデルの生成

コントローラを作る

翻訳

メニューの拡張