ansi256 0.1.0 → 0.2.0

data/README.md

@@ -1,6 +1,12 @@
-# Ansi256
+# ansi256
 
-Decorate text with 256-color ANSI codes.
+ansi256 is a rubygem for colorizing text with 256-color ANSI codes.
+
+Features:
+
+- Supports both named color codes and numeric 256-color codes
+- Allows nesting of colored text
+- Generates optimal(shortest) code sequence
 
 ## Installation
 
@@ -9,6 +15,8 @@ Decorate text with 256-color ANSI codes.
 Basic usage
 -----------
 
+### 256-colors
+
 ```ruby
 require 'ansi256'
 
@@ -27,26 +35,22 @@ puts "Colorize me".fg(111).bg(226).underline.plain
 
 ![colorize-me](https://github.com/junegunn/ansi256/raw/master/colorize-me.png)
 
-Added methods (`fg`, `bg`, `underline`, and `plain`)
-return new String object and do not modify the original String.
-
-256-color table
----------------
+### 16 named colors
 
 ```ruby
-require 'ansi256'
-
-def cfmt col
-  col.to_s.rjust(5).fg(232).bg(col)
-end
-
-puts (0..7).map  { |col| cfmt col }.join
-puts (8..15).map { |col| cfmt col }.join
-(16..255).each_slice(6) do |slice|
-  puts slice.map { |col| cfmt col }.join
-end
+s = "Colorize me"
+puts [ s.black,   s.black.bold,   s.white.bold.on_black   ].join ' '
+puts [ s.red,     s.red.bold,     s.white.bold.on_red     ].join ' '
+puts [ s.green,   s.green.bold,   s.white.bold.on_green   ].join ' '
+puts [ s.yellow,  s.yellow.bold,  s.white.bold.on_yellow  ].join ' '
+puts [ s.blue,    s.blue.bold,    s.white.bold.on_blue    ].join ' '
+puts [ s.magenta, s.magenta.bold, s.white.bold.on_magenta ].join ' '
+puts [ s.cyan,    s.cyan.bold,    s.white.bold.on_cyan    ].join ' '
+puts [ s.white,   s.white.bold,   s.white.bold.on_white   ].join ' '
 ```
 
+![colorize-me-16](https://github.com/junegunn/ansi256/raw/master/colorize-me-16.png)
+
 Nesting
 -------
 
@@ -63,12 +67,15 @@ puts say_hello_world.plain.fg(27)
 
 ![say-hello-world](https://github.com/junegunn/ansi256/raw/master/say-hello-world.png)
 
-_"Just gimme the code"_
+_"Just gimme the code!"_
 -----------------------
 
 ```ruby
 Ansi256.fg(232)
 Ansi256.bg(226)
+Ansi256.green
+Ansi256.on_green
+Ansi256.bold
 Ansi256.underline
 Ansi256.reset
 ```
@@ -77,7 +84,7 @@ Ansi256.reset
 ansi256 executable
 ------------------
 
-Ansi256 comes with ansi256 script which can be used as follows
+Ansi256 comes with `ansi256` script which can be used as follows
 
 ```bash
 > ansi256
