##// END OF EJS Templates
jro_apps » redmine
RSS
Fix typos in the examples. #5823...
Eric Davis -
r3727:5e259d41e2c1
parent child
Show More
Side by Side Unified
Context file:
r3727:5e259d41e2c1 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,271 +1,271
1 # redMine - project management software
1 # redMine - project management software
2 # Copyright (C) 2006-2007 Jean-Philippe Lang
2 # Copyright (C) 2006-2007 Jean-Philippe Lang
3 #
3 #
4 # This program is free software; you can redistribute it and/or
4 # This program is free software; you can redistribute it and/or
5 # modify it under the terms of the GNU General Public License
5 # modify it under the terms of the GNU General Public License
6 # as published by the Free Software Foundation; either version 2
6 # as published by the Free Software Foundation; either version 2
7 # of the License, or (at your option) any later version.
7 # of the License, or (at your option) any later version.
8 #
8 #
9 # This program is distributed in the hope that it will be useful,
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 # GNU General Public License for more details.
12 # GNU General Public License for more details.
13 #
13 #
14 # You should have received a copy of the GNU General Public License
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17
17
18 module Redmine #:nodoc:
18 module Redmine #:nodoc:
19
19
20 class PluginNotFound < StandardError; end
20 class PluginNotFound < StandardError; end
21 class PluginRequirementError < StandardError; end
21 class PluginRequirementError < StandardError; end
22
22
23 # Base class for Redmine plugins.
23 # Base class for Redmine plugins.
24 # Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
24 # Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
25 #
25 #
26 # Redmine::Plugin.register :example do
26 # Redmine::Plugin.register :example do
27 # name 'Example plugin'
27 # name 'Example plugin'
28 # author 'John Smith'
28 # author 'John Smith'
29 # description 'This is an example plugin for Redmine'
29 # description 'This is an example plugin for Redmine'
30 # version '0.0.1'
30 # version '0.0.1'
31 # settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
31 # settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
32 # end
32 # end
33 #
33 #
34 # === Plugin attributes
34 # === Plugin attributes
35 #
35 #
36 # +settings+ is an optional attribute that let the plugin be configurable.
36 # +settings+ is an optional attribute that let the plugin be configurable.
37 # It must be a hash with the following keys:
37 # It must be a hash with the following keys:
38 # * <tt>:default</tt>: default value for the plugin settings
38 # * <tt>:default</tt>: default value for the plugin settings
39 # * <tt>:partial</tt>: path of the configuration partial view, relative to the plugin <tt>app/views</tt> directory
39 # * <tt>:partial</tt>: path of the configuration partial view, relative to the plugin <tt>app/views</tt> directory
40 # Example:
40 # Example:
41 # settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
41 # settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
42 # In this example, the settings partial will be found here in the plugin directory: <tt>app/views/settings/_settings.rhtml</tt>.
42 # In this example, the settings partial will be found here in the plugin directory: <tt>app/views/settings/_settings.rhtml</tt>.
43 #
43 #
44 # When rendered, the plugin settings value is available as the local variable +settings+
44 # When rendered, the plugin settings value is available as the local variable +settings+
45 class Plugin
45 class Plugin
46 @registered_plugins = {}
46 @registered_plugins = {}
47 class << self
47 class << self
48 attr_reader :registered_plugins
48 attr_reader :registered_plugins
49 private :new
49 private :new
50
50
51 def def_field(*names)
51 def def_field(*names)
52 class_eval do
52 class_eval do
53 names.each do |name|
53 names.each do |name|
54 define_method(name) do |*args|
54 define_method(name) do |*args|
55 args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
55 args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
56 end
56 end
57 end
57 end
58 end
58 end
59 end
59 end
60 end
60 end
61 def_field :name, :description, :url, :author, :author_url, :version, :settings
61 def_field :name, :description, :url, :author, :author_url, :version, :settings
62 attr_reader :id
62 attr_reader :id
63
63
64 # Plugin constructor
64 # Plugin constructor
65 def self.register(id, &block)
65 def self.register(id, &block)
66 p = new(id)
66 p = new(id)
67 p.instance_eval(&block)
67 p.instance_eval(&block)
68 # Set a default name if it was not provided during registration
68 # Set a default name if it was not provided during registration
69 p.name(id.to_s.humanize) if p.name.nil?
69 p.name(id.to_s.humanize) if p.name.nil?
70 # Adds plugin locales if any
70 # Adds plugin locales if any
71 # YAML translation files should be found under <plugin>/config/locales/
71 # YAML translation files should be found under <plugin>/config/locales/
72 ::I18n.load_path += Dir.glob(File.join(RAILS_ROOT, 'vendor', 'plugins', id.to_s, 'config', 'locales', '*.yml'))
72 ::I18n.load_path += Dir.glob(File.join(RAILS_ROOT, 'vendor', 'plugins', id.to_s, 'config', 'locales', '*.yml'))
73 registered_plugins[id] = p
73 registered_plugins[id] = p
74 end
74 end
75
75
76 # Returns an array off all registered plugins
76 # Returns an array off all registered plugins
77 def self.all
77 def self.all
78 registered_plugins.values.sort
78 registered_plugins.values.sort
79 end
79 end
80
80
81 # Finds a plugin by its id
81 # Finds a plugin by its id
82 # Returns a PluginNotFound exception if the plugin doesn't exist
82 # Returns a PluginNotFound exception if the plugin doesn't exist
83 def self.find(id)
83 def self.find(id)
84 registered_plugins[id.to_sym] || raise(PluginNotFound)
84 registered_plugins[id.to_sym] || raise(PluginNotFound)
85 end
85 end
86
86
87 # Clears the registered plugins hash
87 # Clears the registered plugins hash
88 # It doesn't unload installed plugins
88 # It doesn't unload installed plugins
89 def self.clear
89 def self.clear
90 @registered_plugins = {}
90 @registered_plugins = {}
91 end
91 end
92
92
93 def initialize(id)
93 def initialize(id)
94 @id = id.to_sym
94 @id = id.to_sym
95 end
95 end
96
96
97 def <=>(plugin)
97 def <=>(plugin)
98 self.id.to_s <=> plugin.id.to_s
98 self.id.to_s <=> plugin.id.to_s
99 end
99 end
100
100
101 # Sets a requirement on Redmine version
101 # Sets a requirement on Redmine version
102 # Raises a PluginRequirementError exception if the requirement is not met
102 # Raises a PluginRequirementError exception if the requirement is not met
103 #
103 #
104 # Examples
104 # Examples
105 # # Requires Redmine 0.7.3 or higher
105 # # Requires Redmine 0.7.3 or higher
106 # requires_redmine :version_or_higher => '0.7.3'
106 # requires_redmine :version_or_higher => '0.7.3'
107 # requires_redmine '0.7.3'
107 # requires_redmine '0.7.3'
108 #
108 #
109 # # Requires a specific Redmine version
109 # # Requires a specific Redmine version
110 # requires_redmine :version => '0.7.3' # 0.7.3 only
110 # requires_redmine :version => '0.7.3' # 0.7.3 only
111 # requires_redmine :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
111 # requires_redmine :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
112 def requires_redmine(arg)
112 def requires_redmine(arg)
113 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
113 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
114 arg.assert_valid_keys(:version, :version_or_higher)
114 arg.assert_valid_keys(:version, :version_or_higher)
115
115
116 current = Redmine::VERSION.to_a
116 current = Redmine::VERSION.to_a
117 arg.each do |k, v|
117 arg.each do |k, v|
118 v = [] << v unless v.is_a?(Array)
118 v = [] << v unless v.is_a?(Array)
119 versions = v.collect {|s| s.split('.').collect(&:to_i)}
119 versions = v.collect {|s| s.split('.').collect(&:to_i)}
120 case k
120 case k
121 when :version_or_higher
121 when :version_or_higher
122 raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
122 raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
123 unless (current <=> versions.first) >= 0
123 unless (current <=> versions.first) >= 0
124 raise PluginRequirementError.new("#{id} plugin requires Redmine #{v} or higher but current is #{current.join('.')}")
124 raise PluginRequirementError.new("#{id} plugin requires Redmine #{v} or higher but current is #{current.join('.')}")
125 end
125 end
126 when :version
126 when :version
127 unless versions.include?(current.slice(0,3))
127 unless versions.include?(current.slice(0,3))
128 raise PluginRequirementError.new("#{id} plugin requires one the following Redmine versions: #{v.join(', ')} but current is #{current.join('.')}")
128 raise PluginRequirementError.new("#{id} plugin requires one the following Redmine versions: #{v.join(', ')} but current is #{current.join('.')}")
129 end
129 end
130 end
130 end
131 end
131 end
132 true
132 true
133 end
133 end
134
134
135 # Sets a requirement on a Redmine plugin version
135 # Sets a requirement on a Redmine plugin version
136 # Raises a PluginRequirementError exception if the requirement is not met
136 # Raises a PluginRequirementError exception if the requirement is not met
137 #
137 #
138 # Examples
138 # Examples
139 # # Requires a plugin named :foo version 0.7.3 or higher
139 # # Requires a plugin named :foo version 0.7.3 or higher
140 # requires_redmine_plugin :foo, :version_or_higher => '0.7.3'
140 # requires_redmine_plugin :foo, :version_or_higher => '0.7.3'
141 # requires_redmine_plugin :foo, '0.7.3'
141 # requires_redmine_plugin :foo, '0.7.3'
142 #
142 #
143 # # Requires a specific version of a Redmine plugin
143 # # Requires a specific version of a Redmine plugin
144 # requires_redmine_plugin :foo, :version => '0.7.3' # 0.7.3 only
144 # requires_redmine_plugin :foo, :version => '0.7.3' # 0.7.3 only
145 # requires_redmine_plugin :foo, :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
145 # requires_redmine_plugin :foo, :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
146 def requires_redmine_plugin(plugin_name, arg)
146 def requires_redmine_plugin(plugin_name, arg)
147 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
147 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
148 arg.assert_valid_keys(:version, :version_or_higher)
148 arg.assert_valid_keys(:version, :version_or_higher)
149
149
150 plugin = Plugin.find(plugin_name)
150 plugin = Plugin.find(plugin_name)
151 current = plugin.version.split('.').collect(&:to_i)
151 current = plugin.version.split('.').collect(&:to_i)
152
152
153 arg.each do |k, v|
153 arg.each do |k, v|
154 v = [] << v unless v.is_a?(Array)
154 v = [] << v unless v.is_a?(Array)
155 versions = v.collect {|s| s.split('.').collect(&:to_i)}
155 versions = v.collect {|s| s.split('.').collect(&:to_i)}
156 case k
156 case k
157 when :version_or_higher
157 when :version_or_higher
158 raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
158 raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
159 unless (current <=> versions.first) >= 0
159 unless (current <=> versions.first) >= 0
160 raise PluginRequirementError.new("#{id} plugin requires the #{plugin_name} plugin #{v} or higher but current is #{current.join('.')}")
160 raise PluginRequirementError.new("#{id} plugin requires the #{plugin_name} plugin #{v} or higher but current is #{current.join('.')}")
161 end
161 end
162 when :version
162 when :version
163 unless versions.include?(current.slice(0,3))
163 unless versions.include?(current.slice(0,3))
164 raise PluginRequirementError.new("#{id} plugin requires one the following versions of #{plugin_name}: #{v.join(', ')} but current is #{current.join('.')}")
164 raise PluginRequirementError.new("#{id} plugin requires one the following versions of #{plugin_name}: #{v.join(', ')} but current is #{current.join('.')}")
165 end
165 end
166 end
166 end
167 end
167 end
168 true
168 true
169 end
169 end
170
170
171 # Adds an item to the given +menu+.
171 # Adds an item to the given +menu+.
172 # The +id+ parameter (equals to the project id) is automatically added to the url.
172 # The +id+ parameter (equals to the project id) is automatically added to the url.
173 # menu :project_menu, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
173 # menu :project_menu, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
174 #
174 #
175 # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
175 # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
176 #
176 #
177 def menu(menu, item, url, options={})
177 def menu(menu, item, url, options={})
178 Redmine::MenuManager.map(menu).push(item, url, options)
178 Redmine::MenuManager.map(menu).push(item, url, options)
179 end
179 end
180 alias :add_menu_item :menu
180 alias :add_menu_item :menu
181
181
182 # Removes +item+ from the given +menu+.
182 # Removes +item+ from the given +menu+.
183 def delete_menu_item(menu, item)
183 def delete_menu_item(menu, item)
184 Redmine::MenuManager.map(menu).delete(item)
184 Redmine::MenuManager.map(menu).delete(item)
185 end
185 end
186
186
187 # Defines a permission called +name+ for the given +actions+.
187 # Defines a permission called +name+ for the given +actions+.
188 #
188 #
189 # The +actions+ argument is a hash with controllers as keys and actions as values (a single value or an array):
189 # The +actions+ argument is a hash with controllers as keys and actions as values (a single value or an array):
190 # permission :destroy_contacts, { :contacts => :destroy }
190 # permission :destroy_contacts, { :contacts => :destroy }
191 # permission :view_contacts, { :contacts => [:index, :show] }
191 # permission :view_contacts, { :contacts => [:index, :show] }
192 #
192 #
193 # The +options+ argument can be used to make the permission public (implicitly given to any user)
193 # The +options+ argument can be used to make the permission public (implicitly given to any user)
194 # or to restrict users the permission can be given to.
194 # or to restrict users the permission can be given to.
195 #
195 #
196 # Examples
196 # Examples
197 # # A permission that is implicitly given to any user
197 # # A permission that is implicitly given to any user
198 # # This permission won't appear on the Roles & Permissions setup screen
198 # # This permission won't appear on the Roles & Permissions setup screen
199 # permission :say_hello, { :example => :say_hello }, :public => true
199 # permission :say_hello, { :example => :say_hello }, :public => true
200 #
200 #
201 # # A permission that can be given to any user
201 # # A permission that can be given to any user
202 # permission :say_hello, { :example => :say_hello }
202 # permission :say_hello, { :example => :say_hello }
203 #
203 #
204 # # A permission that can be given to registered users only
204 # # A permission that can be given to registered users only
205 # permission :say_hello, { :example => :say_hello }, :require => loggedin
205 # permission :say_hello, { :example => :say_hello }, :require => :loggedin
206 #
206 #
207 # # A permission that can be given to project members only
207 # # A permission that can be given to project members only
208 # permission :say_hello, { :example => :say_hello }, :require => member
208 # permission :say_hello, { :example => :say_hello }, :require => :member
209 def permission(name, actions, options = {})
209 def permission(name, actions, options = {})
210 if @project_module
210 if @project_module
211 Redmine::AccessControl.map {|map| map.project_module(@project_module) {|map|map.permission(name, actions, options)}}
211 Redmine::AccessControl.map {|map| map.project_module(@project_module) {|map|map.permission(name, actions, options)}}
212 else
212 else
213 Redmine::AccessControl.map {|map| map.permission(name, actions, options)}
213 Redmine::AccessControl.map {|map| map.permission(name, actions, options)}
214 end
214 end
215 end
215 end
216
216
217 # Defines a project module, that can be enabled/disabled for each project.
217 # Defines a project module, that can be enabled/disabled for each project.
218 # Permissions defined inside +block+ will be bind to the module.
218 # Permissions defined inside +block+ will be bind to the module.
219 #
219 #
220 # project_module :things do
220 # project_module :things do
221 # permission :view_contacts, { :contacts => [:list, :show] }, :public => true
221 # permission :view_contacts, { :contacts => [:list, :show] }, :public => true
222 # permission :destroy_contacts, { :contacts => :destroy }
222 # permission :destroy_contacts, { :contacts => :destroy }
223 # end
223 # end
224 def project_module(name, &block)
224 def project_module(name, &block)
225 @project_module = name
225 @project_module = name
226 self.instance_eval(&block)
226 self.instance_eval(&block)
227 @project_module = nil
227 @project_module = nil
228 end
228 end
229
229
230 # Registers an activity provider.
230 # Registers an activity provider.
231 #
231 #
232 # Options:
232 # Options:
233 # * <tt>:class_name</tt> - one or more model(s) that provide these events (inferred from event_type by default)
233 # * <tt>:class_name</tt> - one or more model(s) that provide these events (inferred from event_type by default)
234 # * <tt>:default</tt> - setting this option to false will make the events not displayed by default
234 # * <tt>:default</tt> - setting this option to false will make the events not displayed by default
235 #
235 #
236 # A model can provide several activity event types.
236 # A model can provide several activity event types.
237 #
237 #
238 # Examples:
238 # Examples:
239 # register :news
239 # register :news
240 # register :scrums, :class_name => 'Meeting'
240 # register :scrums, :class_name => 'Meeting'
241 # register :issues, :class_name => ['Issue', 'Journal']
241 # register :issues, :class_name => ['Issue', 'Journal']
242 #
242 #
243 # Retrieving events:
243 # Retrieving events:
244 # Associated model(s) must implement the find_events class method.
244 # Associated model(s) must implement the find_events class method.
245 # ActiveRecord models can use acts_as_activity_provider as a way to implement this class method.
245 # ActiveRecord models can use acts_as_activity_provider as a way to implement this class method.
246 #
246 #
247 # The following call should return all the scrum events visible by current user that occured in the 5 last days:
247 # The following call should return all the scrum events visible by current user that occured in the 5 last days:
248 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today)
248 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today)
249 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only
249 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only
250 #
250 #
251 # Note that :view_scrums permission is required to view these events in the activity view.
251 # Note that :view_scrums permission is required to view these events in the activity view.
252 def activity_provider(*args)
252 def activity_provider(*args)
253 Redmine::Activity.register(*args)
253 Redmine::Activity.register(*args)
254 end
254 end
255
255
256 # Registers a wiki formatter.
256 # Registers a wiki formatter.
257 #
257 #
258 # Parameters:
258 # Parameters:
259 # * +name+ - human-readable name
259 # * +name+ - human-readable name
260 # * +formatter+ - formatter class, which should have an instance method +to_html+
260 # * +formatter+ - formatter class, which should have an instance method +to_html+
261 # * +helper+ - helper module, which will be included by wiki pages
261 # * +helper+ - helper module, which will be included by wiki pages
262 def wiki_format_provider(name, formatter, helper)
262 def wiki_format_provider(name, formatter, helper)
263 Redmine::WikiFormatting.register(name, formatter, helper)
263 Redmine::WikiFormatting.register(name, formatter, helper)
264 end
264 end
265
265
266 # Returns +true+ if the plugin can be configured.
266 # Returns +true+ if the plugin can be configured.
267 def configurable?
267 def configurable?
268 settings && settings.is_a?(Hash) && !settings[:partial].blank?
268 settings && settings.is_a?(Hash) && !settings[:partial].blank?
269 end
269 end
270 end
270 end
271 end
271 end
General Comments 0
You need to be logged in to leave comments. Login now