##// END OF EJS Templates
jro_apps » redmine
RSS
Code cleanup: implement Plugin#to_param for generating routes....
Jean-Philippe Lang -
r10766:c31f498ba6a2
parent child
Show More
Side by Side Unified
Context file:
r10766:c31f498ba6a2 Loading diff...:
Show file before | Show file after | Hide comments
@@ -1,66 +1,66
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2012 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 class SettingsController < ApplicationController
19 19 layout 'admin'
20 20 menu_item :plugins, :only => :plugin
21 21
22 22 before_filter :require_admin
23 23
24 24 def index
25 25 edit
26 26 render :action => 'edit'
27 27 end
28 28
29 29 def edit
30 30 @notifiables = Redmine::Notifiable.all
31 31 if request.post? && params[:settings] && params[:settings].is_a?(Hash)
32 32 settings = (params[:settings] || {}).dup.symbolize_keys
33 33 settings.each do |name, value|
34 34 # remove blank values in array settings
35 35 value.delete_if {|v| v.blank? } if value.is_a?(Array)
36 36 Setting[name] = value
37 37 end
38 38 flash[:notice] = l(:notice_successful_update)
39 39 redirect_to settings_path(:tab => params[:tab])
40 40 else
41 41 @options = {}
42 42 user_format = User::USER_FORMATS.collect{|key, value| [key, value[:setting_order]]}.sort{|a, b| a[1] <=> b[1]}
43 43 @options[:user_format] = user_format.collect{|f| [User.current.name(f[0]), f[0].to_s]}
44 44 @deliveries = ActionMailer::Base.perform_deliveries
45 45
46 46 @guessed_host_and_path = request.host_with_port.dup
47 47 @guessed_host_and_path << ('/'+ Redmine::Utils.relative_url_root.gsub(%r{^\/}, '')) unless Redmine::Utils.relative_url_root.blank?
48 48
49 49 Redmine::Themes.rescan
50 50 end
51 51 end
52 52
53 53 def plugin
54 54 @plugin = Redmine::Plugin.find(params[:id])
55 55 if request.post?
56 56 Setting.send "plugin_#{@plugin.id}=", params[:settings]
57 57 flash[:notice] = l(:notice_successful_update)
58 redirect_to plugin_settings_path(@plugin.id)
58 redirect_to plugin_settings_path(@plugin)
59 59 else
60 60 @partial = @plugin.settings[:partial]
61 61 @settings = Setting.send "plugin_#{@plugin.id}"
62 62 end
63 63 rescue Redmine::PluginNotFound
64 64 render_404
65 65 end
66 66 end
Show file before | Show file after | Hide comments
@@ -1,19 +1,19
1 1 <h2><%= l(:label_plugins) %></h2>
2 2
3 3 <% if @plugins.any? %>
4 4 <table class="list plugins">
5 5 <% @plugins.each do |plugin| %>
6 <tr class="<%= cycle('odd', 'even') %>">
6 <tr id="plugin-<%= plugin.id %>" class="<%= cycle('odd', 'even') %>">
7 7 <td><span class="name"><%=h plugin.name %></span>
8 8 <%= content_tag('span', h(plugin.description), :class => 'description') unless plugin.description.blank? %>
9 9 <%= content_tag('span', link_to(h(plugin.url), plugin.url), :class => 'url') unless plugin.url.blank? %>
10 10 </td>
11 11 <td class="author"><%= plugin.author_url.blank? ? h(plugin.author) : link_to(h(plugin.author), plugin.author_url) %></td>
12 12 <td class="version"><%=h plugin.version %></td>
13 <td class="configure"><%= link_to(l(:button_configure), :controller => 'settings', :action => 'plugin', :id => plugin.id) if plugin.configurable? %></td>
13 <td class="configure"><%= link_to(l(:button_configure), plugin_settings_path(plugin)) if plugin.configurable? %></td>
14 14 </tr>
15 15 <% end %>
16 16 </table>
17 17 <% else %>
18 18 <p class="nodata"><%= l(:label_no_data) %></p>
19 19 <% end %>
Show file before | Show file after | Hide comments
@@ -1,472 +1,476
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2012 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 module Redmine #:nodoc:
19 19
20 20 class PluginNotFound < StandardError; end
21 21 class PluginRequirementError < StandardError; end
22 22
23 23 # Base class for Redmine plugins.
24 24 # Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
25 25 #
26 26 # Redmine::Plugin.register :example do
27 27 # name 'Example plugin'
28 28 # author 'John Smith'
29 29 # description 'This is an example plugin for Redmine'
30 30 # version '0.0.1'
31 31 # settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
32 32 # end
33 33 #
34 34 # === Plugin attributes
35 35 #
36 36 # +settings+ is an optional attribute that let the plugin be configurable.
37 37 # It must be a hash with the following keys:
38 38 # * <tt>:default</tt>: default value for the plugin settings
39 39 # * <tt>:partial</tt>: path of the configuration partial view, relative to the plugin <tt>app/views</tt> directory
40 40 # Example:
41 41 # settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
42 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 44 # When rendered, the plugin settings value is available as the local variable +settings+
45 45 class Plugin
46 46 cattr_accessor :directory
47 47 self.directory = File.join(Rails.root, 'plugins')
48 48
49 49 cattr_accessor :public_directory
50 50 self.public_directory = File.join(Rails.root, 'public', 'plugin_assets')
51 51
52 52 @registered_plugins = {}
53 53 class << self
54 54 attr_reader :registered_plugins
55 55 private :new
56 56
57 57 def def_field(*names)
58 58 class_eval do
59 59 names.each do |name|
60 60 define_method(name) do |*args|
61 61 args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
62 62 end
63 63 end
64 64 end
65 65 end
66 66 end
67 67 def_field :name, :description, :url, :author, :author_url, :version, :settings
68 68 attr_reader :id
69 69
70 70 # Plugin constructor
71 71 def self.register(id, &block)
72 72 p = new(id)
73 73 p.instance_eval(&block)
74 74 # Set a default name if it was not provided during registration
75 75 p.name(id.to_s.humanize) if p.name.nil?
76 76
77 77 # Adds plugin locales if any
78 78 # YAML translation files should be found under <plugin>/config/locales/
79 79 ::I18n.load_path += Dir.glob(File.join(p.directory, 'config', 'locales', '*.yml'))
80 80
81 81 # Prepends the app/views directory of the plugin to the view path
82 82 view_path = File.join(p.directory, 'app', 'views')
83 83 if File.directory?(view_path)
84 84 ActionController::Base.prepend_view_path(view_path)
85 85 ActionMailer::Base.prepend_view_path(view_path)
86 86 end
87 87
88 88 # Adds the app/{controllers,helpers,models} directories of the plugin to the autoload path
89 89 Dir.glob File.expand_path(File.join(p.directory, 'app', '{controllers,helpers,models}')) do |dir|
90 90 ActiveSupport::Dependencies.autoload_paths += [dir]
91 91 end
92 92
93 93 registered_plugins[id] = p
94 94 end
95 95
96 96 # Returns an array of all registered plugins
97 97 def self.all
98 98 registered_plugins.values.sort
99 99 end
100 100
101 101 # Finds a plugin by its id
102 102 # Returns a PluginNotFound exception if the plugin doesn't exist
103 103 def self.find(id)
104 104 registered_plugins[id.to_sym] || raise(PluginNotFound)
105 105 end
106 106
107 107 # Clears the registered plugins hash
108 108 # It doesn't unload installed plugins
109 109 def self.clear
110 110 @registered_plugins = {}
111 111 end
112 112
113 113 # Checks if a plugin is installed
114 114 #
115 115 # @param [String] id name of the plugin
116 116 def self.installed?(id)
117 117 registered_plugins[id.to_sym].present?
118 118 end
119 119
120 120 def self.load
121 121 Dir.glob(File.join(self.directory, '*')).sort.each do |directory|
122 122 if File.directory?(directory)
123 123 lib = File.join(directory, "lib")
124 124 if File.directory?(lib)
125 125 $:.unshift lib
126 126 ActiveSupport::Dependencies.autoload_paths += [lib]
127 127 end
128 128 initializer = File.join(directory, "init.rb")
129 129 if File.file?(initializer)
130 130 require initializer
131 131 end
132 132 end
133 133 end
134 134 end
135 135
136 136 def initialize(id)
137 137 @id = id.to_sym
138 138 end
139 139
140 140 def directory
141 141 File.join(self.class.directory, id.to_s)
142 142 end
143 143
144 144 def public_directory
145 145 File.join(self.class.public_directory, id.to_s)
146 146 end
147 147
148 def to_param
149 id
150 end
151
148 152 def assets_directory
149 153 File.join(directory, 'assets')
150 154 end
151 155
152 156 def <=>(plugin)
153 157 self.id.to_s <=> plugin.id.to_s
154 158 end
155 159
156 160 # Sets a requirement on Redmine version
157 161 # Raises a PluginRequirementError exception if the requirement is not met
158 162 #
159 163 # Examples
160 164 # # Requires Redmine 0.7.3 or higher
161 165 # requires_redmine :version_or_higher => '0.7.3'
162 166 # requires_redmine '0.7.3'
163 167 #
164 168 # # Requires Redmine 0.7.x or higher
165 169 # requires_redmine '0.7'
166 170 #
167 171 # # Requires a specific Redmine version
168 172 # requires_redmine :version => '0.7.3' # 0.7.3 only
169 173 # requires_redmine :version => '0.7' # 0.7.x
170 174 # requires_redmine :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
171 175 #
172 176 # # Requires a Redmine version within a range
173 177 # requires_redmine :version => '0.7.3'..'0.9.1' # >= 0.7.3 and <= 0.9.1
174 178 # requires_redmine :version => '0.7'..'0.9' # >= 0.7.x and <= 0.9.x
175 179 def requires_redmine(arg)
176 180 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
177 181 arg.assert_valid_keys(:version, :version_or_higher)
178 182
179 183 current = Redmine::VERSION.to_a
180 184 arg.each do |k, req|
181 185 case k
182 186 when :version_or_higher
183 187 raise ArgumentError.new(":version_or_higher accepts a version string only") unless req.is_a?(String)
184 188 unless compare_versions(req, current) <= 0
185 189 raise PluginRequirementError.new("#{id} plugin requires Redmine #{req} or higher but current is #{current.join('.')}")
186 190 end
187 191 when :version
188 192 req = [req] if req.is_a?(String)
189 193 if req.is_a?(Array)
190 194 unless req.detect {|ver| compare_versions(ver, current) == 0}
191 195 raise PluginRequirementError.new("#{id} plugin requires one the following Redmine versions: #{req.join(', ')} but current is #{current.join('.')}")
192 196 end
193 197 elsif req.is_a?(Range)
194 198 unless compare_versions(req.first, current) <= 0 && compare_versions(req.last, current) >= 0
195 199 raise PluginRequirementError.new("#{id} plugin requires a Redmine version between #{req.first} and #{req.last} but current is #{current.join('.')}")
196 200 end
197 201 else
198 202 raise ArgumentError.new(":version option accepts a version string, an array or a range of versions")
199 203 end
200 204 end
201 205 end
202 206 true
203 207 end
204 208
205 209 def compare_versions(requirement, current)
206 210 requirement = requirement.split('.').collect(&:to_i)
207 211 requirement <=> current.slice(0, requirement.size)
208 212 end
209 213 private :compare_versions
210 214
211 215 # Sets a requirement on a Redmine plugin version
212 216 # Raises a PluginRequirementError exception if the requirement is not met
213 217 #
214 218 # Examples
215 219 # # Requires a plugin named :foo version 0.7.3 or higher
216 220 # requires_redmine_plugin :foo, :version_or_higher => '0.7.3'
217 221 # requires_redmine_plugin :foo, '0.7.3'
218 222 #
219 223 # # Requires a specific version of a Redmine plugin
220 224 # requires_redmine_plugin :foo, :version => '0.7.3' # 0.7.3 only
221 225 # requires_redmine_plugin :foo, :version => ['0.7.3', '0.8.0'] # 0.7.3 or 0.8.0
222 226 def requires_redmine_plugin(plugin_name, arg)
223 227 arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
224 228 arg.assert_valid_keys(:version, :version_or_higher)
225 229
226 230 plugin = Plugin.find(plugin_name)
227 231 current = plugin.version.split('.').collect(&:to_i)
228 232
229 233 arg.each do |k, v|
230 234 v = [] << v unless v.is_a?(Array)
231 235 versions = v.collect {|s| s.split('.').collect(&:to_i)}
232 236 case k
233 237 when :version_or_higher
234 238 raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
235 239 unless (current <=> versions.first) >= 0
236 240 raise PluginRequirementError.new("#{id} plugin requires the #{plugin_name} plugin #{v} or higher but current is #{current.join('.')}")
237 241 end
238 242 when :version
239 243 unless versions.include?(current.slice(0,3))
240 244 raise PluginRequirementError.new("#{id} plugin requires one the following versions of #{plugin_name}: #{v.join(', ')} but current is #{current.join('.')}")
241 245 end
242 246 end
243 247 end
244 248 true
245 249 end
246 250
247 251 # Adds an item to the given +menu+.
248 252 # The +id+ parameter (equals to the project id) is automatically added to the url.
249 253 # menu :project_menu, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
250 254 #
251 255 # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
252 256 #
253 257 def menu(menu, item, url, options={})
254 258 Redmine::MenuManager.map(menu).push(item, url, options)
255 259 end
256 260 alias :add_menu_item :menu
257 261
258 262 # Removes +item+ from the given +menu+.
259 263 def delete_menu_item(menu, item)
260 264 Redmine::MenuManager.map(menu).delete(item)
261 265 end
262 266
263 267 # Defines a permission called +name+ for the given +actions+.
264 268 #
265 269 # The +actions+ argument is a hash with controllers as keys and actions as values (a single value or an array):
266 270 # permission :destroy_contacts, { :contacts => :destroy }
267 271 # permission :view_contacts, { :contacts => [:index, :show] }
268 272 #
269 273 # The +options+ argument is a hash that accept the following keys:
270 274 # * :public => the permission is public if set to true (implicitly given to any user)
271 275 # * :require => can be set to one of the following values to restrict users the permission can be given to: :loggedin, :member
272 276 # * :read => set it to true so that the permission is still granted on closed projects
273 277 #
274 278 # Examples
275 279 # # A permission that is implicitly given to any user
276 280 # # This permission won't appear on the Roles & Permissions setup screen
277 281 # permission :say_hello, { :example => :say_hello }, :public => true, :read => true
278 282 #
279 283 # # A permission that can be given to any user
280 284 # permission :say_hello, { :example => :say_hello }
281 285 #
282 286 # # A permission that can be given to registered users only
283 287 # permission :say_hello, { :example => :say_hello }, :require => :loggedin
284 288 #
285 289 # # A permission that can be given to project members only
286 290 # permission :say_hello, { :example => :say_hello }, :require => :member
287 291 def permission(name, actions, options = {})
288 292 if @project_module
289 293 Redmine::AccessControl.map {|map| map.project_module(@project_module) {|map|map.permission(name, actions, options)}}
290 294 else
291 295 Redmine::AccessControl.map {|map| map.permission(name, actions, options)}
292 296 end
293 297 end
294 298
295 299 # Defines a project module, that can be enabled/disabled for each project.
296 300 # Permissions defined inside +block+ will be bind to the module.
297 301 #
298 302 # project_module :things do
299 303 # permission :view_contacts, { :contacts => [:list, :show] }, :public => true
300 304 # permission :destroy_contacts, { :contacts => :destroy }
301 305 # end
302 306 def project_module(name, &block)
303 307 @project_module = name
304 308 self.instance_eval(&block)
305 309 @project_module = nil
306 310 end
307 311
308 312 # Registers an activity provider.
309 313 #
310 314 # Options:
311 315 # * <tt>:class_name</tt> - one or more model(s) that provide these events (inferred from event_type by default)
312 316 # * <tt>:default</tt> - setting this option to false will make the events not displayed by default
313 317 #
314 318 # A model can provide several activity event types.
315 319 #
316 320 # Examples:
317 321 # register :news
318 322 # register :scrums, :class_name => 'Meeting'
319 323 # register :issues, :class_name => ['Issue', 'Journal']
320 324 #
321 325 # Retrieving events:
322 326 # Associated model(s) must implement the find_events class method.
323 327 # ActiveRecord models can use acts_as_activity_provider as a way to implement this class method.
324 328 #
325 329 # The following call should return all the scrum events visible by current user that occured in the 5 last days:
326 330 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today)
327 331 # Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only
328 332 #
329 333 # Note that :view_scrums permission is required to view these events in the activity view.
330 334 def activity_provider(*args)
331 335 Redmine::Activity.register(*args)
332 336 end
333 337
334 338 # Registers a wiki formatter.
335 339 #
336 340 # Parameters:
337 341 # * +name+ - human-readable name
338 342 # * +formatter+ - formatter class, which should have an instance method +to_html+
339 343 # * +helper+ - helper module, which will be included by wiki pages
340 344 def wiki_format_provider(name, formatter, helper)
341 345 Redmine::WikiFormatting.register(name, formatter, helper)
342 346 end
343 347
344 348 # Returns +true+ if the plugin can be configured.
345 349 def configurable?
346 350 settings && settings.is_a?(Hash) && !settings[:partial].blank?
347 351 end
348 352
349 353 def mirror_assets
350 354 source = assets_directory
351 355 destination = public_directory
352 356 return unless File.directory?(source)
353 357
354 358 source_files = Dir[source + "/**/*"]
355 359 source_dirs = source_files.select { |d| File.directory?(d) }
356 360 source_files -= source_dirs
357 361
358 362 unless source_files.empty?
359 363 base_target_dir = File.join(destination, File.dirname(source_files.first).gsub(source, ''))
360 364 begin
361 365 FileUtils.mkdir_p(base_target_dir)
362 366 rescue Exception => e
363 367 raise "Could not create directory #{base_target_dir}: " + e.message
364 368 end
365 369 end
366 370
367 371 source_dirs.each do |dir|
368 372 # strip down these paths so we have simple, relative paths we can
369 373 # add to the destination
370 374 target_dir = File.join(destination, dir.gsub(source, ''))
371 375 begin
372 376 FileUtils.mkdir_p(target_dir)
373 377 rescue Exception => e
374 378 raise "Could not create directory #{target_dir}: " + e.message
375 379 end
376 380 end
377 381
378 382 source_files.each do |file|
379 383 begin
380 384 target = File.join(destination, file.gsub(source, ''))
381 385 unless File.exist?(target) && FileUtils.identical?(file, target)
382 386 FileUtils.cp(file, target)
383 387 end
384 388 rescue Exception => e
385 389 raise "Could not copy #{file} to #{target}: " + e.message
386 390 end
387 391 end
388 392 end
389 393
390 394 # Mirrors assets from one or all plugins to public/plugin_assets
391 395 def self.mirror_assets(name=nil)
392 396 if name.present?
393 397 find(name).mirror_assets
394 398 else
395 399 all.each do |plugin|
396 400 plugin.mirror_assets
397 401 end
398 402 end
399 403 end
400 404
401 405 # The directory containing this plugin's migrations (<tt>plugin/db/migrate</tt>)
402 406 def migration_directory
403 407 File.join(Rails.root, 'plugins', id.to_s, 'db', 'migrate')
404 408 end
405 409
406 410 # Returns the version number of the latest migration for this plugin. Returns
407 411 # nil if this plugin has no migrations.
408 412 def latest_migration
409 413 migrations.last
410 414 end
411 415
412 416 # Returns the version numbers of all migrations for this plugin.
413 417 def migrations
414 418 migrations = Dir[migration_directory+"/*.rb"]
415 419 migrations.map { |p| File.basename(p).match(/0*(\d+)\_/)[1].to_i }.sort
416 420 end
417 421
418 422 # Migrate this plugin to the given version
419 423 def migrate(version = nil)
420 424 puts "Migrating #{id} (#{name})..."
421 425 Redmine::Plugin::Migrator.migrate_plugin(self, version)
422 426 end
423 427
424 428 # Migrates all plugins or a single plugin to a given version
425 429 # Exemples:
426 430 # Plugin.migrate
427 431 # Plugin.migrate('sample_plugin')
428 432 # Plugin.migrate('sample_plugin', 1)
429 433 #
430 434 def self.migrate(name=nil, version=nil)
431 435 if name.present?
432 436 find(name).migrate(version)
433 437 else
434 438 all.each do |plugin|
435 439 plugin.migrate
436 440 end
437 441 end
438 442 end
439 443
440 444 class Migrator < ActiveRecord::Migrator
441 445 # We need to be able to set the 'current' plugin being migrated.
442 446 cattr_accessor :current_plugin
443 447
444 448 class << self
445 449 # Runs the migrations from a plugin, up (or down) to the version given
446 450 def migrate_plugin(plugin, version)
447 451 self.current_plugin = plugin
448 452 return if current_version(plugin) == version
449 453 migrate(plugin.migration_directory, version)
450 454 end
451 455
452 456 def current_version(plugin=current_plugin)
453 457 # Delete migrations that don't match .. to_i will work because the number comes first
454 458 ::ActiveRecord::Base.connection.select_values(
455 459 "SELECT version FROM #{schema_migrations_table_name}"
456 460 ).delete_if{ |v| v.match(/-#{plugin.id}/) == nil }.map(&:to_i).max || 0
457 461 end
458 462 end
459 463
460 464 def migrated
461 465 sm_table = self.class.schema_migrations_table_name
462 466 ::ActiveRecord::Base.connection.select_values(
463 467 "SELECT version FROM #{sm_table}"
464 468 ).delete_if{ |v| v.match(/-#{current_plugin.id}/) == nil }.map(&:to_i).sort
465 469 end
466 470
467 471 def record_version_state_after_migrating(version)
468 472 super(version.to_s + "-" + current_plugin.id.to_s)
469 473 end
470 474 end
471 475 end
472 476 end
Show file before | Show file after | Hide comments
@@ -1,164 +1,167
1 1 # Redmine - project management software
2 2 # Copyright (C) 2006-2012 Jean-Philippe Lang
3 3 #
4 4 # This program is free software; you can redistribute it and/or
5 5 # modify it under the terms of the GNU General Public License
6 6 # as published by the Free Software Foundation; either version 2
7 7 # of the License, or (at your option) any later version.
8 8 #
9 9 # This program is distributed in the hope that it will be useful,
10 10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 12 # GNU General Public License for more details.
13 13 #
14 14 # You should have received a copy of the GNU General Public License
15 15 # along with this program; if not, write to the Free Software
16 16 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17 17
18 18 require File.expand_path('../../test_helper', __FILE__)
19 19
20 20 class AdminControllerTest < ActionController::TestCase
21 21 fixtures :projects, :users, :roles
22 22
23 23 def setup
24 24 User.current = nil
25 25 @request.session[:user_id] = 1 # admin
26 26 end
27 27
28 28 def test_index
29 29 get :index
30 assert_no_tag :tag => 'div',
31 :attributes => { :class => /nodata/ }
30 assert_select 'div.nodata', 0
32 31 end
33 32
34 33 def test_index_with_no_configuration_data
35 34 delete_configuration_data
36 35 get :index
37 assert_tag :tag => 'div',
38 :attributes => { :class => /nodata/ }
36 assert_select 'div.nodata'
39 37 end
40 38
41 39 def test_projects
42 40 get :projects
43 41 assert_response :success
44 42 assert_template 'projects'
45 43 assert_not_nil assigns(:projects)
46 44 # active projects only
47 45 assert_nil assigns(:projects).detect {|u| !u.active?}
48 46 end
49 47
50 48 def test_projects_with_status_filter
51 49 get :projects, :status => 1
52 50 assert_response :success
53 51 assert_template 'projects'
54 52 assert_not_nil assigns(:projects)
55 53 # active projects only
56 54 assert_nil assigns(:projects).detect {|u| !u.active?}
57 55 end
58 56
59 57 def test_projects_with_name_filter
60 58 get :projects, :name => 'store', :status => ''
61 59 assert_response :success
62 60 assert_template 'projects'
63 61 projects = assigns(:projects)
64 62 assert_not_nil projects
65 63 assert_equal 1, projects.size
66 64 assert_equal 'OnlineStore', projects.first.name
67 65 end
68 66
69 67 def test_load_default_configuration_data
70 68 delete_configuration_data
71 69 post :default_configuration, :lang => 'fr'
72 70 assert_response :redirect
73 71 assert_nil flash[:error]
74 72 assert IssueStatus.find_by_name('Nouveau')
75 73 end
76 74
77 75 def test_load_default_configuration_data_should_rescue_error
78 76 delete_configuration_data
79 77 Redmine::DefaultData::Loader.stubs(:load).raises(Exception.new("Something went wrong"))
80 78 post :default_configuration, :lang => 'fr'
81 79 assert_response :redirect
82 80 assert_not_nil flash[:error]
83 81 assert_match /Something went wrong/, flash[:error]
84 82 end
85 83
86 84 def test_test_email
87 85 user = User.find(1)
88 86 user.pref[:no_self_notified] = '1'
89 87 user.pref.save!
90 88 ActionMailer::Base.deliveries.clear
91 89
92 90 get :test_email
93 91 assert_redirected_to '/settings?tab=notifications'
94 92 mail = ActionMailer::Base.deliveries.last
95 93 assert_not_nil mail
96 94 user = User.find(1)
97 95 assert_equal [user.mail], mail.bcc
98 96 end
99 97
100 98 def test_test_email_failure_should_display_the_error
101 99 Mailer.stubs(:test_email).raises(Exception, 'Some error message')
102 100 get :test_email
103 101 assert_redirected_to '/settings?tab=notifications'
104 102 assert_match /Some error message/, flash[:error]
105 103 end
106 104
107 105 def test_no_plugins
108 106 Redmine::Plugin.clear
109 107
110 108 get :plugins
111 109 assert_response :success
112 110 assert_template 'plugins'
113 111 end
114 112
115 113 def test_plugins
116 114 # Register a few plugins
117 115 Redmine::Plugin.register :foo do
118 116 name 'Foo plugin'
119 117 author 'John Smith'
120 118 description 'This is a test plugin'
121 119 version '0.0.1'
122 120 settings :default => {'sample_setting' => 'value', 'foo'=>'bar'}, :partial => 'foo/settings'
123 121 end
124 122 Redmine::Plugin.register :bar do
125 123 end
126 124
127 125 get :plugins
128 126 assert_response :success
129 127 assert_template 'plugins'
130 128
131 assert_tag :td, :child => { :tag => 'span', :content => 'Foo plugin' }
132 assert_tag :td, :child => { :tag => 'span', :content => 'Bar' }
129 assert_select 'tr#plugin-foo' do
130 assert_select 'td span.name', :text => 'Foo plugin'
131 assert_select 'td.configure a[href=/settings/plugin/foo]'
132 end
133 assert_select 'tr#plugin-bar' do
134 assert_select 'td span.name', :text => 'Bar'
135 assert_select 'td.configure a', 0
136 end
133 137 end
134 138
135 139 def test_info
136 140 get :info
137 141 assert_response :success
138 142 assert_template 'info'
139 143 end
140 144
141 145 def test_admin_menu_plugin_extension
142 146 Redmine::MenuManager.map :admin_menu do |menu|
143 147 menu.push :test_admin_menu_plugin_extension, '/foo/bar', :caption => 'Test'
144 148 end
145 149
146 150 get :index
147 151 assert_response :success
148 assert_tag :a, :attributes => { :href => '/foo/bar' },
149 :content => 'Test'
152 assert_select 'div#admin-menu a[href=/foo/bar]', :text => 'Test'
150 153
151 154 Redmine::MenuManager.map :admin_menu do |menu|
152 155 menu.delete :test_admin_menu_plugin_extension
153 156 end
154 157 end
155 158
156 159 private
157 160
158 161 def delete_configuration_data
159 162 Role.delete_all('builtin = 0')
160 163 Tracker.delete_all
161 164 IssueStatus.delete_all
162 165 Enumeration.delete_all
163 166 end
164 167 end
General Comments 0
You need to be logged in to leave comments. Login now