Plugin Tutorial » History » Version 45

John Yani, 2011-01-19 22:39
ajust cd path

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 30 Vinod Singh
{{>toc}}
6 1 Jean-Philippe Lang
7 1 Jean-Philippe Lang
h2. Creating a new Plugin
8 40 Nick Peelman
 
9 40 Nick Peelman
You may need to set the RAILS_ENV variable in order to use the command below:
10 32 Jiří Křivánek
11 32 Jiří Křivánek
<pre>
12 32 Jiří Křivánek
$ export RAILS_ENV="production"
13 32 Jiří Křivánek
</pre>
14 32 Jiří Křivánek
15 9 Jean-Philippe Lang
Creating a new plugin can be done using the Redmine plugin generator.
16 9 Jean-Philippe Lang
Syntax for this generator is:
17 1 Jean-Philippe Lang
18 23 Jean-Baptiste Barth
<pre>ruby script/generate redmine_plugin <plugin_name></pre>
19 9 Jean-Philippe Lang
20 9 Jean-Philippe Lang
So open up a command prompt and "cd" to your redmine directory, then execute the following command:
21 9 Jean-Philippe Lang
22 18 Jean-Philippe Lang
  % ruby script/generate redmine_plugin Polls
23 1 Jean-Philippe Lang
24 18 Jean-Philippe Lang
The plugin structure is created in @vendor/plugins/redmine_polls@:
25 1 Jean-Philippe Lang
26 1 Jean-Philippe Lang
<pre>
27 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/app/controllers
28 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/app/helpers
29 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/app/models
30 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/app/views
31 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/db/migrate
32 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/lib/tasks
33 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/assets/images
34 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/assets/javascripts
35 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/assets/stylesheets
36 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/lang
37 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/README
38 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/init.rb
39 18 Jean-Philippe Lang
      create  vendor/plugins/redmine_polls/lang/en.yml
40 1 Jean-Philippe Lang
</pre>
41 1 Jean-Philippe Lang
42 18 Jean-Philippe Lang
Edit @vendor/plugins/redmine_polls/init.rb@ to adjust plugin information (name, author, description and version):
43 1 Jean-Philippe Lang
44 1 Jean-Philippe Lang
<pre><code class="ruby">
45 1 Jean-Philippe Lang
require 'redmine'
46 1 Jean-Philippe Lang
47 18 Jean-Philippe Lang
Redmine::Plugin.register :redmine_polls do
48 18 Jean-Philippe Lang
  name 'Polls plugin'
49 1 Jean-Philippe Lang
  author 'John Smith'
50 18 Jean-Philippe Lang
  description 'A plugin for managing polls'
51 1 Jean-Philippe Lang
  version '0.0.1'
52 1 Jean-Philippe Lang
end
53 1 Jean-Philippe Lang
</code></pre>
54 1 Jean-Philippe Lang
55 27 Eduardo Yáñez Parareda
Then restart the application and point your browser to http://localhost:3000/admin/plugins.
56 1 Jean-Philippe Lang
After logging in, you should see your new plugin in the plugins list:
57 4 Jean-Philippe Lang
58 29 Vinod Singh
!plugins_list1.png!
59 1 Jean-Philippe Lang
60 13 Jean-Philippe Lang
h2. Generating a model
61 13 Jean-Philippe Lang
62 44 John Yani
For now plugin doesn't store anything. Let's create a simple Poll model for our plugin. Syntax is:
63 1 Jean-Philippe Lang
64 44 John Yani
<pre>
65 44 John Yani
   ruby script/generate redmine_plugin_model <plugin_name> <model_name> [<fields>]
66 44 John Yani
</pre>
67 44 John Yani
68 44 John Yani
So, go to the command prompt and run:
69 44 John Yani
70 44 John Yani
<pre>
71 1 Jean-Philippe Lang
   ruby script/generate redmine_plugin_model polls poll question:string yes:integer no:integer
72 44 John Yani
</pre>
73 14 Jean-Philippe Lang
74 19 Jean-Philippe Lang
This creates the Poll model and the corresponding migration file.
75 1 Jean-Philippe Lang
76 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.
77 28 John Fisher
78 45 John Yani
   <pre>cd vendor/plugins/redmine_polls/db/migrate
