rainbow 2.2.2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae78749f89ed058bfe6d143f96ab9140e243a0bc
-  data.tar.gz: 0ea8625303c1f3c6668ef9cf05692db0295138a3
+  metadata.gz: 831ab2db7f80a9a72f2993f1e7b4f3ffa08a4495
+  data.tar.gz: 0f842d288049511c94a95ce9b8a9210cf5e2344b
 SHA512:
-  metadata.gz: 6a4d28dea14c12a91fb545046183a8fe02b1da104f4dd52c59245cb045ce1116b5b2777570a211112f973ccf52d18cea9547ae1f9ce0405e72538d2dceb4237a
-  data.tar.gz: 03c7b7197f82cd5974c01458524217cfd000a67cff73962b67440c3c44dfd261c5fa1b160da99110fb618a09b3830d0fac1b9b47e854daa28ee0543ff40856df
+  metadata.gz: ecde479bb8ea6f267200efaf03be79e7141bf6fccd7a7191960b2f9f52d809120a943a341f467f0a01c982ff11bf8bd23e66c8732d3af0b22643be5da13b55ec
+  data.tar.gz: b11241f918993558e8a4d248d9eb4b458793e926e10e7e387d5dabaf9e15a988adeda1441c93b3be9d051c939fbf566b2493ba9f8df8eff0bbf629bf36798cac

data/.rubocop.yml

@@ -1,7 +1,13 @@
-Documentation:
-  Enabled: false
+inherit_from: .rubocop_todo.yml
 
-EmptyLinesAroundBody:
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: "2.1"
+  Exclude:
+    - "spec/**/*"
+    - "vendor/**/*"
+Documentation:
   Enabled: false
 
 HashSyntax:

data/.rubocop_todo.yml

@@ -0,0 +1,29 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2017-06-30 12:37:52 +0200 using RuboCop version 0.49.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 25
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 9
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 23
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ModuleLength:
+  Max: 147
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 8

data/.travis.yml

@@ -1,22 +1,24 @@
 language: ruby
 cache:
-  - bundler
+  bundler: true
+
 before_install:
-  - gem update --system
   - gem install bundler
+
 bundler_args: --without guard development
 
 matrix:
   include:
-    - rvm: 2.0.0
-    - rvm: 2.1.9
-    - rvm: 2.2.6
-    - rvm: 2.3.3
-    - rvm: 2.4.0
-    - rvm: jruby-9.1.6.0
+    - rvm: 2.1.10
+    - rvm: 2.2.7
+    - rvm: 2.3.4
+    - rvm: 2.4.1
+    - rvm: jruby-9.1.14.0
       jdk: oraclejdk8
-      env:
-        - JRUBY_OPTS=--debug
-    - rvm: 2.2.6
+    - rvm: 2.2.7
       install: true # This skips 'bundle install'
       script: gem build rainbow && gem install *.gem
+
+env:
+  global:
+    - JRUBY_OPTS=--debug

data/Changelog.md

@@ -1,47 +1,45 @@
 # Rainbow changelog
 
-## 1.0.0 (2008-7-21)
-
-* initial version
+## 3.0.0 (2017-10-24)
 
-## 1.0.1 (2009-3-19)
-
-* Windows support
+* dropped MRI 1.9.3 compatibility
+* dropped MRI 2.0 compatibility
+* removed rake dependency
 
-## 1.0.2 (2009-5-15)
-
-* improved support for ruby 1.8.6 and 1.9.1
-
-## 1.0.3 (2009-7-26)
+## 2.2.2 (2017-04-21)
 
-* rainbow methods don't mutate the original string object anymore
+* added explicit rake dependency to fix installation issue
 
-## 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,37 +49,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
 
-# 2.2.1 (2016-12-28)
+## 1.0.4 (2009-11-27)
 
-* fixed gem installation (2.2.0 was a broken release)
+* support for 256 colors
 
-# 2.2.2 (2017-04-21)
+## 1.0.3 (2009-7-26)
 
-* added explicit rake dependency to fix installation issue
+* 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/Gemfile

@@ -1,17 +1,22 @@
 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'
+
+group :test do
+  gem 'coveralls', require: false
+  gem 'rspec'
+end
 
 group :development do
   gem 'mutant-rspec'
 end
 
+group :test, :development do
+  gem 'rubocop', '~> 0.51.0'
+end
+
 group :guard do
   gem 'guard'
   gem 'guard-rspec'

data/Guardfile

@@ -6,4 +6,3 @@ guard :rspec, cmd: 'rspec --color' do
   watch(%r{^lib/(.+)\.rb$})     { "spec" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
-

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,8 @@ 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"
 ```
 
+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:
@@ -63,28 +67,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
 
@@ -112,6 +115,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:
@@ -154,16 +171,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:

data/Rakefile

@@ -1,6 +1,9 @@
 require "bundler/gem_tasks"
+
 require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
 
-RSpec::Core::RakeTask.new(:spec)
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
 
-task :default => :spec
+task default: %i[spec rubocop]

data/appveyor.yml

@@ -0,0 +1,40 @@
+---
+
+version: "{build}"
+
+install:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  - bundle config --local path vendor/bundle
+  - bundle install --jobs 3 --retry 3 --without guard development 
+
+build: off
+
+cache:
+  - vendor/bundle
+
+init:
+  - git config --global core.autocrlf true
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake
+
+environment:
+  matrix:
+    - RUBY_VERSION: 21
+    - RUBY_VERSION: 21-x64
+    - RUBY_VERSION: 22
+    - RUBY_VERSION: 22-x64
+    - RUBY_VERSION: 23
+    - RUBY_VERSION: 23-x64
+
+matrix:
+  fast_finish: true
+
+branches:
+  only:
+    - master

data/lib/rainbow.rb

@@ -1,8 +1,6 @@
 require_relative 'rainbow/global'
-require_relative 'rainbow/legacy'
 
 module Rainbow
-
   def self.new
     Wrapper.new(global.enabled)
   end
@@ -10,15 +8,4 @@ module Rainbow
   self.enabled = false unless STDOUT.tty? && STDERR.tty?
   self.enabled = false if ENV['TERM'] == 'dumb'
   self.enabled = true if ENV['CLICOLOR_FORCE'] == '1'
-
-  # On Windows systems, try to load the local ANSI support library if Ruby version < 2
-  # Ruby 2.x on Windows includes ANSI support. 
-  if RUBY_PLATFORM =~ /mswin|cygwin|mingw/ && RUBY_VERSION.to_i < 2
-    begin
-      require 'Win32/Console/ANSI'
-    rescue LoadError
-      self.enabled = false
-    end
-  end
-
 end

data/lib/rainbow/color.rb

@@ -1,12 +1,11 @@
 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
@@ -25,9 +24,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)
@@ -46,7 +45,6 @@ module Rainbow
     end
 
     class Indexed < Color
-
       attr_reader :num
 
       def initialize(ground, num)
@@ -59,11 +57,9 @@ module Rainbow
 
         [code]
       end
-
     end
 
     class Named < Indexed
-
       NAMES = {
         black:   0,
         red:     1,
@@ -73,26 +69,28 @@ module Rainbow
         magenta: 5,
         cyan:    6,
         white:   7,
-        default: 9,
-      }
+        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)
@@ -101,7 +99,7 @@ module Rainbow
 
       def initialize(ground, *values)
         if values.min < 0 || values.max > 255
-          fail ArgumentError, "RGB value outside 0-255 range"
+          raise ArgumentError, "RGB value outside 0-255 range"
         end
 
         super(ground, 8)
@@ -116,10 +114,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
@@ -129,16 +126,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