airbrussh 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e49b6c7756e1907e6a3cf024e9f90b811c3fae43
-  data.tar.gz: 0d721e07a866d4cb7c65e283ee172d760eadc1fa
+  metadata.gz: a8636d9e6c1f9b44d7a760d970edd17cdfe08de8
+  data.tar.gz: 94139691e2b02c1b24b42c4df7f6a2aa9924ca45
 SHA512:
-  metadata.gz: fc1aa66f2be55a796d7adbb03a4d142fcdc53cb22bd2c1800880ffec261997bad86f2a4029c87918ad481e09166235369e80a31246d5de51d7f6a8e60751ac9b
-  data.tar.gz: 974909bb9964735a526f8c19b423d95ab83136c367e25e503e5dcee436aa68cd8c12faceb951e42cac5cab12a258693c8af3cfc07f35451ab953396363a75ce2
+  metadata.gz: cc9a2939655844b55ad9c006e5e2cd3866bf93ef8c095107a461e77ad692d705ceca5ccec52d2857c83128c5371f98f75d96a2fc0f2f8cb37827614963ac186f
+  data.tar.gz: bb6aba0f61291ce8050273d0e3631227b703d7ac8498341ab830ebd7aa6eb19139589a2171c1c624a44f17a06899396fb01396a9bd297b2f245896b177d8d8d2

data/.travis.yml

@@ -6,8 +6,6 @@ rvm:
   - 2.2
 env:
   - sshkit="master"
-  # This is the old master before https://github.com/capistrano/sshkit/pull/257 was merged
-  - sshkit="ea211bcbbb71dab0152a18c2774922b7017e4edc"
   - sshkit="= 1.7.1"
   - sshkit="= 1.6.1"
-before_install: gem install bundler --conservative --version '~> 1.8'
+before_install: gem install bundler --conservative --version '~> 1.10'

data/CHANGELOG.md

@@ -8,6 +8,16 @@ Airbrussh is in a pre-1.0 state. This means that its APIs and behavior are subje
 
 * Your contribution here!
 
