Plugin Tutorial » History » Version 100

Toshi MARUYAMA, 2015-10-16 04:07
use "bundle exec"

1 1 Jean-Philippe Lang
h1. Plugin Tutorial
2 12 Jean-Philippe Lang
3 67 Jean-Philippe Lang
This tutorial is based on Redmine 2.x. You can view a previous version of this tutorial for Redmine 1.x "here":/projects/redmine/wiki/Plugin_Tutorial?version=66.
4 72 Jean-Philippe Lang
It assumes that you're familiar with the Ruby on Rails framework.
5 20 Jean-Philippe Lang
6 99 Toshi MARUYAMA
h3. NOTE: Redmine 3.x (Rails 4) script
7 99 Toshi MARUYAMA
8 99 Toshi MARUYAMA
This wiki uses @ruby script/rails@ on Redmine 2.x (Rails 3).
9 99 Toshi MARUYAMA
You need to use @ruby bin/rails@ or @rails@ on Redmine 3.x (Rails 4).
10 99 Toshi MARUYAMA
11 30 Vinod Singh
{{>toc}}
12 1 Jean-Philippe Lang
13 1 Jean-Philippe Lang
h2. Creating a new Plugin
14 40 Nick Peelman
 
15 40 Nick Peelman
You may need to set the RAILS_ENV variable in order to use the command below:
16 32 Jiří Křivánek
17 32 Jiří Křivánek
<pre>
18 32 Jiří Křivánek
$ export RAILS_ENV="production"
19 32 Jiří Křivánek
</pre>
20 32 Jiří Křivánek
21 59 Harry Garrood
On windows:
22 59 Harry Garrood
23 59 Harry Garrood
<pre>
24 68 Jean-Philippe Lang
$ set RAILS_ENV=production
25 59 Harry Garrood
</pre>
26 59 Harry Garrood
27 9 Jean-Philippe Lang
Creating a new plugin can be done using the Redmine plugin generator.
28 9 Jean-Philippe Lang
Syntax for this generator is:
29 1 Jean-Philippe Lang
30 100 Toshi MARUYAMA
<pre>bundle exec ruby script/rails generate redmine_plugin <plugin_name></pre>
31 9 Jean-Philippe Lang
32 1 Jean-Philippe Lang
So open up a command prompt and "cd" to your redmine directory, then execute the following command:
33 1 Jean-Philippe Lang
34 1 Jean-Philippe Lang
<pre>
35 100 Toshi MARUYAMA
$ bundle exec ruby script/rails generate redmine_plugin Polls
36 67 Jean-Philippe Lang
      create  plugins/polls/app
37 67 Jean-Philippe Lang
      create  plugins/polls/app/controllers
38 67 Jean-Philippe Lang
      create  plugins/polls/app/helpers
39 67 Jean-Philippe Lang
      create  plugins/polls/app/models
40 67 Jean-Philippe Lang
      create  plugins/polls/app/views
41 67 Jean-Philippe Lang
      create  plugins/polls/db/migrate
42 67 Jean-Philippe Lang
      create  plugins/polls/lib/tasks
43 67 Jean-Philippe Lang
      create  plugins/polls/assets/images
44 67 Jean-Philippe Lang
      create  plugins/polls/assets/javascripts
45 67 Jean-Philippe Lang
      create  plugins/polls/assets/stylesheets
46 67 Jean-Philippe Lang
      create  plugins/polls/config/locales
47 67 Jean-Philippe Lang
      create  plugins/polls/test
48 67 Jean-Philippe Lang
      create  plugins/polls/README.rdoc
49 67 Jean-Philippe Lang
      create  plugins/polls/init.rb
50 67 Jean-Philippe Lang
      create  plugins/polls/config/routes.rb
51 67 Jean-Philippe Lang
      create  plugins/polls/config/locales/en.yml
52 67 Jean-Philippe Lang
      create  plugins/polls/test/test_helper.rb
53 1 Jean-Philippe Lang
</pre>
54 1 Jean-Philippe Lang
55 67 Jean-Philippe Lang
The plugin structure is created in @plugins/polls@. Edit @plugins/polls/init.rb@ to adjust plugin information (name, author, description and version):
56 1 Jean-Philippe Lang
57 1 Jean-Philippe Lang
<pre><code class="ruby">
58 67 Jean-Philippe Lang
Redmine::Plugin.register :polls do
59 1 Jean-Philippe Lang
  name 'Polls plugin'
60 1 Jean-Philippe Lang
  author 'John Smith'
61 1 Jean-Philippe Lang
  description 'A plugin for managing polls'
62 1 Jean-Philippe Lang
  version '0.0.1'
63 1 Jean-Philippe Lang
end
64 1 Jean-Philippe Lang
</code></pre>
65 1 Jean-Philippe Lang
66 1 Jean-Philippe Lang
Then restart the application and point your browser to http://localhost:3000/admin/plugins.
67 1 Jean-Philippe Lang
After logging in, you should see your new plugin in the plugins list:
68 1 Jean-Philippe Lang
69 71 Jean-Philippe Lang
p=. !plugins_list1.png!
70 1 Jean-Philippe Lang
71 72 Jean-Philippe Lang
Note: any change to the @init.rb@ file of your plugin requires to restart the application as it is not reloaded on each request.
72 72 Jean-Philippe Lang
73 1 Jean-Philippe Lang
h2. Generating a model
74 1 Jean-Philippe Lang
75 1 Jean-Philippe Lang
For now plugin doesn't store anything. Let's create a simple Poll model for our plugin. Syntax is:
76 1 Jean-Philippe Lang
77 1 Jean-Philippe Lang
<pre>
78 100 Toshi MARUYAMA
   bundle exec ruby script/rails generate redmine_plugin_model <plugin_name> <model_name> [field[:type][:index] field[:type][:index] ...]