@@ -90,7 +97,31 @@ usage: ansi256 [-u] <[fg][/bg]> [mesage]
 > ansi256 30 "Say '$(ansi256 230/75 "Hello $(ansi256 -u 232/226 World)")'"
 ```
 
-## Contributing
+Color chart
+-----------
+
+### 256-color table
+
+```ruby
+require 'ansi256'
+
+def cfmt col
+  col.to_s.rjust(5).fg(232).bg(col)
+end
+
+puts (0..7).map  { |col| cfmt col }.join
+puts (8..15).map { |col| cfmt col }.join
+(16..255).each_slice(6) do |slice|
+  puts slice.map { |col| cfmt col }.join
+end
+```
+
+### Reference chart
+
+![xterm-color-chart.png](https://github.com/junegunn/ansi256/raw/master/xterm-color-chart.png)
+
+Contributing
+------------
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/lib/ansi256.rb

@@ -1,9 +1,9 @@
 require "ansi256/version"
+require "ansi256/code"
 require "ansi256/mixin"
+require 'set'
 
 module Ansi256
-  RESET = "\e[0m"
-
   class << self
     def fg code, str = nil
       if str
@@ -21,60 +21,79 @@ module Ansi256
       end
     end
 
-    def underline str = nil
-      if str
-        wrap str, Ansi256.underline
-      else
-        "\e[4m"
+    CODE.each do |name, code|
+      define_method name do |*arg|
+        if str = arg.first
+          wrap str, "\e[#{code}m"
+        else
+          "\e[#{code}m"
+        end
       end
     end
 
-    def reset
-      RESET
-    end
-
     def plain str
       str.gsub(PATTERN, '')
     end
 
   private
-    PATTERN = /\e\[(?:[34]8;5;)?[0-9]+m/
-    MULTI_PATTERN = /(?:\e\[(?:[34]8;5;)?[0-9]+m)+/
+    PATTERN = /\e\[[0-9;]+m/
+    MULTI_PATTERN = /(?:\e\[[0-9;]+m)+/
+    EMPTY_TRIPLE = [nil, nil, Set.new]
+
+    def ansify prev, curr
+      nums = []
+      nums << curr[0] if prev[0] != curr[0]
+      nums << curr[1] if prev[1] != curr[1]
+      nums.concat curr[2].to_a if prev[2] != curr[2]
+      "\e[#{nums.compact.join ';'}m"
+    end
 
     def wrap str, color
-      current = [nil, nil, nil]
+      current = [nil, nil, Set.new]
 
       (color + str.gsub(PATTERN) { |m|
-        if m =~ /\e\[0m/
+        if m =~ /\e\[[^m]*\b0m/
           m + color
         else
           m
         end
-      } << RESET).gsub(MULTI_PATTERN) { |codes|
+      } << reset).gsub(MULTI_PATTERN) { |ansi|
         prev = current.dup
-        codes.split(/(?<=m)/).each do |code|
-          case code
-          when /\e\[38/
-            current[0] = code
-          when /\e\[48/
-            current[1] = code
-          when /\e\[0m/
-            current = [nil, nil, nil]
+        prev[2] = prev[2].dup
+        codes = ansi.scan(/\d+/).map(&:to_i)
+
+        idx = -1
+        while (idx += 1) < codes.length
+          case code = codes[idx]
+          when 38
+            current[0] = codes[idx, 3].join ';'
+            idx += 2 # 38;5;11
+          when 48
+            current[1] = codes[idx, 3].join ';'
+            idx += 2 # 38;5;11
+          when 30..37
+            current[0] = codes[idx]
+          when 40..47
+            current[1] = codes[idx]
+          when 0
+            current[0] = current[1] = nil
+            current[2].clear
           else
-            current[2] = code
+            current[2] << code
           end
         end
 
         if current == prev
           ''
-        elsif current == [nil, nil, nil]
-          RESET
+        elsif current == EMPTY_TRIPLE
+          reset
         else
-          if (0..2).any? { |i| prev[i] && !current[i] }
-            RESET
+          if (0..1).any? { |i| prev[i] && !current[i] } || current[2].proper_subset?(prev[2])
+            prev = EMPTY_TRIPLE
+            reset
           else
             ''
-          end + current.join
+          end + ansify(prev, current)
         end
       }
     end

data/lib/ansi256/code.rb

@@ -0,0 +1,25 @@
+module Ansi256
+  CODE = {
+    :reset      => 0,
+    :bold       => 1,
+    :underline  => 4,
+
+    :black      => 30,
+    :red        => 31,
+    :green      => 32,
+    :yellow     => 33,
+    :blue       => 34,
+    :magenta    => 35,
+    :cyan       => 36,
+    :white      => 37,
+
+    :on_black   => 40,
+    :on_red     => 41,
+    :on_green   => 42,
+    :on_yellow  => 43,
+    :on_blue    => 44,
+    :on_magenta => 45,
+    :on_cyan    => 46,
+    :on_white   => 47,
+  }
+end

data/lib/ansi256/mixin.rb

@@ -12,8 +12,10 @@ module Ansi256
       Ansi256.plain self
     end
 
-    def underline
-      Ansi256.underline self
+    Ansi256::CODE.each do |name, code|
+      define_method name do
+        Ansi256.send name, self
+      end
     end
   end
 end

data/lib/ansi256/version.rb

@@ -1,3 +1,3 @@
 module Ansi256
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/test_ansi256.rb

@@ -26,3 +26,26 @@ puts hello = "Hello #{world} !".fg(230).bg(75)
 puts say_hello_world = "Say '#{hello}'".fg(30)
 puts say_hello_world.plain.fg(27)
 
+# Nesting 2
+puts world = "World".bg(226).blue.underline
+puts hello = "Hello #{world} Hello".white.bold
+puts say_hello_world = "Say '#{hello}'".fg(30).underline
+puts say_hello_world.plain.fg(27)
+
+# Nesting 3
+puts world = "World".blue.underline
+puts hello = "Hello #{world} Hello".blue.bold
+puts say_hello_world = "Say '#{hello}'".fg(30).underline
+puts say_hello_world.plain.fg(27)
+
+# Named colors
+s = "Colorize me"
+puts [ s.black,   s.black.bold,   s.white.bold.on_black   ].join ' '
+puts [ s.red,     s.red.bold,     s.white.bold.on_red     ].join ' '
+puts [ s.green,   s.green.bold,   s.white.bold.on_green   ].join ' '
+puts [ s.yellow,  s.yellow.bold,  s.white.bold.on_yellow  ].join ' '
+puts [ s.blue,    s.blue.bold,    s.white.bold.on_blue    ].join ' '
+puts [ s.magenta, s.magenta.bold, s.white.bold.on_magenta ].join ' '
+puts [ s.cyan,    s.cyan.bold,    s.white.bold.on_cyan    ].join ' '
+puts [ s.white,   s.white.bold,   s.white.bold.on_white   ].join ' '
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ansi256
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -59,6 +59,7 @@ files:
 - ansi256.gemspec
 - bin/ansi256
 - lib/ansi256.rb
+- lib/ansi256/code.rb
 - lib/ansi256/mixin.rb
 - lib/ansi256/version.rb
 - test/test_ansi256.rb
@@ -77,7 +78,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 863938328980395766
+      hash: 2355104005458200198
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 863938328980395766
+      hash: 2355104005458200198
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25