+## [0.6.0][] (2015-07-10)
+
+This is another release with mostly behind-the-scenes changes. If you notice any differences in Airbrussh's behavior in this version, [please report an issue](https://github.com/mattbrictson/airbrussh/issues).
+
+Other changes:
+
+* Bundler 1.10 is now required to build and test airbrussh (this doesn't affect users of airbrussh at all).
+* If the directory containing the log file doesn't exist, Airbrussh will now attempt to create it using `FileUtils.mkdir_p` ([#30](https://github.com/mattbrictson/airbrussh/issues/30))
+* By default Airbrussh now always prints `Using airbrussh format.` when it starts up. In previous versions, a bug caused this message to sometimes not be shown. To change or disable this message, set the `banner` configuration option as explained in the README.
+
 ## [0.5.1][] (2015-06-24)
 
 * Fix `NameError: uninitialized constant Airbrussh::SimpleDelegator`
@@ -52,7 +62,8 @@ There are, however, many behind-the-scenes changes and improvements to overall c
 * Initial release
 
 [Semver]: http://semver.org
-[Unreleased]: https://github.com/mattbrictson/airbrussh/compare/v0.5.1...HEAD
+[Unreleased]: https://github.com/mattbrictson/airbrussh/compare/v0.6.0...HEAD
+[0.6.0]: https://github.com/mattbrictson/airbrussh/compare/v0.5.1...v0.6.0
 [0.5.1]: https://github.com/mattbrictson/airbrussh/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/mattbrictson/airbrussh/compare/v0.4.1...v0.5.0
 [0.4.1]: https://github.com/mattbrictson/airbrussh/compare/v0.4.0...v0.4.1

data/CONTRIBUTING.md

@@ -16,11 +16,17 @@ Have a feature idea, bug fix, or refactoring suggestion? Contributions are welco
 
 ## Getting started
 
-After checking out the repo, run `bin/setup` to install dependencies.
+Note that Bundler 1.10 is required for development. Run `gem update bundler` to get the latest version.
+
+After checking out the airbrussh repo, run `bin/setup` to install dependencies.
 
 * `rake` executes airbrussh's tests and RuboCop checks
 * `bin/test_all.rb` executes the tests against all versions of SSHKit that airbrussh supports
-* `guard` monitors the filesystem and automatically runs tests as you work
+
+A Guardfile is also present, so if you'd like to use Guard to do a TDD workflow, then:
+
+1. Run `bundle install --with extras` to get the optional guard dependencies
+2. Run `guard` to monitor the filesystem and automatically run tests as you work
 
 [Issues]: https://github.com/mattbrictson/airbrussh/issues
 [RuboCop]: https://github.com/bbatsov/rubocop

data/Gemfile

@@ -3,6 +3,19 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in airbrussh.gemspec
 gemspec
 
+# Optional development dependencies; requires bundler >= 1.10.
+# Note that these gems assume a Ruby 2.2 environment. Install them using:
+#
+# bundle install --with extras
+#
+group :extras, :optional => true do
+  gem "chandler"
+  gem "guard", ">= 2.2.2"
+  gem "guard-minitest"
+  gem "rb-fsevent"
+  gem "terminal-notifier-guard"
+end
+
 if (sshkit_version = ENV["sshkit"])
   requirement = begin
     Gem::Dependency.new("sshkit", sshkit_version).requirement

data/Rakefile

@@ -10,9 +10,11 @@ end
 require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
-if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.1.0")
+# rubocop:disable Lint/HandleExceptions
+begin
   require "chandler/tasks"
-  task "release:rubygem_push" => "chandler:push"
+rescue LoadError
 end
+task "release:rubygem_push" => "chandler:push" if defined?(Chandler)
 
 task :default => [:test, :rubocop]

data/airbrussh.gemspec

@@ -23,18 +23,11 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "sshkit", [">= 1.6.1", "!= 1.7.0"]
 
-  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "guard", ">= 2.2.2"
-  spec.add_development_dependency "guard-minitest"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rb-fsevent"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "mocha"
   spec.add_development_dependency "rubocop", ">= 0.31.0"
-  spec.add_development_dependency "terminal-notifier-guard"
-
-  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.1.0")
-    spec.add_development_dependency "chandler"
-  end
 end

data/bin/test_all.rb

@@ -9,6 +9,8 @@ YAML.load_file(".travis.yml")["env"].each do |sshkit_version|
   system("#{sshkit_version} bundle exec rake test")
 end
 
+system("bundle exec rake rubocop")
+
 at_exit do
   puts "\e[0;34;49m== Resetting sshkit ==\e[0m"
   system("bundle update")

data/lib/airbrussh/capistrano.rb

@@ -1,34 +1,17 @@
-require "airbrussh"
-require "airbrussh/colors"
-require "sshkit/formatter/airbrussh"
+require "airbrussh/capistrano/tasks"
 
-# airbrush/capistrano uses a different default configuration
-Airbrussh.configure do |config|
-  config.log_file = "log/capistrano.log"
-  config.monkey_patch_rake = true
-end
-
-# Sanity check!
-unless defined?(Capistrano) && defined?(:namespace)
-  $stderr.puts(
-    Airbrussh::Colors.red(
-      "WARNING: airbrussh/capistrano must be loaded by Capistrano in order "\
-      "to work.\nRequire this gem within your application's Capfile, as "\
-      "described here:\nhttps://github.com/mattbrictson/airbrussh#installation"
-    ))
-end
+tasks = Airbrussh::Capistrano::Tasks.new(self)
 
 # Hook into Capistrano's init process to set the formatter
 namespace :load do
   task :defaults do
-    set :format, :airbrussh
+    tasks.load_defaults
   end
 end
 
 # Capistrano failure hook
 namespace :deploy do
   task :failed do
-    output = env.backend.config.output
-    output.on_deploy_failure if output.respond_to?(:on_deploy_failure)
+    tasks.deploy_failed
   end
 end

data/lib/airbrussh/capistrano/tasks.rb

@@ -0,0 +1,80 @@
+require "airbrussh"
+require "airbrussh/colors"
+require "airbrussh/console"
+require "forwardable"
+require "shellwords"
+
+module Airbrussh
+  module Capistrano
+    # Encapsulates the rake behavior that integrates Airbrussh into Capistrano.
+    # This class allows us to easily test the behavior using a mock to stand in
+    # for the Capistrano DSL.
+    #
+    # See airbrussh/capistrano.rb to see how this class is used.
+    #
+    class Tasks
+      extend Forwardable
+      def_delegators :dsl, :set
+      def_delegators :config, :log_file
+
+      include Airbrussh::Colors
+
+      def initialize(dsl, stderr=$stderr, config=Airbrussh.configuration)
+        @dsl = dsl
+        @stderr = stderr
+        @config = config
+
+        configure
+        warn_if_missing_dsl
+      end
+
+      # Behavior for the rake load:defaults task.
+      def load_defaults
+        require "sshkit/formatter/airbrussh"
+        set :format, :airbrussh
+      end
+
+      # Behavior for the rake deploy:failed task.
+      def deploy_failed
+        return if log_file.nil?
+
+        error_line
+        error_line(red("** DEPLOY FAILED"))
+        error_line(yellow("** Refer to #{log_file} for details. "\
+                          "Here are the last 20 lines:"))
+        error_line
+        error_line(`tail -n 20 #{log_file.shellescape} 2>&1`)
+      end
+
+      private
+
+      attr_reader :dsl, :stderr, :config
+
+      # Change airbrussh's default configuration to be more appropriate for
+      # capistrano.
+      def configure
+        config.log_file = "log/capistrano.log"
+        config.monkey_patch_rake = true
+      end
+
+      # Verify that capistrano and rake DSLs are present
+      def warn_if_missing_dsl
+        return if %w(set namespace task).all? { |m| dsl.respond_to?(m, true) }
+
+        error_line(
+          red("WARNING: airbrussh/capistrano must be loaded by Capistrano in "\
+              "order to work.\nRequire this gem within your application's "\
+              "Capfile, as described here:\n"\
+              "https://github.com/mattbrictson/airbrussh#installation"))
+      end
+
+      def err_console
+        @err_console ||= Airbrussh::Console.new(stderr)
+      end
+
+      def error_line(line="\n")
+        line.each_line(&err_console.method(:print_line))
+      end
+    end
+  end
+end

data/lib/airbrussh/colors.rb

@@ -10,8 +10,6 @@ module Airbrussh
       :gray   => 90
     }.freeze
 
