Remove the need for an external dependency for ANSI color

[mattbrictson]

I think SSHKit's ANSI color needs are simple enough that we do not need to depend on a third-party gem (colorize). The colorize dependency has been a source of bugs.

Instead, we could implement a simple module that provides various colorizing methods. These methods could be used as module functions, or mixed in to the class where they are needed for convenience.

I did this for airbrussh, and it has worked well so far:

module Airbrussh
  # Very basic support for ANSI color, so that we don't have to rely on
  # any external dependencies.
  module Colors
    ANSI_CODES = {
      :red    => 31,
      :green  => 32,
      :yellow => 33,
      :blue   => 34,
      :gray   => 90
    }.freeze

    module_function

    # Define red, green, blue, etc. methods that return a copy of the
    # String that is wrapped in the corresponding ANSI color escape
    # sequence.
    ANSI_CODES.each do |name, code|
      define_method(name) do |string|
        "\e[0;#{code};49m#{string}\e[0m"
      end
    end
  end
end

If there is interest I can create a PR for SSHKit.

[robd]

I think this would be good. The main (only?) place in SSHKit where this is used is the Color class. I am in favour of having an API with a single method name (eg colorize) where the color is passed in as a symbol (rather than separate methods for each color). This makes the code easier if you need to pass the colour around without having to call send(:color_name), and it also means that IDEs don't get confused when searching for usages.

The Pretty formatter also uses bold formatting, so the API could be simplified in that respect because it currently accepts any of the colorize formats (:underline, :blink etc), but only :bold is needed.

[leehambley]

If been holding off on this because I rarely run into the colorize bug, and
printing colours without respecting terminfo is bad practice, but let's
take a step in the right direction here!
On 24 Jun 2015 9:40 pm, "Rob Dupuis" [email protected] wrote:

I think this would be good. The main (only?) place in SSHKit where this is
used is the Color
https://github.com/capistrano/sshkit/blob/master/lib/sshkit/color.rb
class. I am in favour of having an API with a single method name (eg
colorize) where the color is passed in as a symbol (rather than separate
methods for each color). This makes the code easier if you need to pass
the colour around

sshkit/lib/sshkit/formatters/pretty.rb

Line 26 in bd4f49c

color = case stream_type

without having to call send(:color_name), and it also means that IDEs
don't get confused when searching for usages.

The Pretty formatter also uses bold formatting, so the API could be
simplified in that respect because it currently accepts any of the colorize
formats (:underline, :blink etc
https://github.com/fazibear/colorize/blob/0523bea5747f9b7b823c79b2935bdd880cb301e8/lib/colorize/class_methods.rb#L77-L82
).

—
Reply to this email directly or view it on GitHub
#263 (comment).

[mattbrictson]

Great! I'll get a PR started.

[mattbrictson]

Voilà! Transformed this issue into a PR. Let me know what you think.

[leehambley]

Merged :) Thanks @mattbrictson.

Terminal colour code support, and font weighting, etc is a much more complex topic than many realise, and I hope to make time to do a decent integration in SSH kit sometime that actually works correctly.