Project

General

Profile

Plugin Tutorial » History » Version 22

Mischa The Evil, 2009-02-04 21:00
Fixed two typos in the image-attachment references

1 1 Jean-Philippe Lang
h1. Plugin Tutorial
2 12 Jean-Philippe Lang
3 20 Jean-Philippe Lang
Note: To follow this tutorial, you need to run Redmine devel r1786 or higher.
4
5 12 Jean-Philippe Lang
{{toc}}
6 1 Jean-Philippe Lang
7
h2. Creating a new Plugin
8
9 9 Jean-Philippe Lang
Creating a new plugin can be done using the Redmine plugin generator.
10
Syntax for this generator is:
11 1 Jean-Philippe Lang
12 9 Jean-Philippe Lang
  ruby script/generate redmine_plugin <plugin_name>
13
14
So open up a command prompt and "cd" to your redmine directory, then execute the following command:
15
16 18 Jean-Philippe Lang
  % ruby script/generate redmine_plugin Polls
17 1 Jean-Philippe Lang
18 18 Jean-Philippe Lang
The plugin structure is created in @vendor/plugins/redmine_polls@:
19 1 Jean-Philippe Lang
20
<pre>
21 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/app/controllers
22
      create  vendor/plugins/redmine_polls/app/helpers
23
      create  vendor/plugins/redmine_polls/app/models
24
      create  vendor/plugins/redmine_polls/app/views
25
      create  vendor/plugins/redmine_polls/db/migrate
26
      create  vendor/plugins/redmine_polls/lib/tasks
27
      create  vendor/plugins/redmine_polls/assets/images
28
      create  vendor/plugins/redmine_polls/assets/javascripts
29
      create  vendor/plugins/redmine_polls/assets/stylesheets
30
      create  vendor/plugins/redmine_polls/lang
31
      create  vendor/plugins/redmine_polls/README
32
      create  vendor/plugins/redmine_polls/init.rb
33
      create  vendor/plugins/redmine_polls/lang/en.yml
34 1 Jean-Philippe Lang
</pre>
35
36 18 Jean-Philippe Lang
Edit @vendor/plugins/redmine_polls/init.rb@ to adjust plugin information (name, author, description and version):
37 1 Jean-Philippe Lang
38
<pre><code class="ruby">
39
require 'redmine'
40
41 18 Jean-Philippe Lang
Redmine::Plugin.register :redmine_polls do
42
  name 'Polls plugin'
43 1 Jean-Philippe Lang
  author 'John Smith'
44 18 Jean-Philippe Lang
  description 'A plugin for managing polls'
45 1 Jean-Philippe Lang
  version '0.0.1'
46
end
47
</code></pre>
48
49 2 Jean-Philippe Lang
Then restart the application and point your browser to http://localhost:3000/admin/info.
50 1 Jean-Philippe Lang
After logging in, you should see your new plugin in the plugins list:
51 4 Jean-Philippe Lang
52 2 Jean-Philippe Lang
p=. !plugins_list1.png!
53 1 Jean-Philippe Lang
54 13 Jean-Philippe Lang
h2. Generating a model
55
56 19 Jean-Philippe Lang
Let's create a simple Poll model for our plugin:
57 1 Jean-Philippe Lang
58 19 Jean-Philippe Lang
  ruby script/generate redmine_plugin_model polls poll question:string yes:integer no:integer
59 14 Jean-Philippe Lang
60 19 Jean-Philippe Lang
This creates the Poll model and the corresponding migration file.
61 21 Jean-Baptiste Barth
62
Please note that timestamped migrations are not supported by the actual Redmine plugin engine (Engines). If your migrations are named with a timestamp, rename it using "001", "002", etc. instead.
63
64 14 Jean-Philippe Lang
Migrate the database using the following command:
65
66
  rake db:migrate_plugins
67
68
Note that each plugin has its own set of migrations.
69
70 19 Jean-Philippe Lang
Edit @app/models/poll.rb@ in your plugin directory to add a #vote method that will be invoked from our controller:
71 15 Jean-Philippe Lang
72
<pre><code class="ruby">
73 19 Jean-Philippe Lang
class Poll < ActiveRecord::Base
74 15 Jean-Philippe Lang
  def vote(answer)
75
    increment(answer == 'yes' ? :yes : :no)
76
  end
