Extract Logger class

So that we're not calling `puts`/`print` from around the codebase. This
allows us to test, and lets us silence output during test runs.

Change-Id: If557a490ecb9913a2bcef4a943a773711da25443
Reviewed-on: https://gerrit.causes.com/23030
Tested-by: jenkins <jenkins@causes.com>
Reviewed-by: Shane da Silva <shane@causes.com>

Author: Aiden Scandella

lib/overcommit.rb

@@ -1,9 +1,9 @@
 require 'overcommit/configuration'
-require 'overcommit/console_methods'
 require 'overcommit/errors'
 require 'overcommit/git_hook'
 require 'overcommit/hook_specific_check'
 require 'overcommit/installer'
+require 'overcommit/logger'
 require 'overcommit/reporter'
 require 'overcommit/utils'
 require 'overcommit/version'

lib/overcommit/cli.rb

@@ -2,7 +2,6 @@
 
 module Overcommit
   class CLI
-    include ConsoleMethods
     attr_reader :options
 
     def initialize(arguments = [])
@@ -19,14 +18,14 @@ def parse_arguments
         end
 
         opts.on_tail('-v', '--version', 'Show version') do
-          puts VERSION
+          log.log VERSION
           exit 0
         end
 
         opts.on('-l', '--list-templates', 'List built-in templates') do
           Overcommit.config.templates.each_pair do |name, configuration|
             bold name
-            puts YAML.dump(configuration), ''
+            log.log YAML.dump(configuration), ''
           end
           exit 0
         end
@@ -80,20 +79,20 @@ def parse_arguments
 
     def run
       if @options[:targets].nil? || @options[:targets].empty?
-        warning 'You must supply at least one directory'
-        puts @parser.help
+        log.warning 'You must supply at least one directory'
+        log.log @parser.help
         exit 2
       end
 
       @options[:targets].each do |target|
         begin
           Installer.new(@options, target).run
         rescue NotAGitRepoError => e
-          warning "Skipping #{target}: #{e}"
+          log.warning "Skipping #{target}: #{e}"
         end
       end
 
-      success "#{@options[:uninstall] ? 'Removal' : 'Installation'} complete"
+      log.success "#{@options[:uninstall] ? 'Removal' : 'Installation'} complete"
 
     rescue ArgumentError => ex
       error "Installation failed: #{ex}"
@@ -102,9 +101,13 @@ def run
 
   private
 
+    def log
+      Logger.instance
+    end
+
     def print_help(message, ex = nil)
-      error ex.to_s + "\n" if ex
-      puts message
+      log.error ex.to_s + "\n" if ex
+      log.log message
       exit 0
     end
   end

lib/overcommit/console_methods.rb

@@ -1,14 +1,12 @@
 module Overcommit
   module GitHook
     class BaseHook
-      include ConsoleMethods
-
       def initialize
         Overcommit.config.desired_plugins.each do |plugin|
           require plugin
         end
       rescue LoadError, NameError => ex
-        error "Couldn't load plugin: #{ex}"
+        log.error "Couldn't load plugin: #{ex}"
         exit 0
       end
 
@@ -41,6 +39,10 @@ def run(*args)
 
     private
 
+      def log
+        Logger.instance
+      end
+
       # Return all loaded plugins, skipping those that are skippable and have
       # been asked to be skipped by the environment variable SKIP_CHECKS.
       #

lib/overcommit/git_hook.rb

@@ -14,15 +14,15 @@ def run
     end
 
     def install
-      puts "Installing hooks into #{@target}"
+      log.log "Installing hooks into #{@target}"
 
       install_scripts
       install_hooks
       write_configuration
     end
 
     def uninstall
-      puts "Removing hooks from #{@target}"
+      log.log "Removing hooks from #{@target}"
 
       uninstall_scripts
       uninstall_hooks
@@ -31,6 +31,10 @@ def uninstall
 
   private
 
+    def log
+      Logger.instance
+    end
+
     def hook_path
       absolute_target = File.expand_path @target
       File.join(absolute_target, '.git/hooks')

lib/overcommit/installer.rb