79 1 Jean-Philippe Lang
</pre>
80 1 Jean-Philippe Lang
81 1 Jean-Philippe Lang
So, go to the command prompt and run:
82 1 Jean-Philippe Lang
83 1 Jean-Philippe Lang
<pre>
84 100 Toshi MARUYAMA
$ bundle exec ruby script/rails generate redmine_plugin_model polls poll question:string yes:integer no:integer
85 67 Jean-Philippe Lang
      create  plugins/polls/app/models/poll.rb
86 67 Jean-Philippe Lang
      create  plugins/polls/test/unit/poll_test.rb
87 67 Jean-Philippe Lang
      create  plugins/polls/db/migrate/001_create_polls.rb
88 13 Jean-Philippe Lang
</pre>
89 1 Jean-Philippe Lang
90 67 Jean-Philippe Lang
This creates the Poll model and the corresponding migration file @001_create_polls.rb@ in @plugins/polls/db/migrate@:
91 1 Jean-Philippe Lang
92 67 Jean-Philippe Lang
<pre><code class="ruby">
93 67 Jean-Philippe Lang
class CreatePolls < ActiveRecord::Migration
94 67 Jean-Philippe Lang
  def change
95 67 Jean-Philippe Lang
    create_table :polls do |t|
96 67 Jean-Philippe Lang
      t.string :question
97 67 Jean-Philippe Lang
      t.integer :yes, :default => 0
98 67 Jean-Philippe Lang
      t.integer :no, :default => 0
99 67 Jean-Philippe Lang
    end
100 67 Jean-Philippe Lang
  end
101 67 Jean-Philippe Lang
end
102 67 Jean-Philippe Lang
</code></pre>
103 1 Jean-Philippe Lang
104 67 Jean-Philippe Lang
You can adjust your migration file (eg. default values...) then migrate the database using the following command:
105 14 Jean-Philippe Lang
106 67 Jean-Philippe Lang
<pre>
107 100 Toshi MARUYAMA
$ bundle exec rake redmine:plugins:migrate
108 1 Jean-Philippe Lang
109 67 Jean-Philippe Lang
Migrating polls (Polls plugin)...
110 67 Jean-Philippe Lang
==  CreatePolls: migrating ====================================================
111 67 Jean-Philippe Lang
-- create_table(:polls)
112 67 Jean-Philippe Lang
   -> 0.0410s
113 67 Jean-Philippe Lang
==  CreatePolls: migrated (0.0420s) ===========================================
114 67 Jean-Philippe Lang
</pre>
115 24 Eric Davis
116 64 Denny Schäfer
Note that each plugin has its own set of migrations.
117 64 Denny Schäfer
118 24 Eric Davis
Lets add some Polls in the console so we have something to work with.  The console is where you can 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
119 24 Eric Davis
120 24 Eric Davis
<pre>
121 100 Toshi MARUYAMA
bundle exec ruby script/rails console
122 77 mina Beshay
[rails 3] rails console
123 15 Jean-Philippe Lang
>> Poll.create(:question => "Can you see this poll")
124 19 Jean-Philippe Lang
>> Poll.create(:question => "And can you see this other poll")
125 15 Jean-Philippe Lang
>> exit
126 15 Jean-Philippe Lang
</pre>
127 15 Jean-Philippe Lang
128 67 Jean-Philippe Lang
Edit @plugins/polls/app/models/poll.rb@ in your plugin directory to add a #vote method that will be invoked from our controller:
129 1 Jean-Philippe Lang
130 15 Jean-Philippe Lang
<pre><code class="ruby">
131 15 Jean-Philippe Lang
class Poll < ActiveRecord::Base
132 1 Jean-Philippe Lang
  def vote(answer)
133 1 Jean-Philippe Lang
    increment(answer == 'yes' ? :yes : :no)
134 60 Mischa The Evil
  end
135 57 Etienne Massip
end
136 9 Jean-Philippe Lang
</code></pre>
137 9 Jean-Philippe Lang
138 67 Jean-Philippe Lang
h2. Generating a controller
139 3 Jean-Philippe Lang
140 3 Jean-Philippe Lang
For now, the plugin doesn't do anything. So let's create a controller for our plugin.
141 1 Jean-Philippe Lang
We can use the plugin controller generator for that. Syntax is:
142 18 Jean-Philippe Lang
143 100 Toshi MARUYAMA
<pre>bundle exec ruby script/rails generate redmine_plugin_controller <plugin_name> <controller_name> [<actions>]</pre>
144 1 Jean-Philippe Lang
145 1 Jean-Philippe Lang
So go back to the command prompt and run:
146 1 Jean-Philippe Lang
147 1 Jean-Philippe Lang
<pre>
148 100 Toshi MARUYAMA
$bundle exec ruby script/rails generate redmine_plugin_controller Polls polls index vote
149 67 Jean-Philippe Lang
      create  plugins/polls/app/controllers/polls_controller.rb
150 67 Jean-Philippe Lang
      create  plugins/polls/app/helpers/polls_helper.rb
151 67 Jean-Philippe Lang
      create  plugins/polls/test/functional/polls_controller_test.rb
152 67 Jean-Philippe Lang
      create  plugins/polls/app/views/polls/index.html.erb
153 67 Jean-Philippe Lang
      create  plugins/polls/app/views/polls/vote.html.erb