-    module_function
-
     # Define red, green, blue, etc. methods that return a copy of the
     # String that is wrapped in the corresponding ANSI color escape
     # sequence.
@@ -19,6 +17,7 @@ module Airbrussh
       define_method(name) do |string|
         "\e[0;#{code};49m#{string}\e[0m"
       end
+      module_function(name)
     end
   end
 end

data/lib/airbrussh/command_formatter.rb

@@ -4,10 +4,20 @@ require "delegate"
 # rubocop:disable Style/AsciiComments
 
 module Airbrussh
-  # Decorates an SSHKit::Command to add string output helpers.
+  # Decorates an SSHKit Command to add string output helpers and the
+  # command's position within currently executing rake task:
+  #
+  # * position - zero-based position of this command in the list of
+  #              all commands that have been run in the current rake task
+  #  class CommandFormatter < SimpleDelegator
   class CommandFormatter < SimpleDelegator
     include Airbrussh::Colors
 
+    def initialize(command, position)
+      super(command)
+      @position = position
+    end
+
     # Prefixes the line with the command number and removes the newline.
     #
     # format_output("hello\n") # => "01 hello"
@@ -62,7 +72,7 @@ module Airbrussh
     end
 
     def number
-      format("%02d", position + 1)
+      format("%02d", @position + 1)
     end
 
     def success_message

data/lib/airbrussh/configuration.rb

@@ -1,3 +1,7 @@
+require "airbrussh/colors"
+require "airbrussh/console_formatter"
+require "airbrussh/log_file_formatter"
+
 module Airbrussh
   class Configuration
     attr_accessor :log_file, :monkey_patch_rake, :color, :truncate, :banner,
@@ -12,17 +16,27 @@ module Airbrussh
       self.command_output = false
     end
 
-    def command_output_stdout?
-      command_output_include?(:stdout)
+    def banner_message
+      return nil unless banner
+      return banner unless banner == :auto
+      msg = "Using airbrussh format."
+      if log_file
+        msg << "\n"
+        msg << "Verbose output is being written to #{Colors.blue(log_file)}."
+      end
+      msg
     end
 
