colorize 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 317b798812e6ac4ce6a4f841d19ace2486046303
-  data.tar.gz: a4428a6bd6095977fbb4105bedf856cae76c6618
+  metadata.gz: 5daa22026f530e287e74e572407ba4ddf9520104
+  data.tar.gz: 3af9a37ec77d130690c976cd1decbf4fc086a321
 SHA512:
-  metadata.gz: 3af5be1a215b84c3e6d3e34f66f198e9f39a7aa3a5c57e4aacbfd03744747a7555aa34204ab92f1bcdf2121dd41e68288acbb2321be81b41bf40aa04ed68400d
-  data.tar.gz: 7da873f65fd383cae435eee5dc52b2ba1676a31fc4e0964f83b65b10faa3316a1d611392f02486851a0046ce5e37ab7467280b7c6a1703c540e12879beccea13
+  metadata.gz: bcfa897a7e8bc2ce4fa354e192a22d53a8f81114ebe98ebbc7921ba99496b72b92771ba78ad2c3a1c34acd7c83a6e24c5e146ec92ca314283ba4c80675b78d09
+  data.tar.gz: f3f2a9297ab0cac20506b1875e92f3cc0d476a7f053bb6d89941576b22662faa8a9a7970a54d9e64f1738d493e47c0578c35cff963077044cd1e739ebcf8b814

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.7.5 / 2014-12-11
+  * big code refactoring
+  * disable_colorization feature added
+
 == 0.7.4 / 2014-12-10
   * code cleanups
 

data/README.md

@@ -28,9 +28,14 @@ Some usage samples:
 
 Class methods:
 
-    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.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
+    String.disable_colorization = false - disable colorization
+    String.disable_colorization false   - disable colorization
+    String.disable_colorization = true  - enable colorization
+    String.disable_colorization true    - enable colorization
 
 requirements
 ------------
@@ -47,7 +52,7 @@ install
 license
 -------
 
-Copyright (C) 2007 Michal Kalbarczyk
+Copyright (C) 2007-2015 Michal Kalbarczyk
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by

data/colorize.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'colorize'
-  s.version = '0.7.4'
+  s.version = '0.7.5'
 
   s.authors = ['fazibear']
   s.email = 'fazibear@gmail.com'
@@ -21,6 +21,8 @@ Gem::Specification.new do |s|
     'Rakefile',
     'colorize.gemspec',
     'lib/colorize.rb',
