colorize 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71f8aba9c90cbf391acaabc470d94e628d66be6df312605d382cb52b09a939af
-  data.tar.gz: 8efeb99bf7ae768b0d6bc528048238cf0c62f4280e7237ef78163eb1fb026282
+  metadata.gz: b2258f1a1f28ceb6396b7e29aa308326e02bba9a9f36cd229e70c0e417aacd37
+  data.tar.gz: 65b1cbb6089464e698f2dc8591b7d80af1c4aab479cef11e2fcee3c46428dd20
 SHA512:
-  metadata.gz: 2543e6215f9a15e7f8507e4c9c061aec22f3a2d3f4b4d84949c4805b912728fb9a018a6b3f65fa2aefbdbb878bc1ddc99c6a5e29f83cd8229a5df31edea68c1e
-  data.tar.gz: 98c4349e508062160e5a80221eb686dc6fe32ef8f2b90e438cd741c4bd5ddb8dd9c288fb8e0d556aec7a2d25e0ffc47eeee4731439430fc907e0e1d099f40430
+  metadata.gz: 879d312bfb7dad3576bbf6e9791c2a6e168bfb8a29db81980238ce2aaaa5456ac1e535709a6c4f4f811aa5d2a22dce5e89cd0e5366f365102a0667e5c7263d4b
+  data.tar.gz: efc22eb11cc908ae015473ac51fc19680b8adcaf6904d6db7c74064e7e3b2a41cdeadca0a45eeb7950780f94db19e472f561cb3b60bd125fc9460ee4807d353a

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.1.0 / 2023-06-22
+  - make readline support optional
+
+## 1.0.5 / 2023-06-22
+  - (backwards compatibility) purple -> magenta
+
 ## 1.0.3 / 2023-06-21
   - fix ? ommit
 

data/Rakefile

@@ -12,4 +12,8 @@ task :default do
   Rake::Task[:test].execute
   ENV['TEST'] = 'test/test_colorized_string.rb'
   Rake::Task[:test].execute
+  ENV['TEST'] = 'test/test_colorize_with_readline.rb'
+  Rake::Task[:test].execute
+  ENV['TEST'] = 'test/test_colorized_string_with_readline.rb'
+  Rake::Task[:test].execute
 end

data/lib/colorize/class_methods.rb

@@ -3,23 +3,23 @@
 module Colorize
   module ClassMethods
     @@color_codes ||= {
-      black:        30,
-      red:          31,
-      green:        32,
-      yellow:       33,
-      blue:         34,
-      purple:       35,
-      cyan:         36,
-      white:        37,
-      default:      39,
-      light_black:  90,
-      light_red:    91,
-      light_green:  92,
-      light_yellow: 93,
-      light_blue:   94,
-      light_purple: 95,
-      light_cyan:   96,
-      light_white:  97
+      black:         30,
+      red:           31,
+      green:         32,
+      yellow:        33,
+      blue:          34,
+      magenta:       35,
+      cyan:          36,
+      white:         37,
+      default:       39,
+      light_black:   90,
+      light_red:     91,
+      light_green:   92,
+      light_yellow:  93,
+      light_blue:    94,
+      light_magenta: 95,
+      light_cyan:    96,
+      light_white:   97
     }
 
     @@mode_codes ||= {
@@ -39,6 +39,28 @@ module Colorize
       overlined:        53
     }
 
+    #
+    # Property for readline support
+    #
+    def enable_readline_support(value = nil)
+      if value.nil?
+        if defined?(@@readline_support)
+          @@readline_support || false
+        else
+          false
+        end
+      else
+        @@readline_support = (value || false)
+      end
+    end
+
+    #
+    # Setter for enable readline support
+    #
+    def enable_readline_support=(value)
+      @@readline_support = (value || false)
+    end
+
     #
     # Property for disable colorization
     #

data/lib/colorize/instance_methods.rb

@@ -24,7 +24,7 @@ module Colorize
       scan_for_colors.inject(self.class.new) do |str, match|
         colors_from_params(match, params)
         defaults_colors(match)
-        str << "\001\033[#{match[0]};#{match[1]};#{match[2]}m\002#{match[3]}\001\033[0m\002"
+        str << colorized_string(match[0], match[1], match[2], match[3])
       end
     end
 