154 1 Jean-Philippe Lang
</pre>
155 3 Jean-Philippe Lang
156 1 Jean-Philippe Lang
A controller @PollsController@ with 2 actions (@#index@ and @#vote@) is created.
157 3 Jean-Philippe Lang
158 67 Jean-Philippe Lang
Edit @plugins/polls/app/controllers/polls_controller.rb@ to implement these 2 actions.
159 1 Jean-Philippe Lang
160 1 Jean-Philippe Lang
<pre><code class="ruby">
161 7 Jean-Philippe Lang
class PollsController < ApplicationController
162 1 Jean-Philippe Lang
  unloadable
163 3 Jean-Philippe Lang
164 7 Jean-Philippe Lang
  def index
165 72 Jean-Philippe Lang
    @polls = Poll.all
166 1 Jean-Philippe Lang
  end
167 21 Jean-Baptiste Barth
168 25 Eric Davis
  def vote
169 25 Eric Davis
    poll = Poll.find(params[:id])
170 1 Jean-Philippe Lang
    poll.vote(params[:answer])
171 25 Eric Davis
    if poll.save
172 3 Jean-Philippe Lang
      flash[:notice] = 'Vote saved.'
173 3 Jean-Philippe Lang
    end
174 72 Jean-Philippe Lang
    redirect_to :action => 'index'
175 5 Jean-Philippe Lang
  end
176 26 Eric Davis
end
177 3 Jean-Philippe Lang
</code></pre>
178 3 Jean-Philippe Lang
179 67 Jean-Philippe Lang
Then edit @plugins/polls/app/views/polls/index.html.erb@ that will display existing polls:
180 3 Jean-Philippe Lang
181 74 Etienne Massip
<pre><code class="erb">
182 3 Jean-Philippe Lang
<h2>Polls</h2>
183 19 Jean-Philippe Lang
184 50 Igor Zubkov
<% @polls.each do |poll| %>
185 1 Jean-Philippe Lang
  <p>
186 72 Jean-Philippe Lang
  <%= poll.question %>?
187 72 Jean-Philippe Lang
  <%= link_to 'Yes', { :action => 'vote', :id => poll[:id], :answer => 'yes' }, :method => :post %> (<%= poll.yes %>) /
188 72 Jean-Philippe Lang
  <%= link_to 'No', { :action => 'vote', :id => poll[:id], :answer => 'no' }, :method => :post %> (<%= poll.no %>)
189 1 Jean-Philippe Lang
  </p>
190 3 Jean-Philippe Lang
<% end %>
191 74 Etienne Massip
</code></pre>
192 26 Eric Davis
193 72 Jean-Philippe Lang
You can remove @plugins/polls/app/views/polls/vote.html.erb@ since no rendering is done by the @#vote@ action.
194 18 Jean-Philippe Lang
195 72 Jean-Philippe Lang
h3. Adding routes
196 1 Jean-Philippe Lang
197 72 Jean-Philippe Lang
Redmine does not provide the default wildcard route (@':controller/:action/:id'@). Plugins have to declare the routes they need in their proper @config/routes.rb@ file. So edit @plugins/polls/config/routes.rb@ to add the 2 routes for the 2 actions:
198 72 Jean-Philippe Lang
199 67 Jean-Philippe Lang
<pre><code class="ruby">
200 67 Jean-Philippe Lang
get 'polls', :to => 'polls#index'
201 1 Jean-Philippe Lang
post 'post/:id/vote', :to => 'polls#vote'
202 67 Jean-Philippe Lang
</code></pre>
203 67 Jean-Philippe Lang
204 72 Jean-Philippe Lang
You can find more information about Rails routes here: http://guides.rubyonrails.org/routing.html.
205 72 Jean-Philippe Lang
206 38 Randy Syring
Now, restart the application and point your browser to http://localhost:3000/polls.
207 1 Jean-Philippe Lang
You should see the 2 polls and you should be able to vote for them:
208 38 Randy Syring
209 71 Jean-Philippe Lang
p=. !pools1.png!
210 4 Jean-Philippe Lang
211 72 Jean-Philippe Lang
h2. Internationalization
212 4 Jean-Philippe Lang
213 67 Jean-Philippe Lang
The translation files must be stored in config/locales, eg. @plugins/polls/config/locales/@.
214 1 Jean-Philippe Lang
215 1 Jean-Philippe Lang
h2. Extending menus
216 4 Jean-Philippe Lang
217 26 Eric Davis
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.
218 4 Jean-Philippe Lang
So let's add a new item to the application menu.
219 4 Jean-Philippe Lang
220 18 Jean-Philippe Lang
h3. Extending the application menu
221 4 Jean-Philippe Lang
222 67 Jean-Philippe Lang
Edit @plugins/polls/init.rb@ at the root of your plugin directory to add the following line at the end of the plugin registration block:
223 18 Jean-Philippe Lang
224 4 Jean-Philippe Lang
<pre><code class="ruby">
225 4 Jean-Philippe Lang
Redmine::Plugin.register :redmine_polls do
226 4 Jean-Philippe Lang
  [...]
227 4 Jean-Philippe Lang
  
228 4 Jean-Philippe Lang
  menu :application_menu, :polls, { :controller => 'polls', :action => 'index' }, :caption => 'Polls'
229 4 Jean-Philippe Lang
end
230 4 Jean-Philippe Lang
</code></pre>
231 42 Mischa The Evil
232 4 Jean-Philippe Lang
Syntax is:
233 4 Jean-Philippe Lang
234 4 Jean-Philippe Lang
  menu(menu_name, item_name, url, options={})
235 4 Jean-Philippe Lang
236 4 Jean-Philippe Lang
There are five menus that you can extend:
237 1 Jean-Philippe Lang
238 4 Jean-Philippe Lang
* @:top_menu@ - the top left menu
239 4 Jean-Philippe Lang
* @:account_menu@ - the top right menu with sign in/sign out links
240 4 Jean-Philippe Lang
* @:application_menu@ - the main menu displayed when the user is not inside a project
241 4 Jean-Philippe Lang
* @:project_menu@ - the main menu displayed when the user is inside a project
242 4 Jean-Philippe Lang
* @:admin_menu@ - the menu displayed on the Administration page (can only insert after Settings, before Plugins)
243 4 Jean-Philippe Lang
244 4 Jean-Philippe Lang
Available options are:
245 4 Jean-Philippe Lang
246 1 Jean-Philippe Lang
* @:param@ - the parameter key that is used for the project id (default is @:id@)
247 36 Jérémie Delaitre
* @:if@ - a Proc that is called before rendering the item, the item is displayed only if it returns true
248 36 Jérémie Delaitre
* @:caption@ - the menu caption that can be:
249 4 Jean-Philippe Lang
250 4 Jean-Philippe Lang
  * a localized string Symbol
251 4 Jean-Philippe Lang
  * a String
252 4 Jean-Philippe Lang
  * a Proc that can take the project as argument
253 29 Vinod Singh
254 4 Jean-Philippe Lang
* @:before@, @:after@ - specify where the menu item should be inserted (eg. @:after => :activity@)
255 18 Jean-Philippe Lang
* @:first@, @:last@ - if set to true, the item will stay at the beginning/end of the menu (eg. @:last => true@)
256 4 Jean-Philippe Lang
* @:html@ - a hash of html options that are passed to @link_to@ when rendering the menu item
257 4 Jean-Philippe Lang
258 1 Jean-Philippe Lang
In our example, we've added an item to the application menu which is emtpy by default.
259 19 Jean-Philippe Lang
Restart the application and go to http://localhost:3000:
260 6 Jean-Philippe Lang
261 71 Jean-Philippe Lang
p=. !application_menu.png!
262 6 Jean-Philippe Lang
263 18 Jean-Philippe Lang
Now you can access the polls by clicking the Polls tab from the welcome screen.
264 6 Jean-Philippe Lang
265 6 Jean-Philippe Lang
h3. Extending the project menu
266 51 Igor Zubkov
267 18 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.
268 6 Jean-Philippe Lang
Open @init.rb@ and replace the line that was added just before with these 2 lines:
269 6 Jean-Philippe Lang
270 6 Jean-Philippe Lang
<pre><code class="ruby">
271 18 Jean-Philippe Lang
Redmine::Plugin.register :redmine_polls do
272 18 Jean-Philippe Lang
  [...]
273 6 Jean-Philippe Lang
274 6 Jean-Philippe Lang
  permission :polls, { :polls => [:index, :vote] }, :public => true
275 6 Jean-Philippe Lang
  menu :project_menu, :polls, { :controller => 'polls', :action => 'index' }, :caption => 'Polls', :after => :activity, :param => :project_id
276 1 Jean-Philippe Lang
end
277 1 Jean-Philippe Lang
</code></pre>
278 6 Jean-Philippe Lang
279 67 Jean-Philippe Lang
The second line adds our Polls tab to the project menu, just after the activity tab. 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. Restart the application again and go to one of your projects:
280 6 Jean-Philippe Lang
281 71 Jean-Philippe Lang
p=. !project_menu.png!
282 6 Jean-Philippe Lang
283 67 Jean-Philippe Lang
If you click the Polls tab (in 3rd position), you should notice that the project menu is no longer displayed.
284 19 Jean-Philippe Lang
To make the project menu visible, you have to initialize the controller's instance variable @@project@.
285 6 Jean-Philippe Lang
286 61 Harry Garrood
Edit your PollsController to do so:
287 61 Harry Garrood
288 6 Jean-Philippe Lang
<pre><code class="ruby">
289 6 Jean-Philippe Lang
def index
290 18 Jean-Philippe Lang
  @project = Project.find(params[:project_id])
291 6 Jean-Philippe Lang
  @polls = Poll.find(:all) # @project.polls
292 39 Ric Turley
end
293 4 Jean-Philippe Lang
</code></pre>
294 1 Jean-Philippe Lang
295 4 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.
296 18 Jean-Philippe Lang
297 18 Jean-Philippe Lang
Now, you should see the project menu when viewing the polls:
298 10 Jean-Philippe Lang
299 71 Jean-Philippe Lang
p=. !project_menu_pools.png!
300 10 Jean-Philippe Lang
301 10 Jean-Philippe Lang
h2. Adding new permissions
302 20 Jean-Philippe Lang
303 18 Jean-Philippe Lang
For now, anyone can vote for polls. Let's make it more configurable by changing the permission declaration.
304 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).
305 1 Jean-Philippe Lang
306 67 Jean-Philippe Lang
Edit @plugins/polls/init.rb@ to replace the previous permission declaration with these 2 lines:
307 10 Jean-Philippe Lang
308 10 Jean-Philippe Lang
<pre><code class="ruby">
309 1 Jean-Philippe Lang
  permission :view_polls, :polls => :index
