airbrussh 0.8.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83498b571567499f13ecb5a978e2b8e1f8cdfaef
-  data.tar.gz: 1e7f3fe9e08f71b5e2a32ba2cb3a2801d8b70a88
+  metadata.gz: f88b5b67607156fb5e37627a35a23339f674090d
+  data.tar.gz: 221fc6a9042cf7cc2249246ef5d2efa7bbee4463
 SHA512:
-  metadata.gz: c9c0da68ef33be91854762fda31c785deb5e1b1ac55baabaa6784feecd391667077ac1407eeeb81c2f5cbbc5d9612b00f183fa1a55682877346fc9c1fd015760
-  data.tar.gz: 964c8a4e8ea43062932220f25c0cdf491e76e8cc9941633de90e81578bd15de577a39ebe6d70bfc9043be6fe2103b10ec210a18274b740891a33e2672ddb1531
+  metadata.gz: d447630e02fea68846d1430314f515e42ababbd83ccb35bbc08400269d2c6181c93cd2efc7a41ecfe489a6cce4f09dd46deeb97769ad51f4d3f5b8440dce834f
+  data.tar.gz: 1477b51b5db6c879015d1334efb8b5d10a0f9bd80515cef749803ceeb615474dbf8532dbb08124fbbb043d9242c7f4b7769ef7fae0c66bd4052d1551bae0ba72

data/.rubocop.yml

@@ -1,5 +1,3 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true

data/CHANGELOG.md

@@ -8,6 +8,13 @@ Airbrussh is in a pre-1.0 state. This means that its APIs and behavior are subje
 
 * Your contribution here!
 
+## [1.0.0.beta1][] (2015-12-27)
+
+* Airbrussh can now be configured with an options Hash passed to the
+  `Airbrussh::Formatter` constructor. This is in order to standardize how all
+  SSHKit formatters are configured
+  (see [SSHKit #308](https://github.com/capistrano/sshkit/pull/308)).
+
 ## [0.8.0][] (2015-11-20)
 
 * Airbrussh now displays the correct user@host output in the following edge-cases:
@@ -80,7 +87,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.8.0...HEAD
+[Unreleased]: https://github.com/mattbrictson/airbrussh/compare/v1.0.0.beta1...HEAD
+[1.0.0.beta1]: https://github.com/mattbrictson/airbrussh/compare/v0.8.0...v1.0.0.beta1
 [0.8.0]: https://github.com/mattbrictson/airbrussh/compare/v0.7.0...v0.8.0
 [0.7.0]: https://github.com/mattbrictson/airbrussh/compare/v0.6.0...v0.7.0
 [0.6.0]: https://github.com/mattbrictson/airbrussh/compare/v0.5.1...v0.6.0

data/lib/airbrussh.rb

@@ -3,8 +3,10 @@ require "airbrussh/formatter"
 require "airbrussh/version"
 
 module Airbrussh
-  def self.configuration
+  def self.configuration(options={})
+    return options if options.is_a?(::Airbrussh::Configuration)
     @configuration ||= Configuration.new
+    @configuration.apply_options(options)
   end
 
   def self.configure

data/lib/airbrussh/capistrano/tasks.rb

@@ -14,7 +14,7 @@ module Airbrussh
     #
     class Tasks
       extend Forwardable
-      def_delegators :dsl, :set
+      def_delegators :dsl, :set, :env
       def_delegators :config, :log_file
 
       include Airbrussh::Colors
@@ -36,6 +36,7 @@ module Airbrussh
 
       # Behavior for the rake deploy:failed task.
       def deploy_failed
+        return unless airbrussh_is_being_used?
         return if log_file.nil?
 
         error_line
@@ -85,6 +86,12 @@ module Airbrussh
           file.readlines.last(20).join
         end
       end
+
+      def airbrussh_is_being_used?
+        # Obtain the current formatter from the SSHKit backend
+        output = env.backend.config.output
+        output.is_a?(Airbrussh::Formatter)
+      end
     end
   end
 end

data/lib/airbrussh/configuration.rb

@@ -16,6 +16,19 @@ module Airbrussh
       self.command_output = false
     end
 
+    def apply_options(options)
+      return self if options.nil?
+
+      options.each do |key, value|
+        if respond_to?(writer = "#{key}=")
+          public_send(writer, value)
+        else
+          warn_unrecognized_key(key)
+        end
+      end
+      self
+    end
+
     def banner_message
       return nil unless banner
       return banner unless banner == :auto
@@ -39,5 +52,11 @@ module Airbrussh
     def show_command_output?(sym)
       command_output == true || Array(command_output).include?(sym)
     end
+
+    private
+
+    def warn_unrecognized_key(key)
+      $stderr.puts("Ignoring unrecognized Airbrussh option: #{key}")
+    end
   end
 end

data/lib/airbrussh/formatter.rb

@@ -8,7 +8,8 @@ require "airbrussh/delegating_formatter"
 #
 module Airbrussh
   class Formatter < Airbrussh::DelegatingFormatter
-    def initialize(io, config=::Airbrussh.configuration)
+    def initialize(io, options_or_config_object={})
+      config = ::Airbrussh.configuration(options_or_config_object)
       # Delegate to ConsoleFormatter and (optionally) LogFileFormatter,
       # based on the configuration.
       super(config.formatters(io))

data/lib/airbrussh/version.rb

@@ -1,3 +1,3 @@
 module Airbrussh
-  VERSION = "0.8.0"
+  VERSION = "1.0.0.beta1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrussh
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-20 00:00:00.000000000 Z
+date: 2015-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sshkit
@@ -139,7 +139,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -184,12 +183,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Airbrussh pretties up your SSHKit and Capistrano output

data/.rubocop_todo.yml

@@ -1,21 +0,0 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-05-10 16:52:41 -0700 using RuboCop version 0.31.0.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 168
-
-# Offense count: 5
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 15
-
-# Offense count: 1
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Enabled: false