Inject Logger into ConfigurationLoader

In order to support displaying warnings about configuration, we need to
have access to the `Logger` instance.

Inject a `Logger` into the `ConfigurationLoader` constructor and update
all uses of it to provide this dependency.

A follow-up commit will use this to display warnings for hook
configurations that don't explicitly have the `enabled` option set.

Author: sds

lib/overcommit/cli.rb

@@ -146,7 +146,7 @@ def print_version(program_name)
     # Prints the hooks available in the current repo and whether they're
     # enabled/disabled.
     def print_installed_hooks
-      config = Overcommit::ConfigurationLoader.load_repo_config
+      config = Overcommit::ConfigurationLoader.new(log).load_repo_config
 
       config.all_hook_configs.each do |hook_type, hook_configs|
         print_hooks_for_hook_type(config, hook_configs, hook_type)
@@ -175,7 +175,7 @@ def print_hooks_for_hook_type(repo_config, hook_configs, hook_type)
     end
 
     def sign_plugins
-      config = Overcommit::ConfigurationLoader.load_repo_config
+      config = Overcommit::ConfigurationLoader.new(log).load_repo_config
       context = Overcommit::HookContext.create(@options[:hook_to_sign],
                                                config,
                                                @arguments,
@@ -187,7 +187,7 @@ def sign_plugins
     end
 
     def run_all
-      config  = Overcommit::ConfigurationLoader.load_repo_config
+      config  = Overcommit::ConfigurationLoader.new(log).load_repo_config
       context = Overcommit::HookContext.create('run-all', config, @arguments, @input)
       config.apply_environment!(context, ENV)
 

lib/overcommit/configuration_loader.rb

@@ -6,29 +6,13 @@ class ConfigurationLoader
     DEFAULT_CONFIG_PATH = File.join(Overcommit::HOME, 'config', 'default.yml')
 
     class << self
-      # Loads and returns the configuration for the repository we're running in.
-      #
-      # @return [Overcommit::Configuration]
-      def load_repo_config
-        overcommit_yml = File.join(Overcommit::Utils.repo_root,
-                                   Overcommit::CONFIG_FILE_NAME)
-
-        if File.exist?(overcommit_yml)
-          load_file(overcommit_yml)
-        else
-          default_configuration
-        end
-      end
-
       # Loads and returns the default configuration.
       #
       # @return [Overcommit::Configuration]
       def default_configuration
         @default_config ||= load_from_file(DEFAULT_CONFIG_PATH)
       end
 
-      private
-
       # Loads a configuration, ensuring it extends the default configuration.
       def load_file(file)
         config = load_from_file(file)
@@ -40,6 +24,8 @@ def load_file(file)
               error.backtrace
       end
 
+      private
+
       def load_from_file(file)
         hash =
           if yaml = YAML.load_file(file)
@@ -51,5 +37,25 @@ def load_from_file(file)
         Overcommit::Configuration.new(hash)
       end
     end
+
+    # Create a configuration loader which writes warnings/errors to the given
+    # {Overcommit::Logger} instance.
+    def initialize(logger)
+      @log = logger
+    end
+
+    # Loads and returns the configuration for the repository we're running in.
+    #
+    # @return [Overcommit::Configuration]
+    def load_repo_config
+      overcommit_yml = File.join(Overcommit::Utils.repo_root,
+                                 Overcommit::CONFIG_FILE_NAME)
+
+      if File.exist?(overcommit_yml)
+        self.class.load_file(overcommit_yml)
+      else
+        self.class.default_configuration
+      end
+    end
   end
 end

spec/overcommit/cli_spec.rb

@@ -27,8 +27,9 @@
 
     context 'with the --list-hooks option specified' do
       let(:arguments) { ['--list-hooks'] }
+
       let(:contexts) do
-        Overcommit::ConfigurationLoader.load_repo_config.all_hook_configs.keys
+        Overcommit::ConfigurationLoader.new(logger).load_repo_config.all_hook_configs.keys
       end
 
       before { cli.stub(:halt) }

spec/overcommit/configuration_loader_spec.rb

@@ -1,8 +1,10 @@
 require 'spec_helper'
 
 describe Overcommit::ConfigurationLoader do
+  let(:logger) { Overcommit::Logger.silent }
+
   describe '.load_repo_config' do
-    subject { described_class.load_repo_config }
+    subject { described_class.new(logger).load_repo_config }
 
     context 'when repo does not contain a configuration file' do
       around do |example|

template-dir/hooks/overcommit-hook

@@ -43,7 +43,7 @@ begin
     exec($0, *ARGV) # Execute the updated hook with all original arguments
   end
 
-  config = Overcommit::ConfigurationLoader.load_repo_config
+  config = Overcommit::ConfigurationLoader.new(logger).load_repo_config
 
   context = Overcommit::HookContext.create(hook_type, config, ARGV, STDIN)
   config.apply_environment!(context, ENV)