colorize 0.8.1 → 1.0.0.pre.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2f9aa60a1408f5b8cf800bd6d48d0778d6306fdd
-  data.tar.gz: f08adfa6e15d4bc0eb1f553451d96ecf69070c11
+SHA256:
+  metadata.gz: e6cf67e45a9d7d3a06cab45d8588ebc1bcdbcb25f60700bc8b891deaa47aa4ee
+  data.tar.gz: bbee1cd60a0ff68de06a0febcb50cf6655304ed81354dcbde88538f7ea15266f
 SHA512:
-  metadata.gz: 2d49b0c6362a92b525c7d1fdb0209f6fbfdfc61f720190d75f5ceef96338faa98358ce70e94bfe0a7a86f33f6036ae19e6ca9ce29dbbcfd59b3e2a3ee52d8a72
-  data.tar.gz: 674694aef0a11430782f9d888b0b39a3365a8730144d0be759151977fd3b30b2a6c2041d8699438d2fbbfe5db57733bc4a018f6a6344a1f3a4cd590d47bf274c
+  metadata.gz: 1cd49dd178b7c9fa10f1b1d1ce0b417ccc26ca19474883900ccf8a454c23f7d8f421799c05d37f6e88909a6dd7fedfe819788c9cf26173464d0a30c0cd051727
+  data.tar.gz: cc199a5456e868009843681eb7cd0c4012a14e654fa2d8cc6701cf2e7ac8e0bc9de96ba12d0a51d610bc903d9399c18ba50b9985930df2de910d6da60b1c4f13

data/CHANGELOG.md

@@ -0,0 +1,107 @@
+# Changelog
+
+## [1.0.0-beta.3](https://github.com/fazibear/colorize/compare/v1.0.0-beta.2...v1.0.0-beta.3) (2023-03-23)
+
+
+### Miscellaneous Chores
+
+* release 1.0.0-beta.2 ([45c3dd6](https://github.com/fazibear/colorize/commit/45c3dd6f503d5e5588f3f7598019dc7a53adac5e))
+* release 1.0.0-beta.3 ([2eb8f9d](https://github.com/fazibear/colorize/commit/2eb8f9d8c486722b66acdc525653cdef3cb9b163))
+
+## [1.0.0-beta.2](https://github.com/fazibear/colorize/compare/v1.0.0-beta.2...v1.0.0-beta.2) (2023-03-23)
+
+
+### Miscellaneous Chores
+
+* release 1.0.0-beta.2 ([45c3dd6](https://github.com/fazibear/colorize/commit/45c3dd6f503d5e5588f3f7598019dc7a53adac5e))
+
+## [1.0.0-beta.2](https://github.com/fazibear/colorize/compare/v1.0.0-beta.1...v1.0.0-beta.2) (2023-03-23)
+
+
+### Miscellaneous Chores
+
+* release 1.0.0-beta.2 ([29ed0c5](https://github.com/fazibear/colorize/commit/29ed0c5ae97a9a66e4af7e376e2b2a937eaf024d))
+
+## [1.0.0-beta.1](https://github.com/fazibear/colorize/compare/v0.8.1...v1.0.0-beta.1) (2023-03-23)
+
+
+### Miscellaneous Chores
+
+* release 1.0.0-beta.1 ([6303e25](https://github.com/fazibear/colorize/commit/6303e257690cfa7b3efbf11993a4cd75418b5d5e))
+* release 1.0.0.beta ([fbb2cb2](https://github.com/fazibear/colorize/commit/fbb2cb25ff17e9f46ca7fc9b8173414b0f8df7db))
+* release 1.0.0.beta ([f8cb1e4](https://github.com/fazibear/colorize/commit/f8cb1e4033150143918f45663b74c5a574ca372b))
+
+== 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/gem-push.yml/badge.svg)](https://github.com/fazibear/colorize/actions/workflows/gem-push.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,30 @@ Gem::Specification.new do |s|
 
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'json', '~> 2.0'
   s.add_development_dependency 'minitest', '~> 5.0'
-  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.4'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rubocop', '~> 1.0'
+  s.add_development_dependency 'rubocop-github', '~> 0.20'
+  s.add_development_dependency 'rubocop-minitest', '~> 0.29.0'
+  s.add_development_dependency 'rubocop-performance', '~> 1.16'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6'
 
   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.0-beta.3'
+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)