Merge pull request #103 from Shopify/at-remove-colorize

Use our own shell coloration helper

Author: Morriar

Gemfile.lock

@@ -2,7 +2,6 @@ PATH
   remote: .
   specs:
     spoom (1.1.4)
-      colorize
       sorbet (>= 0.5.9204)
       sorbet-runtime (>= 0.5.9204)
       thor (>= 0.19.2)
@@ -13,7 +12,6 @@ GEM
     ast (2.4.1)
     byebug (11.1.3)
     coderay (1.1.3)
-    colorize (0.8.1)
     method_source (1.0.0)
     minitest (5.14.3)
     parallel (1.19.2)

lib/spoom.rb

@@ -1,7 +1,6 @@
 # typed: true
 # frozen_string_literal: true
 
-require "colorize"
 require "sorbet-runtime"
 
 module Spoom
@@ -27,6 +26,7 @@ def self.exec(cmd, *arg, path: '.', capture_err: false)
   end
 end
 
+require "spoom/colors"
 require "spoom/sorbet"
 require "spoom/cli"
 require "spoom/version"

lib/spoom/cli/helper.rb

@@ -11,6 +11,8 @@ module Helper
       extend T::Sig
       extend T::Helpers
 
+      include Colorize
+
       requires_ancestor { Thor }
 
       # Print `message` on `$stdout`
@@ -84,7 +86,7 @@ def sorbet_config
       # Colors
 
       # Color used to highlight expressions in backticks
-      HIGHLIGHT_COLOR = :blue
+      HIGHLIGHT_COLOR = T.let(Spoom::Color::BLUE, Spoom::Color)
 
       # Is the `--color` option true?
       sig { returns(T::Boolean) }
@@ -116,35 +118,35 @@ def highlight(string)
       end
 
       # Colorize a string if `color?`
-      sig { params(string: String, color: Symbol).returns(String) }
-      def colorize(string, color)
+      sig { params(string: String, color: Color).returns(String) }
+      def colorize(string, *color)
         return string unless color?
-        string.colorize(color)
+        T.unsafe(self).set_color(string, *color)
       end
 
       sig { params(string: String).returns(String) }
       def blue(string)
-        colorize(string, :blue)
+        colorize(string, Color::BLUE)
       end
 
       sig { params(string: String).returns(String) }
       def gray(string)
-        colorize(string, :light_black)
+        colorize(string, Color::LIGHT_BLACK)
       end
 
       sig { params(string: String).returns(String) }
       def green(string)
-        colorize(string, :green)
+        colorize(string, Color::GREEN)
       end
 
       sig { params(string: String).returns(String) }
       def red(string)
-        colorize(string, :red)
+        colorize(string, Color::RED)
       end
 
       sig { params(string: String).returns(String) }
       def yellow(string)
-        colorize(string, :yellow)
+        colorize(string, Color::YELLOW)
       end
     end
   end

lib/spoom/colors.rb

@@ -0,0 +1,45 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Spoom
+  class Color < T::Enum
+    extend T::Sig
+
+    enums do
+      CLEAR           = new("\e[0m")
+      BOLD            = new("\e[1m")
+
+      BLACK           = new("\e[30m")
+      RED             = new("\e[31m")
+      GREEN           = new("\e[32m")
+      YELLOW          = new("\e[33m")
+      BLUE            = new("\e[34m")
+      MAGENTA         = new("\e[35m")
+      CYAN            = new("\e[36m")
+      WHITE           = new("\e[37m")
+
+      LIGHT_BLACK     = new("\e[90m")
+      LIGHT_RED       = new("\e[91m")
+      LIGHT_GREEN     = new("\e[92m")
+      LIGHT_YELLOW    = new("\e[93m")
+      LIGHT_BLUE      = new("\e[94m")
+      LIGHT_MAGENTA   = new("\e[95m")
+      LIGHT_CYAN      = new("\e[96m")
+      LIGHT_WHITE     = new("\e[97m")
+    end
+
+    sig { returns(String) }
+    def ansi_code
+      serialize
+    end
+  end
+
+  module Colorize
+    extend T::Sig
+
+    sig { params(string: String, color: Color).returns(String) }
+    def set_color(string, *color)
+      "#{color.map(&:ansi_code).join}#{string}#{Color::CLEAR.ansi_code}"
+    end
+  end
+end

