paint 0.8.2 → 0.8.3

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+=== 0.8.3
+* Paint.[] also accepts uppercased hex strings (gh#2)
+* Performance tweaks (thanks to murphy) (gh#4, #5)
+  * API change: deactivate colorizing with Paint.mode = 0
+
 === 0.8.2
 * Paint.[] with only a single string argument does not colorize the string anymore, but returns the plain string
 * New pseudo color :random - returns a random ansi color
@@ -5,7 +10,7 @@
 === 0.8.1
 * Improve rgb function with better gray scale values
 * Add Paint.mode:
-  * Set to false to deactivate colorizing
+  * Set to 0 to deactivate colorizing
   * Set to 16 or 8 and all color generation methods will generate simple ansi colors
   * Set to 256 for 256 color support
   * Tries to automatically detect your terminal's features

data/README.rdoc

@@ -10,8 +10,9 @@ Paint manages terminal colors and effects for you. It combines the strengths of
 * Custom shortcuts can be defined and flexibly mixed in
 * Fall-back modes for non-256-color terminals (Paint.mode), supported modes:
   * 256 colors
-  * 8 colors (only ansi colors)
   * 16 colors (only ansi colors, combined with bright effect)
+  * 8 colors (only ansi colors)
+  * 0 colors (deactivate)
 
 == Setup
 
@@ -102,7 +103,7 @@ You can choose between three ways to use <tt>Paint.[]</tt> by setting <tt>Paint.
 * 256:   full support
 * 16:    don't use 256 colors, but the ansi eight ones (combined with bright effect)
 * 8:     don't use 256 colors, but the ansi eight ones
-* false: don't colorize at all
+* 0:     don't colorize at all
 
 Paint tries to detect automatically the proper value, but this is still experimental. Please open an issue if <tt>Paint.detect_mode</tt> yields a wrong value for you.
 
@@ -169,4 +170,8 @@ Mainly influenced by rainbow[https://github.com/sickill/rainbow] and {term-ansic
 
 Copyright (c) 2011 Jan Lelis, http://rbjl.net, released under the MIT license.
 
+Contributions[https://github.com/janlelis/paint/contributors] by and thanks to:
+* {murphy}[https://github.com/rubychan]
+
 J-_-L
+

data/Rakefile

@@ -49,3 +49,68 @@ end
 #  rdoc.rdoc_files.include('README*')
 #  rdoc.rdoc_files.include('lib/**/*.rb')
 #end
+
+desc "Run a Benchmark"
+task :benchmark do
+  require 'benchmark'
+  require 'term/ansicolor'
+  class String
+    include Term::ANSIColor
+  end
+  
+  require 'rainbow'
+  $:.unshift '../lib'
+  require 'paint'
+  
+  n = 100_000
+  colors = [:black, :red, :green, :yellow, :blue, :magenta, :cyan]
+  def colors.next
+    @index ||= 0
+    at((@index += 1) % size)
+  end
+  Benchmark.bmbm 30 do |results|
+    string = 'Ruby is awesome!'
+    
+    results.report 'cycle' do
+      n.times do
+        colors.next
+      end
+    end
+
+    results.report 'paint' do
+      n.times do
+        Paint[string, colors.next]
+      end
+    end
+    
+    results.report 'term-ansicolor' do
+      n.times do
+        string.send(colors.next)
+      end
+    end
+    
+    results.report 'rainbow' do
+      n.times do
+        string.color(colors.next)
+      end
+    end
+
+    results.report 'paint with background' do
+      n.times do
+        Paint[string, colors.next, colors.next]
+      end
+    end
+
+    results.report 'term-ansicolor with background' do
+      n.times do
+        string.send(colors.next).send("on_#{colors.next}")
+      end
+    end
+    
+    results.report 'rainbow with background' do
+      n.times do
+        string.color(colors.next).background(colors.next)
+      end
+    end
+  end
+end

data/lib/paint.rb

@@ -54,35 +54,64 @@ module Paint
     :overline_off  => 55,
   }
 
+  # cache
+  ANSI_COLORS_FOREGROUND = {
+    :black   => '30',
+    :red     => '31',
+    :green   => '32',
+    :yellow  => '33',
+    :blue    => '34',
+    :magenta => '35',
+    :cyan    => '36',
+    :white   => '37',
+    :default => '39',
+  }
+
+  # cache
+  ANSI_COLORS_BACKGROUND = {
+    :black   => '40',
+    :red     => '41',
+    :green   => '42',
+    :yellow  => '43',
+    :blue    => '44',
+    :magenta => '45',
+    :cyan    => '46',
+    :white   => '47',
+    :default => '49',
+  }
+
   class << self
     # Takes a string and color options and colorizes the string
     # See README.rdoc for details
-    def [](string, *args)
-      if mode && !args.empty?
-        color(*args) + string.to_s + NOTHING
-      else
-        string.to_s
+    def [](string, *options)
+      return string.to_s if mode.zero? || options.empty?
+      
+      if options.size == 1 && !options.first.respond_to?(:to_ary)
+        options = options.first
       end
+      
+      cache[options] + string.to_s + NOTHING
     end
 
     # Sometimes, you only need the color
     # Used by []
     def color(*options)
-      return '' if !mode || options.empty?
+      return '' if mode.zero? || options.empty?
       mix = []
       color_seen = false
+      colors = ANSI_COLORS_FOREGROUND
 
       options.each{ |option|
         case option
         when Symbol
-          if option == :random
-            mix << random(color_seen)
-            color_seen = true
-          elsif ANSI_EFFECTS.keys.include?(option)
+          if color = colors[option]
+            mix << color
+            color_seen = :set
+          elsif ANSI_EFFECTS.key?(option)
             mix << effect(option)
-          elsif ANSI_COLORS.keys.include?(option)
-            mix  << simple(option, color_seen)
-            color_seen = true
+          elsif option == :random
+            mix << random(color_seen)
+            color_seen = :set
           else
             raise ArgumentError, "Unknown color or effect: #{ option }"
           end
@@ -90,32 +119,37 @@ module Paint
         when Array
           if option.size == 3 && option.all?{ |n| n.is_a? Numeric }
             mix << rgb(*(option + [color_seen])) # 1.8 workaround
-            color_seen = true
+            color_seen = :set
           else
             raise ArgumentError, "Array argument must contain 3 numerals"
           end
 
         when ::String
-          if option =~ /^#?(?:[0-9a-f]{3}){1,2}$/
+          if option =~ /^#?(?:[0-9a-f]{3}){1,2}$/i
             mix << hex(option, color_seen)
-            color_seen = true
+            color_seen = :set
           else
             mix << rgb_name(option, color_seen)
-            color_seen = true
+            color_seen = :set
           end
 
         when Numeric
           integer = option.to_i
-          color_seen = true if (30..49).include?(integer)
+          color_seen = :set if (30..49).include?(integer)
           mix << integer
 
         when nil
-          color_seen = true
+          color_seen = :set
         
         else
           raise ArgumentError, "Invalid argument: #{ option.inspect }"
 
         end
+        
+        if color_seen == :set
+          colors = ANSI_COLORS_BACKGROUND
+          color_seen = true
+        end
       }
 
       wrap(*mix)
@@ -124,10 +158,11 @@ module Paint
     # This variable influences the color code generation
     # Currently supported values:
     # * 256    - 256 colors
-    # * 16     - only ansi colors
-    # * false  - no colorization!
-    def mode() ( !defined?(@mode) || @mode.nil? ) ? detect_mode : @mode end
-    def mode=(val) @mode = val end
+    # * 16     - only ansi colors and bright effect
+    # * 8      - only ansi colors
+    # * 0      - no colorization!
+    def mode() @mode ||= detect_mode end
+    def mode=(val) cache.clear; @mode = val end
 
     # Adds ansi sequence
     def wrap(*ansi_codes)
@@ -173,12 +208,16 @@ module Paint
       (background ? 40 : 30) + rand(8)
     end
 
-    # Creates the specified effect by looking it up in Paint::ANSI_COLORS
+    # Creates the specified effect by looking it up in Paint::ANSI_EFFECTS
     def effect(effect_name)
       ANSI_EFFECTS[effect_name]
     end
 
     private
+    
+    def cache
+      @cache ||= Hash.new { |h, k| h[k] = color(*k) }
+    end
  
     # Returns nearest supported 256-color an rgb value, without fore-/background information
     # Inspired by the rainbow gem

data/lib/paint/util.rb

@@ -38,7 +38,7 @@ module Paint
         if ENV['ANSICON']
           16
         else
-          false
+          0
         end
       else
         # case ENV['COLORTERM']

data/lib/paint/version.rb

@@ -1,3 +1,3 @@
 module Paint
-  VERSION = '0.8.2'
+  VERSION = '0.8.3'
 end

data/paint.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rspec-core'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'rainbow'
+  s.add_development_dependency 'term-ansicolor'
  
   len = s.homepage.size
   s.post_install_message = \

data/spec/paint_mode_spec.rb

@@ -4,8 +4,8 @@ describe 'Paint.mode' do
     Paint['J-_-L', 'gold'].should == "\e[38;5;226mJ-_-L\e[0m"
   end
 
-  it "doesn't colorize anything if mode is false" do
-    Paint.mode = false
+  it "doesn't colorize anything if mode is 0" do
+    Paint.mode = 0
     Paint['J-_-L', 'gold'].should == "J-_-L"
   end
 

data/spec/paint_spec.rb

@@ -34,6 +34,10 @@ describe 'Paint.[]' do
       Paint['J-_-L', "fff"].should == "\e[38;5;255mJ-_-L\e[0m"
     end
 
+    it 'understands a hex string (with uppercased letters) as rgb color definition and use it as foreground color' do
+      Paint['J-_-L', "#4183C4"].should == "\e[38;5;74mJ-_-L\e[0m"
+    end
+
     it 'understands a non-hex string as rgb color name (rgb.txt) and use it as foreground color' do
       Paint['J-_-L', "medium purple"].should == "\e[38;5;141mJ-_-L\e[0m"
     end

metadata

@@ -2,7 +2,7 @@
 name: paint
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors: 
 - Jan Lelis
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-08 00:00:00 Z
+date: 2011-07-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -45,6 +45,28 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rainbow
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: "Terminal painter / no string extensions / 256 color support / effect support / define custom shortcuts / basic usage: Paint['string', :red, :bright]"
 email: mail@janlelis.de
 executables: []