+    'lib/colorize/class_methods.rb',
+    'lib/colorize/instance_methods.rb',
     'test/test_colorize.rb',
   ]
   s.test_files = [

data/lib/colorize.rb

@@ -1,197 +1,12 @@
+require File.expand_path('colorize/class_methods', File.dirname(__FILE__))
+require File.expand_path('colorize/instance_methods', File.dirname(__FILE__))
 #
 # Colorize 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    => 60,
-    :light_red      => 61,
-    :light_green    => 62,
-    :light_yellow   => 63,
-    :light_blue     => 64,
-    :light_magenta  => 65,
-    :light_cyan     => 66,
-    :light_white    => 67
-  }
-
-  #
-  # Modes Hash
-  #
-  MODES = {
-    :default        => 0, # Turn off all attributes
-    :bold           => 1, # Set bold 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)
-  }
-
-  REGEXP_PATTERN = /\033\[([0-9]+);([0-9]+);([0-9]+)m(.+?)\033\[0m|([^\033]+)/m
-  COLOR_OFFSET = 30
-  BACKGROUND_OFFSET = 40
-
-  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 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)
-    windows_requires
-
-    scan(REGEXP_PATTERN).inject('') do |str, match|
-      set_defaults(match)
-      set_from_params(match, params)
-      str << "\033[#{match[0]};#{match[1]};#{match[2]}m#{match[3]}\033[0m"
-    end
-  end
-
-  #
-  # Return uncolorized string
-  #
-  def uncolorize
-    scan(REGEXP_PATTERN).inject('') do |str, match|
-      str << (match[3] || match[4])
-    end
-  end
-
-  #
-  # Return true if string is colorized
-  #
-  def colorized?
-    scan(REGEXP_PATTERN).reject(&:last).any?
-  end
-
-  #
-  # Make some color and on_color methods
-  #
-  COLORS.each_key do |key|
-    next if key == :default
-
-    define_method key do
-      colorize(:color => key)
-    end
-
-    define_method "on_#{key}" do
-      colorize(:background => key)
-    end
-  end
-
-  #
-  # Methods for modes
-  #
-  MODES.each_key do |key|
-    next if key == :default
-
-    define_method key do
-      colorize(:mode => key)
-    end
-  end
-
-  private
-
-  #
-  # Require windows libs
-  #
-  def windows_requires
-    begin
-      require 'Win32/Console/ANSI' if RUBY_VERSION < "2.0.0" && RUBY_PLATFORM =~ /win32/
-    rescue LoadError
-      raise 'You must gem install win32console to use colorize on Windows'
-    end
-  end
-
-  #
-  # Set default colors
-  #
-  def set_defaults(match)
-    match[0] ||= MODES[:default]
-    match[1] ||= COLORS[:default] + COLOR_OFFSET
-    match[2] ||= COLORS[:default] + BACKGROUND_OFFSET
-    match[3] ||= match[4]
-  end
-
-  #
-  # Set color from params
-  #
-  def set_from_params(match, params)
-    case params
-    when Hash then set_from_hash(match, params)
-    when Symbol then set_from_symbol(match, params)
-    end
-  end
-
-  #
-  # Set colors from params hash
-  #
-  def set_from_hash(match, hash)
-    match[0] = MODES[hash[:mode]] if hash[:mode] && MODES[hash[:mode]]
-    match[1] = COLORS[hash[:color]] + COLOR_OFFSET if hash[:color] && COLORS[hash[:color]]
-    match[2] = COLORS[hash[:background]] + BACKGROUND_OFFSET if hash[:background] && COLORS[hash[:background]]
-  end
-
-  #
-  # Set color from params symbol
-  #
-  def set_from_symbol(match, symbol)
-    match[1] = COLORS[symbol] + COLOR_OFFSET if symbol && COLORS[symbol]
-  end
-
-  class << self
-
-    #
-    # Return array of available modes used by colorize method
-    #
-    def modes
-      MODES.keys
-    end
-
-    #
-    # Return array of available colors used by colorize method
-    #
-    def colors
-      COLORS.keys
-    end
-
-    #
-    # Display color samples
-    #
-    def color_samples
-      String.colors.permutation(2).each do |background, color|
-        puts "#{color.inspect.rjust(15)} on #{background.inspect.ljust(15)}".colorize(:color => color, :background => background) + "#{color.inspect.rjust(15)} on #{background.inspect.ljust(15)}"
-      end
-    end
-
-    #
-    # Method removed, raise NoMethodError
-    #
-    def color_matrix(txt = '')
-      fail NoMethodError, '#color_matrix method was removed, try #color_samples instead'
-    end
-  end
+  color_methods
+  modes_methods
 end

data/lib/colorize/class_methods.rb

@@ -0,0 +1,114 @@
+module Colorize
+  module ClassMethods
+
+    #
+    # Property to disable colorization
+    #
+    def disable_colorization(value = nil)
+      if value.nil?
+        @disable_colorization || false
+      else
+        @disable_colorization = (value || false)
+      end
+    end
+
+    #
+    # Setter for disable colorization
+    #
+    def disable_colorization=(value)
+      @disable_colorization = (value || false)
+    end
+
+    #
+    # 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
+      }
+    end
+
+    #
+    # Return array of available colors used by colorize
+    #
+    def colors
+      color_codes.keys
+    end
+
+    #
+    # Mode codes hash
+    #
+    def mode_codes
+      {
+        :default   => 0, # Turn off all attributes
+        :bold      => 1, # Set bold 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)
+      }
+    end
+
+    #
+    # Return array of available modes used by colorize
+    #
+    def modes
+      mode_codes.keys
+    end
+
+    #
+    # Color and on_color methods
+    #
+    def color_methods
+      colors.each do |key|
+        next if key == :default
+
+        define_method key do
+          colorize(:color => key)
+        end
+
+        define_method "on_#{key}" do
+          colorize(:background => key)
+        end
+      end
+    end
+
+    #
+    # Modes methods
+    #
+    def modes_methods
+      modes.each do |key|
+        next if key == :default
+
+        define_method key do
+          colorize(:mode => key)
+        end
+      end
+    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 "#{sample_text.colorize(:color => color, :background => background)} #{sample_text}"
+      end
+    end
+
+    #
+    # Method removed, raise NoMethodError
+    #
+    def color_matrix(txt = '')
+      fail NoMethodError, '#color_matrix method was removed, try #color_samples instead'
+    end
+  end
+end