-    def command_output_stderr?
-      command_output_include?(:stderr)
+    # This returns an array of formatters appropriate for the configuration.
+    # Depending on whether a log file is configured, this could be just the
+    # Airbrussh:ConsoleFormatter, or that plus the LogFileFormatter.
+    def formatters(io)
+      fmts = [Airbrussh::ConsoleFormatter.new(io, self)]
+      fmts.unshift(Airbrussh::LogFileFormatter.new(log_file)) if log_file
+      fmts
     end
 
-    private
-
-    def command_output_include?(sym)
+    def show_command_output?(sym)
       command_output == true || Array(command_output).include?(sym)
     end
   end

data/lib/airbrussh/console_formatter.rb

@@ -0,0 +1,120 @@
+require "airbrussh/colors"
+require "airbrussh/command_formatter"
+require "airbrussh/console"
+require "airbrussh/rake/context"
+require "sshkit"
+
+module Airbrussh
+  class ConsoleFormatter < SSHKit::Formatter::Abstract
+    include Airbrussh::Colors
+    extend Forwardable
+
+    attr_reader :config, :context
+    def_delegators :context, :current_task_name, :register_new_command
+
+    def initialize(io, config=Airbrussh.configuration)
+      super(io)
+
+      @config = config
+      @context = Airbrussh::Rake::Context.new(config)
+      @console = Airbrussh::Console.new(original_output, config)
+
+      write_banner
+    end
+
+    def write_banner
+      print_line(config.banner_message) if config.banner_message
+    end
+
+    def log_command_start(command)
+      return if debug?(command)
+      first_execution = register_new_command(command)
+      command = decorate(command)
+      print_task_if_changed
+      print_indented_line(command.start_message) if first_execution
+    end
+
+    def log_command_data(command, stream_type, string)
+      return if debug?(command)
+      return unless config.show_command_output?(stream_type)
+      command = decorate(command)
+      string.each_line do |line|
+        print_indented_line(command.format_output(line))
+      end
+    end
+
+    def log_command_exit(command)
+      return if debug?(command)
+      command = decorate(command)
+      print_indented_line(command.exit_message(@log_file), -2)
+    end
+
+    def write(obj)
+      case obj
+      when SSHKit::Command
+        log_command_start(obj)
+        log_and_clear_command_output(obj, :stderr)
+        log_and_clear_command_output(obj, :stdout)
+        log_command_exit(obj) if obj.finished?
+      when SSHKit::LogMessage
+        write_log_message(obj)
+      end
+    end
+    alias_method :<<, :write
+
+    private
+
+    attr_accessor :last_printed_task
+
+    def write_log_message(log_message)
+      return if debug?(log_message)
+      print_task_if_changed
+      print_indented_line(gray(log_message.to_s))
+    end
+
+    # For SSHKit versions up to and including 1.7.1, the stdout and stderr
+    # output was available as attributes on the Command. Print the data for
+    # the specified command and stream if enabled and clear the stream.
+    # (see Airbrussh::Configuration#command_output).
+    def log_and_clear_command_output(command, stream)
+      output = command.public_send(stream)
+      log_command_data(command, stream, output)
+      command.public_send("#{stream}=", "")
+    end
+
+    def print_task_if_changed
+      return if current_task_name.nil?
+      return if current_task_name == last_printed_task
+
+      self.last_printed_task = current_task_name
+      print_line("#{clock} #{blue(current_task_name)}")
+    end
+
+    def clock
+      @start_at ||= Time.now
+      duration = Time.now - @start_at
+
+      minutes = (duration / 60).to_i
+      seconds = (duration - minutes * 60).to_i
+
+      format("%02d:%02d", minutes, seconds)
+    end
+
+    def debug?(obj)
+      obj.verbosity <= SSHKit::Logger::DEBUG
+    end
+
+    def decorate(command)
+      Airbrussh::CommandFormatter.new(command, @context.position(command))
+    end
+
+    def print_line(string)
+      @console.print_line(string)
+    end
+
+    def print_indented_line(string, offset=0)
+      indent = " " * (6 + offset)
+      print_line([indent, string].join)
+    end
+  end
+end

data/lib/airbrussh/delegating_formatter.rb

