rainbow 1.1.4 → 1.99.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 820cb8349ec300d38fa0b456dfec3d4fe3399314
+  data.tar.gz: bc326589c9e418bb2dc1d13989d9931b8a7d548e
+SHA512:
+  metadata.gz: 7f487f330dd0cc1401f5b1172ac5e2eca94f54371f02ab79f5d12a5c23c2c3ee5938a9036875b53575721ecae9d33257676f3400f042894678d9beffe68c0df9
+  data.tar.gz: c0b10c5d741321d8743f5b0a35feb3cc9ba3128dd5798462a6b89c273a6d3b725a1062a1fe725a87a2f394b7dd34e78189b9eb0304c8776efd2806ee2ce6413f

data/.gitignore

@@ -0,0 +1,17 @@
+*.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/.travis.yml

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# 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/README.markdown

@@ -1,75 +1,118 @@
-Rainbow
-=======
+# Rainbow
 
-![build status](https://secure.travis-ci.org/sickill/rainbow.png)
+[![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)
 
-About
------
+Rainbow is a ruby gem for colorizing printed text on ANSI terminals.
 
-Rainbow extends ruby String class adding methods to wrap the string with [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code).
+It provides a string wrapper object that allows for wrapping a string with
+[ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code). These codes
+when printed in a terminal change text attributes like text color, background,
+intensity etc.
 
-Features
---------
+## Example
 
-Rainbow adds following methods to String class:
+```ruby
+require 'rainbow'
 
-* foreground(color) (with _color_ and _colour_ aliases)
-* background(color)
-* reset
-* bright
-* italic (not well supported by terminal emulators).
-* underline
-* blink
-* inverse
-* hide.
+puts Rainbow("this is red").color(:red) + " and " + Rainbow("this on yellow bg").background(:yellow) + " and " + Rainbow("even bright underlined!").underline.bright
+```
 
-Each of those methods returns string wrapped with some ANSI codes so you can chain calls as in example above.
+## API
 
-Color can be one of following symbols:
+Following methods are available on a string wrapper object:
 
-    :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white, :default
+* `foreground(color)` (with `color` and `colour` aliases)
+* `background(color)`
+* `bright`
+* `underline`
+* `blink`
+* `inverse`
+* `hide`
+* `italic` (not well supported by terminal emulators).
 
-If you have 256-colors capable terminal you can also specify color in RGB which will find the nearest match from 256 colors palette: 
+All of the methods return wrapped string so you can chain method calls as in
+the above example.
 
-    "Jolacz".color(115, 23, 98)
-    "Jolacz".color("#FFC482")
-    "Jolacz".color("FFC482")
+### String mixin
 
-For support on Windows, you should install the following gems:
+If you prefer not to wrap every string you want to colorize with `Rainbow()`
+you can include all the rainbow methods in a String class directly by requiring
+`rainbow/string`:
 
-  gem install windows-pr win32console
+```ruby
+require 'rainbow/string'
 
-If the gems aren't installed strings are simply returned unaltered.
+puts "this is red".color(:red) + " and " + "this on yellow bg".background(:yellow) + " and " + "even bright underlined!".underline.bright
+```
 
-Rainbow can be disabled globally by setting:
+This way of using Rainbow is not recommended though as it pollutes String's
+public interface with methods that are presentation specific.
 
-    Sickill::Rainbow.enabled = false
+NOTE: the mixin is included in String by default in rainbow 1.99 to not break
+backwards compatibility. It won't be included by default in rainbow 2.0.
 
-It will be disabled by default if it detects that STDOUT is not a TTY.
+### Color specification
 
-Installation
-------------
+Both `foreground/color/colour` and `background` accept color specified in any
+of the following ways:
 
-    gem install rainbow
+* color number (where 1 is red, 2 is green and so on):
+  `Rainbow("hello").foreground(1)`
 
-Usage
------
+* color name as a symbol (available: :black, :red, :green, :yellow, :blue,
+  :magenta, :cyan, :white):
+  `Rainbow("hello").foreground(:yellow)`
 
-    require 'rainbow'
-    puts "this is red".foreground(:red) + " and " + "this on yellow bg".background(:yellow) + " and " + "even bright underlined!".underline.bright
+* RGB triplet as separate values in the range 0-255:
+  `Rainbow("hello").foreground(115, 23, 98)`
 
-Rails Usage
------------
+* RGB triplet as a hex string:
+  `Rainbow("hello").foreground("FFC482")` or `Rainbow("hello").foreground("#FFC482")`
 
-You're probably wanting to add colour to your logs. To do so you must explicity enable rainbow because it will detect that STDOUT (ie: the log file) is not a TTY.
-To make things easy, create the file `config/initializers/rainbow.rb` and include the following:
+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.
 
-    require 'rainbow'
-    Sickill::Rainbow.enabled = true
+## Windows support
 
-Authors
--------
+For Windows support, you should install the following gems:
 
-* Marcin Kulik
-* Xavier Nayrac
+```ruby
+gem install windows-pr win32console
+```
 
+If the above gems aren't installed then all strings are returned unmodified.
+
+## Configuration
+
+Rainbow can be enabled/disabled globally by setting:
+
+```ruby
+Rainbow.enabled = true/false
+```
+
+When disabled all the methods return an unmodified string
+(`Rainbow("hello").color(:red) == "hello"`).
+
+It's enabled by default, unless STDOUT/STDERR is not a TTY or a terminal is
+dumb.
+
+## Installation
+
+Add it to your Gemfile:
+
+```ruby
+gem 'rainbow'
+```
+
+Or just install it via rubygems:
+
+```ruby
+gem install rainbow
+```
+
+## Authors
+
+[Marcin Kulik](http://ku1ik.com/) and [great open-source contributors](https://github.com/sickill/rainbow/graphs/contributors).

data/Rakefile

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

data/lib/rainbow.rb

@@ -1,108 +1,26 @@
-require 'rbconfig'
-require File.join(File.dirname(__FILE__), 'ansi_color')
-
-module Sickill
-  module Rainbow
-    class << self; attr_accessor :enabled; end
-    @enabled = STDOUT.tty? && ENV['TERM'] != 'dumb' || ENV['CLICOLOR_FORCE'] == '1'
-
-    TERM_COLORS = {
-      :black => 0,
-      :red => 1,
-      :green => 2,
-      :yellow => 3,
-      :blue => 4,
-      :magenta => 5,
-      :cyan => 6,
-      :white => 7,
-      :default => 9,
-    }
-
-    TERM_EFFECTS = {
-      :reset => 0,
-      :bright => 1,
-      :italic => 3,
-      :underline => 4,
-      :blink => 5,
-      :inverse => 7,
-      :hide => 8,
-    }
-
-    # Sets foreground color of this text.
-    def foreground(*color)
-      wrap_with_code(AnsiColor.new(:foreground, *color).code)
-    end
-    alias_method :color, :foreground
-    alias_method :colour, :foreground
-
-
-    # Sets background color of this text.
-    def background(*color)
-      wrap_with_code(AnsiColor.new(:background, *color).code)
-    end
-
-    # Resets terminal to default colors/backgrounds.
-    #
-    # It shouldn't be needed to use this method because all methods
-    # append terminal reset code to end of string.
-    def reset
-      wrap_with_code(TERM_EFFECTS[:reset])
-    end
-
-    # Turns on bright/bold for this text.
-    def bright
-      wrap_with_code(TERM_EFFECTS[:bright])
-    end
-
-    # Turns on italic style for this text (not well supported by terminal
-    # emulators).
-    def italic
-      wrap_with_code(TERM_EFFECTS[:italic])
-    end
+require 'rainbow/core'
+require 'rainbow/wrapper'
+require 'rainbow/string'
+require 'rainbow/legacy'
 
-    # Turns on underline decoration for this text.
-    def underline
-      wrap_with_code(TERM_EFFECTS[:underline])
-    end
-
-    # Turns on blinking attribute for this text (not well supported by terminal
-    # emulators).
-    def blink
-      wrap_with_code(TERM_EFFECTS[:blink])
-    end
-
-    # Inverses current foreground/background colors.
-    def inverse
-      wrap_with_code(TERM_EFFECTS[:inverse])
-    end
-
-    # Hides this text (set its color to the same as background).
-    def hide
-      wrap_with_code(TERM_EFFECTS[:hide])
-    end
-
-    private
-
-    def wrap_with_code(code) #:nodoc:
-      return self unless Sickill::Rainbow.enabled
-
-      var = self.dup
-      matched = var.match(/^(\e\[([\d;]+)m)*/)
-      var.insert(matched.end(0), "\e[#{code}m")
-      var.concat("\e[0m") unless var =~ /\e\[0m$/
-      var
-    end
+unless STDOUT.tty? && STDERR.tty?
+  Rainbow.enabled = false
+end
 
-  end
+if ENV['TERM'] == 'dumb'
+  Rainbow.enabled = false
 end
 
-String.send(:include, Sickill::Rainbow)
+if ENV['CLICOLOR_FORCE'] == '1'
+  Rainbow.enabled = true
+end
 
 # On Windows systems, try to load the local ANSI support library
+require 'rbconfig'
 if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
   begin
     require 'Win32/Console/ANSI'
   rescue LoadError
-    Sickill::Rainbow.enabled = false
+    Rainbow.enabled = false
   end
 end

data/lib/rainbow/color.rb

@@ -0,0 +1,109 @@
+module Rainbow
+  class Color
+
+    attr_reader :ground
+
+    def self.build(ground, values)
+      raise ArgumentError.new(
+        "Wrong number of arguments for color definition, should be 1 or 3"
+      ) unless [1, 3].include?(values.size)
+
+      color = values.size == 1 ? values.first : values
+
+      case color
+        when ::Fixnum then Indexed.new(ground, color)
+        when ::Symbol then Named.new(ground, color)
+        when ::Array  then RGB.new(ground, *color)
+        when ::String then RGB.new(ground, *parse_hex_color(color))
+      end
+    end
+
+    def self.parse_hex_color(hex)
+      hex = hex.gsub('#', '')
+      r   = hex[0..1].to_i(16)
+      g   = hex[2..3].to_i(16)
+      b   = hex[4..5].to_i(16)
+
+      [r, g, b]
+    end
+
+    class Indexed < Color
+
+      attr_reader :num
+
+      def initialize(ground, num)
+        @ground = ground
+        @num = num
+      end
+
+      def codes
+        code = num + (ground == :foreground ? 30 : 40)
+
+        [code]
+      end
+
+    end
+
+    class Named < Indexed
+
+      NAMES = {
+        :black   => 0,
+        :red     => 1,
+        :green   => 2,
+        :yellow  => 3,
+        :blue    => 4,
+        :magenta => 5,
+        :cyan    => 6,
+        :white   => 7,
+        :default => 9,
+      }
+
+      def initialize(ground, name)
+        raise ArgumentError.new(
+          "Unknown color name, valid names: #{color_names.join(', ')}"
+        ) unless color_names.include?(name)
+
+        super(ground, NAMES[name])
+      end
+
+      private
+
+      def color_names
+        NAMES.keys
+      end
+
+    end
+
+    class RGB < Indexed
+
+      attr_reader :r, :g, :b
+
+      def self.to_ansi_domain(value)
+        (6 * (value / 256.0)).to_i
+      end
+
+      def initialize(ground, *values)
+        raise ArgumentError.new(
+          "RGB value outside 0-255 range"
+        ) if values.min < 0 or values.max > 255
+
+        super(ground, 8)
+        @r, @g, @b = values
+      end
+
+      def codes
+        super + [5, code_from_rgb]
+      end
+
+      private
+
+      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)
+      end
+
+    end
+
+  end
+end