lib/spoom/file_tree.rb

@@ -156,7 +156,7 @@ def print_node(node)
           end
           print("\n")
         else
-          print_colored(node.name, :blue)
+          print_colored(node.name, Color::BLUE)
           print("/")
           printn
           indent
@@ -180,15 +180,15 @@ def node_strictness(node)
         Spoom::Sorbet::Sigils.file_strictness(path)
       end
 
-      sig { params(strictness: T.nilable(String)).returns(Symbol) }
+      sig { params(strictness: T.nilable(String)).returns(Color) }
       def strictness_color(strictness)
         case strictness
         when "false"
-          :red
+          Color::RED
         when "true", "strict", "strong"
-          :green
+          Color::GREEN
         else
-          :uncolored
+          Color::CLEAR
         end
       end
     end

lib/spoom/printer.rb

@@ -8,6 +8,8 @@ class Printer
     extend T::Sig
     extend T::Helpers
 
+    include Colorize
+
     abstract!
 
     sig { returns(T.any(IO, StringIO)) }
@@ -42,11 +44,10 @@ def print(string)
     # Print `string` colored with `color` into `out`
     #
     # Does not use colors unless `@colors`.
-    sig { params(string: T.nilable(String), color: Symbol, colors: Symbol).void }
-    def print_colored(string, color, *colors)
+    sig { params(string: T.nilable(String), color: Color).void }
+    def print_colored(string, *color)
       return unless string
-      string = colorize(string, color)
-      colors.each { |c| string = colorize(string, c) }
+      string = T.unsafe(self).colorize(string, *color)
       @out.print(string)
     end
 
@@ -72,9 +73,10 @@ def printt
     end
 
     # Colorize `string` with color if `@colors`
-    sig { params(string: String, color: Symbol).returns(String) }
-    def colorize(string, color)
-      @colors ? string.colorize(color) : string
+    sig { params(string: String, color: Spoom::Color).returns(String) }
+    def colorize(string, *color)
+      return string unless @colors
+      T.unsafe(self).set_color(string, *color)
     end
   end
 end

lib/spoom/sorbet/lsp/structures.rb

@@ -56,7 +56,7 @@ def self.from_json(json)
 
       sig { override.params(printer: SymbolPrinter).void }
       def accept_printer(printer)
-        printer.print_colored("#{line}:#{char}", :light_black)
+        printer.print_colored("#{line}:#{char}", Color::LIGHT_BLACK)
       end
 
       def to_s
@@ -81,7 +81,7 @@ def self.from_json(json)
       sig { override.params(printer: SymbolPrinter).void }
       def accept_printer(printer)
         printer.print_object(start)
-        printer.print_colored("-", :light_black)
+        printer.print_colored("-", Color::LIGHT_BLACK)
         printer.print_object(self.end)
       end
 
@@ -106,7 +106,7 @@ def self.from_json(json)
 
       sig { override.params(printer: SymbolPrinter).void }
       def accept_printer(printer)
-        printer.print_colored("#{printer.clean_uri(uri)}:", :light_black)
+        printer.print_colored("#{printer.clean_uri(uri)}:", Color::LIGHT_BLACK)
         printer.print_object(range)
       end
 
@@ -203,14 +203,14 @@ def accept_printer(printer)
         printer.printt
         printer.print(kind_string)
         printer.print(' ')
-        printer.print_colored(name, :blue, :bold)
-        printer.print_colored(' (', :light_black)
+        printer.print_colored(name, Color::BLUE, Color::BOLD)
+        printer.print_colored(' (', Color::LIGHT_BLACK)
         if range
           printer.print_object(range)
         elsif location
           printer.print_object(location)
         end
-        printer.print_colored(')', :light_black)
+        printer.print_colored(')', Color::LIGHT_BLACK)
         printer.printn
         unless children.empty?
           printer.indent

sorbet/rbi/gems/colorize@0.8.1.rbi

@@ -789,9 +789,7 @@ RakeFileUtils = Rake::FileUtilsExt
 class String
   include(::Comparable)
   include(::JSON::Ext::Generator::GeneratorMethods::String)
-  include(::Colorize::InstanceMethods)
   extend(::JSON::Ext::Generator::GeneratorMethods::String::Extend)
-  extend(::Colorize::ClassMethods)
 
   def ext(newext = _); end
   def pathmap(spec = _, &block); end