@@ -0,0 +1,44 @@
+require "sshkit"
+
+module Airbrussh
+  # This class quacks like an SSHKit::Formatter, but when any formatting
+  # methods are called, it simply forwards them to one more more concrete
+  # formatters. This allows us to split out the responsibilities of
+  # ConsoleFormatter and LogFileFormatter into two separate classes, with
+  # DelegatingFormatter forwarding the logging messages to both at once.
+  #
+  class DelegatingFormatter
+    FORWARD_METHODS = %w(
+      fatal error warn info debug log
+      log_command_start log_command_data log_command_exit
+    )
+    DUP_AND_FORWARD_METHODS = %w(<< write)
+
+    attr_reader :formatters
+
+    def initialize(formatters)
+      @formatters = formatters
+    end
+
+    FORWARD_METHODS.each do |method|
+      define_method(method) do |*args|
+        formatters.map { |f| f.public_send(method, *args) }.last
+      end
+    end
+
+    # For versions of SSHKit up to and including 1.7.1, the LogfileFormatter
+    # and ConsoleFormatter (and all of SSHKit's built in formatters) clear
+    # the stdout and stderr data in the command obj. Therefore, ensure only
+    # one of the formatters (the last one) gets the original command. This is
+    # also the formatter whose return value is passed to the caller.
+    #
+    DUP_AND_FORWARD_METHODS.each do |method|
+      define_method(method) do |command_or_log_message|
+        formatters[0...-1].each do |f|
+          f.public_send(method, command_or_log_message.dup)
+        end
+        formatters.last.public_send(method, command_or_log_message)
+      end
+    end
+  end
+end

data/lib/airbrussh/formatter.rb

@@ -1,182 +1,17 @@
-require "airbrussh/colors"
-require "airbrussh/command_formatter"
-require "airbrussh/command_output"
-require "airbrussh/console"
-require "airbrussh/rake/command"
-require "airbrussh/rake/context"
-require "sshkit"
-
+require "airbrussh"
+require "airbrussh/delegating_formatter"
+
+# This is the formatter class that conforms to the SSHKit Formatter API and
+# provides the airbrussh functionality to SSHKit. Note however that this class
+# doesn't do much by itself; instead, it delegates to the ConsoleFormatter
+# and (optionally) the LogFileFormatter, which handle the bulk of the logic.
+#
 module Airbrussh
