airbrussh 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90b12f9244ea92b79588f34960fb6eb585ab90f8
-  data.tar.gz: 6a33190b5a84f17f034b54ef123435d44a0d2309
+  metadata.gz: cce6c8fd80458eebccd4bc41fd5f55d45435e056
+  data.tar.gz: 1e6c39223361f97a90d2593aec1c3f873c61cc13
 SHA512:
-  metadata.gz: b971d87eaa4667f1188abfc7ea49fd2434547f689b5b4b854ff424bd0cbf070395b0690a7df93ce8a328cfe7606cbc6d27a529ea2aa7d2c8ca2335b751cba8b3
-  data.tar.gz: 5a34057f0f8d55c3ac578531bb482b37d4290ccfb9909f0ba61869ed9e65c8b9037a79e04e9add08ef5701ded4934ff008d00aa4214f80cf0daef0f222a224ae
+  metadata.gz: 1695037c080995aabfe3bca4c05c1066700002803e4909b21fa18c58370e8ce364f3f35d0f624225b2a3a4165aed3410cf6a3bff4f254b26fc70b00f93dbf92f
+  data.tar.gz: d58bd13170ce51ddc74af022e0661d5b1844ede48eab39ac8d289b67832d8b5a84b7e22ee6ba05c56b4fa35eff3df3bf6ec49cf25dc28405a05ab1973fc37b41

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## Next release
+
+* Your contribution here!
+
+## 0.3.0 (2015-03-28)
+
+* New `config.banner` option allows startup message to be disabled or changed (suggestion from [@justindowning](https://github.com/justindowning))
+* New `config.command_output` option gives full control of whether airbrussh shows or hides the stderr and stdout data received from remote commands; see the usage section of the README for further explanation (suggestion from [@carlesso](https://github.com/carlesso))
+
 ## 0.2.1 (2015-03-02)
 
 * Un-pin SSHKit dependency now that SSHKit 1.7.1 has been released.

data/README.md

@@ -9,6 +9,16 @@ And don't worry: airbrussh saves Capistrano's default verbose output to a separa
 
 ![Sample output](https://raw.github.com/mattbrictson/airbrussh/master/demo.gif)
 
+For more details on how exactly Airbrussh changes Capistrano's output and the reasoning behind it, check out the blog post: [Introducing Airbrussh](https://mattbrictson.com/airbrussh).
+
+## Requirements
+
+**To use Airbrussh with Capistrano, you will need Capistrano 3.** Capistrano 2.x is not supported.
+
+Airbrussh has been tested with MRI 2.2, Capistrano 3.4.0, and SSHKit 1.7.1. Other recent version combinations will probably work; [open an issue on GitHub](https://github.com/mattbrictson/airbrussh/issues/new) if you run into trouble.
+
+Airbrussh's only dependency is SSHKit >= 1.6.1.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -43,31 +53,70 @@ Airbrussh automatically replaces the default Capistrano log formatter, so there
 ```ruby
 Airbrussh.configure do |config|
   # Capistrano's default, un-airbrusshed output is saved to a file to
-  # facilitate debugging. To disable this entirely:
+  # facilitate debugging.
+  #
+  # To disable this entirely:
   # config.log_file = nil
+  #
   # Default:
   config.log_file = "log/capistrano.log"
 
   # Airbrussh patches Rake so it can access the name of the currently executing
   # task. Set this to false if monkey patching is causing issues.
+  #
   # Default:
   config.monkey_patch_rake = true
 
   # Ansi colors will be used in the output automatically based on whether the
   # output is a TTY, or if the SSHKIT_COLOR environment variable is set.
+  #
   # To disable color always:
   # config.color = false
+  #
   # Default:
   config.color = :auto
 
   # Output is automatically truncated to the width of the terminal window, if
   # possible. If the width of the terminal can't be determined, no truncation
-  # is performed. To truncate to a fixed width:
+  # is performed.
+  #
+  # To truncate to a fixed width:
   # config.truncate = 80
+  #
   # Or to disable truncation entirely:
   # config.truncate = false
+  #
   # Default:
   config.truncate = :auto
+
+  # If a log_file is configured, airbrussh will output a message at startup
+  # displaying the log_file location.
+  #
+  # To always disable this message:
+  # config.banner = false
+  #
+  # To display an alternative message:
+  # config.banner = "Hello, world!"
+  #
+  # Default:
+  config.banner = :auto
+
+  # You can control whether airbrussh shows the output of SSH commands. For
+  # brevity, the output is hidden by default.
+  #
+  # Display stdout of SSH commands. Stderr is not displayed.
+  # config.command_output = :stdout
+  #
+  # Display stderr of SSH commands. Stdout is not displayed.
+  # config.command_output = :stderr
+  #
+  # Display all SSH command output.
+  # config.command_output = [:stdout, :stderr]
+  # or
+  # config.command_output = true
+  #
+  # Default (all output suppressed):
+  config.command_output = false
 end
 ```
 
@@ -88,6 +137,8 @@ Airbrussh.configure do |config|
   config.monkey_patch_rake = false
   config.color = :auto
   config.truncate = :auto
+  config.banner = :auto
+  config.command_output = false
 end
 ```
 

data/lib/airbrussh/capistrano.rb

@@ -6,8 +6,6 @@ require "sshkit/formatter/airbrussh"
 Airbrussh.configure do |config|
   config.log_file = "log/capistrano.log"
   config.monkey_patch_rake = true
-  config.color = :auto
-  config.truncate = :auto
 end
 
 # Sanity check!

data/lib/airbrussh/configuration.rb

@@ -1,12 +1,29 @@
 module Airbrussh
   class Configuration
-    attr_accessor :log_file, :monkey_patch_rake, :color, :truncate
+    attr_accessor :log_file, :monkey_patch_rake, :color, :truncate, :banner,
+                  :command_output
 
     def initialize
       self.log_file = nil
       self.monkey_patch_rake = false
       self.color = :auto
       self.truncate = :auto
+      self.banner = :auto
+      self.command_output = false
+    end
+
+    def command_output_stdout?
+      command_output_include?(:stdout)
+    end
+
+    def command_output_stderr?
+      command_output_include?(:stderr)
+    end
+
+    private
+
+    def command_output_include?(sym)
+      command_output == true || Array(command_output).include?(sym)
     end
   end
 end

data/lib/airbrussh/formatter.rb

@@ -33,7 +33,7 @@ module Airbrussh
 
       @tasks = {}
 
-      @log_file = Airbrussh.configuration.log_file
+      @log_file = config.log_file
       @log_file_formatter = create_log_file_formatter
 
       @console = Airbrussh::Console.new(original_output)
@@ -53,9 +53,14 @@ module Airbrussh
     end
 
     def write_banner
-      return if @log_file.nil?
-      print_line "Using airbrussh format."
-      print_line "Verbose output is being written to #{blue(@log_file)}."
+      return unless config.banner
+      if config.banner == :auto
+        return if @log_file.nil?
+        print_line "Using airbrussh format."
+        print_line "Verbose output is being written to #{blue(@log_file)}."
+      else
+        print_line config.banner
+      end
     end
 
     def write_log_file_delimiter
@@ -72,7 +77,9 @@ module Airbrussh
     end
 
     def write(obj)
-      @log_file_formatter << obj
+      # SSHKit's :pretty formatter mutates the stdout and stderr data in the
+      # command obj. So we need to dup it to ensure our copy is unscathed.
+      @log_file_formatter << obj.dup
 
       case obj
       when SSHKit::Command    then write_command(obj)
@@ -114,12 +121,37 @@ module Airbrussh
         print_line "      #{number} #{description}"
       end
 
+      write_command_output(command, number)
+
       if command.finished?
         status = format_command_completion_status(command, number)
         print_line "    #{status}"
       end
     end
 
+    # Prints the data from the stdout and stderr streams of the given command,
+    # but only if enabled (see Airbrussh::Configuration#command_output).
+    def write_command_output(command, number)
+      # Use a bit of meta-programming here, since stderr and stdout logic
+      # are identical except for different method names.
+      %w(stderr stdout).each do |stream|
+
+        next unless config.public_send("command_output_#{stream}?")
+        output = command.public_send(stream)
+        next if output.empty?
+
+        output.lines.each do |line|
+          print_line "      #{number} #{line.chomp}"
+        end
+
+        # The stderr/stdout data provided by the command object is the current
+        # "chunk" as received over the wire. Since there may be more chunks
+        # appended and we don't want to print duplicates, clear the current
+        # data.
+        command.public_send("#{stream}=", "")
+      end
+    end
+
     def print_task_if_changed
       status = current_task_status
 
@@ -197,5 +229,9 @@ module Airbrussh
         string.to_s.colorize(color.to_sym)
       end
     end
+
+    def config
+      Airbrussh.configuration
+    end
   end
 end

data/lib/airbrussh/version.rb

@@ -1,3 +1,3 @@
 module Airbrussh
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrussh
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-02 00:00:00.000000000 Z
+date: 2015-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sshkit