77
end
78
</code></pre>
79
80 1 Jean-Philippe Lang
h2. Generating a controller
81
82
For now, the plugin doesn't do anything. So let's create a controller for our plugin.
83 9 Jean-Philippe Lang
We can use the plugin controller generator for that. Syntax is:
84
85
  ruby script/generate redmine_plugin_controller <plugin_name> <controller_name> [<actions>]
86
87
So go back to the command prompt and run:
88 3 Jean-Philippe Lang
89
<pre>
90 18 Jean-Philippe Lang
% ruby script/generate redmine_plugin_controller Polls polls index vote
91 3 Jean-Philippe Lang
      exists  app/controllers/
92
      exists  app/helpers/
93 18 Jean-Philippe Lang
      create  app/views/polls
94 3 Jean-Philippe Lang
      create  test/functional/
95 18 Jean-Philippe Lang
      create  app/controllers/polls_controller.rb
96
      create  test/functional/polls_controller_test.rb
97
      create  app/helpers/polls_helper.rb
98
      create  app/views/polls/index.html.erb
99
      create  app/views/polls/vote.html.erb
100 3 Jean-Philippe Lang
</pre>
101
102 18 Jean-Philippe Lang
A controller @PollsController@ with 2 actions (@#index@ and @#vote@) is created.
103 3 Jean-Philippe Lang
104 18 Jean-Philippe Lang
Edit @app/controllers/polls_controller.rb@ in @redmine_polls@ directory to implement these 2 actions.
105 3 Jean-Philippe Lang
106
<pre><code class="ruby">
107 18 Jean-Philippe Lang
class PollsController < ApplicationController
108 1 Jean-Philippe Lang
  unloadable
109
110 7 Jean-Philippe Lang
  def index
111 19 Jean-Philippe Lang
    @polls = Poll.find(:all)
112 3 Jean-Philippe Lang
  end
113 7 Jean-Philippe Lang
114 19 Jean-Philippe Lang
  def vote
115 1 Jean-Philippe Lang
    poll = Poll.find(params[:id])
116 21 Jean-Baptiste Barth
    poll.vote(params[:answer])
117 3 Jean-Philippe Lang
    flash[:notice] = 'Vote saved.'
118
    redirect_to :action => 'index'
119
  end
120
end
121 1 Jean-Philippe Lang
</code></pre>
122 5 Jean-Philippe Lang
123 18 Jean-Philippe Lang
Then edit @app/views/polls/index.html.erb@ that will display existing polls:
124 3 Jean-Philippe Lang
125
126
<pre>
127 18 Jean-Philippe Lang
<h2>Polls</h2>
128 3 Jean-Philippe Lang
129 19 Jean-Philippe Lang
<% @polls.each do |poll| %>
130 3 Jean-Philippe Lang
  <p>
131 19 Jean-Philippe Lang
  <%= poll[:question] %>?
132
  <%= link_to 'Yes', {:action => 'vote', :id => poll[:id], :answer => 'yes'}, :method => :post %> (<%= poll[:yes] %>) /
133
  <%= link_to 'No', {:action => 'vote', :id => poll[:id], :answer => 'no'}, :method => :post %> (<%= poll[:no] %>)
134 3 Jean-Philippe Lang
  </p>
135
<% end %>
136
</pre>
137
138
You can remove @vote.html.erb@ since no rendering is done by the corresponding action.
139
140 18 Jean-Philippe Lang
Now, restart the application and point your browser to http://localhost:3000/polls.
141
You should see the 2 polls and you should be able to vote for them:
142 4 Jean-Philippe Lang
143 22 Mischa The Evil
p=. !pools1.png!
144 4 Jean-Philippe Lang
145 19 Jean-Philippe Lang
Note that poll results are reset on each request if you don't run the application in production mode, since our poll "model" is stored in a class variable in this example.
146 4 Jean-Philippe Lang
147
h2. Extending menus
148
149 18 Jean-Philippe Lang
Our controller works fine but users have to know the url to see the polls. Using the Redmine plugin API, you can extend standard menus.
150 4 Jean-Philippe Lang
So let's add a new item to the application menu.
151
152
h3. Extending the application menu
153
154
Edit @init.rb@ at the root of your plugin directory to add the following line at the end of the plugin registration block:
155
156
<pre><code class="ruby">
157 18 Jean-Philippe Lang
Redmine::Plugin.register :redmine_polls do
158 4 Jean-Philippe Lang
  [...]
159
  
160 18 Jean-Philippe Lang
  menu :application_menu, :polls, { :controller => 'polls', :action => 'index' }, :caption => 'Polls'
161 4 Jean-Philippe Lang
end
162
</code></pre>
163
164
Syntax is:
165
166
  menu(menu_name, item_name, url, options={})
167
168
There are 4 menus that you can extend:
169
170
* @:top_menu@ - the top left menu
171
* @:account_menu@ - the top right menu with sign in/sign out links
172
* @:application_menu@ - the main menu displayed when the user is not inside a project
173
* @:project_menu@ - the main menu displayed when the user is inside a project
174
175
Available options are:
176
177
* @:param@ - the parameter key that is used for the project id (default is @:id@)
178
* @:if@ - a Proc that is called before rendering the item, the item is displayed only if it returns true
179
* @:caption@ - the menu caption that can be:
180
181
  * a localized string Symbol
182
  * a String
183
  * a Proc that can take the project as argument
184
185
* @:before@, @:after@ - specify where the menu item should be inserted (eg. @:after => :activity@)
186
* @:last@ - if set to true, the item will stay at the end of the menu (eg. @:last => true@)
187
* @:html_options@ - a hash of html options that are passed to @link_to@ when rendering the menu item
188
189
In our example, we've added an item to the application menu which is emtpy by default.
190
Restart the application and go to http://localhost:3000:
191
192
p=. !application_menu.png!
193
194 18 Jean-Philippe Lang
Now you can access the polls by clicking the Polls tab from the welcome screen.
195 4 Jean-Philippe Lang
196
h3. Extending the project menu
197
198 19 Jean-Philippe Lang
Now, let's consider that the polls are defined at project level (even if it's not the case in our example poll model). So we would like to add the Polls tab to the project menu instead.
199 6 Jean-Philippe Lang
Open @init.rb@ and replace the line that was added just before with these 2 lines:
200
201
<pre><code class="ruby">
202 18 Jean-Philippe Lang
Redmine::Plugin.register :redmine_polls do
203 6 Jean-Philippe Lang
  [...]
