rainbow 2.2.1 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 173113b6696213f239638a808f56033abc5b7467
-  data.tar.gz: b4794428b131eb7c0d59e3a4d615e211b159b7d9
+SHA256:
+  metadata.gz: 7367f9386ef2460491f123bd207091956c6dcce6300dcf3957a48c126a1ec900
+  data.tar.gz: 1c123ecd4c6ee30422ff9df560df3ec4f5d4c8bcb6010e3a0c5be4435848894a
 SHA512:
-  metadata.gz: 34d9884acf5dfc1af44737a7059a3ab11a274b5cf6517972182c12237e346d0d0ed89f49652dd9ab813408eef275af8dd4df01b8116e0b767d3b91d7da7f7317
-  data.tar.gz: 9d028c71300949cc03b74fa5869cbeb2e749ce23a4c12ef60501e1fb733cdbb0fa7d0a45f96f3c1e9319f3835ff2ed0fa27c75b7f869c9850e62ba615c1161da
+  metadata.gz: 64ddf54fa7edd4f0f05301270503025bfb63cbca6db7e940b4cf6c62cbd860b3cf939c885f5e69becd1f4faf39c9d2fe1e8a35597dd28fe1b30df26e52f334f0
+  data.tar.gz: 74550a67235dcca95dbd6404023576843e626e0ec00e557c0e38fbd145f778983b6c63136008d39da958a4fc83dc73e7a62758a40c8ead76c24066e968b66b6e

data/Changelog.md

@@ -1,47 +1,53 @@
 # Rainbow changelog
 
-## 1.0.0 (2008-7-21)
+## 3.1.0 (2020-08-26)
 
-* initial version
+- added `cross_out` aka `strike`
+- hexadecimal color names supported better, see #83
+- gemspec: list files using a Ruby expression, avoiding git
 
-## 1.0.1 (2009-3-19)
+## 3.0.0 (2017-11-29)
 
-* Windows support
+* added String refinement
+* added new `Rainbow.uncolor` method
+* dropped MRI 1.9.3 compatibility
+* dropped MRI 2.0 compatibility
+* removed Rake dependency
 
-## 1.0.2 (2009-5-15)
+## 2.2.2 (2017-04-21)
 
-* improved support for ruby 1.8.6 and 1.9.1
+* added explicit rake dependency to fix installation issue
 
-## 1.0.3 (2009-7-26)
-
-* rainbow methods don't mutate the original string object anymore
-
-## 1.0.4 (2009-11-27)
+## 2.2.1 (2016-12-28)
 
-* support for 256 colors
+* fixed gem installation (2.2.0 was a broken release)
 
-## 1.1 (2010-6-7)
+## 2.2.0 (2016-12-27)
 
-* option for enabling/disabling of escape code wrapping
-* auto-disabling when STDOUT is not a TTY
+* improved Windows support
+* added Ruby 2.4 support
+* added `bold` alias method for `bright`
 
-## 1.1.1 (2011-2-7)
+## 2.1.0 (2016-01-24)
 
+* added X11 color support
+* fixed `require` issue when rainbow is used as a dependency in another gem
 * improved Windows support
 
-## 1.1.2 (2011-11-13)
+## 2.0.0 (2014-01-24)
 
-* improved compatibility with MRI 1.9.3
+* disable string mixin by default
 
-## 1.1.3 (2011-12-6)
+## 1.99.2 (2014-01-24)
 
-* improved compatibility with MRI 1.8.7
-* fix for regression with regards to original string mutation
+* bring back ruby 1.8 support
 
-## 1.1.4 (2012-4-28)
+## 1.99.1 (2013-12-28)
 
-* option for forcing coloring even when STDOUT is not a TTY (CLICOLOR_FORCE env var)
-* fix for frozen strings
+* drop support for ruby 1.8
+* `require "rainbow/string"` -> `require "rainbow/ext/string"`
+* custom rainbow wrapper instances (with separate enabled/disabled state)
+* shortcut methods for changing text color (`Rainbow("foo").red`)
 
 ## 1.99.0 (2013-12-26)
 
