jro_apps/redmine Commit - r13337:ca71cf380046

Adds methods for loading and adding settings....

Jean-Philippe Lang -

r13337:ca71cf380046

parent child

Context file:

r13337:ca71cf380046

Collapse all files

app/models/setting.rb +52 -32

             # Redmine - project management software
             # Copyright (C) 2006-2014  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             class Setting < ActiveRecord::Base
               DATE_FORMATS = [
                     '%Y-%m-%d',
                     '%d/%m/%Y',
                     '%d.%m.%Y',
                     '%d-%m-%Y',
                     '%m/%d/%Y',
                     '%d %b %Y',
                     '%d %B %Y',
                     '%b %d, %Y',
                     '%B %d, %Y'
                 ]
               TIME_FORMATS = [
                 '%H:%M',
                 '%I:%M %p'
                 ]
               ENCODINGS = %w(US-ASCII
                               windows-1250
                               windows-1251
                               windows-1252
                               windows-1253
                               windows-1254
                               windows-1255
                               windows-1256
                               windows-1257
                               windows-1258
                               windows-31j
                               ISO-2022-JP
                               ISO-2022-KR
                               ISO-8859-1
                               ISO-8859-2
                               ISO-8859-3
                               ISO-8859-4
                               ISO-8859-5
                               ISO-8859-6
                               ISO-8859-7
                               ISO-8859-8
                               ISO-8859-9
                               ISO-8859-13
                               ISO-8859-15
                               KOI8-R
                               UTF-8
                               UTF-16
                               UTF-16BE
                               UTF-16LE
                               EUC-JP
                               Shift_JIS
                               CP932
                               GB18030
                               GBK
                               ISCII91
                               EUC-KR
                               Big5
                               Big5-HKSCS
                               TIS-620)
               cattr_accessor :available_settings
-              @@available_settings = YAML::load(File.open("#{Rails.root}/config/settings.yml"))
+              self.available_settings ||= {}
-              Redmine::Plugin.all.each do |plugin|
-                next unless plugin.settings
-                @@available_settings["plugin_#{plugin.id}"] = {'default' => plugin.settings[:default], 'serialized' => true}
-              end
               validates_uniqueness_of :name
-              validates_inclusion_of :name, :in => @@available_settings.keys
+              validates_inclusion_of :name, :in => Proc.new {available_settings.keys}
               validates_numericality_of :value, :only_integer => true, :if => Proc.new { |setting|
-                (s = @@available_settings[setting.name]) && s['format'] == 'int'
+                (s = available_settings[setting.name]) && s['format'] == 'int'
               }
               attr_protected :id
               # Hash used to cache setting values
               @cached_settings = {}
               @cached_cleared_on = Time.now
               def value
                 v = read_attribute(:value)
                 # Unserialize serialized settings
-                v = YAML::load(v) if @@available_settings[name]['serialized'] && v.is_a?(String)
+                v = YAML::load(v) if available_settings[name]['serialized'] && v.is_a?(String)
-                v = v.to_sym if @@available_settings[name]['format'] == 'symbol' && !v.blank?
+                v = v.to_sym if available_settings[name]['format'] == 'symbol' && !v.blank?
                 v
               end
               def value=(v)
-                v = v.to_yaml if v && @@available_settings[name] && @@available_settings[name]['serialized']
+                v = v.to_yaml if v && available_settings[name] && available_settings[name]['serialized']
                 write_attribute(:value, v.to_s)
               end
               # Returns the value of the setting named name
               def self.[](name)
                 v = @cached_settings[name]
                 v ? v : (@cached_settings[name] = find_or_default(name).value)
               end
               def self.[]=(name, v)
                 setting = find_or_default(name)
                 setting.value = (v ? v : "")
                 @cached_settings[name] = nil
                 setting.save
                 setting.value
               end
