Plugin Tutorial » History » Version 29

Vinod Singh, 2009-10-10 16:37

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