jro_apps/redmine Commit - r4829:e1ad561cf652

Adds a method to temporarily override configuration settings....

Jean-Philippe Lang -

r4829:e1ad561cf652

parent child

Context file:

r4829:e1ad561cf652

Collapse all files

lib/redmine/configuration.rb +10 0

             # Redmine - project management software
             # Copyright (C) 2006-2011  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
               module Configuration
                 # Configuration default values
                 @defaults = {
                   'email_delivery' => nil
                 }
                 @config = nil
                 class << self
                   # Loads the Redmine configuration file
                   # Valid options:
                   # * <tt>:file</tt>: the configuration file to load (default: config/configuration.yml)
                   # * <tt>:env</tt>: the environment to load the configuration for (default: Rails.env)
                   def load(options={})
                     filename = options[:file] || File.join(Rails.root, 'config', 'configuration.yml')
                     env = options[:env] || Rails.env
                     @config = @defaults.dup
                     load_deprecated_email_configuration(env)
                     if File.file?(filename)
                       @config.merge!(load_from_yaml(filename, env))
                     end
                     # Compatibility mode for those who copy email.yml over configuration.yml
                     %w(delivery_method smtp_settings sendmail_settings).each do |key|
                       if value = @config.delete(key)
                         @config['email_delivery'] ||= {}
                         @config['email_delivery'][key] = value
                       end
                     end
                     if @config['email_delivery']
                       ActionMailer::Base.perform_deliveries = true
                       @config['email_delivery'].each do |k, v|
                         v.symbolize_keys! if v.respond_to?(:symbolize_keys!)
                         ActionMailer::Base.send("#{k}=", v)
                       end
                     end
                     @config
                   end
                   # Returns a configuration setting
                   def [](name)
                     load unless @config
                     @config[name]
                   end
+                  # Yields a block with the specified hash configuration settings
+                  def with(settings)
+                    settings.stringify_keys!
+                    load unless @config
+                    was = settings.keys.inject({}) {|h,v| h[v] = @config[v]; h}
+                    @config.merge! settings
+                    yield if block_given?
+                    @config.merge! was
+                  end
                   private
                   def load_from_yaml(filename, env)
                     yaml = YAML::load_file(filename)
                     conf = {}
                     if yaml.is_a?(Hash)
                       if yaml['default']
                         conf.merge!(yaml['default'])
                       end
                       if yaml[env]
                         conf.merge!(yaml[env])
                       end
                     else
                       $stderr.puts "#{filename} is not a valid Redmine configuration file"
                       exit 1
                     end
                     conf
                   end
                   def load_deprecated_email_configuration(env)
                     deprecated_email_conf = File.join(Rails.root, 'config', 'email.yml')
                     if File.file?(deprecated_email_conf)
                       warn "Storing outgoing emails configuration in config/email.yml is deprecated. You should now store it in config/configuration.yml using the email_delivery setting."
                       @config.merge!({'email_delivery' => load_from_yaml(deprecated_email_conf, env)})
                     end
                   end
                 end
               end
             end

test/unit/lib/redmine/configuration_test.rb +9 0

             # Redmine - project management software
             # Copyright (C) 2006-2011  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 Redmine::ConfigurationTest < ActiveSupport::TestCase
               def setup
                 @conf = Redmine::Configuration
               end
               def test_empty
                 assert_kind_of Hash, load_conf('empty.yml', 'test')
               end
               def test_default
                 assert_kind_of Hash, load_conf('default.yml', 'test')
                 assert_equal 'foo', @conf['somesetting']
               end
               def test_no_default
                 assert_kind_of Hash, load_conf('no_default.yml', 'test')
                 assert_equal 'foo', @conf['somesetting']
               end
               def test_overrides
                 assert_kind_of Hash, load_conf('overrides.yml', 'test')
                 assert_equal 'bar', @conf['somesetting']
               end
+              def test_with
+                load_conf('default.yml', 'test')
+                assert_equal 'foo', @conf['somesetting']
+                @conf.with 'somesetting' => 'bar' do
+                  assert_equal 'bar', @conf['somesetting']
+                end
+                assert_equal 'foo', @conf['somesetting']
+              end
               private
               def load_conf(file, env)
                 @conf.load(
                   :file => File.join(Rails.root, 'test', 'fixtures', 'configuration', file),
                   :env => env
                 )
               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