Use ConfigurationReader to unify accesss to configuration files

Author: Pawel Pierzchala

Diff for: bin/git-proxy

@@ -59,7 +59,7 @@ require "yaml"
 ROOT_DIR = File.expand_path( File.join(File.dirname(__FILE__), "../") )
 
 if Rails.env.production? && Process.uid == 0
-  config = YAML::load_file(ROOT_DIR + "/config/gitorious.yml")
+  config = Gitorious::ConfigurationReader.read(ROOT_DIR + "/config/gitorious.yml")
   git_user = config["user"] || (config[Rails.env] && config[Rails.env]["user"])
   if git_user
     uid = Etc.getpwnam(git_user).uid

Diff for: bin/migrate

@@ -41,14 +41,14 @@ require "pathname"
 gitorious_root = Pathname.new(__FILE__).dirname.realpath.to_s.gsub("/bin", "")
 Dir.chdir gitorious_root
 RAILS_ENV = ENV["RAILS_ENV"] || "production"
-require 'yaml'
+require_relative "../lib/gitorious/configuration_reader"
 
 def db_config
-  @db_config ||= YAML::load(File.open('config/database.yml'))
+  @db_config ||= Gitorious::ConfigurationReader.read('config/database.yml')
 end
 
 def gitorious_config
-  @gitorious_config ||= YAML::load(File.open('config/gitorious.yml'))
+  @gitorious_config ||= Gitorious::ConfigurationReader.read('config/gitorious.yml')
 end
 
 def repo_path

Diff for: bin/upgrade-gitorious3-config

@@ -30,7 +30,7 @@ must manually put it in place afterwards
     `cp #{ARGV[1]} #{ARGV[1]}.bu-#{Time.now.to_i}`
   end
 
-  old = YAML.load_file(ARGV[0])
+  old = Gitorious::ConfigurationReader.read(ARGV[0])
 
   def optional(settings, setting)
     return "##{setting}:" if !settings.key?(setting)

Diff for: config/initializers/authentication.rb

@@ -19,7 +19,7 @@
 auth_configuration_path = ENV['GTS_AUTHENTICATION_YML'] || Rails.root + "config/authentication.yml"
 
 if File.exist?(auth_configuration_path)
-  config = YAML::load_file(auth_configuration_path)
+  config = Gitorious::ConfigurationReader.read(auth_configuration_path)
 
   if config && config.key?(Rails.env)
     config = config[Rails.env]

Diff for: config/initializers/setup_mail.rb

@@ -15,7 +15,6 @@
 #   You should have received a copy of the GNU Affero General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
-require 'erb'
 
 ActionMailer::Base.default_url_options[:protocol] = Gitorious.scheme
 ActionMailer::Base.default_url_options[:host]     = Gitorious.host
@@ -26,7 +25,7 @@
 
 smtp_config_path = (Rails.root + 'config' + 'smtp.yml').to_s
 if File.exist?(smtp_config_path)
-  smtp_settings = YAML::load(ERB.new(File.read(smtp_config_path)).result)
+  smtp_settings = Gitorious::ConfigurationReader.read(smtp_config_path)
   if smtp_settings
     ActionMailer::Base.smtp_settings = smtp_settings.symbolize_keys
   end

Diff for: data/hooks/messaging.rb

@@ -49,13 +49,13 @@ def self.env
 Bundler.require(:messaging, Rails.env.to_s)
 ENV["GIT_DIR"] = git_dir
 
-require "yaml"
 require "gitorious/messaging"
+require "gitorious/configuration_reader"
 require "repository_root"
 
 if !defined?(Gitorious::Configuration)
-  conf = YAML::load_file(Rails.root + "config/gitorious.yml")
-  overrides = YAML::load_file(Rails.root + "config/gitorious.overrides.yml") rescue {}
+  conf = Gitorious::ConfigurationReader.read(Rails.root + "config/gitorious.yml")
+  overrides = Gitorious::ConfigurationReader.read(Rails.root + "config/gitorious.overrides.yml") rescue {}
   conf.merge!(overrides || {})
   Gitorious::Messaging.adapter = (conf[Rails.env.to_s] || {})["messaging_adapter"] || conf["messaging_adapter"]
   Bundler.require(Gitorious::Messaging.adapter.to_sym)
@@ -65,7 +65,7 @@ def self.env
   if Gitorious::Messaging.adapter == "resque"
     resque_config = Rails.root + "config/resque.yml"
     if resque_config.exist?
-      settings = YAML::load_file(resque_config)[Rails.env.to_s]
+      settings = Gitorious::ConfigurationReader.read(resque_config)[Rails.env.to_s]
       Resque.redis = settings if settings
     end
   end

Diff for: ldap-wizard/lib/auth_config_loader.rb

@@ -5,7 +5,7 @@ def self.load_auth_file
     auth_file = RAILS_ROOT + "config/authentication.yml"
     raise ConfigurationError, "No config/authentication found" unless auth_file.exist?
 
-    auth_config = YAML::load_file(auth_file) || {}
+    auth_config = Gitorious::ConfigurationReader.read(auth_file) || {}
     auth_config = auth_config[RAILS_ENV] if auth_config.key?(RAILS_ENV)
     raise ConfigurationError, "No authentication configuration found in authentication.yml. #{auth_config.inspect}" unless auth_config
     raise ConfigurationError, "No authentication methods defined in authentication.yml. #{auth_config.inspect}" unless auth_config.key?("methods")

Diff for: ldap-wizard/wizard.rb