79 28 John Fisher
mv  20091009211553_create_polls.rb 001_create_polls.rb</pre>
80 28 John Fisher
81 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.
82 28 John Fisher
83 21 Jean-Baptiste Barth
84 14 Jean-Philippe Lang
Migrate the database using the following command:
85 14 Jean-Philippe Lang
86 14 Jean-Philippe Lang
  rake db:migrate_plugins
87 14 Jean-Philippe Lang
88 14 Jean-Philippe Lang
Note that each plugin has its own set of migrations.
89 14 Jean-Philippe Lang
90 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
91 24 Eric Davis
92 24 Eric Davis
<pre>
93 24 Eric Davis
script/console
94 24 Eric Davis
>> Poll.create(:question => "Can you see this poll ?")
95 24 Eric Davis
>> Poll.create(:question => "And can you see this other poll ?")
96 24 Eric Davis
>> exit
97 24 Eric Davis
</pre>
98 24 Eric Davis
99 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:
100 15 Jean-Philippe Lang
101 15 Jean-Philippe Lang
<pre><code class="ruby">
102 19 Jean-Philippe Lang
class Poll < ActiveRecord::Base
103 15 Jean-Philippe Lang
  def vote(answer)
104 15 Jean-Philippe Lang
    increment(answer == 'yes' ? :yes : :no)
105 15 Jean-Philippe Lang
  end
106 15 Jean-Philippe Lang
end
107 15 Jean-Philippe Lang
</code></pre>
108 15 Jean-Philippe Lang
109 1 Jean-Philippe Lang
h2. Generating a controller
110 1 Jean-Philippe Lang
111 1 Jean-Philippe Lang
For now, the plugin doesn't do anything. So let's create a controller for our plugin.
112 9 Jean-Philippe Lang
We can use the plugin controller generator for that. Syntax is:
113 9 Jean-Philippe Lang
114 23 Jean-Baptiste Barth
<pre>ruby script/generate redmine_plugin_controller <plugin_name> <controller_name> [<actions>]</pre>
115 9 Jean-Philippe Lang
116 9 Jean-Philippe Lang
So go back to the command prompt and run:
117 3 Jean-Philippe Lang
118 3 Jean-Philippe Lang
<pre>
119 18 Jean-Philippe Lang
% ruby script/generate redmine_plugin_controller Polls polls index vote
120 3 Jean-Philippe Lang
      exists  app/controllers/
121 3 Jean-Philippe Lang
      exists  app/helpers/
122 18 Jean-Philippe Lang
      create  app/views/polls
123 3 Jean-Philippe Lang
      create  test/functional/
124 18 Jean-Philippe Lang
      create  app/controllers/polls_controller.rb
125 18 Jean-Philippe Lang
      create  test/functional/polls_controller_test.rb
126 18 Jean-Philippe Lang
      create  app/helpers/polls_helper.rb
127 18 Jean-Philippe Lang
      create  app/views/polls/index.html.erb
128 18 Jean-Philippe Lang
      create  app/views/polls/vote.html.erb
