airbrussh 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02f8bd2273940b9050a9d466bc880c7754909dda
-  data.tar.gz: d4891e7491c900d0de3cf1cfbc50aab88fd64aba
+  metadata.gz: 83498b571567499f13ecb5a978e2b8e1f8cdfaef
+  data.tar.gz: 1e7f3fe9e08f71b5e2a32ba2cb3a2801d8b70a88
 SHA512:
-  metadata.gz: 40bcc8d15dcc408b4fafc53b159cf9bedcd4bdaa55f5010f2bd0ce97988cb84c72c69abedb24b9ca3847ed22046d65f7a511a313a7bb0232d3e06eff0ec2717a
-  data.tar.gz: d0a209836a4d667ec2f58081e6a335c0540ef5e5767a01c6c20001ee65f46eb3fa7e2fda0c34abf01e2ac7b52f5d7764f3943fb774e1ca5679d5f4e66cd624d4
+  metadata.gz: c9c0da68ef33be91854762fda31c785deb5e1b1ac55baabaa6784feecd391667077ac1407eeeb81c2f5cbbc5d9612b00f183fa1a55682877346fc9c1fd015760
+  data.tar.gz: 964c8a4e8ea43062932220f25c0cdf491e76e8cc9941633de90e81578bd15de577a39ebe6d70bfc9043be6fe2103b10ec210a18274b740891a33e2672ddb1531

data/.rubocop.yml

@@ -1,6 +1,8 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
   Exclude:
     - "*.gemspec"
 
@@ -33,3 +35,6 @@ Style/SpaceAroundEqualsInParameterDefault:
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  AllowPredicates: true

data/CHANGELOG.md

@@ -8,6 +8,12 @@ Airbrussh is in a pre-1.0 state. This means that its APIs and behavior are subje
 
 * Your contribution here!
 
+## [0.8.0][] (2015-11-20)
+
+* Airbrussh now displays the correct user@host output in the following edge-cases:
+    * Inside an SSHKit `as(:user => "...")` block
+    * When a user is specified using `set :ssh_options, :user => "..."` ([see #65](https://github.com/mattbrictson/airbrussh/issues/65))
+
 ## [0.7.0][] (2015-08-08)
 
 Fixes:
@@ -74,7 +80,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.7.0...HEAD
+[Unreleased]: https://github.com/mattbrictson/airbrussh/compare/v0.8.0...HEAD
+[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
 [0.5.1]: https://github.com/mattbrictson/airbrussh/compare/v0.5.0...v0.5.1

data/Gemfile

@@ -30,3 +30,6 @@ if (sshkit_version = ENV["sshkit"])
   end
   gem "sshkit", requirement
 end
+
+# net-ssh 3.0+ is not compatible with Ruby 1.9, so pin at older version.
+gem "net-ssh", "~> 2.8" if RUBY_VERSION == "1.9.3"

data/README.md

@@ -52,7 +52,46 @@ set :format, :pretty
 
 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:
+For advanced usage, refer to the these sections below:
+
+* [FAQ](#faq)
+* [Advanced configuration](#advanced-configuration)
+* [Usage outside of Capistrano](#usage-outside-of-capistrano)
+
+## FAQ
+
+**Airbrussh is not displaying the output of my commands! For example, I run `tail` in one of my capistrano tasks and airbrussh doesn't show anything. How do I fix this?**
+
+For brevity, airbrussh mutes all output (stdout and stderr) of commands by default. To show all output, add this to your `deploy.rb` (see also the other [configuration options](#advanced-configuration) later in this README):
+
+```ruby
+Airbrussh.configure do |config|
+  config.command_output = true
+end
+```
+
+**Does airbrussh work with Capistrano 2?**
+
+No, Capistrano 3 is required. We recommend Capistrano 3.4.0 or higher.
+
+**Does airbrussh work with JRuby?**
+
+JRuby is not officially supported or tested, but may work. You must disable automatic truncation to work around a known bug in the JRuby 9.0.1.0 standard library. See [#62](https://github.com/mattbrictson/airbrussh/issues/62) for more details.
+
+```ruby
+Airbrussh.configure do |config|
+  # Disable automatic truncation for JRuby compatibility
+  config.truncate = false
+end
+```
+
+**I have a question that’s not answered here or elsewhere in the README.**
+
+Please [open a GitHub issue](https://github.com/mattbrictson/airbrussh/issues/new) and we’ll be happy to help!
+
+## Advanced configuration
+
+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|
@@ -148,13 +187,11 @@ 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!
+Airbrussh started life as custom logging code within the [capistrano-mb][] 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!
+Airbrussh will most likely be integrated as the default formatter in a future release of SSHKit or Capistrano. If you have any suggestions for how to make this migration a smooth one, or if you have other ideas for improvements to Airbrussh, please add your comment to the discussion in [GitHub issue #39](https://github.com/mattbrictson/airbrussh/issues/39).
 
 ## Development
 
@@ -168,4 +205,4 @@ Airbrussh is designed to work against multiple versions of SSHKit and Ruby. In o
 
 Contributions are welcome! Read [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
 
-[capistrano-fiftyfive]: https://github.com/mattbrictson/capistrano-fiftyfive
+[capistrano-mb]: https://github.com/mattbrictson/capistrano-mb

data/lib/airbrussh/command_formatter.rb

@@ -58,9 +58,9 @@ module Airbrussh
     private
 
     def user_at_host
-      user_str = user { host.user }
-      host_str = host.to_s
-      [user_str, host_str].join("@")
+      user_str = host.user || (host.ssh_options || {})[:user]
+      host_str = host.hostname
+      [user_str, host_str].compact.join("@")
     end
 
     def runtime

data/lib/airbrussh/version.rb

@@ -1,3 +1,3 @@
 module Airbrussh
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: airbrussh
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Matt Brictson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-08 00:00:00.000000000 Z
+date: 2015-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sshkit