204
205 18 Jean-Philippe Lang
  permission :polls, {:polls => [:index, :vote]}, :public => true
206
  menu :project_menu, :polls, { :controller => 'polls', :action => 'index' }, :caption => 'Polls', :after => :activity, :param => :project_id
207 6 Jean-Philippe Lang
end
208
</code></pre>
209
210 18 Jean-Philippe Lang
The second line adds our Polls tab to the project menu, just after the activity tab.
211
The first line is required and declares that our 2 actions from @PollsController@ are public. We'll come back later to explain this with more details.
212 6 Jean-Philippe Lang
213
Restart the application again and go to one of your projects:
214
215
p=. !project_menu.png!
216
217 18 Jean-Philippe Lang
If you click the Polls tab, you should notice that the project menu is no longer displayed.
218 6 Jean-Philippe Lang
To make the project menu visible, you have to initialize the controller's instance variable @@project@.
219
220 18 Jean-Philippe Lang
Edit your PollsController to do so:
221 6 Jean-Philippe Lang
222
<pre><code class="ruby">
223
def index
224
  @project = Project.find(params[:project_id])
225 19 Jean-Philippe Lang
  @polls = Poll.find(:all) # @project.polls
226 6 Jean-Philippe Lang
end
227
</code></pre>
228
229
The project id is available in the @:project_id@ param because of the @:param => :project_id@ option in the menu item declaration above.
230
231 18 Jean-Philippe Lang
Now, you should see the project menu when viewing the polls:
232 6 Jean-Philippe Lang
233 22 Mischa The Evil
p=. !project_menu_pools.png!
234 4 Jean-Philippe Lang
235
h2. Adding new permissions
236
237 18 Jean-Philippe Lang
For now, anyone can vote for polls. Let's make it more configurable by changing the permission declaration.
238
We're going to declare 2 project based permissions, one for viewing the polls and an other one for voting. These permissions are no longer public (@:public => true@ option is removed).
239 10 Jean-Philippe Lang
240
Edit @init.rb@ to replace the previous permission declaration with these 2 lines:
241
242
<pre><code class="ruby">
243 20 Jean-Philippe Lang
244 18 Jean-Philippe Lang
  permission :view_polls, :polls => :index
245
  permission :vote_polls, :polls => :vote
246 1 Jean-Philippe Lang
</code></pre>
247 14 Jean-Philippe Lang
248 10 Jean-Philippe Lang
249
Restart the application and go to http://localhost:3000/roles/report:
250
251
p=. !permissions1.png!
252
253
You're now able to give these permissions to your existing roles.
254
255 18 Jean-Philippe Lang
Of course, some code needs to be added to the PollsController so that actions are actually protected according to the permissions of the current user.
256 10 Jean-Philippe Lang
For this, we just need to append the @:authorize@ filter and make sure that the @project instance variable is properly set before calling this filter.
257
258
Here is how it would look like for the @#index@ action:
259
260 1 Jean-Philippe Lang
<pre><code class="ruby">
261 18 Jean-Philippe Lang
class PollsController < ApplicationController
262 10 Jean-Philippe Lang
  unloadable
263
  
264
  before_filter :find_project, :authorize, :only => :index
265
266
  [...]
267
  
268
  def index
269 19 Jean-Philippe Lang
    @polls = Poll.find(:all) # @project.polls
270 10 Jean-Philippe Lang
  end
271
272
  [...]
273
  
274
  private
275
  
276
  def find_project
277
    # @project variable must be set before calling the authorize filter
278
    @project = Project.find(params[:project_id])
279
  end
280
end
281
</code></pre>
282
283
Retrieving the current project before the @#vote@ action could be done using a similiar way.
284 18 Jean-Philippe Lang
After this, viewing and voting polls will be only available to admin users or users that have the appropriate role on the project.
285 4 Jean-Philippe Lang
286
h2. Creating a project module
287
288 19 Jean-Philippe Lang
For now, the poll functionality is added to all your projects. But you way want to enable polls for some projects only.
289 18 Jean-Philippe Lang
So, let's create a 'Polls' project module. This is done by wraping the permissions declaration inside a call to @#project_module@.
290 11 Jean-Philippe Lang
291
Edit @init.rb@ and change the permissions declaration:
292
293
<pre><code class="ruby">
294 18 Jean-Philippe Lang
  project_module :polls do
295
    permission :view_polls, :polls => :index
296
    permission :vote_polls, :polls => :vote
297 11 Jean-Philippe Lang
  end
298
</code></pre>
299
300
Restart the application and go to one of your project settings.
301 18 Jean-Philippe Lang
Click on the Modules tab. You should see the Polls module at the end of the modules list (disabled by default):
302 11 Jean-Philippe Lang
303
p=. !modules.png!
304
305 18 Jean-Philippe Lang
You can now enable/disable polls at project level.
306 11 Jean-Philippe Lang
307
h2. Improving the plugin views
308
309 16 Jean-Philippe Lang
h3. Adding stylesheets
310
311
Let's start by adding a stylesheet to our plugin views.
312
Create a file named @voting.css@ in the @assets/stylesheets@ directory of your plugin:
313
314
<pre>
315
a.vote { font-size: 120%; }
316
a.vote.yes { color: green; }
317
a.vote.no  { color: red; }
318
</pre>
319
320 18 Jean-Philippe Lang
When starting the application, plugin assets are automatically copied to @public/plugin_assets/redmine_polls/@ by Rails Engines to make them available through your web server. So any change to your plugin stylesheets or javascripts needs an application restart.
321 16 Jean-Philippe Lang
322 18 Jean-Philippe Lang
Then, append the following lines at the end of @app/views/polls/index.html.erb@ so that your stylesheet get included in the page header by Redmine:
323 16 Jean-Philippe Lang
324
<pre>
325
<% content_for :header_tags do %>
326 18 Jean-Philippe Lang
    <%= stylesheet_link_tag 'voting', :plugin => 'redmine_polls' %>
327 16 Jean-Philippe Lang
<% end %>
328
</pre>
329
330 18 Jean-Philippe Lang
Note that the @:plugin => 'redmine_polls'@ option is required when calling the @stylesheet_link_tag@ helper.
331 16 Jean-Philippe Lang
332
Javascripts can be included in plugin views using the @javascript_include_tag@ helper in the same way.
333
334
h3. Setting page title
335
336
You can set the HTML title from inside your views by using the @html_title@ helper.
337
Example:
338
339 18 Jean-Philippe Lang
  <% html_title "Polls" -%>