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

                                TIS-620)
                cattr_accessor :available_settings
-               @@available_settings = YAML::load(File.open("#{Rails.root}/config/settings.yml"))
-               Redmine::Plugin.all.each do |plugin|
-                 next unless plugin.settings
-                 @@available_settings["plugin_#{plugin.id}"] = {'default' => plugin.settings[:default], 'serialized' => true}
-               end
+               self.available_settings ||= {}
                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
                def value
                  v = read_attribute(:value)
                  # Unserialize serialized settings
-                 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 = 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
                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
                  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
                  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

lib/redmine/plugin.rb +5 0

                      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]

test/functional/settings_controller_test.rb +6 -4

                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'
                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

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