capistrano-simple-formatter 0.1.0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    capistrano-simple-formatter (0.2)
+      colored (~> 1.2)
+      highline (~> 1.6.21)
+      sshkit (~> 1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colored (1.2)
+    colorize (0.7.3)
+    highline (1.6.21)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.1)
+    rake (10.3.2)
+    sshkit (1.5.1)
+      colorize
+      net-scp (>= 1.1.2)
+      net-ssh (>= 2.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  capistrano-simple-formatter!
+  rake

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Rodrigo Díaz
+
+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,89 @@
+# Capistrano Simple Formatter
+
+Simple formatter for Capistrano 3.
+
+## Installation
+
+With bundler:
+
+```ruby
+gem 'capistrano-simple-formatter'
+```
+
+or without bundler:
+
+```ruby
+$ gem install capistrano-simple-formatter
+
+require 'capistrano-simple-formatter'
+```
+
+## Usage
+
+Set the Capistrano `format` to `:simple`:
+
+```ruby
+# deploy.rb
+
+set :format, :simple
+```
+
+Then, within any `task` block you can access the formatter through `SSHKit.config.output`, or just `output` within an `on` block.
+
+### Examples
+
+Hook into Capistrano callbacks:
+
+```ruby
+before('deploy:restart', :log_before_deploy_restart) do
+  SSHKit.config.output.start("Restarting apps")
+end
+
+after('deploy:restart', :log_after_deploy_restart) do
+  SSHKit.config.output.success
+end
+```
+
+Log on your tasks:
+
+```ruby
+task(:link_files) do
+  on roles(:app) do
+    output.start "Linking files in #{host}"
+    # Do your work
+
+    if success
+      output.success
+    else
+      output.error 'Something went wrong :('
+    end
+  end
+end
+```
+
+Log nested:
+
+```ruby
+namespace(:delayed_jobs) do
+  task(:status) do
+    SSHKit.config.output.start("Checking delayed_job status...") do
+      on roles(:apps), in: :parallel do
+        status = run_delayed_job_command(:status) # Your magic
+
+        if status.match(/delayed_job: no instances running/)
+          output.error "Not running in #{host}"
+        elsif matches = status.match(/delayed_job: running \[pid (?<pid>\d+)\]/)
+          output.success "Running in #{host} with pid #{matches[:pid]}"
+        else
+          output.info status
+        end
+      end
+    end
+  end
+end
+```
+
+## TODO
+* Output samples
+* Examples file
+* Specs

data/Rakefile

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

data/capistrano-simple-formatter.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+require 'capistrano-simple-formatter'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano-simple-formatter'
+  spec.version       = CapistranoSimpleFormatter::VERSION
+  spec.authors       = ['Rodrigo Díaz V.']
+  spec.email         = ['rdiazv89@gmail.com']
+  spec.summary       = 'Simple formatter for logging Capistrano tasks'
+  spec.description   = 'Simple formatter for logging Capistrano tasks'
+  spec.homepage      = 'https://github.com/rdiazv/capistrano-simple-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 'colored', '~> 1.2'
+  spec.add_dependency 'sshkit', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano-simple-formatter/spinner.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+module CapistranoSimpleFormatter
+  class Spinner
+    CHARS = ['|', '/', '-', '\\']
+
+    def initialize
+      @running = false
+    end
+
+    def start
+      return if @running
+
+      @running = true
+      @thread = Thread.new do
+        while @running do
+          print CHARS.rotate!.first
+          sleep 0.1
+          print "\b"
+        end
+      end
+    end
+
+    def stop
+      return unless @running
+
+      @running = false
+      @thread.join
+    end
+  end
+end

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

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

data/lib/capistrano-simple-formatter.rb

@@ -0,0 +1,3 @@
+require 'capistrano-simple-formatter/version'
+require 'capistrano-simple-formatter/spinner'
+require 'sshkit/formatter/simple'

data/lib/sshkit/formatter/simple.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+require 'sshkit'
+
+module SSHKit
+  module Formatter
+    class Simple < Abstract
+      def initialize(original_output)
+        super(original_output)
+
+        @spinner = CapistranoSimpleFormatter::Spinner.new
+        @in_block = false
+      end
+
+      def start(message, &block)
+        @spinner.start
+
+        begin
+          if block_given?
+            @in_block = true
+            puts "\b#{message}".yellow
+            block.call()
+            stop
+            @in_block = false
+          else
+            print "\b#{message}   ".yellow
+          end
+        rescue Exception => e
+          stop
+          @in_block = false
+          error("\n X ERROR: #{e.message}\n")
+          raise e
+        end
+      end
+
+      def stop
+        @spinner.stop
+      end
+
+      def result(message)
+        if @in_block
+          print "\b"
+          message = "  ├── #{message}"
+        else
+          stop
+        end
+
+        puts(message)
+      end
+
+      def info(message)
+        result(message)
+      end
+
+      def error(message = 'X')
+        result(message.red)
+      end
+
+      def success(message = '✔')
+        result(message.green)
+      end
+
+      def write(message) end
+
+      alias :<< :write
+    end
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-simple-formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Rodrigo Díaz V.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple formatter for logging Capistrano tasks
+email:
+- rdiazv89@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- capistrano-simple-formatter.gemspec
+- lib/capistrano-simple-formatter.rb
+- lib/capistrano-simple-formatter/spinner.rb
+- lib/capistrano-simple-formatter/version.rb
+- lib/sshkit/formatter/simple.rb
+homepage: https://github.com/rdiazv/capistrano-simple-formatter
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple formatter for logging Capistrano tasks
+test_files: []