310 29 Vinod Singh
  permission :vote_polls, :polls => :vote
311 1 Jean-Philippe Lang
</code></pre>
312 10 Jean-Philippe Lang
313 89 Robert Schneider
Restart the application and go to http://localhost:3000/roles/permissions:
314 18 Jean-Philippe Lang
315 71 Jean-Philippe Lang
p=. !permissions1.png!
316 10 Jean-Philippe Lang
317 10 Jean-Philippe Lang
You're now able to give these permissions to your existing roles.
318 1 Jean-Philippe Lang
319 67 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. 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.
320 18 Jean-Philippe Lang
321 10 Jean-Philippe Lang
Here is how it would look like for the @#index@ action:
322 10 Jean-Philippe Lang
323 10 Jean-Philippe Lang
<pre><code class="ruby">
324 10 Jean-Philippe Lang
class PollsController < ApplicationController
325 10 Jean-Philippe Lang
  unloadable
326 10 Jean-Philippe Lang
  
327 10 Jean-Philippe Lang
  before_filter :find_project, :authorize, :only => :index
328 19 Jean-Philippe Lang
329 10 Jean-Philippe Lang
  [...]
330 10 Jean-Philippe Lang
  
331 10 Jean-Philippe Lang
  def index
332 10 Jean-Philippe Lang
    @polls = Poll.find(:all) # @project.polls
