Plugin Tutorial » History » Version 16

Jean-Philippe Lang, 2008-08-10 22:36

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