129 3 Jean-Philippe Lang
</pre>
130 3 Jean-Philippe Lang
131 18 Jean-Philippe Lang
A controller @PollsController@ with 2 actions (@#index@ and @#vote@) is created.
132 3 Jean-Philippe Lang
133 26 Eric Davis
Edit @vendor/plugins/redmine_polls/app/controllers/polls_controller.rb@ in @redmine_polls@ directory to implement these 2 actions.
134 3 Jean-Philippe Lang
135 3 Jean-Philippe Lang
<pre><code class="ruby">
136 18 Jean-Philippe Lang
class PollsController < ApplicationController
137 1 Jean-Philippe Lang
  unloadable
138 1 Jean-Philippe Lang
139 7 Jean-Philippe Lang
  def index
140 19 Jean-Philippe Lang
    @polls = Poll.find(:all)
141 3 Jean-Philippe Lang
  end
142 7 Jean-Philippe Lang
143 19 Jean-Philippe Lang
  def vote
144 1 Jean-Philippe Lang
    poll = Poll.find(params[:id])
145 21 Jean-Baptiste Barth
    poll.vote(params[:answer])
146 25 Eric Davis
    if poll.save
147 25 Eric Davis
      flash[:notice] = 'Vote saved.'
148 25 Eric Davis
      redirect_to :action => 'index'
149 25 Eric Davis
    end
150 3 Jean-Philippe Lang
  end
151 3 Jean-Philippe Lang
end
152 1 Jean-Philippe Lang
</code></pre>
153 5 Jean-Philippe Lang
154 26 Eric Davis
Then edit @vendor/plugins/redmine_polls/app/views/polls/index.html.erb@ that will display existing polls:
155 3 Jean-Philippe Lang
156 3 Jean-Philippe Lang
157 3 Jean-Philippe Lang
<pre>
158 18 Jean-Philippe Lang
<h2>Polls</h2>
159 3 Jean-Philippe Lang
160 19 Jean-Philippe Lang
<% @polls.each do |poll| %>
161 3 Jean-Philippe Lang
  <p>
162 19 Jean-Philippe Lang
  <%= poll[:question] %>?
163 19 Jean-Philippe Lang
  <%= link_to 'Yes', {:action => 'vote', :id => poll[:id], :answer => 'yes'}, :method => :post %> (<%= poll[:yes] %>) /
164 19 Jean-Philippe Lang
  <%= link_to 'No', {:action => 'vote', :id => poll[:id], :answer => 'no'}, :method => :post %> (<%= poll[:no] %>)
165 3 Jean-Philippe Lang
  </p>
166 3 Jean-Philippe Lang
<% end %>
167 3 Jean-Philippe Lang
</pre>
168 3 Jean-Philippe Lang
169 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.
170 3 Jean-Philippe Lang
171 18 Jean-Philippe Lang
Now, restart the application and point your browser to http://localhost:3000/polls.
172 18 Jean-Philippe Lang
You should see the 2 polls and you should be able to vote for them:
173 4 Jean-Philippe Lang
174 29 Vinod Singh
!pools1.png!
175 4 Jean-Philippe Lang
176 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.
177 4 Jean-Philippe Lang
178 37 Randy Syring
h2. Translations
179 37 Randy Syring
180 38 Randy Syring
The location of *.yml translation files is dependent on the version of Redmine that is being run:
181 38 Randy Syring
182 38 Randy Syring
|_. Version |_. Path|
183 38 Randy Syring
| < 0.9 | @.../redmine_polls/lang@ |
184 38 Randy Syring
| >= 0.9 | @.../redmine_polls/config/locales@ |
185 38 Randy Syring
186 38 Randy Syring
If you want your plugin to work in both versions, you will need to have the same translation file in both locations.
187 37 Randy Syring
188 4 Jean-Philippe Lang
h2. Extending menus
189 4 Jean-Philippe Lang
190 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.
191 4 Jean-Philippe Lang
So let's add a new item to the application menu.
192 4 Jean-Philippe Lang
193 4 Jean-Philippe Lang
h3. Extending the application menu
194 4 Jean-Philippe Lang
195 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:
196 4 Jean-Philippe Lang
197 4 Jean-Philippe Lang
<pre><code class="ruby">
198 18 Jean-Philippe Lang
Redmine::Plugin.register :redmine_polls do
199 4 Jean-Philippe Lang
  [...]
200 4 Jean-Philippe Lang
  
201 18 Jean-Philippe Lang
  menu :application_menu, :polls, { :controller => 'polls', :action => 'index' }, :caption => 'Polls'
202 4 Jean-Philippe Lang
end
203 4 Jean-Philippe Lang
</code></pre>
204 4 Jean-Philippe Lang
205 4 Jean-Philippe Lang
Syntax is:
206 4 Jean-Philippe Lang
207 4 Jean-Philippe Lang
  menu(menu_name, item_name, url, options={})
208 4 Jean-Philippe Lang
209 42 Mischa The Evil
There are five menus that you can extend:
210 4 Jean-Philippe Lang
211 4 Jean-Philippe Lang
* @:top_menu@ - the top left menu
212 4 Jean-Philippe Lang
* @:account_menu@ - the top right menu with sign in/sign out links
213 4 Jean-Philippe Lang
* @:application_menu@ - the main menu displayed when the user is not inside a project
214 4 Jean-Philippe Lang
* @:project_menu@ - the main menu displayed when the user is inside a project
215 41 Nick Peelman
* @:admin_menu@ - the menu displayed on the Administration page (can only insert after Settings, before Plugins)
216 4 Jean-Philippe Lang
217 4 Jean-Philippe Lang
Available options are:
218 4 Jean-Philippe Lang
219 4 Jean-Philippe Lang
* @:param@ - the parameter key that is used for the project id (default is @:id@)
220 4 Jean-Philippe Lang
* @:if@ - a Proc that is called before rendering the item, the item is displayed only if it returns true
221 4 Jean-Philippe Lang
* @:caption@ - the menu caption that can be:
222 4 Jean-Philippe Lang
223 4 Jean-Philippe Lang
  * a localized string Symbol
224 4 Jean-Philippe Lang
  * a String
225 4 Jean-Philippe Lang
  * a Proc that can take the project as argument
226 4 Jean-Philippe Lang
227 4 Jean-Philippe Lang
* @:before@, @:after@ - specify where the menu item should be inserted (eg. @:after => :activity@)
228 36 Jérémie Delaitre
* @:first@, @:last@ - if set to true, the item will stay at the beginning/end of the menu (eg. @:last => true@)
229 36 Jérémie Delaitre
* @:html@ - a hash of html options that are passed to @link_to@ when rendering the menu item
230 4 Jean-Philippe Lang
231 4 Jean-Philippe Lang
In our example, we've added an item to the application menu which is emtpy by default.
232 4 Jean-Philippe Lang
Restart the application and go to http://localhost:3000:
233 4 Jean-Philippe Lang
234 29 Vinod Singh
!application_menu.png!
235 4 Jean-Philippe Lang
236 18 Jean-Philippe Lang
Now you can access the polls by clicking the Polls tab from the welcome screen.
237 4 Jean-Philippe Lang
238 4 Jean-Philippe Lang
h3. Extending the project menu
239 4 Jean-Philippe Lang
240 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.
241 6 Jean-Philippe Lang
Open @init.rb@ and replace the line that was added just before with these 2 lines:
242 6 Jean-Philippe Lang
243 6 Jean-Philippe Lang
<pre><code class="ruby">
244 18 Jean-Philippe Lang
Redmine::Plugin.register :redmine_polls do
245 6 Jean-Philippe Lang
  [...]
246 6 Jean-Philippe Lang
247 18 Jean-Philippe Lang
  permission :polls, {:polls => [:index, :vote]}, :public => true
248 18 Jean-Philippe Lang
  menu :project_menu, :polls, { :controller => 'polls', :action => 'index' }, :caption => 'Polls', :after => :activity, :param => :project_id
249 6 Jean-Philippe Lang
end
250 6 Jean-Philippe Lang
</code></pre>
251 6 Jean-Philippe Lang
252 18 Jean-Philippe Lang
The second line adds our Polls tab to the project menu, just after the activity tab.
253 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.
254 6 Jean-Philippe Lang
255 6 Jean-Philippe Lang
Restart the application again and go to one of your projects:
256 6 Jean-Philippe Lang
257 39 Ric Turley
!http://www.redmine.org/attachments/3773/project_menu.png!
258 6 Jean-Philippe Lang
259 18 Jean-Philippe Lang
If you click the Polls tab, you should notice that the project menu is no longer displayed.
260 6 Jean-Philippe Lang
To make the project menu visible, you have to initialize the controller's instance variable @@project@.
261 6 Jean-Philippe Lang
262 18 Jean-Philippe Lang
Edit your PollsController to do so:
263 6 Jean-Philippe Lang
264 6 Jean-Philippe Lang
<pre><code class="ruby">
265 6 Jean-Philippe Lang
def index
266 6 Jean-Philippe Lang
  @project = Project.find(params[:project_id])
267 19 Jean-Philippe Lang
  @polls = Poll.find(:all) # @project.polls
268 6 Jean-Philippe Lang
end
269 6 Jean-Philippe Lang
</code></pre>
270 6 Jean-Philippe Lang
271 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.
272 6 Jean-Philippe Lang
273 18 Jean-Philippe Lang
Now, you should see the project menu when viewing the polls:
274 6 Jean-Philippe Lang
275 39 Ric Turley
!http://www.redmine.org/attachments/3774/project_menu_pools.png!
276 4 Jean-Philippe Lang
277 4 Jean-Philippe Lang
h2. Adding new permissions
278 4 Jean-Philippe Lang
279 18 Jean-Philippe Lang
For now, anyone can vote for polls. Let's make it more configurable by changing the permission declaration.
280 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).
281 10 Jean-Philippe Lang
282 26 Eric Davis
Edit @vendor/plugins/redmine_polls/init.rb@ to replace the previous permission declaration with these 2 lines:
283 10 Jean-Philippe Lang
284 10 Jean-Philippe Lang
<pre><code class="ruby">
285 20 Jean-Philippe Lang
286 18 Jean-Philippe Lang
  permission :view_polls, :polls => :index