333 10 Jean-Philippe Lang
  end
334 10 Jean-Philippe Lang
335 10 Jean-Philippe Lang
  [...]
336 10 Jean-Philippe Lang
  
337 10 Jean-Philippe Lang
  private
338 10 Jean-Philippe Lang
  
339 10 Jean-Philippe Lang
  def find_project
340 18 Jean-Philippe Lang
    # @project variable must be set before calling the authorize filter
341 1 Jean-Philippe Lang
    @project = Project.find(params[:project_id])
342 1 Jean-Philippe Lang
  end
343 4 Jean-Philippe Lang
end
344 1 Jean-Philippe Lang
</code></pre>
345 31 Markus Bockman
346 1 Jean-Philippe Lang
Retrieving the current project before the @#vote@ action could be done using a similar way.
347 37 Randy Syring
After this, viewing and voting polls will be only available to admin users or users that have the appropriate role on the project.
348 31 Markus Bockman
349 31 Markus Bockman
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.
350 31 Markus Bockman
Simply create an *.yml (eg. @en.yml@) file in @plugins/polls/config/locales@ and fill it with labels like this:
351 67 Jean-Philippe Lang
352 83 Denis Savitskiy
<pre><code class="yaml">
353 86 Lennart Nordgreen
"en":
354 31 Markus Bockman
  permission_view_polls: View Polls
355 31 Markus Bockman
  permission_vote_polls: Vote Polls
356 83 Denis Savitskiy
</code></pre>
357 31 Markus Bockman
358 67 Jean-Philippe Lang
In this example the created file is known as @en.yml@, but all other supported language files are also possible too.
359 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. 
360 31 Markus Bockman
361 4 Jean-Philippe Lang
Restart your application and point the permission section.
362 4 Jean-Philippe Lang
363 56 Thomas Winkel
h2. Creating a project module
364 26 Eric Davis
365 11 Jean-Philippe Lang
For now, the poll functionality is added to all your projects. But you may want to enable polls for some projects only.
366 11 Jean-Philippe Lang
So, let's create a 'Polls' project module. This is done by wrapping the permissions declaration inside a call to @#project_module@.
367 11 Jean-Philippe Lang
368 11 Jean-Philippe Lang
Edit @init.rb@ and change the permissions declaration:
369 18 Jean-Philippe Lang
370 18 Jean-Philippe Lang
<pre><code class="ruby">
371 18 Jean-Philippe Lang
  project_module :polls do
372 11 Jean-Philippe Lang
    permission :view_polls, :polls => :index
373 1 Jean-Philippe Lang
    permission :vote_polls, :polls => :vote
374 11 Jean-Philippe Lang
  end
375 11 Jean-Philippe Lang
</code></pre>
376 18 Jean-Philippe Lang
377 11 Jean-Philippe Lang
Restart the application and go to one of your project settings.
378 29 Vinod Singh
Click on the Modules tab. You should see the Polls module at the end of the modules list (disabled by default):
379 11 Jean-Philippe Lang
380 71 Jean-Philippe Lang
p=. !modules.png!
381 11 Jean-Philippe Lang
382 11 Jean-Philippe Lang
You can now enable/disable polls at project level.
383 11 Jean-Philippe Lang
384 16 Jean-Philippe Lang
h2. Improving the plugin views
385 16 Jean-Philippe Lang
386 16 Jean-Philippe Lang
h3. Adding stylesheets
387 26 Eric Davis
388 16 Jean-Philippe Lang
Let's start by adding a stylesheet to our plugin views.
389 67 Jean-Philippe Lang
Create a file named @voting.css@ in the @plugins/polls/assets/stylesheets@ directory:
390 16 Jean-Philippe Lang
391 83 Denis Savitskiy
<pre><code class="css">
392 16 Jean-Philippe Lang
a.vote { font-size: 120%; }
393 16 Jean-Philippe Lang
a.vote.yes { color: green; }
394 16 Jean-Philippe Lang
a.vote.no  { color: red; }
395 83 Denis Savitskiy
</code></pre>
396 16 Jean-Philippe Lang
397 67 Jean-Philippe Lang
When starting the application, plugin assets are automatically copied to @public/plugin_assets/polls/@ to make them available through your web server. So any change to your plugin stylesheets or javascripts needs an application restart.
398 16 Jean-Philippe Lang
399 90 Robert Schneider
The introduced classes need to be used by the links. So change in file @plugins/polls/app/views/polls/index.html.erb@ the link declarations to:
400 90 Robert Schneider
401 90 Robert Schneider
<pre><code class="erb">
402 90 Robert Schneider
<%= link_to 'Yes', {:action => 'vote', :id => poll[:id], :answer => 'yes' }, :method => :post, :class => 'vote yes' %> (<%= poll.yes %>)
403 90 Robert Schneider
<%= link_to 'No', {:action => 'vote', :id => poll[:id], :answer => 'no' }, :method => :post, :class => 'vote no' %> (<%= poll.no %>)
404 90 Robert Schneider
</code></pre>
405 90 Robert Schneider
406 90 Robert Schneider
Then, append the following lines at the end of @index.html.erb@ so that your stylesheet get included in the page header by Redmine:
407 16 Jean-Philippe Lang
408 84 Mischa The Evil
<pre><code class="erb">
409 16 Jean-Philippe Lang
<% content_for :header_tags do %>
410 73 Jean-Philippe Lang
    <%= stylesheet_link_tag 'voting', :plugin => 'polls' %>
