default log formatters handling

Allow users to formally reference and set default log formatters
through an api on the Capistrano::Logger singleton.

- use `Capistrano::Logger.default_formatters` to refer to the current defaults
- use `Capistrano::Logger.default_formatters=` to set custom defaults

lib/capistrano/configuration/log_formatters.rb

@@ -63,9 +63,13 @@ module Capistrano
         end
       end
 
+      def default_log_formatters(formatters)
+        default_formatters = [*formatters]
+      end
+
       def disable_log_formatters
         @logger.disable_formatters = true
       end
     end
   end
-end
+end

lib/capistrano/logger.rb

@@ -31,7 +31,7 @@ module Capistrano
     }
 
     # Set up default formatters
-    @formatters = [
+    @default_formatters = [
       # TRACE
       { :match => /command finished/,          :color => :white,   :style => :dim, :level => 3, :priority => -10 },
       { :match => /executing locally/,         :color => :yellow,  :level => 3, :priority => -20 },
@@ -49,8 +49,21 @@ module Capistrano
       { :match => /^err ::/,                   :color => :red,     :level => 0, :priority => -10 },
       { :match => /.*/,                        :color => :blue,    :level => 0, :priority => -20 }
     ]
+    @formatters = @default_formatters
 
     class << self
+      def default_formatters
+        @default_formatters
+      end
+
+      def default_formatters=(defaults=nil)
+        @default_formatters = [defaults].flatten
+
+        # reset the formatters
+        @formatters = @default_formatters
+        @sorted_formatters = nil
+      end
+
       def add_formatter(options) #:nodoc:
         @formatters.push(options)
         @sorted_formatters = nil

test/logger_formatting_test.rb

@@ -91,4 +91,59 @@ class LoggerFormattingTest < Test::Unit::TestCase
     @io.stubs(:tty?).returns(true)
     @logger.device = @io
   end
-end
+end
+
+class DefaultLoggerFormattersTest < Test::Unit::TestCase
+  def setup
+    @expected_default_formatter_values = [
+      # TRACE
+      { :match => /command finished/,          :color => :white,   :style => :dim, :level => 3, :priority => -10 },
+      { :match => /executing locally/,         :color => :yellow,  :level => 3, :priority => -20 },
+
+      # DEBUG
+      { :match => /executing `.*/,             :color => :green,   :level => 2, :priority => -10, :timestamp => true },
+      { :match => /.*/,                        :color => :yellow,  :level => 2, :priority => -30 },
+
+      # INFO
+      { :match => /.*out\] (fatal:|ERROR:).*/, :color => :red,     :level => 1, :priority => -10 },
+      { :match => /Permission denied/,         :color => :red,     :level => 1, :priority => -20 },
+      { :match => /sh: .+: command not found/, :color => :magenta, :level => 1, :priority => -30 },
+
+      # IMPORTANT
+      { :match => /^err ::/,                   :color => :red,     :level => 0, :priority => -10 },
+      { :match => /.*/,                        :color => :blue,    :level => 0, :priority => -20 }
+    ]
+
+    @custom_default_formatter_values = [
+      { :match => /.*/,  :color => :white }
+    ]
+
+  end
+
+  def test_default_formatters_api
+    assert Capistrano::Logger.respond_to? :default_formatters
+    assert Capistrano::Logger.respond_to? :default_formatters=
+  end
+
+  def test_default_formatters_values
+    assert_equal @expected_default_formatter_values, Capistrano::Logger.default_formatters
+    assert_equal @expected_default_formatter_values, Capistrano::Logger.instance_variable_get("@formatters")
+    assert_equal nil, Capistrano::Logger.instance_variable_get("@sorted_formatters")
+  end
+
+  def test_set_default_formatters_values
+    # when given an array
+    Capistrano::Logger.default_formatters = @custom_default_formatter_values
+
+    assert_equal @custom_default_formatter_values, Capistrano::Logger.default_formatters
+    Capistrano::Logger.default_formatters = @custom_default_formatter_values
+    assert_equal @custom_default_formatter_values, Capistrano::Logger.instance_variable_get("@formatters")
+    assert_equal nil, Capistrano::Logger.instance_variable_get("@sorted_formatters")
+
+    # when given a single formatter values hash
+    Capistrano::Logger.default_formatters = @custom_default_formatter_values.first
+
+    assert_equal @custom_default_formatter_values, Capistrano::Logger.default_formatters
+  end
+
+end