@@ -17,6 +17,7 @@
 require "credentials"
 require "ldap_configuration_presenter"
 require "ldap_tester"
+require "gitorious/configuration_reader"
 require "auth_config_loader"
 
 require "sinatra"

Diff for: lib/gitorious/authorization/configuration.rb

@@ -31,7 +31,7 @@ def self.configure!
         authorization_configuration_path = File.join(root, "config", "authorization.yml")
 
         if File.exist?(authorization_configuration_path)
-          if config = YAML::load_file(authorization_configuration_path)[Rails.env]
+          if config = Gitorious::ConfigurationReader.read(authorization_configuration_path)[Rails.env]
             Gitorious::Authorization::Configuration.configure(config)
           else
             Gitorious::Authorization::Configuration.use_default_configuration

Diff for: lib/gitorious/configuration_loader.rb

@@ -16,8 +16,7 @@
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
 require "pathname"
-require "yaml"
-require "erb"
+require "gitorious/configuration_reader"
 
 # See also config/gitorious_config.rb for more information about
 # how Gitorious is configured.
@@ -155,7 +154,7 @@ def load_config_file(path, allow_missing = false)
       full_path = File.join(@root, path)
       return [{}, {}] if allow_missing && !File.exist?(full_path)
 
-      settings = YAML.load(ERB.new(File.read(full_path)).result) || {}
+      settings = Gitorious::ConfigurationReader.read(full_path) || {}
 
       groups = {}
       groups['production']  = settings.delete('production') if settings.key?('production')

Diff for: lib/gitorious/configuration_reader.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+#--
+#   Copyright (C) 2014 Gitorious AS
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as published by
+#   the Free Software Foundation, either version 3 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 Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#++
+require 'yaml'
+require 'erb'
+
+module Gitorious
+  module ConfigurationReader
+    def self.read(path)
+      YAML::load(ERB.new(File.read(path)).result)
+    end
+  end
+end

Diff for: lib/gitorious/on_config.rb

@@ -15,7 +15,6 @@
 #   You should have received a copy of the GNU Affero General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
-require 'erb'
 
 module Gitorious
   # If the file Rails.root + config/config_file exists, load this as a
@@ -26,7 +25,7 @@ module Gitorious
   def self.on_config(config_file)
     path = Rails.root + "config/#{config_file}"
     if path.exist?
-      settings = YAML::load(ERB.new(File.read(path)).result)[Rails.env]
+      settings = Gitorious::ConfigurationReader.read(path)[Rails.env]
       yield settings if settings
     end
   end

Diff for: lib/tasks/backup.rake

@@ -122,7 +122,8 @@ namespace :backup do
   end
 
   def db_config
-    @db_config ||= YAML::load(File.open('config/database.yml'))
+    require "gitorious/configuration_reader"
+    @db_config ||= Gitorious::ConfigurationReader.read('config/database.yml')
   end
 
   def repo_path

Diff for: script/undo_last_upgrade

@@ -9,8 +9,8 @@
 
 
 def restore_db
-  require 'yaml'
-  conf = YAML::load(File.open('config/database.yml'))
+  require_relative '../lib/gitorious/configuration_reader'
+  conf = Gitorious::ConfigurationReader.read('config/database.yml')
   db_name = conf['production']['database']
   puts `mysql #{db_name} < /tmp/upgrade_db_backup.sql`
 end

Diff for: script/upgrade_to

@@ -18,11 +18,11 @@
 # that each execution of /upgrade_to overwrites the undo point, so
 # only do one upgrade at a time.)
 
-# Assumptions: 
-# 1: If you are several versions behind, only upgrade one tagged version at a time. 
+# Assumptions:
+# 1: If you are several versions behind, only upgrade one tagged version at a time.
 # 2: Always perform a manual, extra backup (/script/snapshot) before attempting an upgrade
 # 3: Take the Gitorious installation offline to prevent users from using it while upgrading
-# 4: Before going through with the upgrade, check relevant release notes for any breaking changes, 
+# 4: Before going through with the upgrade, check relevant release notes for any breaking changes,
 #    (particularly important for any major version upgrades)
 
 
@@ -31,7 +31,7 @@ if Process.uid != 0
   exit
 end
 
-if !ARGV[0] 
+if !ARGV[0]
   puts "Usage:"
   puts "script/upgrade_to <tag>"
   exit
@@ -40,8 +40,8 @@ end
 new_tag = ARGV[0]
 
 def backup_db
-  require 'yaml'
-  conf = YAML::load(File.open('config/database.yml'))
+  require_relative '../lib/gitorious/configuration_reader'
+  conf = Gitorious::ConfigurationReader.read('config/database.yml')
   db_name = conf['production']['database']
   puts `mysqldump #{db_name} > /tmp/upgrade_db_backup.sql`
 end
@@ -57,7 +57,7 @@ end
 
 puts "UPGRADE: About to attempt Gitorious upgrade. Please backup first. Proceed with upgrade? (y/n)"
 response = $stdin.gets.chomp
-if response != "y" 
+if response != "y"
   puts "UPGRADE: Quit."
   exit
 end
@@ -86,7 +86,7 @@ puts "UPGRADE: Clearing asset pipeline..."
 puts `env RAILS_ENV=production bundle exec rake assets:clear`
 
 puts "UPGRADE: Restarting Gitorious..."
-puts `script/restart` 
+puts `script/restart`
 
 puts "UPGRADE: Done, upgraded to #{new_tag}."
 puts "\nATTENTION: Please test and verify that your site works as expected. If any errors occur, rollback to the pre-upgrade state with script/undo_last_upgrade"