Plugin Tutorial » History » Version 43

David Fischer, 2010-11-17 20:52
No reason to drop and create all databases when only running tests

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