@@ -0,0 +1,36 @@
+require 'singleton'
+
+# This class centralizes all communication to STDOUT
+module Overcommit
+  class Logger
+    include Singleton
+
+    def partial(*args)
+      print *args
+    end
+
+    def log(*args)
+      puts *args
+    end
+
+    def bold(str)
+      log "\033[1;37m#{str}\033[0m"
+    end
+
+    def error(str)
+      log "\033[31m#{str}\033[0m"
+    end
+
+    def success(str)
+      log "\033[32m#{str}\033[0m"
+    end
+
+    def warning(str)
+      log "\033[33m#{str}\033[0m"
+    end
+
+    def notice(str)
+      log "\033[1;33m#{str}\033[0m"
+    end
+  end
+end

lib/overcommit/logger.rb

@@ -1,7 +1,5 @@
 module Overcommit
   class Reporter
-    include ConsoleMethods
-
     def initialize(name, checks)
       @name    = name
       @checks  = checks
@@ -11,7 +9,7 @@ def initialize(name, checks)
 
     def with_status(check, &block)
       title = "  Checking #{check.name}..."
-      print title unless check.stealth?
+      log.partial title unless check.stealth?
 
       status, output = yield
 
@@ -20,48 +18,53 @@ def with_status(check, &block)
     end
 
     def print_header
-      puts "Running #{@name} checks"
+      log.log "Running #{@name} checks"
     end
 
     def print_result
-      puts
+      log.log # Newline
+
       case final_result
       when :good
-        success "+++ All #{@name} checks passed"
+        log.success "+++ All #{@name} checks passed"
         exit 0
       when :bad
-        error "!!! One or more #{@name} checks failed"
+        log.error "!!! One or more #{@name} checks failed"
         exit 1
       when :stop
-        warning "*** One or more #{@name} checks needs attention"
-        warning "*** If you really want to commit, use SKIP_CHECKS"
-        warning "*** (takes a space-separated list of checks to skip, or 'all')"
+        log.warning "*** One or more #{@name} checks needs attention"
+        log.warning "*** If you really want to commit, use SKIP_CHECKS"
+        log.warning "*** (takes a space-separated list of checks to skip, or 'all')"
         exit 1
       end
     end
 
   private
 
+    def log
+      Overcommit::Logger.instance
+    end
+
     def print_incremental_result(title, status, output, stealth = false)
       if stealth
         return if status == :good
-        print title
+        log.partial title
       end
 
       print '.' * (@width - title.length)
       case status
       when :good
-        success 'OK'
+        log.success 'OK'
       when :bad
-        error 'FAILED'
+        log.error 'FAILED'
         print_report output
       when :warn
-        warning output
+        log.warning output
       when :stop
-        warning 'UH OH'
+        log.warning 'UH OH'
         print_report output
       else
-        error '???'
+        log.error '???'
         print_report "Check didn't return a status"
         exit 1
       end
@@ -74,7 +77,7 @@ def final_result
     end
 
     def print_report(*report)
-      puts report.flatten.map { |line| "    #{line}" }.join("\n")
+      log.log report.flatten.map { |line| "    #{line}" }.join("\n")
     end
   end
 end

lib/overcommit/reporter.rb

@@ -1,8 +1,6 @@
 module Overcommit
   module Utils
     class << self
-      include ConsoleMethods
-
       @@hooks = []
 
       def register_hook(hook)
@@ -20,7 +18,7 @@ def hook_name
       def load_hooks
         require File.expand_path("../hooks/#{hook_name}", __FILE__)
       rescue LoadError
-        error "No hook definition found for #{hook_name}"
+        log.error "No hook definition found for #{hook_name}"
         exit 1
       end
 
@@ -55,6 +53,12 @@ def modified_files
         @modified_files ||=
           `git diff --cached --name-only --diff-filter=ACM`.split "\n"
       end
+
+    private
+
+      def log
+        Logger.instance
+      end
     end
   end
 end

lib/overcommit/utils.rb

@@ -1,3 +1,12 @@
 require 'overcommit'
 
 def exit(*args) ; end
+
+# Silence output to STDOUT
+class Overcommit::Logger
+  def log(*args)
+  end
+
+  def partial(*args)
+  end
+end