411 16 Jean-Philippe Lang
<% end %>
412 83 Denis Savitskiy
</code></pre>
413 16 Jean-Philippe Lang
414 73 Jean-Philippe Lang
Note that the @:plugin => 'polls'@ option is required when calling the @stylesheet_link_tag@ helper.
415 16 Jean-Philippe Lang
416 16 Jean-Philippe Lang
Javascripts can be included in plugin views using the @javascript_include_tag@ helper in the same way.
417 1 Jean-Philippe Lang
418 16 Jean-Philippe Lang
h3. Setting page title
419 1 Jean-Philippe Lang
420 16 Jean-Philippe Lang
You can set the HTML title from inside your views by using the @html_title@ helper.
421 1 Jean-Philippe Lang
Example:
422 16 Jean-Philippe Lang
423 84 Mischa The Evil
<pre><code class="erb">
424 34 Tom Bostelmann
  <% html_title "Polls" %>
425 83 Denis Savitskiy
</code></pre>
426 34 Tom Bostelmann
427 75 Jean-Philippe Lang
h2. Using hooks
428 75 Jean-Philippe Lang
429 76 Jean-Philippe Lang
h3. Hooks in views
430 76 Jean-Philippe Lang
431 76 Jean-Philippe Lang
Hooks in Redmine views lets you insert custom content to regular Redmine views. For example, looking at source:tags/2.0.0/app/views/projects/show.html.erb#L52 shows that there are 2 hooks available: one named @:view_projects_show_left@ for adding content to the left part and one named @:view_projects_show_right@ for adding content to the right part of the view.
432 76 Jean-Philippe Lang
433 91 Robert Schneider
To use one or more hooks in views, you need to create a class that inherits from @Redmine::Hook::ViewListener@ and implement methods named with the hook(s) you want to use. To append some content to the project overview, add a class to your plugin and require it in your @init.rb@, then implement methods whose name match the hook names.
434 76 Jean-Philippe Lang
435 92 Robert Schneider
For our plugin create a file @plugins/polls/lib/polls_hook_listener.rb@ with this content:
436 76 Jean-Philippe Lang
437 76 Jean-Philippe Lang
<pre><code class="ruby">
438 1 Jean-Philippe Lang
class PollsHookListener < Redmine::Hook::ViewListener
439 91 Robert Schneider
  def view_projects_show_left(context = {})
440 76 Jean-Philippe Lang
    return content_tag("p", "Custom content added to the left")
441 1 Jean-Philippe Lang
  end
442 76 Jean-Philippe Lang
443 91 Robert Schneider
  def view_projects_show_right(context = {})
444 1 Jean-Philippe Lang
    return content_tag("p", "Custom content added to the right")
445 1 Jean-Philippe Lang
  end
446 1 Jean-Philippe Lang
end
447 1 Jean-Philippe Lang
</code></pre>
448 1 Jean-Philippe Lang
449 91 Robert Schneider
Prepend this line to @plugins/polls/init.rb@:
450 91 Robert Schneider
451 91 Robert Schneider
<pre><code class="ruby">
452 92 Robert Schneider
require_dependency 'polls_hook_listener'
453 91 Robert Schneider
</code></pre>
454 91 Robert Schneider
455 92 Robert Schneider
Restart Redmine and have a look into the overview tab of a project. You should see the strings on the left and the right side in the overview.
456 76 Jean-Philippe Lang
457 92 Robert Schneider
You can also use the @render_on@ helper to render a partial. In our plugin you have to replace the just created content in @plugins/polls/lib/polls_hook_listener.rb@ with:
458 76 Jean-Philippe Lang
459 1 Jean-Philippe Lang
<pre><code class="ruby">
460 76 Jean-Philippe Lang
class PollsHookListener < Redmine::Hook::ViewListener
461 76 Jean-Philippe Lang
  render_on :view_projects_show_left, :partial => "polls/project_overview"
462 76 Jean-Philippe Lang
end
463 76 Jean-Philippe Lang
</code></pre>
464 76 Jean-Philippe Lang
465 93 Robert Schneider
Add the partial to your plugin by creating the file @app/views/polls/_project_overview.html.erb@. Its content (use some text like 'Message from Hook!') will be appended to the left part of the project overview. Don't forget to restart Redmine.
466 76 Jean-Philippe Lang
467 76 Jean-Philippe Lang
h3. Hooks in controllers
468 76 Jean-Philippe Lang
469 75 Jean-Philippe Lang
TODO
470 75 Jean-Philippe Lang
471 75 Jean-Philippe Lang
h2. Making your plugin configurable
472 75 Jean-Philippe Lang
473 81 Paul Kerr
Each plugin registered with Redmine is displayed on the admin/plugins page. Support for a basic configuration mechanism is supplied by the Settings controller. This feature is enabled by adding the "settings" method to the plugin registration block in a plugin's init.rb file.
474 81 Paul Kerr
475 81 Paul Kerr
<pre><code class="ruby">
476 81 Paul Kerr
Redmine::Plugin.register :redmine_polls do
477 81 Paul Kerr
  [ ... ]