287 18 Jean-Philippe Lang
  permission :vote_polls, :polls => :vote
288 1 Jean-Philippe Lang
</code></pre>
289 14 Jean-Philippe Lang
290 10 Jean-Philippe Lang
291 10 Jean-Philippe Lang
Restart the application and go to http://localhost:3000/roles/report:
292 10 Jean-Philippe Lang
293 29 Vinod Singh
!permissions1.png!
294 10 Jean-Philippe Lang
295 10 Jean-Philippe Lang
You're now able to give these permissions to your existing roles.
296 10 Jean-Philippe Lang
297 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.
298 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.
299 10 Jean-Philippe Lang
300 10 Jean-Philippe Lang
Here is how it would look like for the @#index@ action:
301 10 Jean-Philippe Lang
302 1 Jean-Philippe Lang
<pre><code class="ruby">
303 18 Jean-Philippe Lang
class PollsController < ApplicationController
304 10 Jean-Philippe Lang
  unloadable
305 10 Jean-Philippe Lang
  
306 10 Jean-Philippe Lang
  before_filter :find_project, :authorize, :only => :index
307 10 Jean-Philippe Lang
308 10 Jean-Philippe Lang
  [...]
309 10 Jean-Philippe Lang
  
310 10 Jean-Philippe Lang
  def index