-  class Formatter < SSHKit::Formatter::Abstract
-    include Airbrussh::Colors
-    extend Forwardable
-
-    attr_reader :config, :context
-    def_delegator :context, :current_task_name
-
-    def initialize(io, config=Airbrussh.configuration)
-      super(io)
-
-      @config = config
-      @context = Airbrussh::Rake::Context.new(config)
-
-      @log_file = config.log_file
-      @log_file_formatter = create_log_file_formatter
-
-      @console = Airbrussh::Console.new(original_output, config)
-      write_log_file_delimiter
-      write_banner
-    end
-
-    def create_log_file_formatter
-      return SSHKit::Formatter::BlackHole.new(nil) if @log_file.nil?
-      SSHKit::Formatter::Pretty.new(
-        ::Logger.new(@log_file, 1, 20_971_520)
-      )
-    end
-
-    def write_banner
-      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
-      delimiter = []
-      delimiter << "-" * 75
-      delimiter << "START #{Time.now} cap #{ARGV.join(' ')}"
-      delimiter << "-" * 75
-      delimiter.each do |line|
-        @log_file_formatter << SSHKit::LogMessage.new(
-          SSHKit::Logger::INFO,
-          line
-        )
-      end
-    end
-
-    def log_command_start(command)
-      command = decorate(command)
-      @log_file_formatter.log_command_start(command)
-      write_command_start(command)
-    end
-
-    def log_command_data(command, stream_type, line)
-      command = decorate(command)
-      @log_file_formatter.log_command_data(command, stream_type, line)
-      write_command_output_line(command, stream_type, line)
-    end
-
-    def log_command_exit(command)
-      command = decorate(command)
-      @log_file_formatter.log_command_exit(command)
-      write_command_exit(command)
-    end
-
-    def write(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
-        command = decorate(obj)
-        write_command_start(command)
-        write_command_output(command)
-        write_command_exit(command) if command.finished?
-      when SSHKit::LogMessage
-        write_log_message(obj)
-      end
-    end
-    alias_method :<<, :write
-
-    def on_deploy_failure
-      return if @log_file.nil?
-      err = Airbrussh::Console.new($stderr)
-      err.print_line
-      err.print_line(red("** DEPLOY FAILED"))
-      err.print_line(yellow("** Refer to #{@log_file} for details. "\
-                            "Here are the last 20 lines:"))
-      err.print_line
-      system("tail -n 20 #{@log_file.shellescape} 1>&2")
-    end
-
-    private
-
-    attr_accessor :last_printed_task
-
-    def write_log_message(log_message)
-      return if debug?(log_message)
-      print_task_if_changed
-      print_indented_line(gray(log_message.to_s))
-    end
-
-    def write_command_start(command)
-      return if debug?(command)
-      print_task_if_changed
-      print_indented_line(command.start_message) if command.first_execution?
-    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)
-      # 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|
-        CommandOutput.for(command).each_line(stream) do |line|
-          write_command_output_line(command, stream, line)
-        end
-      end
-    end
-
-    def write_command_output_line(command, stream, line)
-      hide_command_output = !config.public_send("command_output_#{stream}?")
-      return if hide_command_output || debug?(command)
-      print_indented_line(command.format_output(line))
-    end
-
-    def print_task_if_changed
-      return if current_task_name.nil?
-      return if current_task_name == last_printed_task
-
-      self.last_printed_task = current_task_name
-      print_line("#{clock} #{blue(current_task_name)}")
-    end
-
-    def write_command_exit(command)
-      return if debug?(command)
-      print_indented_line(command.exit_message(@log_file), -2)
-    end
-
-    def clock
-      @start_at ||= Time.now
-      duration = Time.now - @start_at
-
-      minutes = (duration / 60).to_i
-      seconds = (duration - minutes * 60).to_i
-
-      format("%02d:%02d", minutes, seconds)
-    end
-
-    def debug?(obj)
-      obj.verbosity <= SSHKit::Logger::DEBUG
-    end
-
-    def decorate(command)
-      Airbrussh::CommandFormatter.new(@context.decorate_command(command))
-    end
-
-    def print_line(string)
-      @console.print_line(string)
-    end
-
-    def print_indented_line(string, offset=0)
-      indent = " " * (6 + offset)
-      print_line([indent, string].join)
+  class Formatter < Airbrussh::DelegatingFormatter
+    def initialize(io, config=::Airbrussh.configuration)
+      # Delegate to ConsoleFormatter and (optionally) LogFileFormatter,
+      # based on the configuration.
+      super(config.formatters(io))
     end
   end
 end

data/lib/airbrussh/log_file_formatter.rb

@@ -0,0 +1,42 @@
+require "delegate"
+require "fileutils"
+require "logger"
+require "sshkit"
+
+module Airbrussh
+  # A Pretty formatter that sends its output to a specified log file path.
+  # LogFileFormatter takes care of creating the file (and its parent
+  # directory) if it does not already exist, opens it for appending, and writes
+  # a delimiter message. The file is automatically rotated if it reaches 20 MB.
+  #
+  class LogFileFormatter < SimpleDelegator
+    attr_reader :path
+
+    def initialize(path, formatter_class=SSHKit::Formatter::Pretty)
+      @path = path
+      ensure_directory_exists if path.is_a?(String)
+      super(formatter_class.new(log_file_io))
+      write_delimiter
+    end
+
+    private
+
+    def write_delimiter
+      delimiter = []
+      delimiter << "-" * 75
+      delimiter << "START #{Time.now} cap #{ARGV.join(' ')}"
+      delimiter << "-" * 75
+      delimiter.each do |line|
+        write(SSHKit::LogMessage.new(SSHKit::Logger::INFO, line))
+      end
+    end
+
+    def ensure_directory_exists
+      FileUtils.mkdir_p(File.dirname(path))
+    end
+
+    def log_file_io
+      @io ||= ::Logger.new(path, 1, 20_971_520)
+    end
+  end
+end

data/lib/airbrussh/rake/context.rb

@@ -1,5 +1,4 @@
 require "rake"
-require "airbrussh/rake/command"
 
 module Airbrussh
   module Rake