-              # Defines getter and setter for each setting
-              # Then setting values can be read using: Setting.some_setting_name
-              # or set using Setting.some_setting_name = "some value"
-              @@available_settings.each do |name, params|
-                src = <<-END_SRC
-                def self.#{name}
-                  self[:#{name}]
-                end
-                def self.#{name}?
-                  self[:#{name}].to_i > 0
-                end
-                def self.#{name}=(value)
-                  self[:#{name}] = value
-                end
-            END_SRC
-                class_eval src, __FILE__, __LINE__
-              end
               # Sets a setting value from params
               def self.set_from_params(name, params)
                 params = params.dup
                 params.delete_if {|v| v.blank? } if params.is_a?(Array)
                 params.symbolize_keys! if params.is_a?(Hash)
                 m = "#{name}_from_params"
                 if respond_to? m
                   self[name.to_sym] = send m, params
                 else
                   self[name.to_sym] = params
                 end
               end
               # Returns a hash suitable for commit_update_keywords setting
               #
               # Example:
               # params = {:keywords => ['fixes', 'closes'], :status_id => ["3", "5"], :done_ratio => ["", "100"]}
               # Setting.commit_update_keywords_from_params(params)
               # # => [{'keywords => 'fixes', 'status_id' => "3"}, {'keywords => 'closes', 'status_id' => "5", 'done_ratio' => "100"}]
               def self.commit_update_keywords_from_params(params)
                 s = []
                 if params.is_a?(Hash) && params.key?(:keywords) && params.values.all? {|v| v.is_a? Array}
                   attributes = params.except(:keywords).keys
                   params[:keywords].each_with_index do |keywords, i|
                     next if keywords.blank?
                     s << attributes.inject({}) {|h, a|
                       value = params[a][i].to_s
                       h[a.to_s] = value if value.present?
                       h
                     }.merge('keywords' => keywords)
                   end
                 end
                 s
               end
               # Helper that returns an array based on per_page_options setting
               def self.per_page_options_array
                 per_page_options.split(%r{[\s,]}).collect(&:to_i).select {|n| n > 0}.sort
               end
               # Helper that returns a Hash with single update keywords as keys
               def self.commit_update_keywords_array
                 a = []
                 if commit_update_keywords.is_a?(Array)
                   commit_update_keywords.each do |rule|
                     next unless rule.is_a?(Hash)
                     rule = rule.dup
                     rule.delete_if {|k, v| v.blank?}
                     keywords = rule['keywords'].to_s.downcase.split(",").map(&:strip).reject(&:blank?)
                     next if keywords.empty?
                     a << rule.merge('keywords' => keywords)
                   end
                 end
                 a
               end
               def self.openid?
                 Object.const_defined?(:OpenID) && self[:openid].to_i > 0
               end
               # Checks if settings have changed since the values were read
               # and clears the cache hash if it's the case
               # Called once per request
               def self.check_cache
                 settings_updated_on = Setting.maximum(:updated_on)
                 if settings_updated_on && @cached_cleared_on <= settings_updated_on
                   clear_cache
                 end
               end
               # Clears the settings cache
               def self.clear_cache
                 @cached_settings.clear
                 @cached_cleared_on = Time.now
                 logger.info "Settings cache cleared." if logger
               end
+              def self.define_plugin_setting(plugin)
+                if plugin.settings
+                  name = "plugin_#{plugin.id}"
+                  define_setting name, {'default' => plugin.settings[:default], 'serialized' => true}
+                end
+              end
+              # Defines getter and setter for each setting
+              # Then setting values can be read using: Setting.some_setting_name
+              # or set using Setting.some_setting_name = "some value"
+              def self.define_setting(name, options={})
+                available_settings[name.to_s] = options
+                src = <<-END_SRC
+                def self.#{name}
+                  self[:#{name}]
+                end
+                def self.#{name}?
+                  self[:#{name}].to_i > 0
+                end
+                def self.#{name}=(value)
+                  self[:#{name}] = value
+                end
+            END_SRC
+                class_eval src, __FILE__, __LINE__
+              end
+              def self.load_available_settings
+                YAML::load(File.open("#{Rails.root}/config/settings.yml")).each do |name, options|
+                  define_setting name, options
+                end
+              end
+              def self.load_plugin_settings
+                Redmine::Plugin.all.each do |plugin|
+                  define_plugin_setting(plugin)
+                end
+              end
+              load_available_settings
+              load_plugin_settings
             private
               # Returns the Setting instance for the setting named name
               # (record found in database or new record with default value)
               def self.find_or_default(name)
                 name = name.to_s
-                raise "There's no setting named #{name}" unless @@available_settings.has_key?(name)
+                raise "There's no setting named #{name}" unless available_settings.has_key?(name)
                 setting = where(:name => name).first
                 unless setting
                   setting = new
                   setting.name = name
-                  setting.value = @@available_settings[name]['default']
+                  setting.value = available_settings[name]['default']
                 end
                 setting
               end
             end

lib/redmine/plugin.rb +5 0

             # Redmine - project management software
             # Copyright (C) 2006-2014  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             module Redmine #:nodoc:
               class PluginNotFound < StandardError; end
               class PluginRequirementError < StandardError; end
               # Base class for Redmine plugins.
               # Plugins are registered using the <tt>register</tt> class method that acts as the public constructor.
               #
               #   Redmine::Plugin.register :example do
               #     name 'Example plugin'
               #     author 'John Smith'
               #     description 'This is an example plugin for Redmine'
               #     version '0.0.1'
               #     settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
               #   end
               #
               # === Plugin attributes
               #
               # +settings+ is an optional attribute that let the plugin be configurable.
               # It must be a hash with the following keys:
               # * <tt>:default</tt>: default value for the plugin settings
               # * <tt>:partial</tt>: path of the configuration partial view, relative to the plugin <tt>app/views</tt> directory
               # Example:
               #   settings :default => {'foo'=>'bar'}, :partial => 'settings/settings'
               # In this example, the settings partial will be found here in the plugin directory: <tt>app/views/settings/_settings.rhtml</tt>.
               #
               # When rendered, the plugin settings value is available as the local variable +settings+
               class Plugin
                 cattr_accessor :directory
                 self.directory = File.join(Rails.root, 'plugins')
                 cattr_accessor :public_directory
                 self.public_directory = File.join(Rails.root, 'public', 'plugin_assets')
                 @registered_plugins = {}
                 @used_partials = {}
                 class << self
                   attr_reader :registered_plugins
                   private :new
                   def def_field(*names)
                     class_eval do
                       names.each do |name|
                         define_method(name) do |*args|
                           args.empty? ? instance_variable_get("@#{name}") : instance_variable_set("@#{name}", *args)
                         end
                       end
                     end
                   end
                 end
                 def_field :name, :description, :url, :author, :author_url, :version, :settings, :directory
                 attr_reader :id
                 # Plugin constructor
                 def self.register(id, &block)
                   p = new(id)
                   p.instance_eval(&block)
                   # Set a default name if it was not provided during registration
                   p.name(id.to_s.humanize) if p.name.nil?
                   # Set a default directory if it was not provided during registration
                   p.directory(File.join(self.directory, id.to_s)) if p.directory.nil?
                   # Adds plugin locales if any
                   # YAML translation files should be found under <plugin>/config/locales/
                   Rails.application.config.i18n.load_path += Dir.glob(File.join(p.directory, 'config', 'locales', '*.yml'))
                   # Prepends the app/views directory of the plugin to the view path
                   view_path = File.join(p.directory, 'app', 'views')
                   if File.directory?(view_path)
                     ActionController::Base.prepend_view_path(view_path)
                     ActionMailer::Base.prepend_view_path(view_path)
                   end
                   # Adds the app/{controllers,helpers,models} directories of the plugin to the autoload path
                   Dir.glob File.expand_path(File.join(p.directory, 'app', '{controllers,helpers,models}')) do |dir|
                     ActiveSupport::Dependencies.autoload_paths += [dir]
                   end
+                  # Defines plugin setting if present
+                  if p.settings
+                    Setting.define_plugin_setting p
+                  end
                   # Warn for potential settings[:partial] collisions
                   if p.configurable?
                     partial = p.settings[:partial]
                     if @used_partials[partial]
                       Rails.logger.warn "WARNING: settings partial '#{partial}' is declared in '#{p.id}' plugin but it is already used by plugin '#{@used_partials[partial]}'. Only one settings view will be used. You may want to contact those plugins authors to fix this."
                     end
                     @used_partials[partial] = p.id
                   end
                   registered_plugins[id] = p
                 end
                 # Returns an array of all registered plugins
                 def self.all
                   registered_plugins.values.sort
                 end
                 # Finds a plugin by its id
                 # Returns a PluginNotFound exception if the plugin doesn't exist
                 def self.find(id)
                   registered_plugins[id.to_sym] || raise(PluginNotFound)
                 end
                 # Clears the registered plugins hash
                 # It doesn't unload installed plugins
                 def self.clear
                   @registered_plugins = {}
                 end
                 # Removes a plugin from the registered plugins
                 # It doesn't unload the plugin
                 def self.unregister(id)
                   @registered_plugins.delete(id)
                 end
                 # Checks if a plugin is installed
                 #
                 # @param [String] id name of the plugin
                 def self.installed?(id)
                   registered_plugins[id.to_sym].present?
                 end
                 def self.load
                   Dir.glob(File.join(self.directory, '*')).sort.each do |directory|
                     if File.directory?(directory)
                       lib = File.join(directory, "lib")
                       if File.directory?(lib)
                         $:.unshift lib
                         ActiveSupport::Dependencies.autoload_paths += [lib]
                       end
                       initializer = File.join(directory, "init.rb")
                       if File.file?(initializer)
                         require initializer
                       end
                     end
                   end
                 end
                 def initialize(id)
                   @id = id.to_sym
                 end
                 def public_directory
                   File.join(self.class.public_directory, id.to_s)
                 end
                 def to_param
                   id
                 end
                 def assets_directory
                   File.join(directory, 'assets')
                 end
                 def <=>(plugin)
                   self.id.to_s <=> plugin.id.to_s
                 end
                 # Sets a requirement on Redmine version
                 # Raises a PluginRequirementError exception if the requirement is not met
                 #
                 # Examples
                 #   # Requires Redmine 0.7.3 or higher
                 #   requires_redmine :version_or_higher => '0.7.3'
                 #   requires_redmine '0.7.3'
                 #
                 #   # Requires Redmine 0.7.x or higher
                 #   requires_redmine '0.7'
                 #
                 #   # Requires a specific Redmine version
                 #   requires_redmine :version => '0.7.3'              # 0.7.3 only
                 #   requires_redmine :version => '0.7'                # 0.7.x
                 #   requires_redmine :version => ['0.7.3', '0.8.0']   # 0.7.3 or 0.8.0
                 #
                 #   # Requires a Redmine version within a range
                 #   requires_redmine :version => '0.7.3'..'0.9.1'     # >= 0.7.3 and <= 0.9.1
                 #   requires_redmine :version => '0.7'..'0.9'         # >= 0.7.x and <= 0.9.x
                 def requires_redmine(arg)
                   arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
                   arg.assert_valid_keys(:version, :version_or_higher)
                   current = Redmine::VERSION.to_a
                   arg.each do |k, req|
                     case k
                     when :version_or_higher
                       raise ArgumentError.new(":version_or_higher accepts a version string only") unless req.is_a?(String)
                       unless compare_versions(req, current) <= 0
                         raise PluginRequirementError.new("#{id} plugin requires Redmine #{req} or higher but current is #{current.join('.')}")
                       end
                     when :version
                       req = [req] if req.is_a?(String)
                       if req.is_a?(Array)
                         unless req.detect {|ver| compare_versions(ver, current) == 0}
                           raise PluginRequirementError.new("#{id} plugin requires one the following Redmine versions: #{req.join(', ')} but current is #{current.join('.')}")
                         end
                       elsif req.is_a?(Range)
                         unless compare_versions(req.first, current) <= 0 && compare_versions(req.last, current) >= 0
                           raise PluginRequirementError.new("#{id} plugin requires a Redmine version between #{req.first} and #{req.last} but current is #{current.join('.')}")
                         end
                       else
                         raise ArgumentError.new(":version option accepts a version string, an array or a range of versions")
                       end
                     end
                   end
                   true
                 end
                 def compare_versions(requirement, current)
                   requirement = requirement.split('.').collect(&:to_i)
                   requirement <=> current.slice(0, requirement.size)
                 end
                 private :compare_versions
                 # Sets a requirement on a Redmine plugin version
                 # Raises a PluginRequirementError exception if the requirement is not met
                 #
                 # Examples
                 #   # Requires a plugin named :foo version 0.7.3 or higher
                 #   requires_redmine_plugin :foo, :version_or_higher => '0.7.3'
                 #   requires_redmine_plugin :foo, '0.7.3'
                 #
                 #   # Requires a specific version of a Redmine plugin
                 #   requires_redmine_plugin :foo, :version => '0.7.3'              # 0.7.3 only
                 #   requires_redmine_plugin :foo, :version => ['0.7.3', '0.8.0']   # 0.7.3 or 0.8.0
                 def requires_redmine_plugin(plugin_name, arg)
                   arg = { :version_or_higher => arg } unless arg.is_a?(Hash)
                   arg.assert_valid_keys(:version, :version_or_higher)
                   plugin = Plugin.find(plugin_name)
                   current = plugin.version.split('.').collect(&:to_i)
                   arg.each do |k, v|
                     v = [] << v unless v.is_a?(Array)
                     versions = v.collect {|s| s.split('.').collect(&:to_i)}
                     case k
                     when :version_or_higher
                       raise ArgumentError.new("wrong number of versions (#{versions.size} for 1)") unless versions.size == 1
                       unless (current <=> versions.first) >= 0
                         raise PluginRequirementError.new("#{id} plugin requires the #{plugin_name} plugin #{v} or higher but current is #{current.join('.')}")
                       end
                     when :version
                       unless versions.include?(current.slice(0,3))
                         raise PluginRequirementError.new("#{id} plugin requires one the following versions of #{plugin_name}: #{v.join(', ')} but current is #{current.join('.')}")
                       end
                     end
                   end
                   true
                 end
                 # Adds an item to the given +menu+.
                 # The +id+ parameter (equals to the project id) is automatically added to the url.
                 #   menu :project_menu, :plugin_example, { :controller => 'example', :action => 'say_hello' }, :caption => 'Sample'
                 #
                 # +name+ parameter can be: :top_menu, :account_menu, :application_menu or :project_menu
                 #
                 def menu(menu, item, url, options={})
                   Redmine::MenuManager.map(menu).push(item, url, options)
                 end
                 alias :add_menu_item :menu
                 # Removes +item+ from the given +menu+.
                 def delete_menu_item(menu, item)
                   Redmine::MenuManager.map(menu).delete(item)
                 end
                 # Defines a permission called +name+ for the given +actions+.
                 #
                 # The +actions+ argument is a hash with controllers as keys and actions as values (a single value or an array):
                 #   permission :destroy_contacts, { :contacts => :destroy }
                 #   permission :view_contacts, { :contacts => [:index, :show] }
                 #
                 # The +options+ argument is a hash that accept the following keys:
                 # * :public => the permission is public if set to true (implicitly given to any user)
                 # * :require => can be set to one of the following values to restrict users the permission can be given to: :loggedin, :member
                 # * :read => set it to true so that the permission is still granted on closed projects
                 #
                 # Examples
                 #   # A permission that is implicitly given to any user
                 #   # This permission won't appear on the Roles & Permissions setup screen
                 #   permission :say_hello, { :example => :say_hello }, :public => true, :read => true
                 #
                 #   # A permission that can be given to any user
                 #   permission :say_hello, { :example => :say_hello }
                 #
                 #   # A permission that can be given to registered users only
                 #   permission :say_hello, { :example => :say_hello }, :require => :loggedin
                 #
                 #   # A permission that can be given to project members only
                 #   permission :say_hello, { :example => :say_hello }, :require => :member
                 def permission(name, actions, options = {})
                   if @project_module
                     Redmine::AccessControl.map {|map| map.project_module(@project_module) {|map|map.permission(name, actions, options)}}
                   else
                     Redmine::AccessControl.map {|map| map.permission(name, actions, options)}
                   end
                 end
                 # Defines a project module, that can be enabled/disabled for each project.
                 # Permissions defined inside +block+ will be bind to the module.
                 #
                 #   project_module :things do
                 #     permission :view_contacts, { :contacts => [:list, :show] }, :public => true
                 #     permission :destroy_contacts, { :contacts => :destroy }
                 #   end
                 def project_module(name, &block)
                   @project_module = name
                   self.instance_eval(&block)
                   @project_module = nil
                 end
                 # Registers an activity provider.
                 #
                 # Options:
                 # * <tt>:class_name</tt> - one or more model(s) that provide these events (inferred from event_type by default)
                 # * <tt>:default</tt> - setting this option to false will make the events not displayed by default
                 #
                 # A model can provide several activity event types.
                 #
                 # Examples:
                 #   register :news
                 #   register :scrums, :class_name => 'Meeting'
                 #   register :issues, :class_name => ['Issue', 'Journal']
                 #
                 # Retrieving events:
                 # Associated model(s) must implement the find_events class method.
                 # ActiveRecord models can use acts_as_activity_provider as a way to implement this class method.
                 #
                 # The following call should return all the scrum events visible by current user that occurred in the 5 last days:
                 #   Meeting.find_events('scrums', User.current, 5.days.ago, Date.today)
                 #   Meeting.find_events('scrums', User.current, 5.days.ago, Date.today, :project => foo) # events for project foo only
                 #
                 # Note that :view_scrums permission is required to view these events in the activity view.
                 def activity_provider(*args)
                   Redmine::Activity.register(*args)
                 end
                 # Registers a wiki formatter.
                 #
                 # Parameters:
                 # * +name+ - human-readable name
                 # * +formatter+ - formatter class, which should have an instance method +to_html+
                 # * +helper+ - helper module, which will be included by wiki pages
                 def wiki_format_provider(name, formatter, helper)
                   Redmine::WikiFormatting.register(name, formatter, helper)
                 end
                 # Returns +true+ if the plugin can be configured.
                 def configurable?
                   settings && settings.is_a?(Hash) && !settings[:partial].blank?
                 end
                 def mirror_assets
                   source = assets_directory
                   destination = public_directory
                   return unless File.directory?(source)
                   source_files = Dir[source + "/**/*"]
                   source_dirs = source_files.select { |d| File.directory?(d) }
                   source_files -= source_dirs
                   unless source_files.empty?
                     base_target_dir = File.join(destination, File.dirname(source_files.first).gsub(source, ''))
                     begin
                       FileUtils.mkdir_p(base_target_dir)
                     rescue Exception => e
                       raise "Could not create directory #{base_target_dir}: " + e.message
                     end
                   end
                   source_dirs.each do |dir|
                     # strip down these paths so we have simple, relative paths we can
                     # add to the destination
                     target_dir = File.join(destination, dir.gsub(source, ''))
                     begin
                       FileUtils.mkdir_p(target_dir)
                     rescue Exception => e
                       raise "Could not create directory #{target_dir}: " + e.message
                     end
                   end
                   source_files.each do |file|
                     begin
                       target = File.join(destination, file.gsub(source, ''))
                       unless File.exist?(target) && FileUtils.identical?(file, target)
                         FileUtils.cp(file, target)
                       end
                     rescue Exception => e
                       raise "Could not copy #{file} to #{target}: " + e.message
                     end
                   end
                 end
                 # Mirrors assets from one or all plugins to public/plugin_assets
                 def self.mirror_assets(name=nil)
                   if name.present?
                     find(name).mirror_assets
                   else
                     all.each do |plugin|
                       plugin.mirror_assets
                     end
                   end
                 end
                 # The directory containing this plugin's migrations (<tt>plugin/db/migrate</tt>)
                 def migration_directory
                   File.join(Rails.root, 'plugins', id.to_s, 'db', 'migrate')
                 end
                 # Returns the version number of the latest migration for this plugin. Returns
                 # nil if this plugin has no migrations.
                 def latest_migration
                   migrations.last
                 end
                 # Returns the version numbers of all migrations for this plugin.
                 def migrations
                   migrations = Dir[migration_directory+"/*.rb"]
                   migrations.map { |p| File.basename(p).match(/0*(\d+)\_/)[1].to_i }.sort
                 end
                 # Migrate this plugin to the given version
                 def migrate(version = nil)
                   puts "Migrating #{id} (#{name})..."
                   Redmine::Plugin::Migrator.migrate_plugin(self, version)
                 end
                 # Migrates all plugins or a single plugin to a given version
                 # Exemples:
                 #   Plugin.migrate
                 #   Plugin.migrate('sample_plugin')
                 #   Plugin.migrate('sample_plugin', 1)
                 #
                 def self.migrate(name=nil, version=nil)
                   if name.present?
                     find(name).migrate(version)
                   else
                     all.each do |plugin|
                       plugin.migrate
                     end
                   end
                 end
                 class Migrator < ActiveRecord::Migrator
                   # We need to be able to set the 'current' plugin being migrated.
                   cattr_accessor :current_plugin
                   class << self
                     # Runs the migrations from a plugin, up (or down) to the version given
                     def migrate_plugin(plugin, version)
                       self.current_plugin = plugin
                       return if current_version(plugin) == version
                       migrate(plugin.migration_directory, version)
                     end
                     def current_version(plugin=current_plugin)
                       # Delete migrations that don't match .. to_i will work because the number comes first
                       ::ActiveRecord::Base.connection.select_values(
                         "SELECT version FROM #{schema_migrations_table_name}"
                       ).delete_if{ |v| v.match(/-#{plugin.id}/) == nil }.map(&:to_i).max || 0
                     end
                   end
                   def migrated
                     sm_table = self.class.schema_migrations_table_name
                     ::ActiveRecord::Base.connection.select_values(
                       "SELECT version FROM #{sm_table}"
                     ).delete_if{ |v| v.match(/-#{current_plugin.id}/) == nil }.map(&:to_i).sort
                   end
                   def record_version_state_after_migrating(version)
                     super(version.to_s + "-" + current_plugin.id.to_s)
                   end
                 end
               end
             end

test/functional/settings_controller_test.rb +6 -4

             # Redmine - project management software
             # Copyright (C) 2006-2014  Jean-Philippe Lang
             #
             # This program is free software; you can redistribute it and/or
             # modify it under the terms of the GNU General Public License
             # as published by the Free Software Foundation; either version 2
             # of the License, or (at your option) any later version.
             #
             # This program is distributed in the hope that it will be useful,
             # but WITHOUT ANY WARRANTY; without even the implied warranty of
             # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
             # GNU General Public License for more details.
             #
             # You should have received a copy of the GNU General Public License
             # along with this program; if not, write to the Free Software
             # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
             require File.expand_path('../../test_helper', __FILE__)
             class SettingsControllerTest < ActionController::TestCase
               fixtures :projects, :trackers, :issue_statuses, :issues,
                        :users
               def setup
                 User.current = nil
                 @request.session[:user_id] = 1 # admin
               end
               def test_index
                 get :index
                 assert_response :success
                 assert_template 'edit'
               end
               def test_get_edit
                 get :edit
                 assert_response :success
                 assert_template 'edit'
                 assert_select 'input[name=?][value=""]', 'settings[enabled_scm][]'
               end
               def test_get_edit_should_preselect_default_issue_list_columns
                 with_settings :issue_list_default_columns => %w(tracker subject status updated_on) do
                   get :edit
                   assert_response :success
                 end
                 assert_select 'select[id=selected_columns][name=?]', 'settings[issue_list_default_columns][]' do
                   assert_select 'option', 4
                   assert_select 'option[value=tracker]', :text => 'Tracker'
                   assert_select 'option[value=subject]', :text => 'Subject'
                   assert_select 'option[value=status]', :text => 'Status'
                   assert_select 'option[value=updated_on]', :text => 'Updated'
                 end
                 assert_select 'select[id=available_columns]' do
                   assert_select 'option[value=tracker]', 0
                   assert_select 'option[value=priority]', :text => 'Priority'
                 end
               end
               def test_get_edit_without_trackers_should_succeed
                 Tracker.delete_all
                 get :edit
                 assert_response :success
               end
               def test_post_edit_notifications
                 post :edit, :settings => {:mail_from => 'functional@test.foo',
                                           :bcc_recipients  => '0',
                                           :notified_events => %w(issue_added issue_updated news_added),
                                           :emails_footer => 'Test footer'
                                           }
                 assert_redirected_to '/settings'
                 assert_equal 'functional@test.foo', Setting.mail_from
                 assert !Setting.bcc_recipients?
                 assert_equal %w(issue_added issue_updated news_added), Setting.notified_events
                 assert_equal 'Test footer', Setting.emails_footer
                 Setting.clear_cache
               end
               def test_edit_commit_update_keywords
                 with_settings :commit_update_keywords => [
                   {"keywords" => "fixes, resolves", "status_id" => "3"},
                   {"keywords" => "closes", "status_id" => "5", "done_ratio" => "100", "if_tracker_id" => "2"}
                 ] do
                   get :edit
                 end
                 assert_response :success
                 assert_select 'tr.commit-keywords', 2
                 assert_select 'tr.commit-keywords:nth-child(1)' do
                   assert_select 'input[name=?][value=?]', 'settings[commit_update_keywords][keywords][]', 'fixes, resolves'
                   assert_select 'select[name=?]', 'settings[commit_update_keywords][status_id][]' do
                     assert_select 'option[value="3"][selected=selected]'
                   end
                 end
                 assert_select 'tr.commit-keywords:nth-child(2)' do
                   assert_select 'input[name=?][value=?]', 'settings[commit_update_keywords][keywords][]', 'closes'
                   assert_select 'select[name=?]', 'settings[commit_update_keywords][status_id][]' do
                     assert_select 'option[value="5"][selected=selected]', :text => 'Closed'
                   end
                   assert_select 'select[name=?]', 'settings[commit_update_keywords][done_ratio][]' do
                     assert_select 'option[value="100"][selected=selected]', :text => '100 %'
                   end
                   assert_select 'select[name=?]', 'settings[commit_update_keywords][if_tracker_id][]' do
                     assert_select 'option[value="2"][selected=selected]', :text => 'Feature request'
                   end
                 end
               end
               def test_edit_without_commit_update_keywords_should_show_blank_line
                 with_settings :commit_update_keywords => [] do
                   get :edit
                 end
                 assert_response :success
                 assert_select 'tr.commit-keywords', 1 do
                   assert_select 'input[name=?]:not([value])', 'settings[commit_update_keywords][keywords][]'
                 end
               end
               def test_post_edit_commit_update_keywords
                 post :edit, :settings => {
                   :commit_update_keywords => {
                     :keywords => ["resolves", "closes"],
                     :status_id => ["3", "5"],
                     :done_ratio => ["", "100"],
                     :if_tracker_id => ["", "2"]
                   }
                 }
                 assert_redirected_to '/settings'
                 assert_equal([
                   {"keywords" => "resolves", "status_id" => "3"},
                   {"keywords" => "closes", "status_id" => "5", "done_ratio" => "100", "if_tracker_id" => "2"}
                 ], Setting.commit_update_keywords)
               end
               def test_get_plugin_settings
-                Setting.stubs(:plugin_foo).returns({'sample_setting' => 'Plugin setting value'})
                 ActionController::Base.append_view_path(File.join(Rails.root, "test/fixtures/plugins"))
                 Redmine::Plugin.register :foo do
-                  settings :partial => "foo_plugin/foo_plugin_settings"
+                  settings :partial => "foo_plugin/foo_plugin_settings",
+                    :default => {'sample_setting' => 'Plugin setting value'}
                 end
                 get :plugin, :id => 'foo'
                 assert_response :success
                 assert_template 'plugin'
                 assert_select 'form[action="/settings/plugin/foo"]' do
                   assert_select 'input[name=?][value=?]', 'settings[sample_setting]', 'Plugin setting value'
                 end
               ensure
                 Redmine::Plugin.unregister(:foo)
               end
               def test_get_invalid_plugin_settings
                 get :plugin, :id => 'none'
                 assert_response 404
               end
               def test_get_non_configurable_plugin_settings
                 Redmine::Plugin.register(:foo) {}
                 get :plugin, :id => 'foo'
                 assert_response 404
               ensure
                 Redmine::Plugin.unregister(:foo)
               end
               def test_post_plugin_settings
-                Setting.expects(:plugin_foo=).with({'sample_setting' => 'Value'}).returns(true)
                 Redmine::Plugin.register(:foo) do
-                  settings :partial => 'not blank' # so that configurable? is true
+                  settings :partial => 'not blank', # so that configurable? is true
+                    :default => {'sample_setting' => 'Plugin setting value'}
                 end
                 post :plugin, :id => 'foo', :settings => {'sample_setting' => 'Value'}
                 assert_redirected_to '/settings/plugin/foo'
+                assert_equal({'sample_setting' => 'Value'}, Setting.plugin_foo)
               end
               def test_post_non_configurable_plugin_settings
                 Redmine::Plugin.register(:foo) {}
                 post :plugin, :id => 'foo', :settings => {'sample_setting' => 'Value'}
                 assert_response 404
               ensure
                 Redmine::Plugin.unregister(:foo)
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages