rainbow 1.1.1 → 1.1.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Marcin Kulik
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -64,3 +64,10 @@ To make things easy, create the file `config/initializers/rainbow.rb` and includ
 
     require 'rainbow'
     Sickill::Rainbow.enabled = true
+
+Authors
+-------
+
+* Marcin Kulik
+* Xavier Nayrac
+

data/lib/ansi_color.rb

@@ -0,0 +1,71 @@
+require File.join(File.dirname(__FILE__), 'ansi_rgb')
+
+module Sickill
+  module Rainbow
+
+    # Retrieve ANSI color code from a color name, an html color
+    # or an RGB color
+    class AnsiColor
+
+      # +ground+ is one of :foreground, :background
+      # +color+ is one of this 3 formats: name, html, rgb
+      def initialize(ground, *color)
+        @ground = ground
+
+        if color.size == 1
+          @color = color.first
+        else
+          @color = color
+        end
+      end
+
+      # Get the ANSI color code.
+      def code
+        case @color
+          when Symbol then code_from_name
+          when String then code_from_html
+          when Array then code_from_rgb
+        end
+      end
+
+      private
+
+      def code_from_name #:nodoc:
+        validate_color_name
+
+        TERM_COLORS[@color] + (@ground == :foreground ? 30 : 40)
+      end
+
+      def code_from_html #:nodoc:
+        @color = @color.gsub("#", "")
+        AnsiRgb.new(@ground, rgb_from_html).code
+      end
+
+      def rgb_from_html #:nodoc:
+        red = @color[0..1].to_i(16)
+        green = @color[2..3].to_i(16)
+        blue = @color[4..5].to_i(16)
+        [red, green, blue]
+      end
+
+      def code_from_rgb #:nodoc:
+        unless @color.size == 3
+          raise ArgumentError.new \
+            "Bad number of arguments for RGB color definition, should be 3"
+        end
+
+        AnsiRgb.new(@ground, @color).code
+      end
+
+      def validate_color_name #:nodoc:
+        color_names = TERM_COLORS.keys
+
+        unless color_names.include?(@color)
+          raise ArgumentError.new \
+            "Unknown color name, valid names: #{color_names.join(', ')}"
+        end
+      end
+
+    end
+  end
+end

data/lib/ansi_rgb.rb

@@ -0,0 +1,43 @@
+module Sickill
+  module Rainbow
+
+    # Retrieve ANSI color code from RGB color.
+    class AnsiRgb
+
+      # +ground+ is one of :foreground, :background
+      # +rgb+ is an array of 3 values between 0 and 255.
+      def initialize(ground, rgb)
+        if RGB.outside_range?(rgb)
+          raise ArgumentError.new("RGB value outside 0-255 range")
+        end
+
+        @ground_code = { :foreground => 38, :background => 48 }[ground]
+        @red, @green, @blue = rgb[0], rgb[1], rgb[2]
+      end
+
+      # Get the ANSI color code for this RGB color.
+      def code
+        index = 16 +
+                RGB.to_ansi_domain(@red) * 36 +
+                RGB.to_ansi_domain(@green) * 6 +
+                RGB.to_ansi_domain(@blue)
+
+        "#{@ground_code};5;#{index}"
+      end
+
+    end
+
+    # Helper class for RGB color format.
+    class RGB
+      def self.outside_range?(rgb)
+        rgb.min < 0 or rgb.max > 255
+      end
+
+      # Change domain of color value from 0-255 to 0-5
+      def self.to_ansi_domain(value)
+        (6 * (value / 256.0)).to_i
+      end
+    end
+
+  end
+end

data/lib/rainbow.rb

@@ -1,4 +1,5 @@
 require 'rbconfig'
+require File.join(File.dirname(__FILE__), 'ansi_color')
 
 module Sickill
   module Rainbow
@@ -29,8 +30,7 @@ module Sickill
 
     # Sets foreground color of this text.
     def foreground(*color)
-      color = color.first if color.size == 1
-      wrap_with_code(get_color_code(color, :foreground))
+      wrap_with_code(AnsiColor.new(:foreground, *color).code)
     end
     alias_method :color, :foreground
     alias_method :colour, :foreground
@@ -38,13 +38,13 @@ module Sickill
 
     # Sets background color of this text.
     def background(*color)
-      color = color.first if color.size == 1
-      wrap_with_code(get_color_code(color, :background))
+      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.
+    # 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
@@ -54,7 +54,8 @@ module Sickill
       wrap_with_code(TERM_EFFECTS[:bright])
     end
 
-    # Turns on italic style for this text (not well supported by terminal emulators).
+    # Turns on italic style for this text (not well supported by terminal
+    # emulators).
     def italic
       wrap_with_code(TERM_EFFECTS[:italic])
     end
@@ -64,7 +65,8 @@ module Sickill
       wrap_with_code(TERM_EFFECTS[:underline])
     end
 
-    # Turns on blinking attribute for this text (not well supported by terminal emulators).
+    # Turns on blinking attribute for this text (not well supported by terminal
+    # emulators).
     def blink
       wrap_with_code(TERM_EFFECTS[:blink])
     end
@@ -79,49 +81,24 @@ module Sickill
       wrap_with_code(TERM_EFFECTS[:hide])
     end
 
-    protected
+    private
+
     def wrap_with_code(code) #:nodoc:
       return self unless Sickill::Rainbow.enabled
 
-      out = "#{self}"
-      match = out.match(/^(\e\[([\d;]+)m)*/)
-      out.insert(match.end(0), "\e[#{code}m")
-      out.concat("\e[0m") unless out =~ /\e\[0m$/
-      out
-    end
-
-    def get_color_code(color, type) #:nodoc:
-      case color
-      when Symbol
-        validate_color(color)
-        TERM_COLORS[color] + (type == :foreground ? 30 : 40)
-      when String
-        color = color.gsub("#", "")
-        r, g, b = color[0..1].to_i(16), color[2..3].to_i(16), color[4..5].to_i(16)
-        get_rgb_code(r, g, b, type)
-      when Array
-        raise ArgumentError.new("Bad number of arguments for RGB color definition, should be 3") unless color.size == 3
-        get_rgb_code(color[0], color[1], color[2], type)
-      end
+      matched = match(/^(\e\[([\d;]+)m)*/)
+      insert(matched.end(0), "\e[#{code}m")
+      concat("\e[0m") unless self =~ /\e\[0m$/
+      self
     end
 
-    def get_rgb_code(r, g, b, type) #:nodoc:
-      raise ArgumentError.new("RGB value outside 0-255 range") if [r, g, b].min < 0 || [r, g, b].max > 255
-      code = { :foreground => 38, :background => 48 }[type]
-      index = 16 + (6 * (r / 256.0)).to_i * 36 + (6 * (g / 256.0)).to_i * 6 + (6 * (b / 256.0)).to_i
-      "#{code};5;#{index}"
-    end
-
-    def validate_color(color) #:nodoc:
-      raise ArgumentError.new("Unknown color, valid colors: #{TERM_COLORS.keys.join(', ')}") unless TERM_COLORS.keys.include?(color)
-    end
   end
 end
 
 String.send(:include, Sickill::Rainbow)
 
 # On Windows systems, try to load the local ANSI support library
-if Config::CONFIG['host_os'] =~ /mswin|mingw/
+if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
   begin
     require 'Win32/Console/ANSI'
   rescue LoadError

data/test/rainbow_test.rb

@@ -5,11 +5,11 @@ class RainbowTest < Test::Unit::TestCase #:nodoc:
   def test_color_by_name
     assert_equal "\e[31mhello\e[0m", "hello".color(:red)
   end
-  
+
   def test_color_by_rgb
     assert_equal "\e[38;5;196mhello\e[0m", "hello".color(255, 0, 0)
   end
-  
+
   def test_foreground_alias
     assert_equal "hello".color(:red), "hello".foreground(:red)
   end
@@ -17,7 +17,7 @@ class RainbowTest < Test::Unit::TestCase #:nodoc:
   def test_colour_alias
     assert_equal "hello".color(:red), "hello".colour(:red)
   end
-  
+
   def test_background_by_name
     assert_equal "\e[42mhello\e[0m", "hello".background(:green)
   end
@@ -29,7 +29,7 @@ class RainbowTest < Test::Unit::TestCase #:nodoc:
   def test_color_and_background
     assert_equal "\e[31m\e[42mhello\e[0m", "hello".color(:red).background(:green)
   end
-  
+
   def test_hex_color
     assert_equal "\e[48;5;46mhello\e[0m", "hello".background("#00FF00")
     assert_equal "\e[48;5;46mhello\e[0m", "hello".background("00FF00")
@@ -81,4 +81,185 @@ class RainbowTest < Test::Unit::TestCase #:nodoc:
   def test_color_override
     assert_equal "\e[31m\e[34m\e[33mhello\e[0m", "hello".color(:red).color(:blue).color(:yellow)
   end
+
+  def test_reset
+    assert_equal "\e[0mhello\e[0m", "hello".reset
+  end
+
+  def test_italic
+    assert_equal "\e[3mhello\e[0m", "hello".italic
+  end
+
+  def test_underline
+    assert_equal "\e[4mhello\e[0m", "hello".underline
+  end
+
+  def test_blink
+    assert_equal "\e[5mhello\e[0m", "hello".blink
+  end
+
+  def test_inverse
+    assert_equal "\e[7mhello\e[0m", "hello".inverse
+  end
+
+  def test_hide
+    assert_equal "\e[8mhello\e[0m", "hello".hide
+  end
+
+  class MyString < String
+  end
+
+  def test_inheritance
+    my_string = MyString.new "hello"
+    assert_equal "\e[31mhello\e[0m", my_string.color(:red)
+  end
+
+  def test_disabled
+    Sickill::Rainbow.enabled = false
+    assert_equal "hello", "hello".color(:red)
+    Sickill::Rainbow.enabled = true
+  end
+
+end
+
+class AnsiColorTest < Test::Unit::TestCase
+  include Sickill::Rainbow
+
+  ### Foreground
+
+  def test_bad_foreground_name
+    assert_raises ArgumentError do
+      AnsiColor.new(:foreground, :azerty).code
+    end
+  end
+
+  def test_by_name_black_foreground
+    assert_equal 30, AnsiColor.new(:foreground, :black).code
+  end
+
+  def test_by_name_red_foreground
+    assert_equal 31, AnsiColor.new(:foreground, :red).code
+  end
+
+  def test_by_name_green_foreground
+    assert_equal 32, AnsiColor.new(:foreground, :green).code
+  end
+
+  def test_by_name_yellow_foreground
+    assert_equal 33, AnsiColor.new(:foreground, :yellow).code
+  end
+
+  def test_by_name_blue_foreground
+    assert_equal 34, AnsiColor.new(:foreground, :blue).code
+  end
+
+  def test_by_name_magenta_foreground
+    assert_equal 35, AnsiColor.new(:foreground, :magenta).code
+  end
+
+  def test_by_name_cyan_foreground
+    assert_equal 36, AnsiColor.new(:foreground, :cyan).code
+  end
+
+  def test_by_name_white_foreground
+    assert_equal 37, AnsiColor.new(:foreground, :white).code
+  end
+
+  ### Background
+
+  def test_bad_background_name
+    assert_raises ArgumentError do
+      AnsiColor.new(:background, :azerty).code
+    end
+  end
+
+  def test_by_name_black_background
+    assert_equal 40, AnsiColor.new(:background, :black).code
+  end
+
+  def test_by_name_red_background
+    assert_equal 41, AnsiColor.new(:background, :red).code
+  end
+
+  def test_by_name_green_background
+    assert_equal 42, AnsiColor.new(:background, :green).code
+  end
+
+  def test_by_name_yellow_background
+    assert_equal 43, AnsiColor.new(:background, :yellow).code
+  end
+
+  def test_by_name_blue_background
+    assert_equal 44, AnsiColor.new(:background, :blue).code
+  end
+
+  def test_by_name_magenta_background
+    assert_equal 45, AnsiColor.new(:background, :magenta).code
+  end
+
+  def test_by_name_cyan_background
+    assert_equal 46, AnsiColor.new(:background, :cyan).code
+  end
+
+  def test_by_name_white_background
+    assert_equal 47, AnsiColor.new(:background, :white).code
+  end
+
+  ### Hex color
+
+  def test_by_hex_maj
+    assert_equal "38;5;46", AnsiColor.new(:foreground, "00FF00").code
+  end
+
+  def test_by_hex_min
+    assert_equal "38;5;46", AnsiColor.new(:foreground, "00ff00").code
+  end
+
+  def test_by_hex_maj_with_sharp
+    assert_equal "38;5;46", AnsiColor.new(:foreground, "#00FF00").code
+  end
+
+  def test_by_hex_min_with_sharp
+    assert_equal "38;5;46", AnsiColor.new(:foreground, "#00ff00").code
+  end
+
+  ### RGB color
+
+  def test_too_few_colors
+    assert_raises ArgumentError do
+      AnsiColor.new(:foreground, 255, 0).code
+    end
+  end
+
+  def test_too_much_colors
+    assert_raises ArgumentError do
+      AnsiColor.new(:foreground, 255, 0, 0, 0).code
+    end
+  end
+
+  def test_by_rgb_red_foreground
+    assert_equal "38;5;196", AnsiColor.new(:foreground, 255, 0, 0).code
+  end
+
+end
+
+class AnsiRgbTest < Test::Unit::TestCase
+  include Sickill::Rainbow
+
+  def test_red
+    assert_equal "38;5;196", AnsiRgb.new(:foreground, [255, 0, 0]).code
+  end
+
+  def test_rgb_color_with_values_below_zero
+    assert_raises ArgumentError do
+      AnsiRgb.new(:foreground, [-1, 0, 0])
+    end
+  end
+
+  def test_rgb_color_with_values_above_255
+    assert_raises ArgumentError do
+      AnsiRgb.new(:foreground, [256, 0, 0])
+    end
+  end
+
 end

metadata

@@ -1,68 +1,51 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rainbow
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 1
-  version: 1.1.1
+version: !ruby/object:Gem::Version
+  version: 1.1.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Marcin Kulik
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-06 00:00:00 +01:00
-default_executable: 
+date: 2011-11-13 00:00:00.000000000Z
 dependencies: []
-
 description: 
 email: marcin.kulik@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.markdown
 - Changelog
 - LICENSE
 - lib/rainbow.rb
+- lib/ansi_color.rb
+- lib/ansi_rgb.rb
 - test/rainbow_test.rb
-has_rdoc: true
-homepage: http://sickill.net
+homepage: http://ku1ik.com/
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Rainbow extends ruby String class enabling coloring text on ANSI terminals
 test_files: []
-