478 81 Paul Kerr
479 81 Paul Kerr
  settings :default => {'empty' => true}, :partial => 'settings/poll_settings'
480 81 Paul Kerr
end
481 81 Paul Kerr
</code></pre>
482 81 Paul Kerr
483 81 Paul Kerr
Adding this will accomplish two things. First, it will add a "Configure" link to the description block for the plugin in the admin/plugins list. Following this link will cause a common plugin configuration template view to be loaded which will in turn render the partial view referenced by :partial. Calling the settings method will also add support in the Setting module for the plugin. The Setting model will store and retrieve a serialized hash based on the plugin name. This hash is accessed using the Setting method name in the form plugin_<plugin name>. For this example, the hash can be accessed by calling Setting.plugin_redmine_polls.
484 81 Paul Kerr
485 81 Paul Kerr
p=. !plugin_with_config.png!
486 81 Paul Kerr
487 81 Paul Kerr
The view referenced by the :partial hash key passed to the settings method will be loaded as a partial within the plugin configuration view. The basic page layout is constrained by the plugin configuration view: a form is declared and the submit button is generated. The partial is pulled into the view inside a table div inside the form. Configuration settings for the plugin will be displayed and can be modified via standard HTML form elements.
488 81 Paul Kerr
489 81 Paul Kerr
p=. !plugin_config_view.png!
490 81 Paul Kerr
491 85 Jean-Baptiste Barth
*NB* : if two plugins have the same partial name for settings, the first will override the second's settings page. So be sure you give a unique name to your settings partial.
492 85 Jean-Baptiste Barth
493 81 Paul Kerr
When the page is submitted, the settings_controller will take the parameter hash referenced by 'settings' and store it directly in a serialized format in Setting.plugin_redmine_polls. Each time the page is generated the current value of Setting.plugin_redmine_polls will be assigned to the local variable settings.
494 81 Paul Kerr
495 81 Paul Kerr
<pre><code class="erb">
496 81 Paul Kerr
<table>
497 81 Paul Kerr
  <tbody>
498 81 Paul Kerr
    <tr>
499 81 Paul Kerr
      <th>Notification Default Address</th>
500 98 Denis Savitskiy
      <td>
501 98 Denis Savitskiy
        <input type="text" id="settings_notification_default"
502 98 Denis Savitskiy
                           value="<%= settings['notification_default'] %>"
503 98 Denis Savitskiy
	                       name="settings[notification_default]" >
504 98 Denis Savitskiy
      </td>
505 81 Paul Kerr
    </tr>
506 81 Paul Kerr
  </tbody>
507 81 Paul Kerr
</table>
508 81 Paul Kerr
</code></pre>
509 81 Paul Kerr
510 81 Paul Kerr
In the example above, the configuration form was not created using Rails form helpers. This is because there is no @settings model but only the setting hash. Form helpers will attempt to access attributes using model accessor methods which do not exist. For example, a call to @settings.notification_default will fail. The value set by this form is accessed as Setting.plugin_redmine_polls['notification_default'].
511 81 Paul Kerr
512 81 Paul Kerr
Finally, the :default in the settings method call is to register a value that will be returned from the Setting.plugin_redmine_polls call if nothing has been stored in the settings table for this plugin.
513 75 Jean-Philippe Lang
514 34 Tom Bostelmann
h2. Testing your plugin
515 34 Tom Bostelmann
516 71 Jean-Philippe Lang
h3. test/test_helper.rb
517 34 Tom Bostelmann
518 34 Tom Bostelmann
Here are the contents of my test helper file:
519 34 Tom Bostelmann
520 1 Jean-Philippe Lang
<pre>
521 69 Jean-Philippe Lang
require File.expand_path(File.dirname(__FILE__) + '/../../../test/test_helper')
522 34 Tom Bostelmann
</pre>
523 34 Tom Bostelmann
524 70 Jean-Philippe Lang
h3. Sample test
525 34 Tom Bostelmann
526 70 Jean-Philippe Lang
Contents of @polls_controller_test.rb@:
527 1 Jean-Philippe Lang
528 1 Jean-Philippe Lang
<pre><code class="ruby">
529 69 Jean-Philippe Lang
require File.expand_path('../../test_helper', __FILE__)
530 34 Tom Bostelmann
531 69 Jean-Philippe Lang
class PollsControllerTest < ActionController::TestCase
532 69 Jean-Philippe Lang
  fixtures :projects
533 34 Tom Bostelmann
534 69 Jean-Philippe Lang
  def test_index
535 69 Jean-Philippe Lang
    get :index, :project_id => 1
536 34 Tom Bostelmann
537 88 Niklaus Giger
    assert_response :success
538 69 Jean-Philippe Lang
    assert_template 'index'
539 34 Tom Bostelmann
  end
540 52 Igor Zubkov
end
541 54 Igor Zubkov
</code></pre>
542 34 Tom Bostelmann
543 70 Jean-Philippe Lang
h3. Running test
544 34 Tom Bostelmann
545 70 Jean-Philippe Lang
Initialize the test database if necessary:
546 68 Jean-Philippe Lang
547 34 Tom Bostelmann
<pre>
548 87 Vincent Robert
$ rake db:drop db:create db:migrate redmine:plugins:migrate redmine:load_default_data RAILS_ENV=test
549 48 Igor Zubkov
</pre>
550 34 Tom Bostelmann
551 69 Jean-Philippe Lang
To execute the polls_controller_test.rb:
552 34 Tom Bostelmann
553 34 Tom Bostelmann
<pre>
554 100 Toshi MARUYAMA
$ bundle exec ruby plugins\polls\test\functionals\polls_controller_test.rb
555 47 Mo Morsi
</pre>
556 35 Tom Bostelmann
557 35 Tom Bostelmann
h3. Testing with permissions
558 35 Tom Bostelmann
559 1 Jean-Philippe Lang
If your plugin requires membership to a project, add the following to the beginning of your functional tests:
560 47 Mo Morsi
561 82 Denis Savitskiy
<pre><code class="ruby">
562 47 Mo Morsi
def test_index
563 1 Jean-Philippe Lang
  @request.session[:user_id] = 2