data/lib/colorize/instance_methods.rb

@@ -0,0 +1,123 @@
+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
+      require_windows_libs
+      scan_for_colors.inject('') do |str, match|
+        defaults_colors(match)
+        colors_from_params(match, params)
+        str << "\033[#{match[0]};#{match[1]};#{match[2]}m#{match[3]}\033[0m"
+      end
+    end
+
+    #
+    # Return uncolorized string
+    #
+    def uncolorize
+      scan_for_colors.inject('') do |str, match|
+        str << (match[3] || match[4])
+      end
+    end
+
+    #
+    # Return true if string is colorized
+    #
+    def colorized?
+      scan_for_colors.reject(&:last).any?
+    end
+
+    private
+
+    #
+    # Set default colors
+    #
+    def defaults_colors(match)
+      match[0] ||= mode(:default)
+      match[1] ||= color(:default)
+      match[2] ||= background_color(:default)
+      match[3] ||= match[4]
+    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)
+      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
+
+    #
+    # Set color from params symbol
+    #
+    def color_from_symbol(match, symbol)
+      match[1] = color(symbol) if color(symbol)
+    end
+
+    #
+    # Color for foreground (offset 30)
+    #
+    def color(color)
+      self.class.color_codes[color] + 30 if self.class.color_codes[color]
+    end
+
+    #
+    # Color for background (offset 40)
+    #
+    def background_color(color)
+      self.class.color_codes[color] + 40 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(/\033\[([0-9]+);([0-9]+);([0-9]+)m(.+?)\033\[0m|([^\033]+)/m)
+    end
+
+    #
+    # Require windows libs
+    #
+    def require_windows_libs
+      begin
+        require 'Win32/Console/ANSI' if RUBY_VERSION < "2.0.0" && RUBY_PLATFORM =~ /win32/
+      rescue LoadError
+        raise 'You must gem install win32console to use colorize on Windows'
+      end
+    end
+  end
+end

data/test/test_colorize.rb

@@ -88,9 +88,48 @@ class TestColorize < Test::Unit::TestCase
     assert_equal 'This is blue text on red'.freeze.blue.on_red.blink,
                  "\e[5;34;41mThis is blue text on red\e[0m"
   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"
   end
+
+  def test_disable_colorization_with_setter
+    String.disable_colorization = true
+    assert_equal String.disable_colorization, true
+    String.disable_colorization = false
+  end
+
+  def test_disable_colorize_with_setter
+    String.disable_colorization = true
+
+    assert_equal String.disable_colorization, true
+
+    assert_equal 'This is blue after disabling'.blue,
+                 'This is blue after disabling'
+
+    String.disable_colorization = false
+
+    assert_equal 'This is blue after enabling'.colorize(:blue),
+                 "\e[0;34;49mThis is blue after enabling\e[0m"
+  end
+
+  def test_disable_colorize_with_setter
+    assert_equal 'This is blue before disabling'.colorize(:blue),
+                 "\e[0;34;49mThis is blue before disabling\e[0m"
+
+    String.disable_colorization true
+
+    assert_equal String.disable_colorization, true
+
+    assert_equal 'This is blue after disabling'.blue,
+                 'This is blue after disabling'
+
+    String.disable_colorization false
+
+    assert_equal 'This is blue after enabling'.colorize(:blue),
+                 "\e[0;34;49mThis is blue after enabling\e[0m"
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: colorize
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - fazibear
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies: []
 description: Ruby String class extension. Adds methods to set text color, background
   color and, text effects on ruby console and command line output, using ANSI escape
@@ -24,6 +24,8 @@ files:
 - Rakefile
 - colorize.gemspec
 - lib/colorize.rb
+- lib/colorize/class_methods.rb
+- lib/colorize/instance_methods.rb
 - test/test_colorize.rb
 homepage: http://github.com/fazibear/colorize
 licenses: