ansi256 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 895f492a5984cb96d47fd0ba832e2ef911e6da13e3205a0be1efbb9d67042f05
+  data.tar.gz: ea8063500db6e69974b45b37ab0545fe6cdb316f2dba8fcdca507b6e6050d6e9
+SHA512:
+  metadata.gz: 1202cbc808123db06151190557d6db5b30115337a295677a58176797a67eae0acf431459b0c9e2caf0a7b3e1c29325f2c89d4d7d175730eaba1a22355872ce08
+  data.tar.gz: 5fa74dfb02d803ed6230cf318f27111275e1f54c28b4de7533f39ec0bcbad41906062859a316d8f86eaad86e50f70e8d754574ef66af9b6ea57770f6a651cb40

data/README.md

@@ -51,6 +51,16 @@ 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)
 
+### RGB color approximated to 256-color ANSI code
+
+```ruby
+puts "RGB Color (RRGGBB)".fg('ff9930').bg('203366')
+
+puts "RGB Color (R-G-B-)".fg('f90').bg('036')
+
+puts "RGB Color (Monochrome)".fg('ef').bg('3f')
+```
+
 Nesting
 -------
 
@@ -67,8 +77,8 @@ 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!"_
------------------------
+Ansi256 methods
+---------------
 
 ```ruby
 Ansi256.fg(232)
@@ -76,10 +86,29 @@ Ansi256.bg(226)
 Ansi256.green
 Ansi256.on_green
 Ansi256.bold
+Ansi256.dim
+Ansi256.italic
 Ansi256.underline
 Ansi256.reset
+
+Ansi256.fg(232, 'Hello')
+Ansi256.bg(226, 'World')
+Ansi256.green('Hello World')
 ```
 
+Disabling extended String methods
+---------------------------------
+
+```ruby
+Ansi256.enabled?
+  # true
+
+# Print colored output only when STDOUT is tty
+Ansi256.enabled = $stdout.tty?
+
+"Hello".fg(232)
+  # Hello
+```
 
 ansi256 executable
 ------------------