311 19 Jean-Philippe Lang
    @polls = Poll.find(:all) # @project.polls
312 10 Jean-Philippe Lang
  end
313 10 Jean-Philippe Lang
314 10 Jean-Philippe Lang
  [...]
315 10 Jean-Philippe Lang
  
316 10 Jean-Philippe Lang
  private
317 10 Jean-Philippe Lang
  
318 10 Jean-Philippe Lang
  def find_project
319 10 Jean-Philippe Lang
    # @project variable must be set before calling the authorize filter
320 10 Jean-Philippe Lang
    @project = Project.find(params[:project_id])
321 10 Jean-Philippe Lang
  end
322 10 Jean-Philippe Lang
end
323 10 Jean-Philippe Lang
</code></pre>
324 10 Jean-Philippe Lang
325 18 Jean-Philippe Lang
Retrieving the current project before the @#vote@ action could be done using a similar way.
326 4 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.
327 31 Markus Bockman
328 1 Jean-Philippe Lang
If you want to display the symbols of your permissions in a multilangual way, you need to add the necessary text labels in a language file.
329 37 Randy Syring
Simply create an *.yml file in the correct translation directory for your Redmine version and fill it with labels like this:
330 31 Markus Bockman
331 31 Markus Bockman
<pre><code class="ruby">
332 31 Markus Bockman
333 31 Markus Bockman
  permission_view_polls: View Polls
334 31 Markus Bockman
  permission_vote_polls: Vote Polls