@@ -51,33 +57,45 @@
 * support for MRI 1.8.7, 1.9.2, 1.9.3, 2.0 and 2.1, JRuby and Rubinius
 * deprecation of Sickill::Rainbow namespace (use Rainbow.enabled = true instead)
 
-## 1.99.1 (2013-12-28)
+## 1.1.4 (2012-4-28)
 
-* drop support for ruby 1.8
-* `require "rainbow/string"` -> `require "rainbow/ext/string"`
-* custom rainbow wrapper instances (with separate enabled/disabled state)
-* shortcut methods for changing text color (`Rainbow("foo").red`)
+* option for forcing coloring even when STDOUT is not a TTY (CLICOLOR_FORCE env var)
+* fix for frozen strings
 
-## 1.99.2 (2014-01-24)
+## 1.1.3 (2011-12-6)
 
-* bring back ruby 1.8 support
+* improved compatibility with MRI 1.8.7
+* fix for regression with regards to original string mutation
 
-## 2.0.0 (2014-01-24)
+## 1.1.2 (2011-11-13)
 
-* disable string mixin by default
+* improved compatibility with MRI 1.9.3
 
-## 2.1.0 (2016-01-24)
+## 1.1.1 (2011-2-7)
 
-* added X11 color support
-* fixed `require` issue when rainbow is used as a dependency in another gem
 * improved Windows support
 
-# 2.2.0 (2016-12-27)
+## 1.1 (2010-6-7)
 
-* improved Windows support
-* added Ruby 2.4 support
-* added `bold` alias method for `bright`
+* option for enabling/disabling of escape code wrapping
+* auto-disabling when STDOUT is not a TTY
+
+## 1.0.4 (2009-11-27)
 
-# 2.2.1 (2016-12-28)
+* support for 256 colors
 
-* fixed gem installation (2.2.0 was a broken release)
+## 1.0.3 (2009-7-26)
+
+* rainbow methods don't mutate the original string object anymore
+
+## 1.0.2 (2009-5-15)
+
+* improved support for ruby 1.8.6 and 1.9.1
+
+## 1.0.1 (2009-3-19)
+
+* Windows support
+
+## 1.0.0 (2008-7-21)
+
+* initial version

data/README.markdown

@@ -1,6 +1,8 @@
 # Rainbow
 
