sshkit 0.0.1 → 0.0.2

data/.gitignore

@@ -1,2 +1,3 @@
+*.gem
 .vagrant
 test/tmp

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+## Changelog
+
+This file is written in reverse chronological order, newer releases will
+appear at the top.
+
+## 0.0.2
+
+* Include a *Pretty* formatter
+* Modify example to use Pretty formatter.
+* Move common behaviour to an abstract formatter.
+* Formatters no longer inherit StringIO
+
+## 0.0.1
+
+First release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    deploy (0.0.1)
+    sshkit (0.0.1)
       net-ssh
       term-ansicolor
 
@@ -58,11 +58,11 @@ PLATFORMS
 DEPENDENCIES
   autotest
   debugger
-  deploy!
   minitest (>= 2.11.3, < 2.12.0)
   mocha
   rake
   redcarpet
+  sshkit!
   turn
   unindent
   vagrant

data/example.rb

@@ -7,53 +7,11 @@ $: << Dir.pwd + '/lib/'
 # Automatically sucks in the `sshkit`
 # files so that you don't need to.
 require 'sshkit/dsl'
-require 'forwardable'
-require 'term/ansicolor'
 
 directory = '/opt/sites/web_application'
 hosts     = SSHKit::Host.new("root@example.com")
 
-#
-# Custom output formatter!
-#
-class ColorizedFormatter < StringIO
-  extend Forwardable
-  attr_reader :original_output
-  def_delegators :@original_output, :read, :rewind
-
-  def initialize(oio)
-    @original_output = oio
-  end
-
-  def write(obj)
-    if obj.is_a? SSHKit::Command
-      unless obj.started?
-        original_output << "[#{c.green(obj.uuid)}] Running #{c.yellow(c.bold(String(obj)))} on #{c.yellow(obj.host.to_s)}\n"
-      end
-      if obj.complete? && !obj.stdout.empty?
-        obj.stdout.lines.each do |line|
-          original_output << c.green("\t" + line)
-        end
-      end
-      if obj.complete? && !obj.stderr.empty?
-        obj.stderr.lines.each do |line|
-          original_output << c.red("\t" + line)
-        end
-      end
-      if obj.finished?
-        original_output << "[#{c.green(obj.uuid)}] Finished in #{sprintf('%5.3f seconds', obj.runtime)} command #{c.bold { obj.failure? ? c.red('failed') : c.green('successful') }}.\n"
-      end
-    else
-      original_output << c.black(c.on_yellow("Output formatter doesn't know how to handle #{obj.inspect}\n"))
-    end
-  end
-  private
-  def c
-    @c ||= Term::ANSIColor
-  end
-end
-
-SSHKit.config.output = ColorizedFormatter.new($stdout)
+SSHKit.config.output = SSHKit::Formatter::Pretty.new($stdout)
 
 on hosts do |host|
   target = '/opt/rack-rack-repository'

data/lib/sshkit/all.rb

@@ -8,6 +8,10 @@ require_relative 'command'
 require_relative 'configuration'
 require_relative 'connection_manager'
 
+require_relative 'formatters/abstract'
+require_relative 'formatters/black_hole'
+require_relative 'formatters/pretty'
+
 require_relative 'backends/abstract'
 require_relative 'backends/printer'
 require_relative 'backends/netssh'

data/lib/sshkit/formatters/abstract.rb

@@ -0,0 +1,26 @@
+require 'forwardable'
+
+module SSHKit
+
+  module Formatter
+
+    class Abstract
+
+      extend Forwardable
+      attr_reader :original_output
+      def_delegators :@original_output, :read, :rewind
+
+      def initialize(oio)
+        @original_output = oio
+      end
+
+      def write(obj)
+        raise "Abstract formatter should not be used directly, maybe you want SSHKit::Formatter::BlackHole"
+      end
+      alias :<< :write
+
+    end
+
+  end
+
+end

data/lib/sshkit/formatters/black_hole.rb

@@ -0,0 +1,16 @@
+module SSHKit
+
+  module Formatter
+
+    class BlackHole < Abstract
+
+      def write(obj)
+        # Nothing, nothing to do
+      end
+      alias :<< :write
+
+    end
+
+  end
+
+end

data/lib/sshkit/formatters/pretty.rb

@@ -0,0 +1,43 @@
+require 'term/ansicolor'
+
+module SSHKit
+
+  module Formatter
+
+    class Pretty < Abstract
+
+      def write(obj)
+        if obj.is_a? SSHKit::Command
+          unless obj.started?
+            original_output << "[#{c.green(obj.uuid)}] Running #{c.yellow(c.bold(String(obj)))} on #{c.yellow(obj.host.to_s)}\n"
+          end
+          if obj.complete? && !obj.stdout.empty?
+            obj.stdout.lines.each do |line|
+              original_output << c.green("\t" + line)
+            end
+          end
+          if obj.complete? && !obj.stderr.empty?
+            obj.stderr.lines.each do |line|
+              original_output << c.red("\t" + line)
+            end
+          end
+          if obj.finished?
+            original_output << "[#{c.green(obj.uuid)}] Finished in #{sprintf('%5.3f seconds', obj.runtime)} command #{c.bold { obj.failure? ? c.red('failed') : c.green('successful') }}.\n"
+          end
+        else
+          original_output << c.black(c.on_yellow("Output formatter doesn't know how to handle #{obj.inspect}\n"))
+        end
+      end
+      alias :<< :write
+
+      private
+
+      def c
+        @c ||= Term::ANSIColor
+      end
+
+    end
+
+  end
+
+end

data/lib/sshkit/version.rb

@@ -1,3 +1,3 @@
 module SSHKit
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sshkit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -248,6 +248,9 @@ files:
 - lib/sshkit/configuration.rb
 - lib/sshkit/connection_manager.rb
 - lib/sshkit/dsl.rb
+- lib/sshkit/formatters/abstract.rb
+- lib/sshkit/formatters/black_hole.rb
+- lib/sshkit/formatters/pretty.rb
 - lib/sshkit/host.rb
 - lib/sshkit/version.rb
 - sshkit.gemspec