335 31 Markus Bockman
336 31 Markus Bockman
</code></pre>
337 31 Markus Bockman
338 31 Markus Bockman
In this example the created file is known as en.yml, but all other supported language files are also possible too.
339 31 Markus Bockman
As you can see on the example above, the labels consists of the permission symbols @:view_polls@ and @:vote_polls@ with an additional @permission_@ added at the front. 
340 31 Markus Bockman
341 31 Markus Bockman
Restart your application and point the permission section.
342 31 Markus Bockman
343 4 Jean-Philippe Lang
h2. Creating a project module
344 4 Jean-Philippe Lang
345 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.
346 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@.
347 11 Jean-Philippe Lang
348 11 Jean-Philippe Lang
Edit @init.rb@ and change the permissions declaration:
349 11 Jean-Philippe Lang
350 11 Jean-Philippe Lang
<pre><code class="ruby">
351 18 Jean-Philippe Lang
  project_module :polls do
352 18 Jean-Philippe Lang
    permission :view_polls, :polls => :index
353 18 Jean-Philippe Lang
    permission :vote_polls, :polls => :vote
354 11 Jean-Philippe Lang
  end
355 11 Jean-Philippe Lang
</code></pre>
356 11 Jean-Philippe Lang
357 11 Jean-Philippe Lang
Restart the application and go to one of your project settings.
358 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):
359 11 Jean-Philippe Lang
360 29 Vinod Singh
!modules.png!
361 11 Jean-Philippe Lang
362 18 Jean-Philippe Lang
You can now enable/disable polls at project level.
363 11 Jean-Philippe Lang
364 11 Jean-Philippe Lang
h2. Improving the plugin views
365 11 Jean-Philippe Lang
366 16 Jean-Philippe Lang
h3. Adding stylesheets
367 16 Jean-Philippe Lang
368 16 Jean-Philippe Lang
Let's start by adding a stylesheet to our plugin views.
369 26 Eric Davis
Create a file named @voting.css@ in the @vendor/plugins/redmine_polls/assets/stylesheets@ directory:
370 16 Jean-Philippe Lang
371 16 Jean-Philippe Lang
<pre>
372 16 Jean-Philippe Lang
a.vote { font-size: 120%; }
373 16 Jean-Philippe Lang
a.vote.yes { color: green; }
374 16 Jean-Philippe Lang
a.vote.no  { color: red; }
375 16 Jean-Philippe Lang
</pre>
376 16 Jean-Philippe Lang
377 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.
378 16 Jean-Philippe Lang
379 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:
380 16 Jean-Philippe Lang
381 16 Jean-Philippe Lang
<pre>
382 16 Jean-Philippe Lang
<% content_for :header_tags do %>
383 18 Jean-Philippe Lang
    <%= stylesheet_link_tag 'voting', :plugin => 'redmine_polls' %>
384 16 Jean-Philippe Lang
<% end %>
385 16 Jean-Philippe Lang
</pre>
386 16 Jean-Philippe Lang
387 18 Jean-Philippe Lang
Note that the @:plugin => 'redmine_polls'@ option is required when calling the @stylesheet_link_tag@ helper.
388 16 Jean-Philippe Lang
389 16 Jean-Philippe Lang
Javascripts can be included in plugin views using the @javascript_include_tag@ helper in the same way.
390 16 Jean-Philippe Lang
391 16 Jean-Philippe Lang
h3. Setting page title
392 16 Jean-Philippe Lang
393 16 Jean-Philippe Lang
You can set the HTML title from inside your views by using the @html_title@ helper.
394 16 Jean-Philippe Lang
Example:
395 16 Jean-Philippe Lang
396 18 Jean-Philippe Lang
  <% html_title "Polls" -%>