564 47 Mo Morsi
  ...
565 1 Jean-Philippe Lang
end
566 82 Denis Savitskiy
</code></pre>
567 47 Mo Morsi
568 47 Mo Morsi
If your plugin requires a specific permission, you can add that to a user role like so (lookup which role is appropriate for the user in the fixtures):
569 1 Jean-Philippe Lang
570 82 Denis Savitskiy
<pre><code class="ruby">
571 47 Mo Morsi
def test_index
572 1 Jean-Philippe Lang
  Role.find(1).add_permission! :my_permission
573 1 Jean-Philippe Lang
  ...
574 35 Tom Bostelmann
end
575 82 Denis Savitskiy
</code></pre>
576 47 Mo Morsi
577 47 Mo Morsi
578 47 Mo Morsi
You may enable/disable a specific module like so:
579 47 Mo Morsi
580 82 Denis Savitskiy
<pre><code class="ruby">
581 47 Mo Morsi
def test_index
582 47 Mo Morsi
  Project.find(1).enabled_module_names = [:mymodule]
583 47 Mo Morsi
  ...
584 1 Jean-Philippe Lang
end
585 82 Denis Savitskiy
</code></pre>
586 94 @ go2null
587 95 @ go2null
h3. Reference file hierarchy
588 94 @ go2null
589 96 @ go2null
Here is a simple list of all the files and directories mentioned in this Tutorial and [[Hooks]].  This is useful to ensure standard paths are used and also useful for newbies to know here files should go.
590 94 @ go2null
591 94 @ go2null
<pre>
592 94 @ go2null
plugins/PLUGIN/README.rdoc
593 94 @ go2null
plugins/PLUGIN/init.rb
594 94 @ go2null
plugins/PLUGIN/app/
595 94 @ go2null
plugins/PLUGIN/app/controllers/
596 95 @ go2null
plugins/PLUGIN/app/controllers/CONTROLLER_controller.rb
597 94 @ go2null
plugins/PLUGIN/app/helpers/
598 96 @ go2null
plugins/PLUGIN/app/helpers/CONTROLLER_helper.rb
599 94 @ go2null
plugins/PLUGIN/app/models/
600 94 @ go2null
plugins/PLUGIN/app/models/MODEL.rb
601 94 @ go2null
plugins/PLUGIN/app/views/
602 95 @ go2null
plugins/PLUGIN/app/views/CONTROLLER/
603 1 Jean-Philippe Lang
plugins/PLUGIN/app/views/CONTROLLER/_PARTIAL.html.erb
604 1 Jean-Philippe Lang
plugins/PLUGIN/app/views/CONTROLLER/CONTROLLER-ACTION.html.erb
605 96 @ go2null
plugins/PLUGIN/app/views/hooks/
606 96 @ go2null
plugins/PLUGIN/app/views/hooks/_HOOK.html.erb
607 94 @ go2null
plugins/PLUGIN/app/views/settings/
608 94 @ go2null
plugins/PLUGIN/app/views/settings/_MODEL_settings.html.erb
609 94 @ go2null
plugins/PLUGIN/assets/
610 94 @ go2null
plugins/PLUGIN/assets/images/
611 94 @ go2null
plugins/PLUGIN/assets/javascripts/
612 94 @ go2null
plugins/PLUGIN/assets/stylesheets/
613 94 @ go2null
plugins/PLUGIN/assets/stylesheets/voting.css
614 94 @ go2null
plugins/PLUGIN/config/
615 94 @ go2null
plugins/PLUGIN/config/locales/
616 94 @ go2null
plugins/PLUGIN/config/locales/en.yml
617 1 Jean-Philippe Lang
plugins/PLUGIN/config/routes.rb
618 94 @ go2null
plugins/PLUGIN/db/
619 94 @ go2null
plugins/PLUGIN/db/migrate/
620 96 @ go2null
plugins/PLUGIN/db/migrate/001_create_MODELs.rb
621 1 Jean-Philippe Lang
plugins/PLUGIN/lib/
622 94 @ go2null
plugins/PLUGIN/lib/PLUGIN_hook_listener.rb
623 96 @ go2null
plugins/PLUGIN/lib/PLUGIN/
624 96 @ go2null
plugins/PLUGIN/lib/PLUGIN/hooks.rb
625 97 @ go2null
plugins/PLUGIN/lib/PLUGIN/MODEL_patch.rb
626 1 Jean-Philippe Lang
plugins/PLUGIN/lib/tasks/
627 94 @ go2null
plugins/PLUGIN/test/
628 94 @ go2null
plugins/PLUGIN/test/test_helper.rb
629 94 @ go2null
plugins/PLUGIN/test/functional/
630 96 @ go2null
plugins/PLUGIN/test/functional/CONTROLLER_controller_test.rb
631 94 @ go2null
plugins/PLUGIN/test/unit/
632 94 @ go2null
plugins/PLUGIN/test/unit/MODEL_test.rb
633 94 @ go2null
</pre>