Plugin Internals » History » Version 1

Mischa The Evil, 2009-03-30 23:48
Initial version of the page

1 1 Mischa The Evil
h1. Plugin Internals
2 1 Mischa The Evil
3 1 Mischa The Evil
{{>toc}}
4 1 Mischa The Evil
5 1 Mischa The Evil
This page will be used as a central place to store information about plugin-development in Redmine.
6 1 Mischa The Evil
7 1 Mischa The Evil
h2. Overriding the Redmine Core
8 1 Mischa The Evil
9 1 Mischa The Evil
You can override views but not controllers or models in Redmine. Here's how Redmine/Rails works if you try to override a controller (or model) and a view for a fictional plugin @MyPlugin@:
10 1 Mischa The Evil
11 1 Mischa The Evil
h3. Controllers (or models)
12 1 Mischa The Evil
13 1 Mischa The Evil
# Rails bootstraps and loads all it's framework
14 1 Mischa The Evil
# Rails starts to load code in the plugins
15 1 Mischa The Evil
# Rails finds @IssueController@ in MyPlugin and see it defines a @show@ action
16 1 Mischa The Evil
# Rails loads all the other plugins
17 1 Mischa The Evil
# Rails then loads the application from _../app_
18 1 Mischa The Evil
# Rails finds @IssueController@ again and see it also defines a @show@ action
19 1 Mischa The Evil
# Rails (or rather Ruby) overwrites the @show@ action from the plugin with the one from _../app_
20 1 Mischa The Evil
# Rails finishes loading and serves up requests
21 1 Mischa The Evil
22 1 Mischa The Evil
h3. Views
23 1 Mischa The Evil
24 1 Mischa The Evil
View loading is very similar but with one small difference (because of Redmine's patch to Engines)
25 1 Mischa The Evil
26 1 Mischa The Evil
# Rails bootstraps and loads all it's framework
27 1 Mischa The Evil
# Rails starts to load code in the plugins
28 1 Mischa The Evil
# Rails finds a views directory in _../vendor/plugins/my_plugin/app/views_ and *pre-pends* it to the views path
29 1 Mischa The Evil
# Rails loads all the other plugins
30 1 Mischa The Evil
# Rails then loads the application from _../app_
31 1 Mischa The Evil
# Rails finishes loading and serves up requests
32 1 Mischa The Evil
# Request comes in, and a view needs to be rendered
33 1 Mischa The Evil
# Rails looks for a matching template and loads the plugin's template since it was *pre-pended* to the views path
34 1 Mischa The Evil
# Rails renders the plugins'view
35 1 Mischa The Evil
36 1 Mischa The Evil
Due to the fact that it is so easy to extend models and controllers the Ruby way (via including modules), Redmine shouldn't (and doesn't) maintain an API for overriding the core's models and/or controllers. Views on the other hand are tricky (because of Rails magic) so an API for overriding them is way more useful (and thus implemented in Redmine).
37 1 Mischa The Evil
38 1 Mischa The Evil
To override an existing Redmine Core view just create a view file named exactly after the one in _../app/views/_ and Redmine will use it. For example to override the project index page add a file to _../vendor/plugins/my_plugin/app/views/projects/index.rhtml_.
39 1 Mischa The Evil
40 1 Mischa The Evil
h2. Extending the Redmine Core
41 1 Mischa The Evil
42 1 Mischa The Evil
As explained above: you rarely want to override a model/controller. Instead you should either:
43 1 Mischa The Evil
* add new methods to a model/controller or 
44 1 Mischa The Evil
* wrap an existing method.
45 1 Mischa The Evil
46 1 Mischa The Evil
h3. Adding a new method
47 1 Mischa The Evil
48 1 Mischa The Evil
A quick example of *adding a new method* can be found on Eric Davis' "Budget plugin":http://github.com/edavis10/redmine-budget-plugin/blob/5076b1c88b57c2068aa92cdf694769dbd22d061a/lib/issue_patch.rb. Here he added a new method to Issue called @deliverable_subject@ and also declared a relationship.
49 1 Mischa The Evil
50 1 Mischa The Evil
h3. Wrapping an existing method
51 1 Mischa The Evil
52 1 Mischa The Evil
A quick example of *wrapping an existing method* can be found on Eric Davis' "Rate plugin":http://github.com/edavis10/redmine_rate/blob/4666ddb10e1061ca3ef362735d0d264676b99024/lib/rate_users_helper_patch.rb. Here he uses the @alias_method_chain@ to hook into the UsersHelper and wrap the @user_settings_tabs@ method. So when the Redmine Core calls @user_settings_tabs@ the codepath looks like:
53 1 Mischa The Evil
54 1 Mischa The Evil
# Redmine Core calls @UsersHelper#user_settings_tabs@ 
55 1 Mischa The Evil
# @UsersHelper#user_settings_tabs@ runs (which is actually @UsersHelper#user_settings_tabs_with_rate_tab@)
56 1 Mischa The Evil
# @UsersHelper#user_settings_tabs_with_rate_tab@ calls the original @UsersHelper#user_settings_tabs@ (renamed to @UsersHelper#user_settings_tabs_without_rate_tab@)
57 1 Mischa The Evil
# The result then has a new Hash added to it
58 1 Mischa The Evil
# @UsersHelper#user_settings_tabs_with_rate_tab@ returns the combined result to the Redmine core, which is then rendered
59 1 Mischa The Evil
60 1 Mischa The Evil
"@alias_method_chain@":http://api.rubyonrails.org/classes/ActiveSupport/CoreExtensions/Module.html#M001188 is a pretty advanced method but it's also really powerful.
61 1 Mischa The Evil
62 1 Mischa The Evil
h2. References
63 1 Mischa The Evil
64 1 Mischa The Evil
* http://www.redmine.org/boards/3/topics/show/4283
65 1 Mischa The Evil
* http://www.redmine.org/boards/3/topics/show/4095