colorize 0.8.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f9aa60a1408f5b8cf800bd6d48d0778d6306fdd
-  data.tar.gz: f08adfa6e15d4bc0eb1f553451d96ecf69070c11
+SHA256:
+  metadata.gz: 2440a0c4dffad361b76dc139b086a986c0cb4eb04c510e37f39cb33f86aa6448
+  data.tar.gz: c5c8b4df8f4a4fe62b6205205dad479e40e61d6134d38ff156dcd48cdadf7402
 SHA512:
-  metadata.gz: 2d49b0c6362a92b525c7d1fdb0209f6fbfdfc61f720190d75f5ceef96338faa98358ce70e94bfe0a7a86f33f6036ae19e6ca9ce29dbbcfd59b3e2a3ee52d8a72
-  data.tar.gz: 674694aef0a11430782f9d888b0b39a3365a8730144d0be759151977fd3b30b2a6c2041d8699438d2fbbfe5db57733bc4a018f6a6344a1f3a4cd590d47bf274c
+  metadata.gz: 498e222fe9f170791b493d6367c613f7c7eeff98b14ca5726e7741fe783af2433683d79115bf6b74ff0ec956fbb2cf4ca900976dd406f451da795ebc0f778340
+  data.tar.gz: d6b023053c3130ecab27e494c54fbd2da2b8f0756c26931a03b4c74d6f68285bbd61281e38c95c72467126835f4a0382e689705e1dcca94615f7d8450c1e6b07

data/CHANGELOG.md

@@ -0,0 +1,76 @@
+# Changelog
+
+## 1.0.0 / 2023-03-23
+  - add more modes
+  - add aliases
+  - grey and gray default aliases
+  - update dependencies
+  - add non-visible text delimiters
+  - add prevent_color switch
+  - cleanup and refactor
+
+## 0.8.1 / 2016-06-29
+  - fix gemspec bug
+
+## 0.8.0 / 2016-06-27
+	- add ColorizedString class
+	- update README file
+	- add rubocop.yml and follow style
+  - add italic mode
+  - remove interpreter warrnings
+
+## 0.7.7 / 2015-04-19
+  - update gems
+
+## 0.7.6 / 2015-04-18
+  - fix bugs
+
+## 0.7.5 / 2014-12-11
+  - big code refactoring
+  - disable_colorization feature added
+
+## 0.7.4 / 2014-12-10
+  - code cleanups
+
+## 0.7.3 / 2014-05-19
+  - fix new line maching
+
+## 0.7.2 / 2014-04-08
+  - tests cleanups
+  - gem release date fixed
+
+## 0.7.1 / 2014-04-02
+  - handling wrong color values
+
+## 0.7.0 / 2014-03-12
+  - refactored to use regexp pattern matching
+  - works with frozen strings
+  - works with concatenated string
+
+## 0.6.0 / 2013-09-25
+  - code cleanups
+  - bold mode fixed
+  - STDOUT.isatty condition removed
+  - doc updated
+  - jeweler tasks removed
+  - Rakefile updated
+
+## 0.5.8 / 2009-12-02
+  - code cleanups
+  - removed 'ruby -w' warnings
+
+## 0.5.7 / 2009-11-24
+  - moved to github/gemcutter
+  - 1.9 compatible
+
+## 0.5.6 / 2007-08-27
+  - rdocs Allison template
+  - cleanups
+
+## 0.5.5 / 2007-08-11
+  - added effects methods
+  - README files
+  - new rake file
+
+## 0.5.0 / 2007-04-22
+  - initial rewritten version

data/README.md

