rainbow 2.1.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e50d4d60cddebd63162aa542384109c229e019b4
-  data.tar.gz: 5240ea5388eb6b8df8715227cd2830dc9cba19db
+SHA256:
+  metadata.gz: 8a63baad6cad3bf3127e8dfbfb9393f05b6a92122af6f1fd7b3cf5ffe44b4e05
+  data.tar.gz: 8db71093ce37873fa8b009981488cce3ee63cfad85365dd96f416dc4790d4d97
 SHA512:
-  metadata.gz: 4953dabd646d05ea36be2d0e4d4d8b4f1eb070a3bf0576413ab31335e8513302deb8399e8fc111de20948e049f8e3b17a8fd081bafca36455c5bc1721dec05b7
-  data.tar.gz: 7fdee7a80bd1ee2292e274d7e0694a79a03d6f7f99d004d79b21eb88e3f3e1d5d22f9bfb81f478cbbd5505c8c7b10ba95bcdb6aa952a9275c684930abde1ab42
+  metadata.gz: c5d8c29b3d25fcc2a85919143a628e2de3250beb08ec10c228c5fe2b759af567b962e9c78b65bc9fc39db33b643af4556cb05565e45027f25695e2ee1275a115
+  data.tar.gz: 2872ac2c71afebbfb362b86e93f03b3b7b0fe376497fdcd4ce4ce296fa03be4521ca0ed84de3ef24228783842bdff17f4ce3c2f79ad4cfe6faa9896b25e229af

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)
+## 2.2.1 (2016-12-28)
 
-* rainbow methods don't mutate the original string object anymore
+* fixed gem installation (2.2.0 was a broken release)
 
-## 1.0.4 (2009-11-27)
-
-* support for 256 colors
+## 2.2.0 (2016-12-27)
 
-## 1.1 (2010-6-7)
-
-* 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,23 +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
+
+## 1.1 (2010-6-7)
+
+* option for enabling/disabling of escape code wrapping
+* auto-disabling when STDOUT is not a TTY
+
+## 1.0.4 (2009-11-27)
+
+* support for 256 colors
+
+## 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,8 +1,10 @@
 # Rainbow
 
-[![Build Status](https://travis-ci.org/sickill/rainbow.png?branch=master)](https://travis-ci.org/sickill/rainbow)
-[![Code Climate](https://codeclimate.com/github/sickill/rainbow.png)](https://codeclimate.com/github/sickill/rainbow)
-[![Coverage Status](https://coveralls.io/repos/sickill/rainbow/badge.png)](https://coveralls.io/r/sickill/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)
 
 Rainbow is a ruby gem for colorizing printed text on ANSI terminals.
 
@@ -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, 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
 

metadata

@@ -1,29 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: rainbow
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Marcin Kulik
-autorequire: 
+- Olle Jonsson
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-24 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Colorize printed text on ANSI terminals
 email:
 - m@ku1ik.com
@@ -31,43 +38,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
 - Changelog.md
-- Gemfile
-- Guardfile
 - LICENSE
 - README.markdown
-- Rakefile
-- lib/rainbow.rb
-- lib/rainbow/color.rb
-- lib/rainbow/ext/string.rb
-- lib/rainbow/global.rb
-- lib/rainbow/legacy.rb
-- lib/rainbow/null_presenter.rb
-- lib/rainbow/presenter.rb
-- lib/rainbow/string_utils.rb
-- lib/rainbow/version.rb
-- lib/rainbow/wrapper.rb
-- lib/rainbow/x11_color_names.rb
-- rainbow.gemspec
-- spec/integration/instance_spec.rb
-- spec/integration/rainbow_spec.rb
-- spec/integration/string_spec.rb
-- spec/spec_helper.rb
-- spec/support/presenter_shared_examples.rb
-- spec/unit/color_spec.rb
-- spec/unit/namespace_spec.rb
-- spec/unit/null_presenter_spec.rb
-- spec/unit/presenter_spec.rb
-- spec/unit/string_utils_spec.rb
-- spec/unit/wrapper_spec.rb
 homepage: https://github.com/sickill/rainbow
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,27 +53,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Colorize printed text on ANSI terminals
-test_files:
-- spec/integration/instance_spec.rb
-- spec/integration/rainbow_spec.rb
-- spec/integration/string_spec.rb
-- spec/spec_helper.rb
-- spec/support/presenter_shared_examples.rb
-- spec/unit/color_spec.rb
-- spec/unit/namespace_spec.rb
-- spec/unit/null_presenter_spec.rb
-- spec/unit/presenter_spec.rb
-- spec/unit/string_utils_spec.rb
-- spec/unit/wrapper_spec.rb
+test_files: []

data/.gitignore

@@ -1,17 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp

data/.rubocop.yml

@@ -1,14 +0,0 @@
-Documentation:
-  Enabled: false
-
-EmptyLinesAroundBody:
-  Enabled: false
-
-HashSyntax:
-  Enabled: false
-
-MethodName:
-  Enabled: false
-
-StringLiterals:
-  Enabled: false

data/.travis.yml

@@ -1,11 +0,0 @@
-bundler_args: --without guard development
-rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - rbx
-  - jruby
-
-script: "bundle exec rake"
-sudo: false

data/Gemfile

@@ -1,23 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in rainbow.gemspec
-gemspec
-
-gem 'rake'
-gem 'coveralls', require: false
-gem 'mime-types', '< 2.0.0', platforms: [:ruby_18]
-gem 'rspec', '3.0.0beta2'
-
-group :development do
-  gem 'mutant-rspec'
-end
-
-group :guard do
-  gem 'guard'
-  gem 'guard-rspec'
-end
-
-platform :rbx do
-  gem 'json'
-  gem 'rubysl'
-end

data/Guardfile

@@ -1,9 +0,0 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard :rspec, cmd: 'rspec --color' do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { "spec" }
-  watch('spec/spec_helper.rb')  { "spec" }
-end
-

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec