colorize 0.5.7 → 1.0.1

data/colorize.gemspec

@@ -1,49 +1,37 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+require File.expand_path('lib/colorize/version', File.dirname(__FILE__))
 
 Gem::Specification.new do |s|
-  s.name = %q{colorize}
-  s.version = "0.5.7"
+  s.name = 'colorize'
+  s.version = Colorize::VERSION
+  s.required_ruby_version = '>= 2.6'
+
+  s.authors = ['Michał Kalbarczyk']
+  s.email = 'fazibear@gmail.com'
+
+  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.'
+  s.license = 'GPL-2.0'
+
+  s.require_paths = ['lib']
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["fazibear"]
-  s.date = %q{2009-11-24}
-  s.description = %q{Ruby string class extension. It add some methods to set color, background color and text effect on console easier. Uses ANSI escape sequences.}
-  s.email = %q{fazibear@gmail.com}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
   s.files = [
-    ".gitignore",
-     "CHANGELOG.rdoc",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "colorize.gemspec",
-     "lib/colorize.rb",
-     "test/test_colorize.rb",
-     "test/test_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/fazibear/colorize}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Add colors methods to string class}
-  s.test_files = [
-    "test/test_helper.rb",
-     "test/test_colorize.rb"
+    'LICENSE',
+    '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',
   ]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.metadata['rubygems_mfa_required'] = 'true'
 end
-

data/lib/colorize/class_methods.rb

@@ -0,0 +1,203 @@
+# 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 for disable colorization
+    #
+    def disable_colorization(value = nil)
+      if value.nil?
+        if defined?(@@disable_colorization)
+          @@disable_colorization || false
+        else
+          false
+        end
+      else
+        @@disable_colorization = (value || false)
+      end
+    end
+
+    #
+    # Setter for disable colorization
+    #
+    def disable_colorization=(value)
+      @@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
+
+    #
+    # Return array of available colors used by colorize
+    #
+    def colors
+      color_codes.keys
+    end
+
+    #
+    # Return array of available modes used by colorize
+    #
+    def modes
+      mode_codes.keys
+    end
+
+    #
+    # Display color samples
+    #
+    def color_samples
+      colors.permutation(2).each do |background, color|
+        sample_text = "#{color.inspect.rjust(15)} on #{background.inspect.ljust(15)}"
+        puts "#{new(sample_text).colorize(:color => color, :background => background)} #{sample_text}"
+      end
+    end
+
+    #
+    # Add color alias
+    #
+    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
+
+    #
+    # Color codes hash
+    #
+    def color_codes
+      @@color_codes
+    end
+
+    def add_color_code(code, color)
+      @@color_codes[code] = color
+    end
+
+    #
+    # Mode codes hash
+    #
+    def mode_codes
+      @@mode_codes
+    end
+
+    #
+    # Generate color and on_color methods
+    #
+    def color_methods
+      colors.each do |key|
+        next if key == :default
+
+        add_color_method(key)
+      end
+    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
+
+    #
+    # Generate modes methods
+    #
+    def modes_methods
+      modes.each do |key|
+        next if key == :default
+
+        define_method key do
+          colorize(:mode => key)
+        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

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+module Colorize
+  module InstanceMethods
+    #
+    # Change color of string
+    #
+    # Examples:
+    #
+    #   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 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 uncolorized".blue.on_red.uncolorize
+    #
+    def colorize(params)
+      return self if self.class.disable_colorization
+
+      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"
+      end
+    end
+
+    #
+    # Return uncolorized string
+    #
+    def uncolorize
+      scan_for_colors.inject(self.class.new) do |str, match|
+        str << match[3]
+      end
+    end
+
+    #
+    # Return true if string is colorized
+    #
+    def colorized?
+      scan_for_colors.inject([]) do |colors, match|
+        colors << match.tap(&:pop)
+      end.flatten.compact.any?
+    end
+
+    private
+
+    #
+    # Set default colors
+    #
+    def defaults_colors(match)
+      match[0] ||= mode(:default)
+      match[1] ||= color(:default)
+      match[2] ||= background_color(:default)
+    end
+
+    #
+    # Set color from params
+    #
+    def colors_from_params(match, params)
+      case params
+      when Hash then colors_from_hash(match, params)
+      when Symbol then color_from_symbol(match, params)
+      end
+    end
+
+    #
+    # Set colors from params hash
+    #
+    def colors_from_hash(match, hash)
+      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)
+      if self.class.prevent_colors && color(symbol)
+        match[1] ||= color(symbol)
+      else
+        match[1] = color(symbol)
+      end
+    end
+
+    #
+    # Color for foreground
+    #
+    def color(color)
+      self.class.color_codes[color]
+    end
+
+    #
+    # Color for background (offset 10)
+    #
+    def background_color(color)
+      self.class.color_codes[color] + 10 if self.class.color_codes[color]
+    end
+
+    #
+    # Mode
+    #
+    def mode(mode)
+      self.class.mode_codes[mode]
+    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|
+        split_colors(match)
+      end
+    end
+
+    def split_colors(match)
+      colors = (match[0] || '').split(';')
+      array = Array.new(3)
+      array[0], array[1], array[2] = colors if colors.length == 3
+      array[1] = colors                     if colors.length == 1
+      array[3] = match[1] || match[2]
+      array
+    end
+
+    #
+    # Require windows libs
+    #
+    def require_windows_libs
+      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
+  end
+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,191 +1,20 @@
+# 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__))
+
 #