@@ -23,20 +22,24 @@ module Airbrussh
         self.class.current_task_name
       end
 
-      # Decorate an SSHKit Command with Rake::Command to provide additional
-      # context-sensitive information.
-      def decorate_command(command)
+      # Update the context when a new command starts by:
+      # * Clearing the command history if the rake task has changed
+      # * Recording the command in the history
+      #
+      # Returns whether or not this command was the first execution
+      # of this command in the current rake task
+      def register_new_command(command)
         reset_history_if_task_changed
 
         first_execution = !history.include?(command.to_s)
         history << command.to_s
         history.uniq!
+        first_execution
+      end
 
-        Airbrussh::Rake::Command.new(
-          command,
-          first_execution,
-          history.index(command.to_s)
-        )
+      # The position of the specified command in the current rake task
+      def position(command)
+        history.index(command.to_s)
       end
 
       class << self

data/lib/airbrussh/version.rb

@@ -1,3 +1,3 @@
 module Airbrussh
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrussh
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-24 00:00:00.000000000 Z
+date: 2015-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sshkit
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.10'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -58,34 +58,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.2.2
-- !ruby/object:Gem::Dependency
-  name: guard-minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,7 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -115,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -156,34 +128,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.31.0
-- !ruby/object:Gem::Dependency
-  name: terminal-notifier-guard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: chandler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: A replacement log formatter for SSHKit that makes Capistrano output much
   easier on the eyes. Just add Airbrussh to your Capfile and enjoy concise, useful
   log output that is easy to read.
@@ -211,13 +155,15 @@ files:
 - demo.gif
 - lib/airbrussh.rb
 - lib/airbrussh/capistrano.rb
+- lib/airbrussh/capistrano/tasks.rb
 - lib/airbrussh/colors.rb
 - lib/airbrussh/command_formatter.rb
-- lib/airbrussh/command_output.rb
 - lib/airbrussh/configuration.rb
 - lib/airbrussh/console.rb
+- lib/airbrussh/console_formatter.rb
+- lib/airbrussh/delegating_formatter.rb
 - lib/airbrussh/formatter.rb
-- lib/airbrussh/rake/command.rb
+- lib/airbrussh/log_file_formatter.rb
 - lib/airbrussh/rake/context.rb
 - lib/airbrussh/version.rb
 - lib/sshkit/formatter/airbrussh.rb

data/lib/airbrussh/command_output.rb

@@ -1,42 +0,0 @@
-module Airbrussh
-  # A facade that provides access to stdout and stderr command output of
-  # sshkit commands. This is needed to normalize the API differences in
-  # various sshkit versions.
-  class CommandOutput
-    def self.for(command)
-      if command.respond_to?(:clear_stdout_lines)
-        Modern.new(command)
-      else
-        Legacy.new(command)
-      end
-    end
-
-    attr_reader :command
-
-    def initialize(command)
-      @command = command
-    end
-  end
-
-  class Legacy < CommandOutput
-    # The stderr/stdout methods provided by the command object have 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.
-    def each_line(stream, &block)
-      output = command.public_send(stream)
-      return if output.empty?
-      output.lines.to_a.each(&block)
-      command.public_send("#{stream}=", "")
-    end
-  end
-
-  class Modern < CommandOutput
-    # Newer versions of sshkit take care of clearing the output with the
-    # clear_stdout_lines/clear_stderr_lines methods.
-    def each_line(stream, &block)
-      lines = command.public_send("clear_#{stream}_lines")
-      return if lines.join.empty?
-      lines.each(&block)
-    end
-  end
-end

data/lib/airbrussh/rake/command.rb

@@ -1,26 +0,0 @@
-require "delegate"
-
-module Airbrussh
-  module Rake
-    # Decorates an SSHKit Command to add Rake-specific contextual information:
-    #
-    # * first_execution? - is this the first time this command has been run in
-    #                      the context of the current rake task?
-    # * position - zero-based position of this command in the list of
-    #              all commands that have been run in the current rake task
-    #
-    class Command < SimpleDelegator
-      attr_reader :first_execution, :position
-
-      def initialize(command, first_execution, position)
-        super(command)
-        @first_execution = first_execution
-        @position = position
-      end
-
-      def first_execution?
-        first_execution
-      end
-    end
-  end
-end