capistrano-compact-formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80c6060c648bcb4a580a9af765e190b9aeeaa1ed
+  data.tar.gz: 8d6d900c7d816e2eb3ede84c9bb27d7839019e68
+SHA512:
+  metadata.gz: e5685429e25b90176f518aa2a69d7f1d216506bc6d5578c622fc681b9af34dbae55dcc55c4ddc6de0cffd566f91859233d96b0829cf2c9e355a4e8bb19be94e6
+  data.tar.gz: 13d3d7edf1684fcd4be3b9879abd9f2c907ca5f3d462f7e425a4c23ee67e536b0b3453cb9545e84594267166788a7fb4f6ad18ae1e95e8a471f6f286e8a7b613

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Miguel Palhas
+
+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,56 @@
+# Capistrano Compact Formatter
+
+Custom formatter for Capistrano 3, with compact output, and opinionated according to my own needs.
+
+I don't like the built-in formatters from sshkit. They're too verbose in debug mode, but too little verbose otherwise. Everytime an error occurred while using `set :debug, :info`, I would find myself changing it back to `:debug` to see the actual error messages.
+
+A quick breakdown of what it does:
+
+* no difference for each log level. I might add this in the future, but at this point, I didn't feel the need;
+* each command is printed in a single line, containing a trimmed message and a success flag;
+* if a command has output in stdout/stderr, it will be printed below, with a leading tab, in green/red respectively;
+* conditional commands (i.e. commands with the format `[ some_bash_condition ]`) will not be printed. They return frequently return false, which would output a red failure flag. I find that misleading, since it doesn't mean the deploy failed. It's merely a condition that evaluated to false.
+
+Sample output:
+
+![Sample Output](sample-output.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-compact-formatter'
+```
+
+Or install it yourself as:
+
+    $ gem install capistrano-compact-formatter
+
+## Usage
+
+And require it in your `Capfile`
+
+```ruby
+# Capfile
+
+require 'capistrano-compact-formatter'
+```
+
+Then in your `config/deploy.rb`, specify the formatter to use:
+
+```ruby
+# config/deploy.rb
+
+set :format, :compact
+```
+
+And you're all set!
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/capistrano-compact-formatter/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

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/capistrano-compact-formatter.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-compact-formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-compact-formatter'
+  spec.version       = CapistranoCompactFormatter::VERSION
+  spec.authors       = ['Miguel Palhas']
+  spec.email         = ['mpalhas@gmail.com']
+  spec.summary       = %q{A compact formatter for capistrano 3}
+  spec.description   = %q{A compact formatter for capistrano 3}
+  spec.homepage      = 'https://github.com/naps62/capistrano-compact-formatter'
+  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.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/capistrano-compact-formatter.rb

@@ -0,0 +1,2 @@
+require 'capistrano-compact-formatter/version'
+require 'sshkit/formatter/compact'

data/lib/capistrano-compact-formatter/version.rb

@@ -0,0 +1,3 @@
+module CapistranoCompactFormatter
+  VERSION = '0.1.0'
+end

data/lib/sshkit/formatter/compact.rb

@@ -0,0 +1,74 @@
+module SSHKit
+  module Formatter
+    class Compact < Abstract
+      CMD_LEN = 80
+      CMD_SPACE = 10
+
+      def initialize(*args)
+        super
+        @stdout = StringIO.new
+        @stderr = StringIO.new
+      end
+
+      def write(obj)
+        case obj
+        when SSHKit::Command then write_command(obj)
+        when SSHKit::LogMessage then write_log_message(obj)
+        else
+          original_output << c.black(c.on_yellow("Output formatter doesn't know how to handle #{obj.class}\n"))
+        end
+      end
+
+      alias :<< :write
+
+      private
+
+      def write_command(command)
+        return if command.to_command[0] == '['
+
+        command_start = pretty_command(command)[0..CMD_LEN-1].ljust(CMD_LEN).gsub(/[^\s]{3}$/, '...').ljust(CMD_LEN+CMD_SPACE)
+
+        if !command.started?
+          original_output << c.blue(command_start)
+        end
+
+
+        @stdout << formatted_stream(command.stdout)
+        @stderr << formatted_stream(command.stderr)
+
+        if command.finished?
+          original_output << c.bold { command.failure? ? c.red('failure') : c.green('success') }
+          original_output << "\n"
+
+          if command.failure?
+            original_output << c.red(command.to_command)
+          end
+
+          original_output << c.green(@stdout.string)
+          original_output << c.red(@stderr.string)
+
+          @stdout = StringIO.new
+          @stderr = StringIO.new
+        end
+      end
+
+      def write_log_message(log_message)
+        original_output << "  #{log_message.to_s}"
+      end
+
+      def c
+        Color
+      end
+
+      def pretty_command(command)
+        "#{command.command} #{command.args.join(' ')}"
+      end
+
+      def formatted_stream(stream)
+        stream.lines.map do |line|
+          "\t#{line}"
+        end.join('\n')
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-compact-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Miguel Palhas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: A compact formatter for capistrano 3
+email:
+- mpalhas@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-compact-formatter.gemspec
+- lib/capistrano-compact-formatter.rb
+- lib/capistrano-compact-formatter/version.rb
+- lib/sshkit/formatter/compact.rb
+- sample-output.png
+homepage: https://github.com/naps62/capistrano-compact-formatter
+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.5
+signing_key: 
+specification_version: 4
+summary: A compact formatter for capistrano 3
+test_files: []