Merge pull request #1541 from mattbrictson/airbrussh

Make Airbrussh the default formatter for Capistrano

Author: mikejohn857

CHANGELOG.md

@@ -6,6 +6,17 @@ Reverse Chronological Order:
 
 https://github.com/capistrano/capistrano/compare/v3.4.0...HEAD
 
+**You'll notice a big cosmetic change in this release: the default logging
+format has been changed to
+[Airbrussh](https://github.com/mattbrictson/airbrussh).** For more details on
+what Airbrussh does
+and how to configure it, visit the
+[Airbrussh README](https://github.com/mattbrictson/airbrussh#readme). To opt out
+of the new format, simply add `set :format, :pretty` to switch to the old
+default of Capistrano 3.4.0 and earlier.
+
+Other changes:
+
 * `remove` DSL method for removing values like from arrays like `linked_dirs`
 * `append` DSL method for pushing values like `linked_dirs`
   [#1447](https://github.com/capistrano/capistrano/pull/1447),

capistrano.gemspec

@@ -20,9 +20,10 @@ Gem::Specification.new do |gem|
   gem.licenses      = ['MIT']
 
   gem.required_ruby_version = '>= 1.9.3'
-  gem.add_dependency 'sshkit', '>= 1.7.1'
-  gem.add_dependency 'rake', '>= 10.0.0'
+  gem.add_dependency 'airbrussh', '>= 1.0.0.beta1'
   gem.add_dependency 'i18n'
+  gem.add_dependency 'rake', '>= 10.0.0'
+  gem.add_dependency 'sshkit', '>= 1.9.0.rc1'
 
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'mocha'

lib/capistrano/configuration.rb

@@ -58,6 +58,15 @@ def fetch(key, default=nil, &block)
       return value
     end
 
+    def any?(key)
+      value = fetch(key)
+      if value && value.respond_to?(:any?)
+        value.any?
+      else
+        !fetch(key).nil?
+      end
+    end
+
     def validate(key, &validator)
       vs = (validators[key] || [])
       vs << validator
@@ -105,7 +114,7 @@ def backend
 
     def configure_backend
       backend.configure do |sshkit|
-        sshkit.format           = fetch(:format)
+        configure_sshkit_output(sshkit)
         sshkit.output_verbosity = fetch(:log_level)
         sshkit.default_env      = fetch(:default_env)
         sshkit.backend          = fetch(:sshkit_backend, SSHKit::Backend::Netssh)
@@ -182,5 +191,12 @@ def invoke_validations(key, value, &block)
         validator.call(key, block || value)
       end
     end
+
+    def configure_sshkit_output(sshkit)
+      format_args = [fetch(:format)]
+      format_args.push(fetch(:format_options)) if any?(:format_options)
+
+      sshkit.use_format(*format_args)
+    end
   end
 end

lib/capistrano/defaults.rb

@@ -16,7 +16,7 @@
 set_if_empty :default_env, {}
 set_if_empty :keep_releases, 5
 
-set_if_empty :format, :pretty
+set_if_empty :format, :airbrussh
 set_if_empty :log_level, :debug
 
 set_if_empty :pty, false

lib/capistrano/dsl/env.rb

@@ -13,12 +13,7 @@ def is_question?(key)
       end
 
       def any?(key)
-        value = fetch(key)
-        if value && value.respond_to?(:any?)
-          value.any?
-        else
-          !fetch(key).nil?
-        end
+        env.any?(key)
       end
 
       def roles(*names)

lib/capistrano/ext/sshkit/backend/thread_local.rb

@@ -1,5 +1,4 @@
 require "capistrano/all"
-require "capistrano/ext/sshkit/backend/thread_local"
 require "rake/tasklib"
 
 # Base class for Capistrano plugins. Makes building a Capistrano plugin as easy

lib/capistrano/plugin.rb

@@ -7,6 +7,15 @@
   end
 end
 
+require "airbrussh/capistrano"
+# We don't need to show the "using Airbrussh" banner announcement since
+# Airbrussh is now the built-in formatter. Also enable command output by
+# default; hiding the output might be confusing to users new to Capistrano.
+Airbrussh.configure do |airbrussh|
+  airbrussh.banner = false
+  airbrussh.command_output = true
+end
+
 stages.each do |stage|
   Rake::Task.define_task(stage) do
     set(:stage, stage.to_sym)

lib/capistrano/setup.rb

@@ -13,11 +13,12 @@ set :repo_url, '[email protected]:me/my_repo.git'
 # Default value for :scm is :git
 # set :scm, :git
 
-# Default value for :format is :pretty
-# set :format, :pretty
+# Default value for :format is :airbrussh.
+# set :format, :airbrussh
 
-# Default value for :log_level is :debug
-# set :log_level, :debug
+# You can configure the Airbrussh format using :format_options.
+# These are the defaults.
+# set :format_options, command_output: true, log_file: 'log/capistrano.log', color: :auto, truncate: :auto
 
 # Default value for :pty is false
 # set :pty, true

lib/capistrano/templates/deploy.rb.erb

@@ -17,6 +17,7 @@ def default_config
       server 'vagrant@localhost:2220', roles: %w{web app}
       set :linked_files, #{linked_files}
       set :linked_dirs, #{linked_dirs}
+      set :format_options, log_file: nil
     }
   end