@@ -87,7 +116,7 @@ ansi256 executable
 Ansi256 comes with `ansi256` script which can be used as follows
 
 ```bash
-usage: ansi256 [-u] <[fg][/bg]> [mesage]
+usage: ansi256 [-b] [-d] [-i] [-u] <[fg][/bg]> [message]
 
 # Numeric color codes
 ansi256 232 "Hello world"
@@ -99,6 +128,9 @@ ansi256 yellow "Hello world"
 ansi256 /blue "Hello world"
 ansi256 yellow/blue "Hello world"
 
+# RGB colors (only support 6-letter hex codes)
+ansi256 ff9900/000033 "Hello world"
+
 # Mixed color codes
 ansi256 yellow/232 "Hello world"
 

data/ansi256.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", ">= 2.2.33"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
 end

data/bin/ansi256

@@ -1,36 +1,45 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'ansi256'
 
-bold      = ARGV.delete '-b'
-underline = ARGV.delete '-u'
+attrs = [
+  ARGV.delete('-b') && :bold,
+  ARGV.delete('-d') && :dim,
+  ARGV.delete('-i') && :italic,
+  ARGV.delete('-u') && :underline
+].compact
 
-if ARGV.length < 1
-  puts 'usage: ansi256 [-b] [-u] <[fg][/bg]> [message]'
+if ARGV.empty?
+  puts 'usage: ansi256 [-b] [-d] [-i] [-u] <[fg][/bg]> [message]'
   exit 1
 end
 
-fgbg, *msg = ARGV
-fg,   bg   = fgbg.split('/').map { |e|
-  if !e.to_s.empty?
-    (e =~ /^\d+$/) ? e.to_i : e.downcase.to_sym
+fgbg, *rest = ARGV
+fg, bg = fgbg.split('/').map do |e|
+  next if e.empty?
+
+  case e
+  when /^#?[0-9a-f]{6}$/i then e
+  when /^\d+$/ then e.to_i
+  else e.downcase.to_sym
   end
-}
+end
 
-def output msg, fg, bg, ul, b
-  msg = msg.fg(fg)    if fg
-  msg = msg.bg(bg)    if bg
-  msg = msg.underline if ul
-  msg = msg.bold      if b
+output = lambda do |msg|
+  msg = msg.fg(fg) if fg
+  msg = msg.bg(bg) if bg
+  msg = attrs.reduce(msg) { |m, a| m.send(a) }
   puts msg
 end
 
-if !msg.empty?
-  msg.each do |m|
-    output m, fg, bg, underline, bold
+if !rest.empty?
+  rest.each do |m|
+    output.call(m)
   end
 else
-  while msg = $stdin.gets
-    output msg.chomp, fg, bg, underline, bold
+  while (msg = $stdin.gets)
+    output.call(msg.chomp)
   end
 end

data/lib/ansi256/code.rb

@@ -2,6 +2,8 @@ module Ansi256
   CODE = {
     :reset      => 0,
     :bold       => 1,
+    :dim        => 2,
+    :italic     => 3,
     :underline  => 4,
 
     :black      => 30,

data/lib/ansi256/mixin.rb

@@ -1,21 +1,74 @@
 module Ansi256
-  module Mixin
-    def fg code
-      Ansi256.fg(code, self)
-    end
+  class << self
+    def enabled= bool
+      if bool
+        String.class_eval do
+          [:fg, :bg, :plain].each do |name|
+            undef_method(name) if method_defined?(name)
+          end
 
-    def bg code
-      Ansi256.bg(code, self)
-    end
+          def fg code
+            Ansi256.fg(code, self)
+          end
 
-    def plain
-      Ansi256.plain self
-    end
+          def bg code
+            Ansi256.bg(code, self)
+          end
+
+          def plain
+            Ansi256.plain self
+          end
+
+          Ansi256::CODE.each do |name, code|
+            undef_method(name) if method_defined?(name)
+            define_method name do
+              Ansi256.send name, self
+            end
+          end
+        end
 
-    Ansi256::CODE.each do |name, code|
-      define_method name do
-        Ansi256.send name, self
+        Ansi256.class_eval do
+          class << self
+            undef_method(:enabled?) if method_defined?(:enabled?)
+            def enabled?
+              true
+            end
+          end
+        end
+      else
+        String.class_eval do
+          [:fg, :bg, :plain].each do |name|
+            undef_method(name) if method_defined?(name)
+          end
+
+          def fg code
+            self
+          end
+          alias bg fg
+
+          def plain
+            Ansi256.plain self
+          end
+
+          Ansi256::CODE.each do |name, code|
+            undef_method(name) if method_defined?(name)
+            define_method name do
+              self
+            end
+          end
+        end
+
+        Ansi256.class_eval do
+          class << self
+            undef_method(:enabled?) if method_defined?(:enabled?)
+            def enabled?
+              false
+            end
+          end
+        end
       end
+
+      bool
     end
   end
 end

data/lib/ansi256/version.rb

@@ -1,3 +1,3 @@
 module Ansi256
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/ansi256.rb

@@ -12,6 +12,8 @@ module Ansi256
         "\e[#{CODE[code]}m"
       elsif code.is_a?(Fixnum) && (0..255).include?(code)
         "\e[38;5;#{code}m"
+      elsif ansirgb = ansicode_for_rgb(code)
+        "\e[38;5;#{ansirgb}m"
       else
         raise ArgumentError, "Invalid color code: #{code}"
       end
@@ -24,6 +26,8 @@ module Ansi256
         "\e[#{CODE[code] + 10}m"
       elsif code.is_a?(Fixnum) && (0..255).include?(code)
         "\e[48;5;#{code}m"
+      elsif ansirgb = ansicode_for_rgb(code)
+        "\e[48;5;#{ansirgb}m"
       else
         raise ArgumentError, "Invalid color code: #{code}"
       end
@@ -56,6 +60,27 @@ module Ansi256
       "\e[#{nums.compact.join ';'}m"
     end
 
+    def ansicode_for_rgb rgb
+      return unless rgb.is_a?(String) &&
+                    rgb =~ /^#?([0-9a-f]+)$/i
+      rgb = $1
+
+      case rgb.length
+      when 2
+        m = (256 - 231) * rgb.to_i(16) / 256
+        return m == 0 ? 16 : (231 + m)
+      when 3
+        r, g, b = rgb.each_char.map { |e| (e * 2).to_i(16) }
+      when 6
+        r, g, b = rgb.each_char.each_slice(2).map { |e| e.join.to_i(16) }
+      else
+        return
+      end
+
+      r, g, b = [r, g, b].map { |e| 6 * e / 256 }
+      r * 36 + g * 6 + b + 16
+    end
+
     def wrap str, color
       current = [nil, nil, Set.new]
 
@@ -108,7 +133,4 @@ module Ansi256
   end
 end
 
-class String
-  include Ansi256::Mixin
-end
-
+Ansi256.enabled = true

data/test/test_ansi256.rb

@@ -67,6 +67,8 @@ class TestAnsi256 < MiniTest::Unit::TestCase
   def test_just_code
     assert_equal "\e[0m", Ansi256.reset
     assert_equal "\e[1m", Ansi256.bold
+    assert_equal "\e[2m", Ansi256.dim
+    assert_equal "\e[3m", Ansi256.italic
     assert_equal "\e[4m", Ansi256.underline
 
     assert_equal "\e[30m", Ansi256.black
@@ -115,6 +117,8 @@ class TestAnsi256 < MiniTest::Unit::TestCase
     assert_raises(ArgumentError) { Ansi256.fg(300) }
     assert_raises(ArgumentError) { Ansi256.bg(-1) }
     assert_raises(ArgumentError) { Ansi256.bg(300) }
+    assert_raises(ArgumentError) { Ansi256.bg('ffaa') }
+    assert_raises(ArgumentError) { Ansi256.bg('ffeeffaa') }
   end
 
   def test_fg_bg_underline
@@ -139,4 +143,76 @@ class TestAnsi256 < MiniTest::Unit::TestCase
     assert_equal "\e[32;48;5;200;1mWow \e[38;5;100;44;1;4mhello\e[0m\e[32;48;5;200;1m world\e[0m",
       "Wow #{'hello'.fg(100).underline.on_blue} world".green.bold.bg(200)
   end
+
+  def test_rgb
+    {
+      '00'     => 16,
+      '000000' => 16,
+      '111'    => 16,
+      '11'     => 232,
+      '101010' => 16,
+      '1a'     => 233,
+      '1a1a1a' => 16,
+      '20'     => 234,
+      '22'     => 234,
+      '202020' => 16,
+      '222222' => 16,
+      '222222' => 16,
+      'ff'     => 255,
+      'ffffff' => 231,
+      'FFFFFF' => 231,
+      'ff0'    => 226,
+      'ffff00' => 226,
+      'ff0000' => 196,
+      '00ff00' => 46,
+      '0000ff' => 21,
+      'ff9900' => 214,
+      '00ffff' => 51,
+      '0ff'    => 51,
+    }.each do |rgb, ansi|
+      assert_equal ansi, Ansi256.fg(rgb).scan(/[0-9]+/).last.to_i
+      assert_equal ansi, Ansi256.bg(rgb).scan(/[0-9]+/).last.to_i
+    end
+    [:bg, :fg].each do |m|
+      (0..255).each do |r|
+        color = r.to_s(16).rjust(2, '0') * 3
+        print Ansi256.send(m, color, color + ' ')
+      end
+      (0..255).each do |r|
+        color = r.to_s(16).rjust(2, '0')
+        print Ansi256.send(m, color, color + ' ')
+      end
+    end
+    0.step(255, 20) do |r|
+      0.step(255, 20) do |g|
+        0.step(255, 20) do |b|
+          color = [r, g, b].map { |c| c.to_s(16).rjust(2, '0') }.join
+          print Ansi256.bg(color, color + ' ')
+        end
+      end
+    end
+    puts "RGB Color".fg('ff9900').bg('003366')
+    puts "RGB Color".fg('f90').bg('#036')
+    puts "RGB Color".fg('#ff9900').bg('#003366')
+    puts "RGB Color (Monochrome)".fg('ef').bg('3a')
+  end
+
+  def test_enabled
+    2.times do
+      [:fg, :bg].each do |m|
+        assert Ansi256.enabled?
+        hello = "hello".send(m, 'f90')
+        assert_equal 'hello', hello.plain
+
+        Ansi256.enabled = false
+        assert !Ansi256.enabled?
+        assert hello.length > "hello".send(m, 'f90').length
+        assert_equal 'hello', hello.plain
+
+        Ansi256.enabled = true
+        assert Ansi256.enabled?
+        assert_equal hello, "hello".send(m, 'f90')
+      end
+    end
+  end
 end

metadata

@@ -1,46 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: ansi256
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Junegunn Choi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-05-11 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.33
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.2.33
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Colorize text using 256-color ANSI codes
@@ -51,7 +60,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -66,33 +75,25 @@ files:
 homepage: https://github.com/junegunn/ansi256
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3827977892707263520
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3827977892707263520
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.25
-signing_key: 
-specification_version: 3
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
 summary: Colorize text using 256-color ANSI codes
 test_files:
 - test/test_ansi256.rb