+[![Gem Version](https://badge.fury.io/rb/rainbow.svg)](https://rubygems.org/gems/rainbow)
 [![Build Status](https://travis-ci.org/sickill/rainbow.svg?branch=master)](https://travis-ci.org/sickill/rainbow)
+[![Build status](https://ci.appveyor.com/api/projects/status/vq4acb2c38642s5q?svg=true)](https://ci.appveyor.com/project/sickill/rainbow)
 [![Code Climate](https://codeclimate.com/github/sickill/rainbow.svg)](https://codeclimate.com/github/sickill/rainbow)
 [![Coverage Status](https://coveralls.io/repos/sickill/rainbow/badge.svg)](https://coveralls.io/r/sickill/rainbow)
 
@@ -27,6 +29,10 @@ puts Rainbow("this is red").red + " and " + Rainbow("this on yellow bg").bg(:yel
 # => "\e[31mthis is red\e[0m and \e[43mthis on yellow bg\e[0m and \e[4m\e[1meven bright underlined!\e[0m"
 ```
 
+![Screenshot of the previous code in a terminal](https://user-images.githubusercontent.com/132/132943811-93747cc5-bdaf-43a2-a1a4-a1f18e805eba.png)
+
+Or, [watch this video example](https://asciinema.org/a/J928KpHoUQ0sl54ulOSOLE71E?rows=20&speed=2.5)
+
 ### Rainbow presenter API
 
 Rainbow presenter adds the following methods to presented string:
@@ -38,7 +44,9 @@ Rainbow presenter adds the following methods to presented string:
 * `blink`
 * `inverse`
 * `hide`
-* `italic` (not well supported by terminal emulators).
+* `faint` (not well supported by terminal emulators)
+* `italic` (not well supported by terminal emulators)
+* `cross_out`, `strike`
 
 Text color can also be changed by calling a method named by a color:
 
@@ -62,28 +70,27 @@ calls:
 Rainbow("hola!").blue.bright.underline
 ```
 
-### String mixin
+### Refinement
 
-If you don't like wrapping every string you want to colorize with `Rainbow()`
-you can include all the rainbow presenter methods directly in a String class by
-requiring `rainbow/ext/string`:
+If you want to use the Refinements version, you can:
 
 ```ruby
-require 'rainbow/ext/string'
-
-puts "this is red".color(:red) + " and " + "this on yellow bg".background(:yellow) + " and " + "even bright underlined!".underline.bright
+require 'rainbow/refinement'
+using Rainbow
+puts "Hi!".green
 ```
 
-This way of using Rainbow is not recommended though as it pollutes String's
-public interface with methods that are presentation specific.
-
-NOTE: the mixin doesn't include shortcut methods for changing text color, you
-should use "string".color(:blue) instead of "string".blue
+Here's an IRB session example:
 
-NOTE: the mixin is included in String by default in rainbow 1.x versions.
-In rainbow 2.x the behavior was changed - if you're upgrading from 1.x to 2.x
-and you used direct String methods then you can either require the string
-extension as shown above or update your code to use the new presenter API.
+```
+>> 'Hello, World!'.blue.bright.underline
+NoMethodError: undefined method `blue' for "Hello, World!":String
+    (ripl):1:in `<main>'
+>> using Rainbow
+=> main
+>> 'Hello, World!'.blue.bright.underline
+=> "\e[34m\e[1m\e[4mHello, World!\e[0m"
+```
 
 ### Color specification
 
@@ -111,6 +118,20 @@ When you specify a color with a RGB triplet rainbow finds the nearest match
 from 256 colors palette. Note that it requires a 256-colors capable terminal to
 display correctly.
 
+#### Example: Choose a random color
+
+You can pick a random color with Rainbow, it's a one-liner:
+
+```ruby
+colors = Range.new(0,7).to_a
+"whoop dee doop".chars.map { |char| Rainbow(char).color(colors.sample) }.join
+# => "\e[36mw\e[0m\e[37mh\e[0m\e[34mo\e[0m\e[34mo\e[0m\e[37mp\e[0m\e[34m \e[0m\e[36md\e[0m\e[33me\e[0m\e[34me\e[0m\e[37m \e[0m\e[32md\e[0m\e[35mo\e[0m\e[33mo\e[0m\e[36mp\e[0m"
+
+colors = [:aliceblue, :antiquewhite, :aqua, :aquamarine, :azure, :beige, :bisque, :blanchedalmond, :blueviolet]
+"whoop dee doop".chars.map { |char| Rainbow(char).color(colors.sample) }.join
+# => "\e[38;5;135mw\e[0m\e[38;5;230mh\e[0m\e[38;5;231mo\e[0m\e[38;5;135mo\e[0m\e[38;5;231mp\e[0m\e[38;5;231m \e[0m\e[38;5;122md\e[0m\e[38;5;231me\e[0m\e[38;5;231me\e[0m\e[38;5;230m \e[0m\e[38;5;122md\e[0m\e[38;5;51mo\e[0m\e[38;5;51mo\e[0m\e[38;5;51mp\e[0m"
+```
+
 ### Configuration
 
 Rainbow can be enabled/disabled globally by setting:
@@ -153,16 +174,6 @@ colorize all the strings, even the ones that go through file writing
 formatters. You can easily solve that by disabling coloring for the Rainbow
 instances that are used by formatters with file output.
 
-## Windows support
-
-For Windows support on Ruby < 2.0, you should install the following gems:
-
-```ruby
-gem install windows-pr win32console
-```
-
-If the above gems aren't installed then all strings are returned unmodified.
-
 ## Installation
 
 Add it to your Gemfile:
@@ -181,154 +192,35 @@ gem install rainbow
 
 ### ANSI colors
 
-* `black`
-* `red`
-* `green`
-* `yellow`
-* `blue`
-* `magenta`
-* `cyan`
-* `white`
+`black`, `red`, `green`, `yellow`, `blue`, `magenta`, `cyan`, `white`
 
 ### X11 colors
 
-* `aqua`
-* `aquamarine`
-* `mediumaquamarine`
-* `azure`
-* `beige`
-* `bisque`
-* `blanchedalmond`
-* `darkblue`
-* `lightblue`
-* `mediumblue`
-* `aliceblue`
-* `cadetblue`
-* `dodgerblue`
-* `midnightblue`
-* `navyblue`
-* `powderblue`
-* `royalblue`
-* `skyblue`
-* `deepskyblue`
-* `lightskyblue`
-* `slateblue`
-* `darkslateblue`
-* `mediumslateblue`
-* `steelblue`
-* `lightsteelblue`
-* `brown`
-* `rosybrown`
-* `saddlebrown`
-* `sandybrown`
-* `burlywood`
-* `chartreuse`
-* `chocolate`
-* `coral`
-* `lightcoral`
-* `cornflower`
-* `cornsilk`
-* `crimson`
-* `darkcyan`
-* `lightcyan`
-* `firebrick`
-* `fuchsia`
-* `gainsboro`
-* `gold`
-* `goldenrod`
-* `darkgoldenrod`
-* `lightgoldenrod`
-* `palegoldenrod`
-* `gray`
-* `darkgray`
-* `dimgray`
-* `lightgray`
-* `slategray`
-* `lightslategray`
-* `webgray`
-* `darkgreen`
-* `lightgreen`
-* `palegreen`
-* `darkolivegreen`
-* `yellowgreen`
-* `forestgreen`
-* `lawngreen`
-* `limegreen`
-* `seagreen`
-* `darkseagreen`
-* `lightseagreen`
-* `mediumseagreen`
-* `springgreen`
-* `mediumspringgreen`
-* `webgreen`
-* `honeydew`
-* `indianred`
-* `indigo`
-* `ivory`
-* `khaki`
-* `darkkhaki`
-* `lavender`
-* `lavenderblush`
-* `lemonchiffon`
-* `lime`
-* `linen`
-* `darkmagenta`
-* `maroon`
-* `webmaroon`
-* `mintcream`
-* `mistyrose`
-* `moccasin`
-* `oldlace`
-* `olive`
-* `olivedrab`
-* `orange`
-* `darkorange`
-* `orchid`
-* `darkorchid`
-* `mediumorchid`
-* `papayawhip`
-* `peachpuff`
-* `peru`
-* `pink`
-* `deeppink`
-* `lightpink`
-* `hotpink`
-* `plum`
-* `purple`
-* `mediumpurple`
-* `rebeccapurple`
-* `webpurple`
-* `darkred`
-* `orangered`
-* `mediumvioletred`
-* `palevioletred`
-* `salmon`
-* `darksalmon`
-* `lightsalmon`
-* `seashell`
-* `sienna`
-* `silver`
-* `darkslategray`
-* `snow`
-* `tan`
-* `teal`
-* `thistle`
-* `tomato`
-* `turquoise`
-* `darkturquoise`
-* `mediumturquoise`
-* `paleturquoise`
-* `violet`
-* `darkviolet`
-* `blueviolet`
-* `wheat`
-* `antiquewhite`
-* `floralwhite`
-* `ghostwhite`
-* `navajowhite`
-* `whitesmoke`
-* `lightyellow`
-* `greenyellow`
+`aliceblue`, `antiquewhite`, `aqua`, `aquamarine`, `azure`, `beige`, `bisque`,
+`blanchedalmond`, `blueviolet`, `brown`, `burlywood`, `cadetblue`, `chartreuse`,
+`chocolate`, `coral`, `cornflower`, `cornsilk`, `crimson`, `darkblue`,
+`darkcyan`, `darkgoldenrod`, `darkgray`, `darkgreen`, `darkkhaki`,
+`darkmagenta`, `darkolivegreen`, `darkorange`, `darkorchid`, `darkred`,
+`darksalmon`, `darkseagreen`, `darkslateblue`, `darkslategray`, `darkturquoise`,
+`darkviolet`, `deeppink`, `deepskyblue`, `dimgray`, `dodgerblue`, `firebrick`,
+`floralwhite`, `forestgreen`, `fuchsia`, `gainsboro`, `ghostwhite`, `gold`,
+`goldenrod`, `gray`, `greenyellow`, `honeydew`, `hotpink`, `indianred`,
+`indigo`, `ivory`, `khaki`, `lavender`, `lavenderblush`, `lawngreen`,
+`lemonchiffon`, `lightblue`, `lightcoral`, `lightcyan`, `lightgoldenrod`,
+`lightgray`, `lightgreen`, `lightpink`, `lightsalmon`, `lightseagreen`,
+`lightskyblue`, `lightslategray`, `lightsteelblue`, `lightyellow`, `lime`,
+`limegreen`, `linen`, `maroon`, `mediumaquamarine`, `mediumblue`,
+`mediumorchid`, `mediumpurple`, `mediumseagreen`, `mediumslateblue`,
+`mediumspringgreen`, `mediumturquoise`, `mediumvioletred`, `midnightblue`,
+`mintcream`, `mistyrose`, `moccasin`, `navajowhite`, `navyblue`, `oldlace`,
+`olive`, `olivedrab`, `orange`, `orangered`, `orchid`, `palegoldenrod`,
+`palegreen`, `paleturquoise`, `palevioletred`, `papayawhip`, `peachpuff`,
+`peru`, `pink`, `plum`, `powderblue`, `purple`, `rebeccapurple`, `rosybrown`,
+`royalblue`, `saddlebrown`, `salmon`, `sandybrown`, `seagreen`, `seashell`,
+`sienna`, `silver`, `skyblue`, `slateblue`, `slategray`, `snow`, `springgreen`,
+`steelblue`, `tan`, `teal`, `thistle`, `tomato`, `turquoise`, `violet`,
+`webgray`, `webgreen`, `webmaroon`, `webpurple`, `wheat`, `whitesmoke`,
+`yellowgreen`
 
 ## Authors
 

data/lib/rainbow/color.rb

@@ -1,18 +1,24 @@
+# frozen_string_literal: true
+
 module Rainbow
   class Color
-
     attr_reader :ground
 
     def self.build(ground, values)
       unless [1, 3].include?(values.size)
-        fail ArgumentError,
-          "Wrong number of arguments for color definition, should be 1 or 3"
+        raise ArgumentError,
+              "Wrong number of arguments for color definition, should be 1 or 3"
       end
 
       color = values.size == 1 ? values.first : values
 
       case color
-      when Integer
+      # NOTE: Properly handle versions before/after Ruby 2.4.0.
+      # Ruby 2.4+ unifies Fixnum & Bignum into Integer.
+      # However previous versions would still use Fixnum.
+      # To avoid missing `Fixnum` input, call `0.class` which would
+      # return either `Integer` or `Fixnum`.
+      when 0.class
         Indexed.new(ground, color)
       when Symbol
         if Named.color_names.include?(color)
@@ -20,9 +26,9 @@ module Rainbow
         elsif X11Named.color_names.include?(color)
           X11Named.new(ground, color)
         else
-          fail ArgumentError,
-            "Unknown color name, valid names: " +
-            (Named.color_names + X11Named.color_names).join(', ')
+          raise ArgumentError,
+                "Unknown color name, valid names: " +
+                (Named.color_names + X11Named.color_names).join(', ')
         end
       when Array
         RGB.new(ground, *color)
@@ -32,6 +38,11 @@ module Rainbow
     end
 
     def self.parse_hex_color(hex)
+      unless hex =~ /^#?[a-f0-9]{6}/i
+        raise ArgumentError,
+              "Invalid hexadecimal RGB triplet. Valid format: /^#?[a-f0-9]{6}/i"
+      end
+
       hex = hex.sub(/^#/, '')
       r   = hex[0..1].to_i(16)
       g   = hex[2..3].to_i(16)
@@ -41,7 +52,6 @@ module Rainbow
     end
 
     class Indexed < Color
-
       attr_reader :num
 
       def initialize(ground, num)
@@ -54,40 +64,40 @@ module Rainbow
 
         [code]
       end
-
     end
 
     class Named < Indexed
-
       NAMES = {
-        black:   0,
-        red:     1,
-        green:   2,
-        yellow:  3,
-        blue:    4,
+        black: 0,
+        red: 1,
+        green: 2,
+        yellow: 3,
+        blue: 4,
         magenta: 5,
-        cyan:    6,
-        white:   7,
-        default: 9,
-      }
+        cyan: 6,
+        white: 7,
+        default: 9
+      }.freeze
 
       def self.color_names
         NAMES.keys
       end
 
+      def self.valid_names
+        color_names.join(', ')
+      end
+
       def initialize(ground, name)
         unless Named.color_names.include?(name)
-          fail ArgumentError,
-            "Unknown color name, valid names: #{Named.color_names.join(', ')}"
+          raise ArgumentError,
+                "Unknown color name, valid names: #{self.class.valid_names}"
         end
 
         super(ground, NAMES[name])
       end
-
     end
 
     class RGB < Indexed
-
       attr_reader :r, :g, :b
 
       def self.to_ansi_domain(value)
@@ -95,8 +105,8 @@ module Rainbow
       end
 
       def initialize(ground, *values)
-        if values.min < 0 || values.max > 255
-          fail ArgumentError, "RGB value outside 0-255 range"
+        if values.min.negative? || values.max > 255
+          raise ArgumentError, "RGB value outside 0-255 range"
         end
 
         super(ground, 8)
@@ -111,10 +121,9 @@ module Rainbow
 
       def code_from_rgb
         16 + self.class.to_ansi_domain(r) * 36 +
-             self.class.to_ansi_domain(g) * 6  +
-             self.class.to_ansi_domain(b)
+          self.class.to_ansi_domain(g) * 6 +
+          self.class.to_ansi_domain(b)
       end
-
     end
 
     class X11Named < RGB
@@ -124,16 +133,18 @@ module Rainbow
         NAMES.keys
       end
 
+      def self.valid_names
+        color_names.join(', ')
+      end
+
       def initialize(ground, name)
         unless X11Named.color_names.include?(name)
-          fail ArgumentError,
-            "Unknown color name, valid names: #{X11Named.color_names.join(', ')}"
+          raise ArgumentError,
+                "Unknown color name, valid names: #{self.class.valid_names}"
         end
 
         super(ground, *NAMES[name])
       end
-
     end
-
   end
 end

data/lib/rainbow/ext/string.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 require 'rainbow'
 
 module Rainbow
   module Ext
     module String
       module InstanceMethods
-
         def foreground(*color)
           Rainbow(self).foreground(*color)
         end
 
-        alias_method :color, :foreground
-        alias_method :colour, :foreground
+        alias color foreground
+        alias colour foreground
 
         def background(*color)
           Rainbow(self).background(*color)
@@ -24,6 +25,10 @@ module Rainbow
           Rainbow(self).bright
         end
 
+        def faint
+          Rainbow(self).faint
+        end
+
         def italic
           Rainbow(self).italic
         end
@@ -44,9 +49,16 @@ module Rainbow
           Rainbow(self).hide
         end
 
+        def cross_out
+          Rainbow(self).cross_out
+        end
+
+        alias strike cross_out
       end
     end
   end
 end
 
-::String.send(:include, Rainbow::Ext::String::InstanceMethods)
+class String
+  include Rainbow::Ext::String::InstanceMethods
+end

data/lib/rainbow/global.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require_relative 'wrapper'
 
 module Rainbow
-
   def self.global
     @global ||= Wrapper.new
   end
@@ -14,6 +15,9 @@ module Rainbow
     global.enabled = value
   end
 
+  def self.uncolor(string)
+    StringUtils.uncolor(string)
+  end
 end
 
 def Rainbow(string)