@@ -48,6 +48,17 @@ module Colorize
 
     private
 
+    #
+    # Generate string with escape colors
+    #
+    def colorized_string(mode, color, background_color, previous)
+      if self.class.enable_readline_support
+        "\001\033[#{mode};#{color};#{background_color}m\002#{previous}\001\033[0m\002"
+      else
+        "\033[#{mode};#{color};#{background_color}m#{previous}\033[0m"
+      end
+    end
+
     #
     # Set default colors
     #
@@ -114,11 +125,22 @@ module Colorize
       self.class.mode_codes[mode]
     end
 
+    #
+    # Generate regex for color scanner
+    #
+    def scan_for_colors_regex
+      if self.class.enable_readline_support
+        /\001?\033\[([0-9;]+)m\002?(.+?)\001?\033\[0m\002?|([^\001\033]+)/m
+      else
+        /\033\[([0-9;]+)m(.+?)\033\[0m|([^\033]+)/m
+      end
+    end
+
     #
     # Scan for colorized string
     #
     def scan_for_colors
-      scan(/\001?\033\[([0-9;]+)m\002?(.+?)\001?\033\[0m\002?|([^\001\033]+)/m).map do |match|
+      scan(scan_for_colors_regex).map do |match|
         split_colors(match)
       end
     end

data/lib/colorize/version.rb

@@ -4,5 +4,5 @@
 # Gem version
 #
 module Colorize
-  VERSION = '1.0.3'
+  VERSION = '1.1.0'
 end

data/test/test_colorize.rb

@@ -5,51 +5,51 @@ require "#{File.dirname(__FILE__)}/../lib/colorize"
 
 class TestColorize < Minitest::Test
   def test_blue_symbol
-    assert_equal "\001\033[0;34;49m\002This is blue\001\033[0m\002", 'This is blue'.colorize(:blue)
+    assert_equal "\033[0;34;49mThis is blue\033[0m", 'This is blue'.colorize(:blue)
   end
 
   def test_incorrect_symbol
-    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002",  'This is incorrect color'.colorize(:bold)
+    assert_equal "\033[0;39;49mThis is incorrect color\033[0m",  'This is incorrect color'.colorize(:bold)
   end
 
   def test_incorrect_hash
-    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", 'This is incorrect color'.colorize(:color => :bold)
+    assert_equal "\033[0;39;49mThis is incorrect color\033[0m", 'This is incorrect color'.colorize(:color => :bold)
 
-    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", 'This is incorrect color'.colorize(:mode => :green)
+    assert_equal "\033[0;39;49mThis is incorrect color\033[0m", 'This is incorrect color'.colorize(:mode => :green)
 
-    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", 'This is incorrect color'.colorize(:background => :bold)
+    assert_equal "\033[0;39;49mThis is incorrect color\033[0m", 'This is incorrect color'.colorize(:background => :bold)
   end
 
   def test_blue_hash
-    assert_equal "\001\033[0;34;49m\002This is also blue?\001\033[0m\002", 'This is also blue?'.colorize(:color => :blue)
+    assert_equal "\033[0;34;49mThis is also blue?\033[0m", 'This is also blue?'.colorize(:color => :blue)
   end
 
   def test_light_blue_symbol
-    assert_equal "\001\033[0;94;49m\002This is light blue\001\033[0m\002", 'This is light blue'.colorize(:light_blue)
+    assert_equal "\033[0;94;49mThis is light blue\033[0m", 'This is light blue'.colorize(:light_blue)
   end
 
   def test_light_blue_with_red_background_hash
-    assert_equal "\001\033[0;94;41m\002This is light blue with red background\001\033[0m\002", 'This is light blue with red background'.colorize(:color => :light_blue, :background => :red)
+    assert_equal "\033[0;94;41mThis is light blue with red background\033[0m", 'This is light blue with red background'.colorize(:color => :light_blue, :background => :red)
   end
 
   def test_light_blue_with_red_background_symbol_and_hash
-    assert_equal "\001\033[0;94;41m\002This is light blue with red background\001\033[0m\002", 'This is light blue with red background'.colorize(:light_blue).colorize(:background => :red)
+    assert_equal "\033[0;94;41mThis is light blue with red background\033[0m", 'This is light blue with red background'.colorize(:light_blue).colorize(:background => :red)
   end
 
   def test_blue_with_red_background_method
-    assert_equal "\001\033[0;34;41m\002This is blue text on red\001\033[0m\002", 'This is blue text on red'.blue.on_red
+    assert_equal "\033[0;34;41mThis is blue text on red\033[0m", 'This is blue text on red'.blue.on_red
   end
 
   def test_red_with_blue_background_symbol_and_method
-    assert_equal "\001\033[0;31;44m\002This is red on blue\001\033[0m\002", 'This is red on blue'.colorize(:red).on_blue
+    assert_equal "\033[0;31;44mThis is red on blue\033[0m", 'This is red on blue'.colorize(:red).on_blue
   end
 
   def test_red_with_blue_background_and_underline_symbol_and_methods
-    assert_equal "\001\033[4;31;44m\002This is red on blue and underline\001\033[0m\002", 'This is red on blue and underline'.colorize(:red).on_blue.underline
+    assert_equal "\033[4;31;44mThis is red on blue and underline\033[0m", 'This is red on blue and underline'.colorize(:red).on_blue.underline
   end
 
   def test_blue_with_red_background_and_blink_methods
-    assert_equal "\001\033[5;34;41m\002This is blue text on red\001\033[0m\002", 'This is blue text on red'.blue.on_red.blink
+    assert_equal "\033[5;34;41mThis is blue text on red\033[0m", 'This is blue text on red'.blue.on_red.blink
   end
 
   def test_uncolorize
@@ -68,7 +68,7 @@ class TestColorize < Minitest::Test
   end
 
   def test_concatenated_strings_on_green
-    assert_equal "\001\033[0;39;42m\002none \001\033[0m\002\001\033[0;31;42m\002red\001\033[0m\002\001\033[0;39;42m\002 none \001\033[0m\002\001\033[0;34;42m\002blue\001\033[0m\002\001\033[0;39;42m\002 none\001\033[0m\002", "none #{'red'.red} none #{'blue'.blue} none".on_green
+    assert_equal "\033[0;39;42mnone \033[0m\033[0;31;42mred\033[0m\033[0;39;42m none \033[0m\033[0;34;42mblue\033[0m\033[0;39;42m none\033[0m", "none #{'red'.red} none #{'blue'.blue} none".on_green
   end
 
   def test_concatenated_strings_uncolorize
@@ -76,7 +76,7 @@ class TestColorize < Minitest::Test
   end
 
   def test_new_line
-    assert_equal "\001\033[5;34;41m\002This is blue\ntext on red\001\033[0m\002", "This is blue\ntext on red".blue.on_red.blink
+    assert_equal "\033[5;34;41mThis is blue\ntext on red\033[0m", "This is blue\ntext on red".blue.on_red.blink
   end
 
   def test_disable_colorization_with_=
@@ -104,11 +104,11 @@ class TestColorize < Minitest::Test
 
     String.disable_colorization = false
 
-    assert_equal "\001\033[0;34;49m\002This is blue after enabling\001\033[0m\002", 'This is blue after enabling'.colorize(:blue)
+    assert_equal "\033[0;34;49mThis is blue after enabling\033[0m", 'This is blue after enabling'.colorize(:blue)
   end
 
   def test_string_disable_colorization_with_method
-    assert_equal "\001\033[0;34;49m\002This is blue before disabling\001\033[0m\002", 'This is blue before disabling'.colorize(:blue)
+    assert_equal "\033[0;34;49mThis is blue before disabling\033[0m", 'This is blue before disabling'.colorize(:blue)
 
     String.disable_colorization true
 
@@ -118,11 +118,11 @@ class TestColorize < Minitest::Test
 
     String.disable_colorization false
 
-    assert_equal "\001\033[0;34;49m\002This is blue after enabling\001\033[0m\002", 'This is blue after enabling'.colorize(:blue)
+    assert_equal "\033[0;34;49mThis is blue after enabling\033[0m", 'This is blue after enabling'.colorize(:blue)
   end
 
   def test_already_colored_string_with_one_value
-    assert_equal 'This is red'.red, "\001\033[31m\002This is red\001\033[0m\002".red
+    assert_equal 'This is red'.red, "\033[31mThis is red\033[0m".red
   end
 
   def test_color_matrix_method

data/test/test_colorized_string.rb

@@ -9,51 +9,51 @@ class TestColorizedString < Minitest::Test
   end
 
   def test_blue_symbol
-    assert_equal "\001\033[0;34;49m\002This is blue\001\033[0m\002", ColorizedString['This is blue'].colorize(:blue)
+    assert_equal "\033[0;34;49mThis is blue\033[0m", ColorizedString['This is blue'].colorize(:blue)
   end
 
   def test_incorrect_symbol
-    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", ColorizedString['This is incorrect color'].colorize(:bold)
+    assert_equal "\033[0;39;49mThis is incorrect color\033[0m", ColorizedString['This is incorrect color'].colorize(:bold)
   end
 
   def test_incorrect_hash
-    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", ColorizedString['This is incorrect color'].colorize(:color => :bold)
+    assert_equal "\033[0;39;49mThis is incorrect color\033[0m", ColorizedString['This is incorrect color'].colorize(:color => :bold)
 
-    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", ColorizedString['This is incorrect color'].colorize(:mode => :green)
+    assert_equal "\033[0;39;49mThis is incorrect color\033[0m", ColorizedString['This is incorrect color'].colorize(:mode => :green)
 
-    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", ColorizedString['This is incorrect color'].colorize(:background => :bold)
+    assert_equal "\033[0;39;49mThis is incorrect color\033[0m", ColorizedString['This is incorrect color'].colorize(:background => :bold)
   end
 
   def test_blue_hash
-    assert_equal "\001\033[0;34;49m\002This is also blue\001\033[0m\002", ColorizedString['This is also blue'].colorize(:color => :blue)
+    assert_equal "\033[0;34;49mThis is also blue\033[0m", ColorizedString['This is also blue'].colorize(:color => :blue)
   end
 
   def test_light_blue_symbol
-    assert_equal "\001\033[0;94;49m\002This is light blue\001\033[0m\002", ColorizedString['This is light blue'].colorize(:light_blue)
+    assert_equal "\033[0;94;49mThis is light blue\033[0m", ColorizedString['This is light blue'].colorize(:light_blue)
   end
 
   def test_light_blue_with_red_background_hash
-    assert_equal "\001\033[0;94;41m\002This is light blue with red background\001\033[0m\002", ColorizedString['This is light blue with red background'].colorize(:color => :light_blue, :background => :red)
+    assert_equal "\033[0;94;41mThis is light blue with red background\033[0m", ColorizedString['This is light blue with red background'].colorize(:color => :light_blue, :background => :red)
   end
 
   def test_light_blue_with_red_background_symbol_and_hash
-    assert_equal "\001\033[0;94;41m\002This is light blue with red background\001\033[0m\002", ColorizedString['This is light blue with red background'].colorize(:light_blue).colorize(:background => :red)
+    assert_equal "\033[0;94;41mThis is light blue with red background\033[0m", ColorizedString['This is light blue with red background'].colorize(:light_blue).colorize(:background => :red)
   end
 
   def test_blue_with_red_background_method
-    assert_equal "\001\033[0;34;41m\002This is blue text on red\001\033[0m\002", ColorizedString['This is blue text on red'].blue.on_red
+    assert_equal "\033[0;34;41mThis is blue text on red\033[0m", ColorizedString['This is blue text on red'].blue.on_red
   end
 
   def test_red_with_blue_background_symbol_and_method
-    assert_equal "\001\033[0;31;44m\002This is red on blue\001\033[0m\002", ColorizedString['This is red on blue'].colorize(:red).on_blue
+    assert_equal "\033[0;31;44mThis is red on blue\033[0m", ColorizedString['This is red on blue'].colorize(:red).on_blue
   end
 
   def test_red_with_blue_background_and_underline_sumbol_and_methods
-    assert_equal "\001\033[4;31;44m\002This is red on blue and underline\001\033[0m\002", ColorizedString['This is red on blue and underline'].colorize(:red).on_blue.underline
+    assert_equal "\033[4;31;44mThis is red on blue and underline\033[0m", ColorizedString['This is red on blue and underline'].colorize(:red).on_blue.underline
   end
 
   def test_blue_with_red_background_and_blink_methods
-    assert_equal "\001\033[5;34;41m\002This is blue text on red\001\033[0m\002", ColorizedString['This is blue text on red'].blue.on_red.blink
+    assert_equal "\033[5;34;41mThis is blue text on red\033[0m", ColorizedString['This is blue text on red'].blue.on_red.blink
   end
 
   def test_uncolorize
@@ -72,7 +72,7 @@ class TestColorizedString < Minitest::Test
   end
 
   def test_concatenated_strings_on_green
-    assert_equal "\001\033[0;39;42m\002none \001\033[0m\002\001\033[0;31;42m\002red\001\033[0m\002\001\033[0;39;42m\002 none \001\033[0m\002\001\033[0;34;42m\002blue\001\033[0m\002\001\033[0;39;42m\002 none\001\033[0m\002", ColorizedString["none #{ColorizedString['red'].red} none #{ColorizedString['blue'].blue} none"].on_green
+    assert_equal "\033[0;39;42mnone \033[0m\033[0;31;42mred\033[0m\033[0;39;42m none \033[0m\033[0;34;42mblue\033[0m\033[0;39;42m none\033[0m", ColorizedString["none #{ColorizedString['red'].red} none #{ColorizedString['blue'].blue} none"].on_green
   end
 
   def test_concatenated_strings_uncolorize
@@ -80,11 +80,11 @@ class TestColorizedString < Minitest::Test
   end
 
   def test_frozen_strings
-    assert_equal "\001\033[5;34;41m\002This is blue text on red\001\033[0m\002", ColorizedString['This is blue text on red'].freeze.blue.on_red.blink
+    assert_equal "\033[5;34;41mThis is blue text on red\033[0m", ColorizedString['This is blue text on red'].freeze.blue.on_red.blink
   end
 
   def test_new_line
-    assert_equal "\001\033[5;34;41m\002This is blue\ntext on red\001\033[0m\002", ColorizedString["This is blue\ntext on red"].freeze.blue.on_red.blink
+    assert_equal "\033[5;34;41mThis is blue\ntext on red\033[0m", ColorizedString["This is blue\ntext on red"].freeze.blue.on_red.blink
   end
 
   def test_disable_colorization_with_=
@@ -112,11 +112,11 @@ class TestColorizedString < Minitest::Test
 
     ColorizedString.disable_colorization = false
 
-    assert_equal "\001\033[0;34;49m\002This is blue after enabling\001\033[0m\002", ColorizedString['This is blue after enabling'].colorize(:blue)
+    assert_equal "\033[0;34;49mThis is blue after enabling\033[0m", ColorizedString['This is blue after enabling'].colorize(:blue)
   end
 
   def test_string_disable_colorization_with_method
-    assert_equal "\001\033[0;34;49m\002This is blue before disabling\001\033[0m\002", ColorizedString['This is blue before disabling'].colorize(:blue)
+    assert_equal "\033[0;34;49mThis is blue before disabling\033[0m", ColorizedString['This is blue before disabling'].colorize(:blue)
 
     ColorizedString.disable_colorization true
 
@@ -126,11 +126,11 @@ class TestColorizedString < Minitest::Test
 
     ColorizedString.disable_colorization false
 
-    assert_equal "\001\033[0;34;49m\002This is blue after enabling\001\033[0m\002", ColorizedString['This is blue after enabling'].colorize(:blue)
+    assert_equal "\033[0;34;49mThis is blue after enabling\033[0m", ColorizedString['This is blue after enabling'].colorize(:blue)
   end
 
   def test_already_colored_string_with_one_value
-    assert_equal ColorizedString['This is red'].red, ColorizedString["\001\033[31m\002This is red\001\033[0m\002"].red
+    assert_equal ColorizedString['This is red'].red, ColorizedString["\033[31mThis is red\033[0m"].red
   end
 
   def test_color_matrix_method

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colorize
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Michał Kalbarczyk
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-21 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies: []
 description: Extends String class or add a ColorizedString with methods to set text
   color, background color and text effects.