397 34 Tom Bostelmann
398 34 Tom Bostelmann
399 34 Tom Bostelmann
h2. Testing your plugin
400 34 Tom Bostelmann
401 34 Tom Bostelmann
h3. test/test_helper.rb:
402 34 Tom Bostelmann
403 34 Tom Bostelmann
Here are the contents of my test helper file:
404 34 Tom Bostelmann
405 34 Tom Bostelmann
<pre>
406 34 Tom Bostelmann
require File.expand_path(File.dirname(__FILE__) + '/../../../../test/test_helper')
407 34 Tom Bostelmann
</pre>
408 34 Tom Bostelmann
409 34 Tom Bostelmann
h3. Sample test:
410 34 Tom Bostelmann
411 34 Tom Bostelmann
Contents of requirements_controller_test.rb:
412 34 Tom Bostelmann
413 34 Tom Bostelmann
<pre>
414 34 Tom Bostelmann
require File.dirname(__FILE__) + '/../test_helper'
415 34 Tom Bostelmann
require 'requirements_controller'
416 34 Tom Bostelmann
417 34 Tom Bostelmann
class RequirementsControllerTest < ActionController::TestCase
418 34 Tom Bostelmann
  fixtures :projects, :versions, :users, :roles, :members, :member_roles, :issues, :journals, :journal_details,
419 34 Tom Bostelmann
           :trackers, :projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :boards, :messages,
420 34 Tom Bostelmann
           :attachments, :custom_fields, :custom_values, :time_entries
421 34 Tom Bostelmann
422 34 Tom Bostelmann
  def setup
423 34 Tom Bostelmann
    @skill = Skill.new(:skill_name => 'Java')
424 34 Tom Bostelmann
    @project = Project.find(1)
425 34 Tom Bostelmann
    @request    = ActionController::TestRequest.new
426 34 Tom Bostelmann
    @response   = ActionController::TestResponse.new
427 34 Tom Bostelmann
    User.current = nil
428 34 Tom Bostelmann
  end
429 34 Tom Bostelmann
430 34 Tom Bostelmann
  def test_routing
431 34 Tom Bostelmann
    assert_routing(
432 34 Tom Bostelmann
      {:method => :get, :path => '/requirements'},
433 34 Tom Bostelmann
      :controller => 'requirements', :action => 'index'
434 34 Tom Bostelmann
    )
435 34 Tom Bostelmann
  end
436 34 Tom Bostelmann
</pre>
437 34 Tom Bostelmann
438 34 Tom Bostelmann
h3. Initialize Test DB:
439 34 Tom Bostelmann
440 34 Tom Bostelmann
I found it easiest to initialize the test db directly with the following rake call:
441 34 Tom Bostelmann
442 34 Tom Bostelmann
<pre>
443 43 David Fischer
rake db:drop db:create db:migrate db:migrate_plugins redmine:load_default_data RAILS_ENV=test
444 34 Tom Bostelmann
</pre>
445 34 Tom Bostelmann
446 34 Tom Bostelmann
h3. Run test:
447 34 Tom Bostelmann
448 34 Tom Bostelmann
To execute the reqruirements_controller_test.rb I used the following command:
449 34 Tom Bostelmann
450 34 Tom Bostelmann
<pre>
451 34 Tom Bostelmann
rake test:engines:all PLUGIN=redmine_requirements
452 34 Tom Bostelmann
</pre>
453 35 Tom Bostelmann
454 35 Tom Bostelmann
h3. Testing with users and projects
455 35 Tom Bostelmann
456 35 Tom Bostelmann
If your plugin requires membership to a project, add the following to the beginning of your functional tests:
457 35 Tom Bostelmann
458 35 Tom Bostelmann
<pre>
459 35 Tom Bostelmann
def setup
460 35 Tom Bostelmann
  @request    = ActionController::TestRequest.new
461 35 Tom Bostelmann
  @response   = ActionController::TestResponse.new
462 35 Tom Bostelmann
  User.current = nil
463 35 Tom Bostelmann
end
464 35 Tom Bostelmann
465 35 Tom Bostelmann
def test_index
466 35 Tom Bostelmann
  @request.session[:user_id] = 2
467 35 Tom Bostelmann
  get :index, :project_id => 1
468 35 Tom Bostelmann
  assert_response :success
469 35 Tom Bostelmann
  assert_template :index
470 35 Tom Bostelmann
end
471 35 Tom Bostelmann
</pre>
472 35 Tom Bostelmann
473 35 Tom Bostelmann
I'm not sure if all of it is needed to be honest.  But this seemed to do the trick for me :S