プラグイン Tips » 履歴 » バージョン 4
Toshiyuki Ando, 2009/06/28 11:34
1 | 1 | Toshiyuki Ando | h1. プラグイン Tips |
---|---|---|---|
2 | |||
3 | チュートリアルの域を超えそうなものはこちらに? |
||
4 | |||
5 | h2. 活動ページにプラグインの履歴を表示する |
||
6 | |||
7 | Hudson プラグインを例にとり、プラグインの履歴を表示する方法を紹介します。 |
||
8 | |||
9 | 2 | Toshiyuki Ando | h3. 準備するもの |
10 | 1 | Toshiyuki Ando | |
11 | 2 | Toshiyuki Ando | * 履歴の名前 |
12 | 3 | Toshiyuki Ando | * 履歴を管理するクラス |
13 | 2 | Toshiyuki Ando | |
14 | Hudson の場合は、 |
||
15 | |||
16 | * 履歴の名前: hudson |
||
17 | 3 | Toshiyuki Ando | * 履歴を管理するクラス: HudsonBuild (ビルドを活動の履歴としたいので) |
18 | 2 | Toshiyuki Ando | |
19 | としました。 |
||
20 | |||
21 | h3. サイドバーに表示される履歴の名前に、自分のプラグインを追加する |
||
22 | |||
23 | 1 | Toshiyuki Ando | h4. 1. init.rb で活動ページに参加することを宣言する |
24 | |||
25 | 以下のコードを Redmine::Plugin.register の中に追加します。 |
||
26 | |||
27 | <pre><code class="ruby"> |
||
28 | 2 | Toshiyuki Ando | activity_provider :[履歴の名前], :class_name => '[履歴を管理するクラス]', :default => false |
29 | 1 | Toshiyuki Ando | </code></pre> |
30 | |||
31 | Hudson の場合は以下のようになります。 |
||
32 | 2 | Toshiyuki Ando | default => false は、サイドバーのチェックボックスの状態で、最初表示した時にはチェックされないことを意味します。 |
33 | 1 | Toshiyuki Ando | |
34 | <pre><code class="ruby"> |
||
35 | activity_provider :hudson, :class_name => 'HudsonBuild', :default => false |
||
36 | </code></pre> |
||
37 | |||
38 | 2 | Toshiyuki Ando | h4. 2. 権限に view_[履歴の名前] を追加する |
39 | 1 | Toshiyuki Ando | |
40 | 活動の履歴では権限をチェックします。 |
||
41 | 2 | Toshiyuki Ando | 現在ログインしているユーザが履歴を閲覧してよいかどうかは、 *view_[履歴の名前]権限が許されているかどうか* に依存します。 |
42 | 1 | Toshiyuki Ando | |
43 | 2 | Toshiyuki Ando | Hudsonプラグインで言うと、履歴の種類が hudson なので、 *view_hudson* 権限が必要です。 |
44 | *init.rb に記述する権限に view_hudson がないと、権限なしとみなされてサイドバーに履歴の名前が表示されません。* |
||
45 | 1 | Toshiyuki Ando | |
46 | <pre><code class="ruby"> |
||
47 | project_module :hudson do |
||
48 | # パーミッション設定。 |
||
49 | permission :view_hudson, {:hudson => [:index, :history]} # !!ここ大事!! |
||
50 | permission :build_hudson, {:hudson => [:build]}, :require => :member |
||
51 | permission :edit_hudson_settings, {:hudson_settings => [:edit, :joblist]} |
||
52 | end |
||
53 | </code></pre> |
||
54 | |||
55 | h4. 3. 言語ファイルに label_[イベントの種類]_plural というエントリを追加する |
||
56 | |||
57 | サイドバーに表示する用語は、 label_[イベントの種類]_plural に統一されています。 |
||
58 | Hudsonだと label_hudson_plural ですね。 |
||
59 | 言語ファイルに登録しておかないと label_hudson_plural が表示されるという、格好悪いことになります。 |
||
60 | 3 | Toshiyuki Ando | |
61 | h3. 履歴を表示する |
||
62 | |||
63 | 4 | Toshiyuki Ando | h4. 1. 履歴を管理するクラスに、 project, author のプロパティを用意する |
64 | 1 | Toshiyuki Ando | |
65 | 4 | Toshiyuki Ando | 履歴を表示する際に、 project, author のプロパティが必要となります。 |
66 | HudsonBuild には project, author がなかったので、 |
||
67 | |||
68 | * project => 親のjobから借りてくる |
||
69 | * author => でっちあげる(caused_by という列を用意して、Redmine Admin(user_id=1)が起動したことにする) |
||
70 | |||
71 | ことにしました。 |
||
72 | |||
73 | h4. 2. 履歴を管理するクラスに、acts_as_event を追加する |
||
74 | |||
75 | コードを参考に追加してみてください。 |
||
76 | |||
77 | 3 | Toshiyuki Ando | <pre><code class="ruby"> |
78 | acts_as_event :title => Proc.new {|o| "#{l(:label_build)} #{o.job.name} #{o.number}: #{o.result}"}, |
||
79 | :description => "", |
||
80 | :datetime => :finished_at |
||
81 | </code></pre> |
||
82 | 1 | Toshiyuki Ando | |
83 | 4 | Toshiyuki Ando | |:title |表題に利用されます | |
84 | |:description|詳細…斜体で表示されている部分に利用されます| |
||
85 | |:datetime |発生した日時に利用されます | |
||
86 | |||
87 | Proc.new は自分的にはおまじない…(^^; o が表示対象のオブジェクトと考えれば大丈夫なはず。 |
||
88 | |||
89 | h4. 3. 履歴を管理するクラスに、acts_as_activity_provider を追加する |
||
90 | |||
91 | 同じくコードを参考に…。 |
||
92 | |||
93 | 3 | Toshiyuki Ando | <pre><code class="ruby"> |
94 | 1 | Toshiyuki Ando | acts_as_activity_provider :type => 'hudson', |
95 | 3 | Toshiyuki Ando | :timestamp => "#{HudsonBuild.table_name}.finished_at", |
96 | 4 | Toshiyuki Ando | :author_key => "#{HudsonBuild.table_name}.caused_by", |
97 | 1 | Toshiyuki Ando | :find_options => {:include => {:job => :project}} |
98 | </code></pre> |
||
99 | |||
100 | 4 | Toshiyuki Ando | |:type |履歴の名前にあわせましょう | |
101 | |:timestamp |発生した日時を表す列 | |
||
102 | |:find_options|多分ですが、プロジェクトを探す方法| |
||
103 | 3 | Toshiyuki Ando | |
104 | 4 | Toshiyuki Ando | :find_options ですが、例で言うと、HudsonBuild から job(HudsonJob)をたどって、project(Project)を探してくださいという意味になります。 |