airbrussh 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66dc41c940b4eac6103d25a09fa19e9fee07a863
+  data.tar.gz: ad675ee93d5b7e6bcfebbee06e7d9ee5ca384832
+SHA512:
+  metadata.gz: fb2efbcfc660c198270768b65126d63efa2a503ff780dce66f59ecaa8b723231b534051c674e00dbef0834edf3b40e97e3fe6255c2877e8f0dbc38c4d5a3496c
+  data.tar.gz: 2350aacf020830da113e3664402fa95ca20bb2f23681ad8d18720d5ba5a6683842da0ede62b757b7843617a6d4f0241cc2e61e07b1edbb1d5468601b31f682e0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1 (2015-02-19)
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in airbrussh.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Matt Brictson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,113 @@
+# Airbrussh
+
+[![Gem Version](https://badge.fury.io/rb/airbrussh.svg)](http://badge.fury.io/rb/airbrussh)
+
+
+**Airbrussh is a replacement log formatter for SSHKit that makes your Capistrano output much easier on the eyes.** Just add it to your Capfile and enjoy concise, useful log output that is easy to read.
+
+And don't worry: airbrussh saves Capistrano's default verbose output to a separate log file just in case you still need it for troubleshooting.
+
+![Sample output](https://raw.github.com/mattbrictson/airbrussh/master/demo.gif)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "airbrussh", :require => false
+```
+
+And then execute:
+
+    $ bundle
+
+Finally, add this line to your application's Capfile:
+
+```ruby
+require "airbrussh/capistrano"
+```
+
+**Important:** explicitly setting Capistrano's `:format` option in your deploy.rb will override airbrussh. Remove this line if you have it:
+
+```ruby
+# Remove this
+set :format, :pretty
+```
+
+## Usage
+
+Airbrussh automatically replaces the default Capistrano log formatter, so there is nothing more you have to do. Just run `cap` as normal and enjoy the prettier output!
+
+**Advanced:** Airbrussh can be configured by calling `Airbrussh.configure` in your `deploy.rb` file. You can do stage-specific configuration in e.g. `deploy/production.rb` as well. Here are the available options:
+
+```ruby
+Airbrussh.configure do |config|
+  # Capistrano's default, un-airbrusshed output is saved to a file to
+  # 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:
+  # config.truncate = 80
+  # Or to disable truncation entirely:
+  # config.truncate = false
+  # Default:
+  config.truncate = :auto
+end
+```
+
+## Usage outside of Capistrano
+
+If you are using SSHKit directly, you can use Airbrussh without the Capistrano magic:
+
+```ruby
+require "airbrussh"
+SSHKit.config.output = Airbrussh::Formatter.new
+```
+
+When Capistrano is not present, Airbrussh uses a slightly different default configuration:
+
+```ruby
+Airbrussh.configure do |config|
+  config.log_file = nil
+  config.monkey_patch_rake = false
+  config.color = :auto
+  config.truncate = :auto
+end
+```
+
+## History
+
+Airbrussh started life as custom logging code within the [capistrano-fiftyfive][] collection of opinionated Capistrano recipes. In February 2015, the logging code was refactored into a standalone gem with its own configuration and documentation, and renamed `airbrussh`. Now anyone can using SSHKit or Capistrano can safely plug it into their projects!
+
+## Roadmap
+
+Airbrussh needs work! The first priority is to add tests. Once good test coverage is in place, some clean up and refactoring is needed to make the core formatting code easier to understand.
+
+If you have ideas for other improvements, please contribute!
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/airbrussh/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[capistrano-fiftyfive]: https://github.com/mattbrictson/capistrano-fiftyfive

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+end
+
+task :default => :test

data/airbrussh.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "airbrussh/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "airbrussh"
+  spec.version       = Airbrussh::VERSION
+  spec.authors       = ["Matt Brictson"]
+  spec.email         = ["airbrussh@mattbrictson.com"]
+  spec.summary       = "Airbrussh pretties up your SSHKit and Capistrano output"
+  spec.description   = "Airbrussh is a replacement log formatter for SSHKit "\
+                       "that makes your Capistrano output much easier on the "\
+                       "eyes. Just add it to your Capfile and enjoy concise, "\
+                       "useful log output that is easy to read."
+  spec.homepage      = "https://github.com/mattbrictson/airbrussh"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sshkit", ">= 1.6.1"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+end

data/lib/airbrussh.rb

@@ -0,0 +1,17 @@
+require "airbrussh/configuration"
+require "airbrussh/formatter"
+require "airbrussh/version"
+
+module Airbrussh
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/airbrussh/capistrano.rb

@@ -0,0 +1,36 @@
+require "airbrussh"
+require "colorize"
+require "sshkit/formatter/airbrussh"
+
+# airbrush/capistrano uses a different default configuration
+Airbrussh.configure do |config|
+  config.log_file = "log/capistrano.log"
+  config.monkey_patch_rake = true
+  config.color = :auto
+  config.truncate = :auto
+end
+
+# Sanity check!
+unless defined?(Capistrano) && defined?(:namespace)
+  $stderr.puts\
+    "WARNING: airbrussh/capistrano must be loaded by Capistrano in order "\
+    "to work.\n"\
+    "Require this gem within your application's Capfile, as described here:\n"\
+    "https://github.com/mattbrictson/airbrussh#installation"\
+    .colorize(:red)
+end
+
+# Hook into Capistrano's init process to set the formatter
+namespace :load do
+  task :defaults do
+    set :format, :airbrussh
+  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)
+  end
+end

data/lib/airbrussh/configuration.rb

@@ -0,0 +1,12 @@
+module Airbrussh
+  class Configuration
+    attr_accessor :log_file, :monkey_patch_rake, :color, :truncate
+
+    def initialize
+      self.log_file = nil
+      self.monkey_patch_rake = false
+      self.color = :auto
+      self.truncate = :auto
+    end
+  end
+end

data/lib/airbrussh/console.rb

@@ -0,0 +1,80 @@
+require "io/console"
+
+module Airbrussh
+  # Helper class that wraps an IO object and provides methods for truncating
+  # output, assuming the IO object represents a console window.
+  #
+  # This is useful for writing log messages that will typically show up on
+  # an ANSI color-capable console. When a console is not present (e.g. when
+  # running on a CI server) the output will gracefully degrade.
+  class Console
+    def initialize(output)
+      @output = output
+    end
+
+    # Writes to the IO after first truncating the output to fit the console
+    # width. If the underlying IO is not a TTY, ANSI colors are removed from
+    # the output. A newline is always added. Color output can be forced by
+    # setting the SSHKIT_COLOR environment variable.
+    def print_line(obj="")
+      string = obj.to_s
+
+      if console_width
+        string = truncate_to_console_width(string)
+      end
+      unless color_enabled?
+        string = strip_ascii_color(string)
+      end
+
+      write(string + "\n")
+      @output.flush
+    end
+
+    # Writes directly through to the IO with no truncation or color logic.
+    # No newline is added.
+    def write(string)
+      @output.write(string || "")
+    end
+    alias_method :<<, :write
+
+    def truncate_to_console_width(string)
+      string = (string || "").rstrip
+      width = console_width
+
+      if strip_ascii_color(string).length > width
+        while strip_ascii_color(string).length >= width
+          string.chop!
+        end
+        string << "…\e[0m"
+      else
+        string
+      end
+    end
+
+    def strip_ascii_color(string)
+      (string || "").gsub(/\033\[[0-9;]*m/, "")
+    end
+
+    def console_width
+      case (truncate = Airbrussh.configuration.truncate)
+      when :auto
+        IO.console.winsize.last if @output.tty?
+      when Fixnum
+        truncate
+      end
+    end
+
+    private
+
+    def color_enabled?
+      case Airbrussh.configuration.color
+      when true
+        true
+      when :auto
+        ENV["SSHKIT_COLOR"] || @output.tty?
+      else
+        false
+      end
+    end
+  end
+end

data/lib/airbrussh/formatter.rb

@@ -0,0 +1,203 @@
+require "airbrussh/console"
+require "colorize"
+require "ostruct"
+require "sshkit"
+
+# TODO: honor Airbrussh.configuration!
+
+module Airbrussh
+  class Formatter < SSHKit::Formatter::Abstract
+    class << self
+      attr_accessor :current_rake_task
+
+      def monkey_patch_rake_task!
+        return unless Airbrussh.configuration.monkey_patch_rake
+        return if @rake_patched
+
+        eval(<<-EVAL)
+          class ::Rake::Task
+            alias_method :_original_execute_airbrussh, :execute
+            def execute(args=nil)
+              #{name}.current_rake_task = name
+              _original_execute_airbrussh(args)
+            end
+          end
+        EVAL
+
+        @rake_patched = true
+      end
+    end
+
+    def initialize(io)
+      super
+
+      self.class.monkey_patch_rake_task!
+
+      @tasks = {}
+
+      @log_file = Airbrussh.configuration.log_file
+      @log_file_formatter = create_log_file_formatter
+
+      @console = Airbrussh::Console.new(original_output)
+      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, 20971520)
+      )
+    end
+
+    def print_line(string)
+      @console.print_line(string)
+    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)}."
+    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 write(obj)
+      @log_file_formatter << obj
+
+      case obj
+      when SSHKit::Command    then write_command(obj)
+      when SSHKit::LogMessage then write_log_message(obj)
+      end
+    end
+    alias :<< :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
+
+    def write_log_message(log_message)
+      return unless log_message.verbosity >= SSHKit::Logger::INFO
+      print_task_if_changed
+      @console.print_line(light_black("      " + log_message.to_s))
+    end
+
+    def write_command(command)
+      return unless command.verbosity > SSHKit::Logger::DEBUG
+
+      print_task_if_changed
+
+      ctx = context_for_command(command)
+      number = '%02d' % ctx.number
+
+      if ctx.first_execution?
+        description = yellow(ctx.shell_string)
+        print_line "      #{number} #{description}"
+      end
+
+      if command.finished?
+        status = format_command_completion_status(command, number)
+        print_line "    #{status}"
+      end
+    end
+
+    def print_task_if_changed
+      status = current_task_status
+
+      if status.changed && !status.task.empty?
+        print_line "#{clock} #{blue(status.task)}"
+      end
+    end
+
+    def current_task_status
+      task = self.class.current_rake_task.to_s
+      if @tasks[task]
+        changed = false
+      else
+        changed = true
+        @tasks[task] = []
+      end
+
+      OpenStruct.new(
+        :task => task,
+        :commands => @tasks[task],
+        :changed => changed
+      )
+    end
+
+    def context_for_command(command)
+      status = current_task_status
+      task_commands = status.commands
+
+      shell_string = command.to_s.sub(%r(^/usr/bin/env ), "")
+
+      if task_commands.include?(shell_string)
+        first_execution = false
+      else
+        first_execution = true
+        task_commands << shell_string
+      end
+
+      number = task_commands.index(shell_string) + 1
+
+      OpenStruct.new({
+        :first_execution? => first_execution,
+        :number => number,
+        :shell_string => shell_string
+      })
+    end
+
+    def format_command_completion_status(command, number)
+      user = command.user { command.host.user }
+      host = command.host.to_s
+      user_at_host = [user, host].join("@")
+
+      status = if command.failure?
+        red("✘ #{number} #{user_at_host} (see #{@log_file} for details)")
+      else
+        green("✔ #{number} #{user_at_host}")
+      end
+
+      runtime = light_black("%5.3fs" % command.runtime)
+
+      status + " " + runtime
+    end
+
+    def clock
+      @start_at ||= Time.now
+      duration = Time.now - @start_at
+
+      minutes = (duration / 60).to_i
+      seconds = (duration - minutes * 60).to_i
+
+      "%02d:%02d" % [minutes, seconds]
+    end
+
+    %w(light_black red blue green yellow).each do |color|
+      define_method(color) do |string|
+        string.to_s.colorize(color.to_sym)
+      end
+    end
+  end
+end

data/lib/airbrussh/version.rb

@@ -0,0 +1,3 @@
+module Airbrussh
+  VERSION = "0.0.1"
+end

data/lib/sshkit/formatter/airbrussh.rb

@@ -0,0 +1,12 @@
+require "airbrussh/formatter"
+
+# Capistrano's formatter configuration requires that the formatter class
+# be in the SSHKit::Formatter namespace. So we declare
+# SSHKit::Formatter::Airbrussh that simply functions as an alias for
+# Airbrussh::Formatter.
+module SSHKit
+  module Formatter
+    class Airbrussh < Airbrussh::Formatter
+    end
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "airbrussh"
+
+require "minitest/autorun"
+require "minitest/reporters"
+
+Minitest::Reporters.use!(
+  Minitest::Reporters::ProgressReporter.new,
+  ENV,
+  Minitest.backtrace_filter
+)

data/test/test_airbrussh.rb

@@ -0,0 +1,11 @@
+require "minitest_helper"
+
+class TestAirbrussh < MiniTest::Unit::TestCase
+  def test_that_it_has_a_version_number
+    refute_nil ::Airbrussh::VERSION
+  end
+
+  def test_it_does_something_useful
+    assert false
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: airbrussh
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matt Brictson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: 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: minitest-reporters
+  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: Airbrussh is a replacement log formatter for SSHKit that makes your Capistrano
+  output much easier on the eyes. Just add it to your Capfile and enjoy concise, useful
+  log output that is easy to read.
+email:
+- airbrussh@mattbrictson.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- airbrussh.gemspec
+- demo.gif
+- lib/airbrussh.rb
+- lib/airbrussh/capistrano.rb
+- lib/airbrussh/configuration.rb
+- lib/airbrussh/console.rb
+- lib/airbrussh/formatter.rb
+- lib/airbrussh/version.rb
+- lib/sshkit/formatter/airbrussh.rb
+- test/minitest_helper.rb
+- test/test_airbrussh.rb
+homepage: https://github.com/mattbrictson/airbrussh
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Airbrussh pretties up your SSHKit and Capistrano output
+test_files:
+- test/minitest_helper.rb
+- test/test_airbrussh.rb