-# Colorize String class extension.
+# String class extension.
 #
 class String
+  extend Colorize::ClassMethods
+  include Colorize::InstanceMethods
 
-  #
-  # Colors Hash
-  #
-  COLORS = {
-    :black          => 0,
-    :red            => 1,
-    :green          => 2,
-    :yellow         => 3,
-    :blue           => 4,
-    :magenta        => 5,
-    :cyan           => 6,
-    :white          => 7,
-    :default        => 9,
-    
-    :light_black    => 10,
-    :light_red      => 11,
-    :light_green    => 12,
-    :light_yellow   => 13,
-    :light_blue     => 14,
-    :light_magenta  => 15,
-    :light_cyan     => 16,
-    :light_white    => 17
-  }
-
-  #
-  # Modes Hash
-  #
-  MODES = {
-    :default        => 0, # Turn off all attributes
-    #:bright        => 1, # Set bright 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)
-  }
-  
-  protected
-  
-  #
-  # Set color values in new string intance
-  #
-  def set_color_parameters( params )
-    if (params.instance_of?(Hash))
-      @color = params[:color]
-      @background = params[:background]
-      @mode = params[:mode]
-      @uncolorized = params[:uncolorized]
-      self
-    else
-      nil
-    end
-  end
-
-  public
-
-  #
-  # Change color of string
-  #
-  # Examples:
-  #
-  #   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 blue with red background".colorize( :color => :light_blue, :background => :red )
-  #   puts "This is 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
-  #
-  def colorize( params )
-    
-    return self unless STDOUT.isatty
-    
-    begin
-        require 'Win32/Console/ANSI' if RUBY_PLATFORM =~ /win32/
-    rescue LoadError
-        raise 'You must gem install win32console to use color on Windows'
-    end
-    
-    color_parameters = {}
-
-    if (params.instance_of?(Hash))
-      color_parameters[:color] = COLORS[params[:color]]
-      color_parameters[:background] = COLORS[params[:background]]
-      color_parameters[:mode] = MODES[params[:mode]]
-    elsif (params.instance_of?(Symbol))
-      color_parameters[:color] = COLORS[params]
-    end
-    
-    color_parameters[:color] ||= @color || 9
-    color_parameters[:background] ||= @background || 9
-    color_parameters[:mode] ||= @mode || 0
-
-    color_parameters[:uncolorized] ||= @uncolorized || self.dup
-   
-    # calculate bright mode
-    color_parameters[:color] += 50 if color_parameters[:color] > 10
-
-    color_parameters[:background] += 50 if color_parameters[:background] > 10
-
-    return "\033[#{color_parameters[:mode]};#{color_parameters[:color]+30};#{color_parameters[:background]+40}m#{color_parameters[:uncolorized]}\033[0m".set_color_parameters( color_parameters )
-  end
-
-  
-  #
-  # Return uncolorized string
-  #
-  def uncolorize
-    return @uncolorized || self
-  end
-  
-  #
-  # Return true if sting is colorized
-  #
-  def colorized?
-    return !@uncolorized.nil?
-  end
-
-  #
-  # Make some color and on_color methods
-  #
-  COLORS.each_key do | key |
-    eval <<-"end_eval"
-      def #{key.to_s}
-        return self.colorize( :color => :#{key.to_s} )
-      end
-      def on_#{key.to_s}
-        return self.colorize( :background => :#{key.to_s} )
-      end
-    end_eval
-  end
-
-  #
-  # Methods for modes
-  #
-  MODES.each_key do | key |
-    eval <<-"end_eval"
-      def #{key.to_s}
-        return self.colorize( :mode => :#{key.to_s} )
-      end
-    end_eval
-  end
-
-  class << self
-    
-    #
-    # Return array of available modes used by colorize method
-    #
-    def modes
-      keys = []
-      MODES.each_key do | key |
-        keys << key
-      end
-      keys
-    end
-
-    #
-    # Return array of available colors used by colorize method
-    #
-    def colors
-      keys = []
-      COLORS.each_key do | key |
-        keys << key
-      end
-      keys
-    end 
+  color_methods
+  modes_methods
 
-    #
-    # Display color matrix with color names.
-    #
-    def color_matrix( txt = "[X]" )
-      size = String.colors.length
-      String.colors.each do | color |
-        String.colors.each do | back |
-         print txt.colorize( :color => color, :background => back )
-        end
-        puts " < #{color}"
-      end
-      String.colors.reverse.each_with_index do | back, index |
-        puts "#{"|".rjust(txt.length)*(size-index)} < #{back}"
-      end 
-    end
-  end
-  puts
+  add_color_alias(:grey, :light_black)
+  add_color_alias(:gray, :light_black)
 end

data/lib/colorized_string.rb

@@ -0,0 +1,25 @@
+# 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__))
+#
+# ColorizedString class extension.
+#
+class ColorizedString < String
+  extend Colorize::ClassMethods
+  include Colorize::InstanceMethods
+
+  color_methods
+  modes_methods
+
+  add_color_alias(:grey, :light_black)
+  add_color_alias(:gray, :light_black)
+
+  #
+  # Shortcut to create ColorizedString with ColorizedString['test'].
+  #
+  def self.[](string)
+    ColorizedString.new(string)
+  end
+end