@@ -1,8 +1,8 @@
-colorize [![Gem Version](https://badge.fury.io/rb/colorize.svg)](http://badge.fury.io/rb/colorize) [![Build Status](https://travis-ci.org/fazibear/colorize.svg?branch=master)](https://travis-ci.org/fazibear/colorize) [![Code Climate](https://codeclimate.com/github/fazibear/colorize/badges/gpa.svg)](https://codeclimate.com/github/fazibear/colorize) [![Test Coverage](https://codeclimate.com/github/fazibear/colorize/badges/coverage.svg)](https://codeclimate.com/github/fazibear/colorize)
+colorize [![Gem Version](https://badge.fury.io/rb/colorize.svg)](http://badge.fury.io/rb/colorize) [![Ruby Gem](https://github.com/fazibear/colorize/actions/workflows/release.yml/badge.svg)](https://github.com/fazibear/colorize/actions/workflows/release.yml) [![Code Climate](https://codeclimate.com/github/fazibear/colorize/badges/gpa.svg)](https://codeclimate.com/github/fazibear/colorize) [![Test Coverage](https://codeclimate.com/github/fazibear/colorize/badges/coverage.svg)](https://codeclimate.com/github/fazibear/colorize)
 ========
 
 Ruby gem for colorizing text using ANSI escape sequences.
-Extends `String` class or add a `ColorizedString` with methods to set text color, background color and text effects.
+Extends `String` class or add a `ColorizedString` with methods to set the text color, background color and text effects.
 
 modes
 -----
@@ -16,8 +16,10 @@ features
 * change string color
 * change string background
 * change string effect
+* chain methods
 * display color samples
 * disable colorization
+* prevent colors
 
 usage
 -----
@@ -29,20 +31,40 @@ String.colors                       # return array of all possible colors names
 String.modes                        # return array of all possible modes
 String.color_samples                # displays color samples in all combinations
 String.disable_colorization         # check if colorization is disabled
+
+# disable colorization (false by default)
+
 String.disable_colorization = false # enable colorization
 String.disable_colorization false   # enable colorization
 String.disable_colorization = true  # disable colorization
 String.disable_colorization true    # disable colorization
 
+# prevent colors (false by default)
+
+String.prevent_colors = false # override current string colors
+String.prevent_colors false   # override current string colors
+String.prevent_colors = true  # don't colorize colorized strings
+String.prevent_colors true    # don't colorize colorized strings
+
+# adding aliases (:gray and :grey added by default)
+
+String.add_color_alias(:niebieski, :blue)
+String.add_color_alias(:zielony => :green) 
+String.add_color_alias(czarny: :black)
+String.add_color_alias(czerwony: :red, granatowy: :blue)
+
+# examaples
+
 puts "This is blue".colorize(:blue)
 puts "This is light blue".colorize(:light_blue)
 puts "This is also blue".colorize(:color => :blue)
+puts "This is bold green".colorize(:color => :green, :mode => :bold)
 puts "This is light blue with red background".colorize(:color => :light_blue, :background => :red)
 puts "This is light blue with red background".colorize(:light_blue ).colorize( :background => :red)
 puts "This is blue text on red".blue.on_red
 puts "This is red on blue".colorize(:red).on_blue
 puts "This is red on blue and underline".colorize(:red).on_blue.underline
-puts "This is blue text on red".blue.on_red.blink
+puts "This is blinking blue text on red".blue.on_red.blink
 puts "This is uncolorized".blue.on_red.uncolorize
 ```
 
@@ -53,20 +75,40 @@ ColorizedString.colors                       # return array of all possible colo
 ColorizedString.modes                        # return array of all possible modes
 ColorizedString.color_samples                # displays color samples in all combinations
 ColorizedString.disable_colorization         # check if colorization is disabled
+
+# disable colorization (false by default)
+
 ColorizedString.disable_colorization = false # enable colorization
 ColorizedString.disable_colorization false   # enable colorization
 ColorizedString.disable_colorization = true  # disable colorization
 ColorizedString.disable_colorization true    # disable colorization
 
+# prevent colors (false by default)
+
+ColorizedString.prevent_colors = false # override current string colors
+ColorizedString.prevent_colors false   # override current string colors
+ColorizedString.prevent_colors = true  # don't colorize colorized strings
+ColorizedString.prevent_colors true    # don't colorize colorized strings
+
+# adding aliases (:gray and :grey added by default)
+
+ColorizedString.add_color_alias(:niebieski, :blue)
+ColorizedString.add_color_alias(:zielony => :green) 
+ColorizedString.add_color_alias(czarny: :black)
+ColorizedString.add_color_alias(czerwony: :red, granatowy: :blue)
+
+# examples
+
 puts ColorizedString["This is blue"].colorize(:blue)
 puts ColorizedString["This is light blue"].colorize(:light_blue)
 puts ColorizedString["This is also blue"].colorize(:color => :blue)
+puts ColorizedString["This is bold green"].colorize(:color => :green, :mode => :bold)
 puts ColorizedString["This is light blue with red background"].colorize(:color => :light_blue, :background => :red)
 puts ColorizedString["This is light blue with red background"].colorize(:light_blue ).colorize( :background => :red)
 puts ColorizedString["This is blue text on red"].blue.on_red
 puts ColorizedString["This is red on blue"].colorize(:red).on_blue
 puts ColorizedString["This is red on blue and underline"].colorize(:red).on_blue.underline
-puts ColorizedString["This is blue text on red"].blue.on_red.blink
+puts ColorizedString["This is blinking blue text on red"].blue.on_red.blink
 puts ColorizedString["This is uncolorized"].blue.on_red.uncolorize
 
 puts ColorizedString.new("This is blue").blue
@@ -85,6 +127,11 @@ install
 
 *Note:* You may need to use sudo to install gems
 
+thank you
+---------
+
+[![Become Patreon](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/bePatron?u=6912974)
+
 license
 -------
 

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|

data/colorize.gemspec

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
+require File.expand_path('lib/colorize/version', File.dirname(__FILE__))
+
 Gem::Specification.new do |s|
   s.name = 'colorize'
-  s.version = '0.8.1'
+  s.version = Colorize::VERSION
+  s.required_ruby_version = '>= 2.6'
 
   s.authors = ['Michał Kalbarczyk']
   s.email = 'fazibear@gmail.com'
 
-  s.date = Time.now.strftime('%Y-%m-%d')
-
   s.homepage = 'http://github.com/fazibear/colorize'
   s.description = 'Extends String class or add a ColorizedString with methods to set text color, background color and text effects.'
   s.summary = 'Ruby gem for colorizing text using ANSI escape sequences.'
@@ -14,23 +17,21 @@ Gem::Specification.new do |s|
 
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'rake', '~> 10.0'
-  s.add_development_dependency 'minitest', '~> 5.0'
-  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
-
   s.files = [
     'LICENSE',
-    'CHANGELOG',
+    'CHANGELOG.md',
     'README.md',
     'Rakefile',
     'colorize.gemspec',
     'lib/colorize.rb',
     'lib/colorized_string.rb',
+    'lib/colorize/errors.rb',
     'lib/colorize/class_methods.rb',
     'lib/colorize/instance_methods.rb',
+    'lib/colorize/version.rb',
     'test/test_colorize.rb',
+    'test/test_colorized_string.rb',
   ]
-  s.test_files = [
-    'test/test_colorize.rb'
-  ]
+
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/colorize/class_methods.rb

@@ -1,17 +1,56 @@
+# frozen_string_literal: true
+
 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
+    }
+
+    @@mode_codes ||= {
+      default:          0, # Turn off all attributes
+      bold:             1,
+      dim:              2,
+      italic:           3,
+      underline:        4,
+      blink:            5,
+      blink_slow:       5,
+      blink_fast:       6,
+      invert:           7,
+      hide:             8,
+      strike:           9,
+      double_underline: 20,
+      reveal:           28,
+      overlined:        53
+    }
+
     #
-    # Property to disable colorization
+    # Property for disable colorization
     #
     def disable_colorization(value = nil)
       if value.nil?
-        if defined?(@disable_colorization)
-          @disable_colorization || false
+        if defined?(@@disable_colorization)
+          @@disable_colorization || false
         else
           false
         end
       else
-        @disable_colorization = (value || false)
+        @@disable_colorization = (value || false)
       end
     end
 
@@ -19,7 +58,29 @@ module Colorize
     # Setter for disable colorization
     #
     def disable_colorization=(value)
-      @disable_colorization = (value || false)
+      @@disable_colorization = (value || false)
+    end
+
+    #
+    # Property for prevent recolorization
+    #
+    def prevent_colors(value = nil)
+      if value.nil?
+        if defined?(@@prevent_colors)
+          @@prevent_colors || false
+        else
+          false
+        end
+      else
+        @@prevent_colors = (value || false)
+      end
+    end
+
+    #
+    # Setter for prevent recolorization
+    #
+    def prevent_colors=(value)
+      @@prevent_colors = (value || false)
     end
 
     #
@@ -47,10 +108,16 @@ module Colorize
     end
 
     #
-    # Method removed, raise NoMethodError
+    # Add color alias
     #
-    def color_matrix(_ = '')
-      fail NoMethodError, '#color_matrix method was removed, try #color_samples instead'
+    def add_color_alias(*params)
+      parse_color_alias_params(params).each do |_alias_, _color_|
+        check_if_color_available!(_alias_)
+        check_if_color_exist!(_color_)
+
+        add_color_code(_alias_, color_codes[_color_])
+        add_color_method(_alias_)
+      end
     end
 
     # private
@@ -59,32 +126,18 @@ module Colorize
     # Color codes hash
     #
     def color_codes
-      {
-        :black   => 0, :light_black    => 60,
-        :red     => 1, :light_red      => 61,
-        :green   => 2, :light_green    => 62,
-        :yellow  => 3, :light_yellow   => 63,
-        :blue    => 4, :light_blue     => 64,
-        :magenta => 5, :light_magenta  => 65,
-        :cyan    => 6, :light_cyan     => 66,
-        :white   => 7, :light_white    => 67,
-        :default => 9
-      }
+      @@color_codes
+    end
+
+    def add_color_code(code, color)
+      @@color_codes[code] = color
     end
 
     #
     # Mode codes hash
     #
     def mode_codes
-      {
-        :default   => 0, # Turn off all attributes
-        :bold      => 1, # Set bold mode
-        :italic    => 3, # Set italic mode
-        :underline => 4, # Set underline mode
-        :blink     => 5, # Set blink mode
-        :swap      => 7, # Exchange foreground and background colors
-        :hide      => 8  # Hide text (foreground color would be the same as background)
-      }
+      @@mode_codes
     end
 
     #
@@ -94,13 +147,20 @@ module Colorize
       colors.each do |key|
         next if key == :default
 
-        define_method key do
-          colorize(:color => key)
-        end
+        add_color_method(key)
+      end
+    end
 
-        define_method "on_#{key}" do
-          colorize(:background => key)
-        end
+    #
+    # Generate color and on_color method
+    #
+    def add_color_method(key)
+      define_method key do
+        colorize(:color => key)
+      end
+
+      define_method "on_#{key}" do
+        colorize(:background => key)
       end
     end
 
@@ -116,5 +176,28 @@ module Colorize
         end
       end
     end
+
+    def parse_color_alias_params(params)
+      return [params] if params.is_a?(Array) && params.length == 2
+
+      params.flat_map do |param|
+        next param if param.is_a?(Array) && param.length == 2
+        next param.to_a if param.is_a?(Hash)
+      end
+    end
+
+    #
+    # Check if color exists
+    #
+    def check_if_color_available!(color)
+      color_codes[color] && fail(::Colorize::ColorAlreadyExist, "Colorize: color named :#{color} already exist!")
+    end
+
+    #
+    # Check if color is missing
+    #
+    def check_if_color_exist!(color)
+      color_codes[color] || fail(::Colorize::ColorDontExist, "Colorize: color :#{color} don't exist!")
+    end
   end
 end

data/lib/colorize/errors.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Colorize
+  class ColorAlreadyExist < StandardError
+  end
+
+  class ColorDontExist < StandardError
+  end
+end

data/lib/colorize/instance_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Colorize
   module InstanceMethods
     #
@@ -18,11 +20,11 @@ module Colorize
     #
     def colorize(params)
       return self if self.class.disable_colorization
-      require_windows_libs
+
       scan_for_colors.inject(self.class.new) do |str, match|
         colors_from_params(match, params)
         defaults_colors(match)
-        str << "\033[#{match[0]};#{match[1]};#{match[2]}m#{match[3]}\033[0m"
+        str << "\001\033[#{match[0]};#{match[1]};#{match[2]}m\002#{match[3]}\001\033[0m\002"
       end
     end
 
@@ -69,30 +71,40 @@ module Colorize
     # Set colors from params hash
     #
     def colors_from_hash(match, hash)
-      match[0] = mode(hash[:mode])                   if mode(hash[:mode])
-      match[1] = color(hash[:color])                 if color(hash[:color])
-      match[2] = background_color(hash[:background]) if background_color(hash[:background])
+      if self.class.prevent_colors
+        match[0] ||= mode(hash[:mode])                   if mode(hash[:mode])
+        match[1] ||= color(hash[:color])                 if color(hash[:color])
+        match[2] ||= background_color(hash[:background]) if background_color(hash[:background])
+      else
+        match[0] = mode(hash[:mode])                   if mode(hash[:mode])
+        match[1] = color(hash[:color])                 if color(hash[:color])
+        match[2] = background_color(hash[:background]) if background_color(hash[:background])
+      end
     end
 
     #
     # Set color from params symbol
     #
     def color_from_symbol(match, symbol)
-      match[1] = color(symbol) if color(symbol)
+      if self.class.prevent_colors && color(symbol)
+        match[1] ||= color(symbol)
+      else
+        match[1] = color(symbol)
+      end
     end
 
     #
-    # Color for foreground (offset 30)
+    # Color for foreground
     #
     def color(color)
-      self.class.color_codes[color] + 30 if self.class.color_codes[color]
+      self.class.color_codes[color]
     end
 
     #
-    # Color for background (offset 40)
+    # Color for background (offset 10)
     #
     def background_color(color)
-      self.class.color_codes[color] + 40 if self.class.color_codes[color]
+      self.class.color_codes[color] + 10 if self.class.color_codes[color]
     end
 
     #
@@ -106,7 +118,7 @@ module Colorize
     # Scan for colorized string
     #
     def scan_for_colors
-      scan(/\033\[([0-9;]+)m(.+?)\033\[0m|([^\033]+)/m).map do |match|
+      scan(/\001?\033\[([0-9;]+)m\002?(.+?)\001?\033\[0m\002?|([^\001?\033]+)/m).map do |match|
         split_colors(match)
       end
     end
@@ -124,7 +136,7 @@ module Colorize
     # Require windows libs
     #
     def require_windows_libs
-      require 'Win32/Console/ANSI' if RUBY_VERSION < '2.0.0' && RUBY_PLATFORM =~ /win32/
+      require 'Win32/Console/ANSI' if RUBY_VERSION < '2.0.0' && RUBY_PLATFORM.include?('win32')
     rescue LoadError
       raise 'You must gem install win32console to use colorize on Windows'
     end

data/lib/colorize/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+#
+# Gem version
+#
+module Colorize
+  VERSION = '1.0.1'
+end

data/lib/colorize.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
+require File.expand_path('colorize/version', File.dirname(__FILE__))
+require File.expand_path('colorize/errors', File.dirname(__FILE__))
 require File.expand_path('colorize/class_methods', File.dirname(__FILE__))
 require File.expand_path('colorize/instance_methods', File.dirname(__FILE__))
+
 #
 # String class extension.
 #
@@ -9,4 +14,7 @@ class String
 
   color_methods
   modes_methods
+
+  add_color_alias(:grey, :light_black)
+  add_color_alias(:gray, :light_black)
 end

data/lib/colorized_string.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require File.expand_path('colorize/errors', File.dirname(__FILE__))
 require File.expand_path('colorize/class_methods', File.dirname(__FILE__))
 require File.expand_path('colorize/instance_methods', File.dirname(__FILE__))
 #
@@ -10,8 +13,11 @@ class ColorizedString < String
   color_methods
   modes_methods
 
+  add_color_alias(:grey, :light_black)
+  add_color_alias(:gray, :light_black)
+
   #
-  # Sortcut to create ColorizedString with ColorizedString['test'].
+  # Shortcut to create ColorizedString with ColorizedString['test'].
   #
   def self.[](string)
     ColorizedString.new(string)

data/test/test_colorize.rb

@@ -1,153 +1,128 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+# frozen_string_literal: true
 
 require 'minitest/autorun'
-require File.dirname(__FILE__) + '/../lib/colorize'
+require "#{File.dirname(__FILE__)}/../lib/colorize"
 
 class TestColorize < Minitest::Test
   def test_blue_symbol
-    assert_equal 'This is blue'.colorize(:blue),
-                 "\e[0;34;49mThis is blue\e[0m"
+    assert_equal "\001\033[0;34;49m\002This is blue\001\033[0m\002", 'This is blue'.colorize(:blue)
   end
 
   def test_incorrect_symbol
-    assert_equal 'This is incorrect color'.colorize(:bold),
-                 "\e[0;39;49mThis is incorrect color\e[0m"
+    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002",  'This is incorrect color'.colorize(:bold)
   end
 
   def test_incorrect_hash
-    assert_equal 'This is incorrect color'.colorize(:color => :bold),
-                 "\e[0;39;49mThis is incorrect color\e[0m"
+    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", 'This is incorrect color'.colorize(:color => :bold)
 
-    assert_equal 'This is incorrect color'.colorize(:mode => :green),
-                 "\e[0;39;49mThis is incorrect color\e[0m"
+    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", 'This is incorrect color'.colorize(:mode => :green)
 
-    assert_equal 'This is incorrect color'.colorize(:background => :bold),
-                 "\e[0;39;49mThis is incorrect color\e[0m"
+    assert_equal "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", 'This is incorrect color'.colorize(:background => :bold)
   end
 
   def test_blue_hash
-    assert_equal 'This is also blue'.colorize(:color => :blue),
-                 "\e[0;34;49mThis is also blue\e[0m"
+    assert_equal "\001\033[0;34;49m\002This is also blue\001\033[0m\002", 'This is also blue'.colorize(:color => :blue)
   end
 
   def test_light_blue_symbol
-    assert_equal 'This is light blue'.colorize(:light_blue),
-                 "\e[0;94;49mThis is light blue\e[0m"
+    assert_equal "\001\033[0;94;49m\002This is light blue\001\033[0m\002", 'This is light blue'.colorize(:light_blue)
   end
 
   def test_light_blue_with_red_background_hash
-    assert_equal 'This is light blue with red background'.colorize(:color => :light_blue, :background => :red),
-                 "\e[0;94;41mThis is light blue with red background\e[0m"
+    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)
   end
 
   def test_light_blue_with_red_background_symbol_and_hash
-    assert_equal 'This is light blue with red background'.colorize(:light_blue).colorize(:background => :red),
-                 "\e[0;94;41mThis is light blue with red background\e[0m"
+    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)
   end
 
   def test_blue_with_red_background_method
-    assert_equal 'This is blue text on red'.blue.on_red,
-                 "\e[0;34;41mThis is blue text on red\e[0m"
+    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
   end
 
   def test_red_with_blue_background_symbol_and_method
-    assert_equal 'This is red on blue'.colorize(:red).on_blue,
-                 "\e[0;31;44mThis is red on blue\e[0m"
+    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
   end
 
-  def test_red_with_blue_background_and_underline_sumbol_and_methods
-    assert_equal 'This is red on blue and underline'.colorize(:red).on_blue.underline,
-                 "\e[4;31;44mThis is red on blue and underline\e[0m"
+  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
   end
 
   def test_blue_with_red_background_and_blink_methods
-    assert_equal 'This is blue text on red'.blue.on_red.blink,
-                 "\e[5;34;41mThis is blue text on red\e[0m"
+    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
   end
 
   def test_uncolorize
-    assert_equal 'This is uncolorized'.blue.on_red.uncolorize,
-                 'This is uncolorized'
+    assert_equal 'This is uncolorized', 'This is uncolorized'.blue.on_red.uncolorize
   end
 
   def test_colorized?
-    assert_equal 'Red'.red.colorized?, true
-    assert_equal 'Blue'.colorized?, false
-    assert_equal 'Green'.blue.green.uncolorize.colorized?, false
+    assert_predicate 'Red'.red, :colorized?
+    refute_predicate 'Blue', :colorized?
+    refute_predicate 'Green'.blue.green.uncolorize, :colorized?
   end
 
   def test_concatenated__colorize?
-    assert_equal "none #{'red'.red} none #{'blue'.blue} none".colorized?, true
-    assert_equal "none #{'red'.red} none #{'blue'.blue} none".uncolorize.colorized?, false
+    assert_predicate "none #{'red'.red} none #{'blue'.blue} none", :colorized?
+    refute_predicate "none #{'red'.red} none #{'blue'.blue} none".uncolorize, :colorized?
   end
 
   def test_concatenated_strings_on_green
-    assert_equal "none #{'red'.red} none #{'blue'.blue} none".on_green,
-                 "\e[0;39;42mnone \e[0m\e[0;31;42mred\e[0m\e[0;39;42m none \e[0m\e[0;34;42mblue\e[0m\e[0;39;42m none\e[0m"
+    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
   end
 
   def test_concatenated_strings_uncolorize
-    assert_equal "none #{'red'.red} none #{'blue'.blue} none".uncolorize,
-                 'none red none blue none'
-  end
-
-  def test_frozen_strings
-    assert_equal 'This is blue text on red'.freeze.blue.on_red.blink,
-                 "\e[5;34;41mThis is blue text on red\e[0m"
+    assert_equal 'none red none blue none', "none #{'red'.red} none #{'blue'.blue} none".uncolorize
   end
 
   def test_new_line
-    assert_equal "This is blue\ntext on red".freeze.blue.on_red.blink,
-                 "\e[5;34;41mThis is blue\ntext on red\e[0m"
+    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
   end
 
   def test_disable_colorization_with_=
     String.disable_colorization = true
-    assert_equal String.disable_colorization, true
+
+    assert String.disable_colorization
+
     String.disable_colorization = false
   end
 
   def test_disable_colorization_with_method
     String.disable_colorization true
-    assert_equal String.disable_colorization, true
+
+    assert String.disable_colorization
+
     String.disable_colorization false
   end
 
   def test_string_disable_colorization_with_=
     String.disable_colorization = true
 
-    assert_equal String.disable_colorization, true
+    assert String.disable_colorization
 
-    assert_equal 'This is blue after disabling'.blue,
-                 'This is blue after disabling'
+    assert_equal 'This is blue after disabling', 'This is blue after disabling'.blue
 
     String.disable_colorization = false
 
-    assert_equal 'This is blue after enabling'.colorize(:blue),
-                 "\e[0;34;49mThis is blue after enabling\e[0m"
+    assert_equal "\001\033[0;34;49m\002This is blue after enabling\001\033[0m\002", 'This is blue after enabling'.colorize(:blue)
   end
 
   def test_string_disable_colorization_with_method
-    assert_equal 'This is blue before disabling'.colorize(:blue),
-                 "\e[0;34;49mThis is blue before disabling\e[0m"
+    assert_equal "\001\033[0;34;49m\002This is blue before disabling\001\033[0m\002", 'This is blue before disabling'.colorize(:blue)
 
     String.disable_colorization true
 
-    assert_equal String.disable_colorization, true
+    assert String.disable_colorization
 
-    assert_equal 'This is blue after disabling'.blue,
-                 'This is blue after disabling'
+    assert_equal 'This is blue after disabling', 'This is blue after disabling'.blue
 
     String.disable_colorization false
 
-    assert_equal 'This is blue after enabling'.colorize(:blue),
-                 "\e[0;34;49mThis is blue after enabling\e[0m"
+    assert_equal "\001\033[0;34;49m\002This is blue after enabling\001\033[0m\002", 'This is blue after enabling'.colorize(:blue)
   end
 
   def test_already_colored_string_with_one_value
-    assert_equal "\e[31mThis is red\e[0m".red,
-                 'This is red'.red
+    assert_equal 'This is red'.red, "\001\033[31m\002This is red\001\033[0m\002".red
   end
 
   def test_color_matrix_method
@@ -161,4 +136,79 @@ class TestColorize < Minitest::Test
       String.color_samples
     end
   end
+
+  def test_grey_alias
+    assert_equal 'This is grey'.grey, 'This is grey'.light_black
+  end
+
+  def test_gray_alias
+    assert_equal 'This is gray'.gray, 'This is gray'.light_black
+  end
+
+  def test_add_color_alias
+    String.add_color_alias(:extra_blue, :light_blue)
+
+    assert_equal 'blue'.light_blue, 'blue'.extra_blue
+    assert_equal 'blue'.on_light_blue, 'blue'.on_extra_blue
+  end
+
+  def test_add_color_alias_errors
+    String.add_color_alias(:extra_red, :light_red)
+
+    assert_raises ::Colorize::ColorAlreadyExist, 'Colorize: color :extra_red already exist!' do
+      String.add_color_alias(:extra_red, :light_blue)
+    end
+
+    assert_raises ::Colorize::ColorDontExist, 'Colorize: color :light_color don\'t exist!' do
+      String.add_color_alias(:extra_white, :light_color)
+    end
+  end
+
+  def test_add_color_alias_with_single_hash
+    String.add_color_alias(extra_green: :light_green)
+
+    assert_equal 'example string'.light_green, 'example string'.extra_green
+    assert_equal 'example string'.on_light_green, 'example string'.on_extra_green
+  end
+
+  def test_add_color_alias_with_single_hash_with_arrow
+    String.add_color_alias(:extra_color => :gray)
+
+    assert_equal 'example string'.gray, 'example string'.extra_color
+    assert_equal 'example string'.on_gray, 'example string'.on_extra_color
+  end
+
+  def test_add_color_alias_with_multi_hash
+    String.add_color_alias(extra_color_a: :gray, extra_color_b: :blue)
+
+    assert_equal 'example string'.gray, 'example string'.extra_color_a
+    assert_equal 'example string'.blue, 'example string'.extra_color_b
+  end
+
+  def test_add_color_alias_with_multi_hash_with_arrow
+    String.add_color_alias(:extra_color_c => :gray, :extra_color_d => :blue)
+
+    assert_equal 'example string'.gray, 'example string'.extra_color_c
+    assert_equal 'example string'.on_blue, 'example string'.on_extra_color_d
+  end
+
+  def test_add_color_alias_with_multi_hash_mixed
+    String.add_color_alias(extra_color_e: :gray, :extra_color_f => :blue)
+
+    assert_equal 'example string'.gray, 'example string'.extra_color_e
+    assert_equal 'example string'.on_blue, 'example string'.on_extra_color_f
+  end
+
+  def test_prevent_colors
+    String.prevent_colors true
+
+    assert String.prevent_colors
+    assert_equal "#{'blue'.blue}#{'red'.red}#{'green'.green}", "#{'blue'.blue}red#{'green'.green}".red
+
+    String.prevent_colors false
+  end
+
+  def test_colorized_string_without_readline
+    assert_equal "\e[0;31;49mgreen\e[0m".green, 'green'.green
+  end
 end

data/test/test_colorized_string.rb

@@ -0,0 +1,216 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require "#{File.dirname(__FILE__)}/../lib/colorized_string"
+
+class TestColorizedString < Minitest::Test
+  def test_colorize_not_required
+    refute_respond_to '', :colorize, 'Colorize should not be required. Only colorized_string'
+  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)
+  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)
+  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 "\001\033[0;39;49m\002This is incorrect color\001\033[0m\002", 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)
+  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)
+  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)
+  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)
+  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)
+  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
+  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
+  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
+  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
+  end
+
+  def test_uncolorize
+    assert_equal 'This is uncolorized', ColorizedString['This is uncolorized'].blue.on_red.uncolorize
+  end
+
+  def test_colorized?
+    assert_predicate ColorizedString['Red'].red, :colorized?
+    refute_predicate ColorizedString['Blue'], :colorized?
+    refute_predicate ColorizedString['Green'].blue.green.uncolorize, :colorized?
+  end
+
+  def test_concatenated__colorize?
+    assert_predicate ColorizedString["none #{ColorizedString['red'].red} none #{ColorizedString['blue'].blue} none"], :colorized?
+    refute_predicate ColorizedString["none #{ColorizedString['red'].red} none #{ColorizedString['blue'].blue} none"].uncolorize, :colorized?
+  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
+  end
+
+  def test_concatenated_strings_uncolorize
+    assert_equal 'none red none blue none', ColorizedString["none #{ColorizedString['red'].red} none #{ColorizedString['blue'].blue} none"].uncolorize
+  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
+  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
+  end
+
+  def test_disable_colorization_with_=
+    ColorizedString.disable_colorization = true
+
+    assert ColorizedString.disable_colorization
+
+    ColorizedString.disable_colorization = false
+  end
+
+  def test_disable_colorization_with_method
+    ColorizedString.disable_colorization true
+
+    assert ColorizedString.disable_colorization
+
+    ColorizedString.disable_colorization false
+  end
+
+  def test_string_disable_colorization_with_=
+    ColorizedString.disable_colorization = true
+
+    assert ColorizedString.disable_colorization
+
+    assert_equal 'This is blue after disabling', ColorizedString['This is blue after disabling'].blue
+
+    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)
+  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)
+
+    ColorizedString.disable_colorization true
+
+    assert ColorizedString.disable_colorization
+
+    assert_equal 'This is blue after disabling', ColorizedString['This is blue after disabling'].blue
+
+    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)
+  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
+  end
+
+  def test_color_matrix_method
+    assert_raises(NoMethodError) { ColorizedString.color_matrix }
+  end
+
+  def test_color_samples_method
+    assert_output do
+      ColorizedString.color_samples
+    end
+  end
+
+  def test_grey_alias
+    assert_equal ColorizedString['This is grey'].grey, ColorizedString['This is grey'].light_black
+  end
+
+  def test_gray_alias
+    assert_equal ColorizedString['This is gray'].gray, ColorizedString['This is gray'].light_black
+  end
+
+  def test_add_color_alias
+    ColorizedString.add_color_alias(:extra_blue, :light_blue)
+
+    assert_equal ColorizedString['blue'].light_blue, ColorizedString['blue'].extra_blue
+    assert_equal ColorizedString['blue'].on_light_blue, ColorizedString['blue'].on_extra_blue
+
+    assert_raises ::Colorize::ColorAlreadyExist, 'Colorize: color :extra_blue already exist!' do
+      ColorizedString.add_color_alias(:extra_blue, :light_color)
+    end
+
+    assert_raises ::Colorize::ColorDontExist, 'Colorize: color :light_color don\'t exist!' do
+      ColorizedString.add_color_alias(:extra_white, :light_color)
+    end
+  end
+
+  def test_add_color_alias_with_single_hash
+    ColorizedString.add_color_alias(extra_green: :light_green)
+
+    assert_equal ColorizedString['example string'].light_green, ColorizedString['example string'].extra_green
+    assert_equal ColorizedString['example string'].on_light_green, ColorizedString['example string'].on_extra_green
+  end
+
+  def test_add_color_alias_with_single_hash_with_arrow
+    ColorizedString.add_color_alias(:extra_color => :gray)
+
+    assert_equal ColorizedString['example string'].gray, ColorizedString['example string'].extra_color
+    assert_equal ColorizedString['example string'].on_gray, ColorizedString['example string'].on_extra_color
+  end
+
+  def test_add_color_alias_with_multi_hash
+    ColorizedString.add_color_alias(extra_color_a: :gray, extra_color_b: :blue)
+
+    assert_equal ColorizedString['example string'].gray, ColorizedString['example string'].extra_color_a
+    assert_equal ColorizedString['example string'].blue, ColorizedString['example string'].extra_color_b
+  end
+
+  def test_add_color_alias_with_multi_hash_with_arrow
+    ColorizedString.add_color_alias(:extra_color_c => :gray, :extra_color_d => :blue)
+
+    assert_equal ColorizedString['example string'].gray, ColorizedString['example string'].extra_color_c
+    assert_equal ColorizedString['example string'].on_blue, ColorizedString['example string'].on_extra_color_d
+  end
+
+  def test_add_color_alias_with_multi_hash_mixed
+    ColorizedString.add_color_alias(extra_color_e: :gray, :extra_color_f => :blue)
+
+    assert_equal ColorizedString['example string'].gray, ColorizedString['example string'].extra_color_e
+    assert_equal ColorizedString['example string'].on_blue, ColorizedString['example string'].on_extra_color_f
+  end
+
+  def test_prevent_colors
+    ColorizedString.prevent_colors true
+
+    assert ColorizedString.prevent_colors
+    assert_equal "#{ColorizedString['blue'].blue}#{ColorizedString['red'].red}#{ColorizedString['green'].green}", ColorizedString["#{ColorizedString['blue'].blue}red#{ColorizedString['green'].green}"].red
+
+    ColorizedString.prevent_colors false
+  end
+
+  def test_colorized_string_without_readline
+    assert_equal ColorizedString["\e[0;31;49mgreen\e[0m"].green, ColorizedString['green'].green
+  end
+end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: colorize
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 1.0.1
 platform: ruby
 authors:
 - Michał Kalbarczyk
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
+date: 2023-06-19 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.
 email: fazibear@gmail.com
@@ -59,21 +17,25 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG
+- CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile
 - colorize.gemspec
 - lib/colorize.rb
 - lib/colorize/class_methods.rb
+- lib/colorize/errors.rb
 - lib/colorize/instance_methods.rb
+- lib/colorize/version.rb
 - lib/colorized_string.rb
 - test/test_colorize.rb
+- test/test_colorized_string.rb
 homepage: http://github.com/fazibear/colorize
 licenses:
 - GPL-2.0
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,17 +43,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.4.14
+signing_key:
 specification_version: 4
 summary: Ruby gem for colorizing text using ANSI escape sequences.
-test_files:
-- test/test_colorize.rb
+test_files: []

data/CHANGELOG

@@ -1,65 +0,0 @@
-== 0.8.1 / 2016-06-29
-  * fix gemspec bug
-
-== 0.8.0 / 2016-06-27
-	* add ColorizedString class
-	* update README file
-	* add rubocop.yml and follow style
-  * add italic mode
-  * remove interpreter warrnings
-
-== 0.7.7 / 2015-04-19
-  * update gems
-
-== 0.7.6 / 2015-04-18
-  * fix bugs
-
-== 0.7.5 / 2014-12-11
-  * big code refactoring
-  * disable_colorization feature added
-
-== 0.7.4 / 2014-12-10
-  * code cleanups
-
-== 0.7.3 / 2014-05-19
-  * fix new line maching
-
-== 0.7.2 / 2014-04-08
-  * tests cleanups
-  * gem release date fixed
-
-== 0.7.1 / 2014-04-02
-  * handling wrong color values
-
-== 0.7.0 / 2014-03-12
-  * refactored to use regexp pattern matching
-  * works with frozen strings
-  * works with concatenated string
-
-== 0.6.0 / 2013-09-25
-  * code cleanups
-  * bold mode fixed
-  * STDOUT.isatty condition removed
-  * doc updated
-  * jeweler tasks removed
-  * Rakefile updated
-
-== 0.5.8 / 2009-12-02
-  * code cleanups
-  * removed 'ruby -w' warnings
-
-== 0.5.7 / 2009-11-24
-  * moved to github/gemcutter
-  * 1.9 compatible
-
-== 0.5.6 / 2007-08-27
-  * rdocs Allison template
-  * cleanups
-
-== 0.5.5 / 2007-08-11
-  * added effects methods
-  * README files
-  * new rake file
-
-== 0.5.0 / 2007-04-22
-  * initial rewritten version